APIs in Category: net | API version 1.9

net-ping net-ping-info net-resolve | The net APIs provide network management from ONTAP.

NetApp Manage ONTAP

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 EHOSTNOTFOUND if the host name cannot be resolved. Does not support IPv6 at this time.

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

> Errno | Description
> EHOSTNOTFOUND |  |

> Vfiler-enabled
> Yes

Element definition: ip-address | [top]

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

> [none]