Input Name	Range	Type	Description
tag		string	Tag from a previous vi-datacenter-list-info-iter-start.

Errno	Description
EINVALIDTAG

Get the list of Data Center records.

Input Name	Range	Type	Description
maximum		integer	The maximum number of records to retrieve. Range: [1..2^31-1].
tag		string	Tag from a previous vi-datacenter-list-info-iter-start
Output Name	Range	Type	Description
datacenters		datacenter[]	List of Data Centers.
records		integer	The number of records actually returned. Range: [1..2^31-1].

Errno	Description
EINVALIDTAG
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EINTERNALERROR
EACCESSDENIED

List Data Centers discovered in DataFabric Manager Server.

Input Name	Range	Type	Description
include-deleted		boolean validate optional	If present and true, Data Centers marked as deleted in the database are also returned. Data Centers are marked as deleted if they are destroyed from the Virtual Center Server.
is-unprotected		boolean optional	If present and true, members which are unprotected, are returned, which means they are not present in any dataset, having an application policy. If false, or not specified, list all Data Centers.
obj-name-or-id		obj-name-or-id optional	Object for which the list of Data Centers need to be retrieved. If the obj-name-or-id is not specified then all the Data Centers are returned. The valid types of object that can be specified here are :- Virtual Center Data Center Dataset Resource Group
Output Name	Range	Type	Description
records		integer	Number of entities available in the list. Range: [0..2^31-1]
tag		string	Tag to be used for subsequent iteration calls.

Errno	Description
EINVALIDTAG
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EINTERNALERROR
EACCESSDENIED

Ends iteration to list datastores

Input Name	Range	Type	Description
tag		string	Tag from a previous vi-datastore-list-info-iter-start.

Errno	Description
EINVALIDTAG

Get the list of Datastore records.

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve. Range: [1..2^31-1]
tag		string	Tag from a previous vi-datastore-list-info-iter-start
Output Name	Range	Type	Description
datastores		datastore[]	List of Datastores.
records		integer	The number of records actually returned. Range: [1..2^31-1]

Errno	Description
EINVALIDTAG
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EINTERNALERROR
EACCESSDENIED

List Datastores discovered in DataFabric Manager Server.

Input Name	Range	Type	Description
include-deleted		boolean validate optional	If present and true, Datastores marked as deleted in the database are also returned. Datastores are marked as deleted if they are destroyed from the ESX Server.
is-unprotected		boolean optional	If present and true, members which are unprotected, are returned, which means they are not present in any dataset, having an application policy. If false or not specified, list all Datastores.
obj-name-or-id		obj-name-or-id optional	Object for which the list of Datastores needs to be retrieved. If the obj-name-or-id is not specified, then all the Datastores are returned. The valid types of object that be specified here are :- Virtual Center Data Center Virtual Machine ESX server Dataset
Output Name	Range	Type	Description
records		integer	Number of entities available in the list. Range: [0..2^31-1]
tag		string	Tag to be used for subsequent iteration calls.

Errno	Description
EINVALIDTAG
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EINTERNALERROR
EACCESSDENIED

Ends iteration to list hypervisors.

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

Errno	Description
EINVALIDTAG

Get the list of Hypervisor records.

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve. Range: [1..2^31-1]
tag		string	Tag from a previous call to vi-hypervisor-list-info-iter-start.
Output Name	Range	Type	Description
hypervisors		hypervisor-info[]	List of Hypervisors.
records		integer	The number of records actually returned. Range: [1..2^31-1]

Errno	Description
EINVALIDTAG

Start iteration of Hypervisors discovered in DataFabric Manager server.

Input Name	Range	Type	Description
include-deleted		boolean validate optional	If present and true, hypervisors which are marked as deleted in the database are also returned. Hypervisors are marked as deleted if they are no longer managed by the Host Service (for example decommissioned Hypervisors).
obj-name-or-id		obj-name-or-id optional	Name or identifier of an object for which the list of hypervisors need to be retrieved. The valid type for object are :- Virtual Center Data Center Hypervisor Datastore Virtual Machine Dataset Resource Group If the obj-name-or-id is not specified, then all the hypervisors are returned.
virtual-infrastructure-type		virtual-infrastructure-type optional	Input filter for virtual server infrastructure type. If specified, only the hypervisors of the specified infrastructure type are listed.
Output Name	Range	Type	Description
records		integer	Number of entities available in the list. Range: [0..2^31-1]
tag		string	Tag to be used for subsequent iteration calls.

Errno	Description
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EACCESSDENIED
EDATABASEERROR
EINTERNALERROR

Ends iteration to list Virtual Centers.

Input Name	Range	Type	Description
tag		string	Tag from a previous vi-virtual-center-list-info-iter-start.

Errno	Description
EINVALIDTAG

Get list of Virtual Center records..

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve. Range: [1..2^31-1]
tag		string	Tag from a previous vi-virtual-center-list-info-iter-start
Output Name	Range	Type	Description
records		integer	The number of records actually returned. Range: [1..2^31-1]
virtual-centers		virtual-center[]	List of Virtual Center records.

Errno	Description
EINVALIDTAG
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EINTERNALERROR
EACCESSDENIED

List Virtual Center Servers discovered in DataFabric Manager Server.

Input Name	Range	Type	Description
include-deleted		boolean validate optional	If present and true, Virtual Centers marked as deleted in the database are also returned. Virtual Centers are marked deleted if they are disassociated from the Host Service at which point the Host Service stops Managing the resources of Virtual Center.
obj-name-or-id		obj-name-or-id optional	Name or Id of the Virtual Center Server or a Resource Group. If not specified, then all the Virtual Centers will be returned.
Output Name	Range	Type	Description
records		integer	Number of entities available in the list. Range: [0..2^31-1]
tag		string	Tag to be used for subsequent iteration calls.

Errno	Description
EINVALIDTAG
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EINTERNALERROR
EACCESSDENIED

Ends iteration to list virtual disks

Input Name	Range	Type	Description
tag		string	Tag from a previous vi-virtual-disk-list-info-iter-start.

Errno	Description
EINVALIDTAG

Get the list of Virtual Disk records.

Input Name	Range	Type	Description
maximum		integer	The maximum number of records to retrieve. Range: [1..2^31-1]
tag		string	Tag from a previous vi-virtual-disk-list-info-iter-start
Output Name	Range	Type	Description
records		integer	The number of records actually returned. Range: [1..2^31-1]
virtual-disks		virtual-disk[]	List of Virtual Disks records.

Errno	Description
EINVALIDTAG
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EINTERNALERROR
EACCESSDENIED

List Virtual Disks discovered in DataFabric Manager Server.

Input Name	Range	Type	Description
include-deleted		boolean validate optional	If present and true, Virtual Disks marked as deleted in the database are also returned. Virtual Disks are marked deleted if they are delete from the Virtual Machine.
obj-name-or-id		obj-name-or-id optional	Name or identifier of an object for which list of Virtual Disks need to be retrieved. The type of object are :- Virtual Center Data Center Hypervisor Virtual Machine Dataset Resource Group If the obj-name-or-id is not specified, all the Virtual Machines discovered are returned.
Output Name	Range	Type	Description
records		integer	Number of entities available in the list Range: [0..2^31-1]
tag		string	Tag to be used for subsequent iteration calls.

Errno	Description
EINVALIDTAG
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EINTERNALERROR
EACCESSDENIED

Ends iteration to list Virtual Machines.

Input Name	Range	Type	Description
tag		string	Tag from a previous vi-virtual-machine-list-info-iter-start.

Errno	Description
EINVALIDTAG

Get the list of virtual machines records.

Input Name	Range	Type	Description
maximum		integer	The maximum number of entries to retrieve. Range: [1..2^31-1]
tag		string	Tag from a previous call to vi-virtual-machine-list-info-iter-start
Output Name	Range	Type	Description
records		integer	The number of records actually returned. Range: [1..2^31-1]
virtual-machines		virtual-machine[]	List of Virtual Machines retrieved.

Errno	Description
EINVALIDTAG
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EINTERNALERROR
EACCESSDENIED

Start iteration of Virtual Machines discovered in DataFabric Manager server.

Input Name	Range	Type	Description
include-deleted		boolean validate optional	If present and true, Virtual Machines marked as deleted in the database are also returned. Virtual Machines are marked deleted if they no longer exist on the Hypervisor managed by the Host Service.
is-unprotected		boolean optional	If present and true, members which are unprotected are returned, which means they are not present in any dataset, having an application policy. If false or not specified, list all virtual machines.
obj-name-or-id		obj-name-or-id optional	Name or identifier of an object for which list of Virtual Machines need to be retrieved. If the obj-name-or-id is not specified, all the virtual machines are returned. The possible types are :- Virtual Center Data Center Datastore HyperVisor Dataset Resource Group
virtual-infrastructure-type		virtual-infrastructure-type optional	Input filter for virtual server infrastructure type. If specified, only the Virtual Machines of the specified virtual server infrastructure type are listed.
Output Name	Range	Type	Description
records		integer	Number of records available in the list. Range: [0..2^31-1]
tag		string	Tag to be used for subsequent iteration calls.

Errno	Description
EINVALIDTAG
EOBJECTAMBIGUOUS
EOBJECTNOTFOUND
EDATABASEERROR
EINTERNALERROR
EACCESSDENIED

Information about a Data Center.

Name	Range	Type	Description
datacenter-id		obj-id	Object Id of the Data Center.
datacenter-name		obj-name	Name of the Data Center.
datasets		dataset-reference[]	List of the datasets that the data center belongs to.
deleted-by		string optional	The user who deleted the Data Center. This element is present only if the Data Center is deleted and include-deleted is passed as true when starting the iteration.
deleted-timestamp		dp-timestamp optional	The time and date when the Data Center was marked as deleted in DataFabric Manager. This element is present only if the Data Center is deleted and include-deleted is passed as true when starting the iteration.
host-service-id		obj-id	Object id of the Host Service that manages the Data Center.
is-protected		boolean	true, if Data Center is protected.
virtual-center-reference		virtual-center-reference	Information about the Virtual Center Server to which the Data Center belongs to.

Information about a Datastore.

Name	Range	Type	Description
allocated-capacity		integer	Allocated capacity in bytes (i.e size) for the Datastore Range: [0..2^64-1]
datacenter-reference		datacenter-reference	Information of the Datacenter to which the Datastore belongs to.
datasets		dataset-reference[]	List of the datasets that the datastore belongs to.
datastore-id		obj-id	Object identifier of the Datastore.
datastore-name		obj-name	Name of the Datastore.
datastore-on-ontap		boolean	true, if backing storage for Datastore is hosted on Data ONTAP system.
datastore-type		string	Type of the Datastore. The possible types are :- vmfs nfs
deleted-by		string optional	The user who deleted marked the Datastore as deleted. This element is present only if the Datastore is deleted and include-deleted is passed as true when starting the iteration.
deleted-timestamp		dp-timestamp optional	The time and date when Datastore was marked as deleted in DataFabric Manager server. This element is present only if the Datastore is deleted and include-deleted is passed as true when starting the iteration.
host-service-id		obj-id	Id for the Host Service that manages the Datastore.
is-protected		boolean	true, if Datastore is protected.
nfs-export-path		string optional	File system path on Data ONTAP storage system on which the NFS export is created. Applicable only if the Datastore is of type NFS.
used-capacity		integer	Used capacity in bytes for the Datastore Range: [0..2^64-1]
virtual-center-reference		virtual-center-reference	Information on Virtual Center to which the Datastore belongs to.

Information about a Hypervisor.

Name	Range	Type	Description
datacenter-reference		datacenter-reference optional	Information of Data Center to which the hypervisor belongs to. Applicable only in case the virtual-infrastructure-type is 'VMwareManagement'.
deleted-by		string optional	The user who marked the Hypervisor as deleted. This element is present only if the Hypervisor is deleted and include-deleted is passed as true when starting the iteration.
deleted-timestamp		dp-timestamp optional	The time and date when the Hypervisor was marked as deleted in DataFabric Manager Server. This element is present only if the Hypervisor is deleted and include-deleted is passed as true when starting the iteration.
domain-name		string optional	Name of the windows domain/workgroup to which the HyperVisor belongs to, applicable only in case the virtual-infrastructure-type is 'HyperVManagement'.
host-service-id		obj-id	Object identifier of the Host Service that manages the Hypervisor.
hypervisor-id		obj-id	Object Identifier for the hypervisor in DataFabric Manager Server.
hypervisor-name		obj-name	Name of the hypervisor.
ip-address		ip-address	IP Address of the hypervisor.
virtual-center-reference		virtual-center-reference optional	Information of the Virtual Center to which the hypervisor belongs to. Applicable only in case the virtual-infrastructure-type is 'VMwareManagement'.
virtual-infrastructure-type		virtual-infrastructure-type	Type of the virtual server infrastructure the Hypervisor belongs to.

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

[none]

Virtual Center information.

Name	Range	Type	Description
deleted-by		string optional	The user who deleted the Virtual Center object. Present only if include-deleted input field is specified when starting the iteration and the Virtual Center is deleted.
deleted-timestamp		dp-timestamp optional	The time and date when Virtual Center object was deleted. Present only if include-deleted input field is specified when starting the iteration and the Virtual Center is deleted.
host-service-id		obj-id	Object identifier of the Host Service managing the Virtual Center Server.
virtual-center-id		obj-id	Object Id of the Virtual Center.
virtual-center-name		obj-name	Name of the Virtual Center.

Information about Virtual Disk.

Name	Range	Type	Description
datastore-id		obj-id optional	Object Id of the Object Datastore in which the Virtual Disk resides. This is applicable only if the virtual-infrastructure-type is 'VMwareManagement'. This element is deprecated, use datastore-reference instead.
datastore-name		obj-name optional	Object name of the Datastore in which the Virtual Disk resides. This is applicable only if the virtual-infrastructure-type is 'VMwareManagement'. This element is deprecated, use datastore-reference instead.
datastore-reference		datastore-reference optional	Information of the datastore object on which the virtual disk resides. This is applicable only if the virtual-infrastructure-type is 'VMwareManagement'.
deleted-by		string optional	The user who deleted the Virtual Disk. This element is present only if the Virtual Disk is deleted and include-deleted is passed as true when starting the iteration.
deleted-timestamp		dp-timestamp optional	The time and date when the Virtual Disk was deleted. This element is present only if the Virtual Disk is deleted and include-deleted is passed as true when starting the iteration.
host-service-id		obj-id	Identifier of the Host Service managing Virtual Disk (i.e the Host Service that managed the Virtual Machine to which the Virtual Disk is assigned).
vhd-type		string optional	Indicated the type of Virtual Disk. If the virtual-infrastructure-type is 'HyperVManagement' the possible values are : passthrough cluster_shared_volume boot_disk regular If the virtual-infrastructure-type is 'VMwareManagement' the possible values are : raw_device_mapping regular
virtual-disk-id		obj-id	Object id for the Virtual Disk.
virtual-disk-name		obj-name	Name for the Virtual Disk.
virtual-infrastructure-type		virtual-infrastructure-type	Type of virtual infrastructure the Virtual Disk belongs to.
virtual-machine-id		obj-id	Object Id of the Virtual Machine to which this Virtual Disk is assigned. This element is deprecated, use virtual-machine-reference instead.
virtual-machine-name		obj-name	Object Name of the Virtual Machine to which this Virtual Disk is assigned. This element is deprecated, use virtual-machine-reference instead.
virtual-machine-reference		virtual-machine-reference optional	Information of virtual machine object to which the virtual disk is assigned.

Type of virtual infrastructure. The possible values are :- VMwareManagement HyperVManagement

[none]

Information about a Virtual Machine.

Name	Range	Type	Description
datacenter-reference		datacenter-reference optional	Information of the Data Center to which the Virtual Machine is member of in VMware Virtual Center Server. Applicable only in case the virtual-infrastructure-type is 'VMwareManagement'.
datasets		dataset-reference[]	List of datasets that has this Virtual Machine as a member.
deleted-by		string optional	The user who deleted the Virtual Machine. Returned only if include-deleted input element value is true and the Virtual Machine is deleted.
deleted-timestamp		dp-timestamp optional	The time and date when the Virtual Machine was marked as deleted. Returned only if include-deleted input element value is true and the Virtual Machine is deleted.
dns-name		string	FQDN configured for the Virtual Machine.
guest-os-type		string optional	Guest OS type running inside the Virtual Machine.
host-service-id		obj-id	Identifier of the Host Service managing the Virtual Machine.
hypervisor-reference		hypervisor-reference	Information of Hypervisor (ESX Server or Hyper-V Parent partition) on which the Virtual Machine is hosted.
ip-address-list		ip-address[] optional	List of IP addresses configured on the Virtual Machine.
is-protected		boolean	true, if Virtual Machine is protected.
status		string	Indicates the operational state of the Virtual Machine (i.e if Virtual Machine is powered on or not). Valid values are 'on', 'off' or 'unknown'.
virtual-center-reference		virtual-center-reference optional	Information of Virtual Center Server which manages the Virtual Machine. Applicable only in case the virtual-infrastructure-type is 'VMwareManagement'.
virtual-infrastructure-type		virtual-infrastructure-type	Type of virtual infrastructure the virtual machine belongs to.
virtual-machine-id		obj-id	Object id for the virtual machine.
virtual-machine-name		obj-name	Name of the virtual machine, this is the name that virtual server administrator specifies when creating Virtual Machine in virtual server management tools like VMware VCenter Server or Microsoft Hyper-V Virtual Machine Manager.

Information about a hypervisor.

Name	Range	Type	Description
datacenter-id		obj-id	Object Identifier of the Data Center.
datacenter-name		obj-name	Name of the Data Center.

The name and id of a dataset.

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

Name and object identifier of the datastore object.

Name	Range	Type	Description
datastore-id		obj-id optional	Object Id of the Object Datastore in which the Virtual Disk resides.
datastore-name		obj-name optional	Object name of the Datastore in which the Virtual Disk resides.

Seconds since 1/1/1970 in UTC. Range: [0..2^31-1]. This runs out in 2036, so update the API some time before then.

[none]

Information about a hypervisor.

Name	Range	Type	Description
hypervisor-id		obj-id	Object Identifier of the Hypervisor.
hypervisor-name		obj-name	Name of the Hypervisor.

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 obj-id is always used to refer to an existing object by its ID. The ZAPI must specify the object's DFM object type (e.g. dataset, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the value of an obj-id input element does not match the ID of any existing DFM object of the specified type or types, then typically the ZAPI fails with error code EOBJECTNOTFOUND. A ZAPI may deviate from this general rule, for example, it may return a more specific error code. In either case, the ZAPI specification must document its behavior.

[none]

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

[none]

Information about a hypervisor.

Name	Range	Type	Description
virtual-center-id		obj-id	Object Identifier of the Virtual Center.
virtual-center-name		obj-name	Name of the Virtual Center.

Type of virtual infrastructure. The possible values are :- VMwareManagement HyperVManagement

[none]

Name and object identifier of the virtual machine object.

Name	Range	Type	Description
virtual-machine-id		obj-id	Object id of the Virtual Machine to which this Virtual Disk is assigned.
virtual-machine-name		obj-name	Object name of the Virtual Machine to which this Virtual Disk is assigned.

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

[none]

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

[none]