Get the value of an interface attribute
Contents
Use this API to get the value of a specific attribute of an interface.
Resource Information
Method |
URL |
Required authentication |
GET |
/V1/CMDB/Interfaces/Attributes |
Yes |
Parameters
Name |
Description |
|---|---|
Token*required |
Place the token received from the API Log in to get an authentication token. |
hostname*required |
The hostname of a device. |
interfaceName*required |
The full name of an interface. |
attributeName |
The attribute name of the interface that you want to get it value. If not specified, return all attributes and their values. |
Response
Parameter |
Type |
Description |
Example |
|---|---|---|---|
hostname |
string |
The hostname of the returned device. |
{ |
interfaceName |
string |
The full name of the target interface. |
|
interfaceAttributeValue |
string |
The returned attribute value. |
|
statusCode |
integer |
The returned status code of executing the API. |
|
statusDescription |
string |
The explanation of the status code. |
Applicable Interface Attributes
Attribute Name |
Display Name in Device Details Pane |
Description |
|---|---|---|
mibIndex |
MIB Index |
The MIB index of an interface. |
bandwidth |
Bandwidth |
The bandwidth of an interface. |
speed |
Speed |
The speed of an interface. |
duplex |
Duplex |
The duplex of an interface. |
intfStatus |
Live Status |
The state of an interface. |
macAddr |
MAC Address |
The MAC address of an interface. |
descr |
Description |
The description of an interface. |
routingProtocol |
Routing Protocol |
The routing protocol configured on an interface. |
multicastMode |
Multicasting Mode |
The multicasting mode of an interface. |
mplsVrf |
MPLS VRF |
The name of the VRF configured on an interface. |
mplsVpn |
MPLS VPN |
The MPLS VPN configured on an interface. |
inAclName |
Inbound ACL |
The inbound ACL of an interface. |
outAclName |
Outbound ACL |
The outbound ACL of an interface. |
mode |
Switchport Mode |
The switchport mode of an interface. |
vlan |
VLAN |
The VLAN number that an interface belongs to. |
trunkNativeVlan |
Native VLAN |
The native VLAN of an interface as a switch port. |
trunkEncapsulation |
Trunk Encapsulation |
The trunk encapsulation protocol of an interface as a trunk port. |