Skip to main content

Update Admin State Northbound (v2.0)

PUT 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/admin_state

Update admin state Northbound.

Request​

Path Parameters

    tenant_id stringrequired

    The tenant ID.

    site_id stringrequired

    The site ID.

    element_id stringrequired

    The element ID.

Body

Update admin state

    admin_action string

    Possible values: [ALLOCATE, CLAIM, BOUND, UNBOUND, DECLAIM, RETURN, REVOKE, RETIRE, STOCK, UPGRADE, REMANUFACTURE, DEFAULT, INVALID]

    The values of admin actions that can be performed.

    allowed_roles string[]

    Possible values: [NONE, HUB, SPOKE, PA_WE_BR, PA_WE_DC, PA_CONN]

    The allowed roles.

    cluster_insertion_mode string

    The cluster insertion mode.

    cluster_member_id string

    The cluster member ID.

    connected boolean

    The element is connected. True or False.

    deployment_op string

    Possible values: [DECLAIM, UPGRADE, ABORT_UPGRADE, DEFAULT, INVALID, REBIND, READY, IN_SERVICE, REUNBIND, RENEW_CIC, ABORT_CELLULARMODULE_FIRMWARE_UPGRADE, FIPS_AUTO, NON_FIPS_AUTO, FIPS_MANUAL, NON_FIPS_MANUAL, GET_MAC_ADDRESS_TABLE]

    The deployment values.

    description

    The description of the element.

    hw_id string

    The hardware ID.

    id string

    Id

    model_name string

    The model name of the device.

    name string

    The name of the device.

    role string

    Possible values: [NONE, HUB, SPOKE, PA_WE_BR, PA_WE_DC, PA_CONN]

    The element role.

    serial_number string

    The serial number.

    site_id stringrequired

    The site ID.

    software_version string

    The software version.

    state string

    Possible values: [ACTIVE_INIT, ACTIVE_INVENTORY_IN_PROGRESS, ACTIVE_INVENTORY_OPERATION_FAILED, ACTIVE_INVENTORY_GET_PENDING, ACTIVE_INVENTORY_GET_COMPLETE, ACTIVE_INVENTORY_POST_PENDING, ACTIVE_INTF_CONFIG_GET_FAILED, ACTIVE_INTF_STATE_GET_FAILED, ACTIVE_READY, ACTIVE_BOUND_IN_PROGRESS, ACTIVE_UNBOUND_IN_PROGRESS, ACTIVE_UNBOUND_FROM_SITE_FAILED, ACTIVE_BOUND_TO_SITE, ACTIVE_BOUND_TO_SITE_FAILED, OOS, ACTIVE_DECLAIM_IN_PROGRESS]

    The element state.

Responses​

Successful Operation

Schema
    admin_action string

    Possible values: [ALLOCATE, CLAIM, BOUND, UNBOUND, DECLAIM, RETURN, REVOKE, RETIRE, STOCK, UPGRADE, REMANUFACTURE, DEFAULT, INVALID]

    The values of admin actions that can be performed.

    allowed_roles string[]

    Possible values: [NONE, HUB, SPOKE, PA_WE_BR, PA_WE_DC, PA_CONN]

    The allowed roles.

    cluster_insertion_mode string

    The cluster insertion mode.

    cluster_member_id string

    The cluster member ID.

    connected boolean

    The element is connected. True or False.

    deployment_op string

    Possible values: [DECLAIM, UPGRADE, ABORT_UPGRADE, DEFAULT, INVALID, REBIND, READY, IN_SERVICE, REUNBIND, RENEW_CIC, ABORT_CELLULARMODULE_FIRMWARE_UPGRADE, FIPS_AUTO, NON_FIPS_AUTO, FIPS_MANUAL, NON_FIPS_MANUAL, GET_MAC_ADDRESS_TABLE]

    The deployment values.

    description

    The description of the element.

    hw_id string

    The hardware ID.

    id string

    Id

    model_name string

    The model name of the device.

    name string

    The name of the device.

    role string

    Possible values: [NONE, HUB, SPOKE, PA_WE_BR, PA_WE_DC, PA_CONN]

    The element role.

    serial_number string

    The serial number.

    site_id stringrequired

    The site ID.

    software_version string

    The software version.

    state string

    Possible values: [ACTIVE_INIT, ACTIVE_INVENTORY_IN_PROGRESS, ACTIVE_INVENTORY_OPERATION_FAILED, ACTIVE_INVENTORY_GET_PENDING, ACTIVE_INVENTORY_GET_COMPLETE, ACTIVE_INVENTORY_POST_PENDING, ACTIVE_INTF_CONFIG_GET_FAILED, ACTIVE_INTF_STATE_GET_FAILED, ACTIVE_READY, ACTIVE_BOUND_IN_PROGRESS, ACTIVE_UNBOUND_IN_PROGRESS, ACTIVE_UNBOUND_FROM_SITE_FAILED, ACTIVE_BOUND_TO_SITE, ACTIVE_BOUND_TO_SITE_FAILED, OOS, ACTIVE_DECLAIM_IN_PROGRESS]

    The element state.

Loading...