Input Name	Type
HostServiceAuthorize	HostServiceAuthorize
Output Name	Type
HostServiceAuthorizeResult	HostServiceAuthorizeResult

Error Name	Description
EACCESSDENIED
EDATABASEERROR
EHS_ALREADY_AUTHORIZED
EINTERNALERROR

Configure Options in Host Service registry. Options include storage system and VCenter server credentials and DataFabric Manager server endpoints for communication.

Input Name	Type
HostServiceConfigure	HostServiceConfigure
Output Name	Type
HostServiceConfigureResult	HostServiceConfigureResult

Error Name	Description
EDATABASEERROR
EINTERNALERROR
EINVALIDINPUTERROR

Start a discovery job on the Host Service. This will refresh the virtual inventory information cached in the DataFabric Manager database.

Input Name	Type
HostServiceDiscover	HostServiceDiscover
Output Name	Type
HostServiceDiscoverResult	HostServiceDiscoverResult

Error Name	Description
EACCESSDENIED
EDATABASEERROR
EINTERNALERROR
EINVALIDINPUTERROR

Ends iteration To list registered Host Services

Input Name	Type
HostServiceListInfoIterEnd	HostServiceListInfoIterEnd
Output Name	Type
HostServiceListInfoIterEndResult	HostServiceListInfoIterEndResult

Error Name	Description
EINVALIDTAG

Get the specified Host Service Records after the call To HostServiceListInfoIterStart.

Input Name	Type
HostServiceListInfoIterNext	HostServiceListInfoIterNext
Output Name	Type
HostServiceListInfoIterNextResult	HostServiceListInfoIterNextResult

Error Name	Description
EACCESSDENIED
EDATABASEERROR
EINTERNALERROR

Start iteration To list Host Services registered with DataFabric Manager.

Input Name	Type
HostServiceListInfoIterStart	HostServiceListInfoIterStart
Output Name	Type
HostServiceListInfoIterStartResult	HostServiceListInfoIterStartResult

Error Name	Description
EACCESSDENIED
EDATABASEERROR
EINTERNALERROR

Set Host Service specific Options in DataFabric Manager database.

Input Name	Type
HostServiceModify	HostServiceModify
Output Name	Type
HostServiceModifyResult	HostServiceModifyResult

Error Name	Description
EDATABASEERROR
EINTERNALERROR
EINVALIDINPUTERROR
EOBJECTNOTFOUND

Delete a Host Service package From DataFabric Manager.

Input Name	Type
HostServicePackageDelete	HostServicePackageDelete
Output Name	Type
HostServicePackageDeleteResult	HostServicePackageDeleteResult

Error Name	Description
EACCESSDENIED
EDATABASEERROR
EINTERNALERROR

List Host Service packages in DataFabric Manager.

Input Name	Type
HostServicePackageList	HostServicePackageList
Output Name	Type
HostServicePackageListResult	HostServicePackageListResult

Error Name	Description
EACCESSDENIED
EDATABASEERROR
EINTERNALERROR

Register a new Host Service with DataFabric Manager Server. Newly deployed Host Services need To be registered and authorized in DataFabric Manager Server, this enables management of virtual server infrastructure hosted on Data ONTAP systems using Service catalogs. The registration process retrieves the SSL certificate presented by the Host Service, and sets the Host Service Status To "Pending Authorization" state. On confirming the validity of the certificate HostServiceAuthorize API must be invoked To make the Host Service operational.

Input Name	Type
HostServiceRegister	HostServiceRegister
Output Name	Type
HostServiceRegisterResult	HostServiceRegisterResult

Error Name	Description
EDATABASEERROR
EHOSTADDNOTRESOLVED
EHS_REGISTER_ERROR
EINTERNALERROR
EINVALIDINPUTERROR
EOBJECTEXISTS

Ends iteration To list storage system for a Host Service agent.

Input Name	Type
HostServiceStorageSystemListInfoIterEnd	HostServiceStorageSystemListInfoIterEnd
Output Name	Type
HostServiceStorageSystemListInfoIterEndResult	HostServiceStorageSystemListInfoIterEndResult

Error Name	Description
EINVALIDTAG

Get list of storage systems after the call To HostServiceStorageSystemListInfoIterStart.

Input Name	Type
HostServiceStorageSystemListInfoIterNext	HostServiceStorageSystemListInfoIterNext
Output Name	Type
HostServiceStorageSystemListInfoIterNextResult	HostServiceStorageSystemListInfoIterNextResult

Error Name	Description
EACCESSDENIED
EDATABASEERROR
EINTERNALERROR

List storage systems configured in the Host Service registry.

Input Name	Type
HostServiceStorageSystemListInfoIterStart	HostServiceStorageSystemListInfoIterStart
Output Name	Type
HostServiceStorageSystemListInfoIterStartResult	HostServiceStorageSystemListInfoIterStartResult

Error Name	Description
EDATABASEERROR
EINTERNALERROR
EINVALIDINPUTERROR

Un-Register a Host Service From DataFabric Manager Server. All the Virtual Server inventory Objects will will be marked as deleted once the Host Service is unregistered. The API will fail (with EHS_UNREGISTER_ERROR) in case a Virtual Machine or Datastore (in VMware case) managed by the Host Service is a member of a Dataset.

Input Name	Type
HostServiceUnregister	HostServiceUnregister
Output Name	Type
HostServiceUnregisterResult	HostServiceUnregisterResult

Error Name	Description
EDATABASEERROR
EHS_UNREGISTER_ERROR
EINTERNALERROR
EINVALIDINPUTERROR

Authorize a newly registered Host Service. Authorizing a Host Service will allow Host Service To start communicating with DataFabric Manager server, until then Host Service will not be operational. On successful authorization a baseline discovery job is initiated on the Host Service To discover the virtual server inventory information managed by Host Service. This API requires DFM.HostService.Authorize Capability on the Host Service or at global level.

Name	Type	Description
HostServiceNameOrId	ObjNameOrId	FQDN or IP Address or Object Identifier of the Host Service.
RunDiscovery	xsd:boolean optional	After authorization if discovery should be started for the HS. Default Value is true.

Name	Type	Description
JobId	xsd:integer optional	Identifier of the of job created To discover the virtual inventory information managed by the Host Service. The JobId will be returned only if RunDiscovery is true. Range: [1..2^31-1]

Configure Options in Host Service registry. Options include storage system and VCenter server credentials and DataFabric Manager server endpoints for communication.

Name	Type	Description
DfmServerIpAddress	xsd:string optional	IP Address of DataFabric Manager Server machine that the Host Service should use for communication, useful in scenarios where DataFabric Manager Server Host is configured with multiple IP addresses. If not specified, all the AF_INET Interfaces on the machine are enumerated and the first valid Address is used.
HostServiceNameOrId	ObjNameOrId	Name or Id of Host Service registered with DataFabric Manager Service on which the configuration needs To be performed.
StorageSystemsConfiguration	ArrayOfStorageSystemConfiguration optional	Configuration settings for storage systems that needs To be set on the Host Service.
VcenterIpAddress	xsd:string optional	IP Address of the VCenter server Host. If not specified, it is assumed that VCenter and Host Service are located on the same Host and IP Address of the Host Service is used.
VcenterPassword	xsd:string optional	VCenter user Password, this is required by SMVI Plugin To communicate with VCenter Server. This field is applicable only if the Host Service has SMVI Plugin.
VcenterUsername	xsd:string optional	VCenter user Name, this is required by SMVI Plugin To communicate with VCenter Server. This field is applicable only if the Host Service has SMVI Plugin.

Name	Type	Description
JobId	xsd:integer	Id of job created To configure Host Service. Range: [1..2^31-1]

Start a discovery job on the Host Service. This will refresh the virtual inventory information cached in the DataFabric Manager database.

Name	Type	Description
HostServiceNameOrId	ObjNameOrId	FQDN or IP Address or Object Identifier of the Host Service.
ResourceNameOrId	ObjNameOrId optional	If specified, the discovery Operation is performed in the context of specified virtual infrastructure object i.e only the Attributes of the Resource and its relationship with other virtual infrastructure Objects are fetched From the Host Service and updated. For example if the ResourceNameOrId is set To a specific hypervisor, then only the information associated with the hypervisor and Objects under it like the virtual machines hosted on it is retrieved and updated. Refer To ResourceType typedef Description for the list of virtual object types.
ResourceType	xsd:string optional	This field is used To specify the Type of the virtual infrastructure object specified in ResourceNameOrId. This can be used To eliminate ambiguity in case there is a clash in the object Name across different virtual infrastructure object types.
TrackProgress	xsd:boolean optional	If 'true', then a JobId is returned To track progress of discovery Operation, useful when the discovery Operation is initiated by a user. This field is set To false when invoked by Host Service when performing discovery in the background. Default Value: true

Name	Type	Description
JobId	xsd:integer optional	Id of job created To discover resources, returned only if TrackProgress is 'true'. Range: [1..2^31-1]

Ends iteration To list registered Host Services

Name	Type	Description
Tag	xsd:string	Tag From a previous HostServiceListInfoIterStart.

[none]

Get the specified Host Service Records after the call To HostServiceListInfoIterStart.

Name	Type	Description
Maximum	xsd:integer	Maximum number of Records To be received. Range: [1..2^31-1]
Tag	xsd:string	Tag From a previous host-service-list-info--start

Name	Type	Description
HostServices	ArrayOfHostServiceInfo	List of Host services
Records	xsd:integer	The number of Records actually returned. Range: [1..2^31-1]

Start iteration To list Host Services registered with DataFabric Manager.

Name	Type	Description
IncludeDeleted	xsd:boolean optional	If present and true, Host Services marked as deleted in the database are also returned. A Host Service is marked as deleted when it is un-registered From DataFabric Manager. Default Value : false.
ObjNameOrId	ObjNameOrId optional	Name or Identifier of the object for which the Host services need To be listed. The allowed object types for this arguement are: Resource Group Host Service

Name	Type	Description
Records	xsd:integer	Number of Records available in the list. Range: [1..2^31-1]
Tag	xsd:string	Tag To be used for subsequent iteration calls.

Set Host Service specific Options in DataFabric Manager database.

Name	Type	Description
AccessProtocol	xsd:string optional	Communication Protocol used To access the Host Service. Possible Values : 'http', 'https'
AdminPort	xsd:integer optional	Port number that administrative services of Host Service are bound To. Range: [1..2^31-1]
HostServiceNameOrId	ObjNameOrId	Name or Identifier of Host Service.
IpAddress	IpAddress optional	IP Address used To access Host Service.
MgmtPort	xsd:integer optional	Port number that management services of Host Service are bound To. Range: [1..2^31-1]
UpdateServicePort	xsd:integer optional	Port number that update Service is bound To. Range: [1..2^31-1]

[none]

Delete a Host Service package From DataFabric Manager.

Name	Type	Description
PackageNameOrId	ObjNameOrId	Name or Id of the package.

[none]

List Host Service packages in DataFabric Manager.

Name	Type	Description
PackageNameOrId	ObjNameOrId optional	Name or Id of the package.

Name	Type	Description
HostServicePackages	ArrayOfHostServicePackageInfo	List of Host Service packages in DataFabric Manager.

Register a new Host Service with DataFabric Manager Server. Newly deployed Host Services need To be registered and authorized in DataFabric Manager Server, this enables management of virtual server infrastructure hosted on Data ONTAP systems using Service catalogs. The registration process retrieves the SSL certificate presented by the Host Service, and sets the Host Service Status To "Pending Authorization" state. On confirming the validity of the certificate HostServiceAuthorize API must be invoked To make the Host Service operational.

Name	Type	Description
AdminPort	xsd:integer optional	Admin port configured for the Host Service. DataFabric Manager tries To establish SSL connection on this port To fetch the Host Service SSL certificate. Default Value : 8699
DfmServerIpAddress	IpAddress optional	IP Address of the DataFabric Manager Server Host. The Host Service will communicate with Datafabric Manager Server over this IP Address.
MgmtPort	xsd:integer optional	Management port of the Host Service agent. Default Value : 8799
NameOrIpAddress	xsd:string	FQDN or the IP Address of the Host Service machine.
SuppressRegisteredError	xsd:boolean optional	If set To true, the EOBJECTEXISTS Error Condition is suppressed and identifier assigned To existing Host Service is returned in HostServiceId element. Default Value : false.

Name	Type	Description
HostServiceId	ObjId	Object identifier assigned To the registered Host Service.
IsAuthorized	xsd:boolean	If Host Service is authorized To access DataFabric Manager services, this will be true.
IsHypervClusterHostService	xsd:boolean	true, if the Host Service manages the virtual machines in Hyper-V cluster.

Ends iteration To list storage system for a Host Service agent.

Name	Type	Description
Tag	xsd:string	Tag From a previous HostServiceStorageSystemListInfoIterStart.

[none]

Get list of storage systems after the call To HostServiceStorageSystemListInfoIterStart.

Name	Type	Description
Maximum	xsd:integer	The index of the last record To be received Range: [1..2^31-1]
Tag	xsd:string	Tag From a previous call To HostServiceStorageSystemListInfoIterStart

Name	Type	Description
Records	xsd:integer	The number of Records actually returned. Range: [1..2^31-1]
StorageSystems	ArrayOfStorageSystemInfo	List of storage systems that are present in the given Host Service's configuration.

List storage systems configured in the Host Service registry.

Name	Type	Description
HostServiceNameOrId	ObjNameOrId	Name or Id of the Host Service registered with DataFabric Manager Service.

Name	Type	Description
Records	xsd:integer	Number of Records available in the list Range: [1..2^31-1]
Tag	xsd:string	Tag To be used for subsequent iteration calls.

Un-Register a Host Service From DataFabric Manager Server. All the Virtual Server inventory Objects will will be marked as deleted once the Host Service is unregistered. The API will fail (with EHS_UNREGISTER_ERROR) in case a Virtual Machine or Datastore (in VMware case) managed by the Host Service is a member of a Dataset.

Name	Type	Description
Force	xsd:boolean optional	If true, the Operation will proceed even if there are Datasets configured with virtual machines managed by the Host Service. After un-registration the virtual machines will not show up as Dataset Members. The Host Service can be registered back with HostServiceRegister API, the virtual machines would then show up again as Dataset Members. Default Value is false.
HostServiceNameOrId	ObjNameOrId	Name or Object Id or IP Address of the Host Service.

[none]

Name	Type	Description
HostServiceInfo	HostServiceInfo[]

Name	Type	Description
HostServicePackageInfo	HostServicePackageInfo[]

Name	Type	Description
StorageSystemConfiguration	StorageSystemConfiguration[]

Name	Type	Description
StorageSystemInfo	StorageSystemInfo[]

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

[none]

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]

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

[none]

Information about a Host Service.

Name	Type	Description
AdminPort	xsd:integer	Admin port of the Host Service. Range: [1..2^31-1]
DeletedBy	xsd:string	The user who deleted the Host Service.
DeletedTimestamp	xsd:integer	The time and date when the Host Service was deleted. Range: [1..2^64-1]
HostServiceId	ObjId	Object Identifier of the Host Service.
HostServiceIpAddress	xsd:string	IP Address of the Host where Host Service is installed
HostServiceName	xsd:string	FQDN Address of the Host where Host Service is installed
HostServicePlugins	ArrayOfHostServicePluginInfo	plugins information configured on the Host Service
HostServiceStatus	xsd:string	Status of the Host Service. Valid Values are : 'up', 'down' and 'unknown'.
HostServiceVersion	xsd:string	Host Service Version
IsAuthorized	xsd:boolean	Indicates if Host Service registration authorized. false Value indicates that the Host Service is registered but not yet authorized by the Dafabric Manager administrator. All the operations on Host Service like dicovery, configuration, backup and restore of virtual machine data are not allowed until the Host Service is authorized.
LastDiscoveryStatus	xsd:string	Status of the last discovery Operation performed on the Host Service. Valid Values are : 'unknown','failed', and 'ok'
MgmtPort	xsd:integer	Management port of the Host Service. Range: [1..2^31-1]
NeedsUpgrade	xsd:string	Valid Values are : 'unknown', 'yes','no', and 'running' 'yes' if a new Version of Host Service package is registered with DataFabric Manager server and the current Version of the Host Service is older than the newly registered Host Service package. 'unknown': if the upgrade required Status can not be determined 'no': if there are no later packages added To DFM 'running' : if an upgrade is already in progress
TimezoneInfo	TimezoneInfo	Timezone of the Host, where the Host Service is installed. Returns an empty string, if Host Service does not return valid Timezone. Currently valid time zones can be listed by TimezoneListInfoIterStart.
UpdateServicePort	xsd:integer	Port number on which update Service is running. Range: [1..2^31-1]
UpdateServiceVersion	xsd:string	Version of the update Service.

Information about Host Service package.

Name	Type	Description
PackageId	xsd:integer	Object Id of Host Service package.
PackageName	xsd:string	Name of the Host Service package.
PackageVersion	xsd:string	Version of the package.

storage system configuration.

Name	Type	Description
LoginProtocol	xsd:string optional	Protocol that Host Service needs To use when calling ONTAP APIs on the storage systems. Value Values are 'http', 'https' and 'rpc'. If not specified, Default is 'https'.
PushCredentials	xsd:boolean	Push credentials stored in DataFabric Manager database To the Host Service.
StorageSystemNameOrId	ObjNameOrId	Name or Id of the storage system.

Information about a storage system.

Name	Type	Description
AccessProtocol	xsd:string optional	Protocol used by Host Service To communicate with the storage system. Valid Values are : http, https, rpc
LoginStatusFromDfm	xsd:string optional	Indicates if DFM has the valid credentials for storage system. Possible Values are : 'good', 'bad', 'unknown'.
LoginStatusFromHs	xsd:string optional	Indicates if Host Service has the valid credentials for storage system. Possible Values are : 'good', 'bad', 'unknown'.
NdmpCredStatusFromDfm	xsd:string optional	Indicates if DFM has the valid NDMP credential for storage system. Possible Values are : 'good', 'bad', 'unknown'.
NdmpUsername	xsd:string optional	ndmp Username.
StorageSystemId	ObjId	Object Identifier of the storage system in DataFabric Manager.
StorageSystemIpAddress	xsd:string optional	IP Address of the storage system.
StorageSystemName	ObjName optional	Name of the storage system.
StorageSystemStatus	xsd:string optional	Status of storage system. Possbile valus are 'up', 'down', 'unknown'.
StorageSystemType	xsd:string optional	storage system Type. Possbile valus are 'Filer', 'Vfiler', 'unknown'.
StorageSystemUsername	xsd:string optional	login Name in case of 'Filer'.

Name	Type	Description
HostServicePluginInfo	HostServicePluginInfo[]

Name of a DFM object. This typedef is an alias for the built in ZAPI Type string. An object Name must conform To the following format: It must contain between 1 and 64 characters. It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9'). In some contexts, a Name may be the empty string (""), which is interpreted as a null Value, e.g., a reference To no object at all. The behavior of a ZAPI when it encounters an Error involving an ObjName input element depends on how the ZAPI uses the input element. Here are the general rules: If the input Name element is used To create a new object with the given Name, or rename an existing object To that Name, and the Name does not conform To the above format, then the ZAPI fails with Error code EINVALIDINPUTERROR. Note that because EINVALIDINPUTERROR is such a common Error code, ZAPI specifications are not required To document cases when they may return it. If the input Name element is used To refer To an existing object with that Name, and there is no object with that Name, then the ZAPI fails with Error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this Error code. A ZAPI may deviate From these general rules, for example, it may return more specific Error codes. In such cases, the ZAPI specification must document its behavior. If an input Name element is used To refer To an existing object, then the ZAPI specification must specify which DFM object Type (e.g. data set, Host, DP Policy, etc.) is allowed. Some ZAPIs allow the object To be one of several different types. See the Description of ObjFullName for examples of valid input formats. Note that there is no requirement that all object names must be unique. However, the names for some specific types of Objects are constrained such that no two Objects of that Type may have the same Name. For example, this constraint applies To Datasets, DP schedules, and DP policies. This means that no two Datasets may have the same Name, but a Dataset may have the same Name as a DP schedule or DP Policy. In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered To be the same Name for purposes of: creating new Objects, renaming existing Objects, or looking up an object by Name. On the other hand, ZAPIs that return an ObjName generally do not change the capitalization at all. For example, if an object's Name has been set To "MyObject", then list iteration ZAPIs that return the object's Name return it as "MyObject" rather than "MYOBJECT" or "myobject". ZAPIs that operate on ObjName Values and do not follow these general rules about case sensitivity must document the rules that they do follow. One important exception To these general rules is that Volumes, Qtrees, OSSV Directories, SRM Paths, Interfaces, FCP Targets and FC switch ports all have case-sensitive names. When looking up Objects of these types by Name, the case must Match the object Name.

[none]

Information about a time zone.

Name	Type	Description
TimezoneName	xsd:string	Name of time zone.

Name	Type	Description
PluginType	xsd:string	Type of Host Service Plugin.
PluginVersion	xsd:string	Version of the Host Service Plugin.