Get Interface Status (v3.7)
GET/v3.7/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/interfaces/:interface_id/status
Get interface status.
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 [
- ]
cellular_state CellularState
The cellular state details.
Indicates if the cellular state is active. Values = True/False.
apn_info APNInfo
Lists the APN and authentication information.
The APN.
The APN authentication.
The ION device.
dns_v4_config DNS
The DNS v4 config details.
The DNS name servers
The search parameters.
dns_v6_config IPv6DNS
The DNS v6 config details.
The IPv6 configured DNS name servers.
The search parameters.
Effective Vlans
The element ID.
The extended state.
The interface ID.
The IPv4 addresses configured for the interface.
The IPv6 addresses configured for the interface.
lacp_state LacpStateS
Lacp State
Key
Mac Address
Partner Key
Partner Mac Address
Partner System Priority
System Priority
The last state change of the device.
The link local address.
Lldp Enabled
The interface configuration MAC address.
The name of the interface state. Max size = 128.
The negotiated IP MTU value.
The operational state.
poe_state PoeStateS
Poe State
The PoE detection status.
The ION device type.
The PoE operational state.
Indicates if PoE is enabled. By default, PoE is disabled.
The power classification.
The power consumed.
Values = True or False.
The power pair state.
The power priority.
The Port Power Usage Alarm Threshold value is between 50 - 100%.The default threshold is 100% (60W).
port Port
The start and end port details.
The end port range must be between 1 and 65535.
The start port range must be between 1 and 65535.
port_channel_member_state PortChannelMemberStateS[]
Port Channel Member State
Interface Id
Partner Key
Partner Mode
Partner Priority
Partner Rate
Partner State
Port Key
Port Mode
Port Priority
Port Rate
Port State
The remote host name.
The remote IPv4 address.
routes Route[]
The routing details.
The route destination.
The via IP address.
routes_v6 Ipv6Route[]
The route v6 details.
The route destination.
The via IPv6 address.
The secondary IPv4 addresses.
service_link ServiceLink
The service link details ServiceLink.
The anti replay value. True or False.
The anti replay window count.
The site ID.
Copy Tos
Is GRE encapsulation enabled. True or False.
geneve_config GeneveConfigV2
Lists all the geneve configurations.
Keepalive Enable
Keepalive Fail Count: Range(max = 10L, error = INTERFACE_CONFIG_SERVICE_LINK_INVALID_GENEVE_KEEPALIVE_FAIL_COUNT: Geneve keep alive fail count should be in range 1 to 10, min = 3L)
Keepalive Interval: Range(max = 10L, error = INTERFACE_CONFIG_SERVICE_LINK_INVALID_GENEVE_KEEPALIVE_INTERVAL: Geneve Keep alive interval should be in range 3 to 30, min = 1L)
Keepalive Local Ipv4
Keepalive Remote Ipv4
Tenant Vni Label
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 IPSECConfig
The IPSec config details.
authentication IPSECAuthentication
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.
liveliness_probe LivelinessProbe
Lists the livliness probe details.
The liveliness probe failure count interval.
The probe interval. Must be between 1 to 30 seconds.
The probe address.
The local probe address.
The proxy ID.
Nat traversal value. True or False.
Pa Location Oid
Pa Tunnel Oid
The parent value = true.
passive_mode PassiveMode
Passive mode enabled on the device. True or False
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.
proxy_ids Proxy[]
The proxy details.
Local
Local Port
Protocol
Protocol Number
Proxy Id
Remote
Remote Port
sase_ike_gw_config SaseIkeGWConfig
The SASE IKE GW configurations.
Ike Gw Name
Ikev1 Dpd Delay
Ikev1 Dpd Enable
Ikev1 Dpd Timeout
Ikev1 Enable Fragmentation
Ikev1 Exchange Mode
Ikev2 Liveness Check Enable
Ikev2 Liveness Interval
Ikev2 Require Cookie
The security service endpoint ID.
The service endpoint ID.
The tunnel role.
Possible values: [IPSEC
, GRE
, GENEVE
]
The service link type.
stp_state STPStateS
The STP state details.
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 MSTP instance ID.
The STP port cost is between 1-65535. The STP port cost depends on the speed of the port.
The STP Port priority is between 0-240. The default value is 128, STP port priority is in multiples of 16.
The port state.
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.
Spanning Tree Protocol (STP) is enabled by default. By default, the STP type is RSTP.
svi_state SVIStateS
The svi details.
The STP designated cost between 1-65535.
The STP designated MAC address.
The STP designated port.
The STP designated root MAC address.
vrf VRF
The VRF details.
The VRF (Virtual Routing and Forwarding) ID.
The VFR context name.
{
"cellular_state": {
"active": true,
"apn_info": {
"apn": "string",
"authentication": "string"
}
},
"device": "string",
"dns_v4_config": {
"name_servers": [
"string"
],
"search": [
"string"
]
},
"dns_v6_config": {
"name_servers": [
"string"
],
"search": [
"string"
]
},
"effective_vlans": [
0
],
"element_id": "string",
"extended_state": "string",
"id": "string",
"ipv4_addresses": [
"string"
],
"ipv6_addresses": [
"string"
],
"lacp_state": {
"key": 0,
"mac_address": "string",
"partner_key": 0,
"partner_mac_address": "string",
"partner_system_priority": 0,
"system_priority": 0
},
"last_state_change": 0,
"link_local_address": "string",
"lldp_enabled": true,
"mac_address": "string",
"name": "string",
"negotiated_mtu": 0,
"operational_state": "string",
"poe_state": {
"detection_status": "string",
"device_type": "string",
"operational_state": "string",
"poe_enabled": true,
"power_classification": "string",
"power_consumed": 0,
"power_pairs_control_ability": true,
"power_pairs_state": "string",
"power_priority": "string",
"power_usage_threshold": 0
},
"port": {
"end": "string",
"start": "string"
},
"port_channel_member_state": [
{
"interface_id": "string",
"partner_key": 0,
"partner_mode": "string",
"partner_priority": 0,
"partner_rate": "string",
"partner_state": "string",
"port_key": 0,
"port_mode": "string",
"port_priority": 0,
"port_rate": "string",
"port_state": "string"
}
],
"remote_host_name": "string",
"remote_v4_addr": "string",
"routes": [
{
"destination": "string",
"via": "string"
}
],
"routes_v6": [
{
"destination": "string",
"via": "string"
}
],
"secondary_ipv4_addresses": [
"string"
],
"service_link": {
"anti_replay": true,
"anti_replay_window": 0,
"classic_site_id": "string",
"copy_tos": true,
"enable_gre_encapsulation": true,
"geneve_config": {
"keepalive_enable": true,
"keepalive_fail_count": 0,
"keepalive_interval": 0,
"keepalive_local_ipv4": "string",
"keepalive_remote_ipv4": "string",
"tenant_vni_label": "string"
},
"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",
"liveliness_probe": {
"failure_count": 0,
"interval": 0,
"ip_address": "string",
"local_ip_address": "string",
"proxy_id": "string"
},
"nat_traversal": true,
"pa_location_oid": "string",
"pa_tunnel_oid": "string",
"parent": "string",
"passive_mode": {
"enable": true,
"peer_ip_dynamic": true
},
"peer": {
"hostname": "string",
"ip_addresses": [
"string"
]
},
"proxy_ids": [
{
"local": "string",
"local_port": 0,
"protocol": "string",
"protocol_number": 0,
"proxy_id": "string",
"remote": "string",
"remote_port": 0
}
],
"sase_ike_gw_config": {
"ike_gw_name": "string",
"ikev1_dpd_delay": 0,
"ikev1_dpd_enable": true,
"ikev1_dpd_timeout": 0,
"ikev1_enable_fragmentation": true,
"ikev1_exchange_mode": "string",
"ikev2_liveness_check_enable": true,
"ikev2_liveness_interval": 0,
"ikev2_require_cookie": true
},
"security_service_endpoint_id": "string",
"service_endpoint_id": "string",
"tunnel_role": "string",
"type": "IPSEC"
},
"stp_state": {
"bpdu_guard_enabled": true,
"forward_fast_enabled": true,
"mstp_instance_id": 0,
"port_cost": 0,
"port_priority": 0,
"port_state": "string",
"root_guard_enabled": true,
"stp_enabled": true
},
"svi_state": {
"stp_designated_cost": 0,
"stp_designated_mac_address": "string",
"stp_designated_port": 0,
"stp_designated_root_mac_address": "string"
},
"vrf": {
"vrf_context_id": "string",
"vrf_context_name": "string"
}
}