APIs in Category: net | API version 1.13

net-dcb-list-info net-dcb-priority-list-info net-ifconfig-get net-ping net-ping-info net-resolve net-reverse-resolve | The net APIs provide network management from ONTAP.

NetApp Manage ONTAP

net-dcb-list-info | [top]

> Returns the current Data Center Bridging (DCB) configuration for a specified network interface or all network interfaces indexed by the priority group id.

> Input Name | Range | Type | Description
> interface-name |  | string optional | The network interface name. If not specified, the priority group associated DCB configuration for all DCB-capable network interfaces will be displayed.
> priority-group-id |  | integer optional | The Priority Group ID. Range: [0..15] If not specified, the DCB configuration for all assigned priority groups will be displayed.
> Output Name | Range | Type | Description
> net-dcb-entries |  | net-dcb-entry-info[] | A list of DCB configuration entries for each network interface.

> Errno | Description
> EINVALIDINPUTERROR |  |

net-dcb-priority-list-info | [top]

> Returns the current Data Center Bridging (DCB) configuration for a specified network interface or all network interfaces indexed by the DCB priority.

> Input Name | Range | Type | Description
> interface-name |  | string optional | The interface name. If not specified, the priority associated DCB configuration for all DCB-capable network interfaces will be displayed.
> priority |  | integer optional | The priority. Range: [0..7] If not specified, the priority associated DCB configuration for all DCB priorities will be displayed.
> Output Name | Range | Type | Description
> net-dcb-priority-entries |  | net-dcb-priority-entry-info[] | A list of DCB configuration entries indexed by the priority.

> Errno | Description
> EINVALIDINPUTERROR |  |

net-ifconfig-get | [top]

> Output the current configuration for one interface.

> Input Name | Range | Type | Description
> interface-name |  | string optional | This is the name of the interface to display. If not provided, all interfaces will be displayed.
> Output Name | Range | Type | Description
> interface-config-info |  | interface-config-info[] | configuration of interface

> Errno | Description
> EINTERFACENOTFOUND |  |
> ENOPARTNERIFC |  |
> EINVALIDINPUTERROR |  |

net-ping | [top]

> Ping a host. The API returns on the first successful ping of retry-count attempts. EHOSTNOTFOUND is returned if the host cannot be resolved. EONTAPI_EHOSTDOWN is returned if the host cannot be pinged. The interval between retries is 1 second. IPv6 is not supported at this time.

> Input Name | Range | Type | Description
> host-name-or-ip-address |  | string | The name or the IP address of the host to ping. The format is an IPv4 host name or an IP address.
> retry-count |  | integer optional | The number of pings to try before giving up. Default is 3. Range: [1..5]

> Errno | Description
> EHOSTNOTFOUND |  |

> Vfiler-enabled
> Yes

net-ping-info | [top]

> Ping a host. The API pings the host count times, and returns the number of successful pings and times. EHOSTNOTFOUND is returned if the host cannot be resolved. EHOSTNOCONTACT is returned if the host cannot be pinged. The interval between ping attempts is 1 second. IPv6 is not supported at this time.

> Input Name | Range | Type | Description
> host-name-or-ip-address |  | string | The name or the IP address of the host to ping. The format is an IPv4 host name or IP address.
> ping-count |  | integer optional | The number of pings. Default is 3. Range: [1..16]
> Output Name | Range | Type | Description
> packets-received |  | integer optional | The number of packets received. The number of packets lost is the packets-transmitted minus packets-received. Range: [0..16]
> packets-transmitted |  | integer optional | Number of packets transmitted. Should be equal to ping-count. Range: [1..16]
> round-trip-maximum-time |  | integer optional | Maximum time in microseconds for a round trip between the filer and the host if packets-recieved is greater than zero. Range: [0..2^31-1]
> round-trip-mean-time |  | integer optional | Mean time in microseconds for a round trip between the filer and the host if packets-recieved is greater than zero. Range: [0..2^31-1]
> round-trip-minimum-time |  | integer optional | Mimumum time in microseconds for a round trip between the filer and the host if packets-recieved is greater than zero. Range: [0..2^31-1]

> Errno | Description
> EHOSTNOTFOUND |  |

> Vfiler-enabled
> Yes

net-resolve | [top]

> Resolves a host name to one or more IP addresses. Returns an error code of gethostbyname_r if failed. Does not support IPv6 at this time.

> Input Name | Range | Type | Description
> host-name |  | string | Name of the host to be resolved.
> Output Name | Range | Type | Description
> ip-addresses |  | ip-address[] | The IP addresses of the host.

> Errno | Description
> EHOSTNOTFOUND |  |
> EHOST_BADCONFIGURE |  |
> EHOST_TRYAGAIN |  |
> EHOST_MISC |  |

> Vfiler-enabled
> Yes

net-reverse-resolve | [top]

> Resolves an IP address to one or more host names. Returns an error code of gethostbyaddr_r if failed. Does not support IPv6 at this time.

> Input Name | Range | Type | Description
> ip-address |  | string | IP address of the host to be resolved in dotted notation (for example, 10.56.10.125).
> Output Name | Range | Type | Description
> alias-names |  | host-name[] optional | The aliases of the host, if any.
> canonical-name |  | string optional | The canonical host name

> Errno | Description
> EHOSTNOTFOUND |  |
> EHOST_BADCONFIGURE |  |
> EHOST_TRYAGAIN |  |
> EHOST_MISC |  |

> Vfiler-enabled
> Yes

Element definition: host-name | [top]

> Host name

> [none]

Element definition: interface-config-info | [top]

> Configuration for one interface.

> Name | Range | Type | Description
> aliases |  | ip-address-info[] optional | List of interface IP aliases.
> flowcontrol |  | string optional | Specifies the flow control type. Possible values: {none | receive | send | full} The meaning of these values is: "none" (no flow control), "receive" (only receive flow control frames), "send" (only send flow control frames), and "full" (send and receive flow control frames). If the flowcontrol option is not specified, the default value is interface-dependent. Fiber Interfaces: If the interface detects that the link partner auto-negotiates, then the operational flow control setting is negotiated (and the configured or default setting for flow control is ignored). Not all interfaces have a flowcontrol (e.g. loopback does not)
> interface-name |  | string | Name of the interface.
> ipspace-name |  | string | Name of ipspace that the interface belongs to.
> is-enabled |  | boolean | Administrative status. (TRUE: interface is administratively up).
> is-nfo-enabled |  | boolean | TRUE: network failover is configured for this interface.
> is-trusted |  | boolean | TRUE: interface is trusted.
> is-wins-enabled |  | boolean | TRUE: interface is advertised to the WINS server.
> mac-address |  | string optional | Interface mac address. Not provided for "lo" or "vh" interfaces.
> mediatype |  | string optional | Specifies the Ethernet media type used. Possible values: {tp | tp-fd | 100tx | 100tx-fd | 1000fx | 10g-sr | auto} 10/100, 100/1000, and 10/100/1000 Mbps Copper Interfaces: The acceptable types (which vary from card to card) are "tp" (Half-duplex 10BaseT RJ-45 twisted-pair), "tp-fd" (Full duplex 10Base-T RJ-45 twisted-pair), "100tx" (Half-duplex 100Base-T RJ-45 twisted-pair), "100tx-fd" (Full duplex 100Base-T RJ-45 twisted-pair), and "auto" (Auto RJ-45 twisted-pair). The default media type is set to "tp" or to "auto" where applicable. 1000 Mbps Fiber Interfaces: The Gigabit Ethernet Controllers only support the mediatype "auto". The Gigabit Ethernet Controllers only support full-duplex. 10G bps Fiber Interfaces: The 10G TOE/Ethernet Controllers support the mediatype "10g-sr" and "auto". The interface does not do auto-negotiatition, it only supports 10Gb speed, full duplex. Not all interfaces have a mediatype (e.g. loopback does not)
> mtusize |  | integer | Maximum Transfer Unit (MTU) of an interface. Range: 296-9196
> partner |  | string optional | Name of CFO partner interface that will failover to this interface.
> primary-address |  | ip-address-info optional | The primary address for this interface

Element definition: ip-address | [top]

> One ip address, in dotted-decimal format (for example, "192.168.11.12").

> [none]

Element definition: net-dcb-entry-info | [top]

> DCB configuration information about a single network interface.

> Name | Range | Type | Description
> interface-dcb-entries |  | interface-dcb-entry-info[] | A list of priority group associated DCB configuration parameters for a single network interface.
> interface-name |  | string | The network interface name.

Element definition: net-dcb-priority-entry-info | [top]

> DCB configuration information indexed by the priority about a single network interface.

> Name | Range | Type | Description
> interface-dcb-priority-entries |  | interface-dcb-priority-entry-info[] | A list of DCB configuration parameters indexed by the priority.
> interface-name |  | string | The network interface name.

Element definition: interface-dcb-entry-info | [top]

> DCB configuration information about a priority group.

> Name | Range | Type | Description
> application |  | string | Application assigned to the specified priority group.
> bandwidth-percentage |  | integer | Bandwidth assigned to the specified priority group. Range: [0..100]
> priority-entries |  | priority-entry-info[] | A list of DCB priorities associated to the specified priority group.
> priority-group-id |  | integer | The Priority Group ID. A priority group is a group of priorities bound together by management for the purpose of bandwidth allocation. All priorities in a single group are expected to have similar traffic handling requirements (e.g. latency or frame loss). Range: [0..15]

Element definition: interface-dcb-priority-entry-info | [top]

> DCB configuration information about a priority.

> Name | Range | Type | Description
> application |  | string | Application assigned to a specified priority group.
> is-flow-control-enabled |  | boolean | TRUE: the flow control is enabled on a specific priority.
> priority |  | integer | The DCB priority. Range: [0..7]
> priority-group-id |  | integer | The priority group ID. A priority group is a group of priorities bound together by management for the purpose of bandwidth allocation. All priorities in a single group are expected to have similar traffic handling requirements (e.g. latency or frame loss). Range: [0..15]

Element definition: ip-address-info | [top]

> A configured IP Address

> Name | Range | Type | Description
> addr-family |  | string | Address family. Possible values: {af-inet6 | af-inet}.
> address |  | ip-address-or-hostname | IP address.
> broadcast |  | ip-address optional | broadcast address. Default if not specified is computed from IP address and netmask. Not used for IPV6. Must be consistent with netmask.
> creator |  | string | Entity responsible for creation of address. Possible values: "filer" if created by d-blade. "vserver: " if created by n-blade with cluster-wide scope.
> netmask |  | netmask optional |
> prefixlen |  | integer optional | address prefix length. Specifies the number of bits of the address starting at the most significant bit. Can be used for both IPV4 and IPV6. (for IPV4 it is equivalent to netmask). Range: IPV4: 1-32. Default is classful. Range: IPV6: 1-128. Default is 64.

Element definition: ip-address | [top]

> One ip address, in dotted-decimal format (for example, "192.168.11.12").

> [none]

Element definition: ip-address-or-hostname | [top]

> IP address string. For example, 198.18.100.12, or "`hostname`-e0c" (backquoted hostname is allowed) or "toaster" (assuming toaster resolves to an IP address)

> [none]

Element definition: netmask | [top]

> netmask. Possible values: dotted decimal or hex integer (range: 0x1 .. 0xffffffff) Default if not specified is classful: Class A address - 255.0.0.0 or 0xff000000 Class B address - 255.255.0.0 or 0xffff0000 Class C address - 255.255.255.0 or 0xffffff00

> [none]

Element definition: priority-entry-info | [top]

> A priority associated to the specified priority group.

> Name | Range | Type | Description
> priority |  | integer | The priority associated with the specified priority group. Range: [0..7]