vCloud REST API Types

Types


Types (275)

Type Description Since
AmqpSettingsTestType Represents the result from AMQP settings test. 1.5
AmqpSettingsType Represents the settings for the AMQP broker. 1.5
BlockingTaskOperationParamsType Parameters to POST with a blocking task action. 1.5
BlockingTaskSettingsType Represents the settings related to blocking tasks. 1.5
BlockingTaskSettingsType/TimeoutInMilliseconds
BlockingTaskType Describes a blocking task request. 1.5
BlockingTaskUpdateProgressParamsType Parameters to update a blocking task with a new timeout. 1.5
BrandingSettingsType BrandingSettings stores all information about how to brand the product for vCloud service, like provider name, logo etc. 1.5
DatastoreType Represents datastore object. 1.5
DatastoreType/ThresholdRedGb
DatastoreType/ThresholdYellowGb
EmailSettingsType Represent all the email related settings in the system. 1.5
FencePoolType Represents a network pool backed by one or more vSphere isolated networks. 1.0
GeneralSettingsType Represents the general part of the system settings. 1.5
HostType Read only representation of one host in a vSphere server. 1.0
ImportMediaParamsType Represents parameters to import media from vSphere. 1.5
ImportVmAsVAppParamsType Parameters to import a virtual machine as a vApp. 1.0
ImportVmAsVAppTemplateParamsType Parameters to import a virtual machine as a vApp template. 1.0
ImportVmIntoExistingVAppParamsType Parameters to import a virtual machine into an existing VApp. 1.5
LdapGroupAttributesType Defines how a group is imported from LDAP. 1.5
LdapSettingsType Defines the hostname and connection details for system LDAP service. 1.5
LdapUserAttributesType Defines how LDAP attributes are used when importing a user. 1.5
LicenseMetricsInfoType Report of License usage metrics. 1.5
LicenseType This is used by the API to update and retrieve site license specific information. 1.5
LicensingManagedServerType Captures a single set of metrics for a managed server for a given sample. 1.0
LicensingReportListType Represents a list of licensing reports. 1.0
LicensingReportSampleType Represents a single licensing data collection point. 1.0
LicensingReportSampleType/ManagedServerMetrics
LicensingReportSampleType/VirtualMachineMetrics
LicensingReportType Represents a read-only licensing metric report. 1.0
LicensingVirtualMachineType Represents a single set of virtual machine metrics. 1.0
NotificationType
NotificationsSettingsType Represents the settings related to Notifications. 1.5
NumericRangeType Range of integers. 0.9
OrganizationResourcePoolSetType Represents a set of resource pools that back an organization vDC. 1.5
PortGroupPoolType Represents a network pool backed by one or more vSphere port groups. 1.0
PrepareHostParamsType Parameters for preparing an ESX/ESXi host. 0.9
RegisterVimServerParamsType Represents parameters to register a vCenter server. 0.9
ResourcePoolListType Represents a list of available resource pools that have not been assigned to any vDCs (provider or org). 1.0
ResourcePoolType vSphere resource pool information. 0.9
ServerType Information needed to connect to a vSphere or a vShield manager server. 0.9
ShieldManagerType Represents credentials to a vShield Manager server. 0.9
SmtpSettingsType The SMTP server for email notifications and alerts. 1.5
SystemPasswordPolicySettingsType Represents the settings related to Password Policy. 1.5
SystemPasswordPolicySettingsType/AccountLockoutIntervalMinutes
SystemSettingsType Represents the settings of the system. 1.5
UberAdminSettingsType Internal use only. 1.5
UpdateResourcePoolSetParamsType Represents update parameters for resource pools backing provider vdc 1.5
VMWExtensionType List links to extension operations and entities. 1.0
VMWExternalNetworkReferencesType Represents a list of available external networks. 1.0
VMWExternalNetworkType External network type. 1.0
VMWHostReferencesType Represents a list of available hosts. 1.0
VMWNetworkPoolReferencesType Represents a list of available network pools. 1.0
VMWNetworkPoolType Base extension network pool type. 1.0
VMWProviderVdcReferencesType Represents a list of available provider vDCs. 1.0
VMWProviderVdcResourcePoolSetType Represents backing resource pool set 1.5
VMWProviderVdcResourcePoolType Represents backing resource pool for provider vDC. 1.5
VMWProviderVdcType Extension representation of provider vDC type. 1.0
VMWVimServerReferencesType List of references to vCenter servers registered to vCloud Director. 1.0
VimObjectRefListType
VimObjectRefType Represents the moref and the type of a vSphere object. 0.9
VimObjectRefsType List of VimObjectRef elements. 0.9
VimServerType Represents vCenter server information. 0.9
VlanPoolType Represents a network pool backed by one or more vSphere VLANs. 1.0
VmObjectRefType A reference to a virtual machine in vCenter inventory. 1.0
VmObjectRefsListType A list of references to virtual machines in vCenter inventory. 1.0
VmVimInfoType Represents a vSphere VM information. 1.5
AbstractVAppType Represents a base type for VAppType and VmType. 0.9
AccessSettingType Specifies who can access the resource. 0.9
AccessSettingsType A list of access settings for a resource. 0.9
AdminCatalogType Admin representation of the container for meta data (key-value pair) associated to different entities in the system. 1.5
AdminOrgType The AdminOrgType represents an administrative view of an organization. 0.9
AdminVdcType Provides an administrative view of a vDC. 0.9
AvailableNetworksType Represents a list of references to available networks. 0.9
CapabilitiesType Collection of supported hardware capabilities. 1.5
CapacityType Represents a capacity of a given resource. 0.9
CapacityWithUsageType Represents a capacity and usage of a given resource. 0.9
CaptureVAppParamsType Represents the parameters for capturing a vApp to a vApp template. 0.9
CatalogItemType Contains a reference to a VappTemplate or Media object and related metadata. 0.9
CatalogItemsType Represents a list of catalog item references. 0.9
CatalogType Container for references to VappTemplate and Media objects. 0.9
CatalogsListType Container for ReferenceType elements that reference catalogs. 0.9
CloneMediaParamsType Represents parameters for copying a media resource and optionally deleting the source. 0.9
CloneVAppParamsType Represents parameters for copying a vApp and optionally deleting the source. 0.9
CloneVAppTemplateParamsType Represents parameters for copying a vApp template and optionally deleting the source. 0.9
ComposeVAppParamsType Represents vApp composition parameters. 0.9
ComputeCapacityType Represents a compute capacity with units. 0.9
ContainerType Container for query result sets.
ControlAccessParamsType Used to control access to resources. 0.9
CustomOrgLdapSettingsType Used when OrgLdapMode=CUSTOM to define connection details for the organization's LDAP service. 0.9
CustomizationSectionType Represents a vApp template customization settings section. 1.0
DeployVAppParamsType Represents vApp/VM deployment parameters. 0.9
DhcpServiceType Represents a DHCP network service.
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
ExternalNetworkType Admin representation of external network. 1.0
FileType Represents a file to be transferred (uploaded or downloaded). 0.9
FilesListType Represents a list of files to be transferred (uploaded or downloaded). 0.9
FirewallIpAddressType A valid IPv4 address or "Any". 0.9
FirewallRuleType Represents a firewall rule. 0.9
FirewallRuleType/Protocols
FirewallServiceType Represents a network firewall service.
GroupType Represents group in the system. 0.9
GroupsListType Container for ReferenceType elements that reference groups. 0.9
GuestCustomizationSectionType Represents a guest customization settings. 1.0
InstantiateOvfParamsType Represents vApp instantiation from OVF parameters
InstantiateVAppParamsType Represents vApp instantiation parameters. 0.9
InstantiateVAppTemplateParamsType Represents vApp template instantiation parameters. 0.9
InstantiationParamsType Represents a list of ovf:Section to configure for instantiating a VApp. 0.9
IpAddressType A valid IPv4 address or "Any". 0.9
IpAddressesType A list of IP addresses. 0.9
IpRangeType Represents a range of IP addresses, start and end inclusive. 0.9
IpRangesType Represents a list of IP ranges. 0.9
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
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
LeaseSettingsSectionType Represents the lease settings section for a vApp. 0.9
LinkType Extends reference type by adding relation attribute. 0.9
MediaInsertOrEjectParamsType Represents parameters for inserting/ejecting media to VM. 0.9
MediaType Represents a media. 0.9
MetadataEntryType
MetadataType
MetadataValueType
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 Represents mapping between a VM and vApp network. 0.9
NetworkConfigSectionType Represents the network config section of a vApp. 0.9
NetworkConfigurationType The configurations applied to a network. 0.9
NetworkConnectionSectionType Represents a list of network cards existing in a VM. 0.9
NetworkConnectionType Represents a network connection. 0.9
NetworkFeaturesType Represents features of a network.
NetworkPoolReferencesType List of network pools in this vDC. 0.9
NetworkPoolType Represents a network pool. 0.9
NetworkServiceType This is the root type of all NetworkServices
NetworkType Represents a Network in the vCloud model. 0.9
NetworksType Container for ReferenceType elements that reference ExternalNetwork objects. 0.9
OrgEmailSettingsType Defines the email settings for an organization. 0.9
OrgGeneralSettingsType Defines general og settings. 1.5
OrgLdapGroupAttributesType Defines how a group is imported from LDAP. 0.9
OrgLdapSettingsType Base settings for LDAP connection 1.5
OrgLdapUserAttributesType Defines how LDAP attributes are used when importing a user. 0.9
OrgLeaseSettingsType Defines default lease durations and policies for an organization. 0.9
OrgListType Represents a list of organizations. 0.9
OrgNetworkType Represents an organization network in the vCloud model. 0.9
OrgPasswordPolicySettingsType Represents the settings related to Password Policy. 1.5
OrgSettingsType Describes various settings for some organization. 0.9
OrgType Represents an organization. 0.9
OrgVAppTemplateLeaseSettingsType Defines default lease policies for vAppTemplate on organization level. 1.5
OrganizationReferenceType Represents a reference to an Organization. 0.9
OrganizationReferencesType Container for OrganizationReferenceType elements that reference AdminOrgType objects. 0.9
OwnerType Represents the owner of this entity. 1.5
ParamsType A basic type used to specify parameters for operations. 0.9
ProductSectionListType Essentially a container with a list of product sections.
PropertyType Contains key/value pair as property. 0.9
ProviderVdcCapacityType Represents resource capacity in a provider vDC. 0.9
ProviderVdcReferencesType Container for ReferenceType elements that reference ProviderVdcType objects. 0.9
ProviderVdcType Provider vDC read only type. 0.9
PublishCatalogParamsType Parameters used when publishing catalogs. 0.9
QueryListType Container for the list of typed queries available to the requesting user.
QueryResultAdminAllocatedExternalAddressRecordType Represents the results from a AdminAllocatedExternalAddress vCloud query as a record. 1.5
QueryResultAdminCatalogItemRecordType Represents the results from a AdminCatalogItem vCloud query as a record. 1.5
QueryResultAdminCatalogRecordType Represents the results from a AdminCatalog vCloud query as a record. 1.5
QueryResultAdminGroupRecordType Represents the results from a AdminGroup vCloud query as a record. 1.5
QueryResultAdminMediaRecordType Represents the results from a AdminMedia vCloud query as a record. 1.5
QueryResultAdminOrgNetworkRecordType Represents the results from a AdminOrgNetwork vCloud query as a record. 1.5
QueryResultAdminShadowVMRecordType Represents the results from a AdminShadowVM vCloud query as a record. 1.5
QueryResultAdminTaskRecordType Represents the results from a AdminTask vCloud query as a record. 1.5
QueryResultAdminUserRecordType Represents the results from a AdminUser vCloud query as a record. 1.5
QueryResultAdminVAppNetworkRecordType Represents the results from a AdminVAppNetwork vCloud query as a record. 1.5
QueryResultAdminVAppRecordType Represents the results from a AdminVApp vCloud query as a record. 1.5
QueryResultAdminVAppTemplateRecordType Represents the results from a AdminVAppTemplate vCloud query as a record. 1.5
QueryResultAdminVMRecordType Represents the results from a AdminVM vCloud query as a record. 1.5
QueryResultAdminVdcRecordType Represents the results from a AdminVdc vCloud query as a record. 1.5
QueryResultAllocatedExternalAddressRecordType Represents the results from a AllocatedExternalAddress vCloud query as a record. 1.5
QueryResultBlockingTaskRecordType Represents the results from a BlockingTask vCloud query as a record. 1.5
QueryResultCatalogItemRecordType Represents the results from a CatalogItem vCloud query as a record. 1.5
QueryResultCatalogRecordType Represents the results from a Catalog vCloud query as a record. 1.5
QueryResultCellRecordType Represents the results from a Cell vCloud query as a record. 1.5
QueryResultDatastoreProviderVdcRelationRecordType Represents the results from a DatastoreProviderVdcRelation vCloud query as a record. 1.5
QueryResultDatastoreRecordType Represents the results from a Datastore vCloud query as a record. 1.5
QueryResultDvSwitchRecordType Represents the results from a DvSwitch vCloud query as a record. 1.5
QueryResultEventRecordType Represents the results from a Event vCloud query as a record. 1.5
QueryResultGroupRecordType Represents the results from a Group vCloud query as a record. 1.5
QueryResultHostRecordType Represents the results from a Host vCloud query as a record. 1.5
QueryResultMediaRecordType Represents the results from a Media vCloud query as a record. 1.5
QueryResultNetworkPoolRecordType Represents the results from a NetworkPool vCloud query as a record. 1.5
QueryResultNetworkRecordType Represents the results from a Network vCloud query as a record. 1.5
QueryResultOrgNetworkRecordType Represents the results from a OrgNetwork vCloud query as a record. 1.5
QueryResultOrgRecordType Represents the results from a Org vCloud query as a record. 1.5
QueryResultOrgVdcRecordType Represents the results from a OrgVdc vCloud query as a record. 1.5
QueryResultOrgVdcResourcePoolRelationRecordType Represents the results from a OrgVdcResourcePoolRelation vCloud query as a record. 1.5
QueryResultPortgroupRecordType Represents the results from a Portgroup vCloud query as a record. 1.5
QueryResultProviderVdcResourcePoolRelationRecordType Represents the results from a ProviderVdcResourcePoolRelation vCloud query as a record. 1.5
QueryResultRecordType Base type for query result Records.
QueryResultRecordsType Represents the results from a vCloud query as records. 1.5
QueryResultResourcePoolRecordType Represents the results from a ResourcePool vCloud query as a record. 1.5
QueryResultRightRecordType Represents the results from a Right vCloud query as a record. 1.5
QueryResultRoleRecordType Represents the results from a Role vCloud query as a record. 1.5
QueryResultStrandedUserRecordType Represents the results from a StrandedUser vCloud query as a record. 1.5
QueryResultTaskRecordType Represents the results from a Task vCloud query as a record. 1.5
QueryResultType Represents a result from a vCloud query. 1.5
QueryResultUserRecordType Represents the results from a User vCloud query as a record. 1.5
QueryResultVAppNetworkRecordType Represents the results from a VAppNetwork vCloud query as a record. 1.5
QueryResultVAppOrgNetworkRelationRecordType Represents the results from a VAppOrgNetworkRelation vCloud query as a record. 1.5
QueryResultVAppRecordType Represents the results from a VApp vCloud query as a record. 1.5
QueryResultVAppTemplateRecordType Represents the results from a VAppTemplate vCloud query as a record. 1.5
QueryResultVMRecordType Represents the results from a VM vCloud query as a record. 1.5
QueryResultVMWProviderVdcRecordType Represents the results from a VMWProviderVdc vCloud query as a record. 1.5
QueryResultVirtualCenterRecordType Represents the results from a VirtualCenter vCloud query as a record. 1.5
RasdItemsListType Represents a list of RASD items. 0.9
RecomposeVAppParamsType Represents vApp re-composition parameters. 1.0
ReferenceType A reference to a resource. 0.9
ReferencesType This is the container for returned elements in referenceView
RelocateParamsType Parameters to be used for vm relocation. 1.5
RequestOperationParamsType Represents parameters to a request. 1.5
ResourceEntitiesType Represents a list of references to resource entities. 0.9
ResourceEntityType Base type that represents a resource entity such as a vApp template or virtual media. 0.9
ResourceReferenceType Represents a reference to a resource. 0.9
ResourceType The base type for all objects in the vCloud model. 0.9
RightReferencesType Container for ReferenceType elements that reference the predefined RightType objects. 0.9
RightType Represents a right in the system. 0.9
RoleReferencesType Container for ReferenceType elements that reference RoleType objects. 0.9
RoleType Particular role that has a collection of rights. 0.9
RootComputeCapacityType Represents compute capacity with units. 0.9
RouterInfoType
RuntimeInfoSectionType Runtime information for a specific vm 1.5
RuntimeInfoSectionType/VMWareTools
ScreenTicketType The ticket for accessing the console of a VM. 0.9
SerialPortConfigType Internal use only. 1.5
SessionType Represents a vCloud Session. 1.5
SmtpServerSettingsType Specifies connection details for the organization s SMTP server. 0.9
SourcedCompositionItemParamType Represents a composition item. 0.9
StaticRouteType
StaticRoutingServiceType Represents Static Routing network service. 1.5
SupportedHardwareVersionType Supported hardware version. 1.5
SupportedHardwareVersionsType Represents a list of supported VM hardware versions. 1.5
SyslogServerSettingsType Syslog server settings. 1.5
TaskOperationListType List of operation names. 1.5
TaskRequestBaseType Represents generic request to a task. 1.5
TaskType Represents an asynchronous or long-running task in the vCloud environment. 0.9
TasksInProgressType A list of queued, running, or recently completed tasks. 0.9
TasksListType A list of tasks. 0.9
UndeployVAppParamsType Represents vApp/VM undeployment parameters. 0.9
UploadVAppTemplateParamsType Represents vApp Template upload parameters. 0.9
UserType Represents users in the vCloud system. 0.9
UsersListType Container for ReferenceType elements that reference users. 0.9
VAppChildrenType Represents vApp children. 0.9
VAppCreationParamsType Represents vApp creation parameters. 0.9
VAppNetworkConfigurationType Represents a VApp network configuration. 0.9
VAppNetworkType Represents a vApp network. 1.5
VAppTemplateChildrenType Represents vApp template children. 0.9
VAppTemplateType Represents a vApp template. 0.9
VAppType Represents a vApp. 0.9
VCloudExtensibleType A base abstract type for all complex types that support extensions. 0.9
VCloudExtensionType Cloud API extension type with any elements and any attributes. 0.9
VCloudType Top level container representing the cloud from the administrator's point of view. 0.9
VdcReferencesType List of organization vDCs backed by this provider vDC. 1.0
VdcType Represents a virtual data center (vDC). 0.9
VdcsType Represents a list of references to virtual data centers. 0.9
VmPendingQuestionType Represents a question which vSphere issued for a VM in a stuck state(WAITING_FOR_INPUT). 0.9
VmQuestionAnswerChoiceType Represents a pair of ID and text of an answer choice of a VM question. 0.9
VmQuestionAnswerType Represents a VM answer to a question when the VM is in a stuck (WAITING_FOR_INPUT) state. 0.9
VmType Represents a VM. 0.9