Query DB for Elements (v3.1)
POST/v3.1/api/tenants/:tenant_id/elements/query
Query the DB for elements that match the query parameters.
Request
Path Parameters
The tenant ID.
- application/json
Body
Queries to the element
- Array [
- ]
aggregate Aggregate
Aggregate
data AggregateData[]
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
Field
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
Operator
QoS application aggregate statistics.
The unit.
The description of the element.
Dest Page
GetDeleted
Group By
Id
Last Query Ts
Limit
Retrieved Fields
Retrieved Fields Mask
Total Count
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- Array [
- ]
- ]
The actual count.
The deleted number.
The deleted IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
The tenant ID.
Total number.
items ElementQueryFilterV3N1[]
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: [SLEEP
, INIT
, ACTIVE
, ACTIVE_ASSIGNED_DEFAULT
, ACTIVE_ASSIGNED_TENANT
, ACTIVE_TRUSTED
, ACTIVE_NOCERT
, ACTIVE_CLAIMED
, ACTIVE_MIC
, ACTIVE_MIC_PENDING
, ACTIVE_MIC_ISSUED
, ACTIVE_MIC_FAILED
, ACTIVE_CIC
, ACTIVE_CIC_SITE
, ACTIVE_CIC_PENDING
, ACTIVE_CIC_ISSUED
, ACTIVE_CIC_FAILED
, ACTIVE_INVENTORY_IN_PROGRESS
, ACTIVE_INVENTORY_GET_PENDING
, ACTIVE_INVENTORY_POST_PENDING
, ACTIVE_INVENTORY_GET_COMPLETE
, ACTIVE_INVENTORY_GET_FAILED
, ACTIVE_INVENTORY_OPERATION_FAILED
, ACTIVE_INTF_CONFIG_GET_PENDING
, ACTIVE_INTF_CONFIG_GET_COMPLETE
, ACTIVE_INTF_CONFIG_GET_FAILED
, ACTIVE_INTF_STATE_GET_PENDING
, ACTIVE_INTF_STATE_GET_COMPLETE
, ACTIVE_INTF_STATE_GET_FAILED
, ACTIVE_BOUND_TO_SITE_PENDING
, ACTIVE_BOUND_TO_SITE
, ACTIVE_BOUND_TO_SITE_FAILED
, ACTIVE_READY
, ACTIVE_RENEW_PENDING
, ACTIVE_RENEWED
, ACTIVE_DECLAIM_IN_PROGRESS
, ACTIVE_DECLAIMED
, ACTIVE_UNBOUND_FROM_SITE
, ACTIVE_UNBOUND_IN_PROGRESS
, ACTIVE_UNBOUND_FROM_SITE_FAILED
, ACTIVE_CIC_CERTIFICATE_CHECK
, ACTIVE_MONITORING
, ACTIVE_CONNECTED
, ACTIVE_24_HOURS_LESS
, ACTIVE_24_HOURS_MORE
, ACTIVE_TROUBLESHOOT
, ACTIVE_SUSPEND_INIT
, ACTIVE_SUSPEND_IN_PROGRESS
, ACTIVE_SUSPENDED
, ACTIVE_SUSPEND_FAILED
, ACTIVE_SUSPEND_FAILED_TIMEOUT
, ACTIVE_SUSPENDED_MIC_OPERATIONAL
, ACTIVE_SUSPENDED_CIC_OPERATIONAL
, ACTIVE_SUSPENDED_EMPTY_TOKEN
, ACTIVE_SUSPENDED_TOKEN_EXPIRED
, INACTIVE_NOCERT
, INACTIVE_MIC
, INACTIVE_CIC
, INACTIVE_CIC_SITE
, RETURNED
, STANDBY
, OOS_AT_READY
, OOS_AT_INIT
, OOS_AT_BIND_PENDING
, OOS_AT_BIND
, OOS_AT_BIND_FAILED
, OOS_AT_UNBIND_FAILED
, OOS_AT_UNBIND_PROGRESS
, DECOMMISSION
]
The values of admin renew state.
Possible values: [SLEEP
, INIT
, ACTIVE
, ACTIVE_ASSIGNED_DEFAULT
, ACTIVE_ASSIGNED_TENANT
, ACTIVE_TRUSTED
, ACTIVE_NOCERT
, ACTIVE_CLAIMED
, ACTIVE_MIC
, ACTIVE_MIC_PENDING
, ACTIVE_MIC_ISSUED
, ACTIVE_MIC_FAILED
, ACTIVE_CIC
, ACTIVE_CIC_SITE
, ACTIVE_CIC_PENDING
, ACTIVE_CIC_ISSUED
, ACTIVE_CIC_FAILED
, ACTIVE_INVENTORY_IN_PROGRESS
, ACTIVE_INVENTORY_GET_PENDING
, ACTIVE_INVENTORY_POST_PENDING
, ACTIVE_INVENTORY_GET_COMPLETE
, ACTIVE_INVENTORY_GET_FAILED
, ACTIVE_INVENTORY_OPERATION_FAILED
, ACTIVE_INTF_CONFIG_GET_PENDING
, ACTIVE_INTF_CONFIG_GET_COMPLETE
, ACTIVE_INTF_CONFIG_GET_FAILED
, ACTIVE_INTF_STATE_GET_PENDING
, ACTIVE_INTF_STATE_GET_COMPLETE
, ACTIVE_INTF_STATE_GET_FAILED
, ACTIVE_BOUND_TO_SITE_PENDING
, ACTIVE_BOUND_TO_SITE
, ACTIVE_BOUND_TO_SITE_FAILED
, ACTIVE_READY
, ACTIVE_RENEW_PENDING
, ACTIVE_RENEWED
, ACTIVE_DECLAIM_IN_PROGRESS
, ACTIVE_DECLAIMED
, ACTIVE_UNBOUND_FROM_SITE
, ACTIVE_UNBOUND_IN_PROGRESS
, ACTIVE_UNBOUND_FROM_SITE_FAILED
, ACTIVE_CIC_CERTIFICATE_CHECK
, ACTIVE_MONITORING
, ACTIVE_CONNECTED
, ACTIVE_24_HOURS_LESS
, ACTIVE_24_HOURS_MORE
, ACTIVE_TROUBLESHOOT
, ACTIVE_SUSPEND_INIT
, ACTIVE_SUSPEND_IN_PROGRESS
, ACTIVE_SUSPENDED
, ACTIVE_SUSPEND_FAILED
, ACTIVE_SUSPEND_FAILED_TIMEOUT
, ACTIVE_SUSPENDED_MIC_OPERATIONAL
, ACTIVE_SUSPENDED_CIC_OPERATIONAL
, ACTIVE_SUSPENDED_EMPTY_TOKEN
, ACTIVE_SUSPENDED_TOKEN_EXPIRED
, INACTIVE_NOCERT
, INACTIVE_MIC
, INACTIVE_CIC
, INACTIVE_CIC_SITE
, RETURNED
, STANDBY
, OOS_AT_READY
, OOS_AT_INIT
, OOS_AT_BIND_PENDING
, OOS_AT_BIND
, OOS_AT_BIND_FAILED
, OOS_AT_UNBIND_FAILED
, OOS_AT_UNBIND_PROGRESS
, DECOMMISSION
]
The values of the admin suspend state.
Possible values: [NONE
, HUB
, SPOKE
, PA_WE_BR
, PA_WE_DC
, PA_CONN
]
The allowed roles.
Cluster 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.
Device Change Mode Start Time
Possible values: [ELEMENT_CHANGE_MODE_INIT
, ELEMENT_CHANGE_MODE_IN_PROGRESS
, ELEMENT_CHANGE_MODE_FAILED
, ELEMENT_CHANGE_MODE_TIMEOUT
, ELEMENT_CHANGE_MODE
]
Device Change Mode State
Possible values: [none
, l3-mode
, l2-mode
]
Device Mode
The device profile ID.
Possible values: [none
, fips
, non_fips
]
The FIPs mode.
The FIPs mode change starting time.
The hardware ID.
Id
The L3 direct private WAN is enabled. True or False.
The L3 LAN forwarding is enabled. Yes indicates that traffic forwarding to and from LAN interface, when Enable L3 Direct Private WAN Forwarding is enabled.
led_config LedConfig
Valid LED config.
Service Led On
The main power usage threshold. Allowed range is 50-100.
The model name of the device.
The name of the device.
ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack API.
The ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack API.
The override indicator.
ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack API.
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.
spoke_ha_config SpokeHAConfigV2
The details of the spoke HA configuration.
The spoke HA config cluster ID.
The spoke HA config enabled. True or False.
The priority of the spoke HA config.
The spoke HA config source interface ID.
track TrackV2
Track: Valid
interfaces TrackInterface[]
The details of the interfaces.
The interface ID
Reduce priority of the spoke HA config.
waninterfaces TrackWANInterface[]
Waninterfaces: Valid
Reduce priority of the spoke HA config.
The WAN interface ID
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.
switch_config SwitchConfig
The details of the switch configuration.
Default VLAN ID is 1.
The MSTP enabled. True or False.
The STP aging Timer between 10 - 1000000 seconds.
Forward Delay is the length of time spent in listening state, set the value between 4 - 30 seconds.
Hello Time is the time Interval between BPDU transmission, set the value between 1-10 seconds.
The length of Max Age time that the switch retains information learned from BPDUs, set the value between 6 - 40 seconds.
Possible values: [RSTP
]
The STP Mode is RSTP, default STP mode is RSTP
The Priority value is between 0 - 61440, in multiples of 4096.
A information field that can be added to identify the element.
The tenant ID.
VPN to VPN forwarding. True or False.
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"admin_action": "ALLOCATE",
"admin_renew_state": "SLEEP",
"admin_suspend_state": "SLEEP",
"allowed_roles": [
"NONE"
],
"cluster_id": "string",
"connected": true,
"deployment_op": "DECLAIM",
"device_change_mode_start_time": 0,
"device_change_mode_state": "ELEMENT_CHANGE_MODE_INIT",
"device_mode": "none",
"device_profile_id": "string",
"fips_mode": "none",
"fips_mode_change_start_time": 0,
"hw_id": "string",
"id": "string",
"l3_direct_private_wan_forwarding": true,
"l3_lan_forwarding": true,
"led_config": {
"service_led_on": true
},
"main_power_usage_threshold": 0,
"model_name": "string",
"name": "string",
"nat_policysetstack_id": "string",
"network_policysetstack_id": "string",
"override_indicator": [
"string"
],
"priority_policysetstack_id": "string",
"role": "NONE",
"serial_number": "string",
"site_id": "string",
"software_version": "string",
"spoke_ha_config": {
"cluster_id": "string",
"enable": true,
"priority": 0,
"source_interface": "string",
"track": {
"interfaces": [
{
"interface_id": "string",
"reduce_priority": 0
}
],
"waninterfaces": [
{
"reduce_priority": 0,
"wan_interface_id": "string"
}
]
}
},
"state": "ACTIVE_INIT",
"switch_config": {
"default_vlan_id": 0,
"mstp_enabled": true,
"stp_aging_timer": 0,
"stp_forward_delay": 0,
"stp_hello_time": 0,
"stp_max_age": 0,
"stp_mode": "RSTP",
"stp_priority": 0
},
"tags": [
"string"
],
"tenant_id": "string",
"vpn_to_vpn_forwarding": true
}
]
}
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": "BAD_REQUEST"
}
]
}
}