APIs in Category: Vfiler | API version 5.0

VfilerCreate VfilerDestroy VfilerSetup VfilerTemplateCopy VfilerTemplateCreate VfilerTemplateDelete VfilerTemplateListInfoIterEnd VfilerTemplateListInfoIterNext VfilerTemplateListInfoIterStart VfilerTemplateModify | A set of APIs To manage vFilers and vFiler templates. vFiler template APIs are used To create, modify, Destroy and list vFiler template Objects. They contain information that is used To setup a vFiler. vFiler APIs can be used To create a vFiler on a particular Filer or From a Resource pool, To set up the vFiler with appropriate configuration From a vFiler template and also To Destroy a vFiler.

NetApp Manage ONTAP API version 5.0

VfilerCreate (supported) | [top]

> Create a new vFiler on a storage system. A vFiler can be created by either: Specifying the Filer on which To create it. Speciying a Resource pool. In this case, a Filer is selected From the Resource pool based on required Licenses and in-built Resource selection algorithm To evenly balance space and load in the Resource pool and a vFiler will be created on the selected Filer. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have required Capabilities To create a vFiler. EOBJECTNOTFOUND - When the specified ResourceNameOrId Id not found. EFILERNOTFOUND - No storage system could be found on which a vFiler could be created. EINVALIDINPUT - Invalid input provided for certain fields. EINVALIDMEMBERTYPE - when the Filer is in c-mode. EMULTISTORENOTLICENSED - When ResourceNameOrId corresponds To a Filer that does not have multistore licensed.

> Input Name | Type
> VfilerCreate | VfilerCreate
> Output Name | Type
> VfilerCreateResult | VfilerCreateResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EFILERNOTFOUND |  |
> EINVALIDINPUT |  |
> EINVALIDMEMBERTYPE |  |
> EMULTISTORENOTLICENSED |  |
> EOBJECTNOTFOUND |  |

VfilerDestroy (supported) | [top]

> Destroy a Vfiler. This API stops and then destroys the vFiler on the hosting Filer and marks the vFiler as deleted in DFM. Storage resources owned by the vFiler are not destroyed. They will be owned by the hosting Filer after the vFiler is destroyed. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have required Capabilities To Destroy the vFiler. EOBJECTAMBIGUOUS - When the specified object Name is ambiguous. EOBJECTNOTFOUND - When the specified vFiler is not found.

> Input Name | Type
> VfilerDestroy | VfilerDestroy
> Output Name | Type
> VfilerDestroyResult | VfilerDestroyResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |

VfilerSetup (supported) | [top]

> Configure and setup a vFiler based on a specified vFiler template. Depending on the input a CIFS setup will also be done on the vFiler. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have required Capabilities To setup the vFiler. EOBJECTAMBIGUOUS - When the specified object Name is ambiguous. EOBJECTNOTFOUND - When the specified vFiler is not found. EINVALIDINPUT - Invalid input provided.

> Input Name | Type
> VfilerSetup | VfilerSetup
> Output Name | Type
> VfilerSetupResult | VfilerSetupResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |

VfilerTemplateCopy (supported) | [top]

> Creates a new vFiler template by copying all settings From an existing vFiler template. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have privileges To create the Vfiler template. EVFILERTEMPLATEEXISTS - A vFiler template already exists with this Name. EOBJECTNOTFOUND - When the specified vFiler template does not exist.

> Input Name | Type
> VfilerTemplateCopy | VfilerTemplateCopy
> Output Name | Type
> VfilerTemplateCopyResult | VfilerTemplateCopyResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTNOTFOUND |  |
> EVFILERTEMPLATEEXISTS |  |

VfilerTemplateCreate (supported) | [top]

> Creates a vFiler template. A vFiler template contains configuration information that is used during vFiler setup. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have privileges To create the vFiler template. EVFILERTEMPLATEEXISTS - A vFiler template already exists with this Name. EINVALIDINPUT - Input validation failed.

> Input Name | Type
> VfilerTemplateCreate | VfilerTemplateCreate
> Output Name | Type
> VfilerTemplateCreateResult | VfilerTemplateCreateResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EVFILERTEMPLATEEXISTS |  |

VfilerTemplateDelete (supported) | [top]

> Deletes the vFiler template. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have Capabilities To delete the vFiler template. EOBJECTNOTFOUND - When the specified vFiler template does not exist.

> Input Name | Type
> VfilerTemplateDelete | VfilerTemplateDelete
> Output Name | Type
> VfilerTemplateDeleteResult | VfilerTemplateDeleteResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTNOTFOUND |  |
> EVFILERTEMPLATEINUSE |  |

VfilerTemplateListInfoIterEnd (supported) | [top]

> Ends iteration of vFiler templates.

> Input Name | Type
> VfilerTemplateListInfoIterEnd | VfilerTemplateListInfoIterEnd
> Output Name | Type
> VfilerTemplateListInfoIterEndResult | VfilerTemplateListInfoIterEndResult

> Error Name | Description
> EINVALIDTAG |  |

VfilerTemplateListInfoIterNext (supported) | [top]

> Get next Records in the iteration started by VfilerTemplateListInfoIterStart.

> Input Name | Type
> VfilerTemplateListInfoIterNext | VfilerTemplateListInfoIterNext
> Output Name | Type
> VfilerTemplateListInfoIterNextResult | VfilerTemplateListInfoIterNextResult

> Error Name | Description
> EINVALIDTAG |  |

VfilerTemplateListInfoIterStart (supported) | [top]

> Lists vFiler templates. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have required Capabilities To list vFiler templates. EOBJECTAMBIGUOUS - When the specified object Name is ambiguous. EOBJECTNOTFOUND - When the specified vFiler template does not exist.

> Input Name | Type
> VfilerTemplateListInfoIterStart | VfilerTemplateListInfoIterStart
> Output Name | Type
> VfilerTemplateListInfoIterStartResult | VfilerTemplateListInfoIterStartResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |

VfilerTemplateModify (supported) | [top]

> Modifies the settings in a vFiler template. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have capabilties To create the vFiler template. EVFILERTEMPLATEEXISTS - A vFiler template already exists with this Name. EINVALIDINPUT - Input validation failed.

> Input Name | Type
> VfilerTemplateModify | VfilerTemplateModify
> Output Name | Type
> VfilerTemplateModifyResult | VfilerTemplateModifyResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EVFILERTEMPLATEEXISTS |  |

Element definition: VfilerCreate | [top]

> Create a new vFiler on a storage system. A vFiler can be created by either: Specifying the Filer on which To create it. Speciying a Resource pool. In this case, a Filer is selected From the Resource pool based on required Licenses and in-built Resource selection algorithm To evenly balance space and load in the Resource pool and a vFiler will be created on the selected Filer. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have required Capabilities To create a vFiler. EOBJECTNOTFOUND - When the specified ResourceNameOrId Id not found. EFILERNOTFOUND - No storage system could be found on which a vFiler could be created. EINVALIDINPUT - Invalid input provided for certain fields. EINVALIDMEMBERTYPE - when the Filer is in c-mode. EMULTISTORENOTLICENSED - When ResourceNameOrId corresponds To a Filer that does not have multistore licensed.

> Name | Type | Description
> AllowedProtocols | ArrayOfProtocol optional | List of protocols that needs To be allowed access To the vFiler. If not specfied, none of the protocols will be allowed on the vFiler.
> DryRun | xsd:boolean optional | Check if a vFiler can be created on the given ResourceNameOrId. The hosting Filer on which the vFiler is created will be returned. If there are any Errors, because of which a vFiler cannot be created on the given ResourceNameOrId, the API will throw an Error. No changes are made To the ResourceNameOrId when DryRun is true. Default Value is false.
> IpAddress | IpAddress optional | IP Address of the new vFiler. This element is not required only when the API is run in DryRun mode.
> Ipspace | xsd:string optional | IP Space of the new vFiler. Only alphabets, number, hyphens and underscore characters are allowed. It can be a Maximum of 64 characters. If not specified, vFiler is created in "default-ipspace".
> Name | ObjName | Name of the new vFiler To be created. Only alphabets, number, hyphens and underscore characters are allowed. It can be a Maximum of 64 characters.
> ResourceNameOrId | ObjNameOrId | Name or identifier of the hosting Filer or Resource pool From which To provision a new vFiler.

Element definition: VfilerCreateResult | [top]

> Name | Type | Description
> FilerId | ObjId | Identifier of hosting Filer on which the vFiler was or will be created in DryRun mode.
> FilerName | ObjFullName | Name of the hosting Filer on which the vFiler was or will be created in DryRun mode.
> RootVolumeId | ObjId optional | Identifier of the root Volume created for this vFiler Unit. This is not returned when the API is run in DryRun mode.
> RootVolumeName | ObjFullName optional | Full Name of the root Volume created for this vFiler Unit. This is not returned when the API is run in DryRun mode.
> VfilerId | ObjId optional | Identifier of new vFiler created in DFM database. This is not returned when the API is run in DryRun mode.

Element definition: VfilerDestroy | [top]

> Destroy a Vfiler. This API stops and then destroys the vFiler on the hosting Filer and marks the vFiler as deleted in DFM. Storage resources owned by the vFiler are not destroyed. They will be owned by the hosting Filer after the vFiler is destroyed. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have required Capabilities To Destroy the vFiler. EOBJECTAMBIGUOUS - When the specified object Name is ambiguous. EOBJECTNOTFOUND - When the specified vFiler is not found.

> Name | Type | Description
> VfilerNameOrId | ObjNameOrId | Name of identifier of the vFiler To be destroyed.

Element definition: VfilerDestroyResult | [top]

> [none]

Element definition: VfilerSetup | [top]

> Configure and setup a vFiler based on a specified vFiler template. Depending on the input a CIFS setup will also be done on the vFiler. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have required Capabilities To setup the vFiler. EOBJECTAMBIGUOUS - When the specified object Name is ambiguous. EOBJECTNOTFOUND - When the specified vFiler is not found. EINVALIDINPUT - Invalid input provided.

> Name | Type | Description
> AllowedProtocols | ArrayOfProtocol optional | List of protocols that needs To be allowed access To the vFiler. This list overrides the list of protocols currently allowed on the vFiler. If this is not present, no changes are done To the allowed protocols of the vFiler.
> CifsDomainPassword | xsd:string optional | Password for CifsDomainUser. Encrypted using 2-way encryption. Applicable and mandatory if CifsAuthType is set To "active_directory" in Vfiler template specified in VfilerTemplateNameOrId. Default Value is empty.
> CifsDomainUser | xsd:string optional | Name of CIFS domain user that has the ability To add the CIFS server To the domain given in CifsDomainName in Vfiler template specified in VfilerTemplateNameOrId. Examples: Username (assumes DomainName is the user's domain), cifsdomain\username, cifs.domain.com\username. Applicable and mandatory if CifsAuthType is set To "active_directory" in Vfiler template specified in VfilerTemplateNameOrId. Default Value is empty.
> CifsWorkgroupName | xsd:string optional | CIFS workgroup Name of the new Vfiler. If VfilerTemplateNameOrId is specified, this field is applicable only if CifsAuthType is "workgroup" in the specified VfilerTemplate. This field is also applicable when VfilerTemplateNameOrId is not given, but cifs setup needs To be done on the vFiler. Default Value is "WORKGROUP" and this will be used during CIFS setup of the vFiler if RunCifsSetup is true.
> IpBindings | ArrayOfIpBindingInfo optional | IP Address To Interface binding information.
> RootPassword | xsd:string optional | Root Password of the new vFiler. This will be the Password for a new root account that will be created on the vFiler. If a root account already exists on this vFiler, then the Password for the root account will not be changed. Encrypted using 2-way encryption. Length: [0..64] Default Value is empty. Ignored if IpBindings element is not present.
> RunCifsSetup | xsd:boolean optional | Indicates whether CIFS setup should be performed on the vFiler Unit. Note that if this is true and CIFS is already running on the vFiler Unit, CIFS Service will be stopped, and then a setup will be performed. Default Value is FALSE.
> ScriptPath | xsd:string optional | Path To a script that will be run in pre setup and post setup mode when setting up the vFiler Unit.
> VfilerNameOrId | ObjNameOrId | Full Name or identifier of the vFiler To be setup.
> VfilerTemplateNameOrId | ObjNameOrId optional | Name or identifier of vFiler template. The vFiler is setup based on the settings specified in the template. If this is not specified, then DNS, NIS servers cannot be configured for the vFiler. Also, a CIFS setup cannot be done using active_directory. Ignored if IpBindings element is not present and RunCifsSetup is false.

Element definition: VfilerSetupResult | [top]

> [none]

Element definition: VfilerTemplateCopy | [top]

> Creates a new vFiler template by copying all settings From an existing vFiler template. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have privileges To create the Vfiler template. EVFILERTEMPLATEEXISTS - A vFiler template already exists with this Name. EOBJECTNOTFOUND - When the specified vFiler template does not exist.

> Name | Type | Description
> VfilerTemplateName | ObjName | Name of the new vFiler template To be created.
> VfilerTemplateNameOrId | ObjNameOrId | The Name or identifier of an existing vFiler template that is copied To create a new vFiler template.

Element definition: VfilerTemplateCopyResult | [top]

> Name | Type | Description
> VfilerTemplateId | ObjId | Identifier of the newly created vFiler template.

Element definition: VfilerTemplateCreate | [top]

> Creates a vFiler template. A vFiler template contains configuration information that is used during vFiler setup. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have privileges To create the vFiler template. EVFILERTEMPLATEEXISTS - A vFiler template already exists with this Name. EINVALIDINPUT - Input validation failed.

> Name | Type | Description
> VfilerTemplate | WrapperOfVfilerTemplateInfo | vFiler template information.

Element definition: VfilerTemplateCreateResult | [top]

> Name | Type | Description
> VfilerTemplateId | ObjId | Identifier of the newly created vFiler template.

Element definition: VfilerTemplateDelete | [top]

> Deletes the vFiler template. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have Capabilities To delete the vFiler template. EOBJECTNOTFOUND - When the specified vFiler template does not exist.

> Name | Type | Description
> VfilerTemplateNameOrId | ObjNameOrId | Name or identifier of the vFiler template.

Element definition: VfilerTemplateDeleteResult | [top]

> [none]

Element definition: VfilerTemplateListInfoIterEnd | [top]

> Ends iteration of vFiler templates.

> Name | Type | Description
> Tag | xsd:string | An internal opaque handle used by the DFM station.

Element definition: VfilerTemplateListInfoIterEndResult | [top]

> [none]

Element definition: VfilerTemplateListInfoIterNext | [top]

> Get next Records in the iteration started by VfilerTemplateListInfoIterStart.

> Name | Type | Description
> Maximum | xsd:integer | The Maximum number of entries To retrieve. Range: [1..2^31-1]
> Tag | xsd:string | Tag From a previous VfilerTemplateListInfoIterStart. It's an opaque handle used by the DFM station To identify the temporary store created by VfilerTemplateListInfoIterStart.

Element definition: VfilerTemplateListInfoIterNextResult | [top]

> Name | Type | Description
> Records | xsd:integer | The number of Records actually returned.
> VfilerTemplates | ArrayOfVfilerTemplateInfo | List of vFiler templates.

Element definition: VfilerTemplateListInfoIterStart | [top]

> Lists vFiler templates. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have required Capabilities To list vFiler templates. EOBJECTAMBIGUOUS - When the specified object Name is ambiguous. EOBJECTNOTFOUND - When the specified vFiler template does not exist.

> Name | Type | Description
> VfilerTemplateNameOrId | ObjNameOrId optional | Name or identifier of the vFiler template. If not specified, it lists all vFiler templates.

Element definition: VfilerTemplateListInfoIterStartResult | [top]

> Name | Type | Description
> Records | xsd:integer | Number which tells you how many Vfiler templates are present for future retrieval with VfilerTemplateListInfoIterNext. Range: [1..2^31-1]
> Tag | xsd:string | Tag To be used in subsequent calls To VfilerTemplateListInfoIterNext. It is an opaque handle used by the DFM station To identify a temporary store.

Element definition: VfilerTemplateModify | [top]

> Modifies the settings in a vFiler template. Error conditions: EDATABASEERROR - A database Error occurred while processing the Request. EACCESSDENIED - User does not have capabilties To create the vFiler template. EVFILERTEMPLATEEXISTS - A vFiler template already exists with this Name. EINVALIDINPUT - Input validation failed.

> Name | Type | Description
> VfilerTemplate | WrapperOfVfilerTemplateInfo | Information of the vFiler template To be modified.

Element definition: VfilerTemplateModifyResult | [top]

> [none]

Element definition: ArrayOfIpBindingInfo | [top]

> Name | Type | Description
> IpBindingInfo | IpBindingInfo[] |

Element definition: ArrayOfProtocol | [top]

> Name | Type | Description
> Protocol | Protocol[] |

Element definition: ArrayOfVfilerTemplateInfo | [top]

> Name | Type | Description
> VfilerTemplateInfo | VfilerTemplateInfo[] |

Element definition: IpAddress | [top]

> IP Address in string format. The Length of this string cannot be more than 40 characters.

> [none]

Element definition: ObjFullName | [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 ObjName, 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 ObjName and ObjFullName are identical.

> [none]

Element definition: ObjId | [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 ObjId 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 ObjId 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: ObjName | [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 ObjName 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 ObjFullName 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 ObjName 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 ObjName 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]

Element definition: ObjNameOrId | [top]

> Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An ObjNameOrId must contain between 1 and 64 characters, and must conform To one of the following formats: It must have the format of an ObjName, 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 ObjNameOrId input. Elements of Type ObjNameOrId 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 ObjNameOrId 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: WrapperOfVfilerTemplateInfo | [top]

> Name | Type | Description
> VfilerTemplateInfo | VfilerTemplateInfo |

Element definition: IpBindingInfo | [top]

> vFiler IP Address To Interface binding information.

> Name | Type | Description
> Interface | ObjNameOrId | Name or identifier of the Interface To bind the vFiler IP Address To. This can be either a physical Interface, VIF or a VLAN. Example: "e0a", "myvif", "service_vlan"
> IpAddress | IpAddress | IP Address of the vFiler which is bound To the Interface. If this IP Address is not already added To the vFiler, then the IP Address is first added To the vFiler before binding the IP Address with the given Interface.
> MtuSize | xsd:integer optional | MTU Size of the new VLAN Interface. This element should be present only if a new VLAN Interface is being created during vFiler setup. Also the Version of Data ONTAP on the storage system on which the vFiler is being setup, should be 7.3.3 or later. Range: [296..9196]
> Netmask | xsd:string optional | Netmask for the IP Address in dotted decimal notation. For IPv4 Address, either Netmask or PrefixLength can be supplied. For IPv6 Address, Netmask is ignored.
> PartnerInterface | ObjNameOrId optional | Name or identifier of the Interface on the partner node. This element is valid when the storage system on which this vFiler Unit is present is in a Active/Active configuration. If a new VLAN is getting created on the local node, then a new corresponding VLAN will also be created on the partner node on this Interface.
> PrefixLength | xsd:integer optional | Prefix Length for the IP Address. This is required if IPv6 Address is supplied. For IPv4 Address, either Netmask or PrefixLength can be supplied. Range: [1..127]
> VlanIdentifier | xsd:integer optional | Identifier for creating a new VLAN Interface. If this element is present, the Interface element should refer To a physical VLAN tagged Interface. Range: [1..4094]

Element definition: Protocol | [top]

> Name of the Protocol. Possible Values: "nfs", "cifs", "iscsi".

> [none]

Element definition: VfilerTemplateInfo | [top]

> Information about a vFiler Template.

> Name | Type | Description
> AdministrativeHostIpAddress | IpAddress optional | IP Address of the vFiler's administrative Host. By default, this field is empty.
> CifsAuthType | xsd:string optional | CIFS authentication mode To be used for the CIFS setup of a vFiler. This determines the method by which clients will be authenticated when connecting To the CIFS Service on the vFiler. Possible Values: "active_directory", "workgroup". Default Value: "workgroup"
> CifsDomain | xsd:string optional | Active Directory domain To which the vFiler will join To. This can be the NetBIOS or fully qualified domain Name. Examples: cifsdomain, cifs.domain.com This field is applicable only when CifsAuthType is set To "active-directory" and is ignored otherwise.
> CifsSecurityStyle | xsd:string optional | The security style determines whether or not the CIFS Service on vFiler will support multiprotocol access. Possible Values: "ntfs", "multiprotocol". Default Value is: "multiprotocol"
> Description | xsd:string optional | Description of vFiler template. By default, this field is empty.
> DnsDomain | xsd:string optional | Name of the DNS domain for a vFiler that is setup using this vFiler template. By default, this field is empty.
> DnsServers | ArrayOfIpAddress optional | List of DNS servers for a vFiler that is setup using this vFiler template.
> NisDomain | xsd:string optional | Name of the NIS domain for a vFiler that is setup using this vFiler template. By default, this field is empty.
> NisServers | ArrayOfIpAddress optional | List of NIS servers for a vFiler that is setup using this vFiler template.
> VfilerTemplateId | ObjId optional | Identifier of the vFiler template. This is ignored in VfilerTemplateCreate.
> VfilerTemplateName | ObjName optional | Name of the vFiler template. This must be specified in VfilerTemplateCreate.

Element definition: ArrayOfIpAddress | [top]

> Name | Type | Description
> IpAddress | IpAddress[] |