Get an Interface (v4.18)
GET/v4.18/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/interfaces/:interface_id
List a device interface.
Request
Path Parameters
The tenant ID.
The site ID.
The element ID.
The interface ID.
Responses
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
The interface admin state.
attached_lan_networks LanNetworkVlanMapping[]
The attached lan network ID and vlan ID.
The LAN network ID.
The VLAN ID. VLAN ID should be between 0 and 4095.
authentication_config AuthenticationInterfaceConfig
The authentication config details.
The fallback retry count. The fall back to MAC Auth if the client is not using 802.1x authentication.
Possible values: [none
, dot1x
, macauth
, dot1x-to-macauth-fallback
]
The auth mode.
Reauthentication timeout value.
The bound interfaces.
bypass_pair BypassPairV2
The details of the bypass pair.
Bypass port is connected to a LAN network.
LAN state propagation.
The DHCP relay is selected to Yes.
Bypass port is connected to a WAN network.
cellular_config CellularInterfaceConfig
The cellular config details.
apn_config APNConfig
The APN config details.
The cellular interface APN config profile name.
Possible values: [none
, pap
, chap
, pap_or_chap
]
The APN authentication values.
Clear password. True/False.
The password.
The password encrypted (value = true).
The cellular interface APN config user name.
The APN profile ID.
Is auto APN enabled. True / False.
The parent module ID.
The parent sim slot number.
The interface description. Max size = 256.
The device management policy set stack ID.
dhcp_relay DHCPRelay
The DHCP relay information.
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.
The DHCP relay circuit ID.
Option 82 if enabled.
Possible values: [REPLACE
, KEEP
, APPEND
, DROP
]
The DHCP server reforwarding policy.
The DHCP server remote ID.
The DHCP server IP addresses.
The DHCP server source interface.
The directed broadcast.
ethernet_port EthernetPort
The ethernet port information.
Interface running in full duplex mode.
port_id Ethernet
The ethernet port ID.
The ethernet connector type.
The device name.
Disable the port.
Reason to disable the port.
Element ID.
The connector ID.
Port status (active or inactive).
Reason for port being inactive.
The MTU max value.
The max speed value.
The name.
The MAC address.
The region.
The site ID.
The tenant ID.
The ethernet port name.
The ethernet port speed.
The interface ID.
The interface profile ID.
The IPFIX collector context ID.
The IPFIX filter context ID.
ipv4_config Ipv4Config
The ipv4 config information.
dhcp_config Ipv4Dhcp
The DHCP config information.
The client ID.
The IPv4 DHCP host name.
dns_v4_config DNS
The DNS v4 config details.
The DNS name servers
The search parameters.
pppoe_config Ipv4Pppoe
The PPoE config information.
The PPPoE IPv4 CHAP password.
The PPPoE IPv4 CHAP user.
The set route for PPPoE IPv4.
routes Route[]
The ethernet port routes.
The route destination.
The via IP address.
static_config Ipv4Static
The IPv4 static address.
Address
The interface config type. Max = 12.
ipv6_config Ipv6ConfigV1
The ipv6 config information.
dhcp_config Ipv6Dhcp
The DHCP config information.
The client ID.
The IPv6 DHCP host name.
dns_v6_config DNS
The DNS V6 configurations.
The DNS name servers
The search parameters.
routes Route[]
The route details.
The route destination.
The via IP address.
static_config Ipv6StaticV1
The IPv6 static address.
The IPv6 static address.
Is prefix distribution enabled. True or False.
The interface config type. Max = 12.
If LLDP enabled. True/False.
The interface configuration MAC address.
The MTU value of the interface.
multicast_config MulticastInterfaceConfig
The multicast config details.
Possible values: [IGMPV2
, IGMPV3
]
The IGMP version.
Is multicast enabled. True or False.
The name of the interface state. Max size = 128.
The NAT IP address.
The NAT IPV6 address.
nat_pools NatPool[]
The NAT pools information.
ipv4_ranges IPv4Range[]
The NAT Ipv4 address ranges. Minimum 1 and maximum 4 nat pool IP ranges can be specified.
The end IPv4 address.
The start IPv4 address.
The NAT pool ID.
The NAT port. LAN,WAN,Internet bypass ports cannot be part of logical interface groups.
The NAT IPv6 port.Internet bypass ports cannot be part of logical interface groups.
The NAT zone ID.
The network context ID.
The parent value = true.
Possible values: [none
, cellular
]
The peer bypass pair WAN port type.
PoE enabled = true/false.
The interface config PoE power usage threshold. Valid values are in the range 50-100.
pppoe_config PppoEInterfaceConfig
The PPPoE config information.
The host.
IPv4 and IPv6 addresses.
The password for the PPOE interface configuration.
The recoonection delay value.
The name of the service used for the PPPoE configuration.
The username for the PPPoE interface configuration.
Possible values: [GLOBAL
, LOCAL
]
The network scope.
secondary_ip_configs SecondaryIPConfig[]
The interface secondary IP config. Secondary IPs exceed the supported limit of 8.
Ipv4 Address
The scope of the secondary IP config.
service_link_config ServiceLinkV4
The interface secondary IP config. Secondary IPs exceed the supported limit of 8.
gre_config GREConfig
The GRE config details.
The CSUM.
Is keepalive enabled. True or False.
Value between 3 and 10. Indicates the number of consecutive missed keep-alive packets before a link is declared as down. The default value is 3.
Value between 100 ms and 600000 ms. Indicates the time interval in milliseconds between two VPN keepalive packets. The default value is 1000 ms.
ipsec_config IPSECConfigV1
The IPSec config details.
authentication IPSECAuthenticationV1
The IPSec authentication details.
The certificate authentication for the IPsec Profile.
Certificate Profile Id
Comment
ikev1_params IKEV1Params
Ikev1 Params: Valid
The xauth ID.
The authentication secret. Length must be between 4-128.
The xauth secret. Value = True.
The xauth hash. Value = True.
Possible values: [NONE
, SECRET
]
The xauth type.
The local CA certificate uploaded for certificate authentication.
Possible values: [LOCAL_IP
, DN
, HOSTNAME
, CUSTOM
, NONE
]
The local ID type.
The custom local ID.
Local Pa Certificate Id
Pa Master Key Id
Passphrase
Passphrase Encrypted: JsonIgnore(value = true)
Possible values: [EXACT
, WILDCARD
]
Peer Id Check
Permit Peer Id Mismatch
The private key file uploaded for certificate authentication.
Private Key Encrypted: JsonIgnore(value = true)
The standard VPN endpoint CA certificate uploaded.
The ID for the standard VPN endpoint in the Remote ID field.
The password for PSK authentication.
Secret Encrypted: JsonIgnore(value = true)
Secret Hash: JsonIgnore(value = true)
Strict Validation Peer Extended Key Use
Possible values: [NONE
, PSK
, X509
]
The authentication type = PSK or Certificates.
x509Objects X509Objects
X509Objects: JsonIgnore(value = true)
Certificate
Is Local Ca Cert Set
Is Remote Ca Cert Set
Local Ca Certificate
Local Ca Certs Set
Passphrase
Private Key
Remote Ca Certificate
Remote Ca Certs Set
The IPSec profile ID.
The last parent value = true.
The parent value = true.
passive_mode PassiveMode
Passive mode details.
Passive mode enabled for the device. True or False.
Peer IP dynamic enabled. True or False.
peer PeerInfo
The peer information.
The peer hostname.
The peer IP addresses. Max size = 4.
The service endpoint ID.
Possible values: [IPSEC
, GRE
, GENEVE
]
The service link type.
The site WAN interface IDs.
static_arp_configs StaticARPConfig[]
The static ARP config details.
The static APR IPv4 address.
The MAC address.
sub_interface SubInterface
The sub interface vlan ID.
The VLAN ID.
switch_port_config SwitchPortConfig
The switch port config details.
The VLAN access ID.
BPDU Guard enabled on ports do not receive a BPDU from its connected devices. When a BPDU Guard enabled port receives BPDU from a connected device, BPDU Guard disables the port.
The speed. The attached lan network ID and vlan ID.
The VLAN ID.
Root Guard is enabled on a port-by-port basis, it prevents a configured port from becoming a root port. Root Guard prevents a downstream switch from becoming a root bridge in a topology.
storm_control_config StormControlConfig
Storm control config information. Threshold for traffic rate limit, the traffic is rate limited for the set threshold value.
By default, the broadcast threshold is set to 1000kbps. Enter a value between 64 -1000000 kbps.
Multicast threshold value is set between 64-1000000kbps.
Unknown Unicast threshold value is set between 64-1000000 kbps.
STP port cost between 1-65535. The STP port cost depends on the speed of the port.
Spanning Tree Protocol (STP) port enabled.
STP Port priority is between 0-240. The default value is 128, STP port priority is in multiples of 16.
The interface config switch port trunk VLANs. Max trunk VLANs allowed is 32 and no duplicates are allowed.
Possible values: [access
, trunk
]
The VLAN mode.
The voice VLAN ID.
A information field that can be added to identify the interface. Maximum 10 Unique tags of length 1024 each are allowed.
The interface type.
The interface used for value. The allowed values are public,private_wan,lan,none.
vlan_config VlanConfig
The VLAN config details.
Mstp Instance
The VLAN ID.
The voice enabled VLAN.
The VRF (Virtual Routing and Forwarding) ID.
{
"admin_up": true,
"attached_lan_networks": [
{
"lan_network_id": "string",
"vlan_id": 0
}
],
"authentication_config": {
"fallback_retry_count": 0,
"mode": "none",
"reauthentication_timeout": 0
},
"bound_interfaces": [
"string"
],
"bypass_pair": {
"lan": "string",
"lan_state_propagation": true,
"use_relay": true,
"wan": "string"
},
"cellular_config": {
"apn_config": {
"apn": "string",
"authentication": "none",
"clear_password": true,
"password": "string",
"password_encrypted": "string",
"user_name": "string"
},
"apnprofile_id": "string",
"auto_apn": true,
"parent_module_id": "string",
"parent_sim_slot_number": 0
},
"devicemgmt_policysetstack_id": "string",
"dhcp_relay": {
"enabled": true,
"option_82": {
"circuit_id": "string",
"enabled": true,
"reforwarding_policy": "REPLACE",
"remote_id": "string"
},
"server_ips": [
"string"
],
"source_interface": "string"
},
"directed_broadcast": true,
"ethernet_port": {
"full_duplex": true,
"port_id": {
"connector": "string",
"device": "string",
"disabled": true,
"disabled_reason": "string",
"element_id": "string",
"id": "string",
"inactive": true,
"inactive_reason": "string",
"max_mtu": 0,
"max_speed": 0,
"name": "string",
"original_mac_address": "string",
"region": "string",
"site_id": "string",
"tenant_id": "string"
},
"port_name": "string",
"speed": 0
},
"id": "string",
"interface_profile_id": "string",
"ipfixcollectorcontext_id": "string",
"ipfixfiltercontext_id": "string",
"ipv4_config": {
"dhcp_config": {
"client_id": "string",
"hostname": "string"
},
"dns_v4_config": {
"name_servers": [
"string"
],
"search": [
"string"
]
},
"pppoe_config": {
"chap_passwd": "string",
"chap_user": "string",
"set_route": true
},
"routes": [
{
"destination": "string",
"via": "string"
}
],
"static_config": {
"address": "string"
},
"type": "string"
},
"ipv6_config": {
"dhcp_config": {
"client_id": "string",
"hostname": "string"
},
"dns_v6_config": {
"name_servers": [
"string"
],
"search": [
"string"
]
},
"routes": [
{
"destination": "string",
"via": "string"
}
],
"static_config": {
"address": "string",
"enable_prefix_distribution": true
},
"type": "string"
},
"lldp_enabled": true,
"mac_address": "string",
"mtu": 0,
"multicast_config": {
"igmp_version": "IGMPV2",
"multicast_enabled": true
},
"name": "string",
"nat_address": "string",
"nat_address_v6": "string",
"nat_pools": [
{
"ipv4_ranges": [
{
"end": "string",
"start": "string"
}
],
"nat_pool_id": "string"
}
],
"nat_port": 0,
"nat_port_v6": 0,
"nat_zone_id": "string",
"network_context_id": "string",
"parent": "string",
"peer_bypasspair_wan_port_type": "none",
"poe_enabled": true,
"power_usage_threshold": 0,
"pppoe_config": {
"host_uniq": "string",
"ip_address_type": "string",
"password": "string",
"reconnection_delay": 0,
"service_name": "string",
"username": "string"
},
"scope": "GLOBAL",
"secondary_ip_configs": [
{
"ipv4_address": "string",
"scope": "string"
}
],
"service_link_config": {
"gre_config": {
"csum": true,
"keepalive_enable": true,
"keepalive_fail_count": 0,
"keepalive_interval": 0
},
"ipsec_config": {
"authentication": {
"certificate": "string",
"certificate_profile_id": "string",
"comment": "string",
"ikev1_params": {
"xauth_id": "string",
"xauth_secret": "string",
"xauth_secret_encrypted": "string",
"xauth_secret_hash": "string",
"xauth_type": "NONE"
},
"local_ca_certificate": "string",
"local_id": "LOCAL_IP",
"local_id_custom": "string",
"local_pa_certificate_id": "string",
"pa_master_key_id": "string",
"passphrase": "string",
"passphrase_encrypted": "string",
"peer_id_check": "EXACT",
"permit_peer_id_mismatch": true,
"private_key": "string",
"private_key_encrypted": "string",
"remote_ca_certificate": "string",
"remote_id": "string",
"secret": "string",
"secret_encrypted": "string",
"secret_hash": "string",
"strict_validation_peer_extended_key_use": true,
"type": "NONE",
"x509Objects": {
"certHolder": {},
"certificate": "string",
"is_local_ca_cert_set": true,
"is_remote_ca_cert_set": true,
"keyPair": {},
"local_ca_certificate": "string",
"local_ca_certs_set": [
{}
],
"passphrase": "string",
"private_key": "string",
"remote_ca_certificate": "string",
"remote_ca_certs_set": [
{}
]
}
},
"ipsec_profile_id": "string"
},
"last_parent": "string",
"parent": "string",
"passive_mode": {
"enable": true,
"peer_ip_dynamic": true
},
"peer": {
"hostname": "string",
"ip_addresses": [
"string"
]
},
"service_endpoint_id": "string",
"type": "IPSEC"
},
"site_wan_interface_ids": [
"string"
],
"static_arp_configs": [
{
"ipv4_address": "string",
"mac_address": "string"
}
],
"sub_interface": {
"vlan_id": 0
},
"switch_port_config": {
"access_vlan_id": 0,
"bpdu_guard_enabled": true,
"forward_fast_enabled": true,
"native_vlan_id": 0,
"root_guard_enabled": true,
"storm_control_config": {
"broadcast_threshold": 0,
"multicast_threshold": 0,
"unicast_threshold": 0
},
"stp_port_cost": 0,
"stp_port_enabled": true,
"stp_port_priority": 0,
"trunk_vlans": [
"string"
],
"vlan_mode": "access",
"voice_vlan_id": 0
},
"tags": [
"string"
],
"type": "string",
"used_for": "string",
"vlan_config": {
"mstp_instance": 0,
"vlan_id": 0,
"voice_enabled": true
},
"vrf_context_id": "string"
}