Query LAN Networks (v3.2)

POST 
/sdwan/v3.2/api/sites/:site_id/lannetworks/query

Query LAN networks that match query parameters.

Request

Path Parameters

site_id stringrequired

The ID of the site.

application/json

Body

aggregate Aggregate

The aggregate number of LAN networks that match the query parameters.

data AggregateData[]

The details of the aggregate data.

Array [

value number

Value of the aggregate data.

view object

View the aggregate date.

]

field string

The field value.

name string

The name of the query response.

operator string

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

The operator values.

statistic string

The aggregate statistics.

unit string

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number of LAN networks deleted for a time frame.

group_by string[]

Group the LAN networks for the query.

id string

Lists the LAN networks by ID.

last_query_ts int64

Return the ID of a specified query in the current session.

limit int32

The query limit.

next_query object

The limit.

query_params object
retrieved_fields string[]

Retrieve information from a field.

retrieved_fields_mask boolean

List the fields to query.

sort_params object
total_count int64

The total number of query parameters.

Responses

200

Successful Operation

application/json

Schema

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.

total_count int64

Total number.

items LANNetworkQueryFilterV3N2[]
Array [
description
The description of the LAN network. Maz size = 256.
id string
The ID of the LAN network.
ipv4_config LanNetworkIPv4Config
The Ipv4 config of the LAN network. Maz size = 256.
default_routers string[]
The default routers configured for the network.
dhcp_relay DHCPRelay
Details of DHCP relay if enabled.
enabled boolean
Indicates if DHCP relay is enabled.
option_82 DHCPRelayOption82
Details of option_82 if enabled. The ION device DHCP Relay agent can include additional information by using DHCP Option 82, Circuit ID, and Remote ID, which the DHCP server uses to allocate the appropriate IP address.
circuit_id string
The DHCP relay circuit ID.
enabled boolean
Option 82 if enabled.
reforwarding_policy stringrequired
Possible values: [REPLACE, KEEP, APPEND, DROP]
The DHCP server reforwarding policy.
remote_id string
The DHCP server remote ID.
server_ips string[]
The DHCP server IP addresses.
source_interface string
The DHCP server source interface.
dhcp_server DHCPServer
Details of DHCP server if configured.
broadcast_address string
The address of the site.
custom_options BaseCustomDHCPOptions[]
Custom options defined for the DHCP server.
Array [
option_definition stringrequired
Custom option definition. Max length supported is 1024.
option_value stringrequired
Custom option value. Max length supported is 8192.
]
default_lease_time int64
The lease time each client will get if a user does not request a particular lease time.
description
Description of each instance of the DHCP server, per subnet.
disabled boolean
Uncheck to enable the configuration.
dns_servers string[]
The domain name servers for clients to resolve DNS requests. Max number is 3.
domain_name string
The domain name for clients. Max length is 256.
gateway string
The default gateway for clients.
id string
The DHCP server ID.
ip_ranges IPRange[]required
The valid IPv4 address range for defined subnet.
Array [
end_ip stringrequired
The original end IP address for the defined subnet.
start_ip stringrequired
The original start IP address for the defined subnet.
]
max_lease_time int64
The maximum lease time the clients can use.
network_context_id string
ID of the network context, if configured.
static_mappings StaticMapping[]
IP addresses assigned to clients by statically mapping IPs to MAC addresses of the clients.
Array [
ip_address stringrequired
IP addresses assigned mapped to MAC addresses of the clients.
mac string
The mac addresses that need to be mapped.
name stringrequired
The name of the static mapping. Max length supported is 256.
]
subnet stringrequired
The subnet for which the DHCP server is being configured.
tags string[]
An information field that can be added to identify the DHCP server.
prefixes string[]
List of IP addresses for the network.
ipv6_config LanNetworkIPv6Config
The Ipv6 config of the LAN network. Maz size = 256.
default_routers string[]
The LAN config default routers.
prefixes string[]
The LAN config IPv6 prefix.
name stringrequired
The name of the LAN network. Max size = 128.
network_context_id string
The network context ID.
scope stringrequired
Possible values: [GLOBAL, LOCAL]
The scope of the network.
tags string[]
An information field that can be added to identify the LAN network. Maximum 10 unique tags of length 1024 each are allowed.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "total_count": 0,
  "items": [
    {
      "id": "string",
      "ipv4_config": {
        "default_routers": [
          "string"
        ],
        "dhcp_relay": {
          "enabled": true,
          "option_82": {
            "circuit_id": "string",
            "enabled": true,
            "reforwarding_policy": "REPLACE",
            "remote_id": "string"
          },
          "server_ips": [
            "string"
          ],
          "source_interface": "string"
        },
        "dhcp_server": {
          "broadcast_address": "string",
          "custom_options": [
            {
              "option_definition": "string",
              "option_value": "string"
            }
          ],
          "default_lease_time": 0,
          "disabled": true,
          "dns_servers": [
            "string"
          ],
          "domain_name": "string",
          "gateway": "string",
          "id": "string",
          "ip_ranges": [
            {
              "end_ip": "string",
              "start_ip": "string"
            }
          ],
          "max_lease_time": 0,
          "network_context_id": "string",
          "static_mappings": [
            {
              "ip_address": "string",
              "mac": "string",
              "name": "string"
            }
          ],
          "subnet": "string",
          "tags": [
            "string"
          ]
        },
        "prefixes": [
          "string"
        ]
      },
      "ipv6_config": {
        "default_routers": [
          "string"
        ],
        "prefixes": [
          "string"
        ]
      },
      "name": "string",
      "network_context_id": "string",
      "scope": "GLOBAL",
      "tags": [
        "string"
      ]
    }
  ]
}

Loading...