QUERY DOCUMENTATION
Query
| Type Name | Description | User | Admin | System | Format | References Result | Records Result | Deprecated Since |
|---|---|---|---|---|---|---|---|---|
| organization | All organizations visible to you. | - | YES | YES | All | OrgReference(s) | QueryResultRecords(OrgRecord) | - |
| orgVdc | All VDCs in your organization. | YES | YES | - | All | OrgVdcReference(s) | QueryResultRecords(OrgVdcRecord) | - |
| media | All media that you can view or modify. | YES | YES | - | All | MediaReference(s) | QueryResultRecords(MediaRecord) | - |
| vAppTemplate | All vApp templates in your organization. | YES | YES | - | All | VAppTemplateReference(s) | QueryResultRecords(VAppTemplateRecord) | - |
| vApp | All vApps that you can view or modify | YES | YES | - | All | VAppReference(s) | QueryResultRecords(VAppRecord) | - |
| vm | All VMs in your organization that you can view or modify. | YES | YES | - | All | VMReference(s) | QueryResultRecords(VMRecord) | - |
| orgNetwork | Networks in your organization. | YES | YES | - | All | OrgNetworkReference(s) | QueryResultRecords(OrgNetworkRecord) | 35.0 |
| adminOrgNetwork | All organization networks in the system. | - | - | YES | All | OrgNetworkReference(s) | QueryResultRecords(AdminOrgNetworkRecord) | - |
| vAppNetwork | All vApp networks in your organization. | YES | YES | - | All | VAppNetworkReference(s) | QueryResultRecords(VAppNetworkRecord) | - |
| catalog | All catalogs in your organization that you have rights to view or modify. | YES | YES | - | All | CatalogReference(s) | QueryResultRecords(CatalogRecord) | - |
| adminOrgVdc | All organization vDCs in the system. | - | - | YES | All | AdminVdcReference(s) | QueryResultRecords(AdminVdcRecord) | - |
| providerVdc | All provider vDCs in the system. | - | - | YES | All | VMWProviderVdcReference(s) | QueryResultRecords(VMWProviderVdcRecord) | - |
| externalNetwork | External networks in the system. | - | - | YES | All | NetworkReference(s) | QueryResultRecords(NetworkRecord) | - |
| group | All groups in your organization. | YES | YES | - | All | GroupReference(s) | QueryResultRecords(GroupRecord) | - |
| user | Users in your organization. | YES | YES | - | All | UserReference(s) | QueryResultRecords(UserRecord) | - |
| 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 | UserReference(s) | QueryResultRecords(StrandedUserRecord) | - |
| role | All roles defined in the system. | - | YES | YES | All | RoleReference(s) | QueryResultRecords(RoleRecord) | - |
| allocatedExternalAddress | All allocated external IP addresses in your organization and the networks that use them. | - | YES | - | records,idrecords | QueryResultRecords(AllocatedExternalAddressRecord) | - | |
| event | Stored event records in your organization. | YES | YES | YES | records,idrecords | QueryResultRecords(EventRecord) | 34.0 | |
| resourcePool | All resource pools in the system. | - | - | YES | All | ResourcePoolReference(s) | QueryResultRecords(ResourcePoolRecord) | - |
| datastore | All datastores in the system. | - | - | YES | All | DatastoreReference(s) | QueryResultRecords(DatastoreRecord) | - |
| networkPool | All network pools in the system. | - | - | YES | All | NetworkPoolReference(s) | QueryResultRecords(NetworkPoolRecord) | - |
| portgroup | All vCenter portgroups in the system. | - | - | YES | records,idrecords | QueryResultRecords(PortgroupRecord) | - | |
| dvSwitch | All vCenter distributed virtual switches available for use by the system. | - | - | YES | records,idrecords | QueryResultRecords(DvSwitchRecord) | - | |
| cell | All vCloud Director cells supporting this cloud. | - | - | YES | records,idrecords | QueryResultRecords(CellRecord) | - | |
| virtualCenter | All vCenter servers registered to the system. | - | - | YES | All | VirtualCenterReference(s) | QueryResultRecords(VirtualCenterRecord) | - |
| host | ESX/ESXi hosts registered to the system. | - | - | YES | All | HostReference(s) | QueryResultRecords(HostRecord) | - |
| adminVApp | All vApps in the system. | - | - | YES | All | VAppReference(s) | QueryResultRecords(AdminVAppRecord) | - |
| right | All rights defined in the system. | - | YES | YES | All | RightReference(s) | QueryResultRecords(RightRecord) | - |
| adminVM | All VMs in vApps or vApp templates in the system. | - | - | YES | All | VMReference(s) | QueryResultRecords(AdminVMRecord) | - |
| adminAllocatedExternalAddress | All allocated external IP addresses in the system and the networks that use them. | - | - | YES | records,idrecords | QueryResultRecords(AdminAllocatedExternalAddressRecord) | - | |
| vAppOrgNetworkRelation | vApps visible to you and their connections to organization networks. | - | YES | YES | All | VAppOrgNetworkRelationReference(s) | QueryResultRecords(VAppOrgNetworkRelationRecord) | - |
| orgVdcResourcePoolRelation | All resource pools in the system and the organization vDCs that use them. | - | - | YES | records,idrecords | QueryResultRecords(OrgVdcResourcePoolRelationRecord) | - | |
| providerVdcResourcePoolRelation | All resource pools in the system and the Provider vDCs that use them. | - | - | YES | records,idrecords | QueryResultRecords(ProviderVdcResourcePoolRelationRecord) | 32.0 | |
| datastoreProviderVdcRelation | All datastores in the system and the Provider vDCs that use them. | - | - | YES | records,idrecords | QueryResultRecords(DatastoreProviderVdcRelationRecord) | - | |
| adminUser | Users in all organizations in the system. | - | - | YES | All | UserReference(s) | QueryResultRecords(AdminUserRecord) | - |
| adminGroup | Groups in all organizations in the system. | - | - | YES | All | GroupReference(s) | QueryResultRecords(AdminGroupRecord) | - |
| adminVAppNetwork | All vApp networks in the system. | - | - | YES | All | VAppNetworkReference(s) | QueryResultRecords(AdminVAppNetworkRecord) | - |
| adminCatalog | All catalogs in the system. | - | - | YES | All | CatalogReference(s) | QueryResultRecords(AdminCatalogRecord) | - |
| adminCatalogItem | Catalog items in all catalogs in the system. | - | - | YES | All | CatalogItemReference(s) | QueryResultRecords(AdminCatalogItemRecord) | - |
| catalogItem | All catalogs in your organization that you have rights to view or modify. | YES | YES | - | All | CatalogItemReference(s) | QueryResultRecords(CatalogItemRecord) | - |
| adminMedia | All media in the system. | - | - | YES | All | MediaReference(s) | QueryResultRecords(AdminMediaRecord) | - |
| adminVAppTemplate | All vApp templates in the system. | - | - | YES | All | VAppTemplateReference(s) | QueryResultRecords(AdminVAppTemplateRecord) | - |
| adminShadowVM | All shadow VMs in the system. | - | - | YES | All | VMReference(s) | QueryResultRecords(AdminShadowVMRecord) | - |
| task | Active and recently completed tasks in your organization. | YES | YES | YES | All | TaskReference(s) | QueryResultRecords(TaskRecord) | - |
| adminTask | All active or recently completed tasks in the system. | - | - | YES | All | TaskReference(s) | QueryResultRecords(AdminTaskRecord) | - |
| blockingTask | All active blocking tasks in the system. | - | - | YES | All | BlockingTaskReference(s) | QueryResultRecords(BlockingTaskRecord) | - |
| disk | All independent disks in your organization. | YES | YES | - | All | DiskReference(s) | QueryResultRecords(DiskRecord) | - |
| vmDiskRelation | Independent disks in your organization that are attached to a VM. | YES | YES | - | records,idrecords | QueryResultRecords(VmDiskRelationRecord) | - | |
| adminDisk | All independent disks in the system. | - | - | YES | All | AdminDiskReference(s) | QueryResultRecords(AdminDiskRecord) | - |
| adminVMDiskRelation | Independent disks in the system that are attached to a VM. | - | - | YES | records,idrecords | QueryResultRecords(AdminVmDiskRelationRecord) | - | |
| condition | System alerts for objects that have errors or warnings. | - | - | YES | records,idrecords | QueryResultRecords(ConditionRecord) | 35.0 | |
| adminEvent | All stored event records in the system. | - | - | YES | All | AdminEventReference(s) | QueryResultRecords(AdminEventRecord) | - |
| strandedItem | All stranded items in the system. | - | - | YES | All | StrandedItemReference(s) | QueryResultRecords(StrandedItemRecord) | - |
| adminService | System Administrator representation of all extension services registered with the system. | - | - | YES | All | AdminServiceReference(s) | QueryResultRecords(AdminServiceRecord) | - |
| service | All extension services registered with the system. | YES | YES | YES | All | ServiceReference(s) | QueryResultRecords(ServiceRecord) | - |
| serviceLink | All service links defined by extension services. | - | - | YES | All | ServiceLinkReference(s) | QueryResultRecords(ServiceLinkRecord) | - |
| storageProfile | All storage profiles in the VCD server group. | - | - | YES | All | StorageProfileReference(s) | QueryResultRecords(StorageProfileRecord) | - |
| orgVdcStorageProfile | All organization VDC storage profiles in your organization. | YES | YES | - | All | OrgVdcStorageProfileReference(s) | QueryResultRecords(OrgVdcStorageProfileRecord) | - |
| adminOrgVdcStorageProfile | All organization VDC storage profiles in the system. | - | - | YES | All | AdminOrgVdcStorageProfileReference(s) | QueryResultRecords(AdminOrgVdcStorageProfileRecord) | - |
| providerVdcStorageProfile | All Provider VDC storage profiles in the system. | - | - | YES | All | ProviderVdcStorageProfileReference(s) | QueryResultRecords(ProviderVdcStorageProfileRecord) | - |
| apiFilter | All API filters defined in the system for extension services. | - | - | YES | All | ApiFilterReference(s) | QueryResultRecords(ApiFilterRecord) | - |
| adminApiDefinition | System Administrator representation of all extension service API definitions. | - | - | YES | All | AdminApiDefinitionReference(s) | QueryResultRecords(AdminApiDefinitionRecord) | - |
| apiDefinition | All extension service API definitions. | YES | YES | YES | All | ApiDefinitionReference(s) | QueryResultRecords(ApiDefinitionRecord) | - |
| adminFileDescriptor | System Administrator representation of all API filters defined in the system by extension services. | - | - | YES | All | AdminFileDescriptorReference(s) | QueryResultRecords(AdminFileDescriptorRecord) | - |
| fileDescriptor | All file descriptors defined in the system by extension services. | YES | YES | YES | records,idrecords | QueryResultRecords(FileDescriptorRecord) | - | |
| resourceClassAction | All resource class actions defined in the system by extension services. | - | - | YES | All | ResourceClassActionReference(s) | QueryResultRecords(ResourceClassActionRecord) | - |
| aclRule | All ACL rules defined in the system by extension services. | - | - | YES | All | AclRuleReference(s) | QueryResultRecords(AclRuleRecord) | - |
| resourceClass | All resources classes defined in the system by extension services. | - | - | YES | All | ResourceClassReference(s) | QueryResultRecords(ResourceClassRecord) | - |
| serviceResource | All service resources defined in the system by extension services. | - | - | YES | All | ServiceResourceResourceReference(s) | QueryResultRecords(ServiceResourceRecord) | - |
| edgeGateway | All Edge Gateways in your organization. | - | YES | YES | All | EdgeGatewayReference(s) | QueryResultRecords(EdgeGatewayRecord) | - |
| orgVdcNetwork | All organization VDC networks in your organization. | YES | YES | YES | All | OrgVdcNetworkReference(s) | QueryResultRecords(OrgVdcNetworkRecord) | 35.0 |
| vAppOrgVdcNetworkRelation | vApps accessible to you and their connections to organization VDC networks. | - | YES | YES | All | VAppOrgVdcNetworkRelationReference(s) | QueryResultRecords(VAppOrgVdcNetworkRelationRecord) | - |
| externalLocalization | Localization resources for all registered extension services. | - | - | YES | records,idrecords | QueryResultRecords(ExternalLocalizationRecord) | - | |
| resourcePoolVmList | All VMs in the system and the resource pools they use. | - | - | YES | All | VMReference(s) | QueryResultRecords(ResourcePoolVMRecord) | - |
| vmGroupVms | List of all VMs in a VM group and associated container data. | - | - | YES | All | VmGroupVmsReference(s) | QueryResultRecords(VmGroupVmsRecord) | - |
| vmGroups | List of all VM groups in all clusters. | - | - | YES | All | VmGroupsReference(s) | QueryResultRecords(VmGroupsRecord) | - |
| adminRole | All roles defined in the system. | - | - | YES | All | RoleReference(s) | QueryResultRecords(AdminRoleRecord) | - |
| nsxTManager | All NSX-T managers registered in the system. | - | - | YES | All | NsxTManagerReference(s) | QueryResultRecords(NsxTManagerRecord) | - |
| adminOrgVdcTemplate | All VDC Templates in your organization. | - | - | YES | All | AdminOrgVdcTemplateReference(s) | QueryResultRecords(AdminOrgVdcTemplateRecord) | - |
| orgVdcTemplate | All VDC Templates in your organization. | YES | YES | YES | All | OrgVdcTemplateReference(s) | QueryResultRecords(OrgVdcTemplateRecord) | - |
| gatewayUplinks | List of IP addresses that are consumed by gateways. | - | YES | YES | All | GatewayUplinksReference(s) | QueryResultRecords(GatewayUplinksRecord) | - |
| site | The full list of sites in the multisite association | - | - | YES | All | SiteReference(s) | QueryResultRecords(SiteRecord) | - |
| siteAssociation | The full list of associations in the multisite | - | - | YES | All | SiteAssociationReference(s) | QueryResultRecords(SiteAssociationRecord) | - |
| orgAssociation | The full list of org associations for this organization | - | - | YES | All | OrgAssociationReference(s) | QueryResultRecords(OrgAssociationRecord) | - |