Skip to main content

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

    tenant_id stringrequired

    The tenant ID.

Body

Queries to the element

    aggregate Aggregate

    Aggregate

    data AggregateData[]

    The details of the aggregate data.

  • Array [
  • value number

    Value of the aggregate data.

    view object

    View the aggregate date.

  • ]
  • field string

    Field

    name string

    The name of the query response.

    operator string

    Possible values: [max, count, min, avg, sum]

    Operator

    statistic string

    QoS application aggregate statistics.

    unit string

    The unit.

    description

    The description of the element.

    dest_page int32

    Dest Page

    getDeleted boolean

    GetDeleted

    group_by string[]

    Group By

    id string

    Id

    last_query_ts int64

    Last Query Ts

    limit int32

    Limit

    next_query object
    query_params object
    retrieved_fields string[]

    Retrieved Fields

    retrieved_fields_mask boolean

    Retrieved Fields Mask

    sort_params object
    total_count int64

    Total Count

Responses

Successful Operation

Schema
    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.

    description

    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    tenant_id string

    The tenant ID.

    total_count int64

    Total number.

    items ElementQueryFilterV3N1[]
  • Array [
  • 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.

    admin_renew_state string

    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.

    admin_suspend_state string

    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.

    allowed_roles string[]

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

    The allowed roles.

    cluster_id string

    Cluster 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.

    device_change_mode_start_time int64

    Device Change Mode Start Time

    device_change_mode_state string

    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

    device_mode string

    Possible values: [none, l3-mode, l2-mode]

    Device Mode

    device_profile_id string

    The device profile ID.

    fips_mode string

    Possible values: [none, fips, non_fips]

    The FIPs mode.

    fips_mode_change_start_time int64

    The FIPs mode change starting time.

    hw_id string

    The hardware ID.

    id string

    Id

    l3_direct_private_wan_forwarding boolean

    The L3 direct private WAN is enabled. True or False.

    l3_lan_forwarding boolean

    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 boolean

    Service Led On

    main_power_usage_threshold int32

    The main power usage threshold. Allowed range is 50-100.

    model_name string

    The model name of the device.

    name string

    The name of the device.

    nat_policysetstack_id string

    ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack API.

    network_policysetstack_id string

    The ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack API.

    override_indicator string[]

    The override indicator.

    priority_policysetstack_id string

    ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack API.

    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.

    spoke_ha_config SpokeHAConfigV2

    The details of the spoke HA configuration.

    cluster_id stringrequired

    The spoke HA config cluster ID.

    enable booleanrequired

    The spoke HA config enabled. True or False.

    priority int32required

    The priority of the spoke HA config.

    source_interface stringrequired

    The spoke HA config source interface ID.

    track TrackV2

    Track: Valid

    interfaces TrackInterface[]

    The details of the interfaces.

  • Array [
  • interface_id string

    The interface ID

    reduce_priority int32

    Reduce priority of the spoke HA config.

  • ]
  • waninterfaces TrackWANInterface[]

    Waninterfaces: Valid

  • Array [
  • reduce_priority int32

    Reduce priority of the spoke HA config.

    wan_interface_id string

    The WAN interface ID

  • ]
  • 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, ACTIVE_DECLAIMED]

    The element state.

    switch_config SwitchConfig

    The details of the switch configuration.

    default_vlan_id int32

    Default VLAN ID is 1.

    mstp_enabled boolean

    The MSTP enabled. True or False.

    stp_aging_timer int32

    The STP aging Timer between 10 - 1000000 seconds.

    stp_forward_delay int32

    Forward Delay is the length of time spent in listening state, set the value between 4 - 30 seconds.

    stp_hello_time int32

    Hello Time is the time Interval between BPDU transmission, set the value between 1-10 seconds.

    stp_max_age int32

    The length of Max Age time that the switch retains information learned from BPDUs, set the value between 6 - 40 seconds.

    stp_mode stringrequired

    Possible values: [RSTP]

    The STP Mode is RSTP, default STP mode is RSTP

    stp_priority int32

    The Priority value is between 0 - 61440, in multiples of 4096.

    tags string[]

    A information field that can be added to identify the element.

    tenant_id stringrequired

    The tenant ID.

    vpn_to_vpn_forwarding boolean

    VPN to VPN forwarding. True or False.

  • ]
Loading...