Skip to main content

Get Tenant Machine (v2.3)

GET 
/sdwan/v2.3/api/machines/:machine_id

Get a specific machine of a tenant.

Request​

Path Parameters

    machine_id stringrequired

    The machine ID.

Responses​

Successful Operation

Schema
    connected boolean

    The device is connected. True or False.

    console_conf_passphrase string

    The console password.

    em_element_id string

    The element ID.

    esp_tenant_id string

    The MSP tenant ID.

    hw_id stringrequired

    The hardware ID.

    id string

    Id

    image_version stringrequired

    The image version.

    inventory_op string

    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.

    machine_state stringrequired

    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.

    manufacture_id stringrequired

    The manufacture ID.

    model_name stringrequired

    The model name of the device.

    ordering_info string

    The order information.

    owner_tenant_id string

    The owner tenant ID.

    pki_op CAStoreOperation

    Pki Op

    ca_list string[]

    Ca List

    operation string

    Possible values: [UPDATE_CASTORE]

    Operation

    renew_state stringrequired

    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.

    sales_order_number string

    The sales order number.

    ship_state stringrequired

    Possible values: [MACHINE_SHIPPED, MACHINE_SHIPPED_CORRECT_ADDRESS, MACHINE_SHIPPED_WRONG_ADDRESS, MACHINE_NOT_SHIPPED]

    The shipping status.

    sl_no stringrequired

    The serial number.

    suspend_state stringrequired

    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.

    token string

    A valid token. Value = ^[a-zA-Z0-9_-]{1,1000}$.

Loading...