Types

appliance

The appliance API provides services for managing vCenter Appliance configuration. The API is available starting in vSphere 6.7.
Type Description
appliance.notification The notification structure describes a notification that can be reported by the appliance task. This structure was added in vSphere API 6.7.
appliance.notifications The notifications structure contains info/warning/error messages that can be reported be the appliance task. This structure was added in vSphere API 6.7.
appliance.subtask_info The subtask_info structure contains information about one of the subtasks that makes up an appliance task. This structure was added in vSphere API 6.7.
appliance.task_info The task_info structure contains information about an appliance task and the subtasks of which it consists. This structure was added in vSphere API 6.7.

appliance access

The appliance.access API provides services for managing access to the appliance. The API is available starting in vSphere 6.5.

shell

shell service provides operations Get/Set enabled state of BASH.
Type Description
appliance.access.shell.shell_config shell_config structure Structure that defines shell configuration.

appliance infraprofile

The appliance.infraprofile API provides services to manage profile spec for the appliance
Type Description
appliance.infraprofile.notification The notification structure contains fields to describe any info/warning/error messages that Tasks can raise.
appliance.infraprofile.notifications The notifications structure contains info/warning/error messages that can be reported be the task.
appliance.infraprofile.task_info

configs

configs service provides operations to manage desired configuration specification of an appliance.
Type Description
appliance.infraprofile.configs.import_profile_spec The import_profile_spec structure represents a spec information for import and validate.
appliance.infraprofile.configs.profile_info The profile_info structure defines the information about profile.
appliance.infraprofile.configs.profiles_spec The profiles_spec structure represents a spec information for export operation.
appliance.infraprofile.configs.validation_result The validation_result structure contains fields to describe result of validation of profile specification.

appliance local accounts

local accounts

The local_accounts service provides operations to manage local user account. This service was added in vSphere API 6.7.
Type Description
appliance.local_accounts.config The config structure defines the information required for the account. This structure was added in vSphere API 6.7.
appliance.local_accounts.info The info structure defines the local account properties. This structure was added in vSphere API 6.7.
appliance.local_accounts.update_config The update_config structure defines the fields that might be updated. This structure was added in vSphere API 6.7.

policy

The policy service provides operations to manage local user accounts. This service was added in vSphere API 6.7.
Type Description
appliance.local_accounts.policy.info The info structure defines the global password policy. This structure was added in vSphere API 6.7.

appliance logging

The appliance.logging API provides services for managing log forwarding in the appliance. The API is available starting in vSphere 6.5.

forwarding

The forwarding service provides operations to manage forwarding of log messages to remote logging servers. This service was added in vSphere API 6.7.
Type Description
appliance.logging.forwarding.config The config structure defines the configuration for log message forwarding to remote logging servers. This structure was added in vSphere API 6.7.
appliance.logging.forwarding.connection_status This structure was added in vSphere API 6.7.

monitoring

monitoring service provides operations Get and list monitoring data for requested item.
Type Description
appliance.monitoring.monitored_item monitored_item structure Structure representing requested monitored item data.
appliance.monitoring.monitored_item_data monitored_item_data structure Structure representing monitored item data.
appliance.monitoring.monitored_item_data_request monitored_item_data_request structure Structure representing requested monitored item data.

appliance networking

The appliance.networking API provides services for managing network configuration of the appliance. The API is available starting in vSphere 6.5.

networking

The networking service provides operations Get Network configurations. This service was added in vSphere API 6.7.
Type Description
appliance.networking.change_spec This structure was added in vSphere API 6.7.3.
appliance.networking.DNS_info The DNS_info structure contains information about the DNS configuration of a virtual appliance. This structure was added in vSphere API 6.7.
appliance.networking.info The info structure contains information about the network configuration of a virtual appliance. This structure was added in vSphere API 6.7.
appliance.networking.update_spec The update_spec structure describes whether to enable or disable ipv6 on interfaces. This structure was added in vSphere API 6.7.

appliance networking dns

hostname

hostname service provides operations Performs operations on Fully Qualified Doman Name.
Type Description
appliance.networking.dns.hostname.message message structure Test result and message
appliance.networking.dns.hostname.test_status_info test_status_info structure Overall test result

servers

servers service provides operations DNS server configuration.
Type Description
appliance.networking.dns.servers.DNS_server_config DNS_server_config structure This structure represents the configuration state used to determine DNS servers.
appliance.networking.dns.servers.message message structure Test result and message
appliance.networking.dns.servers.test_status_info test_status_info structure Overall test result

appliance networking firewall

inbound

The inbound service provides operations to manage inbound firewall rules. This service was added in vSphere API 6.7.1.
Type Description
appliance.networking.firewall.inbound.rule rule structure Structure that defines a single address-based firewall rule. This structure was added in vSphere API 6.7.1.

appliance networking interfaces

interfaces

interfaces service provides operations Provides information about network interface.
Type Description
appliance.networking.interfaces.interface_info interface_info structure Structure that defines properties and status of a network interface.

ipv4

The ipv4 service provides operations to perform IPv4 network configuration for interfaces. This service was added in vSphere API 6.7.
Type Description
appliance.networking.interfaces.ipv4.config The config structure provides defines the IPv4 configuration of a network interface. This structure was added in vSphere API 6.7.
appliance.networking.interfaces.ipv4.info The info structure defines current IPv4 configuration state of a network interface. This structure was added in vSphere API 6.7.

ipv6

The ipv6 service provides operations to perform IPv6 network configuration for interfaces. This service was added in vSphere API 6.7.
Type Description
appliance.networking.interfaces.ipv6.address The address structure provides the structure used to name an IPv6 address. This structure was added in vSphere API 6.7.
appliance.networking.interfaces.ipv6.address_info The address_info structure provides the structure that you can use to get information about an IPv6 address along with its origin and status. This structure was added in vSphere API 6.7.
appliance.networking.interfaces.ipv6.config The config structure provides the structure that you can use to configure IPv6 on a particular interface. Addresses can be assigned by DHCP, SLAAC or STATIC, as IPv6 permits multiple addresses per interface. This structure was added in vSphere API 6.7.
appliance.networking.interfaces.ipv6.info The info structure provides the structure that defines an existing IPv6 configuration on a particular interface. This structure is read only. This structure was added in vSphere API 6.7.

proxy

The proxy service provides operations Proxy configuration. This service was added in vSphere API 6.7.
Type Description
appliance.networking.proxy.config The config structure defines proxy configuration. This structure was added in vSphere API 6.7.
appliance.networking.proxy.test_result The test_result structure contains information about the test operation done on a proxy server. This structure was added in vSphere API 6.7.

ntp

ntp service provides operations Gets NTP configuration status and tests connection to ntp servers. This service was added in vSphere API 6.7.
Type Description
appliance.ntp.localizable_message localizable_message structure Structure representing message. This structure was added in vSphere API 6.7.
appliance.ntp.test_run_status test_run_status structure Status of the test. This structure was added in vSphere API 6.7.

appliance recovery

The appliance.recovery API provides services for backin up and restoring vCenter Appliance configuration. The API is available starting in vSphere 6.7.

recovery

The recovery service provides operations to invoke an appliance recovery (backup and restore). This service was added in vSphere API 6.7.
Type Description
appliance.recovery.info The info structure contains the information about the appliance recovery environment. This structure was added in vSphere API 6.7.

appliance recovery backup

backup

backup service provides operations Performs backup restore operations
Type Description
appliance.recovery.backup.backup_request backup_request structure Structure representing requested backup piece
appliance.recovery.backup.localizable_message localizable_message structure Structure representing message
appliance.recovery.backup.location_spec The location_spec structure has fields to represent a location on the backup server. This structure was added in vSphere API 6.7.
appliance.recovery.backup.return_result return_result structure Structure representing precheck result

appliance recovery backup job

job

The job service provides operations to be performed on a backup job.
Type Description
appliance.recovery.backup.job.backup_job_status The backup_job_status structure represents the status of a backup/restore job.
appliance.recovery.backup.job.backup_request The backup_request structure represents a requested backup piece.
appliance.recovery.backup.job.localizable_message The localizable_message structure represents a localizable message.
appliance.recovery.backup.job.return_result The return_result structure contains the result information for the cancel operation.

details

The details service provides operations to get the details about backup jobs. This service was added in vSphere API 6.7.
Type Description
appliance.recovery.backup.job.details.build_info The build_info structure contains information about the build of the appliance. This structure was added in vSphere API 6.7.2.
appliance.recovery.backup.job.details.filter_spec The filter_spec structure contains fields used to filter the results when listing backup jobs details (see list). This structure was added in vSphere API 6.7.
appliance.recovery.backup.job.details.info The info structure contains information about a backup job. This structure was added in vSphere API 6.7.

parts

parts service provides operations Provides list of parts optional for the backup
Type Description
appliance.recovery.backup.parts.localizable_message localizable_message structure Structure representing message
appliance.recovery.backup.parts.part part structure Structure representing backup restore part

schedules

The schedules service provides operations to be performed to manage backup schedules. This service was added in vSphere API 6.7.
Type Description
appliance.recovery.backup.schedules.create_spec The create_spec structure contains fields to be specified for creating a new schedule. The structure includes parts, location information, encryption password and enable flag. This structure was added in vSphere API 6.7.
appliance.recovery.backup.schedules.info The info structure contains information about an existing schedule. The structure includes Schedule ID, parts, location information, encryption password, enable flag, recurrence and retention information. This structure was added in vSphere API 6.7.
appliance.recovery.backup.schedules.recurrence_info The recurrence_info structure contains the recurrence information associated with a schedule. This structure was added in vSphere API 6.7.
appliance.recovery.backup.schedules.retention_info The retention_info structure contains retention information associated with a schedule. This structure was added in vSphere API 6.7.
appliance.recovery.backup.schedules.update_spec The update_spec structure contains the fields of the existing schedule which can be updated. This structure was added in vSphere API 6.7.

appliance recovery backup system name

archive

The archive service provides operations to get the backup information. This service was added in vSphere API 6.7.
Type Description
appliance.recovery.backup.system_name.archive.filter_spec The filter_spec structure contains fields used to filter the results when listing backup archives (see list). If multiple fields are specified, only backup archives matching all of the fields match the filter. This structure was added in vSphere API 6.7.
appliance.recovery.backup.system_name.archive.info The info structure represents backup archive information. This structure was added in vSphere API 6.7.
appliance.recovery.backup.system_name.archive.summary The summary structure contains commonly used information about a backup archive. This structure was added in vSphere API 6.7.

appliance recovery reconciliation

job

The job service provides operations to create and get the status of reconciliation job. This service was added in vSphere API 6.7.
Type Description
appliance.recovery.reconciliation.job.create_spec The create_spec structure has the fields to request the start of reconciliation job. This structure was added in vSphere API 6.7.
appliance.recovery.reconciliation.job.info The info structure represents the reconciliation job information. It contains information related to current Status, any associated messages and progress as percentage. This structure was added in vSphere API 6.7.

appliance recovery restore

restore

restore service provides operations Performs restore operations
Type Description
appliance.recovery.restore.localizable_message localizable_message structure Structure representing message
appliance.recovery.restore.metadata metadata structure Structure representing metadata
appliance.recovery.restore.restore_request restore_request structure Structure representing requested restore piece

job

job service provides operations Performs restore operations
Type Description
appliance.recovery.restore.job.localizable_message localizable_message structure Structure representing message
appliance.recovery.restore.job.restore_job_status restore_job_status structure Structure representing backup restore status
appliance.recovery.restore.job.restore_request restore_request structure Structure representing requested restore piece
appliance.recovery.restore.job.return_result return_result structure Structure representing precheck result

services

The Service service provides operations to manage a single/set of appliance services. This service was added in vSphere API 6.7.
Type Description
appliance.services.info The info structure contains information about a service. This structure was added in vSphere API 6.7.

shutdown

shutdown service provides operations Performs reboot/shutdown operations on appliance. This service was added in vSphere API 6.7.
Type Description
appliance.shutdown.shutdown_config shutdown_config structure Structure that defines shutdown configuration returned by the Shutdown.get operation. This structure was added in vSphere API 6.7.

appliance system

The appliance.system API provides services to query the appliance system information. The API is available starting in vSphere 6.5.

storage

storage service provides operations Appliance storage configuration
Type Description
appliance.system.storage.storage_change The storage_change structure describes the changes in capasity of a storage partition. This structure was added in vSphere API 6.7.
appliance.system.storage.storage_mapping The storage_mapping structure describes the mapping between VCSA partitions and the Hard disk numbers visible in the vSphere Web Client.

time

time service provides operations Gets system time.
Type Description
appliance.system.time.system_time_struct system_time_struct structure Structure representing the system time.

version

version service provides operations Get the appliance version.
Type Description
appliance.system.version.version_struct version_struct structure Structure representing appliance version information.

appliance update

The appliance.update API provides services for updating the software in the appliance. The API is available starting in vSphere 6.5.

update

The update service provides operations to get the status of the appliance update. This service was added in vSphere API 6.7.
Type Description
appliance.update.common_info The common_info structure defines common update information. This structure was added in vSphere API 6.7.
appliance.update.info The info structure describes the state of the appliance update. This structure was added in vSphere API 6.7.
appliance.update.service_info The service_info structure describes a service to be stopped and started during the update installation. This structure was added in vSphere API 6.7.
appliance.update.summary The summary structure contains the essential information about the update. This structure was added in vSphere API 6.7.

pending

The pending service provides operations to manipulate pending updates. This service was added in vSphere API 6.7.
Type Description
appliance.update.pending.info The info structure contains the extended information about the update. This structure was added in vSphere API 6.7.
appliance.update.pending.precheck_result The precheck_result structure contains estimates of how long it will take install and rollback an update as well as a list of possible warnings and problems with installing the update. This structure was added in vSphere API 6.7.
appliance.update.pending.question The question structure describes a item of information that must be provided by the user in order to install the update. This structure was added in vSphere API 6.7.

policy

The policy service provides operations to set/get background check for the new updates. This service was added in vSphere API 6.7.
Type Description
appliance.update.policy.config The config structure defines automatic update checking and staging policy. This structure was added in vSphere API 6.7.
appliance.update.policy.info The info structure defines automatic update checking and staging policy. This structure was added in vSphere API 6.7.
appliance.update.policy.time The time structure defines weekday and time the automatic check for new updates will be run. This structure was added in vSphere API 6.7.

staged

The staged service provides operations to get the status of the staged update. This service was added in vSphere API 6.7.
Type Description
appliance.update.staged.info The info structure contains information about the staged update. This structure was added in vSphere API 6.7.

appliance vmon

The appliance.vmon API provides services to manage a set of services that are part of the vCenter Server.

service

The service service provides operations to manage a single/set of services that are managed by vMon.
Type Description
appliance.vmon.service.info The info structure contains information about a service.
appliance.vmon.service.update_spec The update_spec structure describes the changes to be made to the configuration of the service.

cis

The cis API provides VMware common infrastructure services.

session

The session service allows API clients to manage session tokens including creating, deleting and obtaining information about sessions.

The call to the create operation is part of the overall authentication process for API clients. For example, the sequence of steps for establishing a session with SAML token is:

See the programming guide and samples for additional information about establishing API sessions.

Execution Context and Security Context

To use session based authentication a client should supply the session token obtained through the create operation. The client should add the session token in the security context when using SDK classes. Clients using the REST API should supply the session token as a HTTP header.

Session Lifetime

A session begins with call to the create operation to exchange a SAML token for a API session token. A session ends under the following circumstances:

When a session ends, the authentication logic will reject any subsequent client requests that specify that session. Any operations in progress will continue to completion.

Error Handling

The cis.session returns the following errors:

Type Description
cis.session.info Represents data associated with an API session.

cis tagging

The cis.tagging component provides operations and structures to attach metadata, by means of tags, to vSphere objects to make these objects more sortable and searchable. You can use it to create, manage, and enumerate tags and their categories (the group a tag belongs to). You can also query the attached tags and attached objects.
Type Description
cis.tagging.category_model The category_model structure defines a category that is used to group one or more tags.
cis.tagging.tag_model The tag_model structure defines a tag that can be attached to vSphere objects.

category

The category service provides operations to create, read, update, delete, and enumerate categories.
Type Description
cis.tagging.category.create_spec The create_spec structure is used to create a category.

Use the create operation to create a category defined by the create specification.

cis.tagging.category.update_spec The update_spec structure describes the updates to be made to an existing category.

Use the update operation to modify a category. When you call the operation, specify the category identifier. You obtain the category identifier when you call the create operation. You can also retrieve an identifier by using the list operation.

tag

The tag service provides operations to create, read, update, delete, and enumerate tags.
Type Description
cis.tagging.tag.create_spec The create_spec structure describes a tag.

Use the create operation to create a tag defined by the create specification.

cis.tagging.tag.update_spec The update_spec structure describes the updates to be made to an existing tag.

Use the update operation to modify a tag. When you call the operation, you specify the tag identifier. You obtain the tag identifier when you call the create operation. You can also retrieve an identifier by using the list operation.

tag association

The tag_association service provides operations to attach, detach, and query tags.
Type Description
cis.tagging.tag_association.batch_result The batch_result structure describes the result of performing the same operation on several tags or objects in a single invocation. This structure was added in vSphere API 6.5.
cis.tagging.tag_association.object_to_tags The object_to_tags structure describes an object and its related tags. Use the list_attached_tags_on_objects operation to retrieve a array with each element containing an object and the tags attached to it. This structure was added in vSphere API 6.5.
cis.tagging.tag_association.tag_to_objects The tag_to_objects structure describes a tag and its related objects. Use the list_attached_objects_on_tags operation to retrieve a array with each element containing a tag and the objects to which it is attached. This structure was added in vSphere API 6.5.

cis task

The cis.task API provides enumerated types and structures used for managing tasks.
Type Description
cis.task.common_info The common_info structure contains information common to all tasks. This structure was added in vSphere API 6.7.
cis.task.info The info structure contains information about a task. This structure was added in vSphere API 6.7.
cis.task.progress The progress structure contains information describe the progress of an operation. This structure was added in vSphere API 6.7.

tasks

The tasks service provides operations for managing the task related to a long running operation. This service was added in vSphere API 6.7.1.
Type Description
cis.tasks.filter_spec The filter_spec structure contains fields used to filter the results when listing tasks (see list). If multiple fields are specified, only tasks matching all of the fields match the filter.

Currently at least one of cis.tasks.filter_spec.tasks or cis.tasks.filter_spec.services must be specified and not empty.

. This structure was added in vSphere API 6.7.1.
cis.tasks.get_spec The get_spec structure describes what data should be included when retrieving information about a task. This structure was added in vSphere API 6.7.1.

content

The Content API provides structures and services for configuring global settings and permissions, and for managing libraries in the Content Library Service.
Type Description
content.configuration_model The configuration_model structure defines the global settings of the Content Library Service.
content.library_model The content.library_model structure represents a Content Library resource model.

A library_model is a container for a set of items which represent a usable set of files. The Content Library Service allows for multiple libraries to be created with separate authorization and sharing policies.

Each library_model is a container for a set of content.library.item_model instances. Each item is a logical object in a library, which may have multiple files.

A library_model may be local or subscribed. A local library has its source of truth about items within this Content Library Service. Items may be added to or removed from the library. A local library may also be private or published. When published, the library is exposed by a network endpoint and can be used by another Content Library Service for synchronization. A private local library cannot be used for synchronization.

A subscribed library is a library which gets its source of truth from another library that may be across a network in another Content Library Service. A subscribed library may have a different name and metadata from the library to which it subscribes, but the set of library items is always the same as those in the source library. Library items cannot be manually added to a subscribed library -- they can only be added by adding new items to the source library.

content library

The Content Library API provides structures and services for defining and managing the library's items, subscription, publication, and storage.

library

The library service provides operations to manage and find content.library_model entities.

The library service provides support for generic functionality which can be applied equally to all types of libraries. The functionality provided by this service will not affect the properties specific to the type of library. See also content.local_library and content.subscribed_library.

Type Description
content.library.find_spec Specifies the properties that can be used as a filter to find libraries. When multiple fields are specified, all properties of the library must match the specification.
content.library.item_model The item_model structure represents a library item that has been stored in a library.

A item_model represents a single logical unit to be managed within a content.library_model. Items contain the actual content of a library, and their placement within a library determines policies that affect that content such as publishing.

A library item can have a specified type, indicated with the content.library.item_model.type field. This property is associated with a Content Library Service plugin that supports specific types and provides additional services. The types available in a specific Content Library Service can be queried using the content.type service. Items of an unknown or unspecified type are treated generically. Because subscribed library catalogs are synchronized as is, subscribing to a remote Content Library Service effectively gives you a library with the functionality of the remote service's type adapter plugins, even if they are not installed locally.

Items can be managed using the content.library.item service and, for items in subscribed libraries, the content.library.subscribed_item service.

content.library.optimization_info The optimization_info structure defines different optimizations and optimization parameters applied to particular library.
content.library.publish_info The publish_info structure defines how a local library is published publicly for synchronization to other libraries.
content.library.source_info The source_info structure contains information about the source published library of a subscribed library. This structure was added in vSphere API 6.7.2.
content.library.storage_backing The storage_backing structure defines a storage location where content in a library will be stored. The storage location can either be a Datastore or Other type.
content.library.subscription_info The subscription_info structure defines the subscription behavior for a subscribed library.

content library item

The Content Library Item API provides structures and services for managing files in a library item.

item

The item service provides operations for managing library items.
Type Description
content.library.item.destination_spec The destination_spec structure contains information required to publish the library item to a specific subscription. This structure was added in vSphere API 6.7.2.
content.library.item.download_session_model The download_session_model structure provides information on an active content.library.item.download_session resource.
content.library.item.find_spec The find_spec structure specifies the properties that can be used as a filter to find library items. When multiple fields are specified, all properties of the item must match the specification.
content.library.item.transfer_endpoint The transfer_endpoint structure encapsulates a URI along with extra information about it.
content.library.item.update_session_model The update_session_model structure provides information on an active content.library.item.update_session resource.

changes

The changes service provides operations to get a history of the content changes made to a library item. This service was added in vSphere API 6.9.1.
Type Description
content.library.item.changes.info The info structure contains information about a library item change. This structure was added in vSphere API 6.9.1.
content.library.item.changes.summary The summary structure contains commonly used information about a library item change. This structure was added in vSphere API 6.9.1.

content library item downloadsession

The Content Library Item Download Session API provides structures and services for downloading files in a session.

file

The file service provides operations for accessing files within a download session.

After a download session is created against a library item, the file service can be used to retrieve all downloadable content within the library item. Since the content may not be available immediately in a downloadable form on the server side, the client will have to prepare the file and wait for the file status to become PREPARED.

See content.library.item.download_session.

Type Description
content.library.item.downloadsession.file.info The info structure defines the downloaded file.

file

The file service can be used to query for information on the files within a library item. Files are objects which are added to a library item through the content.library.item.update_session and content.library.item.updatesession.file services.
Type Description
content.library.item.file.checksum_info Provides checksums for a content.library.item.file.info object.
content.library.item.file.info The info structure provides information about a file in Content Library Service storage.

A file is an actual stored object for a library item. An item will have zero files initially, but one or more can be uploaded to the item.

storage

storage is a resource that represents a specific instance of a file stored on a storage backing. Unlike content.library.item.file, which is abstract, storage represents concrete files on the various storage backings. A file is only represented once in content.library.item.file, but will be represented multiple times (once for each storage backing) in storage. The storage service provides information on the storage backing and the specific location of the file in that backing to privileged users who want direct access to the file on the storage medium.
Type Description
content.library.item.storage.info The info structure is the expanded form of content.library.item.file.info that includes details about the storage backing for a file in a library item.

content library item updatesession

The Content Library Item Update Session API provides structures and services for updating files in a session.
Type Description
content.library.item.updatesession.certificate_info The certificate_info structure contains information about the public key certificate used to sign the content. This structure was added in vSphere API 6.8.
content.library.item.updatesession.preview_info The preview_info structure contains information about the files being uploaded in the update session. This structure was added in vSphere API 6.8.
content.library.item.updatesession.preview_warning_info The preview_warning_info structure provides information about the warnings which are raised during the update session preview. This structure was added in vSphere API 6.8.
content.library.item.updatesession.warning_behavior The warning_behavior structure defines the session behavior if the warning is raised during the update session. This structure was added in vSphere API 6.8.

file

The file service provides operations for accessing files within an update session.

After an update session is created against a library item, the file service can be used to make changes to the underlying library item metadata as well as the content of the files. The following changes can be made:

The above changes are not applied or visible until the session is completed. See content.library.item.update_session.

Type Description
content.library.item.updatesession.file.add_spec The add_spec structure describes the properties of the file to be uploaded.
content.library.item.updatesession.file.info The info structure defines the uploaded file.
content.library.item.updatesession.file.validation_error The validation_error structure defines the validation error of a file in the session.
content.library.item.updatesession.file.validation_result The validation_result structure defines the result of validating the files in the session.

subscriptions

The subscriptions service provides operations for managing the subscription information of the subscribers of a published library. This service was added in vSphere API 6.7.2.
Type Description
content.library.subscriptions.create_spec The create_spec structure defines the information required to create a new subscription of the published library. This structure was added in vSphere API 6.7.2.
content.library.subscriptions.create_spec_new_subscribed_library The create_spec_new_subscribed_library structure defines the information required to create a new subscribed library. This structure was added in vSphere API 6.7.2.
content.library.subscriptions.create_spec_placement The create_spec_placement structure defines the placement information for the subscribed library's virtual machine template library items. Storage location of the virtual machine template items is defined by the subscribed library's storage backing. This placement information needs to be compatible with the subscribed library's storage backing. The create_spec_placement structure is only applicable for the virtual machine template library items of the subscribed library. This structure was added in vSphere API 6.7.2.
content.library.subscriptions.create_spec_subscribed_library The create_spec_subscribed_library structure defines the subscribed library information used to create the subscription. This structure was added in vSphere API 6.7.2.
content.library.subscriptions.create_spec_vcenter The create_spec_vcenter structure defines information about the vCenter Server instance where the subscribed library associated with the subscription exists or will be created. This structure was added in vSphere API 6.7.2.
content.library.subscriptions.info The info structure contains information about the subscription. This structure was added in vSphere API 6.7.2.
content.library.subscriptions.placement_info The placement_info structure contains the placement information for the subscribed library's virtual machine template library items. The placement_info structure is only applicable for the virtual machine template library items of the subscribed library. This structure was added in vSphere API 6.7.2.
content.library.subscriptions.summary The summary structure contains commonly used information about the subscription. This structure was added in vSphere API 6.7.2.
content.library.subscriptions.update_spec The update_spec structure defines information required to update the subscription. This structure was added in vSphere API 6.7.2.
content.library.subscriptions.update_spec_placement The update_spec_placement structure defines the placement information for the subscribed library's virtual machine template library items. Storage location of the virtual machine template items is defined by the subscribed library's storage backing. This placement information needs to be compatible with the subscribed library's storage backing. The update_spec_placement structure is only applicable for the newly published virtual machine template library items of the subscribed library. Existing items will not be moved. This structure was added in vSphere API 6.7.2.
content.library.subscriptions.update_spec_vcenter The update_spec_vcenter structure defines information about the vCenter Server instance where the subscribed library associated with the subscription exists. The update_spec_vcenter structure is only applicable to subscribed library which exists on remote vCenter Server instance. This structure was added in vSphere API 6.7.2.
content.library.subscriptions.vcenter_info The vcenter_info structure contains information about the vCenter Server instance where the subscribed library associated with the subscription exists. This structure was added in vSphere API 6.7.2.

local library

The local_library service manages local libraries.

The local_library service provides support for creating and maintaining local library instances. A local library may also use the content.library service to manage general library functionality.

Type Description
content.local_library.destination_spec The destination_spec structure contains information required to publish the library to a specific subscription. This structure was added in vSphere API 6.7.2.

subscribed library

Type Description
content.subscribed_library.probe_result The probe_result structure defines the subscription information probe result. This describes whether using a given subscription URL is successful or if there are access problems, such as SSL errors.

content type ovf

Type Description
content.type.ovf.cpu Provide the CPU information in a template VM.
content.type.ovf.disk Provide the disk information in a template VM.
content.type.ovf.disk_controller Provide the disk controller information in a template VM.
content.type.ovf.drive Provide the drive information in a template VM.
content.type.ovf.floppy Provide the floppy information in a template VM.
content.type.ovf.memory Provide the memory information in a template VM.
content.type.ovf.network Provide network information in a template VM.
content.type.ovf.nic Provide NIC information in a VM template
content.type.ovf.ovf_template Provides extra information about a library item of type "ovf".

An OVF library item is the basic building block for instantiating virtual machines from content library. It may contain one or multiple virtual machine templates. This structure provides a rich view of the virtual machines within the ovf container as well as information about to the ovf descriptor associated with the library item

content.type.ovf.USB_controller Provide USB controller information in a template VM.
content.type.ovf.V_app_template Provide information for vApp template in an OVF template file.
content.type.ovf.video_card Provide video card information in a template VM.
content.type.ovf.vm_template Provide template VM information in an OVF template (see OvfTemplate#type). The template VM provide the information about the operation system, CPU, memory, disks and NICs.

content type ovf policy

Type Description
content.type.ovf.policy.storage_policy Provide information of the membership of a particular storage policy group.

It is valid for disk, virtual machine or virtual machine collection.

content.type.ovf.policy.storage_policy_group Provide information of storage policy for a group of disks, virtual machines and/or virtual machine collections.

esx attestation

The esx.attestation API provides services to manage the vSphere Trust Authority Attestation Service.

esx attestation certificate

certificate

The certificate service provides operations to get or update the attestation report signing certificate.

The result of attestation is a signed report that verifies the attested host's authenticity. This service allows the report signing certificate to be read by anyone who needs to trust the signature.

Type Description
esx.attestation.certificate.info The info structure contains information describing the certificate that is used for attestation report signing.
esx.attestation.certificate.set_spec The set_spec structure contains information that describes a certificate that will replace the existing attestation report signing certificate.

csr

The csr service provides operations to create a certificate signing request (CSR) for the attestation report signing certificate.
Type Description
esx.attestation.certificate.csr.create_spec The create_spec structure contains information to generate a private key and CSR.
esx.attestation.certificate.csr.info The info structure contains information for a CSR.

esx attestation os esx

The esx.attestation.os.esx API provides services to manage remote attestation OS configuration for ESX trust.

base images

The base_images service provides operations to manage trusted instances of ESX software.
Type Description
esx.attestation.os.esx.base_images.info The info structure contains information that describes an ESX base image.
esx.attestation.os.esx.base_images.summary The summary structure contains information that summarizes an ESX base image.

raw config

The raw_config service provides operations to get or put the attestation service persistent user configuration.

This service is most useful when either replicating existing configuration settings to a new host, or when applying a known desired configuration across several hosts in a cluster.

Type Description
esx.attestation.raw_config.info The info structure contains information that describes the persistent user configuration.
esx.attestation.raw_config.set_spec The set_spec structure contains information that describes a new configuration to applied using set.

status

The status service provides operations to get the attestation service health status.
Type Description
esx.attestation.status.info The info structure contains information that describes the status of the service.

esx attestation tpm2

The esx.attestation.tpm2 API provides services to manage remote attestation configuration for TPM trust.

ca certificates

The ca_certificates service provides operations to manage Trusted Platform Module (TPM) CA certificates.

Endorsement Keys are typically packaged in a certificate that is signed by a certificate authority (CA). This service allows the CA certificate to be registered with the attestation service in order to validate TPM EK certificates when presented at attestation time.

Type Description
esx.attestation.tpm2.ca_certificates.create_spec The create_spec structure contains information that describes a TPM CA certificate.
esx.attestation.tpm2.ca_certificates.info The info structure contains information that describes a TPM CA certificate.
esx.attestation.tpm2.ca_certificates.summary The summary structure contains information that summarizes a TPM CA certificate.
esx.attestation.tpm2.ca_certificates.x509_cert_chain The x509_cert_chain structure contains information that fully describes a certificate chain.

endorsement keys

The endorsement_keys service provides operations to manage Trusted Platform Module (TPM) Endorsement Keys (EK).
Type Description
esx.attestation.tpm2.endorsement_keys.create_spec The create_spec structure contains information that describes a TPM endorsement key.

Only one of esx.attestation.tpm2.endorsement_keys.create_spec.public_key or esx.attestation.tpm2.endorsement_keys.create_spec.certificate must be specified.

esx.attestation.tpm2.endorsement_keys.info The info structure contains information that describes a TPM endorsement key.
esx.attestation.tpm2.endorsement_keys.summary The summary structure contains information that summarizes a TPM endorsement key.

settings

The settings service provides operations to get or update settings related to the TPM 2.0 attestation protocol behavior.
Type Description
esx.attestation.tpm2.settings.info The info structure contains information that describes the TPM 2.0 protocol settings.
esx.attestation.tpm2.settings.update_spec The update_spec structure contains information that describes changes to the TPM 2.0 protocol settings.

esx authentication

The esx.authentication API provides services for managing ESX authentication and identity management.

client profiles

The client_profiles service provides operations to manage ESX authentication tokens claims. Subject matching is used to provide permission claims described by esx.authentication.client_profiles.access_grant list.

When multiple profiles match, union of the esx.authentication.client_profiles.access_grant elements is applied. When no profiles match, no permission claims are applied.

Type Description
esx.authentication.client_profiles.access_grant The access_grant structure contains information about access permissions.

The structure includes resource type and the specific resource information - entitlement.

esx.authentication.client_profiles.create_spec The create_spec structure contains fields to be specified for creating a new client profile.

The structure includes a subject - local user, external user or external group, and a list of access grants.

esx.authentication.client_profiles.filter_spec The filter_spec structure contains information about filtering the list of existing ClientProfiles.

The structure includes local user, external group or external user specification.

Only one of the subject types can be specified. The filter is appied using exact match of all fields.

esx.authentication.client_profiles.info The info structure contains information about an existing client profile.

The structure includes a subject type, the details of the subject - local user, external user or external group, and a list of access grants.

  • A local user is a user account configured on the ESX system.
  • An external user is a user account configured in an external for the ESX identity provider.
  • An external group is a group account configured in an external for the ESX identity provider.
esx.authentication.client_profiles.subject The subject structure contains information about the subject that a client profile is associated with.

The structure includes a name, issuer alias, and domain.

esx.authentication.client_profiles.summary The summary structure contains summary from the list of existing esx.authentication.client_profiles.

The structure includes a client profile identifier, subject type, the details of the subject - local user, external user or external group.

esx.authentication.client_profiles.update_spec The update_spec structure contains the fields of the existing client profile which can be updated.

The structure includes a list of access grants.

token

ESXi Authentication service

This token service is providing tokens for accessing control plane services on the host.

It is reading the user's credentials from the call context and creates a signed API access token. The token can be presented as authentication to the other host APIs. API clients should treat the token as opaque value. Future ESXi releases may utilize different token technology. There are no backwards compatibility guarantees about the token format and technology. The current implementation uses JSON Web Tokens (JWT) as per RFC 7519.

Type Description
esx.authentication.token.token_info The token_info structure contains API access token.

esx authentication trust

security token issuers

The security_token_issuers service provides operations to manage ESX trust to Security Token Issuers. For example WS-Trust SSO STS or OAuth Identity Providers, that issue authentication tokens.

Each record contains a list of X.509 certificate chains that apply for a unique token issuer. The certificates are used to verify security tokens from this issuer.

Symmetric signing keys are not suported.

If a security token is received with issuer that has no configured security_token_issuers instance, the authentication fails and an error is returned.

Type Description
esx.authentication.trust.security_token_issuers.create_spec The create_spec structure contains fields to be specified for creating a new security token issuer trust. The structure includes an alias identifier, an issuer and a list of certificate chains.
esx.authentication.trust.security_token_issuers.info The info structure contains information about an existing security token issuer trust.

The structure includes an issuer and a list of token signing certificate chains.

esx.authentication.trust.security_token_issuers.issuer_already_exists_info The issuer_already_exists_info structure contains the information under which alias the issuer is.
esx.authentication.trust.security_token_issuers.summary The summary structure contains summary from the list of existing security token issuer trusts.

The structure includes the alias identifier and the issuer string.

esx.authentication.trust.security_token_issuers.update_spec The update_spec structure contains the fields of the existing security token issuer trust which can be updated.

The structure includes an issuer and a list of token signing certificate chains.

esx.authentication.trust.security_token_issuers.x509_cert_chain The x509_cert_chain structure contains information about a chain of X.509 certificates.

The structure includes a list of strings, each string is a PEM encoded certificate.

esx hcl

The esx.hcl API provides services to query the hardware compatibility for an ESXi or a cluster.
Type Description
esx.hcl.driver The driver structure contains fields describing information about a driver.
esx.hcl.firmware The firmware structure contains fields describing information about a firmware.
esx.hcl.notification The notification structure contains fields to describe any info/warning/error messages that Tasks can raise.
esx.hcl.notifications The notifications structure contains info/warning/error messages that can be reported be the task.
esx.hcl.PCI_device The PCI_device structure contains fields describing information about a single PCI device on a host.
esx.hcl.server The server structure contains fields describing information about a server.

compatibility data

This service provides operations to update the local compatibility data residing on the vCenter Appliance or to get information about the said data. The information in the data is generic VMware compatibility information for servers and devices.
Type Description
esx.hcl.compatibility_data.status The status structure contains fields to describe the information available for the compatibility data.

esx hcl hosts

compatibility releases

This service provides operations to list available releases for generating compatibility report for a specific ESXi host.
Type Description
esx.hcl.hosts.compatibility_releases.esxi_compatibility_releases This esxi_compatibility_releases structure contains fields that describe available releases for generating compatibility report for a specific ESXi host.

compatibility report

This service provides operations to generate hardware compatibility report for a given ESXi host against a specific ESXi release.
Type Description
esx.hcl.hosts.compatibility_report.bios_constraint This bios_constraint structure contains fields that describe the BIOS that is supported for the given server and ESXi release.
esx.hcl.hosts.compatibility_report.device_constraint This device_constraint structure contains fields that describe pair of driver and firmware that are supported for a given PCI device and ESXi release.
esx.hcl.hosts.compatibility_report.device_hcl_info This device_hcl_info structure contains fields that describe a PCI device of a given ESXi host and its compatibility information.

If there are multiple PCI devices of the same type on the host each one will be listed in separate instance of this class.

esx.hcl.hosts.compatibility_report.hcl_report This hcl_report represents the hardware compatibility report generated for a specific host and target ESXi release.
esx.hcl.hosts.compatibility_report.result The result structure contains the result of hardware compatibility report creation operation.
esx.hcl.hosts.compatibility_report.server_compatibility This server_compatibility structure contains fields that provide the compatibility information for a server model, cpu and BIOS.
esx.hcl.hosts.compatibility_report.server_hcl_info This server_hcl_info structure contains fields that describe the server of a ESXi host and its compatibility information.
esx.hcl.hosts.compatibility_report.spec The spec structure contains fields to describe the input configuration for an ESXi's compatibility report generation.

reports

This service provides operations to download information generated from the hardware compatibility feature residing on the vCenter Appliance.
Type Description
esx.hcl.reports.location The location structure contains the URI location to download generated compatibility report, as well as a token required (as a header on the HTTP GET request) to get the report. The validity of the token is 5 minutes. After the token expires, any attempt to call the URI with said token will fail.
esx.hcl.reports.token The token structure contains information about the token required to be passed in the HTTP header in the HTTP GET request to generate the report.

esx hosts

The esx.hosts API provides services to manage ESX host.
Type Description
esx.hosts.add_on_info The add_on_info structure contains fields that describe a specific OEM customization add-on.
esx.hosts.base_image_info The base_image_info structure contains fields that describe a specific ESX base-image.
esx.hosts.component_info The component_info structure contains fields that describe a specific component version in a software specification.
esx.hosts.software_info The software_info structure contains fields that describe desired software specification for an ESX host.
esx.hosts.solution_info The solution_info structure contains fields that describe solution registered in the software specification.

esx hosts software

The esx.hosts.software API provides services to get information about current software on ESX.

installed components

The installed_components service provides operations to get installed list of components.
Type Description
esx.hosts.software.installed_components.installed_component_info The installed_component_info structure contains fields that describe the installed component on the host.

esx kms

The esx.kms API provides services to manage the vSphere Trust Authority Key Provider Service.

esx kms providers

The esx.kms.providers API provides services to manage Key Providers.

providers

The providers service provides operations to create, update and delete Key Providers.
Type Description
esx.kms.providers.create_spec The create_spec structure contains fields that describe the desired configuration for a new provider.
esx.kms.providers.info The info structure contains fields that describe the current configuration of a provider.
esx.kms.providers.key_server_create_spec The key_server_create_spec structure contains fields that describe the desired configuration for key server.
esx.kms.providers.key_server_info The key_server_info structure contains fields that describe the current configuration of a key server.
esx.kms.providers.key_server_update_spec The key_server_update_spec structure contains fields that describe new configuration for an existing key server.
esx.kms.providers.kmip_server_create_spec The kmip_server_create_spec structure contains fields that describe the desired configuration for KMIP based key server.
esx.kms.providers.kmip_server_info The kmip_server_info structure contains fields that describe the current configuration of a KMIP based key server.
esx.kms.providers.kmip_server_update_spec The kmip_server_update_spec structure contains fields that describe new configuration for KMIP based key server.
esx.kms.providers.network_address The network_address structure contains an IP address or hostname and a port on which a connection can be established.
esx.kms.providers.server The server structure contains fields that describe a connection endpoint.
esx.kms.providers.summary The summary structure contains fields that summarize a provider.
esx.kms.providers.update_spec The update_spec structure contains fields that describe the new configuration for an existing provider.

esx kms providers client certificate

The esx.kms.providers.client_certificate API provides services to manage client certificates.

client certificate

The client_certificate service provides operations to add and retrieve client certificate.
Type Description
esx.kms.providers.client_certificate.get_spec The get_spec structure contains fields that describe the specifications for getting private key along with client certificate.
esx.kms.providers.client_certificate.info The info structure contains information for a certificate.
esx.kms.providers.client_certificate.set_spec The set_spec structure contains fields that describe the specifications for setting certificate and private key.

csr

The csr service provides operations to create a certificate signing request(CSR).
Type Description
esx.kms.providers.client_certificate.csr.get_spec The get_spec structure contains fields that describe the specifications for getting private key along with CSR.
esx.kms.providers.client_certificate.csr.info The info structure contains information for a CSR.
esx.kms.providers.client_certificate.csr.set_spec The set_spec structure contains fields that describe the specifications for setting CSR and private key.

esx kms providers server certificates

The esx.kms.providers.server_certificates API provides services to manage server certificates.

server certificates

The server_certificates service provides operations to add and retrieve trusted server certificates.

A provider must be configured with a trusted server certificate before performing any key operations.

Type Description
esx.kms.providers.server_certificates.info The info structure contains information for trusted key management server certificates.

remote

The remote service provides operations to retrieve remote key server certificate.
Type Description
esx.kms.providers.server_certificates.remote.filter_spec The filter_spec structure contains fields used to filter the results when listing remote server certificates.
esx.kms.providers.server_certificates.remote.summary The summary structure contains a summary of a remote key server certificate.

status

The status service provides status of a Key Provider.
Type Description
esx.kms.providers.status.info The info structure contains fields that describe the status of the Key Provider.
esx.kms.providers.status.server_info The server_info structure contains fields that describe the status of a key server.

raw config

The raw_config service provides operations to get or put the key management service persistent user configuration.

This service is most useful when either replicating existing configuration settings to a new host, or when applying a known desired configuration across several hosts in a cluster.

Type Description
esx.kms.raw_config.info The info structure contains information that describes the persistent user configuration.
esx.kms.raw_config.set_spec The set_spec structure contains information that describes a new configuration to applied using set.

status

The status service provides operations to get the key management service health status.
Type Description
esx.kms.status.info The info structure contains fields that describe the status of the key management service.

esx settings

The esx.settings API provides services to manage ESX settings.
Type Description
esx.settings.add_on_compliance The add_on_compliance structure contains information that describe the compliance of the OEM add-on with respect to the add-on present in the target software specification.
esx.settings.add_on_details The add_on_details structure contains information that provide more details about the add-on from the depot.
esx.settings.add_on_info The add_on_info structure contains information that describe a specific OEM customization add-on.
esx.settings.add_on_spec The add_on_spec structure contains fields that describe a specific OEM customization add-on.
esx.settings.base_image_compliance The base_image_compliance structure contains information that describe the compliance of ESX base image with respect to the base image present in the target software specification.
esx.settings.base_image_details The base_image_details structure contains information that provide more details about the base image from the depot.
esx.settings.base_image_info The base_image_info structure contains information that describe a specific ESX base-image.
esx.settings.base_image_spec The base_image_spec structure contains fields that describe a specific ESX base-image.
esx.settings.cluster_compliance The cluster_compliance structure contains fields to describe the compliance result of a cluster.
esx.settings.component_compliance The component_compliance structure contains information that describe the compliance of a component with respect to the component present in the target software specification.
esx.settings.component_details The component_details structure contains information that provide more details about the component from the depot.
esx.settings.component_info The component_info structure contains information that describe a specific component version in a software specification.
esx.settings.component_override_info The component_override_info structure contains fields that describe how the component was overridden.
esx.settings.effective_component_details The effective_component_details structure contains information that provide more details about the component from the depot.
esx.settings.effective_component_info The effective_component_info structure contains information that describe a component and how that component appeared in the software specification.
esx.settings.hardware_module_details The hardware_module_details structure contains information that provide more details about the a hardware module (e.g. BIOS, PCI device).
esx.settings.hardware_module_firmware_compliance The hardware_module_firmware_compliance structure contains information that describe the compliance of firmware of a particular hardware module (e.g. BIOS, PCI device) on the host with respect to the firmware present in the target Hardware Support Package (HSP) specification.
esx.settings.hardware_module_firmware_info The hardware_module_firmware_info structure contains information to describe the firmware on a hardware component or module (e.g. BIOS, PCI device).
esx.settings.hardware_support_info The hardware_support_info structure contains information to describe the desired Hardware Support Package (HSP) configured for a cluster.
esx.settings.hardware_support_package_compliance The hardware_support_package_compliance structure contains information that describe compliance of the Hardware Support Package (HSP) on the host with respect to the Hardware support Package (HSP) present in the target software image specification, if any.
esx.settings.hardware_support_package_info The hardware_support_package_info structure contains information to describe the desired Hardware Support Package (HSP) configured for a single device or distinct group of devices (typically the OEM's, including BIOS and device firmware).
esx.settings.hardware_support_package_spec The hardware_support_package_spec structure contains fields to describe the desired Hardware Support Package (HSP) configured for a single device or distinct group of devices (typically the OEM's, including BIOS, device firmware and OEM-supplied driver or agent components).
esx.settings.hardware_support_spec The hardware_support_spec structure contains fields to describe the desired Hardware Support Package (HSP) configured for a cluster.
esx.settings.host_compliance The host_compliance structure contains information to describe the compliance result of a host with respect to given target software specification.
esx.settings.host_info The host_info structure contains fields to describe some details regarding a host in the inventory.
esx.settings.notification The notification structure contains fields to describe any info/warning/error messages that Tasks can raise.
esx.settings.notifications The notifications structure contains info/warning/error messages that can be reported be the task.
esx.settings.software_info The software_info structure contains information that describes the desired software specification for an ESX host.
esx.settings.software_spec The software_spec structure contains fields that describe desired software specification for an ESX host.
esx.settings.solution_compliance The solution_compliance structure contains information that describe the compliance result of a host with respect to given solution present in the target software specification.
esx.settings.solution_component_details The solution_component_details structure contains information that provide more details about component registered by the solution from depot.
esx.settings.solution_component_spec The solution_component_spec structure contains fields that describe a component registered by a software solution.
esx.settings.solution_details The solution_details structure contains information that provide more details about the solution from the depot.
esx.settings.solution_info The solution_info structure contains information that describe solution registered in the software specification.
esx.settings.solution_spec The solution_spec structure contains fields that describe solution registered in the software specification.
esx.settings.task_info The task_info structure contains information about a task and its subtasks of which it consists.

esx settings clusters

The esx.settings.clusters API provides services to manage desired state configuration and software for a cluster of ESX hosts.

depot overrides

The depot_overrides service provides operations to manage software depots overriden for a given cluster. In general ESX servers reach out to vCenter (VUM) to fetch the metadata and payloads required for lifecycle operations. But in ROBO environments ESX clusters can't (or because of bandwidth requirements shouldn't) reach out to vCenter to fetch payloads and metadata. This service allows setting cluster level overrides for depots. If any depots are provided for a cluster, then vCenter level depots are not used for that cluster's remediation. These are not synced periodically at vCenter and are only used by ESXs for lifecycle operations.
Type Description
esx.settings.clusters.depot_overrides.depot The depot structure defines the information regarding a particular depot override for a given cluster.
esx.settings.clusters.depot_overrides.info The info structure defines the information regarding depot overrides for a given cluster.

esx settings clusters enablement

The esx.settings.clusters.enablement API provides services to manage enablement of the feature that allows to collectively manage hosts within the cluster with a single software specification.

software

The software service provides operations to control whether the cluster is managed with a single software specification.
Type Description
esx.settings.clusters.enablement.software.check_result The check_result structure contains information that describes the results of the checks.
esx.settings.clusters.enablement.software.check_spec The check_spec structure contains information describing what checks should be performed.
esx.settings.clusters.enablement.software.enable_spec The enable_spec structure contains information describing checks that should be skipped during enablement. Currently only SOFTWARE check can be skipped.
esx.settings.clusters.enablement.software.info The info structure contains information describing whether the feature is enabled.

esx settings clusters policies

The esx.settings.clusters.policies API provides services to manage policies that affect management of desired state configuration and software for an ESXi cluster. Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential

esx settings clusters policies apply

The esx.settings.clusters.policies.apply API provides services to manage policies that affect application of desired state configuration and software for an ESXi cluster. Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential

apply

The apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to an ESXi cluster.
Type Description
esx.settings.clusters.policies.apply.configured_policy_spec The configured_policy_spec structure contains fields that describe the policies configured to be used when the software and configuration specification documents are applied to an ESXi cluster.
esx.settings.clusters.policies.apply.failure_action The failure_action structure contains fields that describe the actions to be taken when entering maintenance mode fails on a single host within the cluster.

effective

The effective service provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to an ESXi cluster.
Type Description
esx.settings.clusters.policies.apply.effective.effective_policy_spec The effective_policy_spec structure contains fields that describe the effective policies to be used when the software and configuration specification documents are applied to an ESXi cluster.
esx.settings.clusters.policies.apply.effective.failure_action The failure_action structure contains fields that describe the actions to be taken when entering maintenance mode fails on a single host within the cluster.

esx settings clusters software

The esx.settings.clusters.software API provides services to manage desired state software for ESX cluster.

software

The software service provides operations to manage desired software specification of an ESX cluster.
Type Description
esx.settings.clusters.software.apply_result The apply_result structure contains fields that describe the result of an apply operation.
esx.settings.clusters.software.apply_spec The apply_spec structure contains fields that describe the specification to be used for applying the desired software document to a cluster.
esx.settings.clusters.software.apply_status The apply_status structure contains fields that describe the status of an apply operation.
esx.settings.clusters.software.check_info The check_info structure contains fields that describe a particular check.
esx.settings.clusters.software.check_result The check_result structure contains fields that describe aggregated status of all checks performed.
esx.settings.clusters.software.check_spec The check_spec structure contains fields that describe the specification to be used for running checks on the cluster before the apply operation.
esx.settings.clusters.software.check_status The check_status structure contains fields that describe a check result.
esx.settings.clusters.software.entity_check_result The entity_check_result structure contains fields that describe aggregated status of all checks performed on a specific entity.
esx.settings.clusters.software.export_spec The export_spec structure contains information describing how a software specification or image should be exported.

commits

The commits service provides operations to manage committed changes to desired software document.
Type Description
esx.settings.clusters.software.commits.info The info structure defines the information about software draft.

esx settings clusters software drafts software

The esx.settings.clusters.software.drafts.software API provides services to manage draft of the software documents for ESX cluster.

components

The components service provides operations to manage component specification in a software draft.
Type Description
esx.settings.clusters.software.drafts.software.components.update_spec The update_spec structure contains fields that are specified to update list of components in the draft.

recommendations

The recommendations service provides operations to manage the generation and retrieval of recommended image specs.
Type Description
esx.settings.clusters.software.recommendations.explanation_details The explanation_details structure contains fields to describe the result of validation of desired software specification.
esx.settings.clusters.software.recommendations.info The info structure defines the information about the most recent recommendation generation result.

esx settings clusters software reports

The esx.settings.clusters.software.reports API provides services to manage reports pertaining to the desired state software for a cluster of ESXi hosts.
Type Description
esx.settings.clusters.software.reports.check_result The check_result structure contains information to describe HCL compliance result of a cluster on target software specification.
esx.settings.clusters.software.reports.driver_firmware_version The driver_firmware_version structure contains information about device's driver and firmware version combination from Hardware Compatibility List.
esx.settings.clusters.software.reports.pci_device The pci_device structure contains information about a PCI Device.
esx.settings.clusters.software.reports.pci_device_compliance The pci_device_compliance structure contains information that describe the compliance result of all pci device from all hosts in the clsuter with respect to the component present in the target software specification.
esx.settings.clusters.software.reports.pci_device_compliance_info The pci_device_compliance_info structure contains information that describe the compliance of a pci device with respect to the component present in the target software specification.

apply impact

The apply_impact service provides operations to get the impact of an apply operation on a cluster.
Type Description
esx.settings.clusters.software.reports.apply_impact.apply_impact_spec The apply_impact_spec structure contains fields that describe the specification to be used for getting the impact of an apply operation on an ESXi cluster.
esx.settings.clusters.software.reports.apply_impact.cluster_impact The cluster_impact structure contains fields that describe the summary of how hosts within a cluster will be impacted during an apply operation.
esx.settings.clusters.software.reports.apply_impact.impact The impact structure contains fields that describe what the impact is of a particular step during the apply operation.

hardware compatibility

The hardware_compatibility service provides operations to manage HCL Validation of a software specification of an ESX cluster.
Type Description
esx.settings.clusters.software.reports.hardware_compatibility.check_summary The check_summary structure contains information to describe the HCL compliance summary result of a cluster on target software specification.

last apply result

The last_apply_result service provides operations to get the most recent available result of applying the desired software document to all hosts within a cluster.
Type Description
esx.settings.clusters.software.reports.last_apply_result.apply_result The apply_result structure contains fields that describe the result of an apply operation.
esx.settings.clusters.software.reports.last_apply_result.apply_status The apply_status structure contains fields that describe the status of an apply operation.

last check result

The last_check_result service provides operations to get the most recent available result of the checks that have been run on a cluster before the application of the desired software document to all hosts within the cluster.
Type Description
esx.settings.clusters.software.reports.last_check_result.check_info The check_info structure contains fields that describe a particular check.
esx.settings.clusters.software.reports.last_check_result.check_result The check_result structure contains fields that describe aggregated status of all checks performed.
esx.settings.clusters.software.reports.last_check_result.check_status The check_status structure contains fields that describe a check result.
esx.settings.clusters.software.reports.last_check_result.entity_check_result The entity_check_result structure contains fields that describe aggregated status of all checks performed on a specific entity.

esx settings defaults clusters policies

Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential

esx settings defaults clusters policies apply

The esx.settings.defaults.clusters.policies.apply API provides services to manage policies that affect application of desired state configuration and software for ESXi clusters. Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential

apply

The apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to ESXi clusters.
Type Description
esx.settings.defaults.clusters.policies.apply.configured_policy_spec The configured_policy_spec structure contains fields that describe the policies configured to be used when the software and configuration specification documents are applied to ESXi clusters.
esx.settings.defaults.clusters.policies.apply.failure_action The failure_action structure contains fields that describe the actions to be taken when entering maintenance mode fails on a single host within the cluster.

effective

The effective service provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to ESXi clusters.
Type Description
esx.settings.defaults.clusters.policies.apply.effective.effective_policy_spec The effective_policy_spec structure contains fields that describe the effective policies to be used when the software and configuration specification documents are applied to ESXi clusters.
esx.settings.defaults.clusters.policies.apply.effective.failure_action The failure_action structure contains fields that describe the actions to be taken when entering maintenance mode fails on a single host within the cluster.

esx settings depot content

The esx.settings.depot_content API provides services to retrieve contents from the depot.

esx settings depot content add ons

The esx.settings.depot_content.add_ons API provides services to retrieve OEM specific add-on versions from the depot.

add ons

The add_ons service provides operations to get OEM add-ons from the sync'ed and imported depots.
Type Description
esx.settings.depot_content.add_ons.add_on_version_summary The add_on_version_summary structure defines the summary information regarding a version of an OEM add-on.
esx.settings.depot_content.add_ons.filter_spec The filter_spec structure contains fields used to filter the results when listing OEM add-ons, see list).
esx.settings.depot_content.add_ons.summary The summary structure defines the summary information regarding a OEM add-on.

versions

The versions service provides operations to get OEM add-on versions from the sync'ed and imported depots.
Type Description
esx.settings.depot_content.add_ons.versions.component_info The component_info structure defines the information regarding a component present in OEM add-on.
esx.settings.depot_content.add_ons.versions.info The info structure defines the information regarding a OEM add-on version.
esx.settings.depot_content.add_ons.versions.removed_component_info The removed_component_info structure defines the information regarding a component removed by the OEM add-on.

esx settings depot content base images

The esx.settings.depot_content.base_images API provides services to retrieve base_images from the depot.

base images

The base_images service provides operations to get base-images from the sync'ed and imported depots.
Type Description
esx.settings.depot_content.base_images.filter_spec The filter_spec structure contains fields used to filter the results when listing base-images, see list).
esx.settings.depot_content.base_images.summary The summary structure defines the summary information regarding a base-image.

versions

The versions service provides operations to get versions of base-images from the sync'ed and imported depots.
Type Description
esx.settings.depot_content.base_images.versions.component_version_info The component_version_info structure defines the information regarding a component present inbase-image.
esx.settings.depot_content.base_images.versions.info The info structure defines the information regarding a base-image.

esx settings depot content components

The esx.settings.depot_content.components API provides services to retrieve component versions from the depot.

components

The components service provides operations to get Components from the sync'ed and imported depots.
Type Description
esx.settings.depot_content.components.component_version_summary The component_version_summary structure defines the summary information regarding a version of a component.
esx.settings.depot_content.components.filter_spec The filter_spec structure contains fields used to filter the results when listing components, see list).
esx.settings.depot_content.components.summary The summary structure defines the summary information regarding a component.

versions

The versions service provides operations to get component versions from the sync'ed and imported depots.
Type Description
esx.settings.depot_content.components.versions.info The info structure defines the information regarding a component version.

esx settings depots

The esx.settings.depots API provides services to manage VUM compatible ESX Depots.

offline

The offline service provides operations to manage Offline Software Depots used during ESX lifecycle management.
Type Description
esx.settings.depots.offline.create_result The create_result structure defines the result information for a new Offline Depot.
esx.settings.depots.offline.create_spec The create_spec structure defines the information used to create a depot.
esx.settings.depots.offline.info The info structure defines the information regarding an Offline Depot.
esx.settings.depots.offline.summary The summary structure defines the summary information regarding an Offline Depot.

online

The online service provides operations to manage Online Software Depots used during ESX lifecycle management.
Type Description
esx.settings.depots.online.create_spec The create_spec structure defines the information used to create a depot.
esx.settings.depots.online.info The info structure defines the information regarding a Depot.
esx.settings.depots.online.summary The summary structure defines the summary information regarding a Depot.
esx.settings.depots.online.update_spec The update_spec structure defines the information used to update the depot.

sync schedule

The sync_schedule service provides operations to manage Schedule of Online Software Depot sync.
Type Description
esx.settings.depots.sync_schedule.schedule The schedule structure defines a schedule.
esx.settings.depots.sync_schedule.spec The spec structure defines the information regarding the sync schedule.

umds

The umds service provides operations to manage VMware vSphere Update Manager Download Service (UMDS) software depots used during ESX lifecycle management. This is the depot downloaded using UMDS.

If a UMDS depot is specified then online depots are ignored and data is downloaded only from the UMDS depot.

Type Description
esx.settings.depots.umds.info The info structure defines the information regarding an UMDS Depot.
esx.settings.depots.umds.set_spec The set_spec structure defines the information of an UMDS depot.
esx.settings.depots.umds.update_spec The update_spec structure defines the information used to update the UMDS depot.

esx trusted infrastructure

The esx.trusted_infrastructure API provides services for managing Trusted Hosts.
Type Description
esx.trusted_infrastructure.network_address The network_address structure contains an IP address or DNS resolvable name and a port on which a connection can be established.
esx.trusted_infrastructure.x509_cert_chain The x509_cert_chain structure contains x509 certificate chain.

esx trusted infrastructure attestation

services

The services service manages endpoint configuration about the attestation service and its relation to the Key Management Server (KMS) services.
Type Description
esx.trusted_infrastructure.attestation.services.create_spec The create_spec structure contains the data necessary for adding an attestation service instance to the environment.
esx.trusted_infrastructure.attestation.services.filter_spec The filter_spec structure contains the data necessary for identifying an attestation service instance.
esx.trusted_infrastructure.attestation.services.info The info structure contains all the stored information about an attestation service instance.
esx.trusted_infrastructure.attestation.services.summary The summary structure contains a summary of an attestation service instance.

esx trusted infrastructure kms

providers

The providers service provides operations to retrieve available key providers.
Type Description
esx.trusted_infrastructure.kms.providers.filter_spec The filter_spec structure contains fields used to filter the results when listing the providers.
esx.trusted_infrastructure.kms.providers.summary The summary structure contains a summary of a key provider.

services

The services service manages endpoint configuration about the Key Management Server (KMS) service and its relation to the attestation services.
Type Description
esx.trusted_infrastructure.kms.services.create_spec The create_spec structure contains the data necessary for adding a KMS service instance to the environment.
esx.trusted_infrastructure.kms.services.filter_spec The filter_spec structure contains the data necessary for identifying a KMS service instance.
esx.trusted_infrastructure.kms.services.info The info structure contains all the stored information about a KMS service instance.
esx.trusted_infrastructure.kms.services.summary The summary structure contains a summary of a KMS service instance.

vapi metadata

The vapi.metadata API provides metadata services. These are services that provide different facets of API information. Clients can use these services to:
Type Description
vapi.metadata.source_create_spec The source_create_spec structure contains the registration information for a metadata source.
vapi.metadata.source_info Metadata source info

vapi metadata authentication

The vapi.metadata.authentication API provides services that expose authentication information for operation elements across all the service elements.

To calculate the effective authentication information for an operation element, you should first see if there is an authentication scheme specified for the operation element. If it is not specified, then authentication scheme for the service element that contains this operation element is used. If it is not specified for the service element as well, then the authentication scheme for the package element that contains this service element is used.

Type Description
vapi.metadata.authentication.authentication_info The authentication_info structure describes the authentication information. Authentication information could be specified for a package element, service elenent or an operation element.

Using the authentication scheme information, a client invoking an API call from any service can figure out what kind of credentials are needed for that API call.

vapi.metadata.authentication.component_data The component_data structure contains the authentication information of the component along with its fingerprint.
vapi.metadata.authentication.component_info The component_info structure contains authentication information of a component element.

For an explanation of authentication information contained within component elements, see vapi.metadata.authentication.component.

vapi.metadata.authentication.operation_info The operation_info structure contains authentication information of an operation element.
vapi.metadata.authentication.package_info The package_info structure contains authentication information of a package element.

For an explanation of authentication information contained within package elements, see vapi.metadata.authentication.package.

vapi.metadata.authentication.service_info The service_info structure contains authentication information of a service element.

For an explanation of authentication information contained within service elements, see vapi.metadata.authentication.service.

vapi metadata cli

The vapi.metadata.cli API provides services that expose all the information required to display namespace or command help, execute a command and display it's result.

command

The command service provides operations to get information about command line interface (CLI) commands.
Type Description
vapi.metadata.cli.command.identity The identity structure uniquely identifies a command in the CLI commands tree.
vapi.metadata.cli.command.info The info structure contains information about a command. It includes the identity of the command, a description, information about the service and operation that implement the command, and CLI-specific information for the command.
vapi.metadata.cli.command.option_info The option_info structure describes information about a specific input option of a command.
vapi.metadata.cli.command.output_field_info The output_field_info structure describes the name used by the CLI to display a single field of a structure element in the interface definition language.
vapi.metadata.cli.command.output_info The output_info structure describes the names used by the CLI to display the fields of a structure element in the interface definition language as well as the order in which the fields will be displayed.

namespace

The namespace service provides operations to get information about command line interface (CLI) namespaces.
Type Description
vapi.metadata.cli.namespace.identity The identity structure uniquely identifies a namespace in the CLI namespace tree.
vapi.metadata.cli.namespace.info The info structure contains information about a namespace. It includes the identity of the namespace, a description, information children namespaces.

vapi metadata metamodel

The vapi.metadata.metamodel API provides services that expose all the information present in the interface definition language (IDL) specification.

Metamodel metadata is organized into an hierarchy of elements. The main elements are:

The vapi.metadata.metamodel API has services that enables two styles of client applications:
Type Description
vapi.metadata.metamodel.component_data The component_data structure contains the metamodel metadata information of a component element along with its fingerprint.
vapi.metadata.metamodel.component_info The component_info structure contains metamodel metadata information about a component element.
vapi.metadata.metamodel.constant_info The constant_info structure contains metamodel information of the constant elements.
vapi.metadata.metamodel.constant_value The constant_value structure contains the metamodel information of the constant element.
vapi.metadata.metamodel.element_map The element_map structure contains the metadata elements.

One of the sources for metadata is the annotations present in the interface definition language. When an annotation is represented in the element_map, element_map describes the data specified in the arguments for the annotation.

For example, in @UnionCase(tag="tag", value="SELECT"), ElementMap describes the keyword arguments tag and value.

vapi.metadata.metamodel.element_value The element_value structure describes the value of the metadata element.
vapi.metadata.metamodel.enumeration_info The enumeration_info structure contains the metamodel information of an enumeration element.
vapi.metadata.metamodel.enumeration_value_info The enumeration_value_info structure describes the enumeration value in the enumerated type.
vapi.metadata.metamodel.error_info The error_info structure contains the metadata information about the error elements contained in an operation element.
vapi.metadata.metamodel.field_info The field_info structure contains metamodel information of a field element contained in a structure element.
vapi.metadata.metamodel.generic_instantiation The generic_instantiation structure describes the type information of a typed element when the type is an instantiation of one of the generic types provided by the infrastructure.
vapi.metadata.metamodel.operation_info The operation_info structure contains metamodel information of an operation element.
vapi.metadata.metamodel.operation_result_info The operation_result_info structure contains the metamodel information of an operation result element.

An operation accepts a list of parameters and returns a result or an error. The operation_result_info describes the result element of an operation.

vapi.metadata.metamodel.package_info The package_info structure contains the metamodel information of all the service elements, structure elements and enumeration elements contained in the package element.
vapi.metadata.metamodel.primitive_value The primitive_value structure contains value of the constant element.
vapi.metadata.metamodel.service_info The service_info structure contains the metamodel information of all the operation elements, structure elements and enumeration elements containted in a service element.
vapi.metadata.metamodel.structure_info The structure_info structure contains the metamodel information of all the field elements, constant elements and enumeration elements contained in the structure element.

In the interface definition language, API designers have the ability to include all the fields from one structure to another structure. This is done by using an annotation @Include on the structure in which we want to add the fields. If this annotation is present, the list of fields in the structure_info will also contain the fields that are being included. The annotation information is also retained in the vapi.metadata.metamodel.structure_info.metadata element as well.

vapi.metadata.metamodel.type The type structure describes the type information of a typed element in the interface definiton language. The following elements in the metamodel are typed: The type could be one of the three following categories:
  • Built-in types: These are types present in the interface definition language type system. They are provided by the infrastructure.
  • User defined named type: API designers can create custom types and use them for the typed elements. These types have a unique identifier.
  • Generic type instantiation: The language infrastructure also provides generic types such as list, map, set and so on. An instantiation of one of these generic types could also be used for the typed elements.
vapi.metadata.metamodel.user_defined_type The user_defined_type structure contains the metamodel type information of a typed element whose type is a user defined named type.

vapi metadata privilege

The vapi.metadata.privilege API provides services that expose privilege information for operation elements across all the service elements.

An entity has a unique identifier and a resource type. An entity can either be present in one of the parameter elements or if a parameter is a structure element, it could also be present in one of the field elements.

Privileges can be assigned to either operation elements or entities used in the operation element. A list of privileges can also be applied on a package element. This list of privileges would be used as a default for all the operation elements and the entities that do not have any defined privileges.

Type Description
vapi.metadata.privilege.component_data The component_data structure contains the privilege information of the component along with its fingerprint.
vapi.metadata.privilege.component_info The component_info structure contains the privilege information of a component element.

For an explanation of privilege information contained within component elements, see vapi.metadata.privilege.component.

vapi.metadata.privilege.operation_info The operation_info structure contains privilege information of an operation element.

For an explanation of containment within operation elements, see vapi.metadata.privilege.service.operation.

vapi.metadata.privilege.package_info The package_info structure contains the privilege information of a package element.

For an explanation of privilege information contained within package elements, see vapi.metadata.privilege.package.

vapi.metadata.privilege.privilege_info The privilege_info structure contains the privilege information for a parameter element in an operation element.
vapi.metadata.privilege.service_info The service_info structure contains privilege information of a service element.

For an explanation of privilege information contained within service elements, see vapi.metadata.privilege.service.

vapi std

The vapi.std API provides standard types that can be used in the interface specification of any service.
Type Description
vapi.std.authentication_scheme The vapi.std.authentication_scheme class defines constants for authentication scheme identifiers for authentication mechanisms present in the vAPI infrastructure shipped by VMware.

A third party extension can define and implements it's own authentication mechanism and define a constant in a different IDL file.

vapi.std.dynamic_ID The dynamic_ID structure represents an identifier for a resource of an arbitrary type.
vapi.std.localizable_message The localizable_message structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.
vapi.std.localization_param This structure holds a single message parameter and formatting settings for it. The structure has fields for string, long, double, date time and nested messages. Only one will be used depending on the type of data sent. For date, double and long it is possible to set additional formatting details. This structure was added in vSphere API 7.0.0.
vapi.std.nested_localizable_message The nested_localizable_message structure represents a nested within a parameter localizable string or message template. This structure is useful for modeling composite messages. Such messages are necessary to do correct pluralization of phrases, represent lists of several items etc. This structure was added in vSphere API 7.0.0.

vapi std errors

The vapi.std.errors API provides the standard errors that can be included in the list of errors in the specification of operations to indicate that the operation might report those errors. It also provides some structures intended to be used as payload to provide additional information about those errors.
Type Description
vapi.std.errors.already_exists The already_exists error indicates that an attempt was made to create an entity but the entity already exists. Typically the entity has a name or identifier that is required to be unique in some context, but there is already an entity with that name or identifier in that context.

Examples:

  • Trying to create a new tag category when a tag category with the specified name already exists.
  • Trying to create a new tag in tag category when a tag with the specified name already exists the tag category.
  • Trying to create a LUN with a specific UUID on a node (for replication purposes) when a LUN with that UUID already exists on the node.
  • Trying to create a file in a directory or move or copy a file to a directory when a file with that name already exists in the directory.
vapi.std.errors.already_in_desired_state The already_in_desired_state error indicates that an attempt to change the state of a resource or service had no effect because the resource or service is already in the desired state.

Examples:

  • Trying to power on a virtual machine that is already powered on.
vapi.std.errors.argument_locations The argument_locations structure describes which part(s) of the input to the operation caused the error.

Some types of errors are caused by the value of one of the inputs to the operation, possibly due to an interaction with other inputs to the operation. This structure is intended to be used as the payload to identify those inputs when the operation reports errors like vapi.std.errors.invalid_argument or vapi.std.errors.not_found. See vapi.std.errors.error.data.

vapi.std.errors.canceled The canceled error indicates that the operation canceled itself in response to an explicit request to do so. Operations being "canceled" for other reasons (for example the client connection was closed, a time out occured, or due to excessive resource consumption) should not report this error.

Examples:

  • A user is monitoring the progress of the operation in a GUI and sees that it is likely to take longer than he is willing to wait and clicks the cancel button.
  • A user invokes the operation using a command-line tool and decides that she didn't really want to invoke that operation, and presses CTRL-c.

Counterexamples:

  • The client's connection to the server was closed. Reporting an error is pointless since the client will not receive the error response because the connection has been closed.
  • The request is taking longer than some amount of time. The vapi.std.errors.timed_out error would be reported if the time was specified as part of the input or is documented in the API contract.
vapi.std.errors.concurrent_change The concurrent_change error indicates that a data structure, entity, or resource has been modified since some earlier point in time. Typically this happens when the client is doing the write portion of a read-modify-write sequence and indicates that it wants the server to notify it if the data in the server has changed after it did the read, so that it can avoid overwriting that change inadvertantly.
vapi.std.errors.error The error error describes thefields common to all standard errors.

This error serves two purposes:

  1. It is the error that clients in many programming languages can catch to handle all standard errors. Typically those clients will display one or more of the localizable messages from vapi.std.errors.error.messages to a human.
  2. It is the error that operations can report when they need to report some error, but the error doesn't fit into any other standard error, and in fact the only reasonable way for a client to react to the error is to display the message(s) to a human.
vapi.std.errors.feature_in_use The feature_in_use error indicates that an action cannot be completed because a feature is in use.

Examples:

  • Trying to disable snapshots on a virtual machine which has a snapshot.
  • Trying to downgrade a license that has licensed features that are in use.
vapi.std.errors.file_locations The file_locations structure identifies the file(s) that caused the operation to report the error.

Some types of errors are caused by a problem with one or more files. This structure is intended to be used as the payload to identify those files when the operation reports errors like vapi.std.errors.not_found. See vapi.std.errors.error.data.

vapi.std.errors.internal_server_error The internal_server_error error indicates that the server encounters an unexpected condition that prevented it from fulfilling the request.

This error is reported by the API infrastructure, so it could occur in response to the invocation of any operation.

Examples:

  • The operation returns a value whose type doesn't match the type type the operation says it should return.
  • The operation reports an error that is not included in the list of errors the operation says that it can report.
vapi.std.errors.invalid_argument The invalid_argument error indicates that the values received for one or more parameters are not acceptable.

This error is reported by the API infrastructure, so it could occur in response to the invocation of any operation. It may also be reported as the result of operation-specific validation.

Examples:

  • A parameter has a value that is not of the expected type.
  • A parameter has a value that is not in the required range.
  • A parameter has a value that is not one of the specifically allowed strings.
  • One field of a structure is the tag for a tagged union, and has a specific value but another field of the structure that is required to be specified when the tag has that value is not specified, or another field of the structure that is required to be unspecified when the tag has that value is specified.

Counterexamples:

  • Trying to create a new tag in tag category when a tag with the specified name already exists the tag category. The vapi.std.errors.already_exists error would be used instead.
  • Invoke the operation to retrieve information about a virtual machine, passing an id that does not identify an existing virtual machine. The vapi.std.errors.not_found error would be used instead.
  • Attempt to put a virtual machine into a folder that can only contain hosts. The vapi.std.errors.invalid_element_type error would be used instead.
  • Attempt to attach a SCSI virtual disk to an IDE port. The vapi.std.errors.invalid_element_type error would be used instead.
vapi.std.errors.invalid_element_configuration The invalid_element_configuration error indicates that an attempt to modify the configuration of an element or a group containing the element failed due to the configuraton of the element. A typical case is when the operation is am attempt to change the group membership of the element fails, in which case a configuration change on the element may allow the group membership change to succeed.

Examples:

  • Attempt to move a host with a fault tolerant virtual machine out of a cluster (i.e. make the host a standalone host).
  • Attempt to remove a host from a DRS cluster without putting the host into maintenance mode.
vapi.std.errors.invalid_element_type The invalid_element_type error indicates that the server was unable to fulfil the request because an element of a specific type cannot be a member of particular group.

This error could be reported, for example, if an attempt is made to put an element into the wrong type of container.

Examples:

  • Attempt to put a virtual machine into a folder that can only contain hosts.
  • Attempt to attach a SCSI virtual disk to an IDE port.
Counterexamples:
vapi.std.errors.invalid_request The invalid_request error indicates that the request is malformed in such a way that the server is unable to process it.

Examples:

  • The XML in a SOAP request is not well-formed so the server cannot parse the request.
  • The XML in a SOAP request is well-formed but does not match the structure required by the SOAP specification.
  • A JSON-RPC request is not valid JSON.
  • The JSON sent in a JSON-RPC request is not a valid JSON-RPC Request object.
  • The Request object from a JSON-RPC request does not match the structure required by the API infrastructure.

Counterexamples:

Some transport protocols (for example JSON-RPC) include their own mechanism for reporting these kinds of errors, and the API infrastructure for a programming language may expose the errors using a language specific mechanism, so this error might not be used.

vapi.std.errors.not_allowed_in_current_state The not_allowed_in_current_state error indicates that the requested operation is not allowed with a resource or service in its current state. This could be because the operation is performing a configuration change that is not allowed in the current state or because operation itself is not allowed in the current state.

Examples:

  • Trying to add a virtual device that cannot be hot plugged to a running virtual machine.
  • Trying to upgrade the virtual hardware version for a suspended virtual machine.
  • Trying to power off, reset, or suspend a virtual machine that is not powered on.

Counterexamples:

  • Trying to power off a virtual machine that is in the process of being powered on. The vapi.std.errors.resource_busy error would be used instead.
vapi.std.errors.not_found The not_found error indicates that a specified element could not be found.

Examples:

  • Invoke the operation to retrieve information about a virtual machine, passing an id that does not identify an existing virtual machine.
  • Invoke the operation to modify the configuration of a virtual nic, passing an id that does not identify an existing virtual nic in the specified virtual machine.
  • Invoke the operation to remove a vswitch, passing an id that does not identify an existing vswitch.
vapi.std.errors.operation_not_found The operation_not_found error indicates that the operation specified in the request could not be found.

Every API request specifies a service identifier and an operation identifier along with the parameters. If the API infrastructure is unable to find the requested service or operation it reports this error.

This error can be reported by the API infrastructure for any operation, but it is specific to the API infrastructure, and should never be reported by the implementation of any operation.

Examples:

  • A client provides an invalid service or operation identifier when invoking the operation using a dynamic interface (for example REST).
  • A client invokes the operation from a service, but that service has not been installed.

Counterexamples:

  • A client invokes a task scheduling operation, but provides an invalid service identifier or operation identifier. The vapi.std.errors.not_found error would be used instead.
vapi.std.errors.resource_busy The resource_busy error indicates that the operation could not be completed because a resource it needs is busy.

Examples:

  • Trying to power off a virtual machine that is in the process of being powered on.

Counterexamples:

  • Trying to remove a VMFS datastore when there is a virtual machine registered on any host attached to the datastore. The vapi.std.errors.resource_in_use error would be used instead.
vapi.std.errors.resource_in_use The resource_in_use error indicates that the operation could not be completed because a resource is in use.

Examples:

  • Trying to remove a VMFS datastore when the is a virtual machine registered on any host attached to the datastore.
  • Trying to add a virtual switch if the physical network adapter being bridged is already in use.

Counterexamples:

  • Trying to power off a virtual machine that is in the process of being powered on. The vapi.std.errors.resource_busy error would be used instead.
vapi.std.errors.resource_inaccessible The resource_inaccessible error indicates that the operation could not be completed because an entity is not accessible.

Examples:

  • Attempt to invoke some operation on a virtual machine when the virtual machine's configuration file is not accessible (for example due to a storage APD condition).

Counterexamples:

vapi.std.errors.service_unavailable The service_unavailable error indicates that the service is unavailable.

Examples:

  • Attempt to invoke a operation when the server is too busy.
  • Attempt to invoke a operation when the server is undergoing maintenance.
  • An operation fails to contact VMware Tools running inside the virtual machine.

Counterexamples:

  • A client provides an invalid service or operation identifier when invoking the operation using a dynamic interface (for example REST). The vapi.std.errors.operation_not_found error would be used instead.
  • A client invokes the operation from the service, but that service has not been installed. The vapi.std.errors.operation_not_found error would be used instead.
vapi.std.errors.timed_out The timed_out error indicates that the operation did not complete within the allowed amount of time. The allowed amount of time might be:
  • provided by the client as an input parameter.
  • a fixed limit of the service implementation that is a documented part of the contract of the service.
  • a configurable limit used by the implementation of the service.
  • a dynamic limit computed by the implementation of the service.
The operation may or may not complete after the timed_out error was reported.

Examples:

  • The operation was unable to complete within the timeout duration specified by a parameter of the operation.

Counterexamples:

  • A server implementation that puts requests into a queue before dispatching them might delete a request from the queue if it doesn't get dispatched within n minutes. The vapi.std.errors.service_unavailable error would be used instead.
vapi.std.errors.transient_indication The transient_indication structure indicates whether or not the error is transient.

Some types of errors are transient in certain situtations and not transient in other situtations. This error payload can be used to indicate to clients whether a particular error is transient. See vapi.std.errors.error.data.

vapi.std.errors.unable_to_allocate_resource The unable_to_allocate_resource error indicates that the operation failed because it was unable to allocate or acquire a required resource.

Examples:

  • Trying to power on a virtual machine when there are not enough licenses to do so.
  • Trying to power on a virtual machine that would violate a resource usage policy.

Counterexamples:

  • Trying to power off a virtual machine that is in the process of being powered on. A vapi.std.errors.resource_busy error would be used instead.
  • Trying to remove a VMFS datastore when the is a virtual machine registered on any host attached to the datastore. The vapi.std.errors.resource_in_use error would be used instead.
  • Trying to add a virtual switch if the physical network adapter being bridged is already in use. The vapi.std.errors.resource_in_use error would be used instead.
  • Attempt to invoke some operation on a virtual machine when the virtual machine's configuration file is not accessible (for example due to a storage APD condition). The vapi.std.errors.resource_inaccessible error would be used instead.
vapi.std.errors.unauthenticated The unauthenticated error indicates that the operation requires authentication and the user is not authenticated.

API requests may include a security context containing user credentials. For example, the user credentials could be a SAML token, a user name and password, or the session identifier for a previously established session.

Examples:

  • The SAML token in the request's security context has expired.
  • The user name and password in the request's security context are invalid.
  • The session identifier in the request's security context identifies a session that has expired.
Counterexamples:
  • The user is authenticated but isn't authorized to perform the requested operation. The vapi.std.errors.unauthorized error would be used instead.

For security reasons, the vapi.std.errors.error.data field in this error is unset, and the vapi.std.errors.error.messages field in this error does not disclose which part of the security context is correct or incorrect. For example the messages would not disclose whether a username or a password is valid or invalid, but only that a combination of username and password is invalid.

vapi.std.errors.unauthorized The unauthorized error indicates that the user is not authorized to perform the operation.

API requests may include a security context containing user credentials. For example, the user credentials could be a SAML token, a user name and password, or the session identifier for a previously established session. Invoking the operation may require that the user identified by those credentials has particular privileges on the operation or on one or more resource identifiers passed to the operation.

Examples:

  • The operation requires that the user have one or more privileges on the operation, but the user identified by the credentials in the security context does not have the required privileges.
  • The operation requires that the user have one or more privileges on a resource identifier passed to the operation, but the user identified by the credentials in the security context does not have the required privileges.

Counterexamples:

For security reasons, the vapi.std.errors.error.data field in this error is unset, and the vapi.std.errors.error.messages field in this error does not disclose why the user is not authorized to perform the operation. For example the messages would not disclose which privilege the user did not have or which resource identifier the user did not have the required privilege to access. The API documentation should indicate what privileges are required.

vapi.std.errors.unexpected_input The unexpected_input error indicates that the request contained a parameter or field whose name is not known by the server.

Every operation expects parameters with known names. Some of those parameters may be (or contain) structures, and the operation expects those structures to contain fields with known names. If the operation receives parameters or fields with names that is does not expect, this error may be reported.

This error can be reported by the API infrastructure for any operation, but it is specific to the API infrastructure, and should never be reported by the implementation of any operation.

Examples:

  • A client using stubs generated from the interface specification for version2 of a service invokes the operation passing one or more parameters that were added in version2, but they are communicating with a server that only supports version1 of the service.
  • A client provides an unexpected parameter or field name when invoking the operation using a dynamic interface (for example REST).
vapi.std.errors.unsupported The unsupported error indicates that the operation is not supported by the service.

Examples:

  • Trying to hot-plug a CPU when the current configuration of the VM does not support hot-plugging of CPUs.
  • Trying to change the memory size to a value that is not within the acceptable guest memory bounds supported by the virtual machine's host.
vapi.std.errors.unverified_peer The unverified_peer error indicates that an attempt to connect to an unknown or not-yet-trusted endpoint failed because the system was unable to verify the identity of the endpoint.

Typically the {vapi.std.errors.error.data field of this error will contain information that can be presented to a human to allow them to decide whether to trust the endpoint. If they decide to trust the endpoint, the request can be resubmitted with an indication that the endpoint should be trusted.

Examples:

  • The client provides an IP address or URL of an endpoint the system should communicate with using an SSL connection, but the endpoint's SSL certificate is self-signed, expired, or otherwise not trustworthy.
  • The client provides an IP address of a host the system should communicate with using ssh, but ssh doesn't recognize the public key of the host

. This structure was added in vSphere API 6.7.1.

vapi std interposition

The vapi.std.interposition API provides services that TODO.
Type Description
vapi.std.interposition.invocation_request Information about an interposed request for operation invocation. All interposers would receive an instance of this structure as an input parameter.
vapi.std.interposition.invocation_result Information about the result from an interposed operation invocation. All POST interposers will receive an instance of this structure.
vapi.std.interposition.security_principal VMODL equivalent of com.vmware.vapi.security.PrincipalId.

vcenter

The vcenter API provides services for managing VMware vSphere environments. The API is available starting in vSphere 6.5.

vcenter certificate management

The vcenter.certificate_management API provides services to manage certificates.
Type Description
vcenter.certificate_management.x509_cert_chain The x509_cert_chain structure contains x509 certificate chain. This structure was added in vSphere API 6.7.2.

vcenter certificate management vcenter

The vcenter.certificate_management.vcenter API provides services to manage certificates.

tls

The tls interface provides operations to replace Tls certificate. This service was added in vSphere API 6.7.2.
Type Description
vcenter.certificate_management.vcenter.tls.info The info structure contains information from a TLS certificate. This structure was added in vSphere API 6.7.2.
vcenter.certificate_management.vcenter.tls.replace_spec The replace_spec structure contains information to generate a Private Key , CSR and hence VMCA signed machine SSL. This structure was added in vSphere API 6.7.2.
vcenter.certificate_management.vcenter.tls.spec The spec structure contains information for a Certificate and Private Key. This structure was added in vSphere API 6.7.2.

tls csr

The tls_csr interface provides operations to generate certificate signing request. This service was added in vSphere API 6.7.2.
Type Description
vcenter.certificate_management.vcenter.tls_csr.info The info structure contains information for a Certificate signing request. This structure was added in vSphere API 6.7.2.
vcenter.certificate_management.vcenter.tls_csr.spec The spec structure contains information to generate a Private Key and CSR. This structure was added in vSphere API 6.7.2.

trusted root chains

The trusted_root_chains interface provides operations to create, modify, delete and read trusted root certificate chains. This service was added in vSphere API 6.7.2.
Type Description
vcenter.certificate_management.vcenter.trusted_root_chains.create_spec The create_spec structure contains information to create a trusted root certificate chain. This structure was added in vSphere API 6.7.2.
vcenter.certificate_management.vcenter.trusted_root_chains.info The info structure contains information for a trusted root certificate chain. This structure was added in vSphere API 6.7.2.
vcenter.certificate_management.vcenter.trusted_root_chains.summary The summary structure contains a trusted root certificate chain summary suitable for UI presentation. This structure was added in vSphere API 6.7.2.

vmca root

The vmca_root interface provides operations to replace VMware Certificate Authority (VMCA) root certificate. This service was added in vSphere API 6.9.1.
Type Description
vcenter.certificate_management.vcenter.vmca_root.create_spec The create_spec contains information. to generate a Private Key and CSR. This structure was added in vSphere API 6.9.1.

cluster

The cluster service provides operations to manage clusters in the vCenter Server.
Type Description
vcenter.cluster.filter_spec The filter_spec structure contains fields used to filter the results when listing clusters (see list). If multiple fields are specified, only clusters matching all of the fields match the filter.
vcenter.cluster.info The info structure contains information about a cluster in vCenter Server.
vcenter.cluster.summary The summary structure contains commonly used information about a cluster in vCenter Server.

vcenter compute

The vcenter.compute API provides services for managing compute policies in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.

vcenter compute policies

The vcenter.compute.policies API provides structures for managing compute policies in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.

policies

The policies service provides operations to manage compute policies in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. A compute policy defines the intended behavior for a collection of vSphere objects identified by a tag. A compute policy is an instance of a capability. It is created by providing a value for the creation type specified by the capability. See vcenter.compute.policies.capabilities.info.create_spec_type. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vcenter.compute.policies.create_spec The create_spec structure contains common information used to create a new policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.compute.policies.info The info structure contains common information about a compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.compute.policies.status The status structure describes the current status of a compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.compute.policies.summary The summary structure contains commonly used information about a compute policy. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter compute policies capabilities cluster scale in ignore vm capabilities

The vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities API provides structures for the Scale-In Ignore Virtual Machine Capabilities capability offered by vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
Type Description
vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities.create_spec The create_spec structure contains information used to create a new policy to ignore virtual machine capabilities when scaling-in a cluster, see create. When considering scaling-in a cluster, policies that have been created with one of the listed vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities.create_spec.vm_capabilities are ignored for virtual machines that have the tag indicated by vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities.create_spec.vm_tag in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities.info The info structure contains information about a policy to ignore virtual machine capabilities when scaling-in a cluster, see get. When considering scaling-in a cluster, policies that have been created with one of the listed vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities.info.vm_capabilities are ignored for virtual machines that have the tag indicated by vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities.info.vm_tag in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter compute policies capabilities disable drs vmotion

The vcenter.compute.policies.capabilities.disable_drs_vmotion API provides structures for the Disable DRS vMotion capability offered by vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
Type Description
vcenter.compute.policies.capabilities.disable_drs_vmotion.create_spec The create_spec structure contains information used to create a new DisableDrsVmotion policy, see create, in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.compute.policies.capabilities.disable_drs_vmotion.info The info structure contains information about a DisableDrsVmotion policy, see get in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter compute policies capabilities vm evacuation vmotion

The vcenter.compute.policies.capabilities.vm.evacuation.vmotion API provides structures for the virtual machine evacuation vMotion capability offered by vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
Type Description
vcenter.compute.policies.capabilities.vm.evacuation.vmotion.create_spec The create_spec structure contains information used to create a new vMotion policy that applies when a host is evacuated, see create, in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. All virtual machines that share the tag indicated by vcenter.compute.policies.capabilities.vm.evacuation.vmotion.create_spec.vm_tag will be vMotioned from a host whenever the host is evacuated by vCenter. If vCenter cannot migrate a virtual machine, then it will remain running on its current host. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.compute.policies.capabilities.vm.evacuation.vmotion.info The info structure contains information about a vMotion policy that applies when a host is evacuated, see get, in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. All virtual machines that share the tag indicated by vcenter.compute.policies.capabilities.vm.evacuation.vmotion.info.vm_tag will be vMotioned from a host whenever the host is evacuated by vCenter. If vCenter cannot migrate a virtual machine, then it will remain running on its current host. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter compute policies capabilities vm host affinity

The vcenter.compute.policies.capabilities.vm_host_affinity API provides structures for the VM Host affinity capability offered by vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
Type Description
vcenter.compute.policies.capabilities.vm_host_affinity.create_spec The create_spec structure contains information used to create a new virtual machine to host affinity policy, see create. Virtual machines that have the tag indicated by vcenter.compute.policies.capabilities.vm_host_affinity.create_spec.vm_tag will be affine to hosts that have the tag indicated by vcenter.compute.policies.capabilities.vm_host_affinity.create_spec.host_tag in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.compute.policies.capabilities.vm_host_affinity.info The info structure contains information about a virtual machine to host affinity policy, see get. Virtual machines that have the tag indicated by vcenter.compute.policies.capabilities.vm_host_affinity.info.vm_tag will be affine to hosts that have the tag indicated by vcenter.compute.policies.capabilities.vm_host_affinity.info.host_tag in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter compute policies capabilities vm host anti affinity

The vcenter.compute.policies.capabilities.vm_host_anti_affinity API provides structures for the VM Host anti-affinity capability offered by vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
Type Description
vcenter.compute.policies.capabilities.vm_host_anti_affinity.create_spec The create_spec structure contains information used to create a new virtual machine to host anti-affinity policy, see create. Virtual machines that have the tag indicated by vcenter.compute.policies.capabilities.vm_host_anti_affinity.create_spec.vm_tag will be anti-affine to hosts that have the tag indicated by vcenter.compute.policies.capabilities.vm_host_anti_affinity.create_spec.host_tag in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.compute.policies.capabilities.vm_host_anti_affinity.info The info structure contains information about a virtual machine to host anti-affinity policy, see get. Virtual machines that have the tag indicated by vcenter.compute.policies.capabilities.vm_host_anti_affinity.info.vm_tag will be anti-affine to hosts that have the tag indicated by vcenter.compute.policies.capabilities.vm_host_anti_affinity.info.host_tag in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter compute policies capabilities vm vm affinity

The vcenter.compute.policies.capabilities.vm_vm_affinity API provides structures for the VM-VM affinity capability offered by vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
Type Description
vcenter.compute.policies.capabilities.vm_vm_affinity.create_spec The create_spec structure contains information used to create a new VM-VM affinity policy, see create. All virtual machines that share the tag indicated by vcenter.compute.policies.capabilities.vm_vm_affinity.create_spec.vm_tag will be affined to each other in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.compute.policies.capabilities.vm_vm_affinity.info The info structure contains information about a VM-VM affinity policy, see get. All virtual machines that share the tag indicated by vcenter.compute.policies.capabilities.vm_vm_affinity.info.vm_tag are affined to each other in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter compute policies capabilities vm vm anti affinity

The vcenter.compute.policies.capabilities.vm_vm_anti_affinity API provides structures for the VM VM anti-affinity capability offered by vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.
Type Description
vcenter.compute.policies.capabilities.vm_vm_anti_affinity.create_spec The create_spec structure contains information used to create a new VM-VM anti-affinity policy, see create. All virtual machines that share the tag indicated by vcenter.compute.policies.capabilities.vm_vm_anti_affinity.create_spec.vm_tag will be anti-affine to each other in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.compute.policies.capabilities.vm_vm_anti_affinity.info The info structure contains information about a VM-VM anti-affinity policy, see get. All virtual machines that share the tag indicated by vcenter.compute.policies.capabilities.vm_vm_anti_affinity.info.vm_tag are anti-affine to each other in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

tag usage

The tag_usage service provides operations to query which tags are used by policies in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vcenter.compute.policies.tag_usage.filter_spec The filter_spec structure contains fields used to filter the results when listing the tags used by policies as available in this vCenter server (see list). If multiple fields are specified, only the tags used by policies that match an element of each field match the filter. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.compute.policies.tag_usage.summary The summary structure contains common information about a tag used by a policy. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter content registries

The vcenter.content.registries API provides structures and services for managing image registries in vCenter.

vcenter content registries harbor

The vcenter.content.registries.harbor API provides structures and services for managing Harbor registry in vCenter.

harbor

The harbor service provides operations to manage the lifecycle of an integrated Harbor container registry in vCenter.
Type Description
vcenter.content.registries.harbor.create_spec The create_spec structure contains the specification required to create a Harbor registry.
vcenter.content.registries.harbor.garbage_collection The garbage_collection structure contains garbage collection configuration for the Harbor registry.
vcenter.content.registries.harbor.info The info structure contains detailed information about a running Harbor registry.
vcenter.content.registries.harbor.storage_info The storage_info structure contains the detailed information about storage used by the Harbor registry.
vcenter.content.registries.harbor.storage_spec The storage_spec structure contains the specification required to configure storage associated with a Harbor registry. In this version, Harbor registry is created in Kubernetes environment, information in this structure will result in storage quotas on a Kubernetes namespace.
vcenter.content.registries.harbor.summary The summary structure contains basic information about a running Harbor registry.

projects

The projects service provides operations for managing the lifecycle of Harbor project that stores and distributes container repositories and images.
Type Description
vcenter.content.registries.harbor.projects.create_spec The create_spec structure defines the information required to create a Harbor project.
vcenter.content.registries.harbor.projects.info The info structure contains detailed information about a Harbor project.
vcenter.content.registries.harbor.projects.summary The summary structure contains basic information about a Harbor project.

health

The health service provides operations to retrieve health status for a container registry.
Type Description
vcenter.content.registries.health.info The info structure contains health information about a container registry.

datacenter

The datacenter service provides operations to manage datacenters in the vCenter Server.
Type Description
vcenter.datacenter.create_spec The create_spec structure defines the information used to create a datacenter.
vcenter.datacenter.filter_spec The filter_spec structure contains fields used to filter the results when listing datacenters (see list). If multiple fields are specified, only datacenters matching all of the fields match the filter.
vcenter.datacenter.info The info structure contains information about a datacenter in vCenter Server.
vcenter.datacenter.summary The summary structure contains commonly used information about a datacenter in vCenter Server.

datastore

The Datastore service provides operations for manipulating a datastore.
Type Description
vcenter.datastore.filter_spec The filter_spec structure contains fields used to filter the results when listing datastores (see list). If multiple fields are specified, only datastores matching all of the fields match the filter.
vcenter.datastore.info The info structure contains information about a datastore.
vcenter.datastore.summary The summary structure contains commonly used information about a datastore.

vcenter deployment

deployment

The deployment service provides operations to get the status of the vCenter appliance deployment. This service was added in vSphere API 6.7.
Type Description
vcenter.deployment.check_info The check_info structure describes the result of the appliance deployment check. This structure was added in vSphere API 6.7.
vcenter.deployment.data_migration_estimate The data_migration_estimate {structure contains estimated time and disk space required for the vCenter Server database migration. This structure was added in vSphere API 7.0.0.
vcenter.deployment.data_migration_info The data_migration_info {structure contains the disk space requirements and time estimates for the different choices available to migrate the vCenter Server data. This structure was added in vSphere API 7.0.0.
vcenter.deployment.history_migration_spec The history_migration_spec enumerated type defines how vCenter history data will be migrated. vCenter History data includes
  • Statistics
  • Events
  • Tasks
. This structure was added in vSphere API 6.7.
vcenter.deployment.info The info structure contains fields to describe the state of the appliance. This structure was added in vSphere API 6.7.
vcenter.deployment.location_spec The location_spec structure is used to pass the container ESXi or vCenter server of the VM to patch the size of this appliance. This structure was added in vSphere API 6.7.
vcenter.deployment.notification The notification structure contains fields to describe any info/warning/error messages that Tasks can raise. This structure was added in vSphere API 6.7.
vcenter.deployment.notifications The notifications structure contains info/warning/error messages that can be reported be the task. This structure was added in vSphere API 6.7.
vcenter.deployment.remote_psc_spec The remote_psc_spec structure contains information used to configure an external vCenter Server that registers with a remote PSC. This structure was added in vSphere API 6.7.
vcenter.deployment.replicated_psc_spec The replicated_psc_spec structure contains information used to check if the configuring PSC can be replicated to the remote PSC. This structure was added in vSphere API 6.7.
vcenter.deployment.replicated_spec The replicated_spec structure contains information used to check if the configuring vCenter Server can be replicated to the remote PSC. This structure was added in vSphere API 6.7.
vcenter.deployment.source_info The source_info {structure contains the information about the source vCenter Server and the database migration options. This structure was added in vSphere API 7.0.0.
vcenter.deployment.standalone_psc_spec The standalone_psc_spec structure contains information used to configure a standalone PSC appliance. This structure was added in vSphere API 6.7.
vcenter.deployment.standalone_spec The standalone_spec structure contains information used to configure a standalone embedded vCenter Server appliance. This structure was added in vSphere API 6.7.
vcenter.deployment.task The task structure contains fields to describe a particular deployment task. This structure was added in vSphere API 6.7.

import history

The import_history service provides operations for managing the import of vCenter historical data, e.g. Tasks, Events and Statistics, when is is imported separately from the upgrade or migration process. This service was added in vSphere API 6.7.
Type Description
vcenter.deployment.import_history.create_spec The create_spec structure contains information to create and start vCenter historical data lazy-import. This structure was added in vSphere API 6.7.
vcenter.deployment.import_history.info The info structure contains fields to describe the state of vCenter history import task. This structure was added in vSphere API 6.7.

vcenter deployment install initial config remote psc

thumbprint

The thumbprint service provides operations to get the thumbprint of the remote PSC. This service was added in vSphere API 6.7.
Type Description
vcenter.deployment.install.initial_config.remote_psc.thumbprint.remote_spec The remote_spec structure contains the information used to connect to the remote PSC. This structure was added in vSphere API 6.7.

vcenter deployment migrate

migrate

The migrate service provides operations to configure the migration of this appliance from an existing vCenter for Windows. This service was added in vSphere API 7.0.0.
Type Description
vcenter.deployment.migrate.active_directory_spec The active_directory_spec structure contains information used to join the migrated vCenter Server appliance to the Active Directory. This structure was added in vSphere API 7.0.0.
vcenter.deployment.migrate.migrate_spec The migrate_spec structure contains the fields to migrate an existing vCenter Server for Windows to an appliance. This structure was added in vSphere API 7.0.0.
vcenter.deployment.migrate.migration_assistant_spec The migration_assistant_spec structure contains the information needed to connect to the Migration Assistant that is running on the source windows vCenter Server machine. This structure was added in vSphere API 7.0.0.
vcenter.deployment.migrate.psc_spec The psc_spec structure contains information used to migrate a windows Platform Service Controller to Platform Service Controller appliance. This structure was added in vSphere API 7.0.0.
vcenter.deployment.migrate.source_vc_windows The source_vc_windows structure contains information about the windows vCenter Server that is going to be migrated. This structure was added in vSphere API 7.0.0.
vcenter.deployment.migrate.vcsa_embedded_spec The vcsa_embedded_spec structure contains information used to migrate an embedded vCenter Server for Windows to embedded vCenter Server appliance. This structure was added in vSphere API 7.0.0.

active directory

The active_directory service provides operations to check if the migrated vCenter Server appliance can join to the given domain using the provided credentials. This service was added in vSphere API 7.0.0.
Type Description
vcenter.deployment.migrate.active_directory.check_spec The check_spec structure contains information used to join the migrated vCenter Server appliance to the Active Directory. This structure was added in vSphere API 7.0.0.

question

The question service provides operations to get the question raised during deployment and to answer them. This service was added in vSphere API 6.7.
Type Description
vcenter.deployment.question.answer_spec The answer_spec structure contains fields to describe the answer to a raised question. This structure was added in vSphere API 6.7.
vcenter.deployment.question.info The info structure contains fields to describe questions raised during the deployment process. This structure was added in vSphere API 6.7.
vcenter.deployment.question.question The question structure contains fields to describe a deployment question. This structure was added in vSphere API 6.7.

upgrade

The upgrade service provides operations to configure the upgrade of this appliance from an existing vCenter appliance. This service was added in vSphere API 6.7.
Type Description
vcenter.deployment.upgrade.psc_spec The psc_spec structure contains information used to upgrade a Platform Service Controller appliance. This structure was added in vSphere API 6.7.
vcenter.deployment.upgrade.source_appliance_spec The source_appliance_spec structure contains information used to connect to the appliance used as the source for an upgrade. This structure was added in vSphere API 6.7.
vcenter.deployment.upgrade.upgrade_spec The upgrade_spec structure contains information used to configure the appliance upgrade. This structure was added in vSphere API 6.7.
vcenter.deployment.upgrade.vcsa_embedded_spec The vcsa_embedded_spec structure contains information used to upgrade a Embedded vCenter Server appliance. This structure was added in vSphere API 6.7.

folder

The Folder service provides operations for manipulating a vCenter Server folder.
Type Description
vcenter.folder.filter_spec The filter_spec structure contains fields used to filter the results when listing folders (see list). If multiple fields are specified, only folders matching all of the fields match the filter.
vcenter.folder.summary The summary structure contains commonly used information about a folder.

vcenter guest

The vcenter.guest API provides services for managing guest customization specifications in the vCenter Server.
Type Description
vcenter.guest.adapter_mapping The adapter_mapping structure specifies the association between a virtual network adapter and its IP settings. This structure was added in vSphere API 7.0.0.
vcenter.guest.configuration_spec The configuration_spec structure specifies the settings for customizing a guest operating system. This structure was added in vSphere API 7.0.0.
vcenter.guest.customization_spec The customization_spec structure contains information required to customize a virtual machine when deploying it or migrating it to a new host. This structure was added in vSphere API 7.0.0.
vcenter.guest.domain The domain structure specifies the information needed to join a workgroup or domain. This structure maps to the Identification key in the sysprep.xml answer file. These values are transferred into the sysprep.xml file that VirtualCenter stores on the target virtual disk. For more information about performing unattended installation, check https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx. This structure was added in vSphere API 7.0.0.
vcenter.guest.global_DNS_settings The global_DNS_settings structure specifies a collection of global IP settings in the guest operating system. In Linux, DNS server settings are global. The settings can either be statically set or supplied by a DHCP server. This structure was added in vSphere API 7.0.0.
vcenter.guest.gui_unattended The gui_unattended structure maps to the GuiUnattended key in the sysprep.xml answer file. These values are plugged directly into the sysprep.xml file that VirtualCenter stores on the target virtual disk. For more detailed information about performing unattended installations, check https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx. This structure was added in vSphere API 7.0.0.
vcenter.guest.hostname_generator The hostname_generator structure specifies various mechanisms of generating the hostname for the guest inside the virtual machine while customization. This structure was added in vSphere API 7.0.0.
vcenter.guest.IP_settings The IP_settings structure specifies the IP settings for a virtual network adapter. This structure was added in vSphere API 7.0.0.
vcenter.guest.ipv4 The ipv4 structure specifies the IPv4 settings that need to be applied to a virtual network adapter. This structure was added in vSphere API 7.0.0.
vcenter.guest.ipv6 The ipv6 structure specifies the IPv6 settings that need to be applied to a virtual network adapter. This structure was added in vSphere API 7.0.0.
vcenter.guest.ipv6_address The ipv6_address structure specifies the the settings for a Static IPv6 configuration. This structure was added in vSphere API 7.0.0.
vcenter.guest.linux_configuration Guest customization Settings to customize a Linux guest operating system.

The linux_configuration structure contains settings that identify a Linux machine in the same way that the vcenter.guest.windows_configuration structure identifies a Windows machine.

. This structure was added in vSphere API 7.0.0.
vcenter.guest.user_data The user_data structure specifies the personal data pertaining to the user of the Windows guest operating system. This structure maps to the UserData key in the sysprep.xml answer file. These values are transferred directly into the sysprep.xml file that VirtualCenter stores on the target virtual disk. For more detailed information about performing unattended installation, check https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx. This structure was added in vSphere API 7.0.0.
vcenter.guest.windows_configuration The windows_configuration structure specifies the settings for customizing a windows guest operating system. This structure was added in vSphere API 7.0.0.
vcenter.guest.windows_network_adapter_settings The windows_network_adapter_settings structure specifies Windows specific Network settings for a virtual network adapter. This structure was added in vSphere API 7.0.0.
vcenter.guest.windows_sysprep The windows_sysprep structure provides all the settings like user details, administrator details, etc that need to applied for a windows guest operating system during customization. This structure was added in vSphere API 7.0.0.

customization specs

The customization_specs service provides operations to manage guest customization specifications in the vCenter Server. This service was added in vSphere API 6.7.1.
Type Description
vcenter.guest.customization_specs.create_spec The create_spec structure contains specification information and specification object that can be passed to the create operation. This structure was added in vSphere API 7.0.0.
vcenter.guest.customization_specs.filter_spec The filter_spec structure contains fields used to filter the results when listing guest customization specifications (see list). If multiple fields are specified, only guest customization specifications matching all of the fields match the filter. This structure was added in vSphere API 6.7.1.
vcenter.guest.customization_specs.info The info structure describes a guest customization specification and the timestamp when it was last modified. This is returned by the get operation. This structure was added in vSphere API 7.0.0.
vcenter.guest.customization_specs.metadata The metadata structure contains metadata i.e. name and description related to a customization specification. This structure was added in vSphere API 7.0.0.
vcenter.guest.customization_specs.spec The spec structure contains the specification information and specification object. This is passed to the set operation. This structure was added in vSphere API 7.0.0.
vcenter.guest.customization_specs.summary The summary structure contains commonly used information about a guest customization specification. This structure was added in vSphere API 6.7.1.

host

The host service provides operations to manage hosts in the vCenter Server.
Type Description
vcenter.host.create_spec The create_spec structure defines the information used to create a host.
vcenter.host.filter_spec The filter_spec structure contains fields used to filter the results when listing hosts (see list). If multiple fields are specified, only hosts matching all of the fields match the filter.
vcenter.host.summary The summary structure contains commonly used information about a host in vCenter Server.

vcenter hvc

The vcenter.hvc API provides services to manage hybrid links between a local and remote Platform Service Controller. Usage beyond VMware Cloud on AWS is not supported.

vcenter hvc links

The links service provides operations to create, delete, get information, and list hybrid links between the local and foreign Platform Service Controller (PSC). Usage beyond VMware Cloud on AWS is not supported. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vcenter.hvc.links.certificate_info The certificate_info structure contains information about the SSL certificate for a destination PSC endpoint. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.hvc.links.create_spec The create_spec structure is the specification used for the hybrid link creation. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.hvc.links.credentials The credentials service specifies user credentials to make a successful connection to remote endpoint. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.hvc.links.summary The summary structure contains information about the hybrid link. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter hvc links sync

sync

The sync service provides operations to create a sync session, get information on Sync. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vcenter.hvc.links.sync.credentials The credentials service specifies user credentials to make a successful connection to remote endpoint. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

providers

The providers service provides operations to create a sync session, get information on Sync. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vcenter.hvc.links.sync.providers.credentials The credentials service specifies user credentials to make a successful connection to remote endpoint. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.hvc.links.sync.providers.info The info structure contains information about sync for a provider. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.hvc.links.sync.providers.session_info The session_info structure contains sync session information. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.hvc.links.sync.providers.summary The summary structure contains information about a provider. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter identity

The vcenter.identity API provides services to manage VcIdentity.

providers

The providers interface provides operations to list, read and modify vCenter Server identity providers. This service was added in vSphere API 7.0.0.
Type Description
vcenter.identity.providers.active_directory_over_ldap The active_directory_over_ldap structure contains the information about to how to use an Active Directory over LDAP connection to allow searching for users and groups if the identity provider is an On-Prem service. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.create_spec The create_spec structure contains the information used to create an identity provider. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.info The info structure contains the information about an identity provider. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.oauth2_create_spec The oauth2_create_spec structure contains the information used to create an OAuth2 identity provider. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.oauth2_info The oauth2_info structure contains the information about an OAuth2 identity provider. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.oauth2_summary The oauth2_summary structure contains commonly used information about an OAuth2 identity provider. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.oauth2_update_spec The oauth2_update_spec structure contains the information used to update the OAuth2 identity provider. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.oidc_create_spec The oidc_create_spec structure contains the information used to create an OIDC identity provider. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.oidc_info The oidc_info structure contains information about an OIDC identity provider. OIDC is a discovery protocol for OAuth2 configuration metadata, so oidc_info contains additional discovered OAuth2 metadata. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.oidc_summary The oidc_summary structure contains commonly used information about an OIDC identity provider. OIDC is a discovery protocol for OAuth2 configuration metadata, so oidc_summary contains discovered OAuth2 metadata. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.oidc_update_spec The oidc_update_spec structure contains the information used to update the OIDC identity provider. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.summary The summary structure contains commonly used information about an identity provider. This structure was added in vSphere API 7.0.0.
vcenter.identity.providers.update_spec The update_spec structure contains the information used to update the identity provider. This structure was added in vSphere API 7.0.0.

vcenter inventory

The vcenter.inventory component provides operations and structures for retrieving vCenter datastore and network information for a given array of identifiers.

datastore

The datastore service provides operations to retrieve information about datastores.
Type Description
vcenter.inventory.datastore.info The info structure contains information about a datastore.

network

The network service provides operations to retrieve information about vCenter Server networks.
Type Description
vcenter.inventory.network.info The info structure contains information about a vCenter Server network.

vcenter lcm

The vcenter.lcm API provides services for managing the vCenter Server lifecycle.
Type Description
vcenter.lcm.notification The notification structure describes a notification that can be reported by the appliance task, which can be of type info, warning or errors.
vcenter.lcm.notifications The notifications structure contains info/warning/error messages that can be reported be the appliance task.

vcenter lcm discovery

The vcenter.lcm.discovery API provides services for discovering products registered with vCenter Server and interoperability between those products and vCenter Server.
Type Description
vcenter.lcm.discovery.product The Info structure contains information about a VMware product which is present in the customer Environemnt. The following information about the products are present:
  • Name
  • Version
  • Deployments
  • Automatically Discovered or Manually Added

associated products

The associated_products service provides options to list, add, modify, and delete VMware products associated with vCenter Server. Some products can be auto-detected by the system while others can be added manually.
Type Description
vcenter.lcm.discovery.associated_products.create_spec The create_spec structure is the specification used for the product creation.
vcenter.lcm.discovery.associated_products.update_spec The update_spec structure is the specification for the product update.

interop report

The interop_report interface provides operations to report the interoperability between a vCenter Server release version and the other installed VMware products registered in the vCenter Server instance.
Type Description
vcenter.lcm.discovery.interop_report.release_info The release_info structure contains a product release information.
vcenter.lcm.discovery.interop_report.report The report structure contains the interoperability report between the target product and the other registered products in the vCenter Server instance.
vcenter.lcm.discovery.interop_report.report_row The report_row structure contains the interoperability between a given product and the target product.
vcenter.lcm.discovery.interop_report.report_summary The report_summary structure contains a summary of the vcenter.lcm.discovery.interop_report.report.products. It consists of the count of compatible and incompatible products to the target product.
vcenter.lcm.discovery.interop_report.result The result structure contains the result of interoperability report creation operation.
vcenter.lcm.discovery.interop_report.spec Configuration of report generation.

product catalog

The product_catalog service provides information which VMware products can be associated with vCenter Server.
Type Description
vcenter.lcm.discovery.product_catalog.summary The summary structure contains information about each VMware product and its corresponding versions that can be associated with vCenter Server.

reports

The Report service provides an operation to download the report generated by the interop and precheck operations. To download a report, you must use the get operation. A Report.Location structure represents the location of the file which has Report.Token structure which represents the token ID (@name String) and the expiration time of the token Report.Token.expiry DateTime. Report.Location structure also has the URI for the file which needs to be downloaded.
Type Description
vcenter.lcm.reports.location The location structure contains the URI location to download the report from, as well as a token required (as a header on the HTTP request) to get the bundle. The validity of the token is 5 minutes as best attempt. After the token expires, any attempt to call the URI with said token will fail.
vcenter.lcm.reports.token The token structure contains information about the token required in the HTTP GET request to generate the report.

vcenter lcm update

The vcenter.lcm.update API provides services for updating vCenter Server to a newer version.

pending

The pending service provides operation for listing pending minor or major updates of vCenter Server.
Type Description
vcenter.lcm.update.pending.info The info structure contains detailed information about the vCenter patch/update.
vcenter.lcm.update.pending.list_result The list_result structure contains information about the pending patch/updates for the given vCenter server.
vcenter.lcm.update.pending.summary The summary structure contains basic information about the vCenter patch/update/upgrade

precheck report

The precheck_report service generates precheck report for a vCenter Server instance against a target update version.
Type Description
vcenter.lcm.update.precheck_report.report The report structure contains estimates of how long it will take an update as well as a list of possible warnings and errors with applying the update.
vcenter.lcm.update.precheck_report.report_summary The Summary Structure contains the summary of precheck report.
vcenter.lcm.update.precheck_report.result The result structure contains the precheck report and a link to download the CSV report.

vcenter namespace management

The vcenter.namespace_management API provides services for managing Namespaces.
Type Description
vcenter.namespace_management.ipv4_cidr The ipv4_cidr structure contains the specification for representing CIDR notation of IP range. For example, this can be used to represent 256 IP addresses using 10.10.10.0/24.

cluster available versions

The {@name cluster-available-versions} service provides operations to retrieve available upgrade versions of WCP and detailed information about each upgrade.
Type Description
vcenter.namespace_management.cluster_available_versions.summary The summary structure contains the information about each available upgrade version.

cluster compatibility

The cluster_compatibility service provides operations to get Namespace-related compatibility information for clusters in this vCenter.
Type Description
vcenter.namespace_management.cluster_compatibility.filter_spec The filter_spec structure contains fields used to filter the results when listing clusters (see list) and their compatibility information.
vcenter.namespace_management.cluster_compatibility.summary The summary structure contains the information about the compatibility of a cluster.

cluster size info

The {@name cluster-size-info} service provides operations to retrieve various sizes available for enabling Namespaces and information about each size.
Type Description
vcenter.namespace_management.cluster_size_info.info The info structure contains the information about limits associated with a sizing_hint.
vcenter.namespace_management.cluster_size_info.vm_info The vm_info structure contains the information about the configuration of the virtual machines which would be created for Namespaces.

clusters

The clusters service provides operations to enable and disable vSphere Namespaces on a vSphere cluster.
Type Description
vcenter.namespace_management.clusters.enable_spec The enable_spec structure contains the specification required to enable vSphere Namespaces on a cluster.
vcenter.namespace_management.clusters.image_registry The image_registry structure contains the specification required to configure container image registry endpoint.
vcenter.namespace_management.clusters.image_storage_spec The image_storage_spec structure contains the specification required to configure storage used for container images.
vcenter.namespace_management.clusters.info The info structure contains detailed information about the cluster statistics and status related to vSphere Namespaces.
vcenter.namespace_management.clusters.ipv4_range The ipv4_range contains specification to configure multiple interfaces in IPv4. The range of IPv4 addresses is derived by incrementing the startingAddress to the specified addressCount. To use the object for a single IPv4 address specification, set addressCount to 1.
vcenter.namespace_management.clusters.message The message structure contains the information about the object configuration.
vcenter.namespace_management.clusters.NCP_cluster_network_enable_spec The NCP_cluster_network_enable_spec structure encapsulates the NSX Container Plugin-specific cluster networking configuration parameters for the vSphere Namespaces Cluster Enable operation.
vcenter.namespace_management.clusters.NCP_cluster_network_info The NCP_cluster_network_info structure contains the NSX Container Plugin-specific cluster networking configuration.
vcenter.namespace_management.clusters.NCP_cluster_network_set_spec The NCP_cluster_network_set_spec structure encapsulates the NSX Container Plugin-specific cluster networking configuration parameters for the vSphere Namespaces Cluster Set operation.
vcenter.namespace_management.clusters.NCP_cluster_network_update_spec The NCP_cluster_network_update_spec structure encapsulates the NSX Container Plugin-specific cluster networking configuration parameters for the vSphere Namespaces Cluster Update operation.
vcenter.namespace_management.clusters.network_spec The network_spec contains information related to network configuration for one or more interfaces.
vcenter.namespace_management.clusters.set_spec The set_spec structure contains the specification required to set a new configuration on the Cluster. This structure is applied in entirety, replacing the current specification fully.
vcenter.namespace_management.clusters.stats The stats structure contains the basic runtime statistics about a vSphere Namespaces-enabled cluster.
vcenter.namespace_management.clusters.summary The summary structure contains the basic information about the cluster statistics and status related to vSphere Namespaces.
vcenter.namespace_management.clusters.update_spec The update_spec structure contains the specification required to update the configuration on the Cluster. This structure is applied partially, and only the specified fields will replace or modify their existing counterparts.

distributed switch compatibility

The distributed_switch_compatibility service provides operations to get Namespaces compatibility information of Distributed Switches in this vCenter.
Type Description
vcenter.namespace_management.distributed_switch_compatibility.filter_spec The filter_spec structure contains fields used to filter the results when listing Distributed Switches (see list) and their compatibility information.
vcenter.namespace_management.distributed_switch_compatibility.summary The summary structure contains information about the compatibility of a vSphere Distributed Switch with the Namespaces feature.

edge cluster compatibility

The edge_cluster_compatibility service provides operations to get Namespaces compatibility information of NSX Edge Clusters.
Type Description
vcenter.namespace_management.edge_cluster_compatibility.filter_spec The filter_spec structure contains fields used to filter the results when listing Edge Clusters (see list) and their compatibility information.
vcenter.namespace_management.edge_cluster_compatibility.summary The summary structure contains information about an NSX-T Edge Cluster, including its compatibility with the vCenter Namespaces feature.

hosts config

The Compatibility service provides operations to retrieve information about vSphere Namespaces support and licensing.
Type Description
vcenter.namespace_management.hosts_config.info The Compatibility structure contains information about vSphere Namespaces support and licensing.

namespace resource options

The namespace_resource_options service provides operations to get the objects used to create and modify resource quotas on a namespace.
Type Description
vcenter.namespace_management.namespace_resource_options.info The info structure contains the information about the objects used to set and update resource quota keys on a namespace.

vcenter namespace management software

The vcenter.namespace_management.software API provides services for managing namespaces software components.

clusters

The clusters service provides operations to upgrade the vSphere clusters.
Type Description
vcenter.namespace_management.software.clusters.info The info structure contains detailed information about the cluster upgrade status and related information.
vcenter.namespace_management.software.clusters.message The message structure contains the information about the object configuration.
vcenter.namespace_management.software.clusters.result The result structure contains the result of batch upgrade method.
vcenter.namespace_management.software.clusters.summary The summary structure contains basic information about the cluster upgrade related information.
vcenter.namespace_management.software.clusters.upgrade_progress The upgrade_progress structure contains detailed information about the cluster upgrade progess.
vcenter.namespace_management.software.clusters.upgrade_spec The upgrade_spec structure contains the specification required to upgrade a cluster.
vcenter.namespace_management.software.clusters.upgrade_status The upgrade_status structure contains detailed information about the cluster when upgraded is in progress.

vcenter namespace management stats

The vcenter.namespace_management.stats API provides services for gathering statistics related to various Namespaces related components.

time series

The time_series service provides operations to gather statistical values for clusters, namespaces and pods.
Type Description
vcenter.namespace_management.stats.time_series.pod_identifier Pod identifier. These are the fields required to uniquely identify a pod.
vcenter.namespace_management.stats.time_series.spec This structure is sent in a request for TimeSeries data and is used to specify what object stats should be returned for.
vcenter.namespace_management.stats.time_series.time_series A set of timestamps and statistical values representing a time series. The lengths of vcenter.namespace_management.stats.time_series.time_series.time_stamps and vcenter.namespace_management.stats.time_series.time_series.values will always match each other.

support bundle

The support_bundle service provides operations to retrieve the cluster's Namespaces-related support bundle download location.
Type Description
vcenter.namespace_management.support_bundle.location The location structure contains the URI location to download the per-cluster support bundle from, as well as a token required (as a header on the HTTP request) to get the bundle. The validity of the token is 5 minutes. After the token expires, any attempt to call the URI with said token will fail.
vcenter.namespace_management.support_bundle.token The token structure contains information about the token required in the HTTP GET request to generate the support bundle.

vcenter namespaces

The vcenter.namespaces API provides services for managing namespaces related operations.
Type Description
vcenter.namespaces.container A container holds the data that describes a container within a pod. Note: This structure is restricted for VMware internal use only.
vcenter.namespaces.endpoint_address An endpoint_address contains the data that describes an Endpoint's address in Kubernetes. Note: This structure is restricted for VMware internal use only.
vcenter.namespaces.ingress_rule_value An ingress_rule_value contains the data that describes an Ingress rule in Kubernetes. Note: This structure is restricted for VMware internal use only.
vcenter.namespaces.resource_quota_options_v1 The resource_quota_options_v1 structure represents the resource quota limits which can be applied on the namespace. Refer to for information related to the properties of this object and what they map to.
vcenter.namespaces.resource_quota_options_v1_update The resource_quota_options_v1_update structure represents the changes to resource quota limits which are set on the namespace. Refer to <\a> Kubernetes Resource Quota for information related to the properties of this object and what they map to.

access

The access service provides operations to manage access control of subjects on namespaces.
Type Description
vcenter.namespaces.access.create_spec The create_spec structure contains the specification required to create access control on the namespace.
vcenter.namespaces.access.info The info structure contains the information about the access control of the subject on given domain on the namespace.
vcenter.namespaces.access.set_spec The set_spec structure contains the specification required to set new access control on the namespace.

instances

The instances service provides operations to create and delete a namespace object. In this version, an Instance is an abstraction around a Kubernetes namespace.
Type Description
vcenter.namespaces.instances.access The access structure contains the access control information for a subject on a namespace.
vcenter.namespaces.instances.create_spec The create_spec structure contains the specification required to set up a namespace.
vcenter.namespaces.instances.info The info structure contains detailed information about the namespace.
vcenter.namespaces.instances.message The message structure contains the information about the object configuration.
vcenter.namespaces.instances.set_spec The set_spec structure contains the specification required to set a new configuration on the namespace. This structure is applied in entirety, replacing the current specification fully.
vcenter.namespaces.instances.stats The stats structure contains the basic runtime statistics about the namespace.
vcenter.namespaces.instances.storage_spec The storage_spec structure contains the specification required to configure storage associated with a namespace. Information in this structure will result in storage quotas on the Kubernetes namespace.
vcenter.namespaces.instances.summary The summary structure contains basic information about the namespace.
vcenter.namespaces.instances.update_spec The update_spec structure contains the specification required to update the configuration on the namespace. This structure is applied partially, and only the specified fields will replace or modify their existing counterparts.

vcenter namespaces user

The vcenter.namespaces.user API provides services to access namespaces for non-administrative users.

instances

The instances service provides operations to access namespaces for non-administrative users.
Type Description
vcenter.namespaces.user.instances.summary The summary structure contains information about a namespace that user is authorized to access.

network

The Network service provides operations for manipulating a vCenter Server network.
Type Description
vcenter.network.filter_spec The filter_spec structure contains fields used to filter the results when listing networks (see list). If multiple fields are specified, only networks matching all of the fields match the filter.
vcenter.network.summary The summary structure contains commonly used information about a network.

vcenter ovf

The vcenter.ovf API provides services to capture and deploy Open Virtualization Format (OVF) packages to and from the content library.

It provides the ability to deploy OVF packages from the content library with support for advanced network topologies, network services, creating virtual appliances and virtual machines in hosts, resource pools or clusters. It also provides the ability to export virtual appliances and virtual machines from hosts, resource pools or clusters as OVF packages to the content library.

Type Description
vcenter.ovf.certificate_params The certificate_params structure contains information about the public key certificate used to sign the OVF package. This structure will only be returned if the OVF package is signed.

See deploy and filter.

vcenter.ovf.deployment_option The deployment_option structure contains the information about a deployment option as defined in the OVF specification.

This corresponds to the ovf:Configuration element of the ovf:DeploymentOptionSection in the specification. The ovf:DeploymentOptionSection specifies a discrete set of intended resource allocation configurations. This structure represents one item from that set.

See deploy and filter.

vcenter.ovf.deployment_option_params The deployment_option_params structure describes the possible deployment options as well as the choice provided by the user.

This information based on the ovf:DeploymentOptionSection.

See deploy and filter.

vcenter.ovf.extra_config The extra_config structure contains the information about a vmw:ExtraConfig element which can be used to specify configuration settings that are transferred directly to the .vmx file. The behavior of the vmw:ExtraConfig element is similar to the extraConfig property of the VirtualMachineConfigSpec object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the VirtualMachineConfigSpec object. See the VMware vSphere API reference for details on this.

vmw:ExtraConfig elements may occur as direct child elements of a VirtualHardwareSection, or as child elements of individual virtual hardware items.

See deploy and filter.

vcenter.ovf.extra_config_params The extra_config_params structure contains the parameters with information about the vmw:ExtraConfig elements in an OVF package.

vmw:ExtraConfig elements can be used to specify configuration settings that are transferred directly to the .vmx file.

The behavior of the vmw:ExtraConfig element is similar to the extraConfig property of the VirtualMachineConfigSpec object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the VirtualMachineConfigSpec object. See the VMware vSphere API reference for details on this.

See deploy and filter.

vcenter.ovf.ip_allocation_params The ip_allocation_params structure specifies how IP addresses are allocated to OVF properties. In particular, it informs the deployment platform whether the guest supports IPv4, IPv6, or both. It also specifies whether the IP addresses can be obtained through DHCP or through the properties provided in the OVF environment.

Ovf Property elements are exposed to the guest software through the OVF environment. Each Property element exposed in the OVF environment shall be constructed from the value of the ovf:key attribute. A Property element contains a key/value pair, it may optionally specify type qualifiers using the ovf:qualifiers attribute with multiple qualifiers separated by commas.

The settings in ip_allocation_params structure are global to a deployment. Thus, if a virtual machine is part of a virtual appliance, then its settings are ignored and the settings for the virtual appliance is used.

This information is based on the vmw:IpAssignmentSection in OVF package.

See deploy and filter.

vcenter.ovf.ovf_error The ovf_error structure describes an error related to accessing, validating, deploying, or exporting an OVF package.
vcenter.ovf.ovf_info The ovf_info structure contains informational messages related to accessing, validating, deploying, or exporting an OVF package.
vcenter.ovf.ovf_message The ovf_message structure describes a base OVF handling error message related to accessing, validating, deploying, or exporting an OVF package.

These messages fall into different categories defined in vcenter.ovf.ovf_message.category:

vcenter.ovf.ovf_params The ovf_params structure defines the common fields for all OVF deployment parameters. OVF parameters serve several purposes:
  • Describe information about a given OVF package.
  • Describe default deployment configuration.
  • Describe possible deployment values based on the deployment environment.
  • Provide deployment-specific configuration.
Each OVF parameters structure specifies a particular configurable aspect of OVF deployment. An aspect has both a query-model and a deploy-model. The query-model is used when the OVF package is queried, and the deploy-model is used when deploying an OVF package.

Most OVF parameter structures provide both informational and deployment parameters. However, some are purely informational (for example, download size) and some are purely deployment parameters (for example, the flag to indicate whether registration as a vCenter extension is accepted).

See deploy and filter.

vcenter.ovf.ovf_warning The ovf_warning structure describes a warning related to accessing, validating, deploying, or exporting an OVF package.
vcenter.ovf.parse_issue The parse_issue structure contains the information about the issue found when parsing an OVF package during deployment or exporting an OVF package including:
  • Parsing and validation error on OVF descriptor (which is an XML document), manifest and certificate files.
  • OVF descriptor generating and device error.
  • Unexpected server error.
vcenter.ovf.property The property structure contains the information about a property in an OVF package.

A property is uniquely identified by its [classid.]id[.instanceid] fully-qualified name (see vcenter.ovf.property.class_id, vcenter.ovf.property.id, and vcenter.ovf.property.instance_id). If multiple properties in an OVF package have the same fully-qualified name, then the property is excluded and cannot be set. We do warn about this during import.

See deploy and filter.

vcenter.ovf.property_params The property_params structure contains a array of OVF properties that can be configured when the OVF package is deployed.

This is based on the ovf:ProductSection.

See deploy and filter.

vcenter.ovf.scale_out_group The scale_out_group structure contains information about a scale-out group.

It allows a virtual system collection to contain a set of children that are homogeneous with respect to a prototypical virtual system or virtual system collection. It shall cause the deployment function to replicate the prototype a number of times, thus allowing the number of instantiated virtual systems to be configured dynamically at deployment time.

This is based on the ovf2:ScaleOutSection.

See deploy and filter.

vcenter.ovf.scale_out_params The scale_out_params structure contains information about the scale-out groups described in the OVF package.

When deploying an OVF package, a deployment specific instance count can be specified (see vcenter.ovf.scale_out_group.instance_count.

This is based on the ovf2:ScaleOutSection.

See deploy and filter.

vcenter.ovf.size_params The size_params structure contains estimates of the download and deployment sizes.

This information is based on the file references and the ovf:DiskSection in the OVF descriptor.

See deploy and filter.

vcenter.ovf.unknown_section The unknown_section structure contains information about an unknown section in an OVF package.
vcenter.ovf.unknown_section_params The unknown_section_params structure contains a array of unknown, non-required sections.

See deploy and filter.

vcenter.ovf.vcenter_extension_params The vcenter_extension_params structure specifies that the OVF package should be registered as a vCenter extension. The virtual machine or virtual appliance will gain unrestricted access to the vCenter Server APIs. It must be connected to a network with connectivity to the vCenter server.

See deploy and filter.

export flag

The export_flag service provides operations for retrieving information about the export flags supported by the server. Export flags can be specified in a vcenter.ovf.library_item.create_spec to customize an OVF export.
Type Description
vcenter.ovf.export_flag.info The info structure describes an export flag supported by the server.

import flag

The import_flag service provides operations for retrieving information about the import flags supported by the deployment platform. Import flags can be specified in a vcenter.ovf.library_item.resource_pool_deployment_spec to customize an OVF deployment.
Type Description
vcenter.ovf.import_flag.info The info structure describes an import flag supported by the deployment platform.

library item

The library_item service provides operations to deploy virtual machines and virtual appliances from library items containing Open Virtualization Format (OVF) packages in content library, as well as operations to create library items in content library from virtual machines and virtual appliances.

To deploy a virtual machine or a virtual appliance from a library item:

  1. Create a vcenter.ovf.library_item.deployment_target to specify the target deployment type and target deployment designation.
  2. Create a vcenter.ovf.library_item.resource_pool_deployment_spec to specify the parameters for the target deployment.
  3. Use the deploy operation with the created target and parameter specifications, along with the identifier of the specified source content library item. See deploy.

To create a library item in content library from a virtual machine or virtual appliance:

  1. Create a vcenter.ovf.library_item.deployable_identity to specify the source virtual machine or virtual appliance to be used as the OVF template source.
  2. Create a vcenter.ovf.library_item.create_target to specify the target library and library item.
  3. Create a vcenter.ovf.library_item.create_spec to specify the settings for the OVF package to be created.
  4. Use the create operation with the created target and parameter specifications, along with the specified source entity. See create.

Type Description
vcenter.ovf.library_item.create_result The create_result structure defines the result of the create operation. See create.
vcenter.ovf.library_item.create_spec The create_spec structure defines the information used to create or update a library item containing an OVF package.
vcenter.ovf.library_item.create_target The create_target structure specifies the target library item when capturing a virtual machine or virtual appliance as an OVF package in a library item in a content library. The target can be an existing library item, which will be updated, creating a new version, or it can be a newly created library item in a specified library. See create.
vcenter.ovf.library_item.deployable_identity The deployable_identity structure describes the resource created by a deployment, or the source resource from which library item can be created, by specifying its resource type and resource identifier.
vcenter.ovf.library_item.deployment_result The deployment_result structure defines the result of the deploy operation. See deploy.
vcenter.ovf.library_item.deployment_target The deployment_target structure describes the location (target) where a virtual machine or virtual appliance should be deployed. It is used in the deploy and filter operations. See deploy and filter.
vcenter.ovf.library_item.ovf_summary The ovf_summary structure defines the result of the filter operation. See filter. The fields in the structure describe parameterizable information in the OVF descriptor, with respect to a deployment target, for the deploy operation. See deploy.
vcenter.ovf.library_item.resource_pool_deployment_spec The resource_pool_deployment_spec structure defines the deployment parameters that can be specified for the deploy operation where the deployment target is a resource pool. See deploy.
vcenter.ovf.library_item.result_info The result_info structure defines the information returned along with the result of a create or deploy operation to describe errors, warnings, and informational messages produced by the server.
vcenter.ovf.library_item.storage_group_mapping The storage_group_mapping structure defines the storage deployment target and storage provisioning type for a section of type vmw:StorageGroupSection in the OVF descriptor.

resource pool

The ResourcePool service provides operations for manipulating a vCenter Server resource pool.

This service does not include virtual appliances in the inventory of resource pools even though part of the behavior of a virtual appliance is to act like a resource pool.

Type Description
vcenter.resource_pool.create_spec The vcenter.resource_pool.create_spec structure contains information used to create a resource pool, see create. This structure was added in vSphere API 7.0.0.
vcenter.resource_pool.filter_spec The filter_spec structure contains fields used to filter the results when listing resource pools (see list). If multiple fields are specified, only resource pools matching all of the fields match the filter.
vcenter.resource_pool.info The info structure contains information about a resource pool.
vcenter.resource_pool.resource_allocation_create_spec The resource_allocation_create_spec structure contains resource allocation information used to create a resource pool, see create. This structure was added in vSphere API 7.0.0.
vcenter.resource_pool.resource_allocation_info The resource_allocation_info structure contains resource allocation information of a resource pool. This structure was added in vSphere API 7.0.0.
vcenter.resource_pool.resource_allocation_update_spec The resource_allocation_update_spec structure descrives the updates to be made to the resource allocation settings of a resource pool. This structure was added in vSphere API 7.0.0.
vcenter.resource_pool.shares_info The shares_info structure provides specification of shares.

Shares are used to determine relative allocation between resource consumers. In general, a consumer with more shares gets proportionally more of the resource, subject to certain other constraints.

. This structure was added in vSphere API 7.0.0.
vcenter.resource_pool.summary The summary structure contains commonly used information about a resource pool in vCenter Server.
vcenter.resource_pool.update_spec The vcenter.resource_pool.update_spec structure contains specification for updating the configuration of a resource pool. This structure was added in vSphere API 7.0.0.

vcenter services

service

The service service provides operations to manage a single/set of vCenter Server services. This service was added in vSphere API 6.7.
Type Description
vcenter.services.service.info The info structure contains information about a service. This structure was added in vSphere API 6.7.
vcenter.services.service.update_spec The update_spec structure describes the changes to be made to the configuration of the service. This structure was added in vSphere API 6.7.

vcenter storage

vcenter storage policies

policies

The policies service provides operations for managing the storage policies. This service was added in vSphere API 6.7.
Type Description
vcenter.storage.policies.compatibility_info The compatibility_info structure contains info about a list of datastores compatible with a specific storage policy. This structure was added in vSphere API 6.7.
vcenter.storage.policies.compatible_datastore_info The compatible_datastore_info structure contains compatible datastore's information. This structure was added in vSphere API 6.7.
vcenter.storage.policies.filter_spec The filter_spec structure contains fields used to filter the results when listing the storage policies (see list). This structure was added in vSphere API 6.7.
vcenter.storage.policies.summary The summary structure contains commonly used information about a storage policy. This structure was added in vSphere API 6.7.

vcenter storage policies compliance

compliance

The Compliance service provides operations related to all the associated entities of given compliance statuses. This service was added in vSphere API 6.7.
Type Description
vcenter.storage.policies.compliance.filter_spec The filter_spec structure contains complianceStatus used to filter the results when listing entities (see list). This structure was added in vSphere API 6.7.
vcenter.storage.policies.compliance.summary Provides the details of a virtual machine and its associated entities which match the given compliance statuses. This structure was added in vSphere API 6.7.

VM

The VM structure provides operations related to query virtual machines of given compliance statuses. This service was added in vSphere API 6.7.
Type Description
vcenter.storage.policies.compliance.VM.filter_spec The filter_spec structure contains Status used to filter the results when listing virtual machines (see list). This structure was added in vSphere API 6.7.
vcenter.storage.policies.compliance.VM.info Provides the compliance details of a virtual machine and its associated entities which match the given compliance statuses. This structure was added in vSphere API 6.7.

VM

The VM service provides operations managing the storage policy association for a virtual machine and its virtual disks. This service was added in vSphere API 6.7.
Type Description
vcenter.storage.policies.VM.info The info structure contains information about a virtual machine and its virtual disks that are associated with the given storage policy. This structure was added in vSphere API 6.7.

vcenter system config

deployment type

The deployment_type service provides operations to get/set the type of the appliance. This service was added in vSphere API 6.7.
Type Description
vcenter.system_config.deployment_type.info The info structure contains the fields used to get the appliance type. This structure was added in vSphere API 6.7.
vcenter.system_config.deployment_type.reconfigure_spec The reconfigure_spec structure contains the fields used to get and set the appliance type. This structure was added in vSphere API 6.7.

psc registration

The psc_registration service provides operations to get and set the PSC_EXTERNAL appliance a VCSA_EXTERNAL appliance is registered with. This service was added in vSphere API 6.7.
Type Description
vcenter.system_config.psc_registration.info The info structure has fields to specify information about the PSC node. This structure was added in vSphere API 6.7.

vcenter tagging

The vcenter.tagging API provides services for managing tags.

associations

The associations service provides operations to list tag associations. This service was added in vSphere API 7.0.0.
Type Description
vcenter.tagging.associations.iteration_spec The iteration_spec structure contains fields used to break results into pages when listing tags associated to objects see list). This structure was added in vSphere API 7.0.0.
vcenter.tagging.associations.list_result The list_result structure contains the list of tag associations in a page, as well as related metadata fields. This structure was added in vSphere API 7.0.0.
vcenter.tagging.associations.summary The summary describes a tag association. This structure was added in vSphere API 7.0.0.

vcenter tokenservice

The vcenter.tokenservice API provides Token services.
Type Description
vcenter.tokenservice.error The error error describes thefields common to all standard errors.

This error serves two purposes:

  1. It is the error that clients in many programming languages can catch to handle all standard errors. Typically those clients will display one or more of the localizable messages from vcenter.tokenservice.error.messages to a human.
  2. It is the error that operations can report when they need to report some error, but the error doesn't fit into any other standard error, and in fact the only reasonable way for a client to react to the error is to display the message(s) to a human.
vcenter.tokenservice.invalid_grant The invalid_grant error indicates that provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.
vcenter.tokenservice.invalid_request The invalid_request error indicates that vcenter.tokenservice.token_exchange.exchange_spec is missing a required parameter, includes an unsupported parameter value (other than vcenter.tokenservice.token_exchange.exchange_spec.grant_type)
vcenter.tokenservice.invalid_scope The invalid_scope error indicates requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.

token exchange

The token_exchange interface provides possibility to exchange between different tokens types. Implementation of "OAuth 2.0 Token Exchange" standard (https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-12).
Type Description
vcenter.tokenservice.token_exchange.exchange_spec The exchange_spec structure contains arguments required for token exchange.
vcenter.tokenservice.token_exchange.info The info structure contains data that represents successful token exchange response.

vcenter topology

nodes

The nodes interface provides operations to retrieve vCenter and Platform Services Controller nodes information in the topology. This service was added in vSphere API 6.7.2.
Type Description
vcenter.topology.nodes.filter_spec The filter_spec structure contains field used to filter the results when listing vCenter and Platform Services Controller nodes (see list). This structure was added in vSphere API 6.7.2.
vcenter.topology.nodes.info The info structure contains vCenter or Platform Services Controller node details. This structure was added in vSphere API 6.7.2.
vcenter.topology.nodes.summary The summary structure contains commonly used information of vCenter or Platform Services Controller node. This structure was added in vSphere API 6.7.2.

replication status

The replication_status interface provides operations to retrieve replication status information of vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see vcenter.topology.nodes.info.type). This service was added in vSphere API 6.7.2.
Type Description
vcenter.topology.replication_status.filter_spec The filter_spec structure contains field used to filter the results when listing replication status for the vCenter and Platform Services Controller nodes (see list) of type VCSA_EMBEDDED/PSC_EXTERNAL (see vcenter.topology.nodes.info.type). This structure was added in vSphere API 6.7.2.
vcenter.topology.replication_status.summary The summary structure contains replication information of partner vCenter or Platform Services Controller node of type VCSA_EMBEDDED/PSC_EXTERNAL (see vcenter.topology.nodes.info.type). This structure was added in vSphere API 6.7.2.

vcenter trusted infrastructure

The vcenter.trusted_infrastructure API provides services that enable a Trusted Infrastructure. They are responsible for ensuring that infrastructure nodes are running trusted software and for releasing encryption keys only to trusted infrastructure nodes.
Type Description
vcenter.trusted_infrastructure.network_address The network_address structure contains an IP address or DNS resolvable name and a port on which a connection can be established. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.sts_principal The sts_principal structure contains a IDM principal. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.sts_principal_id The sts_principal_id structure contains an IDM principal ID. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.x509_cert_chain The x509_cert_chain structure contains x509 certificate chain. This structure was added in vSphere API 7.0.0.

vcenter trusted infrastructure attestation

The vcenter.trusted_infrastructure.attestation API provides services for configuring Attestation Services for Trusted vCenter.

services

The services service contains information about the registered instances of the Attestation Service in vCenter. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.attestation.services.create_spec The create_spec structure contains the data necessary for registering an Attestation Service instance to the environment. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.attestation.services.filter_spec The filter_spec structure contains the data necessary for identifying an Attestation Service instance. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.attestation.services.info The info structure contains all the stored information about a registered Attestation Service instance. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.attestation.services.summary The summary structure contains basic information about a registered Attestation Service instance. This structure was added in vSphere API 7.0.0.

vcenter trusted infrastructure kms

The vcenter.trusted_infrastructure.kms API provides services for configuring Key Provider Services for Trusted vCenter.

services

The services service contains information about the registered instances of the Key Provider Service in vCenter. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.kms.services.create_spec The create_spec structure contains the data necessary for registering a Key Provider Service instance to the environment. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.kms.services.filter_spec The filter_spec structure contains the data necessary for identifying a Key Provider Service instance. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.kms.services.info The info structure contains all the stored information about a registered Key Provider Service instance. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.kms.services.summary The summary structure contains basic information about a registered Key Provider Service instance. This structure was added in vSphere API 7.0.0.

principal

The principal service contains information about the certificates which sign the tokens used by vCenter for authentication. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.principal.info The info structure contains the information about the principal and certificates used by this vCenter to retrieve tokens. This structure was added in vSphere API 7.0.0.

vcenter trusted infrastructure trust authority clusters

The vcenter.trusted_infrastructure.trust_authority_clusters API provides the Trust Authority Components.

trust authority clusters

The trust_authority_clusters service manages all the Trust Authority Components on each Trust Authority Host in the cluster. The trust_authority_clusters service transforms a ClusterComputeResource into Trust Authority Cluster and vice versa. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.filter_spec The filter_spec structure contains the data necessary for identifying a vcenter.trusted_infrastructure.trust_authority_clusters. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.info The info structure contains the data necessary for retrieving the vcenter.trusted_infrastructure.trust_authority_clusters info. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.summary The summary structure contains information about vcenter.trusted_infrastructure.trust_authority_clusters id and state. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.update_spec The update_spec structure contains the data necessary for update of a vcenter.trusted_infrastructure.trust_authority_clusters. This structure was added in vSphere API 7.0.0.

vcenter trusted infrastructure trust authority clusters attestation

The vcenter.trusted_infrastructure.trust_authority_clusters.attestation API provides services for configuring the Attestation Service. It attests the state of a remote infrastructure node.

vcenter trusted infrastructure trust authority clusters attestation os esx

The vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx API provides the interfaces for configuring ESX host metadata.

base images

The base_images service provides operations to manage trusted instances of ESX software on a cluster level. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.base_images.filter_spec The filter_spec structure contains the data necessary for identifying a Trust Authority Host in a cluster. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.base_images.info The info structure contains information that describes an ESX base image. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.base_images.summary The summary structure contains information that summarizes an ESX base image. This structure was added in vSphere API 7.0.0.

service status

The service_status service provides operations to get the Attestation Service health status. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.service_status.info The info structure contains information that describes the status of the service. This structure was added in vSphere API 7.0.0.

vcenter trusted infrastructure trust authority clusters attestation tpm2

The vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2 API provides services to manage remote attestation configuration for TPM trust.

ca certificates

The ca_certificates service provides operations to manage Trusted Platform Module (TPM) CA certificates.

Endorsement Keys are typically packaged in a certificate that is signed by a certificate authority (CA). This service allows the CA certificate to be registered with the Attestation Service in order to validate TPM EK certificates when presented at attestation time.

. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.ca_certificates.create_spec The create_spec structure contains information that describes a TPM CA certificate. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.ca_certificates.info The info structure contains information that describes a TPM CA certificate. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.ca_certificates.summary The summary structure contains information that summarizes a TPM CA certificate. This structure was added in vSphere API 7.0.0.

endorsement keys

The endorsement_keys service provides operations to manage Trusted Platform Module (TPM) Endorsement Keys (EK) on a cluster level. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.endorsement_keys.create_spec The create_spec structure contains information that describes a TPM endorsement key.

Only one of vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.endorsement_keys.create_spec.public_key or vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.endorsement_keys.create_spec.certificate must be specified.

. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.endorsement_keys.info The info structure contains information that describes a TPM endorsement key. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.endorsement_keys.summary The summary structure contains information that summarizes a TPM endorsement key. This structure was added in vSphere API 7.0.0.

settings

The settings interface provides operations to get or update settings related to the TPM 2.0 attestation protocol behavior. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.settings.info The info structure contains information that describes the TPM 2.0 protocol settings. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.settings.update_spec The update_spec structure contains information that describes changes to the TPM 2.0 protocol settings. This structure was added in vSphere API 7.0.0.

consumer principals

The consumer_principals service configures the token policies and STS trust necessary for the workload vCenter to query the trusted services for their status. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.consumer_principals.create_spec The create_spec structure contains the information necessary to establish trust between a workload vCenter and a Trust Authority Host. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.consumer_principals.filter_spec The filter_spec structure contains data which identifies a connection profile on the trusted vCenter. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.consumer_principals.info The info structure contains the information necessary to establish trust between a workload vCenter and a Trust Authority Host. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.consumer_principals.summary The summary structure contains a summary of the information necessary to establish trust between a workload vCenter and a Trust Authority Host. This structure was added in vSphere API 7.0.0.

vcenter trusted infrastructure trust authority clusters kms

The vcenter.trusted_infrastructure.trust_authority_clusters.kms API provides the interfaces for configuring the Key Provider Service. It encapsulates one or more key servers and exposes Trusted Key Providers.

vcenter trusted infrastructure trust authority clusters kms providers

The vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers API provides the services for configuring the Key Providers of a Trust Authority Cluster.

providers

The providers interface provides operations to create, update and delete Key Providers that handoff to key servers. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.create_spec The create_spec structure contains fields that describe the desired configuration for a new Key Provider. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.info The info structure contains fields that describe the current configuration of a provider. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.key_server_create_spec The key_server_create_spec structure contains fields that describe the desired configuration for the key server. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.key_server_info The key_server_info structure contains fields that describe the current configuration of a key server. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.key_server_update_spec The key_server_update_spec structure contains fields that describe new configuration for an existing key server. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.kmip_server_create_spec The kmip_server_create_spec structure contains fields that describe Key Management Interoperability Protocol (KMIP) desired key server configuration. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.kmip_server_info The kmip_server_info structure contains fields that describe the current configuration of a KMIP based key server. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.kmip_server_update_spec The kmip_server_update_spec structure contains fields that describe new configuration for KMIP based key server. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.server The server structure contains fields that describe a connection endpoint. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.server_info The server_info structure contains fields that describe the status of a key server. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.status The status structure contains fields that describe the status of the Key Provider. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.summary The summary structure contains fields that summarize a provider. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.update_spec The update_spec structure contains fields that describe the new configuration for an existing provider. This structure was added in vSphere API 7.0.0.

vcenter trusted infrastructure trust authority clusters kms providers client certificate

The vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate API provides the interfaces for configuring the Client Certificate used by the Key Provider Service to authenticate against the Key Servers.

client certificate

The client_certificate interface provides operations to add and retrieve client certificate. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate.info The info structure contains the client certificate used by the hosts in a cluster for authenticating with the Provider. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate.update_spec The update_spec structure contains fields that describe the client certificate update for a Key Provider. This structure was added in vSphere API 7.0.0.

csr

The csr interface provides operations to create a certificate signing request(CSR). This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate.csr.info The info structure contains the certificate signing request. This structure was added in vSphere API 7.0.0.

current peer certificates

Retrieves the list of TLS certificates used by peer key servers. Those are meant for review. Following approval these certificates should be added as trusted certificates in the vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.trusted_peer_certificates service. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.current_peer_certificates.filter_spec The filter_spec structure contains fields used to filter the results when listing remote server certificates. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.current_peer_certificates.summary The summary structure contains a summary of the current key server certificates. This structure was added in vSphere API 7.0.0.

trusted peer certificates

Provides management operations for the TLS certificates trusted for communication with peer key servers.

To obtain the currently used TLS certificates use the vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.current_peer_certificates service

. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.trusted_peer_certificates.info The info structure contains x509 certificate list. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.trusted_peer_certificates.update_spec The update_spec structure contains fields that describe the server certificate update for a Key Provider. This structure was added in vSphere API 7.0.0.

service status

The service_status service provides operations to get the Key Provider Service health status. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_clusters.kms.service_status.info The info structure contains information that describes the status of the service. This structure was added in vSphere API 7.0.0.

vcenter trusted infrastructure trust authority hosts

The vcenter.trusted_infrastructure.trust_authority_hosts API provides services that provide information necessary to connect to the hosts running the Trust Authority Components.

attestation

The attestation service contains information necessary to connect to the hosts running Attestation Service. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_hosts.attestation.filter_spec The filter_spec structure contains the data necessary for identifying a Attestation Service. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_hosts.attestation.info The info structure contains all the stored information about a Attestation Service. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_hosts.attestation.summary The summary structure contains all the stored information about a Attestation Service. This structure was added in vSphere API 7.0.0.

kms

The kms service contains information necessary to connect to the hosts running Key Provider Service. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trust_authority_hosts.kms.filter_spec The filter_spec structure contains the data necessary for identifying a Key Provider Service. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_hosts.kms.info The info structure contains all the stored information about a Key Provider Service. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trust_authority_hosts.kms.summary The summary structure contains all the stored information about a Key Provider Service. This structure was added in vSphere API 7.0.0.

vcenter trusted infrastructure trusted clusters attestation

The vcenter.trusted_infrastructure.trusted_clusters.attestation API provides services for configuring Attestation Services for Trusted Clusters.

services

The services service manages the Attestation Service instances a Trusted Cluster is configured to use. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trusted_clusters.attestation.services.create_spec The create_spec structure contains the data necessary for configuring a registered Attestation Service instance with a cluster in the environment. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trusted_clusters.attestation.services.filter_spec The filter_spec structure contains the data necessary for identifying a Attestation service instance. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trusted_clusters.attestation.services.info The info structure contains all the stored information about a registered Attestation Service instance that is configured for a cluster. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trusted_clusters.attestation.services.summary The summary structure contains basic information about a registered Attestation Service instance that is configured for a cluster. This structure was added in vSphere API 7.0.0.

vcenter trusted infrastructure trusted clusters kms

The vcenter.trusted_infrastructure.trusted_clusters.kms API provides services for configuring Key Provider Services for Trusted Clusters.

services

The services service manages the Key Provider Service instances a Trusted Cluster is configured to use. This service was added in vSphere API 7.0.0.
Type Description
vcenter.trusted_infrastructure.trusted_clusters.kms.services.create_spec The create_spec structure contains the data necessary for configuring a registered Key Provider Service instance with a cluster in the environment. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trusted_clusters.kms.services.filter_spec The filter_spec structure contains the data necessary for identifying a Key Provider service instance. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trusted_clusters.kms.services.info The info structure contains all the stored information about a registered Key Provider Service instance that is configured for a cluster. This structure was added in vSphere API 7.0.0.
vcenter.trusted_infrastructure.trusted_clusters.kms.services.summary The summary structure contains basic information about a registered Key Provider Service instance that is configured for a cluster. This structure was added in vSphere API 7.0.0.

vcenter vcha

The vcenter.vcha API provides services for deploying and monitoring a vCenter High Availability (VCHA) Cluster.
Type Description
vcenter.vcha.certificate_info The certificate_info Structure contains information about the SSL certificate for a management vCenter server. This structure was added in vSphere API 6.7.1.
vcenter.vcha.connection_spec The connection_spec structure contains information required to connect to a vCenter server. The connection to the vCenter server always uses the HTTPS protocol. This structure was added in vSphere API 6.7.1.
vcenter.vcha.credentials_spec The credentials_spec structure contains information to connect to the vCenter server managing the VCHA nodes. This structure was added in vSphere API 6.7.1.
vcenter.vcha.disk_info The disk_info structure contains information to describe the storage configuration of a vCenter virtual machine. This structure was added in vSphere API 6.7.1.
vcenter.vcha.disk_spec The disk_spec structure contains information to describe the storage configuration of a vCenter virtual machine. This structure was added in vSphere API 6.7.1.
vcenter.vcha.ip_spec The ip_spec structure contains IP information used to configure a network interface. This structure was added in vSphere API 6.7.1.
vcenter.vcha.ipv4_spec The ipv4_spec structure contains IPV4 information used to configure a network interface. This structure was added in vSphere API 6.7.1.
vcenter.vcha.ipv6_spec The ipv6_spec structure contains IPV6 information used to configure a network interface. This structure was added in vSphere API 6.7.1.
vcenter.vcha.placement_info The placement_info structure contains information to describe the inventory placement of a single node of a VCHA cluster.
The active node's management vCenter server credentials are required to populate all fields except biosUuid. This structure was added in vSphere API 6.7.1.
vcenter.vcha.placement_spec The placement_spec structure contains information to describe the inventory placement of a single node of a VCHA cluster. This structure was added in vSphere API 6.7.1.

vcenter vcha cluster

The vcenter.vcha.cluster API provides services for redeploying and monitoring a vCenter High Availability (VCHA) Cluster after a successful initial deployment.

cluster

The cluster service provides operations to deploy and undeploy a vCenter High Availability (VCHA) cluster, failover from the active VCHA node to the passive VCHA node, and retrieve the status of the VCHA cluster. This service was added in vSphere API 6.7.1.
Type Description
vcenter.vcha.cluster.active_spec The active_spec structure contains the deploy specification for the Active Node of the VCHA cluster. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.deploy_spec The deploy_spec structure contains the deploy specification for the three nodes of a VCHA cluster. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.error_condition The error_condition structure contains an error condition and a recommendation to handle the error condition. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.info The info structure contains the configuration and health information of the three nodes in a VCHA Cluster. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.ip_info The ip_info structure contains fields related to an ip. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.ipv4_info The ipv4_info structure contains fields to describe IPV4 information of the configured network interface. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.ipv6_info The ipv6_info structure contains fields to describe IPV6 information of the configured network interface. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.node_info The node_info structure defines the configuration information for the active and passive nodes in the cluster. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.node_runtime_info The node_runtime_info structure describes a node's runtime information in a VCHA Cluster. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.node_vm_info The node_vm_info structure contains information to describe the Virtual Machine of a node of a VCHA cluster. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.passive_spec The passive_spec structure contains the deploy specification for the Passive Node of the VCHA cluster. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.undeploy_spec The undeploy_spec structure contains the undeploy specification for a VCHA cluster. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.vm_info The vm_info structure contains information to describe the Virtual Machines of passive and witness nodes of a VCHA cluster. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.witness_info The witness_info structure defines the configuration and runtime information for the witness node in the cluster. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.witness_spec The witness_spec structure contains the deploy specification for the Witness Node of the VCHA cluster. This structure was added in vSphere API 6.7.1.

active

The active service provides operations to get information related to the active vCenter High Availability (VCHA) node. This service was added in vSphere API 6.7.1.
Type Description
vcenter.vcha.cluster.active.info The info structure contains the network and placement information of the active node of a VCHA Cluster. This structure was added in vSphere API 6.7.1.

deployment type

The DeploymentType service provides operations to get the deployment type of a vCenter High Availability Cluster (VCHA Cluster). This service was added in vSphere API 6.7.1.
Type Description
vcenter.vcha.cluster.deployment_type.info The info structure contains the deployment type of the VCHA Cluster. This structure was added in vSphere API 6.7.1.

mode

The Mode service provides operations to manage the operating mode of a vCenter High Availability Cluster (VCHA Cluster). This service was added in vSphere API 6.7.1.
Type Description
vcenter.vcha.cluster.mode.info The info structure contains the mode of the VCHA Cluster. This structure was added in vSphere API 6.7.1.

passive

The passive service provides operations to validate a passive's placement configuration and redeploy the passive node in a vCenter High Availability (VCHA) cluster. This service was added in vSphere API 6.7.1.
Type Description
vcenter.vcha.cluster.passive.check_result The check_result structure contains the warnings and errors that will occur during the clone operation. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.passive.check_spec The check_spec structure contains placement information for validation. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.passive.redeploy_spec The redeploy_spec structure contains the redeploy specification. This structure was added in vSphere API 6.7.1.

witness

The witness service provides operations to validate a witness's placement configuration and redeploy the witness node in a vCenter High Availability (VCHA) cluster. This service was added in vSphere API 6.7.1.
Type Description
vcenter.vcha.cluster.witness.check_result The check_result structure contains the warnings and errors that will occur during the clone operation. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.witness.check_spec The check_spec structure contains placement information for validation. This structure was added in vSphere API 6.7.1.
vcenter.vcha.cluster.witness.redeploy_spec The redeploy_spec structure contains the redeploy specification. This structure was added in vSphere API 6.7.1.

operations

The operations service provides operations to figure out the currently active operations and currently disabled operations in a vCenter High Availability (VCHA) cluster. This service was added in vSphere API 6.7.1.
Type Description
vcenter.vcha.operations.info The info structure contains information about which the VCHA operations cannot be invoked in the current state of the system and the list of currently active VCHA operations. This structure was added in vSphere API 6.7.1.

vcenter vm

The vcenter.vm API provides services for managing virtual machines.

VM

The VM service provides operations for managing the lifecycle of a virtual machine.
Type Description
vcenter.VM.clone_placement_spec The clone_placement_spec structure contains information used to place a clone of a virtual machine onto resources within the vCenter inventory. This structure was added in vSphere API 7.0.0.
vcenter.VM.clone_spec Document-based clone spec. This structure was added in vSphere API 7.0.0.
vcenter.VM.compute_placement_spec The compute_placement_spec structure contains information used to place a virtual machine on compute resources.
vcenter.VM.create_spec Document-based creation spec.
vcenter.VM.disk_clone_spec Document-based disk clone spec. This structure was added in vSphere API 7.0.0.
vcenter.VM.disk_relocate_spec Document-based disk relocate spec. This structure was added in vSphere API 7.0.0.
vcenter.VM.filter_spec The filter_spec structure contains fields used to filter the results when listing virtual machines (see list). If multiple fields are specified, only virtual machines matching all of the fields match the filter.
vcenter.VM.guest_customization_spec The guest_customization_spec structure contains information required to customize a virtual machine when deploying it. This structure was added in vSphere API 7.0.0.
vcenter.VM.info Document-based info.
vcenter.VM.instant_clone_placement_spec The instant_clone_placement_spec structure contains information used to place an InstantClone of a virtual machine onto resources within the vCenter inventory. This structure was added in vSphere API 6.7.1.
vcenter.VM.instant_clone_spec Document-based InstantClone spec. This structure was added in vSphere API 6.7.1.
vcenter.VM.inventory_placement_spec The inventory_placement_spec structure contains information used to place a virtual machine in the vCenter inventory.
vcenter.VM.placement_spec The placement_spec structure contains information used to place a virtual machine onto resources within the vCenter inventory.
vcenter.VM.register_placement_spec The register_placement_spec structure contains information used to place a virtual machine, created from existing virtual machine files on storage, onto resources within the vCenter inventory. This structure was added in vSphere API 6.8.7.
vcenter.VM.register_spec The register_spec structure contains information used to create a virtual machine from existing virtual machine files on storage.

The location of the virtual machine files on storage must be specified by providing either vcenter.VM.register_spec.datastore and vcenter.VM.register_spec.path or by providing vcenter.VM.register_spec.datastore_path. If vcenter.VM.register_spec.datastore and vcenter.VM.register_spec.path are set, vcenter.VM.register_spec.datastore_path must be unset, and if vcenter.VM.register_spec.datastore_path is set, vcenter.VM.register_spec.datastore and vcenter.VM.register_spec.path must be unset.

. This structure was added in vSphere API 6.8.7.
vcenter.VM.relocate_placement_spec The relocate_placement_spec structure contains information used to change the placement of an existing virtual machine within the vCenter inventory. This structure was added in vSphere API 7.0.0.
vcenter.VM.relocate_spec Document-based relocate spec. This structure was added in vSphere API 7.0.0.
vcenter.VM.storage_placement_spec The storage_placement_spec structure contains information used to store a virtual machine's files.
vcenter.VM.storage_policy_spec The storage_policy_spec structure contains information about the storage policy to be associated with a virtual machine object. This structure was added in vSphere API 6.7.
vcenter.VM.summary The summary structure contains commonly used information about a virtual machine.

vcenter vm compute

The vcenter.vm.compute API provides services for quering the status of compute policies on virtual machines in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.

policies

The policies service provides operations to query the status of policies on virtual machines in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vcenter.vm.compute.policies.info The info structure contains information about the compliance of a virtual machine with a compute policy. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter vm console

The vcenter.vm.console API provides services for managing Virtual Machine Consoles.

tickets

The tickets service provides operations for managing the virtual machine console tickets. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vcenter.vm.console.tickets.create_spec The create_spec structure defines the information used to create the virtual machine console ticket. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vcenter.vm.console.tickets.summary The summary structure contains commonly used information about the virtual machine console ticket. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter vm guest

The vcenter.vm.guest API provides services for dealing with the guest operating system. This includes information about the state of local file systems and network interfaces and operations to manipulate the guest file system and processes.
Type Description
vcenter.vm.guest.dhcp_config_info The dhcp_config_info structure specifies when Dynamic Host Configuration Protocol is enabled. This structure was added in vSphere API 7.0.0.
vcenter.vm.guest.dns_assigned_values The {@name DnsAssignedValues) structure describes values assigned by a Domain Name Server (DNS). This structure was added in vSphere API 7.0.0.
vcenter.vm.guest.dns_config_info The dns_config_info structure describes the configuration of RFC 1034 DNS settings. This structure was added in vSphere API 7.0.0.

customization

The customization service provides operations to apply a customization specification to a virtual machine. This service was added in vSphere API 7.0.0.
Type Description
vcenter.vm.guest.customization.set_spec The set_spec structure contains specification information that has to be applied to a virtual machine. This structure was added in vSphere API 7.0.0.

identity

The identity service provides operations for retrieving guest operating system identification information. This service was added in vSphere API 6.7.
Type Description
vcenter.vm.guest.identity.info The info structure contains information describing the guest operating system identification. This structure was added in vSphere API 6.7.

local filesystem

The local_filesystem service provides operations for retrieving information about the guest operating system local file systems. This service was added in vSphere API 6.7.
Type Description
vcenter.vm.guest.local_filesystem.info The info structure contains information about a local file system configured in the guest operating system. This structure was added in vSphere API 6.7.
vcenter.vm.guest.local_filesystem.virtual_disk_mapping Describes the virtual disk backing a local guest disk. This structure was added in vSphere API 7.0.0.

vcenter vm guest networking

The vcenter.vm.guest.networking API provides services for dealing with the guest operating system networking.

networking

The networking service provides operations for retrieving guest operating system network information. This service was added in vSphere API 7.0.0.
Type Description
vcenter.vm.guest.networking.info The info structure contains information about networking as configured in the guest operating system. This structure was added in vSphere API 7.0.0.

interfaces

The interfaces service provides operations for retrieving guest operating system network interface information. This service was added in vSphere API 7.0.0.
Type Description
vcenter.vm.guest.networking.interfaces.info The info structure describes a virtual network adapter configured in the guest operating system. This structure was added in vSphere API 7.0.0.
vcenter.vm.guest.networking.interfaces.ip_address_info The ip_address_info structure describes a specific IP Address. This structure was added in vSphere API 7.0.0.
vcenter.vm.guest.networking.interfaces.ip_config_info The ip_config_info structure describes the protocol version independent address reporting data object for network interfaces. This structure was added in vSphere API 7.0.0.

routes

The routes service provides operations for retrieving guest operating system network routing information. This service was added in vSphere API 7.0.0.
Type Description
vcenter.vm.guest.networking.routes.info The info structure describes an individual host, network or default destination network reachable through a gateway. This structure was added in vSphere API 7.0.0.

power

The power service provides operations for managing the guest operating system power state of a virtual machine. This service was added in vSphere API 6.7.
Type Description
vcenter.vm.guest.power.info Information about the guest operating system power state. This structure was added in vSphere API 6.7.

vcenter vm hardware

The vcenter.vm.hardware API provides services for managing the virtual hardware configuration and state of a virtual machine. This includes operations for reading and manipulating virtual device configuration and for querying the runtime state of the devices.

hardware

The hardware service provides operations for configuring the virtual hardware of a virtual machine.
Type Description
vcenter.vm.hardware.connection_create_spec The connection_create_spec structure provides a specification for the configuration of a newly-created removable device.
vcenter.vm.hardware.connection_info The connection_info structure provides information about the state and configuration of a removable virtual device.
vcenter.vm.hardware.connection_update_spec The connection_update_spec structure describes the updates to be made to the configuration of a removable virtual device.
vcenter.vm.hardware.ide_address_info The ide_address_info structure contains information about the address of a virtual device that is attached to a virtual IDE adapter of a virtual machine.
vcenter.vm.hardware.ide_address_spec The ide_address_spec structure contains information for specifying the address of a virtual device that is attached to a virtual IDE adapter of a virtual machine.
vcenter.vm.hardware.info The info structure contains information related to the virtual hardware of a virtual machine.
vcenter.vm.hardware.sata_address_info The sata_address_info structure contains information about the address of a virtual device that is attached to a virtual SATA adapter of a virtual machine.
vcenter.vm.hardware.sata_address_spec The sata_address_spec structure contains information for specifying the address of a virtual device that is attached to a virtual SATA adapter of a virtual machine.
vcenter.vm.hardware.scsi_address_info The scsi_address_info structure contains information about the address of a virtual device that is attached to a virtual SCSI adapter of a virtual machine.
vcenter.vm.hardware.scsi_address_spec The scsi_address_spec structure contains information for specifying the address of a virtual device that is attached to a virtual SCSI adapter of a virtual machine.
vcenter.vm.hardware.update_spec The update_spec structure describes the updates to virtual hardware settings of a virtual machine.

vcenter vm hardware adapter

The vcenter.vm.hardware.adapter API provides services for managing the configuration and state of the virtual adapters belonging to a virtual machine. This includes operations for reading and manipulating the conifguration of USB adapters and host bus adapters.

Note that services for adapters with no configurable properties or runtime state, such as IDE and PCI adapters, are omitted.

sata

The sata service provides operations for configuring the virtual SATA adapters of a virtual machine.
Type Description
vcenter.vm.hardware.adapter.sata.create_spec The create_spec structure provides a specification for the configuration of a newly-created virtual SATA adapter.
vcenter.vm.hardware.adapter.sata.info The info structure contains information about a virtual SATA adapter.
vcenter.vm.hardware.adapter.sata.summary The summary structure contains commonly used information about a Virtual SATA adapter.

scsi

The scsi service provides operations for configuring the virtual SCSI adapters of a virtual machine.
Type Description
vcenter.vm.hardware.adapter.scsi.create_spec The create_spec structure provides a specification for the configuration of a newly-created virtual SCSI adapter.
vcenter.vm.hardware.adapter.scsi.info The info structure contains information about a virtual SCSI adapter.
vcenter.vm.hardware.adapter.scsi.summary The summary structure contains commonly used information about a Virtual SCSI adapter.
vcenter.vm.hardware.adapter.scsi.update_spec The update_spec structure describes the updates to be made to the configuration of a virtual SCSI adapter.

vcenter vm hardware boot

The vcenter.vm.hardware.boot API provides services for managing the virtual devices used to boot a virtual machine.

boot

The boot service provides operations for configuring the settings used when booting a virtual machine.
Type Description
vcenter.vm.hardware.boot.create_spec The create_spec structure describes settings used when booting a virtual machine.
vcenter.vm.hardware.boot.info The info structure contains information about the virtual machine boot process.
vcenter.vm.hardware.boot.update_spec The update_spec structure describes the updates to the settings used when booting a virtual machine.

device

The device service provides operations for configuring the device order used when booting a virtual machine.

The boot order may be specified using a mixture of device classes and device instances, chosen from among the following:

Type Description
vcenter.vm.hardware.boot.device.entry The entry structure specifies a bootable virtual device class or specific bootable virtual device(s).
vcenter.vm.hardware.boot.device.entry_create_spec The structure entry_create_spec specifies a list of bootable virtual device classes. When a VM is being created and a array of entry_create_spec is specified, the boot order of the specific device instances are not specified in this structure. The boot order of the specific device instance will be the order in which the Ethernet and Disk devices appear in the nics and disks respectively.

cdrom

The cdrom service provides operations for configuring the virtual CD-ROM devices of a virtual machine.
Type Description
vcenter.vm.hardware.cdrom.backing_info The backing_info structure contains information about the physical resource backing a virtual CD-ROM device.
vcenter.vm.hardware.cdrom.backing_spec The backing_spec structure provides a specification of the physical resource backing a virtual CD-ROM device.
vcenter.vm.hardware.cdrom.create_spec The create_spec structure provides a specification for the configuration of a newly-created virtual CD-ROM device.
vcenter.vm.hardware.cdrom.info The info structure contains information about a virtual CD-ROM device.
vcenter.vm.hardware.cdrom.summary The summary structure contains commonly used information about a virtual CD-ROM device.
vcenter.vm.hardware.cdrom.update_spec The update_spec structure describes the updates to be made to the configuration of a virtual CD-ROM device.

cpu

The cpu service provides operations for configuring the CPU settings of a virtual machine.
Type Description
vcenter.vm.hardware.cpu.info The info structure contains CPU-related information about a virtual machine.
vcenter.vm.hardware.cpu.update_spec The update_spec structure describes the updates to be made to the CPU-related settings of a virtual machine.

disk

The disk service provides operations for configuring the virtual disks of a virtual machine. A virtual disk has a backing such as a VMDK file. The backing has an independent lifecycle from the virtual machine when it is detached from the virtual machine. The create operation provides the ability to create a new virtual disk. When creating a virtual disk, a new VMDK file may be created or an existing VMDK file may used as a backing. Once a VMDK file is associated with a virtual machine, its lifecycle will be bound to the virtual machine. In other words, it will be deleted when the virtual machine is deleted. The delete operation provides the ability to detach a VMDK file from the virtual machine. The delete operation does not delete the VMDK file that backs the virtual disk. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.
Type Description
vcenter.vm.hardware.disk.backing_info The backing_info structure contains information about the physical resource backing a virtual disk.
vcenter.vm.hardware.disk.backing_spec The backing_spec structure provides a specification of the physical resource backing a virtual disk.
vcenter.vm.hardware.disk.create_spec The create_spec structure provides a specification for the configuration of a newly-created virtual disk.
vcenter.vm.hardware.disk.info The info structure contains information about a virtual disk.
vcenter.vm.hardware.disk.storage_policy_spec The storage_policy_spec structure contains information about the storage policy be associated with a VMDK file. This structure was added in vSphere API 6.7.
vcenter.vm.hardware.disk.summary The summary structure contains commonly used information about a virtual disk.
vcenter.vm.hardware.disk.update_spec The update_spec structure describes the updates to be made to the configuration of a virtual disk.
vcenter.vm.hardware.disk.vmdk_create_spec The vmdk_create_spec structure provides a specification for creating a new VMDK file to be used as a backing for a virtual disk. The virtual disk will be stored in the same directory as the virtual machine's configuration file.

ethernet

The ethernet service provides operations for configuring the virtual Ethernet adapters of a virtual machine.
Type Description
vcenter.vm.hardware.ethernet.backing_info The backing_info structure contains information about the physical resource backing a virtual Ethernet adapter.
vcenter.vm.hardware.ethernet.backing_spec The backing_spec structure provides a specification of the physical resource that backs a virtual Ethernet adapter.
vcenter.vm.hardware.ethernet.create_spec The create_spec structure provides a specification for the configuration of a newly-created virtual Ethernet adapter.
vcenter.vm.hardware.ethernet.info The info structure contains information about a virtual Ethernet adapter.
vcenter.vm.hardware.ethernet.summary The summary structure contains commonly used information about a virtual Ethernet adapter.
vcenter.vm.hardware.ethernet.update_spec The update_spec structure describes the updates to be made to the configuration of a virtual Ethernet adapter.

floppy

The floppy service provides operations for configuring the virtual floppy drives of a virtual machine.
Type Description
vcenter.vm.hardware.floppy.backing_info The backing_info structure contains information about the physical resource backing a virtual floppy drive.
vcenter.vm.hardware.floppy.backing_spec The backing_spec structure provides a specification of the physical resource backing a virtual floppy drive.
vcenter.vm.hardware.floppy.create_spec The create_spec structure provides a specification for the configuration of a newly-created virtual floppy drive.
vcenter.vm.hardware.floppy.info The info structure contains information about a virtual floppy drive.
vcenter.vm.hardware.floppy.summary The summary structure contains commonly used information about a virtual floppy drive.
vcenter.vm.hardware.floppy.update_spec The update_spec structure describes the updates to be made to the configuration of a virtual floppy drive.

memory

The memory service provides operations for configuring the memory settings of a virtual machine.
Type Description
vcenter.vm.hardware.memory.info The info structure contains memory-related information about a virtual machine.
vcenter.vm.hardware.memory.update_spec The update_spec structure describes the updates to be made to the memory-related settings of a virtual machine.

parallel

The parallel service provides operations for configuring the virtual parallel ports of a virtual machine.
Type Description
vcenter.vm.hardware.parallel.backing_info The backing_info structure contains information about the physical resource backing a virtual parallel port.
vcenter.vm.hardware.parallel.backing_spec The backing_spec structure provides a specification of the physical resource backing a virtual parallel port.
vcenter.vm.hardware.parallel.create_spec The create_spec structure provides a specification for the configuration of a newly-created virtual parallel port.
vcenter.vm.hardware.parallel.info The info structure contains information about a virtual parallel port.
vcenter.vm.hardware.parallel.summary The summary structure contains commonly used information about a virtual parallel port.
vcenter.vm.hardware.parallel.update_spec The update_spec structure describes the updates to be made to the configuration of a virtual parallel port.

serial

The serial service provides operations for configuring the virtual serial ports of a virtual machine.
Type Description
vcenter.vm.hardware.serial.backing_info The backing_info structure contains information about the physical resource backing a virtual serial port.
vcenter.vm.hardware.serial.backing_spec The backing_spec structure provides a specification of the physical resource backing a virtual serial port.
vcenter.vm.hardware.serial.create_spec The create_spec structure provides a specification for the configuration of a newly-created virtual serial port.
vcenter.vm.hardware.serial.info The info structure contains information about a virtual serial port.
vcenter.vm.hardware.serial.summary The summary structure contains commonly used information about a virtual serial port.
vcenter.vm.hardware.serial.update_spec The update_spec structure describes the updates to be made to the configuration of a virtual serial port.

identity

The identity service provides operations for managing the identity of a virtual machine. This service was added in vSphere API 6.7.1.
Type Description
vcenter.vm.identity.info The info structure contains information about the identity of a virtual machine. This structure was added in vSphere API 6.7.1.

library item

The library_item service provides operations to identify virtual machines managed by Content Library. This service was added in vSphere API 6.9.1.
Type Description
vcenter.vm.library_item.check_out_info The check_out_info structure contains information about a virtual machine checked out of a content library item. This structure was added in vSphere API 6.9.1.
vcenter.vm.library_item.info The info structure contains information about the library item associated with a virtual machine. This structure was added in vSphere API 6.9.1.

power

The power service provides operations for managing the power state of a virtual machine.
Type Description
vcenter.vm.power.info The info structure contains information about the power state of a virtual machine.

vcenter vm storage

vcenter vm storage policy

policy

The policy service provides operations to configure the storage policies associated with the virtual machine home and/or its virtual disks. This service was added in vSphere API 6.7.
Type Description
vcenter.vm.storage.policy.disk_policy_spec The disk_policy_spec structure provides a specification for the storage policy to be associated with the virtual disks. This structure was added in vSphere API 6.7.
vcenter.vm.storage.policy.info The info structure contains information about the storage policies associated with virtual machine's home directory and virtual hard disks. This structure was added in vSphere API 6.7.
vcenter.vm.storage.policy.update_spec The update_spec structure describes the updates to be made to the storage policies associated with the virtual machine home and/or its virtual disks. This structure was added in vSphere API 6.7.
vcenter.vm.storage.policy.vm_home_policy_spec The vm_home_policy_spec structure provides a specification for the storage policy to be associated with the virtual machine home's directory. This structure was added in vSphere API 6.7.

compliance

The Compliance service provides operations that return the compliance status of virtual machine entities(virtual machine home directory and virtual disks) that specify storage policy requirements. This service was added in vSphere API 6.7.
Type Description
vcenter.vm.storage.policy.compliance.check_spec The check_spec structure contains fields used to specify the entities on which the storage policy compliance check is to be invoked. This structure was added in vSphere API 6.7.
vcenter.vm.storage.policy.compliance.info The info structure contains information about the storage policy compliance of a virtual machine, including information about it's home directory and/or it's virtual disks. This structure was added in vSphere API 6.7.
vcenter.vm.storage.policy.compliance.vm_compliance_info The vm_compliance_info structure contains information about storage policy compliance associated with a virtual machine. This structure was added in vSphere API 6.7.

vcenter vm tools

The vcenter.vm API provides services for managing VMware Tools.

tools

The tools service provides operations for managing VMware Tools in the guest operating system. This service was added in vSphere API 7.0.0.
Type Description
vcenter.vm.tools.info The info structure describes the VMWare Tools properties of a virtual machine. This structure was added in vSphere API 7.0.0.
vcenter.vm.tools.update_spec The (@name UpdateSpec} structure describes the VMware Tools properties of a virtual machine that can be updated. This structure was added in vSphere API 7.0.0.

installer

The installer (@term service} provides operations to install VMware Tools in the guest operating system. This service was added in vSphere API 7.0.0.
Type Description
vcenter.vm.tools.installer.info The info structure contains information about the VMWare Tools installer. This structure was added in vSphere API 7.0.0.

vcenter vm template

The vcenter.vm_template API provides structures and services that will let its client manage VMTX template in Content Library.

vcenter vm template library items

The vcenter.vm_template.library_items API provides structures and services for managing virtual machine template library items. This includes operations for checking out virtual machine template library items and querying previous versions of checked in virtual machines.

library items

The library_items service provides operations to deploy virtual machines from library items containing virtual machine templates, as well as operations to create library items containing virtual machine templates. The library_items service also provides an operation to retrieve information about the template contained in the library item. This service was added in vSphere API 6.8.
Type Description
vcenter.vm_template.library_items.cpu_info The cpu_info structure contains CPU related information about the virtual machine template. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.cpu_update_spec The cpu_update_spec structure describes updates to the CPU configuration of the deployed virtual machine. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.create_placement_spec The create_placement_spec structure contains information used to place a virtual machine template onto resources within the vCenter inventory. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.create_spec The create_spec structure defines the information required to create a library item containing a virtual machine template. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.create_spec_disk_storage The create_spec_disk_storage structure defines the storage specification for a virtual machine template's disks. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.create_spec_disk_storage_policy The create_spec_disk_storage_policy structure defines the storage policy specification for a virtual machine template's disks. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.create_spec_vm_home_storage The create_spec_vm_home_storage structure defines the storage specification for a virtual machine template's configuration and log files. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.create_spec_vm_home_storage_policy The create_spec_vm_home_storage_policy structure defines the storage policy specification for a virtual machine template's configuration and log files. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.deploy_placement_spec The deploy_placement_spec structure contains information used to place a virtual machine onto resources within the vCenter inventory. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.deploy_spec The deploy_spec structure defines the deployment parameters that can be specified for the deploy operation. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.deploy_spec_disk_storage The deploy_spec_disk_storage structure contains the storage specification for disks in the virtual machine. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.deploy_spec_disk_storage_policy The deploy_spec_disk_storage_policy structure describes the storage policy specification for the deployed virtual machine's disks. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.deploy_spec_vm_home_storage The deploy_spec_vm_home_storage structure defines the storage specification for a deployed virtual machine's configuration and log files. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.deploy_spec_vm_home_storage_policy The deploy_spec_vm_home_storage_policy structure defines the storage policy specification for the deployed virtual machine's configuration and log files. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.disk_info The disk_info structure contains information about the virtual machine template's virtual disk. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.disk_storage_info The disk_storage_info structure contains storage related information about a virtual machine template's virtual disk. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.disk_update_spec The disk_update_spec structure describes updates to the configuration of a virtual disk in the deployed virtual machine. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.ethernet_info The ethernet_info structure contains information about a virtual machine template's virtual Ethernet adapter. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.ethernet_update_spec The ethernet_update_spec structure describes the network that the ethernet adapter of the deployed virtual machine should be connected to. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.guest_customization_spec The guest_customization_spec structure contains information required to customize the deployed virtual machine. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.hardware_customization_spec The hardware_customization_spec structure defines the hardware customization options that are applied to the deployed virtual machine. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.info The info structure contains information about a virtual machine template item in content library. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.memory_info The memory_info structure contains memory related information about the virtual machine template. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.memory_update_spec The memory_update_spec structure describes updates to the memory configuration of the deployed virtual machine. This structure was added in vSphere API 6.8.
vcenter.vm_template.library_items.vm_home_storage_info The vm_home_storage_info structure contains storage information about the virtual machine template's configuration and log files. This structure was added in vSphere API 6.8.

check outs

The check_outs service provides operations for managing the checkouts of a library item containing a virtual machine template. This service provides operations to check out a library item to update the virtual machine template, and to check in the library item when the virtual machine changes are complete. This service was added in vSphere API 6.9.1.
Type Description
vcenter.vm_template.library_items.check_outs.check_in_spec The check_in_spec structure defines the information required to check in a virtual machine into a library item. This structure was added in vSphere API 6.9.1.
vcenter.vm_template.library_items.check_outs.check_out_spec The check_out_spec structure defines the information required to check out a library item containing a virtual machine template. This structure was added in vSphere API 6.9.1.
vcenter.vm_template.library_items.check_outs.info The info structure contains information about a checked out virtual machine. This structure was added in vSphere API 6.9.1.
vcenter.vm_template.library_items.check_outs.placement_spec The placement_spec structure contains information used to place a checked out virtual machine onto resources within the vCenter inventory. The specified compute resource should have access to the storage associated with the checked out virtual machine. This structure was added in vSphere API 6.9.1.
vcenter.vm_template.library_items.check_outs.summary The summary structure contains commonly used information about a checked out virtual machine. This structure was added in vSphere API 6.9.1.

versions

The versions service provides operations for managing the live versions of the virtual machine templates contained in a library item. Live versions include the latest and previous virtual machine templates that are available on disk. As new versions of virtual machine templates are checked in, old versions of virtual machine templates are automatically purged. Currently, at most one previous virtual machine template version is stored. This service was added in vSphere API 6.9.1.
Type Description
vcenter.vm_template.library_items.versions.info The info structure contains information about a version of a library item containing a virtual machine template. This structure was added in vSphere API 6.9.1.
vcenter.vm_template.library_items.versions.rollback_spec The rollback_spec structure defines the information required to rollback a virtual machine template library item to a previous version. This structure was added in vSphere API 6.9.1.
vcenter.vm_template.library_items.versions.summary The summary structure contains commonly used information about a version of a library item containing a virtual machine template. This structure was added in vSphere API 6.9.1.

vstats

The vstats component provides API services and types used in the vStats service.
Type Description
vstats.cid_mid The cid_mid structure is used to designate a counter. It contains a counter id that identifies the semantical counter. There is optional metadata identifier that identifies the particular generation of the counter. When counter metadata is not designated vStats will use a default for the counter metadata. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.rsrc_id The rsrc_id structure specifies identification of a resource to be monitored by an acquisition specification record. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.user_info The user_info structure contains human legible, localizable description, used for VMware provided objects. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

acq specs

The acq_specs service provides operations to perform acquisition specification related operations. An acquisition specification defines the statistical data that should be collected at desired sampling rates from the underlying providers. It designates the resources and their counters which should be sampled, and a desired sampling rate. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vstats.acq_specs.counter_spec The counter_spec structure designates a counter or counter set in an acquisition specification. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.acq_specs.create_spec The create_spec structure contains information for a new data acquisition specification. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.acq_specs.filter_spec The filter_spec structure contains fields used to filter the results when listing acquisition specifications. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.acq_specs.info The info structure is the information about an acquisition specification. It specifies the statistical data that should be collected at desired sampling rates. It designates the resources and their counters which should be sampled, and a desired sampling rate. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.acq_specs.list_result The list_result structure contains fields used to return the acquisition specifications. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.acq_specs.update_spec The update_spec structure contains fields that can be updated in an acquisition specification. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

counter metadata

The counter_metadata service provides access to the different historical editions of counters. As computing platforms evolve over time the measurement units for different characteristics of the systems change. As such changes occur, counters will receive different editions reflected in a new metadata record. For example computer memory had changes from kilobytes through megabytes into gigabytes. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vstats.counter_metadata.filter_spec The filter_spec structure is used to filter the counter metadata list. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.counter_metadata.info The info structure contains information about CounterMetadata. It represents edition of the Counter. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

counter sets

The counter_sets service provides operations for accessing groupings of counters. Counter-sets allow consumers to use groups of counters. The counters may relate to different resource types. When an vstats.acq_specs record refers to a counter-set, only the relevant counters apply. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vstats.counter_sets.info The info structure contains information about a set of counters. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

counters

The counters service provides operations to perform various Counter related operations. Counter is derived from metric. It applies the metric to a particular class of a resource. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vstats.counters.filter_spec The filter_spec structure contains fields that can be used to filter list of counters. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.counters.info The info structure contains the counter information. Counter is derived from metric. It applies the metric to a particular class of a resource. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

data

The data service provides operations to query measurement and statistic data. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vstats.data.data_point The data_point structure is an instance of a measurement or stat. A data point is comprised of a Counter, CounterMetadata, Resource, timestamp and value. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.data.data_points_result The data_points_result structure contains fields used to return DataPoints. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.data.filter_spec The filter_spec structure contains fields used to filter the results when listing DataPoint. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

metrics

The metrics service provides operation to list metrics. A metric is a fundamental concept. It means a measurable aspect or property. For instance, temperature, count, velocity, data size, bandwidth. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vstats.metrics.summary The summary structure contains metric summary. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

providers

The providers service manages list of statistical data provider services that are currently used. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vstats.providers.summary summary structure describes a statistical data provider. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

resource address schemas

The resource_address_schemas service manages inventory of resource addressing schemas used by vstats.counters. Each schema consists of a named list of resource identifiers of specific resource type. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vstats.resource_address_schemas.info The info structure defines addressing schema for a counter. This is set of named placeholders for different resource types. For example a network link between VMs will take two arguments "source" and "destination" both of type VM. For each argument query capability is defined. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.resource_address_schemas.resource_id_definition The resource_id_definition structure describes a single identifier of the Resource Addressing Schema. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

resource addresses

The resource_addresses service provides operations to perform resource addressing queries. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vstats.resource_addresses.filter_spec filter_spec structure describes filter criteria for resource addresses. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.resource_addresses.info The info structure contains global address of a specific Resource. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
vstats.resource_addresses.list_result The vstats.resource_addresses.list_result structure contains fields used to return the resource addresses. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

resource types

The resource_types service provides list of resource types. Resource refers to any item or concept that could have measurable properties. It is a prerequisite that a resource can be identified.

Example resource types are virtual machine, virtual disk etc.

. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Type Description
vstats.resource_types.summary The summary structure contains information of addressable resource. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.