APIs in Category: networks | API version 5.0

dfm-network-add dfm-network-delete dfm-network-list-info dfm-network-modify | DFM discovers the network specifed through these apis.

NetApp Manage ONTAP

dfm-network-add | [top]

> Adds a network in DFM to discover.

> Input Name | Range | Type | Description
> network-address |  | network-address | IP address of the network to be added.
> prefix-length |  | prefix-length | The routing prefix length of the network. Useful for calculation of subnet mask of a network.
> Output Name | Range | Type | Description
> network-id |  | network-id | A unique-identifier of the newly added network in DFM.

> Errno | Description
> EACCESSDENIED |  |
> EAPIERROR |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |

dfm-network-delete | [top]

> Delete a network from DFM so that discovery is disabled for that network. Either network-id or network-address has to be provided. If both are specified then an error(EINVALIDINPUT) will be thrown.

> Input Name | Range | Type | Description
> network-address |  | network-address optional | IP address of network.
> network-id |  | obj-id optional | Unique identifier of the network in DFM.

> Errno | Description
> EACCESSDENIED |  |
> EAPIERROR |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |

dfm-network-list-info | [top]

> Returns list of networks added to DFM for discovery.

> Input Name | Range | Type | Description
> network-id |  | network-id optional | Unique identifier representing a network in DFM. If no input is provided, then information about all the networks added to DFM for discovery will be returned.
> Output Name | Range | Type | Description
> networks |  | network-info[] | The list of networks.

> Errno | Description
> EACCESSDENIED |  |
> EAPIERROR |  |
> EDATABASEERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |

dfm-network-modify | [top]

> Modify prefix length of a network in DFM, so that host discovery in this networks should happen based on new subnet mask derived from new value of prefix length.

> Input Name | Range | Type | Description
> network-id |  | network-id | Unique identifier of the network in DFM.
> prefix-length |  | prefix-length | New routing prefix length of network.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EAPIERROR |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |

Element definition: network-address | [top]

> IP address of the network or host

> [none]

Element definition: network-id | [top]

> Unique id representing network in DFM. Range: [0..2^31-1]

> [none]

Element definition: network-info | [top]

> Information of one network.

> Name | Range | Type | Description
> hop-count |  | integer | Represents hop count for the network. Zero will be returned if network is not discovered. Range: [0..2^31 -1]
> last-searched-time |  | timestamp optional | Represents the time when network was last discovered. Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.
> network-address |  | network-address | Address of the network.
> network-id |  | network-id | A unique id representing the network.
> prefix-length |  | prefix-length | The routing prefix length of the network.

Element definition: obj-id | [top]

> Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed to be 0, which is interpreted as a null value, e.g., a reference to no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed to assign an ID to an object. Therefore, an input element of type obj-id is always used to refer to an existing object by its ID. The ZAPI must specify the object's DFM object type (e.g. dataset, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the value of an obj-id input element does not match the ID of any existing DFM object of the specified type or types, then typically the ZAPI fails with error code EOBJECTNOTFOUND. A ZAPI may deviate from this general rule, for example, it may return a more specific error code. In either case, the ZAPI specification must document its behavior.

> [none]

Element definition: prefix-length | [top]

> Prefix length of the network or host

> [none]

Element definition: network-address | [top]

> IP address of the network or host

> [none]

Element definition: network-id | [top]

> Unique id representing network in DFM. Range: [0..2^31-1]

> [none]

Element definition: timestamp | [top]

> Seconds since 1/1/1970 in UTC. Range: [0..2^31-1].

> [none]