vCloud Director REST API User Elements

User Elements


User Elements (280)

Element Description Since
AclRuleRecord A single aclRule query result in records format. 5.1
AclRuleReference A single aclRule query result in reference format. 0.9
AclRuleReferences A container for aclRule query results in references format.
AdminAllocatedExternalAddressRecord A single adminAllocatedExternalAddress query result in records format. 1.5
AdminApiDefinitionRecord A single adminApiDefinition query result in records format. 5.1
AdminApiDefinitionReference A single adminApiDefinition query result in reference format. 0.9
AdminApiDefinitionReferences A container for adminApiDefinition query results in references format.
AdminCatalogItemRecord A single adminCatalogItem query result in records format. 1.5
AdminCatalogRecord A single adminCatalog query result in records format. 1.5
AdminDiskRecord A single adminDisk query result in records format. 5.1
AdminDiskReference A single adminDisk query result in reference format. 0.9
AdminDiskReferences A container for adminDisk query results in references format.
AdminEventRecord A single adminEvent query result in records format. 5.1
AdminEventReference A single adminEvent query result in reference format. 0.9
AdminEventReferences A container for adminEvent query results in references format.
AdminFileDescriptorRecord A single adminFileDescriptor query result in records format. 5.1
AdminFileDescriptorReference A single adminFileDescriptor query result in reference format. 0.9
AdminFileDescriptorReferences A container for adminFileDescriptor query results in references format.
AdminGroupRecord A single adminGroup query result in records format. 1.5
AdminMediaRecord A single adminMedia query result in records format. 1.5
AdminOrgNetworkRecord A single adminOrgNetwork query result in records format. 1.5
AdminOrgVdcStorageProfileRecord A single adminOrgVdcStorageProfile query result in records format. 5.1
AdminOrgVdcStorageProfileReference A single adminOrgVdcStorageProfile query result in reference format. 0.9
AdminOrgVdcStorageProfileReferences A container for adminOrgVdcStorageProfile query results in references format.
AdminServiceRecord A single adminService query result in records format. 5.1
AdminServiceReference A single adminService query result in reference format. 0.9
AdminServiceReferences A container for adminService query results in references format.
AdminShadowVMRecord A single adminShadowVM query result in records format. 1.5
AdminTaskRecord A single adminTask query result in records format. 1.5
AdminUserRecord A single adminUser query result in records format. 1.5
AdminVAppNetworkRecord A single adminVAppNetwork query result in records format. 1.5
AdminVAppRecord A single adminVApp query result in records format. 1.5
AdminVAppTemplateRecord A single adminVAppTemplate query result in records format. 1.5
AdminVMRecord A single adminVM query result in records format. 1.5
AdminVdcRecord A single adminOrgVdc query result in records format. 1.5
AdminVdcReference A single adminOrgVdc query result in reference format. 0.9
AdminVdcReferences A container for adminOrgVdc query results in references format.
AdminVmDiskRelationRecord A single adminVMDiskRelation query result in records format. 5.1
AllEULAsAccepted True confirms acceptance of all EULAs in a vApp template. 0.9
AllocatedExternalAddressRecord A single allocatedExternalAddress query result in records format. 1.5
AllocatedIpAddresses A list of information for allocated IP addresses. 5.1
ApiDefinition (v1.5) Representation of an API definition accessible by all authenticated users. 5.1
ApiDefinitionRecord A single apiDefinition query result in records format. 5.1
ApiDefinitionReference A single apiDefinition query result in reference format. 0.9
ApiDefinitionReferences A container for apiDefinition query results in references format.
ApiExtensibility Lists links to API extensibility operations and entities. 5.1
ApiFilterRecord A single apiFilter query result in records format. 5.1
ApiFilterReference A single apiFilter query result in reference format. 0.9
ApiFilterReferences A container for apiFilter query results in references format.
AuditEvent Audit event 5.6
BlockingTaskRecord A single blockingTask query result in records format. 1.5
BlockingTaskReference A single blockingTask query result in reference format. 0.9
BlockingTaskReferences (v1.5) A container for blockingTask query results in references format.
CaptureVAppParams Parameters for a captureVapp request. 0.9
Catalog Represents the user view of a Catalog object. 0.9
CatalogItem Contains a reference to a VappTemplate or Media object and related metadata. 0.9
CatalogItemRecord A single catalogItem query result in records format. 1.5
CatalogItemReference A single adminCatalogItem, catalogItem query result in reference format. 0.9
CatalogItemReferences A container for adminCatalogItem, catalogItem query results in references format.
CatalogRecord A single catalog query result in records format. 1.5
CatalogReference A single catalog, adminCatalog query result in reference format. 0.9
CatalogReferences A container for catalog, adminCatalog query results in references format.
CellRecord A single cell query result in records format. 1.5
CertificateUpdateParams Parameters for certificate update. 5.1
CertificateUploadSocket Upload socket for certificate. 5.1
CloneMediaParams Parameters required by a cloneMedia request. 0.9
CloneVAppParams Parameters for a clonevApp request. 0.9
CloneVAppTemplateParams Parameters for a cloneVappTemplate request. 0.9
ComplianceResult Represents the results of a compliance check. 5.1
ComposeVAppParams Represents vApp composition parameters. 0.9
ConditionRecord A single condition query result in records format. 5.1
ControlAccessParams Specifies access controls for a resource. 0.9
CopyOrMoveCatalogItemParams Parameters for a copyCatalogItem or moveCatalogItem request. 5.5
CreateSnapshotParams Parameters for a createSnapshot request. 5.1
CurrentUsage A collection of simple metrics representing real time usage statistics 5.6
CurrentUsageSpec Specifies which current usage metrics to retrieve 5.6
CustomizationSection Represents a vApp template customization settings. 1.0
DatastoreProviderVdcRelationRecord A single datastoreProviderVdcRelation query result in records format. 1.5
DatastoreRecord A single datastore query result in records format. 1.5
DatastoreReference A single datastore query result in reference format. 0.9
DatastoreReferences (v1.5) A container for datastore query results in references format.
DefaultStorageProfileSection Name of the storage profile that will be specified for this virtual machine. 5.1
DeployVAppParams Parameters to a deploy vApp request. 0.9
DhcpService DHCP service settings
Disk Represents an independent disk. 5.1
DiskAttachOrDetachParams Parameters for attaching or detaching an independent disk. 5.1
DiskCreateParams Parameters for creating or updating an independent disk. 5.1
DiskRecord A single disk query result in records format. 5.1
DiskReference A single disk query result in reference format. 0.9
DiskReferences A container for disk query results in references format.
DvSwitchRecord A single dvSwitch query result in records format. 1.5
EdgeGateway Represents a gateway. 5.1
EdgeGatewayRecord A single edgeGateway query result in records format. 5.1
EdgeGatewayReference A single edgeGateway query result in reference format. 0.9
EdgeGatewayReferences A container for edgeGateway query results in references format.
EdgeGatewayServiceConfiguration Represents edge gateway services. 5.1
Entity Basic entity type in the vCloud object model. 0.9
Error The standard error message type used in the vCloud REST API. 0.9
Event Parameters for creating an event. 5.1
EventRecord A single event query result in records format. 1.5
ExternalLocalizationRecord A single externalLocalization query result in records format. 5.1
File Represents a file to be transferred (uploaded or downloaded). 0.9
FileDescriptor (v1.5) Represents a file required by an extension API definition. 5.1
FileDescriptorRecord A single fileDescriptor query result in records format. 5.1
FirewallService Firewall service settings
GatewayDhcpService Gateway DHCP service settings 5.1
GatewayIpsecVpnService Gateway Ipsec VPN service settings 5.1
GroupRecord A single group query result in records format. 1.5
GroupReference A single group, adminGroup query result in reference format. 0.9
GroupReferences A container for group, adminGroup query results in references format.
GuestCustomizationSection Represents a guest customization settings. 1.0
HistoricUsage A collection of time-based metrics representing historic usage statistics 5.6
HistoricUsageSpec Specifies which historic usage metrics to retrieve 5.6
HostRecord A single host query result in records format. 1.5
HostReference A single host query result in reference format. 0.9
HostReferences A container for host query results in references format.
InstantiateOvfParams Represents vApp instantiation from OVF parameters
InstantiateOvfProperty Represents an OVF property value assignment. 5.5
InstantiateVAppTemplateParams Represents vApp template instantiation parameters. 0.9
InstantiateVmParams Instantiation parameters for a VM in a vApp. 5.5
IpsecVpnLocalPeer Gives more details of local peer end point. 1.5
IpsecVpnPeer This is the root type for all Ipsec-VPN peers. 1.5
IpsecVpnRemotePeer Gives more details of remote peer end point. 1.5
IpsecVpnService Ipsec Vpn service settings 1.5
IpsecVpnThirdPartyPeer Gives more details of third party peer end point. 1.5
Item
KeystoreUpdateParams Parameters for keystore update. 5.1
KeystoreUploadSocket Upload socket for keystore. 5.1
LeaseSettingsSection Represents vApp lease settings. 0.9
Link Extends reference type by adding relation attribute. 0.9
LoadBalancerService Load Balancer service settings 5.1
Media Represents a Media object. 0.9
MediaInsertOrEjectParams Parameters for an insertMedia or ejectMedia request. 0.9
MediaRecord A single media query result in records format. 1.5
MediaReference A single media, adminMedia query result in reference format. 0.9
MediaReferences A container for media, adminMedia query results in references format.
Metadata User-defined metadata associated with with an object. 1.5
MetadataValue
MksTicket A ticket and connection information for accessing the console of a VM. 5.5
NatService NAT service settings
NetworkAssignment Maps a network name specified in a Vm to the network name of a vApp network defined in the VApp that contains the Vm 0.9
NetworkConfigSection Container for vApp networks. 0.9
NetworkConnection Represents a network connection in the virtual machine. 0.9
NetworkConnectionSection Container for the network connections of this virtual machine. 0.9
NetworkMapping Represents a mapping from an OVF source network to a vCloud target network. 5.5
NetworkPoolRecord A single networkPool query result in records format. 1.5
NetworkPoolReference A single networkPool query result in reference format. 0.9
NetworkPoolReferences A container for networkPool query results in references format.
NetworkRecord A single externalNetwork query result in records format. 1.5
NetworkReference A single externalNetwork query result in reference format. 0.9
NetworkReferences A container for externalNetwork query results in references format.
NetworkService This is the root of the substitution group for network services.
NetworkServiceInsertion Information about a network service that has been inserted 5.1
Org Represents the user view of a vCloud Director organization. 0.9
OrgList Represents a list of organizations. 0.9
OrgNetworkRecord A single orgNetwork query result in records format. 1.5
OrgNetworkReference A single orgNetwork, adminOrgNetwork query result in reference format. 0.9
OrgNetworkReferences A container for orgNetwork, adminOrgNetwork query results in references format.
OrgRecord A single organization query result in records format. 1.5
OrgReference A single organization query result in reference format. 0.9
OrgReferences A container for organization query results in references format.
OrgVdcNetwork Represents an Org vDC network in the vCloud model. 5.1
OrgVdcNetworkRecord A single orgVdcNetwork query result in records format. 5.1
OrgVdcNetworkReference A single orgVdcNetwork query result in reference format. 0.9
OrgVdcNetworkReferences A container for orgVdcNetwork query results in references format.
OrgVdcRecord A single orgVdc query result in records format. 1.5
OrgVdcReference A single orgVdc query result in reference format. 0.9
OrgVdcReferences A container for orgVdc query results in references format.
OrgVdcResourcePoolRelationRecord A single orgVdcResourcePoolRelation query result in records format. 1.5
OrgVdcStorageProfileRecord A single orgVdcStorageProfile query result in records format. 5.1
OrgVdcStorageProfileReference A single orgVdcStorageProfile query result in reference format. 0.9
OrgVdcStorageProfileReferences A container for orgVdcStorageProfile query results in references format.
Owner Represents the owner of this entity. 1.5
PortgroupRecord A single portgroup query result in records format. 1.5
ProductSectionList Container for all ProductSection elements in a VAppTemplate, VApp, or Vm object.
ProviderVdcResourcePoolRelationRecord A single providerVdcResourcePoolRelation query result in records format. 1.5
ProviderVdcStorageProfileRecord A single providerVdcStorageProfile query result in records format. 5.1
ProviderVdcStorageProfileReference A single providerVdcStorageProfile query result in reference format. 0.9
ProviderVdcStorageProfileReferences A container for providerVdcStorageProfile query results in references format.
PublishCatalogParams Parameters required when sharing a catalog with other organizations. 0.9
QueryList Container for the list of typed queries available to the requesting user.
QueryResultRecords Container for query results in records format. 1.5
RasdItemsList Represents a list of RASD items specifying a group of related DMTF Resource Allocation Setting Data properties of this virtual machine. 0.9
RecomposeVAppParams Parameters for a recompose vApp request. 1.0
Record Base element for a single record from query result in records format.
Reference A reference to a resource. 0.9
References Container for query results returned in references format.
RegisterVAppParams Represents vApp registration parameters. 5.5
RelocateParams Parameters to be used for virtual machine relocation. 1.5
ResourceClassActionRecord A single resourceClassAction query result in records format. 5.1
ResourceClassActionReference A single resourceClassAction query result in reference format. 0.9
ResourceClassActionReferences A container for resourceClassAction query results in references format.
ResourceClassRecord A single resourceClass query result in records format. 5.1
ResourceClassReference A single resourceClass query result in reference format. 0.9
ResourceClassReferences A container for resourceClass query results in references format.
ResourceEntity Base type that represents a resource entity such as a vApp template or virtual media. 0.9
ResourcePoolRecord A single resourcePool query result in records format. 1.5
ResourcePoolVMRecord A single resourcePoolVmList query result in records format. 5.1
RightRecord A single right query result in records format. 1.5
RightReference A single right query result in reference format. 0.9
RightReferences A container for right query results in references format.
RoleRecord A single role query result in records format. 1.5
RoleReference A single role query result in reference format. 0.9
RoleReferences A container for role query results in references format.
RuntimeInfoSection VMware Tools and other runtime information for this virtual machine. 1.5
ScreenTicket The ticket for accessing the console of a VM. 0.9
Service (v1.5) Public representation of an external service. 5.1
ServiceLinkRecord A single serviceLink query result in records format. 5.1
ServiceLinkReference A single serviceLink query result in reference format. 0.9
ServiceLinkReferences A container for serviceLink query results in references format.
ServiceRecord A single service query result in records format. 5.1
ServiceReference A single service query result in reference format. 0.9
ServiceReferences A container for service query results in references format.
ServiceResourceRecord A single serviceResource query result in records format. 5.1
ServiceResourceResourceReference A single serviceResource query result in reference format. 0.9
ServiceResourceResourceReferences A container for serviceResource query results in references format.
Session Represents a vCloud Session. 1.5
ShadowVMReferences A container for shadow VM reference elements.
Snapshot Represents a virtual machine snapshot. 5.1
SnapshotSection Represents information about vApp and virtual machine snapshots. 5.1
SspiKeytabUpdateParams Parameters for SSPI keytab update. 5.1
SspiKeytabUploadSocket Upload socket for SSPI keytab. 5.1
StaticRoutingService Static Routing service settings 1.5
StrandedItemRecord A single strandedItem query result in records format. 5.1
StrandedItemReference A single strandedItem query result in reference format. 0.9
StrandedItemReferences A container for strandedItem query results in references format.
StrandedUserRecord A single strandedUser query result in records format. 1.5
SupportedOperatingSystemsInfo Operating systems available for use on virtual machines owned by this organization. 5.1
SupportedVersions List all supported versions. 0.9
Task Represents an asynchronous operation in vCloud Director. 0.9
TaskRecord A single task query result in records format. 1.5
TaskReference A single task, adminTask query result in reference format. 0.9
TaskReferences A container for task, adminTask query results in references format.
TasksList A list of tasks. 0.9
ToCloudTunnelRecord A single toCloudTunnel query result in records format. 5.6
ToCloudTunnelReference A single toCloudTunnel query result in reference format. 0.9
ToCloudTunnelReferences A container for toCloudTunnel query results in references format.
TrustStoreUpdateParams Parameters for updating the truststore. 5.1
TrustStoreUploadSocket Upload socket for the truststore. 5.1
UndeployVAppParams Parameters to an undeploy vApp request. 0.9
UploadVAppTemplateParams Parameters for an uploadVappTemplate request. 0.9
UserRecord A single user query result in records format. 1.5
UserReference A single user, strandedUser, adminUser query result in reference format. 0.9
UserReferences A container for user, strandedUser, adminUser query results in references format.
VApp Represents a vApp. 0.9
VAppNetwork Represents a vApp network. 1.5
VAppNetworkRecord A single vAppNetwork query result in records format. 1.5
VAppNetworkReference A single vAppNetwork, adminVAppNetwork query result in reference format. 0.9
VAppNetworkReferences A container for vAppNetwork, adminVAppNetwork query results in references format.
VAppOrgNetworkRelationRecord A single vAppOrgNetworkRelation query result in records format. 1.5
VAppOrgNetworkRelationReference A single vAppOrgNetworkRelation query result in reference format. 0.9
VAppOrgNetworkRelationReferences A container for vAppOrgNetworkRelation query results in references format.
VAppOrgVdcNetworkRelationRecord A single vAppOrgVdcNetworkRelation query result in records format. 5.1
VAppOrgVdcNetworkRelationReference A single vAppOrgVdcNetworkRelation query result in reference format. 0.9
VAppOrgVdcNetworkRelationReferences A container for vAppOrgVdcNetworkRelation query results in references format.
VAppRecord A single vApp query result in records format. 1.5
VAppReference A single vApp, adminVApp query result in reference format. 0.9
VAppReferences A container for vApp, adminVApp query results in references format.
VAppTemplate Represents a vApp template. 0.9
VAppTemplateRecord A single vAppTemplate query result in records format. 1.5
VAppTemplateReference A single vAppTemplate, adminVAppTemplate query result in reference format. 0.9
VAppTemplateReferences A container for vAppTemplate, adminVAppTemplate query results in references format.
VMRecord A single vm query result in records format. 1.5
VMReference A single vm, adminVM, adminShadowVM, resourcePoolVmList query result in reference format. 0.9
VMReferences A container for vm, adminVM, adminShadowVM, resourcePoolVmList query results in references format.
VMWProviderVdcRecord A single providerVdc query result in records format. 1.5
VMWProviderVdcReference A single providerVdc query result in reference format. 0.9
VMWProviderVdcReferences (v1.5) A container for providerVdc query results in references format.
Vdc Represents the user view of an organization vDC. 0.9
VdcStorageProfile Represents a storage profile in an organization vDC. 5.1
VdcStorageProfiles Container for references to storage profiles associated with a vDC. 5.1
VirtualCenterRecord A single virtualCenter query result in records format. 1.5
VirtualCenterReference A single virtualCenter query result in reference format. 0.9
VirtualCenterReferences A container for virtualCenter query results in references format.
Vm Represents a virtual machine. 0.9
VmCapabilities Allows you to specify certain capabilities of this virtual machine. 5.1
VmDiskRelationRecord A single vmDiskRelation query result in records format. 5.1
VmPendingQuestion Represents a question posted by a virtual machine that is WAITING_FOR_INPUT (status="5"). 0.9
VmQuestionAnswer Represents the answer to a question posted by a virtual machine that is WAITING_FOR_INPUT (status="5"). 0.9
Vms Represents a list of virtual machines. 5.1