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
The tenant ID.
The site ID.
The element ID.
- application/json
Body
Update admin state
Possible values: [ALLOCATE
, CLAIM
, BOUND
, UNBOUND
, DECLAIM
, RETURN
, REVOKE
, RETIRE
, STOCK
, UPGRADE
, REMANUFACTURE
, DEFAULT
, INVALID
]
The values of admin actions that can be performed.
Possible values: [NONE
, HUB
, SPOKE
, PA_WE_BR
, PA_WE_DC
, PA_CONN
]
The allowed roles.
The cluster insertion mode.
The cluster member ID.
The element is connected. True or False.
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.
The description of the element.
The hardware ID.
Id
The model name of the device.
The name of the device.
Possible values: [NONE
, HUB
, SPOKE
, PA_WE_BR
, PA_WE_DC
, PA_CONN
]
The element role.
The serial number.
The site ID.
The software version.
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
, ACTIVE_DECLAIMED
]
The element state.
Responses
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [ALLOCATE
, CLAIM
, BOUND
, UNBOUND
, DECLAIM
, RETURN
, REVOKE
, RETIRE
, STOCK
, UPGRADE
, REMANUFACTURE
, DEFAULT
, INVALID
]
The values of admin actions that can be performed.
Possible values: [NONE
, HUB
, SPOKE
, PA_WE_BR
, PA_WE_DC
, PA_CONN
]
The allowed roles.
The cluster insertion mode.
The cluster member ID.
The element is connected. True or False.
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.
The description of the element.
The hardware ID.
Id
The model name of the device.
The name of the device.
Possible values: [NONE
, HUB
, SPOKE
, PA_WE_BR
, PA_WE_DC
, PA_CONN
]
The element role.
The serial number.
The site ID.
The software version.
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
, ACTIVE_DECLAIMED
]
The element state.
{
"admin_action": "ALLOCATE",
"allowed_roles": [
"NONE"
],
"cluster_insertion_mode": "string",
"cluster_member_id": "string",
"connected": true,
"deployment_op": "DECLAIM",
"hw_id": "string",
"id": "string",
"model_name": "string",
"name": "string",
"role": "NONE",
"serial_number": "string",
"site_id": "string",
"software_version": "string",
"state": "ACTIVE_INIT"
}