APIs in Category: net | Vserver API version 1.21

net-dns-create net-dns-get net-dns-get-iter net-dns-modify net-hosts-create net-hosts-destroy net-hosts-get net-hosts-get-iter net-hosts-modify net-interface-get net-interface-get-iter net-routing-group-route-get net-routing-group-route-get-iter | The net APIs provide network management from ONTAP.

NetApp Manage ONTAP

net-dns-create | [top]

> Creates DNS configuration for a Vserver

> Input Name | Range | Type | Description
> attempts | [1..4] | integer optional | Max number of trials before giving up and returning error. Default is one.
> dns-state |  | enable | Enable/Disable DNS. Possible values are 'enabled' or 'disabled'.
> domains |  | string[] | List of DNS domains such as 'sales.bar.com'. The first domain is the one that the Vserver belongs to.
> name-servers |  | ip-address[] optional | IPv4 addresses of name servers such as '123.123.123.123'.
> return-record |  | boolean optional | If set to true, returns the dns on successful creation. Default: false
> timeout | [1..5] | integer optional | Number of seconds to wait for a response from a name server before trying a different name server. Default is two seconds.
> Output Name | Range | Type | Description
> result |  | net-dns-info optional | The dns created (keys or the entire object if requested)

> Errno | Description
> EDUPLICATEENTRY |  |

net-dns-get | [top]

> Get the DNS configuration of the Vserver

> Input Name | Range | Type | Description
> desired-attributes |  | net-dns-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> Output Name | Range | Type | Description
> attributes |  | net-dns-info | The attributes of the dns.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

net-dns-get-iter | [top]

> Iterate through DNS configurations of the cluster

> Input Name | Range | Type | Description
> desired-attributes |  | net-dns-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | net-dns-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the dns object. All dns objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | net-dns-info[] optional | The list of attributes of dns objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more dns objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

net-dns-modify | [top]

> Modify the DNS configuration of the specified Vserver. Omitted (optional) fields will not be changed.

> Input Name | Range | Type | Description
> attempts | [1..4] | integer optional | Max number of trials before giving up and returning error. Default is one.
> dns-state |  | enable optional | Enable/Disable DNS. Possible values are 'enabled' or 'disabled'.
> domains |  | string[] optional | List of DNS domains such as 'sales.bar.com'. The first domain is the one that the Vserver belongs to.
> name-servers |  | ip-address[] optional | IPv4 addresses of name servers such as '123.123.123.123'.
> timeout | [1..5] | integer optional | Number of seconds to wait for a response from a name server before trying a different name server. Default is two seconds.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

net-hosts-create | [top]

> Create a new IP to host names mapping

> Input Name | Range | Type | Description
> aliases |  | string[] optional | The list of aliases such as 'host1.sales.foo.com'.
> host-ip-address |  | ip-address | IPv4 address in dotted form as '123.123.123.123'.
> hostname |  | string | Canonical hostname in a simple string or in FQDN
> return-record |  | boolean optional | If set to true, returns the hosts on successful creation. Default: false
> Output Name | Range | Type | Description
> result |  | hosts-info optional | The hosts created (keys or the entire object if requested)

> Errno | Description
> EINTERNALERROR |  |

net-hosts-destroy | [top]

> Delete an existing hosts object.

> Input Name | Range | Type | Description
> host-ip-address |  | ip-address | IPv4 address in dotted form as '123.123.123.123'.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

net-hosts-get | [top]

> Given an IP address, return the corresponding IP to host names mapping of the running Vserver context

> Input Name | Range | Type | Description
> desired-attributes |  | hosts-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> host-ip-address |  | ip-address | IPv4 address in dotted form as '123.123.123.123'.
> Output Name | Range | Type | Description
> attributes |  | hosts-info | The attributes of the hosts.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

net-hosts-get-iter | [top]

> Iterate all IP to host name mappings (over all Vserver) of the cluster

> Input Name | Range | Type | Description
> desired-attributes |  | hosts-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | hosts-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the hosts object. All hosts objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | hosts-info[] optional | The list of attributes of hosts objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more hosts objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

net-hosts-modify | [top]

> Given an IP address, modify the corresponding IP to host name mapping. Omitted (optional) fields will not be changed.

> Input Name | Range | Type | Description
> aliases |  | string[] optional | The list of aliases such as 'host1.sales.foo.com'.
> host-ip-address |  | ip-address | IPv4 address in dotted form as '123.123.123.123'.
> hostname |  | string optional | Canonical hostname in a simple string or in FQDN

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

net-interface-get | [top]

> Get the attributes of a network interface.

> Input Name | Range | Type | Description
> desired-attributes |  | net-interface-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> interface-name |  | string | Specifies the logical interface (LIF) name.
> Output Name | Range | Type | Description
> attributes |  | net-interface-info | The attributes of the given network interface.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EVSERVERNTFOUND |  |
> EINTERNALERROR |  |

net-interface-get-iter | [top]

> Iterate over a list of network interface objects.

> Input Name | Range | Type | Description
> desired-attributes |  | net-interface-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | net-interface-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the given network interface object. All given network interface objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | net-interface-info[] optional | The list of attributes of given network interface objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more given network interface objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

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

net-routing-group-route-get | [top]

> Get the attributes of a network routing group route.

> Input Name | Range | Type | Description
> desired-attributes |  | routing-group-route-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> destination-address |  | string | Specifies the IP address and subnet mask of destination. For example: '198.18.10.0/24', 'fd20:13::0/64'
> routing-group |  | string | Specifies the name of routing group. For example: d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet), c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet), n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet) dfd20:13::0/64 ('d' stands for data LIF and fd20:13::0/64 is IPv6 subnet)
> Output Name | Range | Type | Description
> attributes |  | routing-group-route-info | The attributes of the network routing group route.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EVSERVERNTFOUND |  |

net-routing-group-route-get-iter | [top]

> Iterate over a list of network routing group route.

> Input Name | Range | Type | Description
> desired-attributes |  | routing-group-route-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | routing-group-route-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the network routing group route object. All network routing group route objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | routing-group-route-info[] optional | The list of attributes of network routing group route objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more network routing group route objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

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

Element definition: enable | [top]

> 'enabled' or 'disabled'

> [none]

Element definition: hosts-info | [top]

> Name attributes for one host When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> aliases |  | string[] optional | The list of aliases such as 'host1.sales.foo.com'. Attributes: optional-for-create, modifiable
> host-ip-address |  | ip-address optional | IPv4 address in dotted form as '123.123.123.123'. Attributes: key, required-for-create, non-modifiable
> hostname |  | string optional | Canonical hostname in a simple string or in FQDN Attributes: required-for-create, modifiable
> vserver-name |  | vserver-name optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: ip-address | [top]

> IPv4 and IPv6 address

> [none]

Element definition: net-dns-info | [top]

> Contains DNS configuration information of a Vserver When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> attempts | [1..4] | integer optional | Max number of trials before giving up and returning error. Default is one. Attributes: optional-for-create, modifiable
> dns-state |  | enable optional | Enable/Disable DNS. Possible values are 'enabled' or 'disabled'. Attributes: required-for-create, modifiable
> domains |  | string[] optional | List of DNS domains such as 'sales.bar.com'. The first domain is the one that the Vserver belongs to. Attributes: required-for-create, modifiable
> name-servers |  | ip-address[] optional | IPv4 addresses of name servers such as '123.123.123.123'. Attributes: optional-for-create, modifiable
> timeout | [1..5] | integer optional | Number of seconds to wait for a response from a name server before trying a different name server. Default is two seconds. Attributes: optional-for-create, modifiable
> vserver-name |  | vserver-name optional | Vserver Attributes: key, non-creatable, non-modifiable

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

> Network interface information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> address |  | ip-address optional | Specifies the LIF's IP address. This element is valid for all data protocols except FCP. Attributes: optional-for-create, modifiable
> address-family |  | string optional | Address family Attributes: non-creatable, non-modifiable
> administrative-status |  | string optional | Specifies the administrative status of the LIF. The administrative status can differ from the operational status; for instance, if you specify the status as up but a network problem prevents the interface from functioning, the operational status remains as down. Possible values: 'up', 'down', 'unknown' Attributes: optional-for-create, modifiable
> comment |  | string optional | Comment Attributes: optional-for-create, modifiable
> current-node |  | string optional | The node on which the LIF currently resides. Upon LIF migration 'current-node' may be different from 'home-node'. Attributes: non-creatable, non-modifiable
> current-port |  | string optional | The port on which the LIF currently resides. Upon LIF migration 'current-port' may be different from 'home-port'. Attributes: non-creatable, non-modifiable
> data-protocols |  | data-protocol[] optional | Specifies the list of data protocols configured on the LIF. By default, the values in this element are nfs, cifs and fcache. Other supported protocols are iscsi and fcp. A LIF can be configured to not support any data protocols by specifying 'none'. Protocol values of none, iscsi or fcp can't be combined with any other data protocol(s). Attributes: optional-for-create, non-modifiable Possible values: "nfs" - Used for NFS connections, "cifs" - Used for CIFS connections, "iscsi" - Used for iSCSI connections, "fcp" - Used for Fibre Channel connections, "fcache" - Used for FlexCache connections, "none" - Used for management. Does not serve any file protocols.
> dns-domain-name |  | dns-zone optional | Specifies the unique, fully qualified domain name of the DNS zone of this LIF. Attributes: optional-for-create, modifiable
> failover-group |  | failover-group optional | Specifies the failover group name. Attributes: optional-for-create, modifiable
> failover-policy |  | string optional | Specifies the failover policy for the LIF. For FCP and iSCSI LIFs, the only failover policy is 'disabled'; for NFS, CIFs and fcache LIFs, the default policy is 'nextavail'. Attributes: optional-for-create, modifiable Possible values: "nextavail" - Next failover target selected based on next port in failover targets list, preferring local ports first, "priority" - Next failover target selected based on first available port in failover targets list, "disabled" - Failover disabled
> firewall-policy |  | string optional | Specifies the firewall policy for the LIF. Default firewall-policy is set as per the following table: 'LIF Role Protocols Default policy', '------- --------- --------------', 'data none mgmt', 'data any data', 'node_mgmt any mgmt', 'cluster_mgmt any mgmt', 'cluster any cluster', 'intercluster any intercluster' Attributes: optional-for-create, modifiable
> home-node |  | string optional | Specifies the LIF's home node. Attributes: required-for-create, modifiable
> home-port |  | string optional | Specifies the LIF's home port. Attributes: required-for-create, modifiable
> interface-name |  | string optional | Specifies the logical interface (LIF) name. Attributes: key, required-for-create, non-modifiable
> is-auto-revert |  | boolean optional | If true, data LIF will revert to its home node under certain circumstances such as startup, and load balancing migration capability is disabled automatically. Default: false Attributes: optional-for-create, modifiable
> is-home |  | boolean optional | True if LIF is currently on 'home-node' and 'home-port'. Attributes: non-creatable, non-modifiable
> is-ipv4-link-local |  | boolean optional | If true, automatically configure an interface with an IPv4 address. User can configure an interface by explicitly specifying <address> and <netmask> (or <netmask-length>); or by enabling is-ipv4-link-local to true. Attributes: optional-for-create, modifiable
> lif-uuid |  | uuid optional | Available in Data ONTAP 8.2 and later. Attributes: non-creatable, non-modifiable
> listen-for-dns-query |  | boolean optional | If True, this IP address will listen for DNS queries for the dns-zone specified. Attributes: optional-for-create, modifiable
> netmask |  | ip-address optional | Specifies the LIF's netmask. This element is valid for all data protocols except FCP. Attributes: optional-for-create, modifiable
> netmask-length | [0..2^32-1] | integer optional | Specifies number of bits in the netmask. Attributes: optional-for-create, modifiable
> operational-status |  | string optional | Specifies the operational status of the LIF. Possible values: 'up', 'down', 'unknown' Attributes: non-creatable, non-modifiable
> role |  | string optional | Specifies the role of the LIF. Default: data Attributes: required-for-create, non-modifiable Possible values: "undef" - No defined role, "cluster" - Used for communication using the private cluster network, "data" - Used for communicating with file service clients, "node_mgmt" - Used by administrators to configure the node, "intercluster" - Used for communication with a different cluster, "cluster_mgmt" - Used by administrators to configure the cluster
> routing-group-name |  | routing-group optional | Specifies the routing group, which enables multiple logical interfaces to share a set of routing table entries. For example: d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet) c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet) n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet) dfd20:13::0/50 ('d' stands for data LIF and fd20:13::0/50 is IPv6 subnet) Attributes: optional-for-create, modifiable
> use-failover-group |  | string optional | Specifies whether failover rules are automatically created, manually created by the administrator, or disabled. For FCP and iSCSI LIFs, the default policy is 'disabled'; for NFS, CIFs and fcache LIFs, the default policy is 'system_defined'. Attributes: optional-for-create, modifiable Possible values: "system_defined" - Failover targets generated automatically by the system, "disabled" - Failover targets generated manually by the admin, "enabled" - Failover targets defined by failover-group
> vserver |  | string optional | Specifies the Vserver name. Attributes: key, non-creatable, non-modifiable

Element definition: routing-group-route-info | [top]

> Routing group route information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> address-family |  | string optional | Address Family. Possible values: ipv4, ipv6 Attributes: non-creatable, non-modifiable
> destination-address |  | string optional | Specifies the IP address and subnet mask of destination. For example: '198.18.10.0/24', 'fd20:13::0/64' Attributes: key, required-for-create, non-modifiable
> gateway-address |  | string optional | Specifies the IP address of gateway. For example: '198.18.0.0', 'fd20:13::1' Attributes: required-for-create, non-modifiable
> metric | [0..2^32-1] | integer optional | Specifies the metric (hop count) of the LIF. The default value is determined by the LIF role as follows: If the LIF role is 'node_mgmt' or 'cluster_mgmt': 10, If the LIF role is 'data' or 'undef': 20, If the LIF role is 'cluster': 30, If the LIF role is 'intercluster': 40 Attributes: optional-for-create, non-modifiable
> routing-group |  | string optional | Specifies the name of routing group. For example: d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet), c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet), n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet) dfd20:13::0/64 ('d' stands for data LIF and fd20:13::0/64 is IPv6 subnet) Attributes: key, required-for-create, non-modifiable
> vserver |  | string optional | Specifies the name of Vserver. Attributes: key, non-creatable, non-modifiable

Element definition: data-protocol | [top]

> nfs|cifs|iscsi|fcp|fcache|none Possible values: "nfs" - Used for NFS connections, "cifs" - Used for CIFS connections, "iscsi" - Used for iSCSI connections, "fcp" - Used for Fibre Channel connections, "fcache" - Used for FlexCache connections, "none" - Used for management. Does not serve any file protocols.

> [none]

Element definition: dns-zone | [top]

> Specifies the unique, fully qualified domain name of the DNS zone of this LIF.

> [none]

Element definition: enable | [top]

> 'enabled' or 'disabled'

> [none]

Element definition: failover-group | [top]

> Specifies the failover group name.

> [none]

Element definition: ip-address | [top]

> IPv4 and IPv6 address

> [none]

Element definition: routing-group | [top]

> Specifies the name of routing group. For example: d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet), c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet), n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet)

> [none]

Element definition: uuid | [top]

> The 128-bit universally-unique identifier (UUID). UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.

> [none]

Element definition: vserver-name | [top]

> The name of the Vserver.

> [none]