VMware Cloud Director API User Types
VMware Cloud Director API User Types
User Types
User Types (394)
| Type | Description | Since |
|---|---|---|
| AbsoluteTimeType | Specifies an absolute time in UTC | 5.6 |
| AbstractVAppType | Represents a base type for VAppType and VmType. | 0.9 |
| AccessSettingsType | A list of access settings for a resource. | 0.9 |
| AccessSettingType | Controls access to the resource. | 0.9 |
| AffinityRuleType | Represents the base type for affinity and anti-affinity rules. | 20.0 |
| AffinityRuleType/Polarity | ||
| AllocatedIpAddressesType | A list of information for allocated IP addresses. | 5.1 |
| AllocatedIpAddressType | Represents an information for allocated IP address | 5.1 |
| AllocationPoolVdcSummaryType | Represents the summary of consumed and reserved memory, CPU, and storage for a vDC using the Allocation Pool allocation model. | 30.0 |
| ApiDefinitionType | Representation of an API definition accessible by all authenticated users. | 5.1 |
| ApiExtensibilityType | Lists links to API extensibility operations and entities. | 5.1 |
| AuditEventType | Audit event | 5.6 |
| AuthorizedLocationsType | Container for AuthorizedLocationType | 29.0 |
| AuthorizedLocationType | Represents a vCloud Director server group that this session is authorized to access. | 29.0 |
| AvailableNetworksType | Container for references to available organization vDC networks. | 0.9 |
| BootOptionsType | Allows you to specify boot options for this virtual machine. | 21.0 |
| BusUnitNumberType | A combination of bus and unit number. | 31.0 |
| CapabilitiesType | Collection of supported hardware capabilities. | 1.5 |
| CapacityType | Represents the capacity of a given resource. | 0.9 |
| CapacityWithUsageType | Represents a capacity and usage of a given resource. | 0.9 |
| CaptureVAppParamsType | Parameters for a captureVapp request. | 0.9 |
| CaptureVmParamsType | Parameters for a VM which is being captured. | 0.9 |
| CatalogItemsType | Container for references to catalog items. | 0.9 |
| CatalogItemType | Contains a reference to a VappTemplate or Media object and related metadata. | 0.9 |
| CatalogType | Represents the user view of a Catalog object. | 0.9 |
| CertificateUpdateParamsType | Parameters for certificate update. | 5.1 |
| CertificateUploadSocketType | Upload socket for certificate. | 5.1 |
| CloneMediaParamsType | Parameters required by a cloneMedia request. | 0.9 |
| CloneVAppParamsType | Parameters for a clonevApp request. | 0.9 |
| CloneVAppTemplateParamsType | Parameters for a cloneVappTemplate request. | 0.9 |
| ComplianceResultType | Represents the results of a GET /vApp/vm-{id}/complianceResult request. | 5.1 |
| ComposeVAppParamsType | Represents vApp composition parameters. | 0.9 |
| ComputeCapacityType | Represents vDC compute capacity. | 0.9 |
| ComputePolicyComplianceType | Compute policy compliance details of the VM. | 33.0 |
| ComputePolicyType | Compute policy details of the VM. | 33.0 |
| ComputeResourceType | Stores the configured value, reservation, shares and limit for compute resources such CPU and Memory for a virtualized workload. | 32.0 |
| ContainerType | Container for query result sets. | |
| ControlAccessParamsType | Specifies access controls for a resource. | 0.9 |
| CopyOrMoveCatalogItemParamsType | Parameters for a copyCatalogItem or moveCatalogItem request. | 5.5 |
| CreateSnapshotParamsType | Parameters for a createSnapshot request. | 5.1 |
| CreateVmParamsType | Represents VM creation parameters. | 32.0 |
| CurrentUsageSpecType | Specifies which current usage metrics to retrieve | 5.6 |
| CurrentUsageType | A collection of simple metrics representing real time usage statistics | 5.6 |
| CustomizationSectionType | Represents a vApp template customization settings. | 1.0 |
| DefaultHardDiskAdapterTypeType | Represents a virtual hard disk adapter type. | 5.1 |
| DefaultStorageProfileSection_Type | Name of the storage profile that will be specified for this virtual machine. | 5.1 |
| DeployVAppParamsType | Parameters to a deploy vApp request. | 0.9 |
| DhcpPoolServiceType | Represents DHCP pool service. | 5.1 |
| DhcpServiceType | Represents a DHCP network service. | |
| DiskAttachOrDetachParamsType | Parameters for attaching or detaching an independent disk. | 5.1 |
| DiskCreateParamsType | Parameters for creating or updating an independent disk. | 5.1 |
| DiskMoveParamsType | Parameters for moving a named disk to a different Org VDC. | 36.0 |
| DiskSectionType | The section of the VM representation that has to do with the VM's disks. | 32.0 |
| DiskSettingsType | A description of a virtual disk of a VM. | 32.0 |
| DiskSharingType | Sharing type of named disks. | 36.0 |
| DiskType | Represents an independent disk. | 5.1 |
| DistributedCatalogParamsType | Configuration parameters for a Distributed Catalog. | 39.0 |
| EdgeClusterConfigurationType | Used for specifying specific Edge Cluster(s) for a given Edge Gateway. | 34.0 |
| EdgeGatewayFormFactorType | Allows a user to change the size of the gateway | 11.0 |
| EdgeGatewayType | Represents an EdgeGatewayType | 32.0 |
| EntityLinkType | Extends EntityReference type by adding relation attribute. | 1.5 |
| EntityReferenceType | A reference to a vCloud entity. | 1.5 |
| EntityType | Basic entity type in the vCloud object model. | 0.9 |
| ErrorType | The standard error message type used in the vCloud REST API. | 0.9 |
| EventPropertiesType | List of event-specific properties. | 5.6 |
| EventPropertiesType/EventProperty | ||
| EventType | Parameters for creating an event. | 5.1 |
| ExternalNatIpMapType | Maps source site external NAT IP addresses to destination site external NAT IP addresses. | 5.5 |
| ExternalNatIpMapType/Entry | 5.5 | |
| ExternalSubjectType | A reference to a user or group managed by an identity provider configured for use in this organization. | 11.0 |
| FileDescriptorType | Represents a file required by an extension API definition. | 5.1 |
| FilesListType | Represents a list of files to be transferred (uploaded or downloaded). | 0.9 |
| FileType | Represents a file to be transferred (uploaded or downloaded). | 0.9 |
| FileUploadParamsType | Parameters for initializing file upload session. | 5.1 |
| FileUploadSocketType | Parameters for initiating file upload. | 5.1 |
| FirewallIpAddressType | A valid IPv4 address or "Any". | 0.9 |
| FirewallRuleType | Represents a firewall rule. | 0.9 |
| FirewallRuleType/Protocols | ||
| FirewallServiceType | Represents a network firewall service. | |
| FlexVdcSummaryType | Represents the summary of consumed CPU, memory, and storage for a vDC using the Flex allocation model. | 32.0 |
| GatewayBackingRefType | Provides information to access edge gateway via VC | 7.0 |
| GatewayConfigurationType | Gateway Configuration. | 5.1 |
| GatewayDhcpServiceType | Represents Gateway DHCP service. | 5.1 |
| GatewayFeaturesType | Represents edge gateway services. | 5.1 |
| GatewayInterfacesType | A list of Gateway Interfaces. | 5.1 |
| GatewayInterfaceType | Gateway Interface configuration. | 5.1 |
| GatewayIpsecVpnEndpointType | Represents an IPSec VPN endpoint. | 5.1 |
| GatewayIpsecVpnServiceType | Represents gateway IPsec VPN service. | 5.1 |
| GatewayIpsecVpnTunnelType | Represents an IPSec VPN tunnel. | 5.1 |
| GatewayNatRuleType | Represents the SNAT and DNAT rules. | 5.1 |
| GatewayType | Represents a gateway. | 5.1 |
| GuestCustomizationSectionType | Represents a guest customization settings. | 1.0 |
| HardDiskAdapterReferenceType | The reference to a HardDiskAdapter element. | 29.0 |
| HardDiskAdapterType | Hard disk controller type detailed description. | 29.0 |
| HardwareVersionBaseType | ||
| HardwareVersionType | Represents a supported virtual hardware version. | 29.0 |
| HistoricUsageSpecType | Specifies which historic usage metrics to retrieve | 5.6 |
| HistoricUsageType | A collection of time-based metrics representing historic usage statistics | 5.6 |
| IdentifiableResourceType | The base type for all resource types which contain an id attribute. | 0.9 |
| IdpGroupsType | Container for Idp Groups | 30.0 |
| IdpRecommendedRolesType | Container for Idp Recommended Roles | 30.0 |
| InstantiateOvfParamsType | Represents vApp instantiation from OVF parameters | |
| InstantiateOvfPropertyType | Represents an OVF property value assignment. | 5.5 |
| InstantiateVAppParamsType | Represents vApp instantiation parameters. | 0.9 |
| InstantiateVAppTemplateParamsType | Represents vApp template instantiation parameters. | 0.9 |
| InstantiateVmHardwareCustomizationParamsType | Hardware parameter customization applied to a virtual machine in a vApp when instantiated. | 5.5 |
| InstantiateVmHardwareCustomizationParamsType/Disk | ||
| InstantiateVmParamsType | Instantiation parameters for a VM in a vApp. | 5.5 |
| InstantiateVmTemplateParamsType | Represents VM template instantiation parameters. | 32.0 |
| InstantiationParamsType | Container for ovf:Section_Type elements that specify vApp configuration on instantiate, compose, or recompose. | 0.9 |
| IopsResourceType | Stores the reservation, limit, shares and shares level for IOPS of a disk. | 37.0 |
| IpAddressesType | A list of IP addresses. | 0.9 |
| IpAddressType | A valid IPv4 address or "Any". | 0.9 |
| IpRangesType | Represents a list of IP ranges. | 0.9 |
| IpRangeType | Represents a range of IP addresses, start and end inclusive. | 0.9 |
| IpScopesType | Represents a list of IP scopes. | 5.1 |
| IpScopeType | Specify network settings like gateway, network mask, DNS servers, IP ranges, etc. | 0.9 |
| IpsecVpnLocalPeerType | Gives more details of local peer end point. | 1.5 |
| IpsecVpnManagedPeerType | Gives more details of peer end point. | 1.5 |
| IpsecVpnPeerType | Gives more details of peer end point. | 1.5 |
| IpsecVpnRemotePeerType | Gives more details of remote peer end point. | 1.5 |
| IpsecVpnServiceType | Represents an IPSec-VPN network service. | 1.5 |
| IpsecVpnSubnetType | Represents subnet details. | 5.1 |
| IpsecVpnThirdPartyPeerType | Gives more details of third party peer end point. | 1.5 |
| IpsecVpnTunnelType | Represents details of an IPSec-VPN tunnel. | 1.5 |
| IpsecVpnUnmanagedPeerType | Gives more details of peer end point not managed by vCloud Director. | 1.5 |
| IpTypeType | Represents an IP type, either IPv4 or IPv6 | 34.0 |
| KeystoreUpdateParamsType | Parameters for keystore update. | 5.1 |
| KeystoreUploadSocketType | Upload socket for keystore. | 5.1 |
| LBPersistenceType | Represents persistence type for a load balancer service profile. | 5.1 |
| LBPoolHealthCheckType | Represents a service port health check list. | 5.1 |
| LBPoolMemberType | Represents a member in a load balancer pool. | 5.1 |
| LBPoolServicePortType | Represents a service port in a load balancer pool. | 5.1 |
| LBVirtualServerServiceProfileType | Represents service profile for a load balancing virtual server. | 5.1 |
| LeaseSettingsSectionType | Represents vApp lease settings. | 0.9 |
| LinkType | Extends reference type by adding relation attribute. | 0.9 |
| LoadBalancerPoolType | Represents a load balancer pool. | 5.1 |
| LoadBalancerServiceType | Represents gateway load balancer service. | 5.1 |
| LoadBalancerVirtualServerType | Represents a load balancer virtual server. | 5.1 |
| LocalityParamsType | Locality parameters provide a hint that may help optimize placement of a VM with respect to another VM or an independent disk. | 5.1 |
| MediaInsertOrEjectParamsType | Parameters for an insertMedia or ejectMedia request. | 0.9 |
| MediaSectionType | The section of the VM representation that has to do with the VM's media devices (floppies and CDROM) | 32.0 |
| MediaSettingsType | Describes a media in a VM device and what media is attached to it. | 32.0 |
| MediaStateType | Describes the possible configuration states of a media device. | 32.0 |
| MediaType | Represents a Media object. | 0.9 |
| MediaTypeMappingType | Mapping of a content media type to a xsd complex type. | 0.9 |
| MediaTypeType | Represents media supported by VM. | 32.0 |
| MetadataBooleanValue | One of: 1, 0, true, false | 5.1 |
| MetadataDateTimeValue | UTC format. | 5.1 |
| MetadataDomainTagType | A value of SYSTEM places this MetadataEntry in the SYSTEM domain. | 5.1 |
| MetadataEntryType | ||
| MetadataNumberValue | A signed 8-byte integer. | 5.1 |
| MetadataStringValue | UTF-8 character set. | 5.1 |
| MetadataType | User-defined metadata associated with with an object. | 1.5 |
| MetadataTypedValue | One of: MetadataStringValue MetadataNumberValue MetadataBooleanValue MetadataDateTimeValue |
5.1 |
| MetadataValueType | ||
| MksTicketType | A ticket and connection information for accessing the console of a VM. | 5.5 |
| MoveVAppParamsType | Parameters for a MoveVApp request. | 34.0 |
| MultisiteSessionUserInfoType | Container for MultisiteSessionUserInfoType | 30.0 |
| MultisiteType | site vCloud configuration. | 29.0 |
| NatOneToOneBasicRuleType | Represents the NAT basic rule for one to one mapping of internal and external IP addresses from a network. | 0.9 |
| NatOneToOneVmRuleType | Represents the NAT rule for one to one mapping of VM NIC and external IP addresses from a network. | 0.9 |
| NatPortForwardingRuleType | Represents the NAT rule for port forwarding between internal IP/port and external IP/port. | 0.9 |
| NatRuleType | Represents a NAT rule. | 0.9 |
| NatServiceType | Represents a NAT network service. | |
| NatVmRuleType | Represents the NAT rule for port forwarding between VM NIC/port and external IP/port. | 0.9 |
| NetworkAssignmentType | 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 |
| NetworkConfigSectionType | Container for vApp networks. | 0.9 |
| NetworkConfigurationType | The configurations applied to a network. | 0.9 |
| NetworkConnectionSectionType | Container for the network connections of this virtual machine. | 0.9 |
| NetworkConnectionType | Represents a network connection in the virtual machine. | 0.9 |
| NetworkFeaturesType | Represents features of a network. | |
| NetworkMappingType | Represents a mapping from an OVF source network to a vCloud target network. | 5.5 |
| NetworkServiceInsertionType | Information about a network service that has been inserted | 5.1 |
| NetworkServiceType | This is the root of the substitution group for network services. | |
| NetworkType | Represents a Network in the vCloud model. | 0.9 |
| NICBaseType | ||
| NicIpMapType | VM's with NICs that are connected directly to a VDC network and where the NICs have manually assigned IP addresses needs to be mapped to a valid IP address within the IP range of the destination site's VDC network. | 5.5 |
| NicIpMapType/Entry | 5.5 | |
| NICType | Represents a supported virtual NIC type. | 1.5 |
| OperatingSystemFamilyInfoType | Represents an operating system family. | 5.1 |
| OperatingSystemInfoType | Information about an individual operating system. | 5.1 |
| OrgAssociationsType | Container for OrgAssociationType | 29.0 |
| OrgAssociationType | A reference to another organization | 29.0 |
| OrgListType | Represents a list of organizations. | 0.9 |
| OrgType | Represents the user view of a vCloud Director organization. | 0.9 |
| OrgVdcNetworkType | Represents an Org vDC network in the vCloud model. | 5.1 |
| OrgVdcRollupType | Contains rolled-up summary information for all vDCs in this organization. | 30.0 |
| OvfToVdcNetworkMapType | Map from OVF to Org networks. | 5.5 |
| OvfToVdcNetworkMapType/Entry | 5.5 | |
| OwnerType | Represents the owner of this entity. | 1.5 |
| ParamsType | A basic type used to specify request parameters. | 0.9 |
| PayGoVdcSummaryType | Represents the summary of consumed CPU, memory, and storage for a vDC using the AllocationVApp (Pay-as-you-Go) allocation model. | 30.0 |
| PhasesType | An extensibility phase represents a point in a workflow where control can be passed to an extension. | 16.0 |
| PhasesType/Phase | ||
| PhasesType/Phase/name | ||
| PhasesType/Phase/optional | ||
| PhasesType/Phase/type | ||
| ProductSectionListType | Container for all ProductSection elements in a VAppTemplate, VApp, or Vm object. | |
| PropertyType | Contains key/value pair as property. | 0.9 |
| PublishCatalogParamsType | Parameters required when sharing a catalog with other organizations. | 0.9 |
| QueryListType | Container for the list of typed queries available to the requesting user. | |
| QueryResultAclRuleRecordType | Type for a single aclRule query result in records format. | 5.1 |
| QueryResultAdminApiDefinitionRecordType | Type for a single adminApiDefinition query result in records format. | 5.1 |
| QueryResultAdminCatalogItemRecordType | Type for a single adminCatalogItem query result in records format. | 1.5 |
| QueryResultAdminCatalogRecordType | Type for a single adminCatalog query result in records format. | 1.5 |