get-interface-detail

Resource URIs


URI	Description
<base_URI>/operations/get-interface-detail	Retrieves operational data for a given VLAN and enumeration of all the interfaces belonging to this VLAN.

Parameters

interface-type: Displays the interface type.
interface-name: Displays the interface name.
port-mode: Displays the operational mode of the particular interface. This is applicable only for physical interfaces or port-channel interfaces.
if-name: Displays the interface display name as in MIB-II's ifTable. However interface-name and interface-type values of this instance forms fully qualified name for this interface.
if-state: Displays the current operational state of this interface.
line-protocol-state: Displays the 'Line protocol' state of the interface.
line-protocol-state-info: Displays the reason for the current line protocol state of the interface.
hardware-type: Displays the type of the interface.
current-hardware-address: Displays the address of the interface at its protocol sub-layer.
logical-hardware-address: Displays the address of the interface at its protocol sub-layer.
ifindex: A unique value, greater than zero, for each interface.
mtu: Displays the IP MTU value of the interface.
actual-line-speed: Displays the actual line speed of this interface.
configured-line-speed: Displays the administratively configured line speed of the interface.
queuing-strategy: Displays the 'Queuing strategy' for the interface.
ifHCInOctets: Displays the total number of octets received on the interface, including framing characters.
ifHCInUcastPkt: Displays the number of packets, delivered by this sub-layer to a higher (sub-)layer, which were not addressed to a multicast or broadcast address at this sub-layer.
ifHCInMulticastPkts: Displays the number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a multicast address at the sub-layer. For a MAC layer protocol, this includes both Group and Functional addresses.
ifHCInBroadcastPkts: Displays the number of packets, delivered by the sub-layer to a higher (sub-)layer, which were addressed to a broadcast address at the sub-layer.
ifHCInErrors: For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character-oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol.
ifHCOutOctets: Displays the total number of octets transmitted out of the interface, including framing characters.
ifHCOutUcastPkts: Displays the total number of packets that higher-level protocols requested be transmitted, and which were not addressed to a multicast or broadcast address at the sub-layer, including those that were discarded or not sent.
ifHCOutMulticastPkts: Displays the total number of packets that higher-level protocols requested be transmitted, and which were addressed to a multicast address at this sub-layer, including those that were discarded or not sent. For a MAC layer protocol, this includes both Group and Functional addresses.
ifHCOutBroadcastPkt: Displays the total number of packets that higher-level protocols requested be transmitted, and which were addressed to a broadcast address at this sub-layer, including those that were discarded or not sent.
ifHCOutErrors: For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors.
media-type: Displays the media type.
wavelength: Displays the wavelength of pluggable media.
if-description: Displays the textual string containing information about the interface.

Usage Guidelines

Only POST operation is supported.

Examples

URI

http://host:80/rest/operations/get-interface-detail

<get-interface-detail></get-interface-detail>

<output xmlns='urn:brocade.com:mgmt:brocade-interface-ext'>
  <interface>
    <interface-type>port-channel</interface-type>
    <interface-name>1</interface-name>
    <port-mode>unknown</port-mode>
    <if-name>Port-channel 1</if-name>
    <if-state>up</if-state>
    <line-protocol-state>up</line-protocol-state>
    <hardware-type>aggregate</hardware-type>
    <current-hardware-address>60:9c:9f:0e:e6:f0</current-hardware-address>
    <logical-hardware-address>60:9c:9f:0e:e6:f0</logical-hardware-address>
    <if-description>lag-to-bek-1</if-description>
    <ifindex>671088641</ifindex>
    <mtu>9216</mtu>
    <actual-line-speed>600Gbps</actual-line-speed>
    <configured-line-speed>100Gbps</configured-line-speed>
    <queuing-strategy>fifo</queuing-strategy>
    <ifHCInOctets>82201936202292</ifHCInOctets>
    <ifHCInUcastPkts>316118913731</ifHCInUcastPkts>
    <ifHCInMulticastPkts>466925</ifHCInMulticastPkts>
    <ifHCInBroadcastPkts>0</ifHCInBroadcastPkts>
    <ifHCInErrors>0</ifHCInErrors>
    <ifHCOutOctets>83391499158384</ifHCOutOctets>
    <ifHCOutUcastPkts>320694336080</ifHCOutUcastPkts>
    <ifHCOutMulticastPkts>431024</ifHCOutMulticastPkts>
    <ifHCOutBroadcastPkts>0</ifHCOutBroadcastPkts>
    <ifHCOutErrors>0</ifHCOutErrors>
  </interface>
  <interface>
    <interface-type>port-channel</interface-type>
    <interface-name>2</interface-name>
    <port-mode>unknown</port-mode>
    <if-name>Port-channel 2</if-name>
    <if-state>down</if-state>
    <line-protocol-state>down</line-protocol-state>
    <line-protocol-state-info> (admin down)</line-protocol-state-info>
    <hardware-type>aggregate</hardware-type>
    <current-hardware-address>60:9c:9f:0d:3e:4f</current-hardware-address>
    <logical-hardware-address>60:9c:9f:0d:3e:4f</logical-hardware-address>
    <if-description>Insight port-channel on MM2</if-description>
    <ifindex>671088642</ifindex>
    <mtu>1548</mtu>
    <actual-line-speed>nil</actual-line-speed>
    <configured-line-speed>10Gbps</configured-line-speed>
    <queuing-strategy>fifo</queuing-strategy>
    <ifHCInOctets>0</ifHCInOctets>
    <ifHCInUcastPkts>0</ifHCInUcastPkts>
    <ifHCInMulticastPkts>0</ifHCInMulticastPkts>
    <ifHCInBroadcastPkts>0</ifHCInBroadcastPkts>
    <ifHCInErrors>0</ifHCInErrors>
    <ifHCOutOctets>0</ifHCOutOctets>
    <ifHCOutUcastPkts>0</ifHCOutUcastPkts>
    <ifHCOutMulticastPkts>0</ifHCOutMulticastPkts>
    <ifHCOutBroadcastPkts>0</ifHCOutBroadcastPkts>
    <ifHCOutErrors>0</ifHCOutErrors>
  </interface>
  <has-more>false</has-more>
</output>

If the entire information cannot be retrieved in a single execution, the last lines of output says has-more=true.

<has-more xmlns="urn:brocade.com:mgmt:brocade-interface-ext">true</has-more>
</rpc-reply>

In such cases the remaining information can be retrieved using "last-rcvd-interface" as shown in the request body below.

<get-interface-detail>
  <last-rcvd-interface>
    <interface-type>port-channel</interface-type>
    <interface-name>3</interface-name>
  </last-rcvd-interface>
</get-interface-detail>

The API can be used to retrieve information regarding a specific port by applying filter as in the request body below.

<get-interface-detail>
  <interface-type>port-channel</interface-type>
  <interface-name>2</interface-name>
</get-interface-detail>