inventory_status¶
Overview¶
This resource can be used for inventory and status
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP
Tags¶
- inventory_status : Operations related to inventory_status
Paths¶
Get operation for inventory_status¶
GET /inventory_status
Description¶
Use this operation to get the inventory and status
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | inventory_status_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- inventory_status
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
appliance_identifier¶
HA identifier for an appliance. If it's 0 then HA primary, else HA secondary
Type : boolean
inventory_status¶
| Name | Schema |
|---|---|
| region_name optional |
region_name |
inventory_status_delete_success_schema¶
| Name | Schema |
|---|---|
| inventory_status optional |
inventory_status |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
inventory_status_post_success_schema¶
| Name | Schema |
|---|---|
| inventory_status optional |
inventory_status |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
inventory_status_put_success_schema¶
| Name | Schema |
|---|---|
| inventory_status optional |
inventory_status |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
inventory_status_request_schema¶
| Name | Schema |
|---|---|
| inventory_status optional |
inventory_status |
inventory_status_response_schema¶
Type : < inventory_status_response_schema > array
inventory_status_response_schema
| Name | Schema |
|---|---|
| appliance_identifier optional |
appliance_identifier |
| last_successful_poll optional |
last_successful_poll |
| latest_record optional |
latest_record |
| management_ip optional |
management_ip |
| model optional |
model |
| poll optional |
poll |
| region_name optional |
region_name |
| registry_timestamp optional |
registry_timestamp |
| serial_number optional |
serial_number |
| site_name optional |
site_name |
| software optional |
software |
| status optional |
status |
last_successful_poll¶
Time when SD-WAN Center successfully applied statistics from Virtual WAN Appliance
Type : string
latest_record¶
Timestamp of last record in statistics received from Virtual WAN Appliance
Type : string
management_ip¶
Management IP address of Virtual WAN Appliance obtained from the active Master Control Node
Type : string
model¶
Virtual WAN model type
Type : string
poll¶
Shows whether an appliance is being polled or not
Type : boolean
region_name¶
Region name
Type : string
registry_timestamp¶
Timestamp of compiled config running on Virtual WAN Appliance
Type : string
serial_number¶
Virtual WAN serial number
Type : string
site_name¶
Site name
Type : string
software¶
Software version running on Virtual WAN Appliance
Type : string
status¶
State of connection to Virtual WAN Appliances during polling or discovery process
Type : string