Query DB for Site LAN Networks (v3.1)
Query the DB for site LAN networks that match query parameters.
Path Parameters
- tenant_id string required
The ID of the tenant.
- application/json
Request Body
aggregate Aggregate
The aggregate number of LAN networks that match the query parameters.
field stringThe field value.
operator stringPossible values: [
max
,count
,min
,avg
,sum
]The operator values.
- 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.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- count int32
The count of the query list.
- deleted_count int64
The deleted number of queries.
- deleted_ids string[]
The deleted query IDs.
- description
Description of the query. Max size = 256.
- id string
The ID.
- next_query object
Details of the next query.
- tenant_id string
- total_count int64
Total number of queries.
items LANNetworkQueryFilterResponse[]
Array [descriptionThe description of the LAN network. Maz size = 256.
id stringThe 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 booleanIndicates 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 stringThe DHCP relay circuit ID.
enabled booleanOption 82 if enabled.
reforwarding_policy string requiredPossible values: [
REPLACE
,KEEP
,APPEND
,DROP
]The DHCP server reforwarding policy.
remote_id stringThe DHCP server remote ID.
server_ips string[]The DHCP server IP addresses.
source_interface stringThe DHCP server source interface.
dhcp_server DHCPServer
Details of DHCP server if configured.
broadcast_address stringThe address of the site.
custom_options BaseCustomDHCPOptions[]
Custom options defined for the DHCP server.
Array [option_definition string requiredCustom option definition. Max length supported is 1024.
option_value string requiredCustom option value. Max length supported is 8192.
]default_lease_time int64The lease time each client will get if a user does not request a particular lease time.
descriptionDescription of each instance of the DHCP server, per subnet.
disabled booleanUncheck to enable the configuration.
dns_servers string[]The domain name servers for clients to resolve DNS requests. Max number is 3.
domain_name stringThe domain name for clients. Max length is 256.
gateway stringThe default gateway for clients.
id stringThe DHCP server ID.
ip_ranges IPRange[] required
The valid IPv4 address range for defined subnet.
Array [end_ip string requiredThe original end IP address for the defined subnet.
start_ip string requiredThe original start IP address for the defined subnet.
]max_lease_time int64The maximum lease time the clients can use.
network_context_id stringID 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 string requiredIP addresses assigned mapped to MAC addresses of the clients.
mac string requiredThe mac addresses that need to be mapped.
name string requiredThe name of the static mapping. Max length supported is 256.
]subnet string requiredThe 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.
name string requiredThe name of the LAN network. Max size = 128.
network_context_id stringThe network context ID.
scope string requiredPossible values: [
GLOBAL
,LOCAL
]The scope of the network.
site_id string requiredThe ID of the site.
tags string[]An information field that can be added to identify the LAN network. Maximum 10 unique tags of length 1024 each are allowed.
]
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"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"
]
},
"name": "string",
"network_context_id": "string",
"scope": "GLOBAL",
"site_id": "string",
"tags": [
"string"
]
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "BAD_REQUEST"
}
]
}
}