APIs in Category: netif | API version 5.0

netif-ip-interface-list-info

NetApp Manage ONTAP

netif-ip-interface-list-info | [top]

> Get the list of interfaces on a storage system.

> Input Name | Range | Type | Description
> community-string |  | string optional | SNMP community string to use. If omitted, the default "public" is used.
> hostname |  | string | Hostname or IP address of the device to query with SNMP.
> timeout |  | integer optional | Number of seconds to wait for a response before giving up. If omitted, the default value is 5 seconds. Range: [0..2^31-1]
> Output Name | Range | Type | Description
> interfaces |  | netif-ip-interface-info[] | The response from the other server.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

Element definition: netif-ip-interface-info | [top]

> Information about one network interface.

> Name | Range | Type | Description
> administrative-status |  | string | The desired state of the interface. Possible values are "up", "down", and "testing".
> bytes-in |  | integer | The total number of octets received on the interface, including framing characters. Range: [0..2^63-1]
> bytes-out |  | integer | The total number of octets transmitted out of the interface, including framing characters. Range: [0..2^63-1]
> discards-in |  | integer | The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space. Range: [0..2^63-1]
> discards-out |  | integer | The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. Range: [0..2^63-1]
> errors-in |  | integer | The number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. Range: [0..2^63-1]
> errors-out |  | integer | The number of outbound packets that could not be transmitted because of errors. Range: [0..2^63-1]
> ip-addresses |  | string[] | List of IP addresses mapped to this interface.
> name |  | string | The name of the interface.
> operational-status |  | string | The current operational state of the interface. Possible values are "up", "down", and "testing".
> packets-in |  | integer | The number of packets delivered to a higher-layer protocol, including unicast, multicast, and broadcast packets. Range: [0..2^63-1]
> packets-out |  | integer | The total number of packets that higher-level protocols requested be transmitted, including those that were discarded or not sent. Range: [0..2^63-1]
> physical-address |  | string | The interface's MAC address. Example: 00:01:00:00:08:fd
> speed |  | integer | The interface's current bandwidth in bits per second. Range: [0..2^32-1]