APIs in Category: net | Cluster-Mode API version 1.15

net-cluster-ping net-connections-receive-window-size-get net-connections-receive-window-size-get-iter net-connections-receive-window-size-modify net-dns-get-iter net-hosts-get-iter net-interface-create net-interface-delete net-interface-get-iter net-interface-modify net-interface-modify-iter net-port-get net-port-get-iter net-port-ifgrp-add-port net-port-ifgrp-create net-port-ifgrp-destroy net-port-ifgrp-get net-port-ifgrp-remove-port net-port-modify net-port-modify-iter net-routing-group-route-create net-routing-group-route-destroy net-routing-group-route-get-iter net-vlan-create net-vlan-delete net-vlan-get net-vlan-get-iter | The net APIs provide network management from ONTAP.

NetApp Manage ONTAP

net-cluster-ping | [top]

> Ping an IP address to verify whether the interface is alive

> Input Name | Range | Type | Description
> destination-address |  | string | Specifies IPv4 address of the destination.
> interface |  | string optional | Specifies the LIF from which the ping request is to be sent. This element must be specified with <interface-owner>.
> interface-owner |  | string optional | Specifies the name of logical interface (LIF) owner. It may be a node or Vserver name. Element <interface-owner> and <interface> are mutually exclusive with element <node>.
> node |  | string optional | Specifies the node from which ping request is to be sent. Element <node> is mutually exclusive with <interface-owner> and <interface>. If neither <node> nor <interface-owner> and <interface> is specified, then the ping request will originate from the node receiving the API request.
> retry-count | [0..2^32-1] | integer optional | Specifies the number of ECHO_REQUEST retries for the given destination address. Ping stops upon first successful reply from the destination. Default: 20
> wait | [0..2^32-1] | integer optional | Specifies inter packet time interval (secs) for sending ECHO_REQUEST. Default: 1

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

net-connections-receive-window-size-get | [top]

> Get the receive buffer size of a service

> Input Name | Range | Type | Description
> desired-attributes |  | receive-buffer 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.
> network |  | network-type | The network topology classification Possible values: "wan" , "lan" , "undefined"
> protocol |  | protocol-layer4 | The network layer 4 protocol type Possible values: "udp" - UDP, "tcp" - TCP, "na" - not_available
> service |  | stream-protocol-service | The stream protocol connection classification Possible values: "mount" - Mount stream protocol, "nfs" - NFS stream protocol, "nfs_v2" - NFS version 2 stream protocol, "nfs_v3" - NFS version 3 stream protocol, "nlm_v4" - Network lock manager stream protocol, "sm" - Session Manager stream protocol, "ftp_ctrl" - FTP control stream protocol, "ftp_data" - FTP data stream protocol, "http_1_0" - HTTP version 1 stream protocol, "http_1_1" - HTTP version 1.1 stream protocol, "iscsi" - ISCSI stream protocol, "cifs_srv" - CIFS server stream protocol, "cifs_nam" - CIFS name server stream protocol, "loopback" - loopback stream protocol, "rf" - RC stream protocol, "rawscp" - Raw secure copy stream protocol, "discard" - Descard stream protocol, "port_map" - Port map stream protocol, "pass_thru" - Passthru stream protocol, "rclopcp" - Rc connection stream protocol, "nfs_v4" - NFS version 4 stream protocol, "fcache" - Flex cache stream protocol, "ctlopcp" - Ct connection stream protocol, "rquota" - Rquota stream protocol, "unknown" - unknown protocol
> Output Name | Range | Type | Description
> attributes |  | receive-buffer | The attributes of the net-connections-receive-window-size.

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

net-connections-receive-window-size-get-iter | [top]

> Iterate over connections returning receive window size

> Input Name | Range | Type | Description
> desired-attributes |  | receive-buffer 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..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | receive-buffer optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the net-connections-receive-window-size object. All net-connections-receive-window-size 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 |  | receive-buffer[] optional | The list of attributes of net-connections-receive-window-size objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more net-connections-receive-window-size objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

net-connections-receive-window-size-modify | [top]

> Modify a receive buffer size

> Input Name | Range | Type | Description
> network |  | network-type | The network topology classification Possible values: "wan" , "lan" , "undefined"
> protocol |  | protocol-layer4 | The network layer 4 protocol type Possible values: "udp" - UDP, "tcp" - TCP, "na" - not_available
> receive-buffer | [256..7168] | integer optional | Receive buffer size in Kilobytes
> service |  | stream-protocol-service | The stream protocol connection classification Possible values: "mount" - Mount stream protocol, "nfs" - NFS stream protocol, "nfs_v2" - NFS version 2 stream protocol, "nfs_v3" - NFS version 3 stream protocol, "nlm_v4" - Network lock manager stream protocol, "sm" - Session Manager stream protocol, "ftp_ctrl" - FTP control stream protocol, "ftp_data" - FTP data stream protocol, "http_1_0" - HTTP version 1 stream protocol, "http_1_1" - HTTP version 1.1 stream protocol, "iscsi" - ISCSI stream protocol, "cifs_srv" - CIFS server stream protocol, "cifs_nam" - CIFS name server stream protocol, "loopback" - loopback stream protocol, "rf" - RC stream protocol, "rawscp" - Raw secure copy stream protocol, "discard" - Descard stream protocol, "port_map" - Port map stream protocol, "pass_thru" - Passthru stream protocol, "rclopcp" - Rc connection stream protocol, "nfs_v4" - NFS version 4 stream protocol, "fcache" - Flex cache stream protocol, "ctlopcp" - Ct connection stream protocol, "rquota" - Rquota stream protocol, "unknown" - unknown protocol

> 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..100] | 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..100] | integer | The number of records returned in this call.

> Errno | Description
> 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..100] | 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..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

net-interface-create | [top]

> Create a new logical interface.

> Input Name | Range | Type | Description
> address |  | ip-address optional | Specifies the LIF's IP address. This element is valid for all data protocols except FCP.
> 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'
> 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). 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 |  | string optional | Specifies the unique, fully qualified domain name of the DNS zone of this LIF.
> failover-group |  | string optional | Specifies the failover group name.
> 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'. Possible values: "nextavail" - Next failover target selected based on next available port ID, "priority" - Next failover target selected based on lowest available port ID, "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'
> home-node |  | string | Specifies the LIF's home node.
> home-port |  | string | Specifies the LIF's home port.
> interface-name |  | string | Specifies the logical interface (LIF) name.
> 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
> 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 by enabling is-ipv4-link-local to true.
> netmask |  | ip-address optional | Specifies the LIF's netmask. This element is valid for all data protocols except FCP.
> return-record |  | boolean optional | If set to true, returns the given network interface on successful creation. Default: false
> role |  | string | Specifies the role of the LIF. Default: data 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 |  | string 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)
> 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'. Possible values: "system_defined" - Use port roles to select failover targets, "disabled" - Failover disabled, "enabled" - Use a failover group to select failover targets
> vserver |  | string | Specifies the Vserver name.
> Output Name | Range | Type | Description
> result |  | net-interface-info optional | The given network interface created (keys or the entire object if requested)

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

net-interface-delete | [top]

> Destroy an existing network interface object.

> Input Name | Range | Type | Description
> interface-name |  | string | Specifies the logical interface (LIF) name.
> vserver |  | string | Specifies the Vserver name.

> 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..100] | 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..100] | integer | The number of records returned in this call.

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

net-interface-modify | [top]

> Modify the attributes of network interface object.

> Input Name | Range | Type | Description
> address |  | ip-address optional | Specifies the LIF's IP address. This element is valid for all data protocols except FCP.
> 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'
> dns-domain-name |  | string optional | Specifies the unique, fully qualified domain name of the DNS zone of this LIF.
> failover-group |  | string optional | Specifies the failover group name.
> 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'. Possible values: "nextavail" - Next failover target selected based on next available port ID, "priority" - Next failover target selected based on lowest available port ID, "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'
> home-node |  | string optional | Specifies the LIF's home node.
> home-port |  | string optional | Specifies the LIF's home port.
> interface-name |  | string | Specifies the logical interface (LIF) name.
> 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
> 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 by enabling is-ipv4-link-local to true.
> netmask |  | ip-address optional | Specifies the LIF's netmask. This element is valid for all data protocols except FCP.
> routing-group-name |  | string 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)
> 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'. Possible values: "system_defined" - Use port roles to select failover targets, "disabled" - Failover disabled, "enabled" - Use a failover group to select failover targets
> vserver |  | string | Specifies the Vserver name.

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

net-interface-modify-iter | [top]

> Modify the attributes of network interface or a group of network interface objects.

> Input Name | Range | Type | Description
> attributes |  | net-interface-info | Specify at least one modifiable element. Do not specify any other element.
> continue-on-failure |  | boolean optional | This input element is useful when multiple given network interface objects match a given query. If set to true, the API will continue modifying the next matching given network interface even when modification of a previous given network interface fails. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching given network interface even when the modification of a previous matching given network interface fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..100] | integer optional | The maximum number of objects to be modified in this call. Default: 20
> query |  | net-interface-info | If modifying a specific given network interface, this input element must specify all keys. If modifying given network interface objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of given network interface objects (just keys) that were not modified due to some error. If set to false, the list of given network interface objects not modified will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of given network interface objects (just keys) that were successfully updated. If set to false, the list of given network interface objects modified will not be returned. Default: true
> 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
> failure-list |  | net-interface-modify-iter-info[] optional | Information about given network interface objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching given network interface objects to be modified.
> num-failed | [0..100] | integer optional | Number of given network interface objects that matched the query, but were not modified due to some error.
> num-succeeded | [0..100] | integer optional | The number of given network interface objects that matched the query and were successfully updated.
> success-list |  | net-interface-modify-iter-info[] optional | The given network interface objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true

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

net-port-get | [top]

> Get the attributes of a network port.

> Input Name | Range | Type | Description
> desired-attributes |  | net-port-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.
> node |  | string | Specifies the name of node.
> port |  | string | Specifies the name of port.
> Output Name | Range | Type | Description
> attributes |  | net-port-info | The attributes of the given network port.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> ENODENOTFOUND |  |

net-port-get-iter | [top]

> Iterate over a list of network port objects.

> Input Name | Range | Type | Description
> desired-attributes |  | net-port-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..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | net-port-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the given network port object. All given network port 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-port-info[] optional | The list of attributes of given network port objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more given network port objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> ENODENOTFOUND |  |

net-port-ifgrp-add-port | [top]

> Add port to a network interface group.

> Input Name | Range | Type | Description
> ifgrp-name |  | lif-bindable | Specifies the interface group name.
> node |  | string | Specifies the name of node.
> port |  | string | Specifies the name of port.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> ENODENOTFOUND |  |

net-port-ifgrp-create | [top]

> Create a new network interface group.

> Input Name | Range | Type | Description
> distribution-function |  | string | Specifies the traffic distribution function for the ifgrp. Possible values: "mac" - Network traffic is distributed on the basis of MAC addresses, "ip" - Network traffic is distributed on the basis of IP addresses, "sequential" - Network traffic is distributed round-robin to each interface, "port" - Network traffic is distributed by transport layer address 4-tuple
> ifgrp-name |  | lif-bindable | Specifies the interface group name.
> mode |  | string | Specifies the link policy for the ifgrp. Possible values: 'multimode - All links are simultaneously active', 'multimode_lacp - Link state is managed by the switch using link aggregation control protocol (LACP) (IEEE 802.3ad)', 'singlemode - Only one link is active at a time'
> node |  | string | Specifies the name of node.
> return-record |  | boolean optional | If set to true, returns the network interface group on successful creation. Default: false
> Output Name | Range | Type | Description
> result |  | net-ifgrp-info optional | The network interface group created (keys or the entire object if requested)

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> ENODENOTFOUND |  |

net-port-ifgrp-destroy | [top]

> Destroy an existing network interface group.

> Input Name | Range | Type | Description
> ifgrp-name |  | lif-bindable | Specifies the interface group name.
> node |  | string | Specifies the name of node.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> ENODENOTFOUND |  |

net-port-ifgrp-get | [top]

> Get the attributes of a network interface group (ifgrp).

> Input Name | Range | Type | Description
> desired-attributes |  | net-ifgrp-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.
> ifgrp-name |  | lif-bindable | Specifies the interface group name.
> node |  | string | Specifies the name of node.
> Output Name | Range | Type | Description
> attributes |  | net-ifgrp-info | The attributes of the network interface group.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> ENODENOTFOUND |  |

net-port-ifgrp-remove-port | [top]

> Remove port from a network interface group.

> Input Name | Range | Type | Description
> ifgrp-name |  | lif-bindable | Specifies the interface group name.
> node |  | string | Specifies the name of node.
> port |  | string | Specifies the name of port.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> ENODENOTFOUND |  |

net-port-modify | [top]

> Modify the given attributes of network port and the rest remain unchanged.

> Input Name | Range | Type | Description
> administrative-duplex |  | string optional | Specifies the user preferred duplex setting of the port. Possible values: "undef" - No defined duplex, "auto" - Auto-negotiate duplex setting for link, "half" - Half-duplex link usage, "full" - Full-duplex link usage
> administrative-flowcontrol |  | string optional | Specifies the user preferred flow control setting of the port.
> administrative-speed |  | string optional | Specifies the user preferred speed setting of the port. Possible values: "undef" - No defined speed, "auto" - Auto-negotiate speed for link, "10" - 10 megabits per second, "100" - 100 megabits per second, "1000" - 1 gigabit per second, "10000" - 10 gigabits per second
> autorevert-delay | [0..2^32-1] | integer optional | For a port with role 'cluster', specifies the delay in seconds before autoreverting a LIF to this port.
> ifgrp-distribution-function |  | string optional | For a port of type 'ifgrp', specifies the traffic distribution function. Possible values: "mac" - Network traffic is distributed on the basis of MAC addresses, "ip" - Network traffic is distributed on the basis of IP addresses, "sequential" - Network traffic is distributed round-robin to each interface, "port" - Network traffic is distributed by transport layer address 4-tuple
> ifgrp-mode |  | string optional | For a port of type 'ifgrp', specifies the link policy. Possible values: 'multimode - All links are simultaneously active', 'multimode_lacp - Link state is managed by the switch using link aggregation control protocol (LACP) (IEEE 802.3ad)', 'singlemode - Only one link is active at a time'
> ifgrp-node |  | string optional | Specifies the name of the node on which interface group (ifgrp) is created.
> ifgrp-port |  | string optional | For a port of type 'ifgrp', specifies the name of the physical port on which ifgrp is created.
> is-administrative-auto-negotiate |  | boolean optional | Enables or disables Ethernet auto-negotiation of speed, duplex and flow control.
> is-administrative-up |  | boolean optional | If true, it changes the state of the port to 'up'.
> mtu | [0..2^32-1] | integer optional | Specifies the maximum transmission unit (MTU) of the port.
> node |  | string | Specifies the name of node.
> port |  | string | Specifies the name of port.
> port-type |  | string optional | Specifies the type of port. Possible values: "physical" - Physical network interface, "if_group" - Logical interface group (IEEE 802.3, section 43), "vlan" - Virtual LAN (IEEE 802.1Q), "undef" - No defined port type
> role |  | string optional | Specifies the role associated with the port. 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'

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> ENODENOTFOUND |  |

net-port-modify-iter | [top]

> Modify the attributes of network port or a group of network port objects.

> Input Name | Range | Type | Description
> attributes |  | net-port-info | Specify at least one modifiable element. Do not specify any other element.
> continue-on-failure |  | boolean optional | This input element is useful when multiple given network port objects match a given query. If set to true, the API will continue modifying the next matching given network port even when modification of a previous given network port fails. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching given network port even when the modification of a previous matching given network port fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..100] | integer optional | The maximum number of objects to be modified in this call. Default: 20
> query |  | net-port-info | If modifying a specific given network port, this input element must specify all keys. If modifying given network port objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of given network port objects (just keys) that were not modified due to some error. If set to false, the list of given network port objects not modified will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of given network port objects (just keys) that were successfully updated. If set to false, the list of given network port objects modified will not be returned. Default: true
> 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
> failure-list |  | net-port-modify-iter-info[] optional | Information about given network port objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching given network port objects to be modified.
> num-failed | [0..100] | integer optional | Number of given network port objects that matched the query, but were not modified due to some error.
> num-succeeded | [0..100] | integer optional | The number of given network port objects that matched the query and were successfully updated.
> success-list |  | net-port-modify-iter-info[] optional | The given network port objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> ENODENOTFOUND |  |

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

> Create a new network routing group route.

> Input Name | Range | Type | Description
> destination-address |  | string | Specifies the IP address and subnet mask of destination. For example: '198.18.10.0/24'
> gateway-address |  | string | Specifies the IP address of gateway. For example: '198.18.0.0'
> 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
> return-record |  | boolean optional | If set to true, returns the network routing group route on successful creation. Default: false
> 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)
> vserver |  | string | Specifies the name of Vserver.
> Output Name | Range | Type | Description
> result |  | routing-group-route-info optional | The network routing group route created (keys or the entire object if requested)

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

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

> Destroy an existing network routing group route.

> Input Name | Range | Type | Description
> destination-address |  | string | Specifies the IP address and subnet mask of destination. For example: '198.18.10.0/24'
> 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)
> vserver |  | string | Specifies the name of Vserver.

> 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..100] | 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..100] | integer | The number of records returned in this call.

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

net-vlan-create | [top]

> Create a new vlan interface. In Data ONTAP 7-Mode, changes made by this API are not persisted across system reboots. In Data ONTAP Cluster-Mode, changes made by this API are persisted across system reboots.

> Input Name | Range | Type | Description
> vlan-info |  | vlan-info | Vlan to create.

> Errno | Description
> EVLANEXISTS |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EINVALIDTAG |  |
> EINTERFACENOTFOUND |  |

net-vlan-delete | [top]

> Delete a vlan interface. In Data ONTAP 7-Mode, changes made by this API are not persisted across system reboots. In Data ONTAP Cluster-Mode, changes made by this API are persisted across system reboots.

> Input Name | Range | Type | Description
> vlan-info |  | vlan-info | Vlan to delete.

> Errno | Description
> EINTERFACENOTFOUND |  |

net-vlan-get | [top]

> Get the attributes of a VLAN.

> Input Name | Range | Type | Description
> desired-attributes |  | vlan-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 | Name of vlan interface. The name must be of the format <parent-inteface>-<vlanid>
> node |  | string | Node name of vlan interface.
> Output Name | Range | Type | Description
> attributes |  | vlan-info | The attributes of the network VLAN

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

net-vlan-get-iter | [top]

> Iterate over a list of VLAN objects.

> Input Name | Range | Type | Description
> desired-attributes |  | vlan-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..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | vlan-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the net-vlan object. All net-vlan 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 |  | vlan-info[] optional | The list of attributes of net-vlan objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more net-vlan objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

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

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: 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 address in dotted notation as '192.168.125.123'

> [none]

Element definition: lif-bindable | [top]

> [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-ifgrp-info | [top]

> Network interface group 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
> distribution-function |  | string optional | Specifies the traffic distribution function for the ifgrp. Attributes: required-for-create, non-modifiable Possible values: "mac" - Network traffic is distributed on the basis of MAC addresses, "ip" - Network traffic is distributed on the basis of IP addresses, "sequential" - Network traffic is distributed round-robin to each interface, "port" - Network traffic is distributed by transport layer address 4-tuple
> down-ports |  | lif-bindable[] optional | Specifies all inactive ports of an ifgrp. Attributes: non-creatable, non-modifiable
> ifgrp-name |  | lif-bindable optional | Specifies the interface group name. Attributes: key, required-for-create, non-modifiable
> mac-address |  | string optional | Specifies the MAC address of the ifgrp. For example: '02:0c:29:78:e1:b7' Attributes: non-creatable, non-modifiable
> mode |  | string optional | Specifies the link policy for the ifgrp. Possible values: 'multimode - All links are simultaneously active', 'multimode_lacp - Link state is managed by the switch using link aggregation control protocol (LACP) (IEEE 802.3ad)', 'singlemode - Only one link is active at a time' Attributes: required-for-create, non-modifiable
> node |  | string optional | Specifies the name of node. Attributes: key, required-for-create, non-modifiable
> port-participation |  | string optional | Port participation state of the ifgrp. Attributes: non-creatable, non-modifiable Possible values: "full" - Indicates all the ifgrp ports are active, "partial" - Indicates not all the ifgrp ports are active, "none" - Indicates none of the ifgrp ports is active
> ports |  | lif-bindable[] optional | List of ports associated with this ifgrp. Attributes: non-creatable, non-modifiable
> up-ports |  | lif-bindable[] optional | Specifies all active ports of an ifgrp. Attributes: 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
> 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
> 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 |  | string optional | Specifies the unique, fully qualified domain name of the DNS zone of this LIF. Attributes: optional-for-create, modifiable
> failover-group |  | string 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 available port ID, "priority" - Next failover target selected based on lowest available port ID, "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 by enabling is-ipv4-link-local to true. 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: non-creatable, non-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 |  | string 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) 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" - Use port roles to select failover targets, "disabled" - Failover disabled, "enabled" - Use a failover group to select failover targets
> vserver |  | string optional | Specifies the Vserver name. Attributes: key, non-creatable, non-modifiable

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

> Information about the modify operation that was attempted/performed against given network interface object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the modify operation caused an error.
> error-message |  | string optional | Error description, if the modify operation caused an error.
> net-key |  | net-interface-info | The keys for the given network interface object to which the modify operation applies.

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

> Network port 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
> administrative-duplex |  | string optional | Specifies the user preferred duplex setting of the port. Attributes: required-for-create, modifiable Possible values: "undef" - No defined duplex, "auto" - Auto-negotiate duplex setting for link, "half" - Half-duplex link usage, "full" - Full-duplex link usage
> administrative-flowcontrol |  | string optional | Specifies the user preferred flow control setting of the port. Attributes: required-for-create, modifiable
> administrative-speed |  | string optional | Specifies the user preferred speed setting of the port. Attributes: required-for-create, modifiable Possible values: "undef" - No defined speed, "auto" - Auto-negotiate speed for link, "10" - 10 megabits per second, "100" - 100 megabits per second, "1000" - 1 gigabit per second, "10000" - 10 gigabits per second
> autorevert-delay | [0..2^32-1] | integer optional | For a port with role 'cluster', specifies the delay in seconds before autoreverting a LIF to this port. Attributes: optional-for-create, modifiable
> ifgrp-distribution-function |  | string optional | For a port of type 'ifgrp', specifies the traffic distribution function. Attributes: required-for-create, modifiable Possible values: "mac" - Network traffic is distributed on the basis of MAC addresses, "ip" - Network traffic is distributed on the basis of IP addresses, "sequential" - Network traffic is distributed round-robin to each interface, "port" - Network traffic is distributed by transport layer address 4-tuple
> ifgrp-mode |  | string optional | For a port of type 'ifgrp', specifies the link policy. Possible values: 'multimode - All links are simultaneously active', 'multimode_lacp - Link state is managed by the switch using link aggregation control protocol (LACP) (IEEE 802.3ad)', 'singlemode - Only one link is active at a time' Attributes: required-for-create, modifiable
> ifgrp-node |  | string optional | Specifies the name of the node on which interface group (ifgrp) is created. Attributes: required-for-create, modifiable
> ifgrp-port |  | string optional | For a port of type 'ifgrp', specifies the name of the physical port on which ifgrp is created. Attributes: required-for-create, modifiable
> is-administrative-auto-negotiate |  | boolean optional | Enables or disables Ethernet auto-negotiation of speed, duplex and flow control. Attributes: required-for-create, modifiable
> is-administrative-up |  | boolean optional | If true, it changes the state of the port to 'up'. Attributes: required-for-create, modifiable
> is-operational-auto-negotiate |  | boolean optional | True if Ethernet auto negotiation is successful, false otherwise. Attributes: non-creatable, non-modifiable
> link-status |  | string optional | Specifies the link status of the port. Possible values: 'unknown - Port status unknown', 'up - Port is up', 'down - Port is down' Attributes: non-creatable, non-modifiable
> mac-address |  | string optional | Specifies the MAC address of the port. Attributes: non-creatable, non-modifiable
> mtu | [0..2^32-1] | integer optional | Specifies the maximum transmission unit (MTU) of the port. Attributes: required-for-create, modifiable
> node |  | string optional | Specifies the name of node. Attributes: key, required-for-create, non-modifiable
> operational-duplex |  | string optional | Duplex setting reported by the port after Ethernet auto-negotiation. Attributes: non-creatable, non-modifiable Possible values: "undef" - No defined duplex, "auto" - Auto-negotiate duplex setting for link, "half" - Half-duplex link usage, "full" - Full-duplex link usage
> operational-flowcontrol |  | string optional | Flow control setting reported by the port after Ethernet auto-negotiation. Attributes: non-creatable, non-modifiable
> operational-speed |  | string optional | Speed setting reported by the port after Ethernet auto-negotiation. Attributes: non-creatable, non-modifiable Possible values: "undef" - No defined speed, "auto" - Auto-negotiate speed for link, "10" - 10 megabits per second, "100" - 100 megabits per second, "1000" - 1 gigabit per second, "10000" - 10 gigabits per second
> port |  | string optional | Specifies the name of port. Attributes: key, required-for-create, non-modifiable
> port-type |  | string optional | Specifies the type of port. Attributes: required-for-create, modifiable Possible values: "physical" - Physical network interface, "if_group" - Logical interface group (IEEE 802.3, section 43), "vlan" - Virtual LAN (IEEE 802.1Q), "undef" - No defined port type
> role |  | string optional | Specifies the role associated with the port. 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' Attributes: required-for-create, modifiable
> vlan-id | [0..2^32-1] | integer optional | For a port of type 'vlan', specifies the vlan identification number. Attributes: required-for-create, non-modifiable
> vlan-node |  | string optional | Specifies the name of the node on which vlan is created. Attributes: required-for-create, non-modifiable
> vlan-port |  | string optional | For a port of type 'vlan', specifies the name of the physical port on which the vlan is created. Attributes: required-for-create, non-modifiable

Element definition: net-port-modify-iter-info | [top]

> Information about the modify operation that was attempted/performed against given network port object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the modify operation caused an error.
> error-message |  | string optional | Error description, if the modify operation caused an error.
> net-key |  | net-port-info | The keys for the given network port object to which the modify operation applies.

Element definition: network-type | [top]

> The network topology classification Possible values: "wan" , "lan" , "undefined"

> [none]

Element definition: protocol-layer4 | [top]

> The network layer 4 protocol type Possible values: "udp" - UDP, "tcp" - TCP, "na" - not_available

> [none]

Element definition: receive-buffer | [top]

> Receive buffer window size configuration 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
> network |  | network-type optional | The network topology classification Attributes: key, required-for-create, non-modifiable Possible values: "wan" , "lan" , "undefined"
> protocol |  | protocol-layer4 optional | The network layer 4 protocol type Attributes: key, required-for-create, non-modifiable Possible values: "udp" - UDP, "tcp" - TCP, "na" - not_available
> receive-buffer | [256..7168] | integer optional | Receive buffer size in Kilobytes Attributes: required-for-create, modifiable
> service |  | stream-protocol-service optional | The stream protocol connection classification Attributes: key, required-for-create, non-modifiable Possible values: "mount" - Mount stream protocol, "nfs" - NFS stream protocol, "nfs_v2" - NFS version 2 stream protocol, "nfs_v3" - NFS version 3 stream protocol, "nlm_v4" - Network lock manager stream protocol, "sm" - Session Manager stream protocol, "ftp_ctrl" - FTP control stream protocol, "ftp_data" - FTP data stream protocol, "http_1_0" - HTTP version 1 stream protocol, "http_1_1" - HTTP version 1.1 stream protocol, "iscsi" - ISCSI stream protocol, "cifs_srv" - CIFS server stream protocol, "cifs_nam" - CIFS name server stream protocol, "loopback" - loopback stream protocol, "rf" - RC stream protocol, "rawscp" - Raw secure copy stream protocol, "discard" - Descard stream protocol, "port_map" - Port map stream protocol, "pass_thru" - Passthru stream protocol, "rclopcp" - Rc connection stream protocol, "nfs_v4" - NFS version 4 stream protocol, "fcache" - Flex cache stream protocol, "ctlopcp" - Ct connection stream protocol, "rquota" - Rquota stream protocol, "unknown" - unknown protocol

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
> destination-address |  | string optional | Specifies the IP address and subnet mask of destination. For example: '198.18.10.0/24' Attributes: key, required-for-create, non-modifiable
> gateway-address |  | string optional | Specifies the IP address of gateway. For example: '198.18.0.0' 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) Attributes: key, required-for-create, non-modifiable
> vserver |  | string optional | Specifies the name of Vserver. Attributes: key, non-creatable, non-modifiable

Element definition: stream-protocol-service | [top]

> The stream protocol connection classification Possible values: "mount" - Mount stream protocol, "nfs" - NFS stream protocol, "nfs_v2" - NFS version 2 stream protocol, "nfs_v3" - NFS version 3 stream protocol, "nlm_v4" - Network lock manager stream protocol, "sm" - Session Manager stream protocol, "ftp_ctrl" - FTP control stream protocol, "ftp_data" - FTP data stream protocol, "http_1_0" - HTTP version 1 stream protocol, "http_1_1" - HTTP version 1.1 stream protocol, "iscsi" - ISCSI stream protocol, "cifs_srv" - CIFS server stream protocol, "cifs_nam" - CIFS name server stream protocol, "loopback" - loopback stream protocol, "rf" - RC stream protocol, "rawscp" - Raw secure copy stream protocol, "discard" - Descard stream protocol, "port_map" - Port map stream protocol, "pass_thru" - Passthru stream protocol, "rclopcp" - Rc connection stream protocol, "nfs_v4" - NFS version 4 stream protocol, "fcache" - Flex cache stream protocol, "ctlopcp" - Ct connection stream protocol, "rquota" - Rquota stream protocol, "unknown" - unknown protocol

> [none]

Element definition: vlan-info | [top]

> vlan

> Name | Range | Type | Description
> gvrp-enabled |  | boolean | true: GVRP is enabled. GVRP is a standard protocol enabling the node to advertise its vlan information to the entire network through GVRP aware devices. This protocol eliminates the need to manually configure vlan information on each switch in the network.
> interface-name |  | string | Name of vlan interface. The name must be of the format <parent-inteface>-<vlanid>
> node |  | string optional | Node name of vlan interface.
> parent-interface |  | string | The physical interface that hosts the vlan interface.
> vlanid |  | integer | The vlan id. Range: 1..4094.

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: enable | [top]

> 'enabled' or 'disabled'

> [none]

Element definition: ip-address | [top]

> IPv4 address in dotted notation as '192.168.125.123'

> [none]

Element definition: lif-bindable | [top]

> [none]

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
> 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
> 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 |  | string optional | Specifies the unique, fully qualified domain name of the DNS zone of this LIF. Attributes: optional-for-create, modifiable
> failover-group |  | string 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 available port ID, "priority" - Next failover target selected based on lowest available port ID, "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 by enabling is-ipv4-link-local to true. 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: non-creatable, non-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 |  | string 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) 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" - Use port roles to select failover targets, "disabled" - Failover disabled, "enabled" - Use a failover group to select failover targets
> vserver |  | string optional | Specifies the Vserver name. Attributes: key, non-creatable, non-modifiable

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

> Network port 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
> administrative-duplex |  | string optional | Specifies the user preferred duplex setting of the port. Attributes: required-for-create, modifiable Possible values: "undef" - No defined duplex, "auto" - Auto-negotiate duplex setting for link, "half" - Half-duplex link usage, "full" - Full-duplex link usage
> administrative-flowcontrol |  | string optional | Specifies the user preferred flow control setting of the port. Attributes: required-for-create, modifiable
> administrative-speed |  | string optional | Specifies the user preferred speed setting of the port. Attributes: required-for-create, modifiable Possible values: "undef" - No defined speed, "auto" - Auto-negotiate speed for link, "10" - 10 megabits per second, "100" - 100 megabits per second, "1000" - 1 gigabit per second, "10000" - 10 gigabits per second
> autorevert-delay | [0..2^32-1] | integer optional | For a port with role 'cluster', specifies the delay in seconds before autoreverting a LIF to this port. Attributes: optional-for-create, modifiable
> ifgrp-distribution-function |  | string optional | For a port of type 'ifgrp', specifies the traffic distribution function. Attributes: required-for-create, modifiable Possible values: "mac" - Network traffic is distributed on the basis of MAC addresses, "ip" - Network traffic is distributed on the basis of IP addresses, "sequential" - Network traffic is distributed round-robin to each interface, "port" - Network traffic is distributed by transport layer address 4-tuple
> ifgrp-mode |  | string optional | For a port of type 'ifgrp', specifies the link policy. Possible values: 'multimode - All links are simultaneously active', 'multimode_lacp - Link state is managed by the switch using link aggregation control protocol (LACP) (IEEE 802.3ad)', 'singlemode - Only one link is active at a time' Attributes: required-for-create, modifiable
> ifgrp-node |  | string optional | Specifies the name of the node on which interface group (ifgrp) is created. Attributes: required-for-create, modifiable
> ifgrp-port |  | string optional | For a port of type 'ifgrp', specifies the name of the physical port on which ifgrp is created. Attributes: required-for-create, modifiable
> is-administrative-auto-negotiate |  | boolean optional | Enables or disables Ethernet auto-negotiation of speed, duplex and flow control. Attributes: required-for-create, modifiable
> is-administrative-up |  | boolean optional | If true, it changes the state of the port to 'up'. Attributes: required-for-create, modifiable
> is-operational-auto-negotiate |  | boolean optional | True if Ethernet auto negotiation is successful, false otherwise. Attributes: non-creatable, non-modifiable
> link-status |  | string optional | Specifies the link status of the port. Possible values: 'unknown - Port status unknown', 'up - Port is up', 'down - Port is down' Attributes: non-creatable, non-modifiable
> mac-address |  | string optional | Specifies the MAC address of the port. Attributes: non-creatable, non-modifiable
> mtu | [0..2^32-1] | integer optional | Specifies the maximum transmission unit (MTU) of the port. Attributes: required-for-create, modifiable
> node |  | string optional | Specifies the name of node. Attributes: key, required-for-create, non-modifiable
> operational-duplex |  | string optional | Duplex setting reported by the port after Ethernet auto-negotiation. Attributes: non-creatable, non-modifiable Possible values: "undef" - No defined duplex, "auto" - Auto-negotiate duplex setting for link, "half" - Half-duplex link usage, "full" - Full-duplex link usage
> operational-flowcontrol |  | string optional | Flow control setting reported by the port after Ethernet auto-negotiation. Attributes: non-creatable, non-modifiable
> operational-speed |  | string optional | Speed setting reported by the port after Ethernet auto-negotiation. Attributes: non-creatable, non-modifiable Possible values: "undef" - No defined speed, "auto" - Auto-negotiate speed for link, "10" - 10 megabits per second, "100" - 100 megabits per second, "1000" - 1 gigabit per second, "10000" - 10 gigabits per second
> port |  | string optional | Specifies the name of port. Attributes: key, required-for-create, non-modifiable
> port-type |  | string optional | Specifies the type of port. Attributes: required-for-create, modifiable Possible values: "physical" - Physical network interface, "if_group" - Logical interface group (IEEE 802.3, section 43), "vlan" - Virtual LAN (IEEE 802.1Q), "undef" - No defined port type
> role |  | string optional | Specifies the role associated with the port. 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' Attributes: required-for-create, modifiable
> vlan-id | [0..2^32-1] | integer optional | For a port of type 'vlan', specifies the vlan identification number. Attributes: required-for-create, non-modifiable
> vlan-node |  | string optional | Specifies the name of the node on which vlan is created. Attributes: required-for-create, non-modifiable
> vlan-port |  | string optional | For a port of type 'vlan', specifies the name of the physical port on which the vlan is created. Attributes: required-for-create, non-modifiable

Element definition: network-type | [top]

> The network topology classification Possible values: "wan" , "lan" , "undefined"

> [none]

Element definition: protocol-layer4 | [top]

> The network layer 4 protocol type Possible values: "udp" - UDP, "tcp" - TCP, "na" - not_available

> [none]

Element definition: vserver-name | [top]

> The name of the Vserver.

> [none]

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: ip-address | [top]

> IPv4 address in dotted notation as '192.168.125.123'

> [none]