|
APIs in Category: Host |
API version 5.0 |
| HostAdd (supported) | [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 a storage system or NetCache or FC Switch, we add it To the database and set the ApplianceId. If it's a Host agent, we add the agent To the database and set the AgentId. On return, only one of the ApplianceId or AgentId will be set.
Input Name Type HostAdd HostAdd
Output Name Type HostAddResult HostAddResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EHOSTADDDUPPRODID EHOSTADDNOCONTACT EHOSTADDNOLICENSE EHOSTADDNONODES EHOSTADDNOTRESOLVED EHOSTADDTAKENOVER EHOSTADDVFILERPARENTDELETED EHOSTEXISTS EHOSTRUNMONFAILED EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| HostAddLicense (supported) | [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: 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 SuppressInuseError 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.
- 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)
Input Name Type HostAddLicense HostAddLicense
Output Name Type HostAddLicenseResult HostAddLicenseResult
Error Name Description EAPIERROR EBADHOSTTYPE EHOSTACCESSDENIED EHOSTCOMMUNICATION EHOSTDOESNOTEXIST EINVALIDLICENSE ELICENSEINUSE
| HostAddOssv (supported) | [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 OssvId.
Input Name Type HostAddOssv HostAddOssv
Output Name Type HostAddOssvResult HostAddOssvResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EHOSTADDDUPPRODID EHOSTADDMISMATCHPRODID EHOSTADDNOCONTACT EHOSTADDNOLICENSE EHOSTADDNONODES EHOSTADDNOTENABLED EHOSTADDNOTRESOLVED EHOSTBADCONFIG EHOSTEXISTS EHOSTNDMPACCESSFAILED EHOSTNDMPTABLOOKUPFAILED EHOSTRUNMONFAILED EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| HostAgentOssvServiceStart (supported) | [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 Type HostAgentOssvServiceStart HostAgentOssvServiceStart
Output Name Type HostAgentOssvServiceStartResult HostAgentOssvServiceStartResult
Error Name Description EACCESSDENIED EAGENTNOTUPTODATE EAPIERROR EDATABASEERROR EHOSTACCESSDENIED EHOSTBADCONFIG EHOSTCOMMUNICATION EHOSTDOESNOTEXIST EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS ESERVICESTATEUNKNOWN
| HostAgentOssvServiceStop (supported) | [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 Type HostAgentOssvServiceStop HostAgentOssvServiceStop
Output Name Type HostAgentOssvServiceStopResult HostAgentOssvServiceStopResult
Error Name Description EACCESSDENIED EAGENTNOTUPTODATE EAPIERROR EDATABASEERROR EHOSTACCESSDENIED EHOSTBADCONFIG EHOSTCOMMUNICATION EHOSTDOESNOTEXIST EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS ESERVICESTATEUNKNOWN
| HostCapabilityListIterEnd (supported) | [top] |
Terminates a View list iteration and clean up any saved info.
Input Name Type HostCapabilityListIterEnd HostCapabilityListIterEnd
Output Name Type HostCapabilityListIterEndResult HostCapabilityListIterEndResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| HostCapabilityListIterNext (supported) | [top] |
Returns items From a previous call To HostCapabilityListIterStart.
Input Name Type HostCapabilityListIterNext HostCapabilityListIterNext
Output Name Type HostCapabilityListIterNextResult HostCapabilityListIterNextResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| HostCapabilityListIterStart (supported) | [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 Type HostCapabilityListIterStart HostCapabilityListIterStart
Output Name Type HostCapabilityListIterStartResult HostCapabilityListIterStartResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EHOSTNOTFOUND EHOSTOSVERSIONNOTSUPPORTED EINVALIDINPUT
| HostCreateNdmpuser (supported) | [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 Type HostCreateNdmpuser HostCreateNdmpuser
Output Name Type HostCreateNdmpuserResult HostCreateNdmpuserResult
Error Name Description EACCESSDENIED EAPIERROR EAPILICENSE EBADHOSTTYPE EDATABASEERROR EHOSTDOESNOTEXIST EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS
| HostDelete (supported) | [top] |
Deletes a Host. A Host cannot be deleted in the following cases: A successful deletion of a Host will have the following impacts:
- Controllers that belong To a cluster cannot be deleted individually. In this case, ECANNOTDELETECLUSTERNODEHOST will be returned.
- Cannot delete agent if it is in use by ossv or has SRM Paths. In this case, EHOSTINUSE will be returned. The agent can be forcefully deleted, if IgnoreHostInUse is set To true.
- Resource Pools and Resource Groups containing the Host will be updated based on its removal.
- All monitored Objects contained by the Host will be removed.
- Monitoring of the Host will be stopped.
- Datasets resources containing the Host will be removed based on Host removal. This may affect Dataset conformance Status.
- If deleting an agent that is used by ossv, ossv stop/start Capability will be disabled.
- If deleting an agent that is used by SRM Paths, SRM monitoring will be disabled.
Input Name Type HostDelete HostDelete
Output Name Type HostDeleteResult HostDeleteResult
Error Name Description EACCESSDENIED EAPIERROR ECANNOTDELETECLUSTERNODEHOST EDATABASEERROR EHOSTDOESNOTEXIST EHOSTINUSE EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS
| HostDomainuserAdd (supported) | [top] |
Adds a domain user on the Host. This is applicable for Hosts running ONTAP versions 7.0 and above.
Input Name Type HostDomainuserAdd HostDomainuserAdd
Output Name Type HostDomainuserAddResult HostDomainuserAddResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EDOMAINUSERNOTFOUND EDUPLICATEUSERGROUP EHOSTNOTFOUND EHOSTOSVERSIONNOTSUPPORTED EINTERNALERROR EINVALIDDOMAINUSERNAME EINVALIDINPUT EUSERGROUPNOTFOUND
| HostDomainuserListIterEnd (supported) | [top] |
Terminates a View list iteration and clean up any saved info.
Input Name Type HostDomainuserListIterEnd HostDomainuserListIterEnd
Output Name Type HostDomainuserListIterEndResult HostDomainuserListIterEndResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| HostDomainuserListIterNext (supported) | [top] |
Returns items From a previous call To HostDomainuserListIterStart.
Input Name Type HostDomainuserListIterNext HostDomainuserListIterNext
Output Name Type HostDomainuserListIterNextResult HostDomainuserListIterNextResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| HostDomainuserListIterStart (supported) | [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 Type HostDomainuserListIterStart HostDomainuserListIterStart
Output Name Type HostDomainuserListIterStartResult HostDomainuserListIterStartResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EDOMAINUSERNOTFOUND EINTERNALERROR EINVALIDINPUT EOBJECTNOTFOUND EUSERGROUPNOTFOUND
| HostDomainuserPush (supported) | [top] |
Pushes a domain user To a Host. This is applicable for Hosts running ONTAP versions 7.0 and above. The Operation succeeds when the Host on which the domain user is To be pushed contains usergroups similar To that of the domain user. Two usergroups are similar if they have same Name and set of similar roles (roles with same Name and same set of Capabilities).
Input Name Type HostDomainuserPush HostDomainuserPush
Output Name Type HostDomainuserPushResult HostDomainuserPushResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EDOMAINUSERAMBIGUOUS EDOMAINUSERNOTFOUND EHOSTNOTFOUND EHOSTOSVERSIONNOTSUPPORTED EINCOMPATIBLEUSERGROUP EINVALIDINPUT EUSERGROUPNOTFOUND
| HostDomainuserRemove (supported) | [top] |
Removes a domain user From a usergroup or usergroups.
Input Name Type HostDomainuserRemove HostDomainuserRemove
Output Name Type HostDomainuserRemoveResult HostDomainuserRemoveResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EDOMAINUSERAMBIGUOUS EDOMAINUSERNOTFOUND EINTERNALERROR EINVALIDINPUT EUSERGROUPNOTFOUND
| HostGetDefaults (supported) | [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 HostListInfoIterNext. Default Values vary according To the Host Type.
Input Name Type HostGetDefaults HostGetDefaults
Output Name Type HostGetDefaultsResult HostGetDefaultsResult
Error Name Description EACCESSDENIED EAPIERROR
| HostListInfoIterEnd (supported) | [top] |
Ends iteration To list Hosts.
Input Name Type HostListInfoIterEnd HostListInfoIterEnd
Output Name Type HostListInfoIterEndResult HostListInfoIterEndResult
Error Name Description EACCESSDENIED EAPIERROR EINVALIDTAG
| HostListInfoIterNext (supported) | [top] |
Get next few Records in the iteration started by HostListInfoIterStart.
Input Name Type HostListInfoIterNext HostListInfoIterNext
Output Name Type HostListInfoIterNextResult HostListInfoIterNextResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINVALIDTAG
| HostListInfoIterStart (supported) | [top] |
Starts iteration To list Hosts. The list of Hosts can include: Use the filtering criteria in this API To specify the list of Hosts returned by HostListInfoIterNext. If no filtering criteria is specified, all non-deleted Hosts will be returned by HostListInfoIterNext.
- Storage Systems
- vFiler units
- vserver
- Host Agents
- OSSV Agents
- Switches
Input Name Type HostListInfoIterStart HostListInfoIterStart
Output Name Type HostListInfoIterStartResult HostListInfoIterStartResult
Error Name Description EAPIERROR EBADHOSTTYPE EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| HostModify (supported) | [top] |
Modify Attributes stored in the DFM database of a Host managed by the DFM.
Input Name Type HostModify HostModify
Output Name Type HostModifyResult HostModifyResult
Error Name Description EACCESSDENIED EAPIERROR EAPILICENSE EDATABASEERROR EHOSTDOESNOTEXIST EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS
| HostModifyAgentCredentials (supported) | [top] |
Change the Password on the Host Agent for the built in Host Agent management user "admin", using the Operating System credentials specified by OsUsername and OsPassword 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 Type HostModifyAgentCredentials HostModifyAgentCredentials
Output Name Type HostModifyAgentCredentialsResult HostModifyAgentCredentialsResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EHOSTACCESSDENIED EHOSTCOMMUNICATION EHOSTDOESNOTEXIST EHOSTREQUESTDENIED EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS
| HostRoleCreate (supported) | [top] |
Creates a role on the Host. This is applicable for Hosts running ONTAP versions 7.0 and above.
Input Name Type HostRoleCreate HostRoleCreate
Output Name Type HostRoleCreateResult HostRoleCreateResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EDUPLICATEROLE EHOSTNOTFOUND EHOSTOSVERSIONNOTSUPPORTED EINVALIDCAPABILITY EINVALIDDESCRIPTION EINVALIDINPUT EINVALIDROLENAME
| HostRoleDelete (supported) | [top] |
Deletes a role on the Host.
Input Name Type HostRoleDelete HostRoleDelete
Output Name Type HostRoleDeleteResult HostRoleDeleteResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINVALIDINPUT ENOTFOUNDROLE EROLEAMBIGUOUS
| HostRoleListIterEnd (supported) | [top] |
Terminates a View list iteration and clean up any saved info.
Input Name Type HostRoleListIterEnd HostRoleListIterEnd
Output Name Type HostRoleListIterEndResult HostRoleListIterEndResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| HostRoleListIterNext (supported) | [top] |
Returns items From a previous call To HostRoleListIterStart.
Input Name Type HostRoleListIterNext HostRoleListIterNext
Output Name Type HostRoleListIterNextResult HostRoleListIterNextResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| HostRoleListIterStart (supported) | [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 Type HostRoleListIterStart HostRoleListIterStart
Output Name Type HostRoleListIterStartResult HostRoleListIterStartResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINVALIDINPUT ENOTFOUNDROLE EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| HostRoleModify (supported) | [top] |
Modifies a role on the Host.
Input Name Type HostRoleModify HostRoleModify
Output Name Type HostRoleModifyResult HostRoleModifyResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EHOSTNOTFOUND EINVALIDCAPABILITY EINVALIDDESCRIPTION EINVALIDINPUT ENOTFOUNDROLE EROLEAMBIGUOUS
| HostRolePush (supported) | [top] |
Pushes a role To a Host. This is applicable for Hosts running ONTAP versions 7.0 and above. The Operation succeeds when the Host on which the role is To be pushed supports all the Capabilities present in the role.
Input Name Type HostRolePush HostRolePush
Output Name Type HostRolePushResult HostRolePushResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EHOSTNOTFOUND EHOSTOSVERSIONNOTSUPPORTED EINVALIDCAPABILITY EINVALIDINPUT ENOTFOUNDROLE EROLEAMBIGUOUS
| HostSetOption (supported) | [top] |
Change the Option on the storage system specified by HostOptionName To the Value specified by HostOptionValue. 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 HostListInfoIterNext is called. 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.
HostOptionName HostListInfoIterNext element ndmpd.enable IsNdmpEnabled ndmpd.access NdmpAccessSpecifier snapvault.enable IsSnapvaultEnabled snapvault.access SnapvaultAccessSpecifier snapmirror.enable IsSnapmirrorEnabled snapmirror.access SnapmirrorAccessSpecifier
Input Name Type HostSetOption HostSetOption
Output Name Type HostSetOptionResult HostSetOptionResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EHOSTDOESNOTEXIST EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS
| HostUserAdd (supported) | [top] |
Creates a local user on the Host. This is applicable for Hosts running ONTAP versions 7.0 and above.
Input Name Type HostUserAdd HostUserAdd
Output Name Type HostUserAddResult HostUserAddResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EDUPLICATEUSER EHOSTNOTFOUND EHOSTOSVERSIONNOTSUPPORTED EINVALIDDESCRIPTION EINVALIDINPUT EINVALIDPASSWORDAGE EINVALIDUSERFULLNAME EINVALIDUSERNAME EPASSWORDAGENOTSUPPORTED EUSERGROUPNOTFOUND
| HostUserDelete (supported) | [top] |
Deletes a local user on the Host.
Input Name Type HostUserDelete HostUserDelete
Output Name Type HostUserDeleteResult HostUserDeleteResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINVALIDINPUT ENOTFOUNDUSER EUSERAMBIGUOUS
| HostUserListIterEnd (supported) | [top] |
Terminates a View list iteration and clean up any saved info.
Input Name Type HostUserListIterEnd HostUserListIterEnd
Output Name Type HostUserListIterEndResult HostUserListIterEndResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| HostUserListIterNext (supported) | [top] |
Returns items From a previous call To HostUserListIterStart.
Input Name Type HostUserListIterNext HostUserListIterNext
Output Name Type HostUserListIterNextResult HostUserListIterNextResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| HostUserListIterStart (supported) | [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 Type HostUserListIterStart HostUserListIterStart
Output Name Type HostUserListIterStartResult HostUserListIterStartResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINVALIDINPUT ENOTFOUNDUSER EOBJECTNOTFOUND EUSERGROUPNOTFOUND
| HostUserModify (supported) | [top] |
Modifies local user on the Host.
Input Name Type HostUserModify HostUserModify
Output Name Type HostUserModifyResult HostUserModifyResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EHOSTNOTFOUND EINVALIDDESCRIPTION EINVALIDINPUT EINVALIDPASSWORDAGE EINVALIDUSERFULLNAME ENOTFOUNDUSER EPASSWORDAGENOTSUPPORTED EUSERAMBIGUOUS EUSERGROUPNOTFOUND
| HostUserModifyPassword (supported) | [top] |
Modifies Password of a local user on the Host.
Input Name Type HostUserModifyPassword HostUserModifyPassword
Output Name Type HostUserModifyPasswordResult HostUserModifyPasswordResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EHOSTNOTFOUND EINTERNALERROR EINVALIDINPUT ENOTFOUNDUSER EUSERAMBIGUOUS
| HostUserPush (supported) | [top] |
Pushes a local user To a Host. This is applicable for Hosts running ONTAP versions 7.0 and above. The Operation succeeds when the Host on which the local user is To be pushed contains usergroups similar To that of the local user. Two usergroups are similar if they have same Name and set of similar roles (roles with same Name and same set of Capabilities).
Input Name Type HostUserPush HostUserPush
Output Name Type HostUserPushResult HostUserPushResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EHOSTNOTFOUND EHOSTOSVERSIONNOTSUPPORTED EINCOMPATIBLEUSERGROUP EINVALIDINPUT ENOTFOUNDUSER EPASSWORDAGENOTSUPPORTED EUSERAMBIGUOUS EUSERGROUPNOTFOUND
| HostUsergroupCreate (supported) | [top] |
Creates a usergroup on the Host. This is applicable for Hosts running ONTAP versions 7.0 and above.
Input Name Type HostUsergroupCreate HostUsergroupCreate
Output Name Type HostUsergroupCreateResult HostUsergroupCreateResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EDUPLICATEUSERGROUP EHOSTNOTFOUND EHOSTOSVERSIONNOTSUPPORTED EINVALIDDESCRIPTION EINVALIDINPUT EINVALIDUSERGROUPNAME ENOTFOUNDROLE
| HostUsergroupDelete (supported) | [top] |
Deletes a usergroup on the Host.
Input Name Type HostUsergroupDelete HostUsergroupDelete
Output Name Type HostUsergroupDeleteResult HostUsergroupDeleteResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINVALIDINPUT EUSERGROUPAMBIGUOUS EUSERGROUPNOTFOUND
| HostUsergroupListIterEnd (supported) | [top] |
Terminates a View list iteration and clean up any saved info.
Input Name Type HostUsergroupListIterEnd HostUsergroupListIterEnd
Output Name Type HostUsergroupListIterEndResult HostUsergroupListIterEndResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| HostUsergroupListIterNext (supported) | [top] |
Returns items From a previous call To HostUsergroupListIterStart.
Input Name Type HostUsergroupListIterNext HostUsergroupListIterNext
Output Name Type HostUsergroupListIterNextResult HostUsergroupListIterNextResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| HostUsergroupListIterStart (supported) | [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 Type HostUsergroupListIterStart HostUsergroupListIterStart
Output Name Type HostUsergroupListIterStartResult HostUsergroupListIterStartResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINVALIDINPUT EOBJECTNOTFOUND EUSERGROUPNOTFOUND
| HostUsergroupModify (supported) | [top] |
Modifies a usergroup on the Host.
Input Name Type HostUsergroupModify HostUsergroupModify
Output Name Type HostUsergroupModifyResult HostUsergroupModifyResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EDUPLICATEUSERGROUP EHOSTNOTFOUND EINVALIDDESCRIPTION EINVALIDINPUT EINVALIDUSERGROUPNAME ENOTFOUNDROLE EUSERGROUPAMBIGUOUS EUSERGROUPNOTFOUND
| HostUsergroupPush (supported) | [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 Type HostUsergroupPush HostUsergroupPush
Output Name Type HostUsergroupPushResult HostUsergroupPushResult
Error Name Description EACCESSDENIED EAPIERROR EBADHOSTTYPE EDATABASEERROR EHOSTNOTFOUND EHOSTOSVERSIONNOTSUPPORTED EINCOMPATIBLEROLE EINVALIDINPUT ENOTFOUNDROLE EUSERGROUPAMBIGUOUS EUSERGROUPNOTFOUND
| Element definition: HostAdd | [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 a storage system or NetCache or FC Switch, we add it To the database and set the ApplianceId. If it's a Host agent, we add the agent To the database and set the AgentId. On return, only one of the ApplianceId or AgentId will be set.
Name Type Description AddNetwork xsd:boolean
optional
Indicates if DFM should start monitoring the network in which new Host resides. Default is false. AdminPort xsd:integer
optional
The port To use To try To access a Host agent. Range: [1..65535] BlockCmode xsd:boolean
optional
Indicates if DFM should block adding c-mode Hosts. Default is false. HostNameOrId xsd: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]
| Element definition: HostAddLicense | [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: 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 SuppressInuseError 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.
- 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)
Name Type Description HostLicense xsd:string
License To be installed on storage system. HostNameOrId HostNameOrId
The Host To receive the License. SuppressInuseError xsd:boolean
optional
If true, suppresses the ELICENSEINUSE Error. Defaults To false.
| Element definition: HostAddLicenseResult | [top] |
[none]
| Element definition: HostAddOssv | [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 OssvId.
Name Type Description HostNameOrId xsd: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] NdmpCredentials WrapperOfFullNdmpCredentials
optional
The ndmp credentials we should try To use To connect To the ossv Host we're trying To add.
| Element definition: HostAddOssvResult | [top] |
Name Type Description HostAddress xsd:string
optional
IP Address for the Host. Length: [0..39] OssvId HostId
optional
Identifier of the newly added ossv agent.
| Element definition: HostAddResult | [top] |
Name Type Description AgentId HostId
optional
Identifier of the newly added Host agent. ApplianceId HostId
optional
Identifier of the newly added storage system or NetCache or FC Switch. HostAddress xsd:string
optional
IP Address for the Host. Length: [0..39]
| Element definition: HostAgentOssvServiceStart | [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.
Name Type Description AgentNameOrId HostNameOrId
The Name or Id of the agent Host To start/stop the ossv Service on. Timeout xsd:integer
optional
Number of seconds To wait for ossv Service To start/stop. Range: [1..100]
| Element definition: HostAgentOssvServiceStartResult | [top] |
[none]
| Element definition: HostAgentOssvServiceStop | [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.
Name Type Description AgentNameOrId HostNameOrId
The Name or Id of the agent Host To start/stop the ossv Service on. Timeout xsd:integer
optional
Number of seconds To wait for ossv Service To start/stop. Range: [1..100]
| Element definition: HostAgentOssvServiceStopResult | [top] |
[none]
| Element definition: HostCapabilityListIterEnd | [top] |
Terminates a View list iteration and clean up any saved info.
Name Type Description Tag xsd:string
Tag From a previous HostCapabilityListIterStart call.
| Element definition: HostCapabilityListIterEndResult | [top] |
[none]
| Element definition: HostCapabilityListIterNext | [top] |
Returns items From a previous call To HostCapabilityListIterStart.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Range: [1..2^31-1] Tag xsd:string
Tag From a previous host-capability-list-iter-start-call.
| Element definition: HostCapabilityListIterNextResult | [top] |
Name Type Description Capabilities ArrayOfCapability
List of Capabilities on the Host. Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1]
| Element definition: HostCapabilityListIterStart | [top] |
Initiates a Query for a list of allowed Capabilities on Host. This is applicable for Hosts running ONTAP versions 7.0 and above.
Name Type Description HostNameOrId ObjNameOrId
Name or Id of the Host To list the Capabilities for. Only storage systems and vFiler units are allowed.
| Element definition: HostCapabilityListIterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are available for future retrieval with HostCapabilityListIterNext. Range: [1..2^31-1] Tag xsd:string
Tag To be used in subsequent calls To HostCapabilityListIterNext or HostCapabilityListIterEnd.
| Element definition: HostCreateNdmpuser | [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.
Name Type Description HostNameOrId HostNameOrId
The Host To create the NDMP user on. NdmpUsername NdmpUsername
NDMP user Name.
| Element definition: HostCreateNdmpuserResult | [top] |
[none]
| Element definition: HostDelete | [top] |
Deletes a Host. A Host cannot be deleted in the following cases: A successful deletion of a Host will have the following impacts:
- Controllers that belong To a cluster cannot be deleted individually. In this case, ECANNOTDELETECLUSTERNODEHOST will be returned.
- Cannot delete agent if it is in use by ossv or has SRM Paths. In this case, EHOSTINUSE will be returned. The agent can be forcefully deleted, if IgnoreHostInUse is set To true.
- Resource Pools and Resource Groups containing the Host will be updated based on its removal.
- All monitored Objects contained by the Host will be removed.
- Monitoring of the Host will be stopped.
- Datasets resources containing the Host will be removed based on Host removal. This may affect Dataset conformance Status.
- If deleting an agent that is used by ossv, ossv stop/start Capability will be disabled.
- If deleting an agent that is used by SRM Paths, SRM monitoring will be disabled.
Name Type Description HostNameOrId ObjNameOrId
Name or Id of a Host. Host can be one of the following: Filer, Vfiler, cluster, vserver, agent, ossv, switch IgnoreHostInUse xsd:boolean
optional
Default is false. This flag is applicable only when the deleted Host is of Type agent. This flag controls whether an EHOSTINUSE Error is returned To caller when the deleted agent is used by ossv or has SRM Paths. When this flag is set To true, agent is forcefully deleted regardless of its usage state.
| Element definition: HostDeleteResult | [top] |
[none]
| Element definition: HostDomainuserAdd | [top] |
Adds a domain user on the Host. This is applicable for Hosts running ONTAP versions 7.0 and above.
Name Type Description HostDomainuserNameOrIdOrSid DomainuserNameOrIdOrSid
Name or Id or Sid of domain user. HostNameOrId ObjNameOrId
optional
Name or Id of the Host on which the domain user is To be added. Only storage systems and vFiler units are allowed. HostUsergroupNamesOrIds ArrayOfHostUsergroupNameOrId
List of ids or names of usergroups To which the domain user has To be added.
| Element definition: HostDomainuserAddResult | [top] |
Name Type Description HostDomainuserId AccessObjectId
Identifier of the domain user added To usergroup(s) on Host.
| Element definition: HostDomainuserListIterEnd | [top] |
Terminates a View list iteration and clean up any saved info.
Name Type Description Tag xsd:string
Tag From a previous HostDomainuserListIterStart call.
| Element definition: HostDomainuserListIterEndResult | [top] |
[none]
| Element definition: HostDomainuserListIterNext | [top] |
Returns items From a previous call To HostDomainuserListIterStart.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Range: [1..2^31-1] Tag xsd:string
Tag From a previous HostDomainuserListIterStart call.
| Element definition: HostDomainuserListIterNextResult | [top] |
Name Type Description HostDomainusers ArrayOfHostDomainuserInfo
List of domain users on Host(s). Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1]
| Element definition: HostDomainuserListIterStart | [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.
Name Type Description HostDomainuserNameOrIdOrSid DomainuserNameOrIdOrSid
optional
Name or Sid or Id of the domain user on the Host. HostUsergroupNameOrId UsergroupNameOrId
optional
Name of Id of the user Group. If specified only the users belonging To this Group will be listed. ObjectNameOrId ObjNameOrId
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 xsd:boolean
optional
Default is false. If set To true, then the usergroups, roles, and allowed Capabilities are placed into the HostDomainuserInfo element.
| Element definition: HostDomainuserListIterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are available for future retrieval with HostDomainuserListIterNext. Range: [1..2^31-1] Tag xsd:string
Tag To be used in subsequent calls To HostDomainuserListIterNext or HostDomainuserListIterEnd.
| Element definition: HostDomainuserPush | [top] |
Pushes a domain user To a Host. This is applicable for Hosts running ONTAP versions 7.0 and above. The Operation succeeds when the Host on which the domain user is To be pushed contains usergroups similar To that of the domain user. Two usergroups are similar if they have same Name and set of similar roles (roles with same Name and same set of Capabilities).
Name Type Description HostDomainuserNameOrIdOrSid DomainuserNameOrIdOrSid
Name or Id or Sid of the domain user on the Host. HostNameOrId ObjNameOrId
Name or Id of the Host To push the domain user on. Only storage systems and vFiler units are allowed.
| Element definition: HostDomainuserPushResult | [top] |
[none]
| Element definition: HostDomainuserRemove | [top] |
Removes a domain user From a usergroup or usergroups.
Name Type Description HostDomainuserNameOrIdOrSid DomainuserNameOrIdOrSid
Name or Id or Sid of domain user on the Host. HostUsergroupNamesOrIds ArrayOfHostUsergroupNameOrId
List of ids or names of usergroups From which the domain user has To be removed.
| Element definition: HostDomainuserRemoveResult | [top] |
[none]
| Element definition: HostGetDefaults | [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 HostListInfoIterNext. Default Values vary according To the Host Type.
[none]
| Element definition: HostGetDefaultsResult | [top] |
Name Type Description HostDefaults HostDefaults
The default Values of the Attributes defined by this ZAPI set.
| Element definition: HostListInfoIterEnd | [top] |
Ends iteration To list Hosts.
Name Type Description Tag xsd:string
The Tag From a previous HostListInfoIterStart.
| Element definition: HostListInfoIterEndResult | [top] |
[none]
| Element definition: HostListInfoIterNext | [top] |
Get next few Records in the iteration started by HostListInfoIterStart.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Range: [1..2^31-1]
Tag xsd:string
The Tag returned by a previous HostListInfoIterStart.
| Element definition: HostListInfoIterNextResult | [top] |
Name Type Description Hosts ArrayOfHostInfo
Array of Hosts. Records xsd:integer
optional
The number of Records actually returned. Range: [1..2^31-1].
| Element definition: HostListInfoIterStart | [top] |
Starts iteration To list Hosts. The list of Hosts can include: Use the filtering criteria in this API To specify the list of Hosts returned by HostListInfoIterNext. If no filtering criteria is specified, all non-deleted Hosts will be returned by HostListInfoIterNext.
- Storage Systems
- vFiler units
- vserver
- Host Agents
- OSSV Agents
- Switches
Name Type Description ExpandFilerToVfilers xsd:boolean
optional
If true and ObjectNameOrId is a storage system and HostTypes contains "Vfiler" then all vFiler units belonging To the storage system are returned else it is ignored. Default Value is false. HostDpFilterInfo HostDpFilterInfo
optional
Data Protection specific information for this iterator. HostTypes ArrayOfHostType
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. IncludeIsAvailable xsd:boolean
optional
If true, the IsAvailable Status is calculated for each Host which may make the call To this zapi take much longer. IncludeMigrationInfo xsd:boolean
optional
If true, return the migration information for the migrating vFiler units. Default false. IncludePerfSpaceDetails xsd:boolean
optional
If true, return the details of space consumed by performance data of the Host. Default false. IsDirectMemberOnly xsd: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 ObjectNameOrId field. LicenseFilter ArrayOfLicense
optional
Filter for listing storage systems based on services licensed. Appliable when HostType is "Filer". Only those storage systems which have all the Licenses installed as specified in input are listed. ObjectManagementFilter ObjectManagementInterface
optional
Filter the object based on the Data ONTAP Interface that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. If no filter is supplied, all Objects will be considered. ObjectNameOrId ObjNameOrId
optional
Name or identifier of an object To list Hosts for. The allowed object types for this argument are: If ObjectNameOrId identifies a Host, that single Host will be returned. If ObjectNameOrId resolves To more than one Hosts, all of them will be returned. If no ObjectNameOrId 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 HostTypes element includes "agent" or "ossv" all subdomains beginning with the Host Name will be checked.
- Resource Group
- Resource Pool
- Dataset
- Storage Set
- Host
- Aggregate
- Volume
- Qtree
- OSSV Directory
- GenericAppObject
QueryHost xsd:boolean
optional
If true, Query the Host To update the database and refresh the Values returned in the following elements by HostListInfoIterNext: The HostListInfoIterNext zapi defines which elements will be updated based on whether the Host Type supports it.
- HostStatus
- IsAgentOssvEnabled
- IsSnapvaultEnabled
- IsNdmpEnabled
- IsSnapmirrorEnabled
- SnapvaultAccessSpecifier
- NdmpAccessSpecifier
- SnapmirrorAccessSpecifier
- HostCommunicationStatus
- HostCredentialsStatus
- NdmpCommunicationStatus
- NdmpCredentialsStatus
- NdmpAgentStatus
- IsSnapvaultPrimary
- IsSnapvaultSecondary
- IsSnapmirrorHost
- IsUnixPrimary
- IsLinuxPrimary
- IsWindowsPrimary
- IsWindowsOfmPrimary
- IsNearstore
Errors in communicating with or authenticating To the Host will prevent updating all the elements that are supported for that Host Type.
VfilerIpspace VfilerIpspace
optional
Filter for listing vFiler units, if specified, only the vFiler units that belong To the Ipspace are listed. Applicable only for HostType "Vfiler".
| Element definition: HostListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are available for future retrieval with host-list-iter-next. Range: [0..2^31-1]
Tag xsd:string
Tag To be used in subsequent calls To host-list-iter-next or host-list-iter-end.
| Element definition: HostModify | [top] |
Modify Attributes stored in the DFM database of a Host managed by the DFM.
Name Type Description HostModifyInfo HostModifyInfo
Host information. HostNameOrId HostNameOrId
The Host To be modified.
| Element definition: HostModifyAgentCredentials | [top] |
Change the Password on the Host Agent for the built in Host Agent management user "admin", using the Operating System credentials specified by OsUsername and OsPassword 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.
Name Type Description AgentNameOrId HostNameOrId
The Host To change the Host Agent Password on. ManagementPassword HostPassword
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. OsPassword HostPassword
root or administrative Password used To authenticate https POST Password change Request. Encrypted using two way encryption. OsUsername xsd:string
root or administrative user Name used To authenticate https POST Password change Request.
| Element definition: HostModifyAgentCredentialsResult | [top] |
[none]
| Element definition: HostModifyResult | [top] |
[none]
| Element definition: HostRoleCreate | [top] |
Creates a role on the Host. This is applicable for Hosts running ONTAP versions 7.0 and above.
Name Type Description HostRole WrapperOfHostRoleInfo
New role information. "HostRoleName" 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.
| Element definition: HostRoleCreateResult | [top] |
Name Type Description HostRoleId AccessObjectId
Identifier of the new role created on the Host.
| Element definition: HostRoleDelete | [top] |
Deletes a role on the Host.
Name Type Description HostRoleNameOrId AccessObjectNameOrId
Name or Id of the role To be deleted on the Host.
| Element definition: HostRoleDeleteResult | [top] |
[none]
| Element definition: HostRoleListIterEnd | [top] |
Terminates a View list iteration and clean up any saved info.
Name Type Description Tag xsd:string
Tag From a previous HostRoleListIterStart call.
| Element definition: HostRoleListIterEndResult | [top] |
[none]
| Element definition: HostRoleListIterNext | [top] |
Returns items From a previous call To HostRoleListIterStart.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Range: [1..2^31-1] Tag xsd:string
Tag From a previous HostRoleListIterStart call.
| Element definition: HostRoleListIterNextResult | [top] |
Name Type Description HostRoles ArrayOfHostRoleInfo
List of roles on Host(s). Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1]
| Element definition: HostRoleListIterStart | [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.
Name Type Description HostRoleNameOrId AccessObjectNameOrId
optional
Name or Id of a role on the Host. If this is provided, the output contains only the information associated with this role. ObjectNameOrId ObjNameOrId
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 xsd:boolean
optional
Default is false. If set To true, then the allowed Capabilities are placed into the HostRoleInfo element.
| Element definition: HostRoleListIterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are available for future retrieval with HostRoleListIterNext. Range: [1..2^31-1] Tag xsd:string
Tag To be used in subsequent calls To HostRoleListIterNext or HostRoleListIterEnd.
| Element definition: HostRoleModify | [top] |
Modifies a role on the Host.
Name Type Description HostRole WrapperOfHostRoleInfo
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.
| Element definition: HostRoleModifyResult | [top] |
[none]
| Element definition: HostRolePush | [top] |
Pushes a role To a Host. This is applicable for Hosts running ONTAP versions 7.0 and above. The Operation succeeds when the Host on which the role is To be pushed supports all the Capabilities present in the role.
Name Type Description HostNameOrId ObjNameOrId
Name or Id of the Host To push the role on. Only storage systems and vFiler units are allowed. HostRoleNameOrId AccessObjectNameOrId
Name or Id of the role To be pushed on the Host.
| Element definition: HostRolePushResult | [top] |
[none]
| Element definition: HostSetOption | [top] |
Change the Option on the storage system specified by HostOptionName To the Value specified by HostOptionValue. 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 HostListInfoIterNext is called. 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.
HostOptionName HostListInfoIterNext element ndmpd.enable IsNdmpEnabled ndmpd.access NdmpAccessSpecifier snapvault.enable IsSnapvaultEnabled snapvault.access SnapvaultAccessSpecifier snapmirror.enable IsSnapmirrorEnabled snapmirror.access SnapmirrorAccessSpecifier
Name Type Description HostNameOrId HostNameOrId
The Host To set the Option on. HostOptionName xsd:string
The Name of the Host Option. Length: [0..255] HostOptionValue xsd:string
The Host Option will be set To this Value. Length: [0..255]
| Element definition: HostSetOptionResult | [top] |
[none]
| Element definition: HostUserAdd | [top] |
Creates a local user on the Host. This is applicable for Hosts running ONTAP versions 7.0 and above.
Name Type Description HostUser WrapperOfHostUserInfo
New local user information. HostUserName, 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.
| Element definition: HostUserAddResult | [top] |
Name Type Description HostUserId AccessObjectId
Identifier of the new user created on the Host.
| Element definition: HostUserDelete | [top] |
Deletes a local user on the Host.
Name Type Description HostUserNameOrId AccessObjectNameOrId
Name or Id of the local user on the Host.
| Element definition: HostUserDeleteResult | [top] |
[none]
| Element definition: HostUserListIterEnd | [top] |
Terminates a View list iteration and clean up any saved info.
Name Type Description Tag xsd:string
Tag From a previous HostUserListIterStart call.
| Element definition: HostUserListIterEndResult | [top] |
[none]
| Element definition: HostUserListIterNext | [top] |
Returns items From a previous call To HostUserListIterStart.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Range: [1..2^31-1] Tag xsd:string
Tag From a previous host-user-list-iter- call.
| Element definition: HostUserListIterNextResult | [top] |
Name Type Description HostUsers ArrayOfHostUserInfo
List of local users on the Host. Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1]
| Element definition: HostUserListIterStart | [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.
Name Type Description HostUserNameOrId AccessObjectNameOrId
optional
Name or Id of a local user. HostUsergroupNameOrId UsergroupNameOrId
optional
Name of Id of the user Group. If specified only the users belonging To this Group will be listed. ObjectNameOrId ObjNameOrId
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 xsd:boolean
optional
Default is false. If set To true, then the usergroups, roles, and allowed Capabilities are placed into the HostUserInfo element.
| Element definition: HostUserListIterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are available for future retrieval with HostUserListIterNext. Range: [1..2^31-1] Tag xsd:string
Tag To be used in subsequent calls To HostUserListIterNext or HostUserListIterEnd.
| Element definition: HostUserModify | [top] |
Modifies local user on the Host.
Name Type Description HostUser WrapperOfHostUserInfo
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.
| Element definition: HostUserModifyPassword | [top] |
Modifies Password of a local user on the Host.
Name Type Description HostNameOrId ObjNameOrId
optional
Name or Id of Storage System/vFiler Unit on which the local user exists. HostUserNameOrId AccessObjectNameOrId
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. NewPassword HostUserPassword
New Password of the local user. OldPassword HostUserPassword
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.
| Element definition: HostUserModifyPasswordResult | [top] |
[none]
| Element definition: HostUserModifyResult | [top] |
[none]
| Element definition: HostUserPush | [top] |
Pushes a local user To a Host. This is applicable for Hosts running ONTAP versions 7.0 and above. The Operation succeeds when the Host on which the local user is To be pushed contains usergroups similar To that of the local user. Two usergroups are similar if they have same Name and set of similar roles (roles with same Name and same set of Capabilities).
Name Type Description HostNameOrId ObjNameOrId
Name or Id of the Host To push the user on. Only storage systems and vFiler units are allowed. HostUserNameOrId AccessObjectNameOrId
Name or Id of the local user on the Host. Password HostUserPassword
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.
| Element definition: HostUserPushResult | [top] |
[none]
| Element definition: HostUsergroupCreate | [top] |
Creates a usergroup on the Host. This is applicable for Hosts running ONTAP versions 7.0 and above.
Name Type Description HostUsergroup WrapperOfHostUsergroupInfo
New usergroup information. "HostUsergroupName" 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.
| Element definition: HostUsergroupCreateResult | [top] |
Name Type Description HostUsergroupId AccessObjectId
Identifier of the new usergroup created on the Host.
| Element definition: HostUsergroupDelete | [top] |
Deletes a usergroup on the Host.
Name Type Description HostUsergroupNameOrId UsergroupNameOrId
Name or Id of the usergroup on the Host.
| Element definition: HostUsergroupDeleteResult | [top] |
[none]
| Element definition: HostUsergroupListIterEnd | [top] |
Terminates a View list iteration and clean up any saved info.
Name Type Description Tag xsd:string
Tag From a previous HostUsergroupListIterStart call.
| Element definition: HostUsergroupListIterEndResult | [top] |
[none]
| Element definition: HostUsergroupListIterNext | [top] |
Returns items From a previous call To HostUsergroupListIterStart.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Range: [1..2^31-1] Tag xsd:string
Tag From a previous host-group-list-iter-start call.
| Element definition: HostUsergroupListIterNextResult | [top] |
Name Type Description HostUsergroups ArrayOfHostUsergroupInfo
List of usergroups on Host(s). Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1]
| Element definition: HostUsergroupListIterStart | [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.
Name Type Description HostUsergroupNameOrId UsergroupNameOrId
optional
Name or Id of a usergroup. ObjectNameOrId ObjNameOrId
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 xsd:boolean
optional
Default is false. If set To true, then the roles and allowed Capabilities are placed into the HostUsergroupInfo element.
| Element definition: HostUsergroupListIterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are available for future retrieval with host-group-list-iter-next. Range: [1..2^31-1] Tag xsd:string
Tag To be used in subsequent calls To HostUsergroupListIterNext or HostUsergroupListIterEnd.
| Element definition: HostUsergroupModify | [top] |
Modifies a usergroup on the Host.
Name Type Description HostUsergroup WrapperOfHostUsergroupInfo
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. NewUsergroupName UsergroupName
optional
New usergroup Name for this usergroup. This is used To rename the usergroup specified in HostUsergroup. If this Value is invalid, HostUsergroupModify fails without changing anything. The Value is optional, and if not provided, the Group Name will be unchanged.
| Element definition: HostUsergroupModifyResult | [top] |
[none]
| Element definition: HostUsergroupPush | [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.
Name Type Description HostNameOrId ObjNameOrId
Name or Id of the Host To push the usergroup on. Only storage systems and vFiler units are allowed. HostUsergroupNameOrId UsergroupNameOrId
Name or Id of the usergroup To be pushed on the Host.
| Element definition: HostUsergroupPushResult | [top] |
[none]
| Element definition: AccessObjectId | [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: AccessObjectNameOrId | [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 AccessObjectName or AccessObjectId.
[none]
| Element definition: ArrayOfCapability | [top] |
Name Type Description Capability Capability[]
| Element definition: ArrayOfHostDomainuserInfo | [top] |
Name Type Description HostDomainuserInfo HostDomainuserInfo[]
| Element definition: ArrayOfHostInfo | [top] |
Name Type Description HostInfo HostInfo[]
| Element definition: ArrayOfHostRoleInfo | [top] |
Name Type Description HostRoleInfo HostRoleInfo[]
| Element definition: ArrayOfHostType | [top] |
Name Type Description HostType HostType[]
| Element definition: ArrayOfHostUserInfo | [top] |
Name Type Description HostUserInfo HostUserInfo[]
| Element definition: ArrayOfHostUsergroupInfo | [top] |
Name Type Description HostUsergroupInfo HostUsergroupInfo[]
| Element definition: ArrayOfHostUsergroupNameOrId | [top] |
Name Type Description HostUsergroupNameOrId HostUsergroupNameOrId[]
| Element definition: ArrayOfLicense | [top] |
Name Type Description License License[]
| Element definition: DomainuserNameOrIdOrSid | [top] |
Name or Id or the Sid of domain user. This must conform To one of the following:
- DomainuserName
- Sid
- access-cotrol-id
[none]
| Element definition: HostDefaults | [top] |
The default Values for the Attributes defined by the Host.
Name Type Description AdminPortAgent IpPortNumber
The agent's default administrative port for executing ONTAP APIs. Valid only for Host Agents. AdminPortCacheHttp IpPortNumber
The Host's default HTTP administrative port for executing ONTAP APIs. Valid only for NetCache appliances. AdminPortCacheHttps IpPortNumber
The Host's default HTTPS administrative port for executing ONTAP APIs. Valid only for NetCache appliances. AdminPortHost IpPortNumber
The Host's default administrative port for executing ONTAP APIs. Valid only for storage systems. AdminPortHostHttp IpPortNumber
The Host's default HTTP administrative port for executing ONTAP APIs. Valid only for storage systems. AdminPortHostHttps IpPortNumber
The Host's default HTTPS administrative port for executing ONTAP APIs. Valid only for storage systems. AdminTransportAgent xsd:string
The default Value for the transport used for communicating To the Agent. Possible Values: are "http", "https" AdminTransportCache xsd:string
The default Value for the transport used for communicating To the cache. Possible Values: "http", "https" AdminTransportHost xsd:string
The default Value for the transport used for communicating To the Host. Possible Values: "http", "https" NdmpPort IpPortNumber
Default Value for NDMP port. Valid only for storage systems and OSSV agents. PerfAdvisorTransportHost xsd: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" SnapvaultMaxBackupThreads xsd: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 xsd:integer
Default Value of Timeout we use in zapis that accept Timeout arguments. Time is in seconds. Range: [1..100] UseHostsEquiv xsd:boolean
The setting for communicating To the Host using Hosts.equiv authentication. Valid only for storage systems and vFiler units.
| Element definition: HostDpFilterInfo | [top] |
Data Protection specific information for this iterator. Default is false.
Name Type Description IsDpIgnored xsd: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. IsInDataset xsd:boolean
optional
If true, only Hosts in a Dataset are listed Default is false. IsInResourcepool xsd:boolean
optional
If true, only Hosts in a Resource pool are listed Default is false. IsSnapmirroredOnly xsd:boolean
optional
If true, only SnapMirror Hosts are listed. Host could be either a Source or a destination for SnapMirror. Default is false. IsSnapvaultPrimaryOnly xsd:boolean
optional
If true, only SnapVault primary systems are listed. Default is false. IsSnapvaultSecondaryOnly xsd:boolean
optional
If true, only SnapVault secondary systems are listed. Default is false. IsUnprotected xsd:boolean
optional
If true, only list Hosts which are not protected, which means it is: If false or not set, list all Hosts.
- 1. not in any Resource pool.
- and 2. not a member of a node in a Dataset with protection Policy assigned.
| Element definition: HostId | [top] |
DFM Host identifier. Range: [1..2^31-1]
[none]
| Element definition: HostModifyInfo | [top] |
Host information.
Name Type Description AdminPort IpPortNumber
optional
The Host's administrative port for executing APIs. Valid only for Host Agents or Storage Systems. If the port is being modified for a Host Agent operating under UNIX, the port number has To be greater than or equal To 1025. AdminTransport xsd:string
optional
The transport used for API communication with the Host. Possible Values are: 'http', 'https' Valid only for storage systems, ignored for others. HostAddress xsd:string
optional
Primary IP Address for the Host. If not present, the current setting is not modified. Length: [0..39]
HostDescription xsd:string
optional
User-specified Description of Host. If not present, the current setting is not modified. Length: [0..255] HostDpModifyInfo HostDpModifyInfo
optional
Data protection specific Host information. If not present, the current settings are not modified. HostName ObjName
optional
New Name for the Host. This Name cannot be set To the empty string. If not present, the current setting is not modified. HostPassword HostPassword
optional
Password for logging into the Host. HostUsername xsd:string
optional
User Name for logging into the Host. If not present, the current setting is not modified. Length: [0..64]
NdmpCredentials NdmpCredentials
optional
NDMP credentials for the Host. Valid only for storage systems and OSSV agents. If not present, the current settings are not modified. PerfAdvisorTransport PerfAdvisorTransport
optional
The transport setting for communicating To the Host for collecting performance data. Valid only for storage systems. UseHostsEquiv xsd: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: HostNameOrId | [top] |
DFM Host. A Host can be a storage system, a vFiler Unit, a switch, 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: HostPassword | [top] |
Password for logging in. Encrypted using 2-way encryption. Length: [0..64]
[none]
| Element definition: HostUserPassword | [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: NdmpUsername | [top] |
Name of NDMP user. Length: [1..32]
[none]
| Element definition: ObjNameOrId | [top] |
Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An ObjNameOrId must contain between 1 and 64 characters, and must conform To one of the following formats: Elements of Type ObjNameOrId are used only as inputs To ZAPIs. The Value must Match either the Name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types.
- It must have the format of an ObjName, or
- It must be the decimal numeric string form of a positive integer whose Value is in the range [1..2^31 - 1].
- In case of application resources From the Host Service, this field can contain unique identifier assigned To the object by the Host Service e.g. for a Virtual Machine, it can be a GUID of the VM. One exception is when such unique identifier is a decimal numeric string containing only digits From 0 through 9. In that case, you cannot use such identifier as ObjNameOrId input.
If the format of an ObjNameOrId input element does not conform, or the Value does not Match the Name or ID of an existing object, then generally the ZAPI documents that it fails with Error code EOBJECTNOTFOUND. A ZAPI may return more specific Error codes. In such cases, the ZAPI specification must document its behavior.
If a ZAPI can accept a null Value (e.g. reference To no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null Value.
[none]
| Element definition: ObjectManagementInterface | [top] |
Specify the management Interface of ONTAP that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. Possible Values are:
- "node" - For Objects manageable by node management Interface
- "cluster" - For Objects manageable by cluster management Interface
[none]
| Element definition: UsergroupName | [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: UsergroupNameOrId | [top] |
Name or Id of usergroup on storage system or vFiler Unit. This must conform To the format of either UsergroupName or AccessObjectId.
[none]
| Element definition: VfilerIpspace | [top] |
Ipspace of vFiler Unit.
[none]
| Element definition: WrapperOfFullNdmpCredentials | [top] |
Name Type Description FullNdmpCredentials FullNdmpCredentials
| Element definition: WrapperOfHostRoleInfo | [top] |
Name Type Description HostRoleInfo HostRoleInfo
| Element definition: WrapperOfHostUserInfo | [top] |
Name Type Description HostUserInfo HostUserInfo
| Element definition: WrapperOfHostUsergroupInfo | [top] |
Name Type Description HostUsergroupInfo HostUsergroupInfo
| Element definition: Capability | [top] |
Name of a Capability on the Host. This must conform To one of the following formats: Here, instead of *, commands and sub-commands can be specified directly. Maximum Length: 64 characters
- "*"
- "login-*"
- "security-*"
- "cli-*"
- "api-*"
[none]
| Element definition: FullNdmpCredentials | [top] |
A full set of ndmp credentials with no empty fields which is a specific requirement for this zapi since NdmpUsername and NdmpPassword are both required in order To add an ossv Host.
Name Type Description NdmpPassword HostPassword
Password Name for logging into the Host. Encrypted using 2-way encryption. NdmpPort IpPortNumber
optional
Port To connect on. NdmpUsername NdmpUsername
User Name for logging into the Host.
| Element definition: HostDomainuserInfo | [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 Type Description Capabilities ArrayOfCapability
optional
List of Capabilities of the domain user inherited From the usergroup(s) in which user is member of. HostDomainuserId AccessObjectId
Internal Id of domain user on the Host. HostDomainuserName DomainuserName
Name of the domain user on the Host. HostId ObjId
Id of the Host on which the domain user is present. HostName ObjName
Name of the Host on which the domain user is present. HostRoleIds ArrayOfHostRoleId
optional
List of ids of roles contained by usergroup(s) in which the domain user is member of. HostRoleNames ArrayOfHostRoleName
optional
List of names of roles contained by usergroup(s) in which the domain user is member of. HostUsergroupIds ArrayOfHostUsergroupId
optional
List of ids of usergroups in which the domain user is member of. HostUsergroupNames ArrayOfHostUsergroupName
optional
List of usergroup names in which the domain user is member of. Sid Sid
optional
Sid of the domain user on the Host.
| Element definition: HostDpModifyInfo | [top] |
Data protection specific Host information.
Name Type Description IsDpIgnored xsd: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. SnapvaultMaxBackupThreads xsd: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: HostInfo | [top] |
Host's information.
Name Type Description AdminPort IpPortNumber
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 HostGetDefaults To determine the global default Value. AdminTransport xsd: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 HostGetDefaults To determine the global default Value. CifsDomainInfo CifsDomainInfo
optional
CIFS domain informaiton of storage systems or vFiler Unit. HostAddress xsd:string
The Host's primary IP Address. HostCommunicationStatus xsd: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". HostCredentialsStatus xsd: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 HostCredentialsStatus is "good" or "read_only" and HostCommunicationStatus 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.
HostDescription xsd:string
User-specified Description of Host. Length: [0..255] HostDpInfo HostDpInfo
optional
Data Protection specific information for this Host. HostFqdn xsd:string
optional
The fully qualified domain Name of the Host. Length: [1..255] HostId HostId
This is the DFM Id of the Host. HostModel xsd:string
Model Name or "unknown". Length: [1..255] HostName xsd:string
This is the DFM Name of the Host. Length: [1..255] HostObjStatus ObjStatus
optional
Current Status of the Host based on all Events HostOs xsd: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] HostPerfInfo HostPerfInfo
optional
Current Status of the Host based on all Events NdmpCredentialsStatus will not be updated if NdmpCommunicationStatus 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. HostStatus xsd: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". HostType HostType
Type of the Host. HostUsername xsd:string
This is the administrator Username for a requested Host. Length: [1..64] HostVersion xsd:string
This is the software release for a requested Host. Length: [1..255] IsAvailable xsd:boolean
optional
Tells whether or not this Host is up. For OSSV clients, if valid login credentials are not set, the IsAvailable state will be false. Licenses ArrayOfLicense
List of Licenses installed on the storage system. This will be returned only if the HostType is "Filer". NdmpAgentStatus xsd: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 NdmpCommunicationStatus and NdmpCredentialsStatus, 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 NdmpCommunicationStatus or NdmpCredentialsStatus. If those Status Values do not indicate problems, the problem may be occurring after credentials have been exchanged. NdmpCommunicationStatus xsd: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". NdmpCommunicationTimestamp xsd: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. NdmpCredentials NdmpCredentials
optional
NDMP credentials for the Host. Valid only for storage systems and OSSV agents. The ndmp Password will always be empty for security reasons. NdmpCredentialsStatus xsd: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. NdmpTimestamp xsd:integer
optional
Date of the last successful connection (i.e. the last time NdmpAgentStatus 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. OtherHostId HostId
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. PartnerStorageSystemId ObjId
optional
Identifier of the partner storage system. This element is present only for storage systems in an Active/Active configuration. PartnerStorageSystemName ObjFullName
optional
Full Name of the partner storage system. This element is present only for storage systems in an Active/Active configuration. PerfAdvisorTransport PerfAdvisorTransport
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 HostGetDefaults To determine the global default Value. ServiceStatuses ArrayOfServiceStatus
List of services and their statuses. This element will be present only for a storage system or a vFiler Unit. UseHostsEquiv xsd: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 HostGetDefaults To determine the global default Value. VfilerInfo VfilerInfo
optional
Information about a vFiler Unit. This element is present only when HostType is "Vfiler".
| Element definition: HostRoleInfo | [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 Type Description Capabilities ArrayOfCapability
optional
List of Capabilities the role is allowed. Description AccessObjectDescription
optional
Description of the role. HostId ObjId
optional
Id of the Host on which the role is present. HostName ObjName
optional
Name of the Host on which the role is present. HostRoleId AccessObjectId
optional
Internal Id of the role on the Host. HostRoleName AccessObjectName
optional
Name of the role on the Host.
| Element definition: HostType | [top] |
Type of Host. Possible Values are: Filer, Vfiler, cluster, vserver, agent, ossv, and switch.
[none]
| Element definition: HostUserInfo | [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 Type Description Capabilities ArrayOfCapability
optional
List of Capabilities of the local user inherited From the usergroup(s) in which user is member of. Description AccessObjectDescription
optional
Description of the local user. FullName xsd:string
optional
Full Name of the local user. It should not contain colon(:). Maximum Length:256 characters HostId ObjId
optional
Id of the Host on which the local user is present. HostName ObjName
optional
Name of the Host on which the local user is present. HostRoleIds ArrayOfHostRoleId
optional
List of ids of roles contained by usergroup(s) in which the local user is member of. HostRoleNames ArrayOfHostRoleName
optional
List of names of roles contained by usergroup(s) in which the local user is member of. HostUserId AccessObjectId
optional
Internal Id of local user on the Host. HostUserName AccessObjectName
optional
Name of the local user on the Host. HostUsergroupIds ArrayOfHostUsergroupId
optional
List of ids of usergroups in which the local user is member of. HostUsergroupNames ArrayOfHostUsergroupName
optional
List of usergroup names on which the user is member of. MaximumPasswordAge xsd:unsignedInt
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 MinimumPasswordAge xsd:unsignedInt
optional
Minimum age of the Password(in Days) before it can be changed. Range: [0..2^32-1] Default Value: 0 Password HostUserPassword
optional
Password of the local user. Status xsd: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: HostUsergroupInfo | [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 Type Description Capabilities ArrayOfCapability
optional
List of Capabilities the usergroup has inherited From the member roles. Description xsd:string
optional
Description of the usergroup on the Host. Maximum Length: 128 characters HostId ObjId
optional
Id of the Host on which the usergroup is present. HostName ObjName
optional
Name of the Host on which the usergroup is present. HostRoleIds ArrayOfHostRoleId
optional
List of ids of roles the usergroup contains. HostRoleNames ArrayOfHostRoleName
optional
List of role names the usergroup contains. HostUsergroupId AccessObjectId
optional
Internal Id of the usergroup on the Host. HostUsergroupName UsergroupName
optional
Name of the usergroup on the Host.
| Element definition: HostUsergroupNameOrId | [top] |
Name or Id of usergroup. This must conform To the format of either UsergroupName or AccessObjectId.
[none]
| Element definition: IpPortNumber | [top] |
IP port number. Range: [0..2^16-1]
[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: NdmpCredentials | [top] |
NDMP credentials for a Host or a network. Valid only for storage systems and OSSV agents.
Name Type Description NdmpPassword HostPassword
optional
NDMP Password. NdmpPort IpPortNumber
optional
NDMP port. Valid only for storage systems and OSSV agents. If not present, the current setting is not modified. NdmpUsername NdmpUsername
optional
NDMP user Name. Valid only for storage systems and OSSV agents. If not present, the current setting is not modified.
| Element definition: ObjName | [top] |
Name of a DFM object. This typedef is an alias for the built in ZAPI Type string. An object Name must conform To the following format: The behavior of a ZAPI when it encounters an Error involving an ObjName input element depends on how the ZAPI uses the input element. Here are the general rules:
- 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.
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 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.
If an input Name element is used To refer To an existing object, then the ZAPI specification must specify which DFM object Type (e.g. data set, Host, DP Policy, etc.) is allowed. Some ZAPIs allow the object To be one of several different types. See the Description of ObjFullName for examples of valid input formats.
Note that there is no requirement that all object names must be unique. However, the names for some specific types of Objects are constrained such that no two Objects of that Type may have the same Name. For example, this constraint applies To Datasets, DP schedules, and DP policies. This means that no two Datasets may have the same Name, but a Dataset may have the same Name as a DP schedule or DP Policy.
In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered To be the same Name for purposes of: creating new Objects, renaming existing Objects, or looking up an object by Name. On the other hand, ZAPIs that return an ObjName generally do not change the capitalization at all. For example, if an object's Name has been set To "MyObject", then list iteration ZAPIs that return the object's Name return it as "MyObject" rather than "MYOBJECT" or "myobject".
ZAPIs that operate on ObjName Values and do not follow these general rules about case sensitivity must document the rules that they do follow.
One important exception To these general rules is that Volumes, Qtrees, OSSV Directories, SRM Paths, Interfaces, FCP Targets and FC switch ports all have case-sensitive names. When looking up Objects of these types by Name, the case must Match the object Name.
[none]
| Element definition: PerfAdvisorTransport | [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: AccessObjectDescription | [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: AccessObjectName | [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: ArrayOfHostRoleId | [top] |
Name Type Description HostRoleId HostRoleId[]
| Element definition: ArrayOfHostRoleName | [top] |
Name Type Description HostRoleName HostRoleName[]
| Element definition: ArrayOfHostUsergroupId | [top] |
Name Type Description HostUsergroupId HostUsergroupId[]
| Element definition: ArrayOfHostUsergroupName | [top] |
Name Type Description HostUsergroupName HostUsergroupName[]
| Element definition: ArrayOfServiceStatus | [top] |
Name Type Description ServiceStatus ServiceStatus[]
| Element definition: CifsDomainInfo | [top] |
Details of the cifs domain.
Name Type Description CifsDnsDomainName xsd:string
Specifies the CIFS DNS domain Name. Maximum Length: 255 characters. CifsDomainId xsd:integer
Identifier of the cifs domain. Range: [1..(2^16)-1] CifsDomainName xsd:string
Specifies the NETBIOS Name of the cifs domain. Maximum Length: 255 characters.
| Element definition: DomainuserName | [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: HostDpInfo | [top] |
Data Protection specific information for this iterator.
Name Type Description Datasets ArrayOfDatasetReference
List of Datasets the Host is a member of. If IsInDataset is false, this list will be empty. HostDataset ObjName
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. HostResourcepool ObjName
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. IsAgentOssvEnabled xsd:boolean
optional
Indicates if the ossv Service has been enabled. Valid only for Host Agents. IsDpIgnored xsd:boolean
Indicates if an administrator has chosen To ignore this Host for purposes of data protection. IsInDataset xsd:boolean
Indicates if this Host is a member of any Dataset. IsLinuxPrimary xsd:boolean
optional
Indicates if Host is being managed as having a Linux primary License. Default Value is "false". IsNdmpEnabled xsd:boolean
optional
True if an administrator has chosen To enable ndmp on this Host. IsNearstore xsd:boolean
optional
Indicates if Host is being managed as having a Nearstore License. Default Value is "false". IsSnapmirrorEnabled xsd:boolean
optional
True if an administrator has chosen To enable snapmirror on this Host. IsSnapmirrorHost xsd:boolean
optional
Indicates if Host is being managed as a SnapMirror Host. Default Value is "false". IsSnapvaultEnabled xsd:boolean
optional
True if an administrator has chosen To enable snapvault on this Host. IsSnapvaultPrimary xsd:boolean
Indicates if Host is being managed as a SnapVault primary system. IsSnapvaultSecondary xsd:boolean
Indicates if Host is being managed as a SnapVault secondary system. IsUnixPrimary xsd:boolean
optional
Indicates if Host is being managed as having a Unix primary License. Default Value is "false". IsWindowsOfmPrimary xsd:boolean
optional
Indicates if Host is being managed as having a Windows Open File Manager (OFM) primary License. Default Value is "false". IsWindowsPrimary xsd:boolean
optional
Indicates if Host is being managed as having a Windows primary License. Default Value is "false". NdmpAccessSpecifier xsd: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] SnapmirrorAccessSpecifier xsd: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] SnapvaultAccessSpecifier xsd: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] SnapvaultMaxBackupThreads xsd: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 HostGetDefaults To determine the global default Value. Range: [1..144]
| Element definition: HostPerfInfo | [top] |
Performance specific information for this iterator
Name Type Description DataUnavailableReason ArrayOfPerfStatusError
optional
This element is included only if IsDataAvailable is set To false and indicates the Reason(s) for failure. HostPerfStatus ObjStatus
optional
Current Status of the Host based on performance Events IsDataAvailable xsd:boolean
Returns if the performance data can be collected for this Host This will be present only for storage systems and vFiler units. LastClientStatsCollectionTime Timestamp
optional
Present in output only. This specifies the last time per-client statistics were collected for the Host. It will not be present if per-client statistics were never collected for the Host From Performance Advisor. This element is returned for Storage Systems only. PercentageSpaceConsumed xsd:string
optional
Present in output only. Indicates the percentage of Total space consumed by this Host's performance data. This element will be returned only is IncludePerfSpaceDetails is set To true. It will be returned for Storage Systems only. SpaceConsumed xsd:integer
optional
Present in output only. Indicates the amount of server storage currently consumed by the performance data in bytes. This element will be returned only is IncludePerfSpaceDetails is set To true. It will be returned for Storage Systems only. SpaceProjected xsd:integer
optional
Present in output only. Indicates the Maximum amount of server storage required To store performance data in bytes. This element will be returned only is IncludePerfSpaceDetails is set To true. It will be returned for Storage Systems only.
| Element definition: ObjFullName | [top] |
Full Name of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An object full Name conforms To all the rules of an ObjName, except that the full Name may be up To 255 characters long. DFM creates full names by concatenating an object Name with any parent object names, so as To create a unique Name for an object. The format of full names is as follows:
- Host full names are the either the fully-qualified domain Name or the IP Address of the Host.
- Aggregate full names are the Host Name and the Aggregate Name, separated by a colon, e.g. Hostname:aggr0.
- Volume full names are the Host Name and the Volume Name, separated by ":/", e.g. Hostname:/volume. Note this does not include "/vol". Volume and Aggregate full names are distinguished by the presence of a forward slash after the colon.
- Qtree full names are the containing Volume full Name and the Qtree Name, separated by a slash, e.g. Hostname:/volume/qtree. The data not contained by any Qtree may be represented by "-", e.g. Hostname:/volume/-.
- Lun Path full names are either a Volume or Qtree full Name and the LUN Path, separated by a slash, e.g. Hostname:/volume/LUN or Hostname:/volume/qtree/LUN.
- Network full names are a network Address block in CIDR format, e.g. 1.2.3.0/8.
- OSSV Directory full names are the OSSV Host Name and the OSSV Path, separated by a colon, e.g. host-lnx:/usr/local or host-w2k:c:/temp
- Include any others here...
- Initiator Group full names are Host Name and the initiator Group Name, separated by a colon, e.g. Hostname:igroup.
For any DFM object not listed above, the ObjName and ObjFullName are identical.
[none]
| Element definition: ObjId | [top] |
Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI Type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed To be 0, which is interpreted as a null Value, e.g., a reference To no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed To assign an ID To an object. Therefore, an input element of Type ObjId is always used To refer To an existing object by its ID. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types.
If the Value of an ObjId input element does not Match the ID of any existing DFM object of the specified Type or types, then typically the ZAPI fails with Error code EOBJECTNOTFOUND. A ZAPI may deviate From this general rule, for example, it may return a more specific Error code. In either case, the ZAPI specification must document its behavior.
[none]
| Element definition: ObjStatus | [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'.
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.
- 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 storage system 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.
[none]
| 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: VfilerInfo | [top] |
information of a vFiler Unit. Avaiblable only if HostType is "Vfiler".
Name Type Description HostingFilerId ObjId
optional
Identifier of the hosting Filer of the vFiler Unit. HostingFilerName ObjFullName
optional
DNS Name of the hosting Filer of the vFiler Unit. VfilerAllowedProtocols ArrayOfProtocol
optional
List of allowed protocols on the vFiler Unit. VfilerIpspace xsd:string
optional
IPSpace of the vFiler Unit. VfilerMigrationInfo VfilerMigrationInfo
Migration information for the vFiler Unit. This will be returned only if the vFiler is in migrating state and if IncludeMigrationInfo is true in HostListInfoIterStart. VfilerNetworkResources ArrayOfVfilerNetworkResource
Network Interface information of a vFiler Unit.
| Element definition: ArrayOfDatasetReference | [top] |
Name Type Description DatasetReference DatasetReference[]
| Element definition: ArrayOfPerfStatusError | [top] |
Name Type Description PerfStatusError PerfStatusError[]
| Element definition: ArrayOfProtocol | [top] |
Name Type Description Protocol Protocol[]
| Element definition: ArrayOfVfilerNetworkResource | [top] |
Name Type Description VfilerNetworkResource VfilerNetworkResource[]
| Element definition: HostRoleId | [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: HostRoleName | [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: HostUsergroupId | [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: HostUsergroupName | [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: ServiceStatus | [top] |
Status indicating whether a Service is up or down.
Name Type Description Service xsd:string
optional
Indicates whether the Service is up or not. Possible Values: "up", "down".
| Element definition: Timestamp | [top] |
Seconds since 1/1/1970 in UTC. Range: [0..2^31-1].
[none]
| Element definition: VfilerMigrationInfo | [top] |
Migration information for a vFiler Unit.
Name Type Description DestinationFilerId ObjId
Database ID of the destination storage system DestinationFilerName ObjFullName
Full Name of the destination storage system DestinationVfilerId ObjId
Database ID of the destination vFiler Unit DestinationVfilerName ObjFullName
Full Name of the destination vFiler Unit MigrationStatus MigrationStatus
Migration Status of the vFiler Unit SourceFilerId ObjId
Database ID of the Source storage system SourceFilerName ObjFullName
Full Name of the Source storage system SourceVfilerId ObjId
Database ID of the Source vFiler Unit SourceVfilerName ObjFullName
Full Name of the Source vFiler Unit
| Element definition: DatasetReference | [top] |
The Name and Id of a Dataset.
Name Type Description DatasetId ObjId
Identifier for the Dataset.
Range: [1..2^31-1]DatasetName ObjName
Name of the Dataset.
| Element definition: MigrationStatus | [top] |
Migration Status for an ongoing vFiler Unit migration. Possible Values: "in_progress", "migrating", "migrated", "migrated_with_errors", "migrate_failed", "rolled_back", "rolled_back_with_errors".
[none]
| Element definition: PerfStatusError | [top] |
Possible resons for data unavailability.
Name Type Description Error xsd: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: VfilerNetworkResource | [top] |
Information about one vFiler Unit IP Address
Name Type Description InterfaceId ObjId
optional
Interface identifier To which the IP Address is bound. Present only if the IP Address is bound To an Interface InterfaceName ObjName
optional
Interface Name To which the IP Address is bound. Present only if the IP Address is bound To an Interface IpAddress IpAddress
IP Address assigned To the vFiler MtuSize xsd:integer
optional
Mtu Size for the above bounded Interface. PrefixLength xsd:integer
Mtu Size for the above bounded Interface.
| Element definition: IpAddress | [top] |
IP Address in string format. The Length of this string cannot be more than 40 characters.
[none]