APIs in Category: ifc | API version 5.0

ifc-list-info-iter-end ifc-list-info-iter-next ifc-list-info-iter-start | List network interface information stored in DFM Server database.

NetApp Manage ONTAP

ifc-list-info-iter-end | [top]

> Ends iteration of interfaces.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous ifc-list-info-iter-start.

> Errno | Description
> EINVALIDTAG |  |

ifc-list-info-iter-next | [top]

> Get next set of records in the iteration started by call to ifc-list-info-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer optional | Maximum records to retrieve. Range: [1..2^31-1]
> tag |  | string | Tag from a previous ifc-list-info-iter-start.
> Output Name | Range | Type | Description
> ifcs |  | ifc-info[] | List of interfaces.
> records |  | integer | The number of records actually returned. Value of 0 records indicates that end of records. Range: [1..2^31-1]

> Errno | Description
> EINVALIDTAG |  |

ifc-list-info-iter-start | [top]

> Start iteration of interfaces.

> Input Name | Range | Type | Description
> ipspace |  | string optional | IPSpace name. If specified only the interfaces that belong the given ipspace are returned.
> object-management-filter |  | object-management-interface optional | Filter the object based on the Data ONTAP interface that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. If no filter is supplied, all objects will be considered.
> object-name-or-id |  | obj-name-or-id optional | Name of Id of the following objects. Interface Storage system If storage sytem name or Id is specified, only the interfaces discovered on the storage system are returned. The name of the interface should be specified in : format. Ex: "toaster:e0a".
> Output Name | Range | Type | Description
> records |  | integer | Number of records fetched and stored for retrieval using ifc-list-info-iter-next. Range: [1..2^31-1]
> tag |  | string | Tag to be used for subsequent calls.

> Errno | Description
> EACCESSDENIED |  |
> EOBJECTNOTFOUND |  |
> EDATABASEERROR |  |
> EINVALIDINPUTERROR |  |
> EOBJECTAMBIGUOUS |  |

Element definition: ifc-info | [top]

> Information of about one interface.

> Name | Range | Type | Description
> host-id |  | obj-id | Identifier of the Filer on which the interface is present.
> host-name |  | string | DNS name of the Filer on which the interface is present.
> ifc-id |  | obj-id | Identifier of interface in DFM Server database. Range: [1..2^31-1]
> ifc-name |  | obj-name | Name of the interface (ex: e0a).
> ip-address |  | string optional | IP address configured for the interface. Empty in case the interface in unconfigured.
> ip-address-type |  | string | Type of IP address configured for the interface. Possible values are: ipv4 ipv6
> ipspace |  | string | Name of the IPSpace to which the interface belongs.
> is-vlan-capable |  | boolean optional | Specifies if the interface is capable of supporting VLAN tagging. An interface will not support VLAN tagging if: It is not VLAN capable (at present only some INTEL NICs are supported for VLAN tagging.) It is a physical interface on which a VIF is configured. It is an interface that is already accepting traffic.
> mtu-size |  | integer optional | Interface mtu size.
> netmask |  | string optional | Netmask configured for the interface. Empty in case the interface is unconfigured or configured with IPv6 address.
> partner-interface-id |  | obj-id optional | Partner interface identifier. This element is present only when the storage system on which the interface is present is in an Active/Active configuration and there is a partner interface configured for this interface.
> partner-interface-name |  | obj-full-name optional | Partner interface name. This element is present only when the storage system on which the interface is present is in an Active/Active configuration and there is a partner interface configured for this interface.
> prefix-length |  | integer optional | Prefix length for the IP address configured for the interface. Empty in case the interface is unconfigured. In case of IPv4 address, it is number of netmask bits. Range: [1..127]
> status |  | string | Operation status of the interface, valid values are "up", "down", "testing", "unknown".
> type |  | string | Type of interface. Possible values are "ethernet", "fddi", "loopback", "atm", "vif", "vlan", "unknown".

Element definition: obj-name-or-id | [top]

> Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI type string. An obj-name-or-id must contain between 1 and 64 characters, and must conform to one of the following formats: It must have the format of an obj-name, or It must be the decimal numeric string form of a positive integer whose value is in the range [1..2^31 - 1]. In case of application resources from the Host Service, this field can contain unique identifier assigned to the object by the Host Service e.g. for a Virtual Machine, it can be a GUID of the VM. One exception is when such unique identifier is a decimal numeric string containing only digits from 0 through 9. In that case, you cannot use such identifier as obj-name-or-id input. Elements of type obj-name-or-id are used only as inputs to ZAPIs. The value must match either the name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object type (e.g. dataset, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the format of an obj-name-or-id input element does not conform, or the value does not match the name or ID of an existing object, then generally the ZAPI documents that it fails with error code EOBJECTNOTFOUND. A ZAPI may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If a ZAPI can accept a null value (e.g. reference to no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null value.

> [none]

Element definition: object-management-interface | [top]

> Specify the management interface of ONTAP that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. Possible values are: "node" - For objects manageable by node management interface "cluster" - For objects manageable by cluster management interface

> [none]

Element definition: obj-full-name | [top]

> Full name of a DFM object. This typedef is an alias for the builtin ZAPI type string. An object full name conforms to all the rules of an obj-name, except that the full name may be up to 255 characters long. DFM creates full names by concatenating an object name with any parent object names, so as to create a unique name for an object. The format of full names is as follows: Host full names are the either the fully-qualified domain name or the IP address of the host. Aggregate full names are the host name and the aggregate name, separated by a colon, e.g. hostname:aggr0. Volume full names are the host name and the volume name, separated by ":/", e.g. hostname:/volume. Note this does not include "/vol". Volume and aggregate full names are distinguished by the presence of a forward slash after the colon. Qtree full names are the containing volume full name and the qtree name, separated by a slash, e.g. hostname:/volume/qtree. The data not contained by any qtree may be represented by "-", e.g. hostname:/volume/-. Lun Path full names are either a volume or qtree full name and the LUN path, separated by a slash, e.g. hostname:/volume/LUN or hostname:/volume/qtree/LUN. Network full names are a network address block in CIDR format, e.g. 1.2.3.0/8. OSSV Directory full names are the OSSV host name and the OSSV path, separated by a colon, e.g. host-lnx:/usr/local or host-w2k:c:/temp Include any others here... Initiator Group full names are host name and the initiator group name, separated by a colon, e.g. hostname:igroup. For any DFM object not listed above, the obj-name and obj-full-name are identical.

> [none]

Element definition: obj-id | [top]

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

> [none]

Element definition: obj-name | [top]

> Name of a DFM 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 EINVALIDINPUTERROR. Note that because EINVALIDINPUTERROR 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 DFM object type (e.g. data set, host, DP policy, 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. For example, this constraint applies to datasets, DP schedules, and DP policies. This means that no two datasets may have the same name, but a dataset may have the same name as a DP schedule or DP policy. In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered to be the same name for purposes of: creating new objects, renaming existing objects, or looking up an object by name. On the other hand, ZAPIs that return an obj-name generally do not change the capitalization at all. For example, if an object's name has been set to "MyObject", then list iteration ZAPIs that return the object's name return it as "MyObject" rather than "MYOBJECT" or "myobject". ZAPIs that operate on obj-name values and do not follow these general rules about case sensitivity must document the rules that they do follow. One important exception to these general rules is that volumes, qtrees, OSSV directories, SRM paths, interfaces, FCP targets and FC switch ports all have case-sensitive names. When looking up objects of these types by name, the case must match the object name.

> [none]