APIs in Category: net
API version 6.1

 
net-interface-iter

NetApp Manage ONTAP
 
net-interface-iter [top]

Iterate over logical interfaces. This API lists ethernet interfaces only. It does not list FCP interfaces.
Input Name Range Type Description
is-cluster-interface-only boolean
optional
If this flag is set, only the ethernet interfaces owned by the cluster are returned. Interfaces owned by a vserver or cluster node will not be returned. This input can only be provided with a resource-filter value for a cluster.
max-records integer
optional
The maximum number of records per return batch the caller wants to receive. The server may return smaller batch sizes based on performance constraints. If this field is not provided, then the server will return default number of records based on server performance.
resource-filter resource-key
optional
Resource by which to filter the result set. Any resource-filters specified in the first call must be included in subsequent calls. The allowed object types for this argument are:
  • cluster
  • vserver
  • cluster_node
  • network_lif
If resource-filter identifies a network_lif, that single network_lif will be returned. If resource-filter resolves to more than one network_lif, all of them will be returned. If no resource-filter is provided, all network_lifs will be listed.
tag string
optional
Specify the tag from the last call. It is not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Any resource-filters specified in the first call must be included in subsequent calls.
 
Output Name Range Type Description
next-tag string
optional
Tag for the next call. Not present when there are no more objects to return.
num-records integer
The number of records returned in this call.
records net-interface-info[]
optional
The list of records.

 
Element definition: net-interface-info [top]
Information of about one interface.
Name Range Type Description
address-type string
optional
Type of IP address configured for the interface. Possible values are:
  • ipv4
  • ipv6
administrative-status string
optional
The administrative status of the interface. 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'
cluster-name string
Name of the cluster that the interface resides on.
current-node string
optional
Name of the interface's current node.
current-port string
optional
Name of the interface's current port.
data-protocols data-protocol[]
optional
The list of data protocols configured on the interface.
failover-group string
optional
The failover group name of this interface.
failover-policy string
Failover policy: "nextavail", "priority", "disabled", "unmapped".
home-node string
optional
Name of the interface's home node.
home-port string
optional
Name of the interface's home port.
is-home boolean
optional
True if the interface is currently on 'home-node' and 'home-port'.
name obj-name
Name of the interface (e.g.: e0a).
network-address string
optional
Network address for the interface.
network-prefix-length [0..127] integer
optional
Prefix length for the network mask of the interface.
operational-status string
Operational status of the interface, valid values are "up", "down", "testing", "unknown".
owner-name obj-name
Name of the owner of the interface.
owner-resource-key resource-key
The resource key for the owner of the interface. The owner is determined from the network interface's role. If the role is "data" then the owner will be a vserver. If the role is "node_mgmt" then the owner will be a cluster node. Otherwise the owner will be a cluster.
owner-type obj-type
Type of the interface's owner. Possible values are:
  • cluster
  • cluster_node
  • vserver
resource-key resource-key
The resource key for the interface.

 
Element definition: resource-key [top]
A self-describing string identifier for a managed resource.
[none]

 
Element definition: data-protocol [top]
Data protocol configured on an interface. 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: obj-name [top]
Name of an object. This typedef is an alias for the built in ZAPI type string. An object name must conform to the following format:
  • It must contain between 1 and 64 characters.
  • It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9').
  • In some contexts, a name may be the empty string (""), which is interpreted as a null value, e.g., a reference to no object at all.
The behavior of a ZAPI when it encounters an error involving an obj-name input element depends on how the ZAPI uses the input element. Here are the general rules:
  • If the input name element is used to create a new object with the given name, or rename an existing object to that name, and the name does not conform to the above format, then the ZAPI fails with error code EINVALIDINPUT. Note that because EINVALIDINPUT is such a common error code, ZAPI specifications are not required to document cases when they may return it.
  • If the input name element is used to refer to an existing object with that name, and there is no object with that name, then the ZAPI fails with error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this error code.
A ZAPI may deviate from these general rules, for example, it may return more specific error codes. In such cases, the ZAPI specification must document its behavior.

If an input name element is used to refer to an existing object, then the ZAPI specification must specify which object type (e.g. cluster, vserver, volume etc.) is allowed. Some ZAPIs allow the object to be one of several different types. See the description of obj-full-name for examples of valid input formats.

Note that there is no requirement that all object names must be unique. However, the names for some specific types of objects are constrained such that no two objects of that type may have the same name.

[none]

 
Element definition: obj-type [top]
Type of a managed object. Possible values:
  • "cluster"
  • "cluster-node"
  • "vserver"
  • "resource-group"
  • "volume"
  • "qtree"
  • "disk"
  • "network-interface"
  • "management-station"
  • "quota-user"
  • "initiator-group"
  • "lun"
  • "fcp-target"
  • "aggregate"
  • "port"
  • "port-set"
  • "lif"
  • "ifgrp"
  • "export-policy"
  • "role"
  • "storage-service"
  • "service-workflow"
[none]