vCloud API All Queries
vCloud API All Queries
All Queries
All Queries (89)
| Type Name | Description | User | Admin | System | Format | Records Result | Since | Deprecated |
|---|---|---|---|---|---|---|---|---|
| aclRule | All ACL rules defined in the system by extension services. | - | - | YES | All | QueryResultRecords of (AclRuleRecord) | 5.1 | - |
| adminAllocatedExternalAddress | All allocated external IP addresses in the system and the networks that use them. | - | - | YES | records,idrecords | QueryResultRecords of (AdminAllocatedExternalAddressRecord) | 5.1 | |
| adminApiDefinition | System Administrator representation of all extension service API definitions. | - | - | YES | All | QueryResultRecords of (AdminApiDefinitionRecord) | 5.1 | - |
| adminCatalog | All catalogs in the system. | - | - | YES | All | QueryResultRecords of (AdminCatalogRecord) | - | |
| adminCatalogItem | Catalog items in all catalogs in the system. | - | - | YES | All | QueryResultRecords of (AdminCatalogItemRecord) | - | |
| adminDisk | All independent disks in the system. | - | - | YES | All | QueryResultRecords of (AdminDiskRecord) | 5.1 | - |
| adminEvent | All stored event records in the system. | - | - | YES | All | QueryResultRecords of (AdminEventRecord) | 5.1 | - |
| adminEventCBM | All stored event records in the system for chargeback integration. | - | - | - | records,idrecords | QueryResultRecords of (AdminEventCBMRecord) | 5.1 | - |
| adminFileDescriptor | System Administrator representation of all API filters defined in the system by extension services. | - | - | YES | All | QueryResultRecords of (AdminFileDescriptorRecord) | 5.1 | - |
| adminGroup | Groups in all organizations in the system. | - | - | YES | All | QueryResultRecords of (AdminGroupRecord) | - | |
| adminMedia | All media in the system. | - | - | YES | All | QueryResultRecords of (AdminMediaRecord) | - | |
| adminOrgNetwork | All organization networks in the system. | - | - | YES | All | QueryResultRecords of (AdminOrgNetworkRecord) | 5.1 | |
| adminOrgVdc | All organization vDCs in the system. | - | - | YES | All | QueryResultRecords of (AdminVdcRecord) | - | |
| adminOrgVdcStorageProfile | All organization VDC storage profiles in the system. | - | - | YES | All | QueryResultRecords of (AdminOrgVdcStorageProfileRecord) | 5.1 | - |
| adminService | System Administrator representation of all extension services registered with the system. | - | - | YES | All | QueryResultRecords of (AdminServiceRecord) | 5.1 | - |
| adminServiceOfferingInstance | All service offering instances visible to admins | - | - | - | All | QueryResultRecords of (AdminServiceOfferingInstanceRecord) | 5.5 | - |
| adminShadowVM | All shadow VMs in the system. | - | - | YES | All | QueryResultRecords of (AdminShadowVMRecord) | - | |
| adminTask | All active or recently completed tasks in the system. | - | - | YES | All | QueryResultRecords of (AdminTaskRecord) | - | |
| adminUser | Users in all organizations in the system. | - | - | YES | All | QueryResultRecords of (AdminUserRecord) | - | |
| adminVApp | All vApps in the system. | - | - | YES | All | QueryResultRecords of (AdminVAppRecord) | - | |
| adminVAppNetwork | All vApp networks in the system. | - | - | YES | All | QueryResultRecords of (AdminVAppNetworkRecord) | - | |
| adminVAppTemplate | All vApp templates in the system. | - | - | YES | All | QueryResultRecords of (AdminVAppTemplateRecord) | - | |
| adminVM | All VMs in vApps or vApp templates in the system. | - | - | YES | All | QueryResultRecords of (AdminVMRecord) | - | |
| adminVMDiskRelation | Independent disks in the system that are attached to a VM. | - | - | YES | records,idrecords | QueryResultRecords of (AdminVmDiskRelationRecord) | 5.1 | - |
| allocatedExternalAddress | All allocated external IP addresses in your organization and the networks that use them. | - | YES | - | records,idrecords | QueryResultRecords of (AllocatedExternalAddressRecord) | 5.1 | |
| apiDefinition | All extension service API definitions. | YES | YES | YES | All | QueryResultRecords of (ApiDefinitionRecord) | 5.1 | - |
| apiFilter | All API filters defined in the system for extension services. | - | - | YES | All | QueryResultRecords of (ApiFilterRecord) | 5.1 | - |
| blockingTask | All active blocking tasks in the system. | - | - | YES | All | QueryResultRecords of (BlockingTaskRecord) | - | |
| catalog | All catalogs in your organization that you have rights to view or modify. | YES | YES | - | All | QueryResultRecords of (CatalogRecord) | - | |
| catalogItem | All catalogs in your organization that you have rights to view or modify. | YES | YES | - | All | QueryResultRecords of (CatalogItemRecord) | - | |
| cell | All vCloud Director cells supporting this cloud. | - | - | YES | records,idrecords | QueryResultRecords of (CellRecord) | - | |
| condition | System alerts for objects that have errors or warnings. | - | - | YES | records,idrecords | QueryResultRecords of (ConditionRecord) | 5.1 | - |
| datastore | All datastores in the system. | - | - | YES | All | QueryResultRecords of (DatastoreRecord) | - | |
| datastoreProviderVdcRelation | All datastores in the system and the Provider vDCs that use them. | - | - | YES | records,idrecords | QueryResultRecords of (DatastoreProviderVdcRelationRecord) | - | |
| disk | All independent disks in your organization. | YES | YES | - | All | QueryResultRecords of (DiskRecord) | 5.1 | - |
| dvSwitch | All vCenter distributed virtual switches available for use by the system. | - | - | YES | records,idrecords | QueryResultRecords of (DvSwitchRecord) | - | |
| edgeGateway | All Edge Gateways in your organization. | - | YES | YES | All | QueryResultRecords of (EdgeGatewayRecord) | 5.1 | - |
| event | Stored event records in your organization. | YES | YES | YES | records,idrecords | QueryResultRecords of (EventRecord) | - | |
| externalLocalization | Localization resources for all registered extension services. | - | - | YES | records,idrecords | QueryResultRecords of (ExternalLocalizationRecord) | 5.1 | - |
| externalNetwork | External networks in the system. | - | - | YES | All | QueryResultRecords of (NetworkRecord) | - | |
| fileDescriptor | All file descriptors defined in the system by extension services. | YES | YES | YES | records,idrecords | QueryResultRecords of (FileDescriptorRecord) | 5.1 | - |
| fromCloudTunnel | From-the-cloud tunnels. | YES | YES | YES | All | QueryResultRecords of (FromCloudTunnelRecord) | 6.0 | - |
| group | All groups in your organization. | YES | YES | - | All | QueryResultRecords of (GroupRecord) | - | |
| host | ESX/ESXi hosts registered to the system. | - | - | YES | All | QueryResultRecords of (HostRecord) | - | |
| licensingManagedServer | Licensing Metrics for Managed Servers. | - | - | - | records,idrecords | QueryResultRecords of (LicensingManagedServerRecord) | 5.5 | - |
| licensingReport | Licensing Reports. | - | - | - | records,idrecords | QueryResultRecords of (LicensingReportRecord) | 5.5 | - |
| licensingReportSample | Licensing Report Samples. | - | - | - | records,idrecords | QueryResultRecords of (LicensingReportSampleRecord) | 5.5 | - |
| licensingVirtualMachine | Licensing Metrics for Virtual Machine. | - | - | - | records,idrecords | QueryResultRecords of (LicensingVirtualMachineRecord) | 5.5 | - |
| media | All media that you can view or modify. | YES | YES | - | All | QueryResultRecords of (MediaRecord) | - | |
| networkPool | All network pools in the system. | - | - | YES | All | QueryResultRecords of (NetworkPoolRecord) | - | |
| orgNetwork | Networks in your organization. | YES | YES | - | All | QueryResultRecords of (OrgNetworkRecord) | - | |
| orgVdc | All VDCs in your organization. | YES | YES | - | All | QueryResultRecords of (OrgVdcRecord) | - | |
| orgVdcNetwork | All organization VDC networks in your organization. | - | YES | YES | All | QueryResultRecords of (OrgVdcNetworkRecord) | 5.1 | - |
| orgVdcResourcePoolRelation | All resource pools in the system and the organization vDCs that use them. | - | - | YES | records,idrecords | QueryResultRecords of (OrgVdcResourcePoolRelationRecord) | - | |
| orgVdcStorageProfile | All organization VDC storage profiles in your organization. | YES | YES | - | All | QueryResultRecords of (OrgVdcStorageProfileRecord) | 5.1 | - |
| organization | All organizations visible to you. | - | YES | YES | All | QueryResultRecords of (OrgRecord) | - | |
| portgroup | All vCenter portgroups in the system. | - | - | YES | records,idrecords | QueryResultRecords of (PortgroupRecord) | - | |
| providerVdc | All provider vDCs in the system. | - | - | YES | All | QueryResultRecords of (VMWProviderVdcRecord) | - | |
| providerVdcResourcePoolRelation | All resource pools in the system and the Provider vDCs that use them. | - | - | YES | records,idrecords | QueryResultRecords of (ProviderVdcResourcePoolRelationRecord) | - | |
| providerVdcStorageProfile | All Provider VDC storage profiles in the system. | - | - | YES | All | QueryResultRecords of (ProviderVdcStorageProfileRecord) | 5.1 | - |
| resourceClass | All resources classes defined in the system by extension services. | - | - | YES | All | QueryResultRecords of (ResourceClassRecord) | 5.1 | - |
| resourceClassAction | All resource class actions defined in the system by extension services. | - | - | YES | All | QueryResultRecords of (ResourceClassActionRecord) | 5.1 | - |
| resourcePool | All resource pools in the system. | - | - | YES | records,idrecords | QueryResultRecords of (ResourcePoolRecord) | - | |
| resourcePoolVmList | All VMs in the system and the resource pools they use. | - | - | YES | All | QueryResultRecords of (ResourcePoolVMRecord) | 5.1 | - |
| right | All rights defined in the system. | - | YES | YES | All | QueryResultRecords of (RightRecord) | - | |
| role | All roles defined in the system. | - | YES | YES | All | QueryResultRecords of (RoleRecord) | - | |
| service | All extension services registered with the system. | YES | YES | YES | All | QueryResultRecords of (ServiceRecord) | 5.1 | - |
| serviceExtension | Service extensions that provides service offerings. | - | - | - | All | QueryResultRecords of (ServiceExtensionRecord) | 5.5 | - |
| serviceLink | All service links defined by extension services. | - | - | YES | All | QueryResultRecords of (ServiceLinkRecord) | 5.1 | - |
| serviceOffering | All service offerings from extensions | - | - | - | All | QueryResultRecords of (ServiceOfferingRecord) | 5.5 | - |
| serviceOfferingInstance | All service offering instances visible to you. | - | - | - | All | QueryResultRecords of (ServiceOfferingInstanceRecord) | 5.5 | - |
| serviceResource | All service resources defined in the system by extension services. | - | - | YES | All | QueryResultRecords of (ServiceResourceRecord) | 5.1 | - |
| strandedItem | All stranded items in the system. | - | - | YES | All | QueryResultRecords of (StrandedItemRecord) | 5.1 | - |
| strandedUser | "All stranded users. When you delete an LDAP group, users who were imported from that group become stranded and cannot log in." | - | YES | YES | All | QueryResultRecords of (StrandedUserRecord) | - | |
| task | Active and recently completed tasks in your organization. | YES | YES | YES | All | QueryResultRecords of (TaskRecord) | - | |
| toCloudTunnel | To-the-cloud tunnels. | YES | YES | YES | All | QueryResultRecords of (ToCloudTunnelRecord) | 5.6 | - |
| user | Users in your organization. | YES | YES | - | All | QueryResultRecords of (UserRecord) | - | |
| vApp | All vApps that you can view or modify | YES | YES | - | All | QueryResultRecords of (VAppRecord) | - | |
| vAppNetwork | All vApp networks in your organization. | YES | YES | - | All | QueryResultRecords of (VAppNetworkRecord) | - | |
| vAppOrgNetworkRelation | vApps visible to you and their connections to organization networks. | - | YES | YES | All | QueryResultRecords of (VAppOrgNetworkRelationRecord) | 5.1 | |
| vAppOrgVdcNetworkRelation | vApps accessible to you and their connections to organization VDC networks. | - | YES | YES | All | QueryResultRecords of (VAppOrgVdcNetworkRelationRecord) | 5.1 | - |
| vAppTemplate | All vApp templates in your organization. | YES | YES | - | All | QueryResultRecords of (VAppTemplateRecord) | - | |
| vchsEdgeGateway | Summary Information for a specific edge gateway. | - | - | YES | All | QueryResultRecords of (VchsEdgeGatewayRecord) | 5.7 | - |
| vchsOrgVdcNetwork | Summary Information for a specific Org Vdc Network. | - | - | YES | All | QueryResultRecords of (VchsOrgVdcNetworkRecord) | 5.7 | - |
| vdcServiceOffering | All service offerings visible to VDCs. | - | - | - | All | QueryResultRecords of (VdcServiceOfferingRecord) | 5.5 | - |
| virtualCenter | All vCenter servers registered to the system. | - | - | YES | All | QueryResultRecords of (VirtualCenterRecord) | - | |
| vm | All VMs in your organization that you can view or modify. | YES | YES | - | All | QueryResultRecords of (VMRecord) | - | |
| vmDiskRelation | Independent disks in your organization that are attached to a VM. | YES | YES | - | records,idrecords | QueryResultRecords of (VmDiskRelationRecord) | 5.1 | - |
| vmServiceOfferingInstance | All service offering instances visible to VMs. | - | - | - | All | QueryResultRecords of (VmServiceOfferingInstanceRecord) | 5.5 | - |