|
APIs in Category: VirtualInfrastructure |
API version 5.0 |
| ViDatacenterListInfoIterEnd (supported) | [top] |
Ends iteration To list Data Centers.
Input Name Type ViDatacenterListInfoIterEnd ViDatacenterListInfoIterEnd
Output Name Type ViDatacenterListInfoIterEndResult ViDatacenterListInfoIterEndResult
Error Name Description EINVALIDTAG
| ViDatacenterListInfoIterNext (supported) | [top] |
Get the list of Data Center Records.
Input Name Type ViDatacenterListInfoIterNext ViDatacenterListInfoIterNext
Output Name Type ViDatacenterListInfoIterNextResult ViDatacenterListInfoIterNextResult
Error Name Description EACCESSDENIED EDATABASEERROR EINTERNALERROR EINVALIDTAG EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| ViDatacenterListInfoIterStart (supported) | [top] |
List Data Centers discovered in DataFabric Manager Server.
Input Name Type ViDatacenterListInfoIterStart ViDatacenterListInfoIterStart
Output Name Type ViDatacenterListInfoIterStartResult ViDatacenterListInfoIterStartResult
Error Name Description EACCESSDENIED EDATABASEERROR EINTERNALERROR EINVALIDTAG EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| ViDatastoreListInfoIterEnd (supported) | [top] |
Ends iteration To list Datastores
Input Name Type ViDatastoreListInfoIterEnd ViDatastoreListInfoIterEnd
Output Name Type ViDatastoreListInfoIterEndResult ViDatastoreListInfoIterEndResult
Error Name Description EINVALIDTAG
| ViDatastoreListInfoIterNext (supported) | [top] |
Get the list of Datastore Records.
Input Name Type ViDatastoreListInfoIterNext ViDatastoreListInfoIterNext
Output Name Type ViDatastoreListInfoIterNextResult ViDatastoreListInfoIterNextResult
Error Name Description EACCESSDENIED EDATABASEERROR EINTERNALERROR EINVALIDTAG EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| ViDatastoreListInfoIterStart (supported) | [top] |
List Datastores discovered in DataFabric Manager Server.
Input Name Type ViDatastoreListInfoIterStart ViDatastoreListInfoIterStart
Output Name Type ViDatastoreListInfoIterStartResult ViDatastoreListInfoIterStartResult
Error Name Description EACCESSDENIED EDATABASEERROR EINTERNALERROR EINVALIDTAG EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| ViHypervisorListInfoIterEnd (supported) | [top] |
Ends iteration To list Hypervisors.
Input Name Type ViHypervisorListInfoIterEnd ViHypervisorListInfoIterEnd
Output Name Type ViHypervisorListInfoIterEndResult ViHypervisorListInfoIterEndResult
Error Name Description EINVALIDTAG
| ViHypervisorListInfoIterNext (supported) | [top] |
Get the list of Hypervisor Records.
Input Name Type ViHypervisorListInfoIterNext ViHypervisorListInfoIterNext
Output Name Type ViHypervisorListInfoIterNextResult ViHypervisorListInfoIterNextResult
Error Name Description EINVALIDTAG
| ViHypervisorListInfoIterStart (supported) | [top] |
Start iteration of Hypervisors discovered in DataFabric Manager server.
Input Name Type ViHypervisorListInfoIterStart ViHypervisorListInfoIterStart
Output Name Type ViHypervisorListInfoIterStartResult ViHypervisorListInfoIterStartResult
Error Name Description EACCESSDENIED EDATABASEERROR EINTERNALERROR EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| ViVirtualCenterListInfoIterEnd (supported) | [top] |
Ends iteration To list Virtual Centers.
Input Name Type ViVirtualCenterListInfoIterEnd ViVirtualCenterListInfoIterEnd
Output Name Type ViVirtualCenterListInfoIterEndResult ViVirtualCenterListInfoIterEndResult
Error Name Description EINVALIDTAG
| ViVirtualCenterListInfoIterNext (supported) | [top] |
Get list of Virtual Center Records..
Input Name Type ViVirtualCenterListInfoIterNext ViVirtualCenterListInfoIterNext
Output Name Type ViVirtualCenterListInfoIterNextResult ViVirtualCenterListInfoIterNextResult
Error Name Description EACCESSDENIED EDATABASEERROR EINTERNALERROR EINVALIDTAG EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| ViVirtualCenterListInfoIterStart (supported) | [top] |
List Virtual Center Servers discovered in DataFabric Manager Server.
Input Name Type ViVirtualCenterListInfoIterStart ViVirtualCenterListInfoIterStart
Output Name Type ViVirtualCenterListInfoIterStartResult ViVirtualCenterListInfoIterStartResult
Error Name Description EACCESSDENIED EDATABASEERROR EINTERNALERROR EINVALIDTAG EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| ViVirtualDiskListInfoIterEnd (supported) | [top] |
Ends iteration To list virtual Disks
Input Name Type ViVirtualDiskListInfoIterEnd ViVirtualDiskListInfoIterEnd
Output Name Type ViVirtualDiskListInfoIterEndResult ViVirtualDiskListInfoIterEndResult
Error Name Description EINVALIDTAG
| ViVirtualDiskListInfoIterNext (supported) | [top] |
Get the list of Virtual Disk Records.
Input Name Type ViVirtualDiskListInfoIterNext ViVirtualDiskListInfoIterNext
Output Name Type ViVirtualDiskListInfoIterNextResult ViVirtualDiskListInfoIterNextResult
Error Name Description EACCESSDENIED EDATABASEERROR EINTERNALERROR EINVALIDTAG EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| ViVirtualDiskListInfoIterStart (supported) | [top] |
List Virtual Disks discovered in DataFabric Manager Server.
Input Name Type ViVirtualDiskListInfoIterStart ViVirtualDiskListInfoIterStart
Output Name Type ViVirtualDiskListInfoIterStartResult ViVirtualDiskListInfoIterStartResult
Error Name Description EACCESSDENIED EDATABASEERROR EINTERNALERROR EINVALIDTAG EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| ViVirtualMachineListInfoIterEnd (supported) | [top] |
Ends iteration To list Virtual Machines.
Input Name Type ViVirtualMachineListInfoIterEnd ViVirtualMachineListInfoIterEnd
Output Name Type ViVirtualMachineListInfoIterEndResult ViVirtualMachineListInfoIterEndResult
Error Name Description EINVALIDTAG
| ViVirtualMachineListInfoIterNext (supported) | [top] |
Get the list of virtual machines Records.
Input Name Type ViVirtualMachineListInfoIterNext ViVirtualMachineListInfoIterNext
Output Name Type ViVirtualMachineListInfoIterNextResult ViVirtualMachineListInfoIterNextResult
Error Name Description EACCESSDENIED EDATABASEERROR EINTERNALERROR EINVALIDTAG EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| ViVirtualMachineListInfoIterStart (supported) | [top] |
Start iteration of Virtual Machines discovered in DataFabric Manager server.
Input Name Type ViVirtualMachineListInfoIterStart ViVirtualMachineListInfoIterStart
Output Name Type ViVirtualMachineListInfoIterStartResult ViVirtualMachineListInfoIterStartResult
Error Name Description EACCESSDENIED EDATABASEERROR EINTERNALERROR EINVALIDTAG EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| Element definition: ViDatacenterListInfoIterEnd | [top] |
Ends iteration To list Data Centers.
Name Type Description Tag xsd:string
Tag From a previous ViDatacenterListInfoIterStart.
| Element definition: ViDatacenterListInfoIterEndResult | [top] |
[none]
| Element definition: ViDatacenterListInfoIterNext | [top] |
Get the list of Data Center Records.
Name Type Description Maximum xsd:integer
The Maximum number of Records To retrieve. Range: [1..2^31-1]. Tag xsd:string
Tag From a previous ViDatacenterListInfoIterStart
| Element definition: ViDatacenterListInfoIterNextResult | [top] |
Name Type Description Datacenters ArrayOfDatacenter
List of Data Centers. Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1].
| Element definition: ViDatacenterListInfoIterStart | [top] |
List Data Centers discovered in DataFabric Manager Server.
Name Type Description IncludeDeleted xsd:boolean
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. IsUnprotected xsd: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. ObjNameOrId ObjNameOrId
optional
Object for which the list of Data Centers need To be retrieved. If the ObjNameOrId 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
| Element definition: ViDatacenterListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
Number of entities available in the list. Range: [0..2^31-1] Tag xsd:string
Tag To be used for subsequent iteration calls.
| Element definition: ViDatastoreListInfoIterEnd | [top] |
Ends iteration To list Datastores
Name Type Description Tag xsd:string
Tag From a previous ViDatastoreListInfoIterStart.
| Element definition: ViDatastoreListInfoIterEndResult | [top] |
[none]
| Element definition: ViDatastoreListInfoIterNext | [top] |
Get the list of Datastore Records.
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 ViDatastoreListInfoIterStart
| Element definition: ViDatastoreListInfoIterNextResult | [top] |
Name Type Description Datastores ArrayOfDatastore
List of Datastores. Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1]
| Element definition: ViDatastoreListInfoIterStart | [top] |
List Datastores discovered in DataFabric Manager Server.
Name Type Description IncludeDeleted xsd:boolean
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. IsUnprotected xsd: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. ObjNameOrId ObjNameOrId
optional
Object for which the list of Datastores needs To be retrieved. If the ObjNameOrId 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
| Element definition: ViDatastoreListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
Number of entities available in the list. Range: [0..2^31-1] Tag xsd:string
Tag To be used for subsequent iteration calls.
| Element definition: ViHypervisorListInfoIterEnd | [top] |
Ends iteration To list Hypervisors.
Name Type Description Tag xsd:string
Tag From a previous hypervisor-list-info-iter-start.
| Element definition: ViHypervisorListInfoIterEndResult | [top] |
[none]
| Element definition: ViHypervisorListInfoIterNext | [top] |
Get the list of Hypervisor Records.
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 call To ViHypervisorListInfoIterStart.
| Element definition: ViHypervisorListInfoIterNextResult | [top] |
Name Type Description Hypervisors ArrayOfHypervisorInfo
List of Hypervisors. Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1]
| Element definition: ViHypervisorListInfoIterStart | [top] |
Start iteration of Hypervisors discovered in DataFabric Manager server.
Name Type Description IncludeDeleted xsd:boolean
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). ObjNameOrId ObjNameOrId
optional
Name or identifier of an object for which the list of Hypervisors need To be retrieved. The valid Type for object are :- If the ObjNameOrId is not specified, then all the Hypervisors are returned.
- Virtual Center
- Data Center
- Hypervisor
- Datastore
- Virtual Machine
- Dataset
- Resource Group
VirtualInfrastructureType VirtualInfrastructureType
optional
Input filter for virtual server infrastructure Type. If specified, only the Hypervisors of the specified infrastructure Type are listed.
| Element definition: ViHypervisorListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
Number of entities available in the list. Range: [0..2^31-1] Tag xsd:string
Tag To be used for subsequent iteration calls.
| Element definition: ViVirtualCenterListInfoIterEnd | [top] |
Ends iteration To list Virtual Centers.
Name Type Description Tag xsd:string
Tag From a previous ViVirtualCenterListInfoIterStart.
| Element definition: ViVirtualCenterListInfoIterEndResult | [top] |
[none]
| Element definition: ViVirtualCenterListInfoIterNext | [top] |
Get list of Virtual Center Records..
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 ViVirtualCenterListInfoIterStart
| Element definition: ViVirtualCenterListInfoIterNextResult | [top] |
Name Type Description Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1] VirtualCenters ArrayOfVirtualCenter
List of Virtual Center Records.
| Element definition: ViVirtualCenterListInfoIterStart | [top] |
List Virtual Center Servers discovered in DataFabric Manager Server.
Name Type Description IncludeDeleted xsd:boolean
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. ObjNameOrId ObjNameOrId
optional
Name or Id of the Virtual Center Server or a Resource Group. If not specified, then all the Virtual Centers will be returned.
| Element definition: ViVirtualCenterListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
Number of entities available in the list. Range: [0..2^31-1] Tag xsd:string
Tag To be used for subsequent iteration calls.
| Element definition: ViVirtualDiskListInfoIterEnd | [top] |
Ends iteration To list virtual Disks
Name Type Description Tag xsd:string
Tag From a previous ViVirtualDiskListInfoIterStart.
| Element definition: ViVirtualDiskListInfoIterEndResult | [top] |
[none]
| Element definition: ViVirtualDiskListInfoIterNext | [top] |
Get the list of Virtual Disk Records.
Name Type Description Maximum xsd:integer
The Maximum number of Records To retrieve. Range: [1..2^31-1] Tag xsd:string
Tag From a previous ViVirtualDiskListInfoIterStart
| Element definition: ViVirtualDiskListInfoIterNextResult | [top] |
Name Type Description Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1] VirtualDisks ArrayOfVirtualDisk
List of Virtual Disks Records.
| Element definition: ViVirtualDiskListInfoIterStart | [top] |
List Virtual Disks discovered in DataFabric Manager Server.
Name Type Description IncludeDeleted xsd:boolean
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. ObjNameOrId ObjNameOrId
optional
Name or identifier of an object for which list of Virtual Disks need To be retrieved. The Type of object are :- If the ObjNameOrId is not specified, all the Virtual Machines discovered are returned.
- Virtual Center
- Data Center
- Hypervisor
- Virtual Machine
- Dataset
- Resource Group
| Element definition: ViVirtualDiskListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
Number of entities available in the list Range: [0..2^31-1] Tag xsd:string
Tag To be used for subsequent iteration calls.
| Element definition: ViVirtualMachineListInfoIterEnd | [top] |
Ends iteration To list Virtual Machines.
Name Type Description Tag xsd:string
Tag From a previous ViVirtualMachineListInfoIterStart.
| Element definition: ViVirtualMachineListInfoIterEndResult | [top] |
[none]
| Element definition: ViVirtualMachineListInfoIterNext | [top] |
Get the list of virtual machines Records.
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 call To ViVirtualMachineListInfoIterStart
| Element definition: ViVirtualMachineListInfoIterNextResult | [top] |
Name Type Description Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1] VirtualMachines ArrayOfVirtualMachine
List of Virtual Machines retrieved.
| Element definition: ViVirtualMachineListInfoIterStart | [top] |
Start iteration of Virtual Machines discovered in DataFabric Manager server.
Name Type Description IncludeDeleted xsd:boolean
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. IsUnprotected xsd: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. ObjNameOrId ObjNameOrId
optional
Name or identifier of an object for which list of Virtual Machines need To be retrieved. If the ObjNameOrId is not specified, all the virtual machines are returned. The possible types are :-
- Virtual Center
- Data Center
- Datastore
- HyperVisor
- Dataset
- Resource Group
VirtualInfrastructureType VirtualInfrastructureType
optional
Input filter for virtual server infrastructure Type. If specified, only the Virtual Machines of the specified virtual server infrastructure Type are listed.
| Element definition: ViVirtualMachineListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
Number of Records available in the list. Range: [0..2^31-1] Tag xsd:string
Tag To be used for subsequent iteration calls.
| Element definition: ArrayOfDatacenter | [top] |
Name Type Description Datacenter Datacenter[]
| Element definition: ArrayOfDatastore | [top] |
Name Type Description Datastore Datastore[]
| Element definition: ArrayOfHypervisorInfo | [top] |
Name Type Description HypervisorInfo HypervisorInfo[]
| Element definition: ArrayOfVirtualCenter | [top] |
Name Type Description VirtualCenter VirtualCenter[]
| Element definition: ArrayOfVirtualDisk | [top] |
Name Type Description VirtualDisk VirtualDisk[]
| Element definition: ArrayOfVirtualMachine | [top] |
Name Type Description VirtualMachine VirtualMachine[]
| 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: VirtualInfrastructureType | [top] |
Type of virtual infrastructure. The possible Values are :-
- VMwareManagement
- HyperVManagement
[none]
| Element definition: Datacenter | [top] |
Information about a Data Center.
Name Type Description DatacenterId ObjId
Object Id of the Data Center. DatacenterName ObjName
Name of the Data Center. Datasets ArrayOfDatasetReference
List of the Datasets that the data center belongs To. DeletedBy xsd:string
optional
The user who deleted the Data Center. This element is present only if the Data Center is deleted and IncludeDeleted is passed as true when starting the iteration. DeletedTimestamp DpTimestamp
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 IncludeDeleted is passed as true when starting the iteration. HostServiceId ObjId
Object Id of the Host Service that manages the Data Center. IsProtected xsd:boolean
true, if Data Center is protected. VirtualCenterReference VirtualCenterReference
Information about the Virtual Center Server To which the Data Center belongs To.
| Element definition: Datastore | [top] |
Information about a Datastore.
Name Type Description AllocatedCapacity xsd:unsignedLong
Allocated capacity in bytes (i.e Size) for the Datastore Range: [0..2^64-1] DatacenterReference DatacenterReference
Information of the Datacenter To which the Datastore belongs To. Datasets ArrayOfDatasetReference
List of the Datasets that the Datastore belongs To. DatastoreId ObjId
Object identifier of the Datastore. DatastoreName ObjName
Name of the Datastore. DatastoreOnOntap xsd:boolean
true, if backing storage for Datastore is hosted on Data ONTAP system. DatastoreType xsd:string
Type of the Datastore. The possible types are :-
- vmfs
- nfs
DeletedBy xsd:string
optional
The user who deleted marked the Datastore as deleted. This element is present only if the Datastore is deleted and IncludeDeleted is passed as true when starting the iteration. DeletedTimestamp DpTimestamp
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 IncludeDeleted is passed as true when starting the iteration. HostServiceId ObjId
Id for the Host Service that manages the Datastore. IsProtected xsd:boolean
true, if Datastore is protected. NfsExportPath xsd: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. UsedCapacity xsd:unsignedLong
Used capacity in bytes for the Datastore Range: [0..2^64-1] VirtualCenterReference VirtualCenterReference
Information on Virtual Center To which the Datastore belongs To.
| Element definition: HypervisorInfo | [top] |
Information about a Hypervisor.
Name Type Description DatacenterReference DatacenterReference
optional
Information of Data Center To which the hypervisor belongs To. Applicable only in case the VirtualInfrastructureType is 'VMwareManagement'. DeletedBy xsd:string
optional
The user who marked the Hypervisor as deleted. This element is present only if the Hypervisor is deleted and IncludeDeleted is passed as true when starting the iteration. DeletedTimestamp DpTimestamp
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 IncludeDeleted is passed as true when starting the iteration. DomainName xsd:string
optional
Name of the windows domain/workgroup To which the HyperVisor belongs To, applicable only in case the VirtualInfrastructureType is 'HyperVManagement'. HostServiceId ObjId
Object identifier of the Host Service that manages the Hypervisor. HypervisorId ObjId
Object Identifier for the hypervisor in DataFabric Manager Server. HypervisorName ObjName
Name of the hypervisor. IpAddress IpAddress
IP Address of the hypervisor. VirtualCenterReference VirtualCenterReference
optional
Information of the Virtual Center To which the hypervisor belongs To. Applicable only in case the VirtualInfrastructureType is 'VMwareManagement'. VirtualInfrastructureType VirtualInfrastructureType
Type of the virtual server infrastructure the Hypervisor belongs To.
| Element definition: VirtualCenter | [top] |
Virtual Center information.
Name Type Description DeletedBy xsd:string
optional
The user who deleted the Virtual Center object. Present only if IncludeDeleted input field is specified when starting the iteration and the Virtual Center is deleted. DeletedTimestamp DpTimestamp
optional
The time and date when Virtual Center object was deleted. Present only if IncludeDeleted input field is specified when starting the iteration and the Virtual Center is deleted. HostServiceId ObjId
Object identifier of the Host Service managing the Virtual Center Server. VirtualCenterId ObjId
Object Id of the Virtual Center. VirtualCenterName ObjName
Name of the Virtual Center.
| Element definition: VirtualDisk | [top] |
Information about Virtual Disk.
Name Type Description DatastoreId ObjId
optional
Object Id of the Object Datastore in which the Virtual Disk resides. This is applicable only if the VirtualInfrastructureType is 'VMwareManagement'. This element is deprecated, use DatastoreReference instead. DatastoreName ObjName
optional
Object Name of the Datastore in which the Virtual Disk resides. This is applicable only if the VirtualInfrastructureType is 'VMwareManagement'. This element is deprecated, use DatastoreReference instead. DatastoreReference DatastoreReference
optional
Information of the Datastore object on which the virtual disk resides. This is applicable only if the VirtualInfrastructureType is 'VMwareManagement'. DeletedBy xsd:string
optional
The user who deleted the Virtual Disk. This element is present only if the Virtual Disk is deleted and IncludeDeleted is passed as true when starting the iteration. DeletedTimestamp DpTimestamp
optional
The time and date when the Virtual Disk was deleted. This element is present only if the Virtual Disk is deleted and IncludeDeleted is passed as true when starting the iteration. HostServiceId ObjId
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). VhdType xsd:string
optional
Indicated the Type of Virtual Disk. If the VirtualInfrastructureType is 'HyperVManagement' the possible Values are :
- passthrough
- cluster_shared_volume
- boot_disk
- regular
If the VirtualInfrastructureType is 'VMwareManagement' the possible Values are :
- raw_device_mapping
- regular
VirtualDiskId ObjId
Object Id for the Virtual Disk. VirtualDiskName ObjName
Name for the Virtual Disk. VirtualInfrastructureType VirtualInfrastructureType
Type of virtual infrastructure the Virtual Disk belongs To. VirtualMachineId ObjId
Object Id of the Virtual Machine To which this Virtual Disk is assigned. This element is deprecated, use VirtualMachineReference instead. VirtualMachineName ObjName
Object Name of the Virtual Machine To which this Virtual Disk is assigned. This element is deprecated, use VirtualMachineReference instead. VirtualMachineReference VirtualMachineReference
optional
Information of virtual machine object To which the virtual disk is assigned.
| Element definition: VirtualMachine | [top] |
Information about a Virtual Machine.
Name Type Description DatacenterReference DatacenterReference
optional
Information of the Data Center To which the Virtual Machine is member of in VMware Virtual Center Server. Applicable only in case the VirtualInfrastructureType is 'VMwareManagement'. Datasets ArrayOfDatasetReference
List of Datasets that has this Virtual Machine as a member. DeletedBy xsd:string
optional
The user who deleted the Virtual Machine. Returned only if IncludeDeleted input element Value is true and the Virtual Machine is deleted. DeletedTimestamp DpTimestamp
optional
The time and date when the Virtual Machine was marked as deleted. Returned only if IncludeDeleted input element Value is true and the Virtual Machine is deleted. DnsName xsd:string
FQDN configured for the Virtual Machine. GuestOsType xsd:string
optional
Guest OS Type running inside the Virtual Machine. HostServiceId ObjId
Identifier of the Host Service managing the Virtual Machine. HypervisorReference HypervisorReference
Information of Hypervisor (ESX Server or Hyper-V Parent partition) on which the Virtual Machine is hosted. IpAddressList ArrayOfIpAddress
optional
List of IP addresses configured on the Virtual Machine. IsProtected xsd:boolean
true, if Virtual Machine is protected. Status xsd: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'. VirtualCenterReference VirtualCenterReference
optional
Information of Virtual Center Server which manages the Virtual Machine. Applicable only in case the VirtualInfrastructureType is 'VMwareManagement'. VirtualInfrastructureType VirtualInfrastructureType
Type of virtual infrastructure the virtual machine belongs To. VirtualMachineId ObjId
Object Id for the virtual machine. VirtualMachineName ObjName
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.
| Element definition: ArrayOfDatasetReference | [top] |
Name Type Description DatasetReference DatasetReference[]
| Element definition: ArrayOfIpAddress | [top] |
Name Type Description IpAddress IpAddress[]
| Element definition: DatacenterReference | [top] |
Information about a hypervisor.
Name Type Description DatacenterId ObjId
Object Identifier of the Data Center. DatacenterName ObjName
Name of the Data Center.
| Element definition: DatastoreReference | [top] |
Name and object identifier of the Datastore object.
Name Type Description DatastoreId ObjId
optional
Object Id of the Object Datastore in which the Virtual Disk resides. DatastoreName ObjName
optional
Object Name of the Datastore in which the Virtual Disk resides.
| Element definition: DpTimestamp | [top] |
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]
| Element definition: HypervisorReference | [top] |
Information about a hypervisor.
Name Type Description HypervisorId ObjId
Object Identifier of the Hypervisor. HypervisorName ObjName
Name of the Hypervisor.
| Element definition: IpAddress | [top] |
IP Address in string format. The Length of this string cannot be more than 40 characters.
[none]
| Element definition: ObjId | [top] |
Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI Type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed To be 0, which is interpreted as a null Value, e.g., a reference To no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed To assign an ID To an object. Therefore, an input element of Type ObjId is always used To refer To an existing object by its ID. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types.
If the Value of an ObjId input element does not Match the ID of any existing DFM object of the specified Type or types, then typically the ZAPI fails with Error code EOBJECTNOTFOUND. A ZAPI may deviate From this general rule, for example, it may return a more specific Error code. In either case, the ZAPI specification must document its behavior.
[none]
| Element definition: ObjName | [top] |
Name of a DFM object. This typedef is an alias for the built in ZAPI Type string. An object Name must conform To the following format: 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: VirtualCenterReference | [top] |
Information about a hypervisor.
Name Type Description VirtualCenterId ObjId
Object Identifier of the Virtual Center. VirtualCenterName ObjName
Name of the Virtual Center.
| Element definition: VirtualMachineReference | [top] |
Name and object identifier of the virtual machine object.
Name Type Description VirtualMachineId ObjId
Object Id of the Virtual Machine To which this Virtual Disk is assigned. VirtualMachineName ObjName
Object Name of the Virtual Machine To which this Virtual Disk is assigned.
| 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.