APIs in Category: Netif
API version 5.0

 
NetifIpInterfaceListInfo

NetApp Manage ONTAP API version 5.0
 
NetifIpInterfaceListInfo (supported) [top]

Get the list of Interfaces on a storage system.
Input Name Type
NetifIpInterfaceListInfo NetifIpInterfaceListInfo
 
Output Name Type
NetifIpInterfaceListInfoResult NetifIpInterfaceListInfoResult
 Error Name  Description
 EINTERNALERROR
 EINVALIDINPUTERROR

 
Element definition: NetifIpInterfaceListInfo [top]
Get the list of Interfaces on a storage system.
Name Type Description
CommunityString xsd:string
optional
SNMP community string To use. If omitted, the default "public" is used.
Hostname xsd:string
Hostname or IP Address of the device To Query with SNMP.
Timeout xsd: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]

 
Element definition: NetifIpInterfaceListInfoResult [top]
Name Type Description
Interfaces ArrayOfNetifIpInterfaceInfo
The Response From the other server.

 
Element definition: ArrayOfNetifIpInterfaceInfo [top]
Name Type Description
NetifIpInterfaceInfo NetifIpInterfaceInfo[]

 
Element definition: NetifIpInterfaceInfo [top]
Information about one network Interface.
Name Type Description
AdministrativeStatus xsd:string
The desired state of the Interface. Possible Values are "up", "down", and "testing".
BytesIn xsd:integer
The Total number of octets received on the Interface, including framing characters.
Range: [0..2^63-1]
BytesOut xsd:integer
The Total number of octets transmitted out of the Interface, including framing characters.
Range: [0..2^63-1]
DiscardsIn xsd: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]
DiscardsOut xsd: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]
ErrorsIn xsd:integer
The number of inbound packets that contained Errors preventing them From being deliverable To a higher-layer Protocol.
Range: [0..2^63-1]
ErrorsOut xsd:integer
The number of outbound packets that could not be transmitted because of Errors.
Range: [0..2^63-1]
IpAddresses ArrayOfString
List of IP addresses mapped To this Interface.
Name xsd:string
The Name of the Interface.
OperationalStatus xsd:string
The current operational state of the Interface. Possible Values are "up", "down", and "testing".
PacketsIn xsd:integer
The number of packets delivered To a higher-layer Protocol, including unicast, multicast, and broadcast packets.
Range: [0..2^63-1]
PacketsOut xsd: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]
PhysicalAddress xsd:string
The Interface's MAC Address.
Example: 00:01:00:00:08:fd
Speed xsd:unsignedInt
The Interface's current bandwidth in bits per second.
Range: [0..2^32-1]

 
Element definition: ArrayOfString [top]
Name Type Description
String xsd:string[]