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.
appliance configuration
The appliance.configuration API provides services to manage profile spec for the appliance
| Type |
Description |
| appliance.configuration.compliance_result |
The compliance_result structure defines the information about drift results. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.component_info |
The component_info structure defines the information about component. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.diff_result |
The diff_result structure defines the information about the setting. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.diff_values |
The diff_values structure defines the information about modified and current value of the property. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.impact |
The impact structure contains fields that describe what the impact is of a particular step during the apply operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.notification |
The notification structure contains fields to describe any info/warning/error messages that Tasks can raise. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.notifications |
The notifications structure contains info/warning/error messages that can be reported be the task. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.profile_compliance |
The profile_compliance structure contains fields to describe the compliance result of a appliance. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.task_info |
The task_info structure contains information about a task. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.validate_result |
The validate_result structure contains fields that describe what the validate results of an appliance. operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
desired state
The desired_state service provides operations to manage desired configuration specification of an appliance. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| appliance.configuration.desired_state.commit_spec |
The commit_spec structure contains fields that are used to create a new commit. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.desired_state.create_spec |
The create_spec structure defines the information used to create a profile. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.desired_state.export_spec |
The export_spec structure represents a spec information for export operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.desired_state.filter_spec |
The filter_spec structure contains fields used to filter the results when listing profile configuration. See list. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.desired_state.import_spec |
The import_spec structure represents a spec information for Import operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.desired_state.metadata |
The metadata structure defines the metadata information about profile. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.desired_state.profile_info |
The profile_info structure represents a information about the desired profile. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.desired_state.profile_spec |
The profile_info structure represents a information of the profile configuration. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.configuration.desired_state.summary |
The summary structure defines the summary information about profile configuration. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
environment
The environment service provides operations to get and set appliance environment. This service was added in vSphere API 6.7.
| Type |
Description |
| appliance.environment.config |
The config structure describes the configurable settings for the appliance environment. This structure was added in vSphere API 6.7. Note: This structure is restricted for VMware internal use only. |
| appliance.environment.display |
The display structure contains information what needs to be displayed in the user interface. This structure was added in vSphere API 6.7. Note: This structure is restricted for VMware internal use only. |
| appliance.environment.info |
The info structure contains the information about the appliance environment. This structure was added in vSphere API 6.7. Note: This structure is restricted for VMware internal use only. |
appliance health
The appliance.health API provides services for reporting the health of the various subsystems of the the appliance. The API is available starting in vSphere 6.5.
database
The database service provides operations to retrieve the health status of the vcdb. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| appliance.health.database.info |
The info structure contains information about the health of the the database. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.health.database.message |
The message structure contains a database health message along with its severity. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
health check settings
The health_check_settings service provides operations to enable/disable health check settings in vCenter Server. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| appliance.health_check_settings.setting_spec |
setting_spec structure contains specification of vCenter Server health and its corresponding state. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.health_check_settings.update_spec |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
appliance infraprofile
The appliance.infraprofile API provides services to manage profile spec for the appliance
configs
configs service provides operations to manage desired configuration specification of an appliance.
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.
policy
The policy service provides operations to manage local user accounts. This service 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.
monitoring
monitoring service provides operations Get and list monitoring data for requested item.
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.
servers
servers service provides operations DNS server configuration.
appliance networking firewall
inbound
The inbound service provides operations to manage inbound firewall rules. This service was added in vSphere API 6.7.1.
appliance networking interfaces
interfaces
interfaces service provides operations Provides information about network interface.
ipv4
The ipv4 service provides operations to perform IPv4 network configuration for interfaces. This service 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.
routes
routes service provides operations Performs networking routes operations. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| appliance.networking.routes.config |
config structure Structure that describes how routing is performed for a particular destination and prefix. A destination/prefix of 0.0.0.0/0 ( for IPv4) or ::/0 (for IPv6) refers to the default gateway. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.networking.routes.info |
info structure Structure that describes how routing is performed for a particular destination and prefix. A destination/prefix of 0.0.0.0/0 ( for IPv4) or ::/0 (for IPv6) refers to the default gateway. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.networking.routes.route_status |
route_status structure Test result and message. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.networking.routes.test_status |
test_status structure Overall test result. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
ntp
ntp service provides operations Gets NTP configuration status and tests connection to ntp servers. This service 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
appliance recovery backup job
job
The job service provides operations to be performed on a backup job.
details
The details service provides operations to get the details about backup jobs. This service was added in vSphere API 6.7.
parts
parts service provides operations Provides list of parts optional for the backup
schedules
The schedules service provides operations to be performed to manage backup schedules. This service 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.
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.
appliance recovery restore
restore
restore service provides operations Performs restore operations
job
job service provides operations Performs restore operations
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. |
support bundle
The support_bundle service provides operations to create support bundle task, cancel, list and list components. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| appliance.support_bundle.create_spec |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.support_bundle.filter_spec |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.support_bundle.info |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.support_bundle.iteration_spec |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.support_bundle.list_result |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
appliance system
The appliance.system API provides services to query the appliance system information. The API is available starting in vSphere 6.5.
appliance system security
global fips
The global_fips service provides operations to enable/disable appliance FIPS mode.
global fips internal
The global_fips_internal service provides operations to get appliance FIPS mode by internal services.
storage
storage service provides operations Appliance storage configuration
time
time service provides operations Gets system time.
version
version service provides operations Get the appliance version.
appliance techpreview
appliance techpreview localaccounts
user
user service provides operations Perform operations on local user account.
appliance techpreview monitoring
snmp
snmp service provides operations SNMP agent operations.
| Type |
Description |
| appliance.techpreview.monitoring.snmp.SNM_pv1_trap_target |
SNM_pv1_trap_target structure Structure that defines an SNMP v1/v2c trap target. Note: This structure is restricted for VMware internal use only. |
| appliance.techpreview.monitoring.snmp.SNM_pv3_target |
SNM_pv3_target structure Structure that defines an SNMP v3 inform or trap target. Note: This structure is restricted for VMware internal use only. |
| appliance.techpreview.monitoring.snmp.SNMP_config |
SNMP_config structure Structure that defines the SNMP configuration, provided as input to set(), and never the result of get(). See SNMPConfigReadOnly. This structure is used to configure SNMP v1, v2c, and v3. Note: This structure is restricted for VMware internal use only. |
| appliance.techpreview.monitoring.snmp.SNMP_config_read_only |
SNMP_config_read_only structure Structure that defines the SNMP configuration, the result of get(), and never provided as input to set(). This structure differs from SNMPConfig because it contains localized keys (as defined in http://tools.ietf.org/html/rfc3826#section-1.2), instead of raw secret strings. This structure can be used to configure SNMP v1, v2c, and v3. Keep this structure in sync with vmw_snmp.py:_default_config(). Note that if a field if left empty, it is considered unset and will be ignored. Existing array elements below can be unset by sending an element with the string 'reset'. Note: This structure is restricted for VMware internal use only. |
| appliance.techpreview.monitoring.snmp.SNMP_hash_config |
SNMP_hash_config structure Structure to provide up to two secrets to combine with the SNMPv3 engine ID and authentication or privacy protocol to form a localized hash. auth_hash is always required, priv_hash can be empty. By default arguments are paths on the local filesystem, raw_secret takes path to be the actual raw secret. First implementation was in ESXi: esxcli system snmp hash --help Note: This structure is restricted for VMware internal use only. |
| appliance.techpreview.monitoring.snmp.SNMP_hash_results |
SNMP_hash_results structure Structure to provide operators diagnostics test results. Note: This structure is restricted for VMware internal use only. |
| appliance.techpreview.monitoring.snmp.SNMP_limits |
SNMP_limits structure Structure that provides various limits of the SNMP agent. Note: This structure is restricted for VMware internal use only. |
| appliance.techpreview.monitoring.snmp.SNMP_remote_user |
SNMP_remote_user structure Structure that defines a user at particular remote SNMPv3 entity needed when using informs. auth_key and priv_key contained localized keys as defined in http://tools.ietf.org/html/rfc3826#section-1.2. Note: This structure is restricted for VMware internal use only. |
| appliance.techpreview.monitoring.snmp.SNMP_stats |
SNMP_stats structure Structure to provide operators diagnostics on snmp agent itself. Note: This structure is restricted for VMware internal use only. |
| appliance.techpreview.monitoring.snmp.SNMP_test_results |
SNMP_test_results structure Structure to provide operators diagnostics test results. Note: This structure is restricted for VMware internal use only. |
| appliance.techpreview.monitoring.snmp.SNMP_user |
SNMP_user structure Structure that defines information associated with an SNMP user. authKey and privKey are localized keys defined in http://tools.ietf.org/html/rfc3826#section-1.2. Note: This structure is restricted for VMware internal use only. |
appliance techpreview networking
appliance techpreview networking firewall addr
inbound
inbound service provides operations Operations for firewall rules.
ipv4
ipv4 service provides operations Performs IPV4 network configuration for interfaces.
ipv6
ipv6 service provides operations Performs IPV4 network configuration for interfaces.
routes
routes service provides operations Performs networking routes operations.
services
services service provides operations Manages services.
| Type |
Description |
| appliance.techpreview.services.service_info |
service_info structure Structure that describes a service and the operations you can perform on a service. Note: This structure is restricted for VMware internal use only. |
appliance techpreview system
update
update service provides operations Performs update repository configuration.
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. |
history
The history service provides operations to get update history. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| appliance.update.history.info |
The info structure contains detailed information about the installed updates. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.update.history.summary |
The summary structure contains information about the installed updates. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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 vcenter settings v1
The appliance.vcenter.settings.v1 API provides services to manage the ConfigManagement.
| Type |
Description |
| appliance.vcenter.settings.v1.check_result |
The check_result structure contains fields that describe the precheck results of an appliance. operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.vcenter.settings.v1.compliance_result |
The compliance_result structure defines the information about scan results. 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. |
| appliance.vcenter.settings.v1.desired_state |
The desired_state structure defines the configuration about different components in vCenter. 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. |
| appliance.vcenter.settings.v1.diff_result |
The diff_result structure defines the information about the feature configuration. 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. |
| appliance.vcenter.settings.v1.impact |
The impact structure contains fields that describe the impact during apply. operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.vcenter.settings.v1.notification |
The notification structure contains fields to describe any info/warning/error messages that Tasks can raise. 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. |
| appliance.vcenter.settings.v1.notifications |
The notifications structure contains info/warning/error messages that can be reported be the task. 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. |
| appliance.vcenter.settings.v1.scan_result |
The scan_result structure contains fields to describe the scan result of a appliance. 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. |
| appliance.vcenter.settings.v1.task_info |
The task_info structure contains information about a task. 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. |
appliance vcenter settings v1 config
The appliance.vcenter.settings.v1.config API provides services to manage the ConfigManagement.
config
The config service provides operations to manage desired configuration specification of vCenter.
| Type |
Description |
| appliance.vcenter.settings.v1.config.apply_result |
The apply_result structure contains fields that describe the result of an apply operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.vcenter.settings.v1.config.apply_spec |
The apply_spec structure contains fields that describe desired profile apply specification for vCneter. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| appliance.vcenter.settings.v1.config.create_spec |
The create_spec structure contains the specification required to create a profile in vCenter. the spec contains fields that describe information about the profile. 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. |
| appliance.vcenter.settings.v1.config.info |
The info structure represents information about the config profile. the spec contains fields that describe information about the profile. 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. |
| appliance.vcenter.settings.v1.config.scan_spec |
The scan_spec structure contains the specification required for compliance check against the vCenter current config state. 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. |
| appliance.vcenter.settings.v1.config.set_spec |
The UpdateSpec structure describes the updates to profile settings of vCenter. the spec contains fields that describe service information about the profile. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
appliance vcenter settings v1 config components applmgmt
appliance vcenter settings v1 config components authmanagement
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.
cdc
The cdc API provides services to listen for resource life-cycle or model changes. The API is available starting in vSphere 6.5.
change log
A fully-ordered, read-only log of resource change events. Clients can use it to listen for resource life-cycle or model changes that occur in the system. A client can request all changes that have occurred since its previous change request by providing the sequence token obtained from the result of the previous change request.
| Type |
Description |
| cdc.change_log.change_event |
Holds information about a single resource change that has been captured, e.g. resource creation/deletion or resource model update. Note: This structure is restricted for VMware internal use only. |
| cdc.change_log.change_list |
Contains a list of ordered resource change events that have been captured in response to a call to get_changes method. Note: This structure is restricted for VMware internal use only. |
cis
The cis API provides VMware common infrastructure services.
cis data
The cis.data API provides services for uniform data access to the resource model data of the CIS services. The API is available starting in vSphere 6.5.
cis data provider
The cis.data.provider API provides services for uniform data access to the resource model data of a Data Provider. The API is available starting in vSphere 6.5.
Provides access to the resource model schema of a Data Provider. The schema describes all resource models supported by the provider as well as information about the model properties and how they could be queried. This schema describes all resource models that could be queried via the cis.data.provider.resource_model interface. Hence, any Data Provider that implements the latter must also implement this interface in order to expose its resource model schema.
resource model
Represents a uniform data access interface to the resource model data of a Data Provider. Provides a convenient API for search and retrieval of specific projections on the targeted resource model data. Clients can use this interface to navigate through the data provider's inventory using filtering by various resource model property criteria. Every VMODL2 Data Provider must implement this interface as well as cis.data.provider.metadata.schema interface. The latter is used to advertise the schema of the resource models that could be queried.
| Type |
Description |
| cis.data.provider.resource_model.filter |
Specifies the filter criteria that each resource model should satisfy in order to qualify for the final result set for a given query. Note: This structure is restricted for VMware internal use only. |
| cis.data.provider.resource_model.property_predicate |
A condition on a resource model property. Matches all instances of the resource models listed in cis.data.provider.resource_model.query_spec.resource_models that have a property which satisifes this condition. Note: This structure is restricted for VMware internal use only. |
| cis.data.provider.resource_model.query_spec |
A query which encapsulates a request for specific resource model data. It supports filtering the resource model data to return by specifying conditions on the targeted resource model properties as well as retrieval of arbitrary number of properties or sub-properties of the resource models that satisfy the filter criteria. Also, it allows for sorting and limiting the final result set. Each query has the following main constituents: - Property List: specifies the list of property values to be returned in the result set for the query. Corresponds to the
SELECT clause in SQL. - Resource Model List: specifies one or multiple resource models (for the same resource type) that should be queried. Corresponds to the
FROM clause in SQL. - Filter: restricts (filters) the set of resource models whose properties should be returned based on conditions/predicates on their property values. Corresponds to the
WHERE clause in SQL. - Sort Criteria: defines how the final result set should be sorted by comparing the values of one or more properties of the items in the result set. Corresponds to the
ORDER BY clause in SQL. - Limit: limits the number of items from the final sorted result set that should be returned to the client.
Note: This structure is restricted for VMware internal use only. |
| cis.data.provider.resource_model.resource_item |
Contains the data returned for a single resource, which corresponds to a single item in the result set. Represents the result of a projection onto the public state of the resource model data of the given resource. Note: This structure is restricted for VMware internal use only. |
| cis.data.provider.resource_model.result_set |
Contains the data returned in response to a particular query instance. Note: This structure is restricted for VMware internal use only. |
| cis.data.provider.resource_model.sort_criterion |
Determines how a list of result items should be sorted by the values of one or more properties that belong to the models associated with the resources that the result items represent. Note: This structure is restricted for VMware internal use only. |
resource model
Represents a uniform data access interface to the resource model data of the CIS services. Provides a convenient API for search and retrieval of specific projections on the targeted resource model data. Clients can use this interface to navigate through the CIS inventory by using filters, i.e. one or a combination of multiple predicates (conditions) on the targeted resource models properties.
| Type |
Description |
| cis.data.resource_model.filter |
Specifies the filter criteria that each resource model should satisfy in order to qualify for the final result set for a given query. Note: This structure is restricted for VMware internal use only. |
| cis.data.resource_model.property_predicate |
A condition on a resource model property. Matches all instances of the resource models listed in cis.data.resource_model.query_spec.resource_models that have a property which satisifes this condition. Note: This structure is restricted for VMware internal use only. |
| cis.data.resource_model.query_spec |
A query which encapsulates a request for specific resource model data. It supports filtering the resource model data to return by specifying conditions on the targeted resource model properties as well as retrieval of arbitrary number of properties or sub-properties of the resource models that satisfy the filter criteria. Also, it allows for sorting and limiting the final result set. Each query has the following main constituents: - Property List: specifies the list of property values to be returned in the result set for the query. Corresponds to the
SELECT clause in SQL. - Resource Model List: specifies one or multiple resource models (for the same resource type) that should be queried. Corresponds to the
FROM clause in SQL. - Filter: restricts (filters) the set of resource models whose properties should be returned based on conditions/predicates on their property values. Corresponds to the
WHERE clause in SQL. - Sort Criteria: defines how the final result set should be sorted by comparing the values of one or more properties of the items in the result set. Corresponds to the
ORDER BY clause in SQL. - Page Specification: specifies what portion of the final sorted result set should be returned to the client. Defined by a combination of two fields: #offset and #limit.
Note: This structure is restricted for VMware internal use only. |
| cis.data.resource_model.resource_item |
Contains the data returned for a single resource, which corresponds to a single item in the result set. Represents the result of a projection onto the public state of the resource model data of the given resource. Note: This structure is restricted for VMware internal use only. |
| cis.data.resource_model.result_set |
Contains the data returned in response to a particular query instance. Note: This structure is restricted for VMware internal use only. |
| cis.data.resource_model.sort_criterion |
Determines how a list of result items should be sorted by the values of one or more properties that belong to the models associated with the resources that the result items represent. Note: This structure is restricted for VMware internal use only. |
cis data svc
The cis.data.svc API provides services for uniform data access to the resource model data of the CIS services. The API is available starting in vSphere 6.5.
resource model
Represents a uniform data access interface to the resource model data of the CIS services. Provides a convenient API for search and retrieval of specific projections on the targeted resource model data. Clients can use this interface to navigate through the CIS inventory by using filters, i.e. one or a combination of multiple predicates (conditions) on the targeted resource models properties.
| Type |
Description |
| cis.data.svc.resource_model.filter |
Specifies the filter criteria that each resource model should satisfy in order to qualify for the final result set for a given query. Note: This structure is restricted for VMware internal use only. |
| cis.data.svc.resource_model.property_predicate |
A condition on a resource model property. Matches all instances of the resource models listed in cis.data.svc.resource_model.query_spec.resource_models that have a property which satisifes this condition. Note: This structure is restricted for VMware internal use only. |
| cis.data.svc.resource_model.query_spec |
A query which encapsulates a request for specific resource model data. It supports filtering the resource model data to return by specifying conditions on the targeted resource model properties as well as retrieval of arbitrary number of properties or sub-properties of the resource models that satisfy the filter criteria. Also, it allows for sorting and limiting the final result set. Each query has the following main constituents: - Property List: specifies the list of property values to be returned in the result set for the query. Corresponds to the
SELECT clause in SQL. - Resource Model List: specifies one or multiple resource models (for the same resource type) that should be queried. Corresponds to the
FROM clause in SQL. - Filter: restricts (filters) the set of resource models whose properties should be returned based on conditions/predicates on their property values. Corresponds to the
WHERE clause in SQL. - Sort Criteria: defines how the final result set should be sorted by comparing the values of one or more properties of the items in the result set. Corresponds to the
ORDER BY clause in SQL. - Limit: limits the number of items from the final sorted result set that should be returned to the client.
Note: This structure is restricted for VMware internal use only. |
| cis.data.svc.resource_model.resource_item |
Contains the data returned for a single resource, which corresponds to a single item in the result set. Represents the result of a projection onto the public state of the resource model data of the given resource. Note: This structure is restricted for VMware internal use only. |
| cis.data.svc.resource_model.result_set |
Contains the data returned in response to a particular query instance. Note: This structure is restricted for VMware internal use only. |
| cis.data.svc.resource_model.sort_criterion |
Determines how a list of result items should be sorted by the values of one or more properties that belong to the models associated with the resources that the result items represent. Note: This structure is restricted for VMware internal use only. |
session
The session service allows API clients to manage session tokens including creating, deleting and obtaining information about sessions.
- The create operation creates session token in exchange for another authentication token.
- The delete operation invalidates a session token.
- The get retrieves information about a session token.
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:
- Connect to lookup service.
- Discover the secure token service (STS) endpoint URL.
- Connect to the secure token service to obtain a SAML token.
- Authenticate to the lookup service using the obtained SAML token.
- Discover the API endpoint URL from lookup service.
- Call the create operation. The create call must include the SAML token.
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:
- Call to the delete operation.
- The session expires. Session expiration may be caused by one of the following situations:
- Client inactivity - For a particular session identified by client requests that specify the associated session ID, the lapsed time since the last request exceeds the maximum interval between requests.
- Unconditional or absolute session expiration time: At the beginning of the session, the session logic uses the SAML token and the system configuration to calculate absolute expiration time.
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.
batch
The batch service provides operations to query category, tag, and tag association information in batch. All operations return successfully. Error or insufficient privilege on an individual object will not result in a thrown exception, instead it will just be skipped. This service was added in vSphere API 6.5.
cis tagging category
The com.vmware.cis.category API provides services for managing tag categories.
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. |
host
The host service provides operations to list categories that have hosts as an attachable type. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| cis.tagging.category.host.summary |
The summary structure contains commonly used information about a category that has host as an attachable type. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
VM
The VM service provides operations to list categories that have virtual machines as an attachable type. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| cis.tagging.category.VM.summary |
The summary structure contains commonly used information about a category that has virtual machine as an attachable type. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
cis tagging tag
The com.vmware.cis.tag API provides services for managing tags.
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. |
host
The host service provides operations to list tags that can be attached to hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| cis.tagging.tag.host.summary |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
VM
The VM service provides operations to list tags that can be attached to virtual machines. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| cis.tagging.tag.VM.summary |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
tag association
The tag_association service provides operations to attach, detach, and query tags.
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.
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.
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.
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.
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.
tagging
A service for managing tags on library items. A library item can be tagged by one or multiple key/value pairs. These can be used to add extra information to the library item. Library item tags will be replicated through the VCSP protocol. If a library item belongs to a published library, the subscribed library item will have the same tags once a sync happens. Note that tags cannot be set on library items that are part of a subscribed library.
| Type |
Description |
| content.library.item.tagging.info |
Defines a key/value pair that can be associated with a library item Note: This structure is restricted for VMware internal use only. |
content library item updatesession
The Content Library Item Update Session API provides structures and services for updating files in a session.
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:
- deleting an existing file within the library item. This deletes both the metadata and the content.
- updating an existing file with new content.
- adding a new file to the library item.
The above changes are not applied or visible until the session is completed. See content.library.item.update_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
content type ovf policy
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.
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.
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.
esx attestation report
The esx.attestation.report API provides services to manage remote attestation report request.
| Type |
Description |
| esx.attestation.report.attest_request |
The attest_request structure contains information used to specify an attestation report request. Note: This structure is restricted for VMware internal use only. |
| esx.attestation.report.attest_result |
The attest_result structure contains the result of an attestation report request. Note: This structure is restricted for VMware internal use only. |
| esx.attestation.report.document |
The document structure contains an attestation report document. Note: This structure is restricted for VMware internal use only. |
| esx.attestation.report.tpm2_identity |
The tpm2_identity structure contains a unique TPM 2.0 identifier for the remote host. Note: This structure is restricted for VMware internal use only. |
| esx.attestation.report.tpm2_request |
The tpm2_request structure contains information used to specify an attestation report request using the TPM 2.0 protocol. Note: This structure is restricted for VMware internal use only. |
| esx.attestation.report.tpm2_result |
The tpm2_result structure contains the result of an attestation report request using the TPM 2.0 protocol. Note: This structure is restricted for VMware internal use only. |
status
The status service provides operations to get the attestation service health status.
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.
endorsement keys
The endorsement_keys service provides operations to manage Trusted Platform Module (TPM) Endorsement Keys (EK).
settings
The settings service provides operations to get or update settings related to the TPM 2.0 attestation protocol behavior.
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, or a privilege specification. Only one of the subject types can be specified. The filter is applied 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, or a privilege specification, 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.
- A privilege specification defines matching to external JWT claim 'privs'.
|
| 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.
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.
esx gdp
The esx.gdp API provides services to manage and use the Guest Data Publisher Service.
| Type |
Description |
| esx.gdp.application_publish_result |
The application_publish_result structure constains fields used to specify a guest application published datum from a virtual machine. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.gdp.publish_result |
The publish_result structure constains fields used to specify a published datum from a guest virtual machine. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
guest data
The guest_data service provides operations to get guest data published from a set of virtual machines on a set of topics. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.gdp.guest_data.filter_spec |
The filter_spec structure constains fields used to specify a subscription for interested virtual machines and topics. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.gdp.guest_data.vm_filter_spec |
The vm_filter_spec structure contains fields used to specify a virtual machine to get data from. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
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.
esx hcl hosts
compatibility releases
This service provides operations to list 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.
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 health
The esx.health API provides services to query the ESX health respective to its target state.
| Type |
Description |
| esx.health.check_info |
Combines information about a health check and the issues that it can report. Note: This structure is restricted for VMware internal use only. |
| esx.health.check_spec |
Defines the context of a health check query. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
| esx.health.check_status |
Represents a check status. Note: This structure is restricted for VMware internal use only. |
| esx.health.connection_spec |
A class containing all the data needed to establish a connection to a given ESXi host. Note: This structure is restricted for VMware internal use only. |
| esx.health.status_info |
Represents the aggregated status of a single entity. Note: This structure is restricted for VMware internal use only. |
| esx.health.target_spec |
Captures the target desired specification for a host or cluster. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
esx health clusters
| Type |
Description |
| esx.health.clusters.check_spec |
Defines the context for a cluster-level health query. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
esx health hosts
| Type |
Description |
| esx.health.hosts.check_spec |
Defines the context for a host-level health query. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
| esx.health.hosts.target_spec |
A target desired specification for a HOST. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
esx health perspectives
credentials
This service provides operations for configuring the credentials that EHP will use when communicating with other services. This service was added in vSphere API 7.0.1.0.
| Type |
Description |
| esx.health.perspectives.credentials.nsx_connection_spec |
The nsx_connection_spec structure contains fields to describe information to connect to an NSX Manager. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
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.
esx kms
The esx.kms API provides services to manage the vSphere Trust Authority Key Provider Service.
key operation
The key_operation service provides operations to encrypt and decrypt data using a key that is provisioned for a Key Provider.
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.
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.
csr
The csr service provides operations to create a certificate signing request(CSR).
credential
The credential service provides operations to add a credential for key management server(s).
| Type |
Description |
| esx.kms.providers.credential.info |
The info structure contains fields that describe a key server credential. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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.
remote
The remote service provides operations to retrieve remote key server certificate.
status
The status service provides status of a Key Provider.
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.
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.
configuration
The configuration service provides operations to manage desired configuration of an ESX cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.clusters.configuration.apply_result |
The apply_result structure contains fields that describe the result of an apply operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| esx.settings.clusters.configuration.apply_spec |
The apply_spec structure contains fields that describe the specification to be used for applying the desired configuration to a cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| esx.settings.clusters.configuration.apply_status |
The apply_status structure contains fields that describe the status of an apply operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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.
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.
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-2020 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-2020 VMware, Inc. All rights reserved. VMware Confidential Copyright 2019-2020 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.
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.
reset info
The reset_info service provides internal operations to identify the outcome when configured policies esx.settings.clusters.policies.apply.configured_policy_spec are reset.
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.
commits
The commits service provides operations to manage committed changes to desired software document.
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.
drafts internal
The drafts service provides internal operations to manage working copy of software documents.
ha internal
The ha_internal service provides operations to manage desired software state for HA solution on an ESX cluster.
recommendations
The recommendations service provides operations to manage the generation and retrieval of recommended image specs.
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.
apply impact
The apply_impact service provides operations to get the impact of an apply operation on a cluster.
hardware compatibility
The hardware_compatibility service provides operations to manage HCL Validation of a software specification of an ESX cluster.
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.
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.
esx settings clusters software solutions
The esx.settings.clusters.software.solutions API provides services to manage desired state software for ESXi cluster solutions.
esx settings clusters software solutions nsx
The esx.settings.clusters.software.solutions.nsx API provides services to manage desired state software for NSX solution on ESXi cluster.
nsx internal
The nsx_internal interface service provides operations to manage desired software state for the NSX solution on an ESX cluster. This service was added in vSphere API 7.0.1.0.
solutions internal
The solutions_internal service provides operations to manage a solution desired software specifications for an ESX cluster. This service was added in vSphere API 7.0.1.0.
esx settings defaults clusters policies
Copyright 2019-2020 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-2020 VMware, Inc. All rights reserved. VMware Confidential Copyright 2019-2020 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.
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.
reset info
The reset_info service provides internal operations to identify the outcome when configured policies esx.settings.defaults.clusters.policies.apply.configured_policy_spec are reset.
esx settings defaults hosts policies
The esx.settings.defaults.hosts.policies API provides services to manage the default policies that affect management of desired state configuration and software for ESXi hosts. Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential
esx settings defaults hosts policies apply
The esx.settings.defaults.hosts.policies.apply API provides services to manage the policies that affect application of desired state configuration and software for ESXi hosts. 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 hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.defaults.hosts.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 hosts. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| esx.settings.defaults.hosts.policies.apply.failure_action |
The failure_action structure contains fields that describe the actions to be taken when entering maintenance mode fails on an ESXi host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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 hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.defaults.hosts.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 hosts. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| esx.settings.defaults.hosts.policies.apply.effective.failure_action |
The failure_action structure contains fields that describe the actions to be taken when entering maintenance mode fails on an ESXi host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
reset info
The reset_info service provides internal operations to identify the outcome when configured policies esx.settings.defaults.hosts.policies.apply.configured_policy_spec are reset. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.defaults.hosts.policies.apply.reset_info.configured_policy_reset_info |
The configured_policy_reset_info structure contains fields that describe the outcome when configured policies are reset. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.settings.defaults.hosts.policies.apply.reset_info.enable_quick_boot_reset_info |
The enable_quick_boot_reset_info structure contains fields that describe the outcome when the configured value for whether Quick Boot should be enabled during remediation is reset. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.settings.defaults.hosts.policies.apply.reset_info.failure_action |
The failure_action structure contains fields that describe the actions to be taken when entering maintenance mode fails on an ESXi host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.settings.defaults.hosts.policies.apply.reset_info.failure_action_reset_info |
The failure_action_reset_info structure contains fields that describe the outcome when the configured value for the action to be taken when entering maintenance mode fails is reset. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.settings.defaults.hosts.policies.apply.reset_info.pre_remediation_power_action_reset_info |
The pre_remediation_power_action_reset_info structure contains fields that describe the outcome when the configured value for what action should be taken on the power state of VMs before entering maintenance mode is reset. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
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.
versions
The versions service provides operations to get OEM add-on versions from the sync'ed and imported depots.
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.
versions
The versions service provides operations to get versions of base-images from the sync'ed and imported depots.
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.
versions
The versions service provides operations to get component versions from the sync'ed and imported depots.
esx settings depot content hardware support
esx settings depot content hardware support manifests
manifests
The manifests service provides operations to get Hardware Support Package (HSP) manifests from the sync'ed and imported depots.
versions
The versions service provides operations to get Hardware Support Package (HSP) manifest versions from the sync'ed and imported depots.
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.
online
The online service provides operations to manage Online Software Depots used during ESX lifecycle management.
sync schedule
The sync_schedule service provides operations to manage Schedule of Online Software Depot sync.
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.
esx settings hardware support
esx settings hardware support managers
managers
The managers service provides operations to list Hardware Support Manager (HSM) for a given vCenter.
esx settings hardware support managers packages
packages
The packages service provides operations to manage a host's Hardware Support Package (HSP) configuration.
versions
The versions service provides operations to inspect a Hardware Support Package (HSP)'s detailed information.
esx settings hosts enablement
The esx.settings.hosts.enablement API provides services to manage standalone host with a single software specification.
software
The software service provides operations to control whether the host is managed with a single software specification. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.hosts.enablement.software.check_result |
The check_result structure contains information that describes the results of the checks. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| esx.settings.hosts.enablement.software.check_spec |
The check_spec structure contains information describing what checks should be performed. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| esx.settings.hosts.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. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| esx.settings.hosts.enablement.software.info |
The info structure contains information describing whether the feature is enabled. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
esx settings hosts policies
The esx.settings.hosts.policies API provides services to manage the policies that affect management of desired state configuration and software for an ESXi host. Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential
esx settings hosts policies apply
The esx.settings.hosts.policies.apply API provides services to manage the policies that affect application of desired state configuration and software for an ESXi host. 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 host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.hosts.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 host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| esx.settings.hosts.policies.apply.failure_action |
The failure_action structure contains fields that describe the actions to be taken when entering maintenance mode fails on an ESXi host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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 host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.hosts.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 hosts. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| esx.settings.hosts.policies.apply.effective.failure_action |
The failure_action structure contains fields that describe the actions to be taken when entering maintenance mode fails on an ESXi host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
reset info
The reset_info service provides internal operations to identify the outcome when configured policies esx.settings.hosts.policies.apply.configured_policy_spec are reset. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.hosts.policies.apply.reset_info.configured_policy_reset_info |
The configured_policy_reset_info structure contains fields that describe the outcome when configured policies are reset. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.settings.hosts.policies.apply.reset_info.enable_quick_boot_reset_info |
The enable_quick_boot_reset_info structure contains fields that describe the outcome when the configured value for whether Quick Boot should be enabled during remediation is reset. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.settings.hosts.policies.apply.reset_info.failure_action |
The failure_action structure contains fields that describe the actions to be taken when entering maintenance mode fails on an ESXi host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.settings.hosts.policies.apply.reset_info.failure_action_reset_info |
The failure_action_reset_info structure contains fields that describe the outcome when the configured value for the action to be taken when entering maintenance mode fails is reset. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.settings.hosts.policies.apply.reset_info.pre_remediation_power_action_reset_info |
The pre_remediation_power_action_reset_info structure contains fields that describe the outcome when the configured value for what action should be taken on the power state of VMs before entering maintenance mode is reset. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
esx settings hosts software
The esx.settings.hosts.software API provides services to manage desired software on a standalone host.
commits
The commits service provides operations to manage committed changes to desired software document. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.hosts.software.commits.info |
The info structure defines the information about software draft. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
esx settings hosts software drafts software
The esx.settings.hosts.software.drafts.software API provides services to manage specifications in a software draft for an ESX host.
components
The components service provides operations to manage component specification in a software draft. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.hosts.software.drafts.software.components.update_spec |
The update_spec structure contains fields that are specified to update list of components in the draft. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
drafts internal
The drafts service provides internal operations to manage working copy of software documents. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.hosts.software.drafts_internal.create_result |
The create_result structure contains fields that are returned after creation of a draft. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.settings.hosts.software.drafts_internal.import_spec |
The import_spec structure defines the information used to import the desired software specification. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.settings.hosts.software.drafts_internal.info |
The info structure defines the information about software draft. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.settings.hosts.software.drafts_internal.metadata |
The metadata structure defines the metadata information about software draft. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
esx settings hosts software reports
The esx.settings.hosts.software.reports API provides services to manage reports pertaining to the desired state software for standalone ESXi hosts.
apply impact
The apply_impact service provides operations to get the impact of an apply operation on a standalone ESXi host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.settings.hosts.software.reports.apply_impact.host_impact |
The host_impact structure contains fields that describe the summary of how the standalone ESXi host will be impacted during an apply operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| esx.settings.hosts.software.reports.apply_impact.impact |
The impact structure contains fields that describe what the impact is of a particular step during the apply operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
last apply result
The last_apply_result service provides operations to get the most recent available result of applying the desired software document to a standalone ESXi host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
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 the standalone host before the application of the desired software document to the host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
esx settings internal
The esx.settings.internal API provides services to manage ESX internal settings.
software
The software service provides operations to manage software documents for non-existing entities.
| Type |
Description |
| esx.settings.internal.software.validate_result |
The validate_result structure contains fields to describe result of validation of desired software specification. Note: This structure is restricted for VMware internal use only. |
summary
The summary service provides operation to summarize the complaince result of the clusters in the data-center.
esx trusted infrastructure
The esx.trusted_infrastructure API provides services for managing Trusted Hosts.
esx trusted infrastructure attestation
reports
The reports interface provides operations to get the Trusted Host attestation reports. This service was added in vSphere API 7.0.1.0.
services
The services service manages endpoint configuration about the attestation service and its relation to the Key Management Server (KMS) services.
esx trusted infrastructure kms
providers
The providers service provides operations to create, retrieve, update and delete providers.
services
The services service manages endpoint configuration about the Key Management Server (KMS) service and its relation to the attestation services.
esx vm
data sets
The data_sets service provides operations for sharing information between a virtual machine and its guest operating system. Information is grouped into data sets, each of which contains key-value entries comprising the data. It's expected that each application using the service will have at least one unique data set in which to store its data to avoid conflict with other applications. Each data set has attributes defining its size limitations, access control and interoperability configuration.
It's not recommended that sensitive data (for example, passwords or private keys) be stored in plain-text. The data will be visible to other applications, running both on the management network and within the guest. The data can also be exposed by backups or templates.
Data set support requires the the virtual machine be at virtual hardware version XXX or later.
Data sets should only be modified by the application that creates them. Otherwise the application may stop working.
. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| esx.vm.data_sets.create_spec |
The create_spec structure describes a data set to be created. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.vm.data_sets.info |
The info structure describes a data set. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.vm.data_sets.summary |
Basic data set information. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| esx.vm.data_sets.update_spec |
The update_spec structure describes attibutes of a data set that can be modified. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
hlm
The hlm API provides services for managing HLM in Cloud Services Gateway.
| Type |
Description |
| hlm.notification |
The notification structure contains fields to describe any info/warning/error messages that Tasks can raise. |
| hlm.notifications |
The notifications structure contains info/warning/error messages that can be reported be the task. |
hlm deployment
deployment
The deployment service provides operations to get the state of the HLM installation. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| hlm.deployment.check_info |
The check_info structure describes the result of the appliance deployment check. |
| hlm.deployment.info |
The info structure contains fields to describe the state of the appliance. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| hlm.deployment.task |
The task structure contains fields to describe a particular deployment task. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
install
The install service provides operations to configure the installation of the appliance. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| hlm.deployment.install.install_info |
The install_info structure contains information which is cached and returned as the result of get operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| hlm.deployment.install.install_spec |
The install_spec structure contains information used to install HLM on the CSGW appliance. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| hlm.deployment.install.SSO_info |
The SSO_info structure contains information about the vCenter Server which is cached and returned as the result of get operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| hlm.deployment.install.SSO_spec |
The SSO_spec structure contains information about the vCenter Server which is required to connect and/or perform other operations. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| hlm.deployment.install.VMC_info |
The VMC_info structure contains information about the vmc vcenter Server which is cached and returned as the result of get operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| hlm.deployment.install.VMC_spec |
The VMC_spec structure contains information about the vmc vcenter Server which is required to connect and/or perform other operations. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
vapi
The vapi component provides API infrastructure services and standard types that can be used in the interface specification of any service.
| Type |
Description |
| vapi.component_info |
The component_info structure holds component metadata of the different metadata types for an API component. The structure allows any combination of metadata types to be aggregated into one instance. This structure was added in vSphere API 6.7. Note: This structure is restricted for VMware internal use only. |
| vapi.metadata_info |
The metadata_info is a structure which holds a map of the available metadata aggregated in a vapi.component_info structure. This structure was added in vSphere API 6.7. Note: This structure is restricted for VMware internal use only. |
The vapi.metadata API provides metadata services. These are services that provide different facets of API information. Clients can use these services to: - Discover APIs available in the infrastructure.
- Fetch metadata that can be used to build presentation layers like CLI, REST, etc.
- Fetch authentication and authorization metadata.
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. |
The source service provides operations to manage the sources of authentication metadata information. The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains authentication information. The generated file can be registered as a source of metadata.
The authentication file contains all the data present in the interface definition files. Each authentication file contains data about one component element. When a authentication file is added as a source, each source contributes only one component element's metadata.
Authentication metadata can also be discovered from a remote server that supports the authentication metadata services (see vapi.metadata.authentication). Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.
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.
| Type |
Description |
| vapi.metadata.cli.component_info |
The component_info is an aggregated structure for CLI commands and namespaces information. This structure was added in vSphere API 6.7. Note: This structure is restricted for VMware internal use only. |
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. |
The namespace service provides operations to get information about command line interface (CLI) namespaces.
The source service provides operations to manage the sources of command line interface (CLI) metadata information. The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains CLI information.
A CLI metadata file contains information about one component element. When a CLI metadata file is added as a source, each source contributes only one component element's metadata.
CLI metadata can also be discovered from a remote server that supports the CLI metadata services (see vapi.metadata.cli) API. Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.
| Type |
Description |
| vapi.metadata.cli.source.create_spec |
The create_spec structure contains the registration information of a CLI source. Note: This structure is restricted for VMware internal use only. |
| vapi.metadata.cli.source.info |
The info structure contains the metadata source information. Note: This structure is restricted for VMware internal use only. |
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:
- Enumeration: An enumeration element that has a list of enumeration value elements.
- Constant: A constant element has a name and a value.
- Structure: A structure element can have field elements, constant elements and enumeration elements.
- Operation: An operation has a list of parameter elements, result element and error elements.
- Service: A service is a collection of operation elements, structure elements, enumerated elements and constant elements.
- Package: A package is a collection of service elements, structure elements and enumeration elements.
- Component: A component is a collection of package elements.
The vapi.metadata.metamodel API has services that enables two styles of client applications: - A client can retrieve the exact pieces of information it requires using the various granularities the API supports (that is vapi.metadata.metamodel.component, vapi.metadata.metamodel.package, vapi.metadata.metamodel.service, vapi.metadata.metamodel.structure, vapi.metadata.metamodel.enumeration and vapi.metadata.metamodel.service.operation). In this case, it doesn't cache any information locally and always invokes operations to get the metamodel information it requires.
- A client can retrieve all the metamodel information in fewer operation invocations using the vapi.metadata.metamodel.component service and cache the output locally. It can then poll on the fingerprint information exposed by the vapi.metadata.metamodel.component service to monitor changes in API definition.
| 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. |
The source service provides operations to manage the sources of metamodel metadata information. The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains metamodel information. The generated file can be registered as a source of metadata.
The metamodel file contains all the data present in the interface definition files. Each metamodel file contains data about one component element. When a metamodel file is added as a source, each source contributes only one component element's metadata.
Metamodel metadata can also be discovered from a remote server that supports the metamodel metadata services (see vapi.metadata.metamodel). Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.
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. |
The source service provides operations to manage the sources of privilege metadata information. The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains privilege information. The generated file can be registered as a source of metadata.
The privilege file contains all the data present in the interface definition files. Each privilege file contains data about one component element. When a privilege file is added as a source, each source contributes only one component element's metadata.
Privilege metadata can also be discovered from a remote server that supports the privilege metadata services (see vapi.metadata.privilege). Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.
| Type |
Description |
| vapi.metadata.routing.component_data |
Routing information of the vAPI component along with its checksum Note: This structure is restricted for VMware internal use only. |
| vapi.metadata.routing.component_info |
Information about a vAPI component that contains routing information For an explanation of routing information within components, see vapi.metadata.routing.component Note: This structure is restricted for VMware internal use only. |
| vapi.metadata.routing.operation_info |
Information about a vAPI operation that contains routing information. For an explanation of containment within operations, see com.vmware.vapi.metadata.routing.Operation Note: This structure is restricted for VMware internal use only. |
| vapi.metadata.routing.package_info |
Information about a vAPI package containing routing information. For an explanation of routing information within packages, see vapi.metadata.routing.package Note: This structure is restricted for VMware internal use only. |
| vapi.metadata.routing.routing_info |
Routing information Note: This structure is restricted for VMware internal use only. |
| vapi.metadata.routing.service_info |
Information about a vAPI service that has routing information A service is said to contain routing information if any of its operations have routing information Note: This structure is restricted for VMware internal use only. |
Operations to manage the metadata sources for routing information
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.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.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: - 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.
- 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: |
| 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: |
| 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.
vapi std introspection
The vapi.std.introspection API provides services that expose basic information about the vAPI services registered with a vAPI provider.
operation
The vapi.std.introspection.operation service provides operations to retrieve information about the operations present in a vAPI service.
provider
The vapi.std.introspection.provider service provides operations to retrieve information about a vAPI Provider. A provider is a container that exposes one or more vAPI services.
service
The vapi.std.introspection.service service provides operations to retrieve information about the services exposed by a vAPI provider. A provider is a container that exposes one or more vAPI services.
vcenter
The vcenter API provides services for managing VMware vSphere environments. The API is available starting in vSphere 6.5.
vcenter activedirectory
The vcenter.activedirectory API provides Active Directory Domain operations services.
active directory
The active_directory service provides operations to join, check the status of domain join of the appliance to a given domain or leave the current domain.
vcenter certificate authority
The vcenter.certificate_authority API provides services CA Service. Copyright 2019 VMware, Inc. All rights reserved. -- VMware Confidential
certificate
The certificate interface provides operations to provide info about certificates present on server. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.certificate_authority.certificate.spec |
The spec structure contains information to generate a Private Key , CSR and hence SSL Certificate. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
vcenter certificate management
The vcenter.certificate_management API provides services to manage certificates.
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.
tls csr
The tls_csr interface provides operations to generate certificate signing request. This service 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.
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.
vcenter cluster
cluster
The cluster service provides operations to manage clusters in the vCenter Server.
| Type |
Description |
| vcenter.cluster.create_spec |
The create_spec structure defines the information used to create a cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| 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 cluster edrs
The vcenter.cluster.edrs API provides services for interacting with EDRS, such as, query EDRS scaling recommendation, set algo parameter, etc.
algo parameter
The algo_parameter service provides operations to set/get EDRS algorithm parameters for a cluster. 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.cluster.edrs.algo_parameter.param |
The param structure contains EDRS algorithm parameters. 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. Note: This structure is restricted for VMware internal use only. |
maintenance mode
The maintenance_mode service provides operations to handle the scale out request when entering cluster maintanence mode and the scale in request when exiting maintenance mode. 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.cluster.edrs.maintenance_mode.enter_spec |
The enter_spec structure contains the details of the specification used when the cluster EDRS enter maintenance mode. 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. Note: This structure is restricted for VMware internal use only. |
| vcenter.cluster.edrs.maintenance_mode.exit_spec |
The exit_spec structure contains the details of the specification used when the cluster EDRS exit maintenance mode. 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. Note: This structure is restricted for VMware internal use only. |
| vcenter.cluster.edrs.maintenance_mode.info |
The info structure contains {term fields} used to inform the maintenance mode information of the cluster. 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. Note: This structure is restricted for VMware internal use only. |
recommendation
The recommendation service provides operations to give scale in (to remove host) / scale out (to add host) recommendation for a cluster. This service was added in vSphere API 7.0.1.0.
| Type |
Description |
| vcenter.cluster.edrs.recommendation.recommendation |
The recommendation structure contains the recommend action, and all related details. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
| vcenter.cluster.edrs.recommendation.utilization_info |
The utilization_info structure contains the details of cluster resources utilization and corresponding thresholds. Resource utilization is an estimated value derived from current usage and historical data. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
vcenter cluster modules vm
members
The members service provides operations to manage the membership of virtual machines in a cluster module. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.cluster.modules.vm.members.get_result |
The get_result structure contains fields used to return the virtual machines that are members of the module, see get). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.cluster.modules.vm.members.status |
The status structure contains fields used to report the status of updating module membership, see add and remove). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
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.
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.
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.
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. |
VM
The VM service provides operations to enumerate the policies that are associated with virtual machines and their status. 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.VM.list_result |
The list_result structure contains the returned policies, see 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. Note: This structure is restricted for VMware internal use only. |
| vcenter.compute.policies.VM.summary |
The summary describes a policy and its compliance status. 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. Note: This structure is restricted for VMware internal use only. |
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.
vcenter content registries harbor project
The vcenter.content.registries.harbor.project API provides structures and services for managing Harbor projects.
members
The members service provides operations to manage Harbor project members.
projects
The projects service provides operations for managing the lifecycle of Harbor project that stores and distributes container repositories and images.
health
The health service provides operations to retrieve health status for 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.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.0. |
| vcenter.deployment.disk_info |
The disk_info {structure contains information about used space, free space, total size, and mount point of the disk. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.deployment.history_migration_spec |
The history_migration_spec enumerated type defines how vCenter history data will be migrated. vCenter History data includes . 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 information about the source vCenter Server system and the database migration options. This structure was added in vSphere API 7.0.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.
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.
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.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.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.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.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.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.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.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.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.
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.
vcenter extension
tasks
The tasks service provides operations for creating tasks for an operation in vCenter extension and updating the description, state and progress of the task. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.extension.tasks.create_spec |
The create_spec structure contains fields used to create a task. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.extension.tasks.update_spec |
The update_spec structure contains fields used to update the information of the operation associated with a task. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
vcenter files nfc
The vcenter.files.nfc API provides services for managing NFC file operations.
| Type |
Description |
| vcenter.files.nfc.ticket |
The ticket structure contains connection and proof of authorization information required to initiate a NFC connection on a host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
vcenter files nfc tickets
The vcenter.files.nfc.tickets API provides services for creating NFC tickets.
datastore
The datastore service provides operations to create Network File Copy (NFC) tickets to access files on a datastore. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.files.nfc.tickets.datastore.create_result |
The create_result structure contains the connection, authorization and host information required to initiate an NFC connection on a host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.files.nfc.tickets.datastore.create_spec |
The create_spec structure contains the information required to create a vcenter.files.nfc.ticket to access files on a datastore. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
folder
The Folder service provides operations for manipulating a vCenter Server folder.
| Type |
Description |
| vcenter.folder.create_spec |
The create_spec structure defines the information used to create a folder. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| 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.info |
The info structure contains information about a folder. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| 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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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. |
vcenter hlm
The vcenter.hlm API provides services to manage various linked modes. Usage beyond VMware Cloud on AWS is not supported.
The community service provides operations to add and remove nodes to a community. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.hlm.community.add_check_spec |
The add_check_spec structure is the specification used for specifying how to perform network checks within a community before adding a new peer. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.hlm.community.add_spec |
The add_spec structure is the specification used for connecting to another node and adding it to the local community. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.hlm.community.certificate_info |
The certificate_info structure contains information about the SSL certificate for a target node. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.hlm.community.check_info |
The check_info structure contains information on the {@operation} check. Connectivity checks are validated pairwise. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.hlm.community.info |
The info structure has information about the community. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.hlm.community.member |
The member structure has information about a community member. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.hlm.community.status |
The status structure contains fields that are used to describe the outcome of a single direction connectivity check. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
convergence
The convergence check whether the community is converged. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.hlm.convergence.convergence_info |
The convergence_info structure contains fields that are used to describe the outcome of convergence check. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.hlm.convergence.service_convergence_info |
The service_convergence_info structure contains fields the information that are used to describe if data of the service has converged for each syncable service. Converged means all data has been replicated to other partners in the community. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
multi sddc
The multi_sddc service provides operations to set MultiSDDC specific config information. This API is used only to set configuration and get is intentionally not provided by this api. The actual feature related APIs will throw relevant exceptions , if the configuration for Multi sddc is not enabled. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.hlm.multi_sddc.config_spec |
The config_spec structure sets Multisddc feature to enabled. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
remote worker
The remote_worker service provides operations to do operations related to HLM on remote node. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.hlm.remote_worker.link_input_spec |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.hlm.remote_worker.trust_create_spec |
The CreateSpec structure contains information to create a trust. Note: DO NOT MODIFY WITHOUT SYNCHRONIZING CHANGES WITH THE VcTrusts VMODL TODO: This is the same definition as VCTrust CreateSpec which cannot be imported, modify to use VCTrusts.CreateSpec https://opengrok.eng.vmware.com/source/xref/main.perforce.1666/bora/api/vcenter/trust/VcTrusts.vmodl. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.hlm.remote_worker.x509_cert_chain |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
sddcs
The sddcs service provides the operation to list the Sddcs under an organization. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.hlm.sddcs.filter_spec |
The filter_spec structure contains fields used to list Sddcs. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.hlm.sddcs.summary |
The Info structure gives information about an Sddc. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
vcenter host
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 host maintenance
requests v1
The requests_v1 service provides operations to manage host maintenance requests in the vCenter Server. This service was added in vSphere API 7.0.1.0.
| Type |
Description |
| vcenter.host.maintenance.requests_v1.create_result |
The create_result structure contains fields that are used to describe the outcome of the create operation. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
| vcenter.host.maintenance.requests_v1.create_spec |
The create_spec structure defines the information used to create a maintenance request. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
| vcenter.host.maintenance.requests_v1.filter_spec |
The filter_spec structure contains fields used to filter the results when listing requests (see list). This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
| vcenter.host.maintenance.requests_v1.list_result |
The list_result structure contains information of maintenance requests that are assigned to hosts. See list. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
| vcenter.host.maintenance.requests_v1.summary |
The summary structure contains commonly used information about a maintenance request associated with a host. This structure was added in vSphere API 7.0.1.0. Note: This structure is restricted for VMware internal use only. |
The tags service provides operations to manage tag associations of a host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.host.tags.status |
The status structure contains fields that are used to describe the outcome of the add/remove operations that operate on multiple tags. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
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
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.info |
The info structure contains information about link. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| 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. |
| vcenter.hvc.links.sync.remediation_status |
The Info structure contains information about the result of remediate. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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.
foreign security principals
The foreign_security_principals interface provides operations to read and modify foreign security principals. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.identity.foreign_security_principals.create_spec |
The create_spec structure contains information to create a foreign security principal. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.identity.foreign_security_principals.info |
The info structure contains information about a foreign security principal. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.identity.foreign_security_principals.update_spec |
The update_spec structure contains information to update a foreign security principal. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
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.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.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.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.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.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.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.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.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.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.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.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.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.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.0. |
vc identity
The vc_identity interface provides operations to read and modify local vCenter identity. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.identity.vc_identity.info |
The info structure contains data that represents a local vCenter identity. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.identity.vc_identity.update_spec |
The update_spec structure contains data to update the local vCenter identity. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
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.
network
The network service provides operations to retrieve information about vCenter Server networks.
vcenter lcm
The vcenter.lcm API provides services for managing the vCenter Server lifecycle.
| Type |
Description |
| vcenter.lcm.connection |
Connection information for source/destination location. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.deployment_info |
Information about the appliance deployed. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.deployment_option |
Container to control deployment. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.destination_appliance |
Spec to describe the new appliance. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.destination_appliance_service |
The configuration of vCenter services. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.destination_location |
Configuration of destination location. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.embedded_replicated_vcsa |
Configuration of the replicated Single Sign-On for Embedded type deployment. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.embedded_standalone_vcsa |
Configuration of the standalone Single Sign-On for Embedded type deployment. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.esx |
Configuration of ESX. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.esx_inventory |
Configuration of ESX's inventory. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.external_tool |
Configuration of the external tools used. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.external_vcsa |
Configuration of the Single Sign-On for Management type deployment. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.install_spec |
The specification that represents a install operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.network |
Network configuration of the appliance to be deployed. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| 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.psc |
Spec used to configure a Platform Services Controller. This section describes how the Platform Services Controller appliance should be configured. If unset, either #vcsaEmbedded or #vcsaExternal must be provided. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.psc_replicated |
Configuration of the replicated Single Sign-On for PSC type deployment. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.psc_standalone |
Configuration of the standalone Single Sign-On for Embedded type deployment. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.result |
Container of info, warning and error messages associated with a single task. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.reverse_proxy |
Port numbers on which the vCenter Server Appliance communicates with the other vSphere components. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.ssh |
Setting to enable SSH on the deployed appliance. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.sub_task_info |
Container that contains the status information about a single task. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.task_info |
The container that contains the status information of a deployment. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.temporary_network |
Configuration of the temporary network which is used during upgrade/migrate. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.time |
NTP setting of the appliance to be deployed. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.vc |
Configuration of the VC that hosts/will host an appliance. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.vc_inventory |
Inventory information about a VCenter. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.vcsa_embedded |
Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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.
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.
product catalog
The product_catalog service provides information which VMware products 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. |
tasks
The service of life cycle management tasks. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.lcm.tasks.info |
The data container of the task. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
vcenter lcm topology
The vcenter.lcm.topology API provides services for discovering vCenter Server topology in Enhanced Linked Mode (ELM).
nodes
The nodes interface provides operations to retrieve information about all linked vCenter Server nodes. 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.lcm.topology.nodes.vc_node |
The vc_node structure contains vCenter or Platform Services Controller node details. 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. Note: This structure is restricted for VMware internal use only. |
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.
precheck report
The precheck_report service generates precheck report for a vCenter Server instance against a target update version.
validation
The service that provides validation of a section of full deployment specification. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.lcm.validation.appliance_name_destination_appliance |
Data container for appliance name information used in validation of appliance name request. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.validation.appliance_name_destination_location |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.validation.appliance_name_esx |
This section describes the ESX host on which to deploy the appliance. Required if you are deploying the appliance directly on an ESX host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.validation.appliance_name_esx_inventory |
The configuration of ESX inventory. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.validation.appliance_name_request |
Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.validation.appliance_name_vc |
This subsection describes the vCenter on which to deploy the appliance. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.lcm.validation.appliance_name_vc_inventory |
All names are case-sensitive. you can install the appliance to one of the following destinations: 1. A resource pool in a cluster, use 'cluster_path'. 2. A specific ESX host in a cluster, use 'host_path'. 3. A resource pool in a specific ESX host being managed by the current vCenter, use 'resource_pool_path'. You must always provide the 'network_name' key. To install a new appliance to a specific ESX host in a cluster, provide the 'host_path' key, and the 'datastore_name', e.g. 'host_path': '/MyDataCenter/host/MyCluster/10.20.30.40', 'datastore_name': 'Your Datastore'. To install a new appliance to a specific resource pool, provide the 'resource_pool_path', and the 'datastore_name', e.g. 'resource_pool_path': '/Your Datacenter Folder/Your Datacenter/host/Your Cluster/Resources/Your Resource Pool', 'datastore_name': 'Your Datastore'. To place a new appliance to a virtual machine Folder, provide the 'vm_folder_path', e.g. 'vm_folder_path': 'VM Folder 0/VM Folder1'. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
vcenter namespace management
The vcenter.namespace_management API provides services for managing Namespaces.
| Type |
Description |
| vcenter.namespace_management.IP_range |
The IP_range structure is used to express a range of IP addresses. The formats supported by this structure will depend on the IP addressing scheme that is being used by vSphere Namespaces. Currently, vSphere Namespaces only supports IPv4. This structure was added in vSphere API 7.0.1.0. |
| 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. |
vcenter namespace management certificate management
tls csr
The tls_csr interface provides operations to generate certificate signing requests.
cluster available versions
The {@name cluster-available-versions} service provides operations to retrieve available upgrade versions of WCP and detailed information about each upgrade.
cluster compatibility
The cluster_compatibility service provides operations to get Namespace-related compatibility information for clusters in this vCenter.
cluster size info
The {@name cluster-size-info} service provides operations to retrieve various sizes available for enabling Namespaces and information about each size.
clusters
The clusters service provides operations to enable and disable vSphere Namespaces on a vSphere cluster.
distributed switch compatibility
The distributed_switch_compatibility service provides operations to get Namespaces compatibility information of Distributed Switches in this vCenter.
edge cluster compatibility
The edge_cluster_compatibility service provides operations to get Namespaces compatibility information of NSX Edge Clusters.
vcenter namespace management events
The vcenter.namespace_management.events API provides service for gathering Kubernetes events related to a Kubernetes Cluster.
events
The events service provides operations to get Kubernetes events related to a particular cluster.
| Type |
Description |
| vcenter.namespace_management.events.events.event |
The event contains selected fields from the corresponding Kubernetes event. Please refer Kubernetes Events API for more details. Note: This structure is restricted for VMware internal use only. |
hosts config
The Compatibility service provides operations to retrieve information about vSphere Namespaces support and licensing.
load balancers
load_balancers represent the user provisioned load balancers. The load balancers provided may be used to front the API servers in both, vSphere Namespaces Cluster and Tanzu Kubernetes Grid clusters. Note: The lifecycle of these load balancers is not managed by vSphere. This service was added in vSphere API 7.0.1.0.
namespace resource options
The namespace_resource_options service provides operations to get the objects used to create and modify resource quotas on a namespace.
networks
The networks service provides lifecycle operations on vSphere Namespaces networks associated with a vSphere cluster. This service was added in vSphere API 7.0.1.0.
| Type |
Description |
| vcenter.namespace_management.networks.create_spec |
The create_spec structure contains the specification required to create a vSphere Namespaces network object. This structure was added in vSphere API 7.0.1.0. |
| vcenter.namespace_management.networks.info |
This structure was added in vSphere API 7.0.1.0. |
| vcenter.namespace_management.networks.set_spec |
The set_spec structure contains the specification required to set a new configuration of a vSphere Namespaces network object. This structure is applied in entirety, replacing the current specification fully. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.networks.update_spec |
The update_spec structure contains the specification required to set a new configuration of a vSphere Namespaces network object. This structure may be partially populated, and unset fields in spec will leave those parts of configuration as-is. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.networks.vsphere_DVPG_network_create_spec |
The vsphere_DVPG_network_create_spec structure describes the configuration specification of a vSphere DVPG-backed Namespaces Network object. This structure was added in vSphere API 7.0.1.0. |
| vcenter.namespace_management.networks.vsphere_DVPG_network_info |
The vsphere_DVPG_network_info structure describes the configuration specification of a vSphere DVPG-backed Namespaces Network object. This structure was added in vSphere API 7.0.1.0. |
| vcenter.namespace_management.networks.vsphere_DVPG_network_set_spec |
The vsphere_DVPG_network_set_spec structure contains new configuration to set on an existing a vSphere DVPG-backed Namespaces Network object. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.networks.vsphere_DVPG_network_update_spec |
The vsphere_DVPG_network_update_spec structure contains new configuration to update on an existing a vSphere DVPG-backed Namespaces Network object. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
nodes
The nodes service provides operations to manage the state of Kubernetes nodes of a Namespaces cluster.
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.
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.
vcenter namespace management supervisor services
The vcenter.namespace_management.supervisor_services API provides services for managing supervisor services that are extensions to the vSphere Supervisor clusters.
supervisor services
The supervisor_services service provides operations to manage a supervisor service object. Supervisor services can be extensions to the vSphere Supervisor clusters and provide services to applications running in vSphere Supervisor clusters. They are often provided by 3rd party vendors. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.namespace_management.supervisor_services.create_spec |
The create_spec structure provides a specification required to create a supervisor service. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.supervisor_services.custom_create_spec |
The custom_create_spec structure provides a specification required to create a supervisor service with a version from a custom format that doesn't follow the vSphere application service format, just like any custom operator. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.supervisor_services.info |
The info structure contains detailed information about a supervisor service. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.supervisor_services.summary |
The summary structure contains the basic information about a supervisor service version. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.supervisor_services.update_spec |
The update_spec structure provides a specification required to update a supervisor service. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.supervisor_services.vsphere_create_spec |
The vsphere_create_spec structure provides a specification required to create a supervisor service with a version from vSphere application service format, which shall contain the service identifier, display name and description information. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
versions
The versions service provides operations to manage a version object of a supervisor service. A supervisor service version can be enabled on the vSphere Supervisor clusters. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.namespace_management.supervisor_services.versions.create_spec |
The create_spec structure provides a specification required to create a supervisor service version. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.supervisor_services.versions.custom_create_spec |
The custom_create_spec structure provides a specification required to create a supervisor service version from a custom format that doesn't follow the vSphere application service format, just like any custom operator. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.supervisor_services.versions.info |
The info structure contains detailed information about a supervisor service version. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.supervisor_services.versions.summary |
The summary structure contains the basic information about a supervisor service version. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.namespace_management.supervisor_services.versions.vsphere_create_spec |
The vsphere_create_spec structure provides a specification required to create a supervisor service version from vSphere application service format, which shall contain the supervisor service identifier, version identifier, display name and description information. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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.
access
The access service provides operations to manage access control of subjects on namespaces.
vcenter namespaces events
The vcenter.namespaces.events API provides service for gathering Kubernetes events related to a Kubernetes Namespace.
events
The events service provides operations to get Kubernetes events related to a particular namespace.
| Type |
Description |
| vcenter.namespaces.events.events.event |
The event contains selected fields from the corresponding Kubernetes event. Please refer Kubernetes Events API for more details. Note: This structure is restricted for VMware internal use only. |
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.
supervisor services
The supervisor_services service provides operations to set the desired state of Supervisor Services, as well as list them. Supervisor Services are extensions to the vSphere Namespace Supervisor, often provided by 3rd party vendors. They run in a highly privileged mode, and that should be considered before enabling them. This service was added in vSphere API 7.0.0.10200.
| Type |
Description |
| vcenter.namespaces.supervisor_services.set_spec |
The set_spec structure contains the specification required to set the desired state of a SupervisorService. This structure was added in vSphere API 7.0.0.10200. Note: This structure is restricted for VMware internal use only. |
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.
vcenter network
The vcenter.network API provides services for managing network-related objects such as switches and port groups.
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. |
distributed switches
The DistributedSwitches service provides operations for manipulating a vSphere Distributed Switch (VDS). Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.network.distributed_switches.filter_spec |
The filter_spec structure contains fields used to filter the results when listing vSphere distributed switches (see list). A flag is also available to specify that only vSphere distributed switches connected to all hosts in the clusters should satisfy the filter. If multiple fields are specified, only vSphere distributed switches matching all the fields match the filter. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.network.distributed_switches.summary |
The summary structure contains commonly used information about a vSphere Distributed Switch. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
vcenter nsx
The vcenter.nsx API provides services for configuration of NSX capabilities on VC clusters.
| Type |
Description |
| vcenter.nsx.cluster_enable_spec |
The cluster_enable_spec structure contains the specification to enable NSX networking with transport node configuration on all the hosts in a vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.cluster_overlay_network_spec |
The cluster_overlay_network_spec contains information related to network configuration for the Tunnel Endpoints (TEPs) on the hosts in the vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.edge_cluster_enable_spec |
The edge_cluster_enable_spec structure contains the specification required to enable NSX Edge node(s) on a vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.edge_cluster_update_spec |
The edge_cluster_update_spec structure contains the specification required to update NSX Edge node(s) on an existing NSX Edge cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.edge_overlay_network_spec |
The edge_overlay_network_spec contains information related to network configuration for the Tunnel Endpoints (TEPs) on the NSX Edge nodes in the vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.ip_pool_create_spec |
The ip_pool_create_spec structure contains the specification to create an NSX IP pool. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.ip_pool_info |
The ip_pool_info structure contains the specification of an NSX IP pool. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.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. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.ipv4_range |
The ipv4_range contains the specification to configure multiple interfaces in IPV4. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.management_network_spec |
The management_network_spec contains information related to network configuration for the management network interface on the NSX Edge node. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.message |
The message structure contains the information pertaining to the API using it. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.nsx.node_spec |
The node_spec structure contains the specification required to set up NSX Edge node. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.NSX_enable_spec |
The NSX_enable_spec structure contains the specification that can be used to enable NSX networking on a vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.placement_spec |
The placement_spec contains the placement specification required to set up NSX Edge node(s). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.uplink_network_spec |
The uplink_network_spec contains information related to configuration of the uplink network interface on the NSX Edge node(s). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.uplink_node_spec |
The uplink_node_spec structure contains the specification required to set up an NSX Edge node configured with the uplink network. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
vcenter nsx clusters
The vcenter.nsx.clusters API provides services for operations that can be used to assist in enabling NSX networking on a vSphere cluster.
clusters
The clusters service provides operations to configure NSX networking on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.clusters.cluster_overlay_network_info |
The cluster_overlay_network_info contains information related to network configuration for the Tunnel Endpoints (TEPs) on the hosts in the vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.info |
The info structure contains the specification of NSX networking with transport node configuration on all the hosts in a vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
networking status
The networking_status service provides operations to query the networking status of a vSphere cluster on which NSX networking is enabled. Networking status is comprised of the overall configuration status of the cluster, status of the vSphere Distributed Switch (VDS) which was used for the overlay network configuration of the cluster, configuration status and health status of NSX Edge node(s) in the cluster, configuration status and health status of ESXi hosts in the cluster and information about the logical router in the NSX Edge node(s). Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.clusters.networking_status.cluster |
The cluster structure is an aggregation of configuration and health information about different entities in a vSphere cluster which has NSX networking enabled. It has information about the NSX Edge node cluster, ESXi hosts in the cluster and the logical router associated with the NSX Edge node(s). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.config |
The config structure contains information about the configuration status of an entity. The entity can be an NSX Edge node, an NSX Edge cluster, an ESXi host or a logical router in the NSX Edge node(s). It is also used to denote the overall NSX networking configuration status of the cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.edge_cluster |
The edge_cluster structure contains information about the NSX Edge node(s) in the NSX Edge cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.edge_node |
The edge_node structure contains information related to the configuration and health of the NSX Edge node(s) in the cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.esx_host |
The esx_host structure contains information related to the configuration and health of the ESXi hosts in the cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.esx_host_cluster |
The esx_host_cluster structure contains information about the ESXi hosts in the cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.health |
The health structure contains information about the health status of an entity. The entity can be an NSX Edge node, an ESXi host or a VDS. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.info |
The info structure is an aggregation of configuration and health information about different entities in the cluster and status information about the VDS. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.logical_router |
The logical_router structure contains information about the logical router in the NSX Edge node(s). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.message |
The message structure contains the information about the result of the status checks. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.uplink_edge |
The uplink_edge structure contains information about the uplink NSX Edge node(s). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.uplink_high_availability |
The uplink_high_availability structure contains information about the high availability status of a service router on an NSX Edge node. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.networking_status.vds |
The vds structure contains the result of the status checks performed on the vSphere Distributed Switch (VDS). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
status
The status service provides operations to get the status of configuration of NSX networking on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.clusters.status.info |
The info structure contains information about the NSX networking configuration status of clusters. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
validation
The validation service provides operations to validate a specification that can be used to enable NSX networking with transport node configuration on all the hosts in a vSphere cluster and enable NSX Edge nodes in a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.clusters.validation.check_message |
The check_message structure contains the information about the result of the validation checks. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.clusters.validation.check_result |
The check_result structure contains the result of the validation checks performed on the specification that can be used to configure or update NSX networking on a vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
vcenter nsx deployment
The vcenter.nsx.deployment API provides services for configuration of NSX capabilities on VC clusters.
| Type |
Description |
| vcenter.nsx.deployment.appliance_spec |
The appliance_spec contains the inputs related to appliance deployment operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.network |
The network structure contains IP information used to configure a network interface. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.placement_spec |
The placement_spec structure contains information to describe the inventory placement of an appliance. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
compatibility
The compatibility service provides compatibility information between current vCenter server version and currently installed NSX version. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.deployment.compatibility.info |
The info structure contains the compatibility information. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.compatibility.version |
The version structure contains version information about the latest supported NSX version for current vCenter Server. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
configuration
The configuration service contains the information about currently deployed NSX. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.deployment.configuration.info |
The info contains information about currently deployed NSX. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
install
The install service provides operations to create, query and delete an NSX appliance attached to the vCenter. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.deployment.install.info |
The info structure contains detailed information about the status of the last NSX deployment operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.install.install_spec |
The install_spec contains the inputs related to appliance deployment operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.install.message |
The message structure contains the information about the ongoing deployment. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
install recommendations
The install_recommendations service defines the resource requirements for various NSX appliance sizes and recommends an NSX size based on the vCenter size. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.deployment.install_recommendations.appliance_size |
The appliance_size contains the resource requirements for a NSX deployment size. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.install_recommendations.info |
The info contains the list of available NSX deployment sizes and recommends an NSX deployment size based on current vCenter size. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
license
The license service provides operations to query, validate and apply license to the NSX Manager Appliance attached to the vCenter. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.deployment.license.info |
The info structure contains detailed information about the NSX license to be applied or already applied. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.license.update_spec |
The update_spec structure contains the license key used to update the license on the NSX Manager Appliance. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.license.validate_spec |
The validate_spec structure contains the license key used to validate the license on the NSX Manager Appliance. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.license.validation_message |
The validation_message structure contains the message about the NSX license being validated for or already applied. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
software package
The software_package service contains operations related to staging NSX integrated binaries needed to install and manage NSX integrated functionality. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.deployment.software_package.info |
The info structure contains information about the overall staging status. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.software_package.message |
The message structure contains information about the errors and warnings if any. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.software_package.progress |
The progress structure contains information about the progress of staging operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.software_package.upload_result |
The upload_result structure contains information about the session, and the upload URI. Use the URI to upload the NSX binary. Pass the access token in the header to upload the file. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.software_package.upload_spec |
The upload_spec structure contains information about the session, and the file to upload the NSX binaries. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
supported version
The supported_version service provides information about the supported NSX version for vCenter server. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.deployment.supported_version.info |
The info structure contains version information about supported NSX version for vCenter Server. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
upgrade
The upgrade service represents all the operations of NSX Upgrade from vCenter server. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.deployment.upgrade.cluster_info |
The cluster_info structure contains information about the cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.upgrade.info |
The info structure contains information about NSX deployment on the environment. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.upgrade.message |
The message structure contains message with respect to a single entity. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.upgrade.operation |
The operation structure contains information about the operation to be performed. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.deployment.upgrade.upgrade_spec |
The upgrade_spec structure contains information required to start upgrade on NSX deployment. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
upgrade status
The upgrade_status service represents the status with respect to current NSX upgrade. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.deployment.upgrade_status.info |
The info structure contains information regarding the current NSX upgrade operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
vcenter nsx edge clusters
The vcenter.nsx.edge_clusters API provides services for operations that can be used to assist in enabling NSX Edge capabilities on a vSphere cluster.
edge clusters
The {@name Edge-clusters} service provides operations to configure NSX Edge capabilities on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.edge_clusters.edge_overlay_network_info |
The edge_overlay_network_info contains information related to network configuration for the Tunnel Endpoints (TEPs) on the NSX Edge nodes in the vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.edge_clusters.info |
The info structure contains the specification of NSX Edge node(s) on a vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.edge_clusters.management_network_info |
The management_network_info contains information related to network configuration for the management network interface on the NSX Edge node. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.edge_clusters.node_info |
The node_info structure contains the specification of NSX Edge node. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.edge_clusters.placement_info |
The placement_info contains the placement specification of NSX Edge node(s). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.edge_clusters.uplink_network_info |
The uplink_network_info contains information related to configuration of the uplink network interface on the NSX Edge node(s). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.edge_clusters.uplink_node_info |
The uplink_node_info structure contains the specification of an NSX Edge node configured with the uplink network. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
status
The status service provides operations to get the status of configuration of NSX Edge capabilities on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.edge_clusters.status.info |
The info structure contains information about the status of configuration of NSX Edge capabilities of clusters. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
ip pools
The ip_pools service provides operations to read NSX IP pools used on NSX enabled vSphere clusters. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.ip_pools.info |
The info structure contains the specification for an NSX IP pool. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.ip_pools.summary |
The summary structure contains basic information about an NSX IP pool. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
management network compatibility
The management_network_compatibility service provides operations to get compatibility information for distributed port groups (DVPG) and their associated VMKernel NICs. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.management_network_compatibility.host_vmknic_info |
The host_vmknic_info structure contains information about the network configuration of a VMKernel NIC on a host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.management_network_compatibility.summary |
The summary structure contains information about the compatibility of a Distributed Port Group (DVPG) and the network configuration of associated VMKernel NICs for setting up management networks. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
recovery
The recovery service represents all the operations of NSXi Infrastructure Recovery for vSphere clusters. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.nsx.recovery.execute_spec |
The execute_spec structure contains information related to recovery of NSX infrastructure for WCP clusters. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.recovery.execution_status |
The execution_status structure contains information related to the status of recovery of NSX infrastructure for WCP clusters. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.nsx.recovery.info |
The info structure contains information related to recovery needed. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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.datastore_disk_group |
The datastore_disk_group structure contains information about a storage disk group described in the OVF package. This structure will always be returned when retrieving information about an OVF package. See vcenter.ovf.datastore_mapping_params.disk_groups. A disk group is a main unit of storage on a ESXi host. Each disk group includes one SSD and one or multiple HDDs (magnetic disks). See Import#tryDeploy, Import#deploy, deploy, and filter. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.datastore_mapping_params |
The datastore_mapping_params structure contains information about the mapping from OVF storage groups to specific storage targets supported on the target platform. This structure will only be used when deploying an OVF package to a resource pool, cluster or host. This is information based on the vmw:StorageGroupSection and vmw:StorageSection. See Import#tryDeploy, Import#deploy, deploy, and filter. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.datastore_target |
The datastore_target structure contains information about a datastore or datastore cluster in the target deployment environment. See Import#tryDeploy, Import#deploy, deploy, and filter. Note: This structure is restricted for VMware internal use only. |
| 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.eula_params |
The eula_params structure includes a array of end user licence agreements (EULAs) included in the OVF package. If the OVF package includes one or more EULAs, an import will only succeed if the all_EULA_accepted field boolean is set to true. This information based on the ovf:EulaSection. See Import#tryDeploy, Import#deploy, deploy, and filter. Note: This structure is restricted for VMware internal use only. |
| 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.name_and_product_params |
The name_and_product_params structure contains name, description, and product information about an OVF package. The information in this package is derived from the ovf:AnnotationSection, ovf:ProductSection, and the name/id information on the root content type. The name/description can be changed/overwritten during deployment. See Import#tryDeploy, Import#deploy, deploy, and filter. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.network_mapping_params |
The network_mapping_params structure specifies how source networks in the OVF package are mapped to target networks in the deployment environment. A mapping must be provided for each source network or the deployment will fail. This is based on the ovf:NetworkSection. See Import#tryDeploy, Import#deploy, deploy, and filter. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.ovf_error |
The ovf_error structure describes an error related to accessing, validating, deploying, or exporting an OVF package. |
| vcenter.ovf.ovf_file_info |
The ovf_file_info structure contains the information regarding a single file in an OVF package or an OVA package file. Note: This structure is restricted for VMware internal use only. |
| 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.source_network |
The source_network structure contains information about a network in the OVF package. See Import#tryDeploy, Import#deploy, deploy, and filter. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.storage_disk_group |
The storage_disk_group structure contains the information about a storage disk group described in the OVF package. See Import#tryDeploy, Import#deploy, deploy, and filter. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.storage_mapping_params |
The storage_mapping_params structure maps the OVF storage groups to specific storage profiles available on the target platform. This structure will only be used when deploying an OVF package to a virtual datacenter. This is information based on the vmw:StorageGroupSection and vmw:StorageSection. See Import#tryDeploy, Import#deploy, deploy, and filter. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.storage_profile_target |
The storage_profile_target structure contains information about a storage policy. See Import#tryDeploy, Import#deploy, deploy, and filter. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.target_network |
The target_network structure contains information about a network in the deployment environment. See Import#tryDeploy, Import#deploy, deploy, and filter. Note: This structure is restricted for VMware internal use only. |
| 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.V_Service_Dependency |
Information about a vService dependency. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.V_Service_Params |
List of vService dependencies that can be configured at deployment time. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.V_Service_Provider |
Information about a vService provider. Note: This structure is restricted for VMware internal use only. |
| 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. |
| vcenter.ovf.vcenter_guest_customization |
The vcenter_guest_customization structure defines the customization of the guest operating system for a virtual machine specified by section of type ovf:VirtualSystem in the OVF descriptor. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.vcenter_guest_customization_params |
The vcenter_guest_customization_params structure contains the parameters with information about customization of ovf:VirtualSystem using vCenter guest OS customization specifications. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.warning_info |
The warning_info structure provides information about the warnings which are raised during the OVF package deployment. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
capability
The capability service provides operations for retrieving information about the capabilities supported by the OVF service server.
| Type |
Description |
| vcenter.ovf.capability.capability_info |
The Info structure describes OVF capabilities supported by the server. Note: This structure is restricted for VMware internal use only. |
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.
export session
The export_session service provides operations to export a virtual machine or virtual appliance as an OVF package. The OVF package can either be downloaded using HTTP GETs or directly transferred to a content library. The export session is represented by an info resource, which includes the current state of the transfer and also provides the list of files that can be downloaded.
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.
import session
The import_session service provides operations to import an OVF package. OVF package data can be transferred by the server pulling them from a HTTP(S) source or a content library item, or the client can push them using HTTP(S) PUT requests.
An OVF import proceeds as follows:
- Create import session
- Create import session object by specifying the source type (
PUSH_SOURCE, PULL_SOURCE, CONTENT_LIBRARY_SOURCE). - Wait for descriptor
- Wait for the OVF descriptor and localization bundles to be available.
- Query options
- Querying the import session for OVF instantiation parameters.
- Select parameters
- Selecting instantiation parameters.
- Instantiate
- Initiate instantiate.
- Wait for completion
- Wait for completion and push files if this is a push upload.
The steps query option/select parameters can happen multiple times. For example, an OVF deployment wizard would typically query for parameters multiple times to get more specific information about possible values for instantiation parameters, as well as validating the provided values as the user progresses through the wizard.
Concurrent import of files is supported. For push import the client can push multiple files at the same time.
| Type |
Description |
| vcenter.ovf.import_session.create_spec |
The create_spec structure contains information about the import parameters. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.import_session.info |
The info structure represents an import session. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.import_session.ovf_validation_result |
The ovf_validation_result structure contains information about the result of calling tryInstantiate. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.import_session.preview |
The preview structure contains information about the result of an OVF import preview based on OVF descriptor, which includes referenced files and OVF validation information. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.import_session.preview_file |
The preview_file structure contains information about a file that is referenced in the OVF descriptor and will be imported according to an import preview. Note: This structure is restricted for VMware internal use only. |
| vcenter.ovf.import_session.probe_result |
The probe_result structure contains information about the accessibility of a pull source URI. Note: This structure is restricted for VMware internal use only. |
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:
- Create a vcenter.ovf.library_item.deployment_target to specify the target deployment type and target deployment designation.
- Create a vcenter.ovf.library_item.resource_pool_deployment_spec to specify the parameters for the target deployment.
- 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:
- 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.
- Create a vcenter.ovf.library_item.create_target to specify the target library and library item.
- Create a vcenter.ovf.library_item.create_spec to specify the settings for the OVF package to be created.
- Use the
create operation with the created target and parameter specifications, along with the specified source entity. See create.
probe import session
The probe_import_session service provides operations to dry-run an import of an OVF package without having selected a target. This can be used for querying instantiation parameters such as name and EULA that are not dependent on the target. Parameters that depend on the target such as networks are omitted. Once a target has been chosen, a new session must be created with vcenter.ovf.import_session. The probe session cannot be instantiated or altered to refer to a target.
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.
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 settings
The vcenter.settings API provides services to manage a syncable SettingsStore where configuration or settings information can be stored and retrieved. Usage beyond VMware Cloud on AWS is not supported.
namespaces
The namespaces provides operations to create, read, update, and delete settings store namespaces. A namespace is a logical container that holds a group of configuration items. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.settings.namespaces.create_spec |
The create_spec structure contains specifications used to create a namespace. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.settings.namespaces.info |
Info class describing a namespace in the Settings Store. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.settings.namespaces.update_spec |
Spec used to update the namespace itself, not its associated data items. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
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.
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.
VM
The VM structure provides operations related to query virtual machines of given compliance statuses. This service 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 svcaccountmgmt
The vcenter.svcaccountmgmt API provides Token services.
password
The password interface provides operations to manage service account passwords. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.svcaccountmgmt.password.change_spec |
The change_spec structure contains information that is required to change a service account password. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.svcaccountmgmt.password.output_spec |
The output_spec structure contains information that is returned on successful reset of the service account password. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.svcaccountmgmt.password.reset_spec |
The reset_spec structure contains information that is required to reset a service account password. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
service account
The service_account interface provides operations to manage service accounts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.svcaccountmgmt.service_account.create_spec |
The create_spec structure contains information to create a new service account. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.svcaccountmgmt.service_account.delete_spec |
The delete_spec structure contains information that is required for the deletion of the service account. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.svcaccountmgmt.service_account.output_spec |
The output_spec structure contains information that is returned on successful creation of the service account. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
vcenter system
The vcenter.system API provides services for getting system information in vCenter.
announcements
The announcements service provides operations to manage system wide announcements
| Type |
Description |
| vcenter.system.announcements.info |
The info structure defines the announcement properties. Note: This structure is restricted for VMware internal use only. |
| vcenter.system.announcements.spec |
The spec structure defines the announcement properties for set and create operations. Note: This structure is restricted for VMware internal use only. |
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.
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.
vcenter tag associations
host
The host service provides operations to query tag associations that have a host identifier. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.tag_associations.host.filter_spec |
The filter_spec structure contains fields used to filter the results when listing tags associated to hosts, see list). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.tag_associations.host.iteration_spec |
The iteration_spec structure contains fields used to break results into pages when listing tags associated to hosts, see list). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.tag_associations.host.list_result |
The list_result structure contains the list of tag associations in a page, as well as related metadata fields. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.tag_associations.host.summary |
The summary describes a tag association. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
VM
The VM service provides operations to manage tag associations that have a virtual machine identifier. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.tag_associations.VM.filter_spec |
The filter_spec structure contains fields used to filter the results when listing tags associated to virtual machines, see list). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.tag_associations.VM.iteration_spec |
The iteration_spec structure contains fields used to break results into pages when listing tags associated to virtual machines, see list). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.tag_associations.VM.list_result |
The list_result structure contains the list of tag associations in a page, as well as related metadata fields. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.tag_associations.VM.summary |
The summary describes a tag association. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
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.0.
The host service provides operations to manage which tags can be associated with hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.tags.host.filter_spec |
The filter_spec structure contains fields used to filter the results when listing tags associated to hosts, see list. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.tags.host.list_result |
The list_result structure contains commonly used information about tags that are assigned to hosts. See list. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.tags.host.summary |
The summary structure contains commonly used information about a tag that is assigned to a host. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
The associations service provides operations to manage associations of a single tag to multiple hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.tags.host.associations.status |
The status structure contains fields that are used to describe the outcome of the add/remove operations. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
The VM service provides operations to manage which tags can be associated with virtual machines. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.tags.VM.filter_spec |
The filter_spec structure contains fields used to filter the results when listing tags associated to virtual machines, see list). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.tags.VM.list_result |
The list_result structure contains commonly used information about tags that are assigned to virtual machines. See list. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.tags.VM.summary |
The summary structure contains commonly used information about a tag that is assigned to a virtual machine. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
The associations service provides operations to manage associations of a single tag to multiple virtual machines. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.tags.vm.associations.status |
The status structure contains fields that are used to describe the outcome of the add/remove operations. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
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: - 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.
- 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).
vcenter topology
The vcenter.topology API provides services to retrieve all vCenter and Platform Services Controller nodes and replication status in the topology.
vcenter topology nodes
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. |
embedded
The embedded service provides operations to manage the vCenter Server node in the topology. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.topology.nodes.embedded.decommission_spec |
The decommission_spec structure contains information about the vCenter Server node to be decommissioned. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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.
vcenter trust
The vcenter.trust API provides services to manage VcTrusts.
subscriptions
The subscriptions interface provides operations to create, update, delete and list vCenter trusts subscription. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.trust.subscriptions.create_spec |
The create_spec structure contains information to create a vctrust subscription. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.trust.subscriptions.info |
The info structure contains id and expiration data about a vctrust subscription. It is used as return value when adding a vctrust. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.trust.subscriptions.info_details |
The info_details structure contains detailed information about a subscription. It is only returned when the client ask for a "info" request for that subscription. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
vc trusts
The vc_trusts interface provides operations to create, modify, delete and read vCenter trusts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.trust.vc_trusts.create_spec |
The create_spec structure contains information to create a trust. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.trust.vc_trusts.info |
The info structure contains data that represents a trust. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.trust.vc_trusts.summary |
The summary structure contains a trust summary suitable for UI presentation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
| vcenter.trust.vc_trusts.update_spec |
The update_spec structure contains data to update a VcTrusts spec. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
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.
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.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.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.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.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.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.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.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.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.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.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.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.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.0.
csr
The csr interface provides operations to create a certificate signing request(CSR). This service was added in vSphere API 7.0.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.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.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.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.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.0.
vcenter trusted infrastructure trusted clusters
The vcenter.trusted_infrastructure.trusted_clusters API provides services for configuring Trusted Clusters.
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.0.
services applied config
The services_applied_config service provides information about the aggregate health of the applied Attestation Service configuration on the Trusted Clusters. The desired state of the Attestation Service is stored within vCenter, while the applied configuration is stored on the hosts in the cluster. The services_applied_config service is available for all clusters, not only Trusted Clusters. In such cases empty desired state is assumed, e.g. when an applied Attestation Service configuration is found outside of a Trusted Cluster it is considered an ERROR. The services_applied_config service is able to put the applied Attestation Service configuration into a consistent state when individual host configurations have diverged from the desired state. This service was added in vSphere API 7.0.1.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.0.
services applied config
The services_applied_config service provides information about the aggregate health of the applied Key Provider Service configuration on the Trusted Clusters. The desired state of the Key Provider Service is stored within vCenter, while the applied configuration is stored on the hosts in the cluster. The services_applied_config service is available for all clusters, not only Trusted Clusters. In such cases empty desired state is assumed, e.g. when an applied Key Provider Service configuration is found outside of a Trusted Cluster it is considered an ERROR. The services_applied_config service is able to put the applied Key Provider Service configuration into a consistent state when individual host configurations have diverged from the desired state. This service was added in vSphere API 7.0.1.0.
services applied config
The services_applied_config service provides information about the aggregate health of the applied Trust Authority Component configurations on the Trusted Clusters. The desired state of the Trust Authority Component configurations is stored within vCenter, while the applied configuration is stored on the hosts in the cluster and is a copy of the desired state. The services_applied_config service is available for all clusters, not only Trusted Clusters. When an applied Trust Authority Component configuration is found outside of a Trusted Cluster it is considered an ERROR. The services_applied_config service is able to make the applied Trust Authority Component configuration consistent with the desired state when individual host configurations have diverged from the desired state. This service was added in vSphere API 7.0.1.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. |
capabilities
The capabilities service provides operations to get the capabilities of a vCenter High Availability (VCHA) node. This service was added in vSphere API 6.7.1.
| Type |
Description |
| vcenter.vcha.capabilities.info |
The info structure contains information about the capabilities of the active node of a VCHA configuration. This structure was added in vSphere API 6.7.1. Note: This structure is restricted for VMware internal use only. |
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.
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.
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.
license
The license service provides operations to get the license of a vCenter High Availability (VCHA) feature. This service was added in vSphere API 7.0.0.1.
| Type |
Description |
| vcenter.vcha.license.info |
The info structure contains information about the license of the active node of a VCHA configuration. This structure was added in vSphere API 7.0.0.1. Note: This structure is restricted for VMware internal use only. |
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.
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. This service was added in vSphere API 7.0.0.2.
| Type |
Description |
| vcenter.vm.console.tickets.create_spec |
The create_spec structure defines the information used to create the virtual machine console ticket. This structure was added in vSphere API 7.0.0.2. |
| vcenter.vm.console.tickets.summary |
The summary structure contains commonly used information about the virtual machine console ticket. This structure was added in vSphere API 7.0.0.2. |
data sets
The data_sets service provides operations for sharing information between a virtual machine and its guest operating system. Information is grouped into data sets, each of which contains key-value entries comprising the data. It's expected that each application using the service will have at least one unique data set in which to store its data to avoid conflict with other applications. Each data set has attributes defining its size limitations, access control and interoperability configuration.
It's not recommended that sensitive data (for example, passwords or private keys) be stored in plain-text. The data will be visible to other applications, running both on the management network and within the guest. The data can also be exposed by backups or templates.
Data set support requires the the virtual machine be at virtual hardware version XXX or later.
Data sets should only be modified by the application that creates them. Otherwise the application may stop working.
. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.vm.data_sets.create_spec |
The create_spec structure describes a data set to be created. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.data_sets.info |
The info structure describes a data set. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.data_sets.summary |
Basic data set information. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.data_sets.update_spec |
The update_spec structure describes attibutes of a data set that can be modified. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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.credentials |
The credentials structure defines the guest credentials used for guest operation authentication. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| 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.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.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.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.0.
| Type |
Description |
| vcenter.vm.guest.customization.info |
The info structure contains the status of a customization operation applied to a virtual machine. This structure was added in vSphere API 7.0.0.0. |
| 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.0. |
vcenter vm guest filesystem
The vcenter.vm.guest.filesystem API provides services for dealing with the filesystem of the guest operating system.
| Type |
Description |
| vcenter.vm.guest.filesystem.file_error_details |
The file_error_details structure describes additional error information for file and directory operations. XXX standard enhanced error link XXX. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
files
The files service provides operations to manage the files in the guest filesystem. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.vm.guest.filesystem.files.file_attributes_info |
The file_attributes_info structure describes the attributes of a file in a guest operating system. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.files.file_attributes_update_spec |
File attributes used for updating an existing file with update. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.files.filter_spec |
The filter_spec structure contains information used to filter the results when listing files (see list). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.files.info |
The info structure describes a file or directory in the guest operating system. Returned by get. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.files.iteration_spec |
The iteration_spec structure contains fields used to break results into pages when listing files. See list). Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.files.list_result |
The list_result structure describes the results of a list operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.files.posix_file_attributes_info |
The posix_file_attributes_info structure describes information about file attributes specific to Posix Guest operating systems. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.files.posix_file_attributes_update_spec |
The posix_file_attributes_update_spec structure describes attributes that can be changed for a Posix file. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.files.summary |
The summary structure describes a file or directory in the guest operating system returned by a list operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.files.windows_file_attributes_info |
The {@name WindowsFileAttributesInfo) structure describes file attributes specific to Windows Guest operating systems. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.files.windows_file_attributes_update_spec |
The windows_file_attributes_update_spec structure describes attributes that can be changed for a Windows file. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
transfers
The transfers service provides operations to copy files into and out of the guest file system. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.vm.guest.filesystem.transfers.file_attributes_create_spec |
The file_attributes_create_spec structure describes file attributes used when creating a new file with put. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.transfers.posix_file_attributes_create_spec |
The posix_file_attributes_create_spec structure describes creation information about file attributes specific to Posix guest operating systems. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.filesystem.transfers.windows_file_attributes_create_spec |
The windows_file_attributes_create_spec structure describes creation information about file attributes specific to Windows guest operating systems. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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.
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.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.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.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.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.0. |
operations
Status of operations in the guest OS. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.vm.guest.operations.info |
Guest operating system operation status information. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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. |
processes
The processes service provides operations to manage processes in the guest operating system. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.vm.guest.processes.create_spec |
The create_spec structure describes the arguments to create. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.processes.info |
The info structure describes the state of a guest process. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.processes.process_error_details |
The process_error_details structure describes additional error information for process operations. XXX add comment with proper linkage to Error XXX. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.guest.processes.summary |
The summary structure describes the state of a guest process. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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.nvme_address_info |
The nvme_address_info structure contains information about the address of a virtual device that is attached to a virtual NVMe adapter of a virtual machine. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.hardware.nvme_address_spec |
The nvme_address_spec structure contains information for specifying the address of a virtual device that is attached to a virtual NVMe adapter of a virtual machine. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| 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.
nvme
The nvme service provides operations for configuring the virtual NVMe adapters of a virtual machine. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.vm.hardware.adapter.nvme.create_spec |
The create_spec structure provides a specification for the configuration of a newly-created virtual NVMe adapter. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.hardware.adapter.nvme.info |
The info structure contains information about a virtual NVMe adapter. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vm.hardware.adapter.nvme.summary |
The summary structure contains commonly used information about a Virtual NVMe adapter. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
sata
The sata service provides operations for configuring the virtual SATA adapters of a virtual machine.
scsi
The scsi service provides operations for configuring the virtual SCSI adapters of a virtual machine.
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.
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:
- CDROM: Boot from a virtual CD-ROM drive; the device instance(s) will be chosen by the BIOS subsystem.
- FLOPPY: Boot from a virtual floppy drive; the device instance(s) will be chosen by the BIOS subsystem.
- DISK: Boot from a virtual disk device; the device instance is specified explicitly in vcenter.vm.hardware.boot.device.entry.disks list, and multiple instances may be specified in the list.
- ETHERNET: Boot from a virtual Ethernet adapter; the device instance is specified explicitly as vcenter.vm.hardware.boot.device.entry.nic, and multiple adapters may be specified in the boot order list.
| 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.
cpu
The cpu service provides operations for configuring the CPU 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.
ethernet
The ethernet service provides operations for configuring the virtual Ethernet adapters of a virtual machine.
floppy
The floppy service provides operations for configuring the virtual floppy drives of a virtual machine.
memory
The memory service provides operations for configuring the memory settings of a virtual machine.
parallel
The parallel service provides operations for configuring the virtual parallel ports of a virtual machine.
serial
The serial service provides operations for configuring the virtual serial ports of a virtual machine.
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. |
The tags service provides operations to manage tag associations of a virtual machine. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.vm.tags.status |
The status structure contains fields that are used to describe the outcome of the add/remove operations that operate on multiple tags. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This structure is restricted for VMware internal use only. |
The vcenter.vm API provides services for managing VMware 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.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.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.0. |
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.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.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.
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.
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.
vcenter vmwportal
The vcenter.vmwportal API provides services for connecting to my.vmware.com and download binaries.
accounts
The accounts service represents all the operations details of user accounts on my.vmware.com portal. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.vmwportal.accounts.check_spec |
The check_spec structure contains the product name for which we are checking the entitlement. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vcenter.vmwportal.accounts.summary |
The summary structure contains the information about the entitlement account. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
authentication
The authentication service allows the admin to login to my.vmware.com using the my.vmware.com account. This API is prerequisite for APIs that download binaries from my.vmware.com such as the NSX stage download API. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vcenter.vmwportal.authentication.create_spec |
The create_spec structure contains the basic authentication credentials for my.vmware.com portal. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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. |
cache
The cache service provides operations to keep cache of vstats on different platforms in sync. It invloves synchronization of internal AcqSpecs. 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.cache.acq_spec |
The acq_spec structure contains information for a new or updated 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. Note: This structure is restricted for VMware internal use only. |
| vstats.cache.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. Note: This structure is restricted for VMware internal use only. |
| vstats.cache.query_spec |
The query_spec structure contains fields that can be used to get data to sync from a particular time epoch in paginated manner. 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. Note: This structure is restricted for VMware internal use only. |
| vstats.cache.sync_result |
The sync_result structure contains fields sent by server which will be consumed/synced by client. 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. Note: This structure is restricted for VMware internal use only. |
configuration
The configuration service provides operations to manipulate vStats service configuration. 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.configuration.info |
The info structure contains vStats configuration. 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. Note: This structure is restricted for VMware internal use only. |
| vstats.configuration.update_spec |
The update_spec structure contains modifiable fields from vStats configuration. 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. Note: This structure is restricted for VMware internal use only. |
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. |
endpoints
The endpoints service provides operations to configure endpoints for pushing stats data. To configure an endpoint use the create operation to create an endpoint configuration. The vstats.endpoints.info structure represents an endpoint configuration. It designates the authentication details and endpoint type details. After creating an endpoint, you can retrieve, modify, or remove the endpoint. See the descriptions of the list, update, and delete operations. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vstats.endpoints.auth_spec |
The auth_spec structure contains authentication information of the endpoint. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vstats.endpoints.basic_auth |
The basic_auth structure contains basic authentication information of the endpoint. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vstats.endpoints.create_spec |
The create_spec structure contains information to create a new endpoint configuration in vStats. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vstats.endpoints.filter_spec |
The filter_spec structure contains fields used to filter the results when listing endpoints. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vstats.endpoints.info |
The info structure is the endpoint configuration that contains the information pertaining to an endpoint. It contains the authentication details specifying only username, data format supported at endpoint side, status of an endpoint and also number of acquisition specifications associated with this endpoint. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| vstats.endpoints.update_spec |
The update_spec structure contains fields that can be updated in an endpoint. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
health
The health service provides access to vStats health. 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.health.info |
The info structure contains service health 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. Note: This structure is restricted for VMware internal use only. |
management
The management service provides operations to perform various management related operations. The service provides access to the database settings of the system. 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.management.dbs_config |
The dbs_config structure specifies configuration of database connection. 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. Note: This structure is restricted for VMware internal use only. |
| vstats.management.dbs_configs |
The dbs_configs structure specifies configuration information of the databases. 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. Note: This structure is restricted for VMware internal use only. |
| vstats.management.info |
The info structure contains information about the database configuration of the vstats service. 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. Note: This structure is restricted for VMware internal use only. |
| vstats.management.tsdb_size_info |
The tsdb_size_info structure contains Time-series-database (TSDB) size 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. Note: This structure is restricted for VMware internal use only. |
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. |
The push_data_formats service provides list of supported push data formats by vstats. A push data format is the type of format expected at the endpoint. The stats data collected need to be sent in this format when an endpoint is configured with a chosen push data format from this list. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
| Type |
Description |
| vstats.push_data_formats.summary |
The summary structure contains summary of push data formats. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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. |
retention plans
The retention_plans service manages the retention settings of the product. 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.retention_plans.info |
info structure describes a data retention plan. 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. Note: This structure is restricted for VMware internal use only. |
| vstats.retention_plans.max_ages_info |
The max_ages_info structure specifies retention times for roll up intervals. The intervals are specified in seconds. 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. Note: This structure is restricted for VMware internal use only. |
telemetry
The telemetry service provides operations to retrieve telemetry 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.telemetry.filter_spec |
filter_spec structure describes filter criteria for telemetry. 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. Note: This structure is restricted for VMware internal use only. |
| vstats.telemetry.info |
The info structure contains overall telemetry 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. Note: This structure is restricted for VMware internal use only. |
| vstats.telemetry.telemetry_counter |
The telemetry_counter structure specifies vStats monotonically increasing integer. 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. Note: This structure is restricted for VMware internal use only. |
| vstats.telemetry.telemetry_gauge |
The telemetry_gauge structure specifies vStats telemetry-gauge, both integer and floating point are presented here. 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. Note: This structure is restricted for VMware internal use only. |
| vstats.telemetry.telemetry_histogram |
The telemetry_histogram structure specifies vStats telemetry-histogram. 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. Note: This structure is restricted for VMware internal use only. |
| vstats.telemetry.telemetry_meter |
The telemetry_meter structure specifies vStats telemetry-meter. 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. Note: This structure is restricted for VMware internal use only. |
| vstats.telemetry.telemetry_timer |
The telemetry_timer structure specifies vStats telemetry-timer. Units are in nanoseconds. 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. Note: This structure is restricted for VMware internal use only. |