APIs in Category: host | API version 3.8

host-add host-add-license host-add-ossv host-agent-ossv-service-start host-agent-ossv-service-stop host-capability-list-iter-end host-capability-list-iter-next host-capability-list-iter-start host-create-ndmpuser host-domainuser-add host-domainuser-list-iter-end host-domainuser-list-iter-next host-domainuser-list-iter-start host-domainuser-push host-domainuser-remove host-get-defaults host-list-info-iter-end host-list-info-iter-next host-list-info-iter-start host-modify host-modify-agent-credentials host-role-create host-role-delete host-role-list-iter-end host-role-list-iter-next host-role-list-iter-start host-role-modify host-role-push host-set-option host-user-add host-user-delete host-user-list-iter-end host-user-list-iter-next host-user-list-iter-start host-user-modify host-user-modify-password host-user-push host-usergroup-create host-usergroup-delete host-usergroup-list-iter-end host-usergroup-list-iter-next host-usergroup-list-iter-start host-usergroup-modify host-usergroup-push | Host operations include display and modification of configuration retrieved from the hosts or provided when the hosts are added to the DFM, as well as status information obtained by monitoring. Modifications to the host attributes are stored in the DFM database only, except for licenses, which are added on the physical host as well as the database.

NetApp Manage ONTAP

host-add | [top]

> Add new managed host to the DataFabric Manager. The host being added must be a storage system or an host agent. DFM figures out what type of host we're adding. If it's an appliance (storage system, NetCache, or FC Switch), we add the appiance to the database and set the appliance-id. If it's a host agent, we add the agent to the database and set the agent-id. On return, only one of the appliance-id or agent-id will be set.

> Input Name | Range | Type | Description
> add-network |  | boolean optional | Indicates if DFM should start monitoring the network in which new host resides. Default is false.
> admin-port |  | integer optional | The port to use to try to access a host agent. Range: [1..65535]
> host-name-or-id |  | string | Name, dfm id, or IP address of the host to be added. Value can be a DFM * object name (maximum 255 characters), a fully qualified domain name (FQDN)(maximum 255 characters), or the ip address. If the value is a DFM object name for a host object with a deletion flag, the deletion flag is removed. <P> Length: [0..255]
> Output Name | Range | Type | Description
> agent-id |  | host-id optional | Identifier of the newly added host agent.
> appliance-id |  | host-id optional | Identifier of the newly added appliance.
> host-address |  | string optional | IP address for the host. Length: [0..39]

> Errno | Description
> EINVALIDINPUT |  |
> EAPIERROR |  |
> EINTERNALERROR |  |
> EOBJECTNOTFOUND |  |
> EOBJECTAMBIGUOUS |  |
> EACCESSDENIED |  |
> EHOSTRUNMONFAILED |  |
> EHOSTADDNOTRESOLVED |  |
> EHOSTADDNOSNMP |  |
> EHOSTADDNOCONTACT |  |
> EHOSTADDTAKENOVER |  |
> EHOSTADDDUPPRODID |  |
> EHOSTEXISTS |  |
> EHOSTADDNONODES |  |
> EHOSTADDNOLICENSE |  |
> EDATABASEERROR |  |
> EHOSTADDVFILERPARENTDELETED |  |

host-add-license | [top]

> Add a license to a host. Host must be a storage system. Host must already be present in DFM's database and root login and password for the host must be set in DFM. The DFM will check the list of licenses on the host and update the database when the following types of licenses are changed: Snapvault primary (sv_ontap_pri) Snapvault secondary (sv_ontap_sec) Unix primary (sv_unix_pri) Linux primary (sv_linux_pri) Windows primary (sv_windows_pri) Snapmirror (snapmirror) Synchronous snapmirror (snapmirror_sync) Windows OFM primary (sv_windows_ofm_pri) Nearstore (nearstore_option) NFS (nfs) CIFS (cifs) iSCSI (iscsi) MultiStore (vfiler) FCP (fcp) ASIS (a_sis) If the license is already in use by another host and is not a site license, then the ZAPI will apply the license to the host, and then return with error code ELICENSEINUSE. The ELICENSEINUSE error will not be returned if the optional parameter suppress-inuse-error is true. The ELICENSEINUSE error will not prevent the license from being applied to the host, since it is not the role of the DFM to prevent the user from installing duplicate licenses. The storage system must be running a minimum ONTAP version of 6.5.6.

> Input Name | Range | Type | Description
> host-license |  | string | License to be installed on storage system.
> host-name-or-id |  | host-name-or-id | The host to receive the license.
> suppress-inuse-error |  | boolean optional | If true, suppresses the ELICENSEINUSE error. Defaults to false.

> Errno | Description
> EHOSTDOESNOTEXIST |  |
> EBADHOSTTYPE |  |
> EHOSTCOMMUNICATION |  |
> EHOSTACCESSDENIED |  |
> ELICENSEINUSE |  |
> EINVALIDLICENSE |  |
> EAPIERROR |  |

host-add-ossv | [top]

> Add new managed ossv host to the DataFabric Manager. If there is an ossv agent running on the host, we add the ossv agent to the database as a snapvault primary and set the ossv-id.

> Input Name | Range | Type | Description
> host-name-or-id |  | string | Name or IP address of the host to be added or the DFM object id of a previously deleted OSSV agent. When adding a new OSSV agent, the value can be a valid DFM object name (maximum 255 characters), a fully qualified domain name (FQDN)(maximum 255 characters), or the IPv4 address. When adding a previously deleted OSSV agent, the id must be the ID of the deleted OSSV agent, not the id of host agent on the same client system Length: [0..255]
> ndmp-credentials |  | full-ndmp-credentials optional | The ndmp credentials we should try to use to connect to the ossv host we're trying to add.
> Output Name | Range | Type | Description
> host-address |  | string optional | IP address for the host. Length: [0..39]
> ossv-id |  | host-id optional | Identifier of the newly added ossv agent.

> Errno | Description
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EAPIERROR |  |
> EINTERNALERROR |  |
> EOBJECTNOTFOUND |  |
> EOBJECTAMBIGUOUS |  |
> EACCESSDENIED |  |
> EHOSTADDNOCONTACT |  |
> EHOSTNDMPTABLOOKUPFAILED |  |
> EHOSTADDNOLICENSE |  |
> EHOSTADDNONODES |  |
> EHOSTEXISTS |  |
> EHOSTADDMISMATCHPRODID |  |
> EHOSTADDDUPPRODID |  |
> EBADHOSTTYPE |  |
> EHOSTADDNOTENABLED |  |
> EHOSTNDMPACCESSFAILED |  |
> EHOSTBADCONFIG |  |
> EHOSTADDNOTRESOLVED |  |
> EHOSTADDNOCONTACT |  |
> EHOSTRUNMONFAILED |  |

host-agent-ossv-service-start | [top]

> Start the OSSV service on the host agent using the ossv ZAPI. DFM must have valid credentials for the Host Agent. The Host Agent and OSSV Agent must be installed on the host. Valid only for Host Agents. DFM will wait up to the time allowed in the timeout argument to make sure the requested service state was reached. If the timeout is exceeded, we return ESERVICESTATEUNKNOWN.

> Input Name | Range | Type | Description
> agent-name-or-id |  | host-name-or-id | The name or id of the agent host to start/stop the ossv service on.
> timeout |  | integer optional | Number of seconds to wait for ossv service to start/stop. Range: [1..100]

> Errno | Description
> EOBJECTAMBIGUOUS |  |
> ESERVICESTATEUNKNOWN |  |
> EAGENTNOTUPTODATE |  |
> EHOSTDOESNOTEXIST |  |
> EHOSTCOMMUNICATION |  |
> EHOSTACCESSDENIED |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EAPIERROR |  |
> EINTERNALERROR |  |
> EHOSTBADCONFIG |  |

host-agent-ossv-service-stop | [top]

> Stop the OSSV service on the host agent using the ossv ZAPI. DFM must have valid credentials for the Host Agent. The Host Agent and OSSV Agent must be installed on the host. Valid only for Host Agents. DFM will wait up to the time allowed in the timeout argument to make sure the requested service state was reached. If the timeout is exceeded, we return ESERVICESTATEUNKNOWN.

> Input Name | Range | Type | Description
> agent-name-or-id |  | host-name-or-id | The name or id of the agent host to start/stop the ossv service on.
> timeout |  | integer optional | Number of seconds to wait for ossv service to start/stop. Range: [1..100]

> Errno | Description
> EOBJECTAMBIGUOUS |  |
> ESERVICESTATEUNKNOWN |  |
> EAGENTNOTUPTODATE |  |
> EHOSTDOESNOTEXIST |  |
> EHOSTCOMMUNICATION |  |
> EHOSTACCESSDENIED |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EAPIERROR |  |
> EINTERNALERROR |  |
> EHOSTBADCONFIG |  |

host-capability-list-iter-end | [top]

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous host-capability-list-iter-start call.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

host-capability-list-iter-next | [top]

> Returns items from a previous call to host-capability-list-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..2^31-1]
> tag |  | string | Tag from a previous host-capability-list-iter-start-call.
> Output Name | Range | Type | Description
> capabilities |  | capability[] | List of capabilities on the host.
> records |  | integer | The number of records actually returned. Range: [1..2^31-1]

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

host-capability-list-iter-start | [top]

> Initiates a query for a list of allowed capabilities on host. This is applicable for hosts running ONTAP versions 7.0 and above.

> Input Name | Range | Type | Description
> host-name-or-id |  | obj-name-or-id | Name or id of the host to list the capabilities for. Only storage systems and vFiler units are allowed.
> Output Name | Range | Type | Description
> records |  | integer | Number indicating how many items are available for future retrieval with host-capability-list-iter-next. Range: [1..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to host-capability-list-iter-next or host-capability-list-iter-end.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> EHOSTOSVERSIONNOTSUPPORTED |  |

host-create-ndmpuser | [top]

> Create an NDMP user on the host, creating the user account if necessary and storing the host-encrypted password on dfm. If the user exists already, we generate the encrypted NDMP password for them on the storage system and store that in the database. If it is a new user on the storage system, we will create a new unencrypted password for the caller and use that to generate the encrypted NDMP password which we will then store in the database. If the user is root, we will just use root's unencrypted password as the NDMP password since the encryption requirement does not apply to the root user. New non-root users will be added to the "Backup Administrators" group. Valid only for storage systems.

> Input Name | Range | Type | Description
> host-name-or-id |  | host-name-or-id | The host to create the NDMP user on.
> ndmp-username |  | ndmp-username | NDMP user name.

> Errno | Description
> EOBJECTAMBIGUOUS |  |
> EHOSTDOESNOTEXIST |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> ENOTLICENSED |  |
> EINVALIDINPUT |  |
> EAPIERROR |  |
> EINTERNALERROR |  |
> EBADHOSTTYPE |  |

host-domainuser-add | [top]

> Adds a domain user on the host. This is applicable for hosts running ONTAP versions 7.0 and above.

> Input Name | Range | Type | Description
> host-domainuser-name-or-id-or-sid |  | domainuser-name-or-id-or-sid | Name or id or SID of domain user.
> host-name-or-id |  | obj-name-or-id optional | Name or id of the host on which the domain user is to be added. Only storage systems and vFiler units are allowed.
> host-usergroup-names-or-ids |  | host-usergroup-name-or-id[] | List of ids or names of usergroups to which the domain user has to be added.
> Output Name | Range | Type | Description
> host-domainuser-id |  | access-object-id | Identifier of the domain user added to usergroup(s) on host.

> Errno | Description
> EINTERNALERROR |  |
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDDOMAINUSERNAME |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> EDOMAINUSERNOTFOUND |  |
> EUSERGROUPNOTFOUND |  |
> EDUPLICATEUSERGROUP |  |
> EHOSTOSVERSIONNOTSUPPORTED |  |

host-domainuser-list-iter-end | [top]

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous host-domainuser-list-iter-start call.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

host-domainuser-list-iter-next | [top]

> Returns items from a previous call to host-domainuser-list-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..2^31-1]
> tag |  | string | Tag from a previous host-domainuser-list-iter-start call.
> Output Name | Range | Type | Description
> host-domainusers |  | host-domainuser-info[] | List of domain users on host(s).
> records |  | integer | The number of records actually returned. Range: [1..2^31-1]

> Errno | Description
> EINVALIDTAG |  |
> EAPIERROR |  |
> EINVALIDINPUT |  |

host-domainuser-list-iter-start | [top]

> Initiates a query for a list of domain users on host(s). Domain users on host(s) that matches all filters will be returned. If no input is specified, all the domain users on all monitored storage systems/vFiler units will be returned.

> Input Name | Range | Type | Description
> host-domainuser-name-or-id-or-sid |  | domainuser-name-or-id-or-sid optional | Name or SID or id of the domain user on the host.
> host-usergroup-name-or-id |  | usergroup-name-or-id optional | Name of id of the user group. If specified only the users belonging to this group will be listed.
> object-name-or-id |  | obj-name-or-id optional | Name or id of an object to list the domain users for. The allowed object types for this argument are: Resource Group Host (only storage systems and vFiler units are allowed)
> verbose |  | boolean optional | Default is false. If set to true, then the usergroups, roles, and allowed capabilities are placed into the host-domainuser-info element.
> Output Name | Range | Type | Description
> records |  | integer | Number indicating how many items are available for future retrieval with host-domainuser-list-iter-next. Range: [1..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to host-domainuser-list-iter-next or host-domainuser-list-iter-end.

> Errno | Description
> EINTERNALERROR |  |
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTNOTFOUND |  |
> EBADOBJECTTYPE |  |
> EDOMAINUSERNOTFOUND |  |
> EUSERGROUPNOTFOUND |  |

host-domainuser-push | [top]

> Input Name | Range | Type | Description
> host-domainuser-name-or-id-or-sid |  | domainuser-name-or-id-or-sid | Name or id or SID of the domain user on the host.
> host-name-or-id |  | obj-name-or-id | Name or id of the host to push the domain user on. Only storage systems and vFiler units are allowed.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> EDOMAINUSERNOTFOUND |  |
> EDOMAINUSERAMBIGUOUS |  |
> EUSERGROUPNOTFOUND |  |
> EINCOMPATIBLEUSERGROUP |  |
> EHOSTOSVERSIONNOTSUPPORTED |  |

host-domainuser-remove | [top]

> Removes a domain user from a usergroup or usergroups.

> Input Name | Range | Type | Description
> host-domainuser-name-or-id-or-sid |  | domainuser-name-or-id-or-sid | Name or id or SID of domain user on the host.
> host-usergroup-names-or-ids |  | host-usergroup-name-or-id[] | List of ids or names of usergroups from which the domain user has to be removed.

> Errno | Description
> EINTERNALERROR |  |
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EDOMAINUSERNOTFOUND |  |
> EDOMAINUSERAMBIGUOUS |  |
> EUSERGROUPNOTFOUND |  |

host-get-defaults | [top]

> The DFM stores a set of global default values for selected attributes, which are used on all hosts. The administrator can override the values on a per-host basis. This api returns the default values for some attributes returned by host-list-info-iter-next. Default values vary according to the host type.

> Output Name | Range | Type | Description
> host-defaults |  | host-defaults | The default values of the attributes defined by this ZAPI set.

> Errno | Description
> EACCESSDENIED |  |
> EAPIERROR |  |

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

> Ends iteration to list hosts.

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

> Errno | Description
> EAPIERROR |  |
> EACCESSDENIED |  |
> EINVALIDTAG |  |

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

> Get next few records in the iteration started by host-list-info-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer validate | The maximum number of entries to retrieve. Range: [1..2^31-1]
> tag |  | string | The tag returned by a previous host-list-info-iter-start.
> Output Name | Range | Type | Description
> hosts |  | host-info[] | Array of hosts.

> Errno | Description
> EINVALIDTAG |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EAPIERROR |  |

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

> Starts iteration to list hosts. The list of hosts can include: Storage Systems vFiler units Netcache appliances Host Agents OSSV Agents Switches Use the filtering criteria in this API to specify the list of hosts returned by host-list-info-iter-next. If no filtering criteria is specified, all non-deleted hosts will be returned by host-list-info-iter-next.

> Input Name | Range | Type | Description
> expand-filer-to-vfilers |  | boolean optional | If true and object-name-or-id is a storage system and host-types contains "vfiler" then all vFiler units belonging to the storage system are returned else it is ignored. Default value is false.
> host-dp-filter-info |  | host-dp-filter-info optional | Data Protection specific information for this iterator.
> host-types |  | host-type[] optional | Types of hosts to list. If the host type matches any of the types in this array of host types it will be included in the list, subject to other filtering criteria. If this list contains an unknown type the EBADHOSTTYPE error will be returned.
> include-is-available |  | boolean optional | If true, the is-available status is calculated for each host which may make the call to this zapi take much longer.
> include-migration-info |  | boolean optional | If true, return the migration information for the migrating vFiler units. Default false.
> is-direct-member-only |  | boolean optional | If true, only return the hosts that are direct members of the specified resource group. Default value is false. This field is meaningful only if a resource group name or id is given for the object-name-or-id field.
> license-filter |  | license[] optional | Filter for listing storage systems based on services licensed. Appliable when host-type is "filer". Only those storage systems which have all the licenses installed as specified in input are listed.
> object-name-or-id |  | obj-name-or-id optional | Name or identifier of an object to list hosts for. The allowed object types for this argument are: Resource Group Resource Pool Dataset Storage Set Host Aggregate Volume Qtree OSSV Directory If object-name-or-id identifies a host, that single host will be returned. If object-name-or-id resolves to more than one hosts, all of them will be returned. If no object-name-or-id is provided, all hosts will be listed. Host Agents and OSSV agents may use a subdomain to identify themselves, unlike other host types. If the host-types element includes "agent" or "ossv" all subdomains beginning with the host name will be checked.
> query-host |  | boolean optional | If true, query the host to update the database and refresh the values returned in the following elements by host-list-info-iter-next: host-status is-agent-ossv-enabled is-snapvault-enabled is-ndmp-enabled is-snapmirror-enabled snapvault-access-specifier ndmp-access-specifier snapmirror-access-specifier host-communication-status host-credentials-status ndmp-communication-status ndmp-credentials-status ndmp-agent-status is-snapvault-primary is-snapvault-secondary is-snapmirror-host is-unix-primary is-linux-primary is-windows-primary is-windows-ofm-primary is-nearstore The host-list-info-iter-next zapi defines which elements will be updated based on whether the host type supports it. Errors in communicating with or authenticating to the host will prevent updating all the elements that are supported for that host type.
> vfiler-ipspace |  | vfiler-ipspace optional | Filter for listing vFiler units, if specified, only the vFiler units that belong to the ipspace are listed. Applicable only for host-type "vfiler".
> Output Name | Range | Type | Description
> records |  | integer | Number indicating how many items are available for future retrieval with host-list-iter-next. Range: [0..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to host-list-iter-next or host-list-iter-end.

> Errno | Description
> EAPIERROR |  |
> EINTERNALERROR |  |
> EINVALIDINPUT |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |
> EBADHOSTTYPE |  |

host-modify | [top]

> Modify attributes stored in the DFM database of a host managed by the DFM.

> Input Name | Range | Type | Description
> host-modify-info |  | host-modify-info | Host information.
> host-name-or-id |  | host-name-or-id | The host to be modified.

> Errno | Description
> EOBJECTAMBIGUOUS |  |
> EHOSTDOESNOTEXIST |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> ENOTLICENSED |  |
> EINVALIDINPUT |  |
> ENOTSUPPORTED |  |
> EAPIERROR |  |
> EINTERNALERROR |  |

host-modify-agent-credentials | [top]

> Change the password on the Host Agent for the built in Host Agent management user "admin", using the Operating System credentials specified by os-username and os-password to authenticate the https POST request. If the operation succeeds, update the Host Agent password stored in the DFM database. Valid only for Host Agents.

> Input Name | Range | Type | Description
> agent-name-or-id |  | host-name-or-id | The host to change the Host Agent password on.
> management-password |  | host-password optional | New password for the Host Agent management API password. If this parameter is present, it is assumed to be encrypted using two way encryption. If this parameter is not present, the DFM will generate a password.
> os-password |  | host-password | root or administrative password used to authenticate https POST password change request. Encrypted using two way encryption.
> os-username |  | string | root or administrative user name used to authenticate https POST password change request.

> Errno | Description
> EOBJECTAMBIGUOUS |  |
> EHOSTDOESNOTEXIST |  |
> EHOSTACCESSDENIED |  |
> EHOSTCOMMUNICATION |  |
> EHOSTREQUESTDENIED |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EAPIERROR |  |
> EINTERNALERROR |  |
> EBADHOSTTYPE |  |

host-role-create | [top]

> Creates a role on the host. This is applicable for hosts running ONTAP versions 7.0 and above.

> Input Name | Range | Type | Description
> host-role |  | host-role-info | New role information. "host-role-name" and at least one allowed capability must be specified. Either host name or id on which the role is to be created must be provided. If both host name and host id are provided, then id takes precedence. Description is also allowed. All other fields are ignored.
> Output Name | Range | Type | Description
> host-role-id |  | access-object-id | Identifier of the new role created on the host.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDROLENAME |  |
> EINVALIDDESCRIPTION |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> EDUPLICATEROLE |  |
> EINVALIDCAPABILITY |  |
> EHOSTOSVERSIONNOTSUPPORTED |  |

host-role-delete | [top]

> Deletes a role on the host.

> Input Name | Range | Type | Description
> host-role-name-or-id |  | access-object-name-or-id | Name or id of the role to be deleted on the host.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> ENOTFOUNDROLE |  |
> EROLEAMBIGUOUS |  |

host-role-list-iter-end | [top]

> Terminates a view list iteration and clean up any saved info.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous host-role-list-iter-start call.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

host-role-list-iter-next | [top]

> Returns items from a previous call to host-role-list-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..2^31-1]
> tag |  | string | Tag from a previous host-role-list-iter-start call.
> Output Name | Range | Type | Description
> host-roles |  | host-role-info[] | List of roles on host(s).
> records |  | integer | The number of records actually returned. Range: [1..2^31-1]

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

host-role-list-iter-start | [top]

> Initiates a query for a list of roles on host(s). Roles on host(s) that match all filters will be returned. If no input is specified, all the roles on all monitored storage systems or vFiler units will be returned.

> Input Name | Range | Type | Description
> host-role-name-or-id |  | access-object-name-or-id optional | Name or id of a role on the host. If this is provided, the output contains only the information associated with this role.
> object-name-or-id |  | obj-name-or-id optional | Name or id of an object to list the roles for. The allowed object types for this argument are: Resource Group Host (allowed host types are storage system and vFiler units)
> verbose |  | boolean optional | Default is false. If set to true, then the allowed capabilities are placed into the host-role-info element.
> Output Name | Range | Type | Description
> records |  | integer | Number indicating how many items are available for future retrieval with host-role-list-iter-next. Range: [1..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to host-role-list-iter-next or host-role-list-iter-end.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTNOTFOUND |  |
> EOBJECTAMBIGUOUS |  |
> ENOTFOUNDROLE |  |

host-role-modify | [top]

> Modifies a role on the host.

> Input Name | Range | Type | Description
> host-role |  | host-role-info | Role name or id must be provided. Host name or id is an optional parameter. If one or more capabilities and/or description is provided, the role is modified accordingly. If both name and id are provided, id takes precedence.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDDESCRIPTION |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> ENOTFOUNDROLE |  |
> EROLEAMBIGUOUS |  |
> EINVALIDCAPABILITY |  |

host-role-push | [top]

> Input Name | Range | Type | Description
> host-name-or-id |  | obj-name-or-id | Name or id of the host to push the role on. Only storage systems and vFiler units are allowed.
> host-role-name-or-id |  | access-object-name-or-id | Name or id of the role to be pushed on the host.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> ENOTFOUNDROLE |  |
> EROLEAMBIGUOUS |  |
> EINVALIDCAPABILITY |  |
> EHOSTOSVERSIONNOTSUPPORTED |  |

host-set-option | [top]

> Change the option on the storage system specified by host-option-name to the value specified by host-option-value. If the operation succeeds the following options will be stored in the DFM database and will be returned in the specified elements the next time host-list-info-iter-next is called.
> host-option-name | host-list-info-iter-next element
> --- | ---
> ndmpd.enable | is-ndmp-enabled
> ndmpd.access | ndmp-access-specifier
> snapvault.enable | is-snapvault-enabled
> snapvault.access | snapvault-access-specifier
> snapmirror.enable | is-snapmirror-enabled
> snapmirror.access | snapmirror-access-specifier
> If the name of the host option ends in ".access" and the value of the host option is the empty string, the value will be changed to "none". See na_options(1) for a list of option names and values. See na_protocolaccess(8) for access specifier syntax and usage. Valid only for storage systems.

> Input Name | Range | Type | Description
> host-name-or-id |  | host-name-or-id | The host to set the option on.
> host-option-name |  | string | The name of the host option. Length: [0..255]
> host-option-value |  | string | The host option will be set to this value. Length: [0..255]

> Errno | Description
> EOBJECTAMBIGUOUS |  |
> EHOSTDOESNOTEXIST |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EAPIERROR |  |
> EINTERNALERROR |  |
> EBADHOSTTYPE |  |

host-user-add | [top]

> Creates a local user on the host. This is applicable for hosts running ONTAP versions 7.0 and above.

> Input Name | Range | Type | Description
> host-user |  | host-user-info | New local user information. host-user-name, password and at least one usergroup must be provided. Usergroup can be specified in terms of name or usergroup id. Either host name or id on which the local user is to be created must be provided. Description, minimum password age, maximum password age are also allowed. All other fields are ignored. If both id and name are specified, then id takes precedence.
> Output Name | Range | Type | Description
> host-user-id |  | access-object-id | Identifier of the new user created on the host.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDUSERNAME |  |
> EINVALIDDESCRIPTION |  |
> EINVALIDUSERFULLNAME |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> EDUPLICATEUSER |  |
> EUSERGROUPNOTFOUND |  |
> EHOSTOSVERSIONNOTSUPPORTED |  |
> EPASSWORDAGENOTSUPPORTED |  |
> EINVALIDPASSWORDAGE |  |

host-user-delete | [top]

> Deletes a local user on the host.

> Input Name | Range | Type | Description
> host-user-name-or-id |  | access-object-name-or-id | Name or id of the local user on the host.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> ENOTFOUNDUSER |  |
> EUSERAMBIGUOUS |  |

host-user-list-iter-end | [top]

> Terminates a view list iteration and clean up any saved info.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous host-user-list-iter-start call.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

host-user-list-iter-next | [top]

> Returns items from a previous call to host-user-list-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..2^31-1]
> tag |  | string | Tag from a previous host-user-list-iter- call.
> Output Name | Range | Type | Description
> host-users |  | host-user-info[] | List of local users on the host.
> records |  | integer | The number of records actually returned. Range: [1..2^31-1]

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

host-user-list-iter-start | [top]

> Initiates a query for a list of local users on host(s). Local users on host(s) that matches all filters will be returned. If no input is specified, all the local users on all monitored storage systems or vFiler units will be returned.

> Input Name | Range | Type | Description
> host-user-name-or-id |  | access-object-name-or-id optional | Name or id of a local user.
> host-usergroup-name-or-id |  | usergroup-name-or-id optional | Name of id of the user group. If specified only the users belonging to this group will be listed.
> object-name-or-id |  | obj-name-or-id optional | Name or id of an object to list the local users for. The allowed object types for this argument are: Resource Group Host (allowed host types are storage system and vFiler unit)
> verbose |  | boolean optional | Default is false. If set to true, then the usergroups, roles, and allowed capabilities are placed into the host-user-info element.
> Output Name | Range | Type | Description
> records |  | integer | Number indicating how many items are available for future retrieval with host-user-list-iter-next. Range: [1..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to host-user-list-iter-next or host-user-list-iter-end.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTNOTFOUND |  |
> ENOTFOUNDUSER |  |
> EUSERGROUPNOTFOUND |  |

host-user-modify | [top]

> Modifies local user on the host.

> Input Name | Range | Type | Description
> host-user |  | host-user-info | Local user name or id must be provided. Host name or id is an optional parameter. If one or more usergroups(ids or names), description, minimum password age, and/or maximum password age are provided, the local user is modified accordingly. All other fields are ignored. If both id and name are specified, then id takes precedence.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDDESCRIPTION |  |
> EINVALIDUSERFULLNAME |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> ENOTFOUNDUSER |  |
> EUSERAMBIGUOUS |  |
> EUSERGROUPNOTFOUND |  |
> EPASSWORDAGENOTSUPPORTED |  |
> EINVALIDPASSWORDAGE |  |

host-user-modify-password | [top]

> Modifies password of a local user on the host.

> Input Name | Range | Type | Description
> host-name-or-id |  | obj-name-or-id optional | Name or id of Storage System/vFiler unit on which the local user exists.
> host-user-name-or-id |  | access-object-name-or-id | Name or id of the local user. For storage systems running Data ONTAP version 7.0 or later, the user should have been discovered by DFM and thus host user id can be specified instead of host user name.
> new-password |  | host-user-password | New password of the local user.
> old-password |  | host-user-password optional | Old password of the local user. If this element is provided, we run the password command or ZAPI using the credentials provided in the ZAPI input elements.

> Errno | Description
> EINTERNALERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> ENOTFOUNDUSER |  |
> EUSERAMBIGUOUS |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> EAPIERROR |  |

host-user-push | [top]

> Input Name | Range | Type | Description
> host-name-or-id |  | obj-name-or-id | Name or id of the host to push the user on. Only storage systems and vFiler units are allowed.
> host-user-name-or-id |  | access-object-name-or-id | Name or id of the local user on the host.
> password |  | host-user-password optional | Password of the new user on the host, to which the user is pushed on. If the user already exists on the destination host, this field is ignored.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> ENOTFOUNDUSER |  |
> EUSERAMBIGUOUS |  |
> EUSERGROUPNOTFOUND |  |
> EINCOMPATIBLEUSERGROUP |  |
> EHOSTOSVERSIONNOTSUPPORTED |  |
> EPASSWORDAGENOTSUPPORTED |  |

host-usergroup-create | [top]

> Creates a usergroup on the host. This is applicable for hosts running ONTAP versions 7.0 and above.

> Input Name | Range | Type | Description
> host-usergroup |  | host-usergroup-info | New usergroup information. "host-usergroup-name" and at least one role must be specified. Role can be specified in terms of role name or role id. Either host name or id on which the usergroup is to be created must be provided. Description is also allowed. All other fields are ignored. If both id and name are specified, then id takes precedence.
> Output Name | Range | Type | Description
> host-usergroup-id |  | access-object-id | Identifier of the new usergroup created on the host.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDUSERGROUPNAME |  |
> EINVALIDDESCRIPTION |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> EDUPLICATEUSERGROUP |  |
> ENOTFOUNDROLE |  |
> EHOSTOSVERSIONNOTSUPPORTED |  |

host-usergroup-delete | [top]

> Deletes a usergroup on the host.

> Input Name | Range | Type | Description
> host-usergroup-name-or-id |  | usergroup-name-or-id | Name or id of the usergroup on the host.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EUSERGROUPNOTFOUND |  |
> EUSERGROUPAMBIGUOUS |  |

host-usergroup-list-iter-end | [top]

> Terminates a view list iteration and clean up any saved info.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous host-usergroup-list-iter-start call.

> Errno | Description
> EAPIERROR |  |
> EINVALIDTAG |  |
> EINVALIDINPUT |  |

host-usergroup-list-iter-next | [top]

> Returns items from a previous call to host-usergroup-list-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of entries to retrieve. Range: [1..2^31-1]
> tag |  | string | Tag from a previous host-group-list-iter-start call.
> Output Name | Range | Type | Description
> host-usergroups |  | host-usergroup-info[] | List of usergroups on host(s).
> records |  | integer | The number of records actually returned. Range: [1..2^31-1]

> Errno | Description
> EAPIERROR |  |
> EINVALIDTAG |  |
> EINVALIDINPUT |  |

host-usergroup-list-iter-start | [top]

> Initiates a query for a list of usergroups on host(s). Usergroups on host(s) that match all filters will be returned. If no input is specified, all the usergroups on all monitored storage systems or vFiler units will be returned.

> Input Name | Range | Type | Description
> host-usergroup-name-or-id |  | usergroup-name-or-id optional | Name or id of a usergroup.
> object-name-or-id |  | obj-name-or-id optional | Name or id of an object to list the usergroups for. The allowed object types for this argument are: Resource Group Host (allowed host types are storage system and vFiler unit)
> verbose |  | boolean optional | Default is false. If set to true, then the roles and allowed capabilities are placed into the host-usergroup-info element.
> Output Name | Range | Type | Description
> records |  | integer | Number indicating how many items are available for future retrieval with host-group-list-iter-next. Range: [1..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to host-usergroup-list-iter-next or host-usergroup-list-iter-end.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EOBJECTNOTFOUND |  |
> EBADOBJECTTYPE |  |
> EUSERGROUPNOTFOUND |  |

host-usergroup-modify | [top]

> Modifies a usergroup on the host.

> Input Name | Range | Type | Description
> host-usergroup |  | host-usergroup-info | Usergroup name or id must be provided. Host name or id is an optional parameter. If one or more roles(ids or names) and/or description is provided, existing roles and/or description are removed and updated with new ones. All other fields are ignored. If both id and name are specified, then id takes precedence.
> new-usergroup-name |  | usergroup-name optional | New usergroup name for this usergroup. This is used to rename the usergroup specified in host-usergroup. If this value is invalid, host-usergroup-modify fails without changing anything. The value is optional, and if not provided, the group name will be unchanged.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EINVALIDUSERGROUPNAME |  |
> EINVALIDDESCRIPTION |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> EUSERGROUPNOTFOUND |  |
> EUSERGROUPAMBIGUOUS |  |
> ENOTFOUNDROLE |  |
> EDUPLICATEUSERGROUP |  |

host-usergroup-push | [top]

> Pushes a usergroup to a host. This is applicable for hosts running ONTAP versions 7.0 and above. The operation succeeds when the host on which the usergroup is to be pushed contains roles similar to that of the usergroup. Two roles are similar if they have the same name and same set of capabilities.

> Input Name | Range | Type | Description
> host-name-or-id |  | obj-name-or-id | Name or id of the host to push the usergroup on. Only storage systems and vFiler units are allowed.
> host-usergroup-name-or-id |  | usergroup-name-or-id | Name or id of the usergroup to be pushed on the host.

> Errno | Description
> EAPIERROR |  |
> EINVALIDINPUT |  |
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EHOSTNOTFOUND |  |
> EBADHOSTTYPE |  |
> EUSERGROUPNOTFOUND |  |
> EUSERGROUPAMBIGUOUS |  |
> ENOTFOUNDROLE |  |
> EINCOMPATIBLEROLE |  |
> EHOSTOSVERSIONNOTSUPPORTED |  |

Element definition: access-object-id | [top]

> Identification number (ID) for an access object. An access object can be a role, usergroup, local user or a domain user. The ID for an access object is always assigned by the DFM system. This typedef is an alias for the built-in type integer. Access object IDs are unsigned integers in the range [1..2^31-1].

> [none]

Element definition: access-object-name-or-id | [top]

> Name or id of an access object. An access object can be a role, usergroup, local user, or a domain user. This must conform to the format of either access-object-name or access-object-id.

> [none]

Element definition: capability | [top]

> Name of a capability on the host. This must conform to one of the following formats: "*" "login-*" "security-*" "cli-*" "api-*" Here, instead of *, commands and sub-commands can be specified directly. Maximum Length: 64 characters

> [none]

Element definition: domainuser-name-or-id-or-sid | [top]

> Name or id or the SID of domain user. This must conform to one of the following: domainuser-name sid access-cotrol-id

> [none]

Element definition: full-ndmp-credentials | [top]

> A full set of ndmp credentials with no empty fields which is a specific requirement for this zapi since ndmp-username and ndmp-password are both required in order to add an ossv host.

> Name | Range | Type | Description
> ndmp-password |  | host-password | Password name for logging into the host. Encrypted using 2-way encryption.
> ndmp-port |  | ip-port-number optional | Port to connect on.
> ndmp-username |  | ndmp-username | User name for logging into the host.

Element definition: host-defaults | [top]

> The default values for the attributes defined by the host.

> Name | Range | Type | Description
> admin-port-agent |  | ip-port-number | The agent's default administrative port for executing ONTAP APIs. Valid only for Host Agents.
> admin-port-cache-http |  | ip-port-number | The host's default HTTP administrative port for executing ONTAP APIs. Valid only for NetCache appliances.
> admin-port-cache-https |  | ip-port-number | The host's default HTTPS administrative port for executing ONTAP APIs. Valid only for NetCache appliances.
> admin-port-host |  | ip-port-number | The host's default administrative port for executing ONTAP APIs. Valid only for storage systems.
> admin-port-host-http |  | ip-port-number | The host's default HTTP administrative port for executing ONTAP APIs. Valid only for storage systems.
> admin-port-host-https |  | ip-port-number | The host's default HTTPS administrative port for executing ONTAP APIs. Valid only for storage systems.
> admin-transport-agent |  | string | The default value for the transport used for communicating to the Agent. Possible values: are "http", "https"
> admin-transport-cache |  | string | The default value for the transport used for communicating to the cache. Possible values: "http", "https"
> admin-transport-host |  | string | The default value for the transport used for communicating to the host. Possible values: "http", "https"
> ndmp-port |  | ip-port-number | Default value for NDMP port. Valid only for storage systems and OSSV agents.
> perf-advisor-transport-host |  | string | The default value for the transport setting for communicating to the host for collecting performance data. Valid only for storage systems. Possible values: "http_only", "https_ok"
> snapvault-max-backup-threads |  | integer | Default maximum number of threads the DFM can use to coordinate in parallel the backup transfers for different backup relationships to the same secondary volume. This field is applicable only to storage systems that are SnapVault Secondary hosts. Range: [1..144]
> timeout |  | integer | Default value of timeout we use in zapis that accept timeout arguments. Time is in seconds. Range: [1..100]
> use-hosts-equiv |  | boolean | The setting for communicating to the host using hosts.equiv authentication. Valid only for storage systems and vFiler units.

Element definition: host-domainuser-info | [top]

> Describes the contents of a domain user on the host. The host can be a Storage System or a vFiler unit. Output will always contain all the elements present in the type definition.

> Name | Range | Type | Description
> SID |  | sid optional | SID of the domain user on the host.
> capabilities |  | capability[] optional | List of capabilities of the domain user inherited from the usergroup(s) in which user is member of.
> host-domainuser-id |  | access-object-id | Internal id of domain user on the host.
> host-domainuser-name |  | domainuser-name | Name of the domain user on the host.
> host-id |  | obj-id | Id of the host on which the domain user is present.
> host-name |  | obj-name | Name of the host on which the domain user is present.
> host-role-ids |  | host-role-id[] optional | List of ids of roles contained by usergroup(s) in which the domain user is member of.
> host-role-names |  | host-role-name[] optional | List of names of roles contained by usergroup(s) in which the domain user is member of.
> host-usergroup-ids |  | host-usergroup-id[] optional | List of ids of usergroups in which the domain user is member of.
> host-usergroup-names |  | host-usergroup-name[] optional | List of usergroup names in which the domain user is member of.

Element definition: host-dp-filter-info | [top]

> Data Protection specific information for this iterator. Default is false.

> Name | Range | Type | Description
> is-dp-ignored |  | boolean optional | If true, only list aggregates that have been set to be ignored for purposes of data protection. If false, only list aggregates that have not been set to be ignored for purposes of data protection. If not specified, list all aggregates without taking into account whether they have been ignored or not.
> is-in-dataset |  | boolean optional | If true, only hosts in a dataset are listed Default is false.
> is-in-resourcepool |  | boolean optional | If true, only hosts in a resource pool are listed Default is false.
> is-snapmirrored-only |  | boolean optional | If true, only SnapMirror hosts are listed. Host could be either a source or a destination for SnapMirror. Default is false.
> is-snapvault-primary-only |  | boolean optional | If true, only SnapVault primary systems are listed. Default is false.
> is-snapvault-secondary-only |  | boolean optional | If true, only SnapVault secondary systems are listed. Default is false.

Element definition: host-id | [top]

> DFM host identifier. Range: [1..2^31-1]

> [none]

Element definition: host-info | [top]

> Host's information.

> Name | Range | Type | Description
> admin-port |  | ip-port-number | The host's administrative port for executing Manage OnTap APIs. Valid only for Storage Systems, NetCache appliances, and Host Agents. If this element is present and empty, the global default value is used. Use host-get-defaults to determine the global default value.
> admin-transport |  | string | The transport used for communicating to the host. Possible values: "http", "https". If this element is present and empty, the global default value is used. Use host-get-defaults to determine the global default value.
> cifs-domain-info |  | cifs-domain-info optional | CIFS domain informaiton of storage systems or vFiler unit.
> host-address |  | string | The host's primary IP address.
> host-communication-status |  | string optional | Whether we are able to establish a connection to validate the host credentials. Valid only for storage systems and Host Agents. Possible values: "unknown", "up", or "down".
> host-credentials-status |  | string optional | The current status of the Storage System or Host Agent credentials. Possible values: "not_applicable", "unknown", "bad", "good", "read_only" (Storage System will never have a status of "read_only"). This value reflects whether the credentials were validated or invalidated by the Storage System or Host Agent. "unknown" means that the DFM has not been able to test the credentials (username/password) against the Storage System or Host Agent. The value of this element will not change if we are unable to communicate with the host. The DFM can access the Host Agent if host-credentials-status is "good" or "read_only" and host-communication-status is "up". If the Host Agent credentials are guest credentials, and have been validated by the Host Agent, the value will be "read_only". The value "not_applicable" applies to hosts (vFiler units only for now) where login credential status is not meaningful to the DFM.
> host-description |  | string | User-specified description of host. Length: [0..255]
> host-dp-info |  | host-dp-info optional | Data Protection specific information for this host.
> host-fqdn |  | string optional | The fully qualified domain name of the host. Length: [1..255]
> host-id |  | host-id | This is the DFM id of the host.
> host-model |  | string | Model name or "unknown". Length: [1..255]
> host-name |  | string | This is the DFM name of the host. Length: [1..255]
> host-obj-status |  | obj-status optional | Current status of the host based on all events
> host-os |  | string | This is the OS version for the host. On OSSV Agents this is the Windows OS (Windows 2000, etc.) On all other hosts this is the software release Length: [1..16]
> host-perf-info |  | host-perf-info optional | Current status of the host based on all events ndmp-credentials-status will not be updated if ndmp-communication-status is bad because the DFM is not able to connect to the ndmp agent on the storage system or OSSV agent to validate the credentials.
> host-status |  | string optional | The current status of the host. This element displays the status of the host os, which is ONTAP in the case of storage systems, and is Windows, Linux etc. in the case of Host Agents or OSSV agents. Possible values: "unknown", "up", or "down".
> host-type |  | host-type | Type of the host.
> host-username |  | string | This is the administrator username for a requested host. Length: [1..64]
> host-version |  | string | This is the software release for a requested host. Length: [1..255]
> is-available |  | boolean optional | Tells whether or not this host is up. For OSSV clients, if valid login credentials are not set, the is-available state will be false.
> licenses |  | license[] | List of licenses installed on the storage system. This will be returned only if the host-type is "filer".
> ndmp-agent-status |  | string optional | The current status of NDMP. Possible values: "unknown", "up", or "down". Valid only for storage systems and OSSV agents. This status is more than the combined result of ndmp-communication-status and ndmp-credentials-status, since a value of "up" indicates the DFM monitor was successful in fully establishing the connection to the point that useful messages can be sent (this requires steps beyond exchanging credentials). If the value is "down" you need to look at ndmp-communication-status or ndmp-credentials-status. If those status values do not indicate problems, the problem may be occurring after credentials have been exchanged.
> ndmp-communication-status |  | string optional | Whether we are able to establish a connection to validate the NDMP credentials. Valid only for storage systems and OSSV agents. Possible values: "unknown", "up", or "down".
> ndmp-communication-timestamp |  | integer optional | Date of the last attempt to establish a connection to validate the NDMP credentials. Valid only for storage systems and OSSV agents. The timestamp value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.
> ndmp-credentials |  | ndmp-credentials optional | NDMP credentials for the host. Valid only for storage systems and OSSV agents. The ndmp password will always be empty for security reasons.
> ndmp-credentials-status |  | string optional | The current status of the NDMP credentials. Valid only for storage systems and OSSV agents. Possible values: "not_applicable", "unknown", "good", or "bad". The value "not_applicable" applies to hosts (vFiler units only for now) where ndmp credential status is not meaningful.
> ndmp-timestamp |  | integer optional | Date of the last successful connection (i.e. the last time ndmp-agent-status was "up"). Valid only for storage systems and OSSV agents. The timestamp value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.
> other-host-id |  | host-id optional | A Host Agent and an OSSV Agent on the same machine will have different IDs. If this host is an OSSV Agent and DFM knows about a Host Agent on the same machine, or if this host is an Host Agent and DFM knows about a OSSV Agent on the same machine, this value is the ID of the other host.
> partner-storage-system-id |  | obj-id optional | Identifier of the partner storage system. This element is present only for storage systems in an Active/Active configuration.
> partner-storage-system-name |  | obj-full-name optional | Full name of the partner storage system. This element is present only for storage systems in an Active/Active configuration.
> perf-advisor-transport |  | perf-advisor-transport optional | The transport setting for communicating to the host for collecting performance data. Valid only for storage systems. If this element is present and empty, the global default value is used. Use host-get-defaults to determine the global default value.
> service-statuses |  | service-status[] | List of services and their statuses. This element will be present only for a storage system or a vFiler unit.
> use-hosts-equiv |  | boolean optional | The setting for communicating to the host using hosts.equiv authentication. Valid only for storage systems and vFiler units. If this element is present and empty, the global default value is used. Use host-get-defaults to determine the global default value.
> vfiler-info |  | vfiler-info optional | Information about a vFiler unit. This element is present only when host-type is "vfiler".

Element definition: host-modify-info | [top]

> Host information.

> Name | Range | Type | Description
> admin-port |  | ip-port-number optional | The host's administrative port for executing APIs. Valid only for Host Agents or NetCache appliances. If the Host Agent is operating under UNIX, the port range is restricted to [1025..2^16-1]
> host-address |  | string optional | Primary IP address for the host. If not present, the current setting is not modified. Length: [0..39]
> host-description |  | string optional | User-specified description of host. If not present, the current setting is not modified. Length: [0..255]
> host-dp-modify-info |  | host-dp-modify-info optional | Data protection specific host information. If not present, the current settings are not modified.
> host-name |  | obj-name optional | New name for the host. This name cannot be set to the empty string. If not present, the current setting is not modified.
> host-password |  | host-password optional | Password for logging into the host.
> host-username |  | string optional | User name for logging into the host. If not present, the current setting is not modified. Length: [0..64]
> ndmp-credentials |  | ndmp-credentials optional | NDMP credentials for the host. Valid only for storage systems and OSSV agents. If not present, the current settings are not modified.
> perf-advisor-transport |  | perf-advisor-transport optional | The transport setting for communicating to the host for collecting performance data. Valid only for storage systems.
> use-hosts-equiv |  | boolean optional | The setting for communicating to the host using hosts.equiv authentication. Valid only for storage systems and vFiler units. If the element is present and empty, the default value set in the global options will be used. If not present, the current setting is not modified.

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

> DFM host. A host can be a storage system, a vFiler unit, a switch, a netcache or an agent. Value can be a DFM object name (maximum 255 characters), a fully qualified domain name (FQDN)(maximum 255 characters), the ip address, or the DFM id [1..2^31-1].

> [none]

Element definition: host-password | [top]

> Password for logging in. Encrypted using 2-way encryption. Length: [0..64]

> [none]

Element definition: host-role-info | [top]

> Describes the contents of a role on the host. The host can be a storage system or a vFiler unit. Output will always contain all the elements present in the type definition.

> Name | Range | Type | Description
> capabilities |  | capability[] optional | List of capabilities the role is allowed.
> description |  | access-object-description optional | Description of the role.
> host-id |  | obj-id optional | Id of the host on which the role is present.
> host-name |  | obj-name optional | Name of the host on which the role is present.
> host-role-id |  | access-object-id optional | Internal id of the role on the host.
> host-role-name |  | access-object-name optional | Name of the role on the host.

Element definition: host-type | [top]

> Type of host. Possible values are: filer, vfiler, cache, agent, ossv, and switch.

> [none]

Element definition: host-user-info | [top]

> Describes the contents of a local user on the host. The host type can be a Storage System or a vFiler unit. Minimum password age, Maximum password age, and status are applicable for hosts running ONTAP versions 7.1 and above. Apart from these fields, output will always contain all the elements present in the type definition.

> Name | Range | Type | Description
> capabilities |  | capability[] optional | List of capabilities of the local user inherited from the usergroup(s) in which user is member of.
> description |  | access-object-description optional | Description of the local user.
> full-name |  | string optional | Full name of the local user. It should not contain colon(:). Maximum Length:256 characters
> host-id |  | obj-id optional | Id of the host on which the local user is present.
> host-name |  | obj-name optional | Name of the host on which the local user is present.
> host-role-ids |  | host-role-id[] optional | List of ids of roles contained by usergroup(s) in which the local user is member of.
> host-role-names |  | host-role-name[] optional | List of names of roles contained by usergroup(s) in which the local user is member of.
> host-user-id |  | access-object-id optional | Internal id of local user on the host.
> host-user-name |  | access-object-name optional | Name of the local user on the host.
> host-usergroup-ids |  | host-usergroup-id[] optional | List of ids of usergroups in which the local user is member of.
> host-usergroup-names |  | host-usergroup-name[] optional | List of usergroup names on which the user is member of.
> maximum-password-age |  | integer optional | Maximum age of the password(in days) before it has to be changed. Range: [0..2^32-1] Default Value: (2^32-1) days
> minimum-password-age |  | integer optional | Minimum age of the password(in days) before it can be changed. Range: [0..2^32-1] Default Value: 0
> password |  | host-user-password optional | Password of the local user.
> status |  | string optional | Status of the local user on the host. This element cannot be used as an input. Possible values: "enabled" "disabled" "expired"

Element definition: host-user-password | [top]

> Password of the local user on the host. Encrypted using standard 2-way encryption. This must conform to the rules found in options "security.passwd.rules". By default, the password can contain 8 to 256 characters.

> [none]

Element definition: host-usergroup-info | [top]

> Describes the contents of a usergroup on the host. The host can be a storage system or a vFiler. Output will always contain all the elements present in the type definition.

> Name | Range | Type | Description
> capabilities |  | capability[] optional | List of capabilities the usergroup has inherited from the member roles.
> description |  | string optional | Description of the usergroup on the host. Maximum Length: 128 characters
> host-id |  | obj-id optional | Id of the host on which the usergroup is present.
> host-name |  | obj-name optional | Name of the host on which the usergroup is present.
> host-role-ids |  | host-role-id[] optional | List of ids of roles the usergroup contains.
> host-role-names |  | host-role-name[] optional | List of role names the usergroup contains.
> host-usergroup-id |  | access-object-id optional | Internal id of the usergroup on the host.
> host-usergroup-name |  | usergroup-name optional | Name of the usergroup on the host.

Element definition: host-usergroup-name-or-id | [top]

> Name or id of usergroup. This must conform to the format of either usergroup-name or access-object-id.

> [none]

Element definition: license | [top]

> Name of the licensed Data ONTAP service. Possible values: "nfs", "cifs", "iscsi", "fcp", "multistore", "a_sis", "snapmirror_sync".

> [none]

Element definition: ndmp-username | [top]

> Name of NDMP user. Length: [1..32]

> [none]

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]. 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: usergroup-name | [top]

> Name of a usergroup on storage system or vFiler unit. Usergroup name can contain between 1 and 256 characters and include any alphanumeric character, a space, or a punctuation character that is not one of: " * + , / : ; < = > ? [ ] |

> [none]

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

> Name or id of usergroup on storage system or vFiler unit. This must conform to the format of either usergroup-name or access-object-id.

> [none]

Element definition: vfiler-ipspace | [top]

> Ipspace of vFiler unit.

> [none]

Element definition: access-object-description | [top]

> Description of an access object. An access object can be a role, usergroup, local user, or a domain user. Description of an access object can include any alphanumeric character, a space, or a punctuation character other than :(colon). Maximum Length: 128 characters

> [none]

Element definition: access-object-id | [top]

> Identification number (ID) for an access object. An access object can be a role, usergroup, local user or a domain user. The ID for an access object is always assigned by the DFM system. This typedef is an alias for the built-in type integer. Access object IDs are unsigned integers in the range [1..2^31-1].

> [none]

Element definition: access-object-name | [top]

> Name of an access object. An access object can be a role, usergroup, local user, or a domain user. The rules defined here are not applicable for domain users and usergroups. An access object can contain between 1 and 32 characters and include any alphanumeric character, a space, or a punctuation character that is not one of: " * + , / : ; < = > ? [ ] |

> [none]

Element definition: capability | [top]

> Name of a capability on the host. This must conform to one of the following formats: "*" "login-*" "security-*" "cli-*" "api-*" Here, instead of *, commands and sub-commands can be specified directly. Maximum Length: 64 characters

> [none]

Element definition: cifs-domain-info | [top]

> Details of the cifs domain.

> Name | Range | Type | Description
> cifs-dns-domain-name |  | string | Specifies the CIFS DNS domain name. Maximum length: 255 characters.
> cifs-domain-id |  | integer | Identifier of the cifs domain. Range: [1..(2^16)-1]
> cifs-domain-name |  | string | Specifies the NETBIOS name of the cifs domain. Maximum length: 255 characters.

Element definition: domainuser-name | [top]

> Name of the user in domain\username format. (Ex:NETAPP\rohan) Maximum Length: 288 characters (Domain name can contain up to 255 characters, and username can contain up to 32 characters)

> [none]

Element definition: host-dp-info | [top]

> Data Protection specific information for this iterator.

> Name | Range | Type | Description
> datasets |  | dataset-reference[] | List of datasets the host is a member of. If is-in-dataset is false, this list will be empty.
> host-dataset |  | obj-name optional | Name of the dataset the host is a member of. This element will not be present if the host is not a member of a dataset. This field is deprecated in favor of datasets, which lists all datasets the host belongs to. It is still populated with one of the dataset ids.
> host-resourcepool |  | obj-name optional | Name of the resource pool the host is a member of. This element will not be present if the host is not a member of a resource pool.
> is-agent-ossv-enabled |  | boolean optional | Indicates if the ossv service has been enabled. Valid only for Host Agents.
> is-dp-ignored |  | boolean | Indicates if an administrator has chosen to ignore this host for purposes of data protection.
> is-in-dataset |  | boolean | Indicates if this host is a member of any dataset.
> is-linux-primary |  | boolean optional | Indicates if host is being managed as having a Linux primary license. Default value is "false".
> is-ndmp-enabled |  | boolean optional | True if an administrator has chosen to enable ndmp on this host.
> is-nearstore |  | boolean optional | Indicates if host is being managed as having a Nearstore license. Default value is "false".
> is-snapmirror-enabled |  | boolean optional | True if an administrator has chosen to enable snapmirror on this host.
> is-snapmirror-host |  | boolean optional | Indicates if host is being managed as a SnapMirror host. Default value is "false".
> is-snapvault-enabled |  | boolean optional | True if an administrator has chosen to enable snapvault on this host.
> is-snapvault-primary |  | boolean | Indicates if host is being managed as a SnapVault primary system.
> is-snapvault-secondary |  | boolean | Indicates if host is being managed as a SnapVault secondary system.
> is-unix-primary |  | boolean optional | Indicates if host is being managed as having a Unix primary license. Default value is "false".
> is-windows-ofm-primary |  | boolean optional | Indicates if host is being managed as having a Windows Open File Manager (OFM) primary license. Default value is "false".
> is-windows-primary |  | boolean optional | Indicates if host is being managed as having a Windows primary license. Default value is "false".
> ndmp-access-specifier |  | string optional | This is the access expression ndmp uses to determine who has access. Valid only for storage systems. See na_protocolaccess(8) for access specifier syntax and usage. Examples of valid values include "all", or "host=abc,xyz AND if=e0". See na_protocolaccess(8) for access specifier syntax and usage. Length: [0..255]
> snapmirror-access-specifier |  | string | This is the access expression snapmirror uses to determine who has access. Valid only for storage systems. Examples of valid values include "all", or "host=abc,xyz AND if=e0". See na_protocolaccess(8) for access specifier syntax and usage. Length: [0..255]
> snapvault-access-specifier |  | string | This is the access expression snapvault uses to determine who has access. Valid only for storage systems. Examples of valid values include "all", or "host=abc,xyz AND if=e0". See na_protocolaccess(8) for access specifier syntax and usage. Length: [0..255]
> snapvault-max-backup-threads |  | integer optional | Maximum number of threads the DFM can use to coordinate in parallel the backup transfers for different backup relationships to the same secondary volume. If this element is present and empty, the global default value is used. This field is applicable only to SnapVault Secondary hosts. Use host-get-defaults to determine the global default value. Range: [1..144]

Element definition: host-dp-modify-info | [top]

> Data protection specific host information.

> Name | Range | Type | Description
> is-dp-ignored |  | boolean optional | True if an administrator has chosen to ignore this host for purposes of data protection. The default value is false. If not present, the current setting is not modified.
> snapvault-max-backup-threads |  | integer optional | Maximum number of threads DFM can use to coordinate in parallel the backup transfers for different backup relationships to the same secondary volume. This field is applicable only to SnapVault Secondary hosts. If the element is present and empty or the value is 0, the default value set in the global options will be used. If not present, the current setting is not modified. Range: [0..144]

Element definition: host-id | [top]

> DFM host identifier. Range: [1..2^31-1]

> [none]

Element definition: host-perf-info | [top]

> Performance specific information for this iterator

> Name | Range | Type | Description
> data-unavailable-reason |  | perf-status-error[] optional | This element is included only if is-data-available is set to false and indicates the reason(s) for failure.
> host-perf-status |  | obj-status optional | Current status of the host based on performance events
> is-data-available |  | boolean | Returns if the performance data can be collected for this host This will be present only for storage systems and vFiler units.

Element definition: host-role-id | [top]

> Id of the role on the host. The ID for a host role is always assigned by the DFM system. Range: [1..2^31-1].

> [none]

Element definition: host-role-name | [top]

> Name of the role on the host. A host role name contains between 1 and 32 characters and can include any alphanumeric character, a space, or a punctuation character that is not one of: " * + , / : ; < = > ? [ ] |

> [none]

Element definition: host-usergroup-id | [top]

> Id of the usergroup on the host The ID for a host usergroup is always assigned by the DFM system. Range: [1..2^31-1].

> [none]

Element definition: host-usergroup-name | [top]

> Name of the usergroup on the host. A host usergroup name contains between 1 and 32 characters and can include any alphanumeric character, a space, or a punctuation character that is not one of: " * + , / : ; < = > ? [ ] |

> [none]

Element definition: ip-port-number | [top]

> IP port number. Range: [0..2^16-1]

> [none]

Element definition: ndmp-credentials | [top]

> NDMP credentials for a host or a network. Valid only for storage systems and OSSV agents.

> Name | Range | Type | Description
> ndmp-password |  | host-password optional | NDMP password.
> ndmp-port |  | ip-port-number optional | NDMP port. Valid only for storage systems and OSSV agents. If not present, the current setting is not modified.
> ndmp-username |  | ndmp-username optional | NDMP user name. Valid only for storage systems and OSSV agents. If not present, the current setting is not modified.

Element definition: ndmp-username | [top]

> Name of NDMP user. Length: [1..32]

> [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]

Element definition: obj-status | [top]

> A status value which can be associated with a DFM object. This typedef is an alias for the builtin ZAPI type string. The severity associated with an event has this type. Possible values are: 'unknown', 'normal', 'information', 'unmanaged' 'warning', 'error', 'critical', 'emergency'. unknown: An object has an unknown status when it transitions from one state to another. Ideally, an object will have this status briefly. For example, when an object has been added, but not yet discovered. normal: An object has normal status when it is working within the thresholds specified in DFM. information: The information events are normal occurrences on an object for which you can define alarms. unmanaged: An object is considered to be unmanaged when the login and password are not set for the appliance or agent. warning: An object has the warning status when an event related to the object occurred that an administrator should know about. The event will not cause service disruption. error: An object has error status when it does not cause any service disruption, but it may affect performance. critical: An object has critical status when it is still performing, but service disruption may occur if corrective action is not taken immediately. emergency: An object is in emergency status when it stops performing unexpectedly and could lose data. In some contexts, it is important that severities are ordered (as above). For example, an alarm might be triggered if an event with a given severity "or worse" occurs. In this example, worse means "after" in the list above.

> [none]

Element definition: perf-advisor-transport | [top]

> The transport setting for communicating to the host for collecting performance data. Data collection is disabled when this option is set to Disabled. Possible values: "http_only", "https_ok", "disabled"

> [none]

Element definition: service-status | [top]

> Status indicating whether a service is up or down.

> Name | Range | Type | Description
> service |  | string optional | Name of the service. Possible values: "nfs", "cifs", "iscsi" or "fcp". statusIndicates whether the service is up or not. Possible values: "up", "down".

Element definition: sid | [top]

> SID (Security Identifier) describing a user. Length: [5..128] characters Format: S-1-5-21-int-int-int-rid RID is a unique random integer generated by storage system/vFiler unit.

> [none]

Element definition: vfiler-info | [top]

> information of a vFiler unit. Avaiblable only if host-type is "vfiler".

> Name | Range | Type | Description
> hosting-filer-id |  | obj-id optional | Identifier of the hosting filer of the vFiler unit.
> hosting-filer-name |  | obj-full-name optional | DNS name of the hosting filer of the vFiler unit.
> vfiler-allowed-protocols |  | protocol[] optional | List of allowed protocols on the vFiler unit.
> vfiler-ipspace |  | string optional | IPSpace of the vFiler unit.
> vfiler-migration-info |  | vfiler-migration-info | Migration information for the vFiler unit. This will be returned only if the vFiler is in migrating state and if include-migration-info is true in host-list-info-iter-start.
> vfiler-network-resources |  | vfiler-network-resource[] | Network interface information of a vFiler unit.

Element definition: dataset-reference | [top]

> The name and id of a dataset.

> Name | Range | Type | Description
> dataset-id |  | obj-id | Identifier for the dataset. Range: [1..2^31-1]
> dataset-name |  | obj-name | Name of the dataset.

Element definition: host-password | [top]

> Password for logging in. Encrypted using 2-way encryption. Length: [0..64]

> [none]

Element definition: ip-port-number | [top]

> IP port number. Range: [0..2^16-1]

> [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]

Element definition: perf-status-error | [top]

> Possible resons for data unavailability.

> Name | Range | Type | Description
> error |  | string | The following are the possible reasons: 1) "perf-advisor-not-enabled" This indicates that the performance advisor is not enabled on DFM. 2) "host-bad-credentials" This indicates that the authetication credentials for the host are incorrect. 3) "host-no-credentials" This indicated that the host login is empty. 4) "host-not-reachable" This indicates that the host is down and hence not reachable. 5) "host-transport-incorrect" This indicates that the host transport is in compatible with the performance advisor transport. 6) "filer-os-version-less-than-6.5" This indicates that the storage system is running OS with a release version less than 6.5. 7) "filer-data-unavailable" This indicates that DFM has not discovered instances of performance objects on the storage system yet.

Element definition: protocol | [top]

> Name of the protocol. Possible values: "nfs", "cifs", "iscsi".

> [none]

Element definition: vfiler-migration-info | [top]

> Migration information for a vFiler unit.

> Name | Range | Type | Description
> destination-filer-name |  | obj-full-name | Full name of the destination storage system
> destination-vfiler-id |  | obj-id | Database ID of the destination vFiler unit
> destination-vfiler-name |  | obj-full-name | Full name of the destination vFiler Unit
> migration-status |  | migration-status | Migration status of the vFiler unit
> source-filer-id |  | obj-id | Database ID of the source storage system
> source-filer-name |  | obj-full-name | Full name of the source storage system
> source-vfiler-id |  | obj-id | Database ID of the source vFiler unit
> source-vfiler-name |  | obj-full-name | Full name of the source vFiler Unit

Element definition: vfiler-network-resource | [top]

> Information about one vFiler unit IP address

> Name | Range | Type | Description
> interface-id |  | obj-id optional | Interface identifier to which the IP address is bound. Present only if the IP address is bound to an interface
> interface-name |  | obj-name optional | Interface name to which the IP address is bound. Present only if the IP address is bound to an interface
> ip-address |  | ip-address | IP Address assigned to the vFiler
> prefix-length |  | integer optional | Prefix length for an IP Address bound to an interface. If the ip-address is unconfigured, this field will not be returned. Range: [1..127]

Element definition: ip-address | [top]

> IP address in string format. The length of this string cannot be more than 40 characters.

> [none]

Element definition: migration-status | [top]

> Migration status for an ongoing vFiler unit migration. Possible values: "in_progress", "migrating", "migrated", "migrated_with_errors", "migrate_failed".

> [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]