Reallocate Machine Client Tenant of ESP (v2.5)
POST/sdwan/v2.5/api/clients/:client_id/machines/:machine_id/reallocate
Reallocate a specific machine from one client tenant to another, where both client tenants are clients of the same ESP.
Request
Path Parameters
Tenant ID (source) of the client tenant of ESP.
The device ID.
- application/json
Body
The device is connected. True or False.
The console password.
The element ID.
The MSP tenant ID.
The hardware ID.
The image version.
Possible values: [claim
, return
, revoke
, reuse
, retire
, recover
, remanufacture
, default
, invalid
, esp_allocate
, esp_received_stock
, esp_return
, esp_revoke
, esp_reuse
]
The inventory lifecycle values.
Possible values: [manufactured
, manufactured_qa_pending
, manufactured_qa_ok
, manufactured_qa_not_ok
, manufactured_battery_test_pending
, manufactured_battery_test_start
, manufactured_battery_test_passed
, manufactured_battery_test_failed
, manufactured_mic_issue_pending
, manufactured_mic_issued
, manufactured_mic_failed
, manufactured_mic_operational
, manufactured_cic_issue_pending
, manufactured_cic_issued
, manufactured_cic_revoked
, manufactured_cic_operational
, manufactured_mic_signing_pending
, manufactured_cic_signing_pending
, allocated
, allocated_to_esp
, claim_pending
, initializing
, initialization_failed
, assigned
, claim_pending
, claimed
, claim_failed
, to_be_returned
, returned
, revoked
, machine_element_delete_pending
, return_failed
, received_stock
, remanufactured
, retired
, recover
, decommissioned
, machine_claim_valid
, machine_claim_invalid
, machine_cic_renew_initial
, machine_cic_renew_issue_pending
, machine_cic_renew_issued
, machine_cic_renew_signing_pending
, machine_cic_renew_failed
, machine_cic_renewed
]
The various device states.
The manufacture ID.
The model name of the device.
The order information.
The owner tenant ID.
pki_op CAStoreOperation
Ca List
Possible values: [UPDATE_CASTORE
]
Operation
Possible values: [manufactured
, manufactured_qa_pending
, manufactured_qa_ok
, manufactured_qa_not_ok
, manufactured_battery_test_pending
, manufactured_battery_test_start
, manufactured_battery_test_passed
, manufactured_battery_test_failed
, manufactured_mic_issue_pending
, manufactured_mic_issued
, manufactured_mic_failed
, manufactured_mic_operational
, manufactured_cic_issue_pending
, manufactured_cic_issued
, manufactured_cic_revoked
, manufactured_cic_operational
, manufactured_mic_signing_pending
, manufactured_cic_signing_pending
, allocated
, allocated_to_esp
, claim_pending
, initializing
, initialization_failed
, assigned
, claim_pending
, claimed
, claim_failed
, to_be_returned
, returned
, revoked
, machine_element_delete_pending
, return_failed
, received_stock
, remanufactured
, retired
, recover
, decommissioned
, machine_claim_valid
, machine_claim_invalid
, machine_cic_renew_initial
, machine_cic_renew_issue_pending
, machine_cic_renew_issued
, machine_cic_renew_signing_pending
, machine_cic_renew_failed
, machine_cic_renewed
]
The device renew states.
The sales order number.
Possible values: [machine_shipped
, machine_shipped_correct_address
, machine_shipped_wrong_address
, machine_not_shipped
]
The shipping status.
A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
The device is connected. True or False.
The console password.
The element shell ID.
The element ID.
The MSP tenant ID.
The hardware ID.
Id
The image version.
Possible values: [CLAIM
, RETURN
, REVOKE
, REUSE
, RETIRE
, RECOVER
, REMANUFACTURE
, DEFAULT
, INVALID
, ALLOCATE
, RECEIVED_STOCK
, ESP_ALLOCATE
, ESP_RECEIVED_STOCK
, ESP_RETURN
, ESP_REVOKE
, ESP_REUSE
]
The inventory lifecycle values.
Is Eval: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])
Possible values: [MANUFACTURED
, MANUFACTURED_QA_PENDING
, MANUFACTURED_QA_OK
, MANUFACTURED_QA_NOK
, MANUFACTURED_BATTERY_TEST_PENDING
, MANUFACTURED_BATTERY_TEST_START
, MANUFACTURED_BATTERY_TEST_PASS
, MANUFACTURED_BATTERY_TEST_FAILED
, MANUFACTURED_MIC_ISSUE_PENDING
, MANUFACTURED_MIC_ISSUED
, MANUFACTURED_MIC_FAILED
, MANUFACTURED_MIC_OPERATIONAL
, MANUFACTURED_CIC_ISSUE_PENDING
, MANUFACTURED_CIC_ISSUED
, MANUFACTURED_CIC_REVOKED
, MANUFACTURED_CIC_OPERATIONAL
, MANUFACTURED_MIC_SIGNING_PENDING
, MANUFACTURED_CIC_SIGNING_PENDING
, MACHINE_ALLOCATED
, MACHINE_ALLOCATED_TO_ESP
, MACHINE_ELEMENT_ID_PENDING
, MACHINE_INIT
, MACHINE_INIT_FAILED
, MACHINE_ASSIGNED
, MACHINE_CLAIM_PENDING
, MACHINE_CLAIMED
, MACHINE_CLAIM_FAILED
, MACHINE_TO_BE_RETURNED
, MACHINE_RETURNED
, MACHINE_REVOKED
, MACHINE_ELEMENT_DELETE_PENDING
, MACHINE_RETURN_FAILED
, MACHINE_RECEIVED_STOCK
, REMANUFACTURED
, MACHINE_RETIRED
, MACHINE_RECOVER
, MACHINE_DECOMMISSIONED
, MACHINE_CLAIM_VALID
, MACHINE_CLAIM_INVALID
, MACHINE_CIC_RENEW_INITIAL
, MACHINE_CIC_RENEW_ISSUE_PENDING
, MACHINE_CIC_RENEW_ISSUED
, MACHINE_CIC_RENEW_SIGNING_PENDING
, MACHINE_CIC_RENEW_FAILED
, MACHINE_CIC_RENEWED
, MACHINE_SUSPEND_INIT
, MACHINE_SUSPEND_IN_PROGRESS
, MACHINE_SUSPENDED_MIC_OPERATIONAL
, MACHINE_SUSPENDED_CIC_OPERATIONAL
, MACHINE_SUSPEND_FAILED
, MACHINE_SUSPENDED_EMPTY_TOKEN
, MACHINE_SUSPENDED_INVALID_TOKEN
, MACHINE_SUSPENDED_TOKEN_EXPIRED
, MACHINE_SUSPENDED
, MACHINE_SUSPEND_FAILED_TIMEOUT
, MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS
, MACHINE_ALLOCATED_TO_SHELL
]
The various device states.
The manufacture ID.
The model name of the device.
The order information.
The owner tenant ID.
pki_op CAStoreOperation
Pki Op
Ca List
Possible values: [UPDATE_CASTORE
]
Operation
Possible values: [MANUFACTURED
, MANUFACTURED_QA_PENDING
, MANUFACTURED_QA_OK
, MANUFACTURED_QA_NOK
, MANUFACTURED_BATTERY_TEST_PENDING
, MANUFACTURED_BATTERY_TEST_START
, MANUFACTURED_BATTERY_TEST_PASS
, MANUFACTURED_BATTERY_TEST_FAILED
, MANUFACTURED_MIC_ISSUE_PENDING
, MANUFACTURED_MIC_ISSUED
, MANUFACTURED_MIC_FAILED
, MANUFACTURED_MIC_OPERATIONAL
, MANUFACTURED_CIC_ISSUE_PENDING
, MANUFACTURED_CIC_ISSUED
, MANUFACTURED_CIC_REVOKED
, MANUFACTURED_CIC_OPERATIONAL
, MANUFACTURED_MIC_SIGNING_PENDING
, MANUFACTURED_CIC_SIGNING_PENDING
, MACHINE_ALLOCATED
, MACHINE_ALLOCATED_TO_ESP
, MACHINE_ELEMENT_ID_PENDING
, MACHINE_INIT
, MACHINE_INIT_FAILED
, MACHINE_ASSIGNED
, MACHINE_CLAIM_PENDING
, MACHINE_CLAIMED
, MACHINE_CLAIM_FAILED
, MACHINE_TO_BE_RETURNED
, MACHINE_RETURNED
, MACHINE_REVOKED
, MACHINE_ELEMENT_DELETE_PENDING
, MACHINE_RETURN_FAILED
, MACHINE_RECEIVED_STOCK
, REMANUFACTURED
, MACHINE_RETIRED
, MACHINE_RECOVER
, MACHINE_DECOMMISSIONED
, MACHINE_CLAIM_VALID
, MACHINE_CLAIM_INVALID
, MACHINE_CIC_RENEW_INITIAL
, MACHINE_CIC_RENEW_ISSUE_PENDING
, MACHINE_CIC_RENEW_ISSUED
, MACHINE_CIC_RENEW_SIGNING_PENDING
, MACHINE_CIC_RENEW_FAILED
, MACHINE_CIC_RENEWED
, MACHINE_SUSPEND_INIT
, MACHINE_SUSPEND_IN_PROGRESS
, MACHINE_SUSPENDED_MIC_OPERATIONAL
, MACHINE_SUSPENDED_CIC_OPERATIONAL
, MACHINE_SUSPEND_FAILED
, MACHINE_SUSPENDED_EMPTY_TOKEN
, MACHINE_SUSPENDED_INVALID_TOKEN
, MACHINE_SUSPENDED_TOKEN_EXPIRED
, MACHINE_SUSPENDED
, MACHINE_SUSPEND_FAILED_TIMEOUT
, MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS
, MACHINE_ALLOCATED_TO_SHELL
]
The device renew states.
The sales order number.
Possible values: [MACHINE_SHIPPED
, MACHINE_SHIPPED_CORRECT_ADDRESS
, MACHINE_SHIPPED_WRONG_ADDRESS
, MACHINE_NOT_SHIPPED
]
The shipping status.
Sl No
Possible values: [MANUFACTURED
, MANUFACTURED_QA_PENDING
, MANUFACTURED_QA_OK
, MANUFACTURED_QA_NOK
, MANUFACTURED_BATTERY_TEST_PENDING
, MANUFACTURED_BATTERY_TEST_START
, MANUFACTURED_BATTERY_TEST_PASS
, MANUFACTURED_BATTERY_TEST_FAILED
, MANUFACTURED_MIC_ISSUE_PENDING
, MANUFACTURED_MIC_ISSUED
, MANUFACTURED_MIC_FAILED
, MANUFACTURED_MIC_OPERATIONAL
, MANUFACTURED_CIC_ISSUE_PENDING
, MANUFACTURED_CIC_ISSUED
, MANUFACTURED_CIC_REVOKED
, MANUFACTURED_CIC_OPERATIONAL
, MANUFACTURED_MIC_SIGNING_PENDING
, MANUFACTURED_CIC_SIGNING_PENDING
, MACHINE_ALLOCATED
, MACHINE_ALLOCATED_TO_ESP
, MACHINE_ELEMENT_ID_PENDING
, MACHINE_INIT
, MACHINE_INIT_FAILED
, MACHINE_ASSIGNED
, MACHINE_CLAIM_PENDING
, MACHINE_CLAIMED
, MACHINE_CLAIM_FAILED
, MACHINE_TO_BE_RETURNED
, MACHINE_RETURNED
, MACHINE_REVOKED
, MACHINE_ELEMENT_DELETE_PENDING
, MACHINE_RETURN_FAILED
, MACHINE_RECEIVED_STOCK
, REMANUFACTURED
, MACHINE_RETIRED
, MACHINE_RECOVER
, MACHINE_DECOMMISSIONED
, MACHINE_CLAIM_VALID
, MACHINE_CLAIM_INVALID
, MACHINE_CIC_RENEW_INITIAL
, MACHINE_CIC_RENEW_ISSUE_PENDING
, MACHINE_CIC_RENEW_ISSUED
, MACHINE_CIC_RENEW_SIGNING_PENDING
, MACHINE_CIC_RENEW_FAILED
, MACHINE_CIC_RENEWED
, MACHINE_SUSPEND_INIT
, MACHINE_SUSPEND_IN_PROGRESS
, MACHINE_SUSPENDED_MIC_OPERATIONAL
, MACHINE_SUSPENDED_CIC_OPERATIONAL
, MACHINE_SUSPEND_FAILED
, MACHINE_SUSPENDED_EMPTY_TOKEN
, MACHINE_SUSPENDED_INVALID_TOKEN
, MACHINE_SUSPENDED_TOKEN_EXPIRED
, MACHINE_SUSPENDED
, MACHINE_SUSPEND_FAILED_TIMEOUT
, MACHINE_ALLOCATION_TO_SHELL_IN_PROGRESS
, MACHINE_ALLOCATED_TO_SHELL
]
The suspend state.
A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$.
{
"connected": true,
"console_conf_passphrase": "string",
"element_shell_id": "string",
"em_element_id": "string",
"esp_tenant_id": "string",
"hw_id": "string",
"id": "string",
"image_version": "string",
"inventory_op": "CLAIM",
"is_eval": "string",
"machine_state": "MANUFACTURED",
"manufacture_id": "string",
"model_name": "string",
"ordering_info": "string",
"owner_tenant_id": "string",
"pki_op": {
"ca_list": [
"string"
],
"operation": "UPDATE_CASTORE"
},
"renew_state": "MANUFACTURED",
"sales_order_number": "string",
"ship_state": "MACHINE_SHIPPED",
"sl_no": "string",
"suspend_state": "MANUFACTURED",
"token": "string"
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_ESP_CLIENT"
},
{
"code": "TENANT_REGION_ASSOCIATION_NOT_FOUND"
},
{
"code": "MACHINE_UNKNOWN"
},
{
"code": "OPERATION_NOT_ALLOWED"
},
{
"code": "INVALID_OPERATION"
},
{
"code": "INVALID_STATE",
"description": "If the machine is not in to_be_returned state or allocated_to_esp states, use /operations API to move it to to_be_returned (return operation) or allocated_to_esp (esp_received stock operation) state, before attempting to reallocate the machine to another client tenant."
},
{
"code": "MACHINE_DELETE_DEFAULT_REGION"
},
{
"code": "INVALID_MACHINE_REGION"
}
]
}
}