Developer Documentation
BETA
API Reference
PowerCLI Reference
vSphere Automation API
Appliance REST APIs
All Data Structures
vAPI Error
REST Error
AccessConsolecliGetResponseBody
AccessConsolecliSetRequestBody
AccessDcuiGetResponseBody
AccessDcuiSetRequestBody
AccessShellShellConfig
AccessShellGetResponseBody
AccessShellSetRequestBody
AccessSshGetResponseBody
AccessSshSetRequestBody
HealthMessagesResponseBody
LocalAccountsConfig
LocalAccountsInfo
LocalAccountsUpdateConfig
LocalAccountsCreateRequestBody
LocalAccountsGetResponseBody
LocalAccountsListResponseBody
LocalAccountsSetRequestBody
LocalAccountsUpdateRequestBody
MonitoringGetResponseBody
MonitoringListResponseBody
MonitoringQueryResponseBody
MonitoringMonitoredItemDataRequest
MonitoringMonitoredItem
MonitoringMonitoredItemData
MonitoringIntervalType
MonitoringFunctionType
NetworkingDnsServersDNSServerConfig
NetworkingInterfacesIpv6Config
NetworkingDNSInfoDNSMode
NetworkingDNSInfo
NetworkingGetResponseBody
NetworkingInfo
NetworkingChangetaskRequestBody
NetworkingChangeTaskResponseBody
NetworkingChangeSpec
NetworkingUpdateSpec
NetworkingUpdateRequestBody
NetworkingInterfacesIpv4Config
NtpServerStatus
NtpGetResponseBody
NtpSetRequestBody
NtpTestRequestBody
NtpTestResponseBody
NtpTestRunStatus
NtpLocalizableMessage
RecoveryInfo
RecoveryGetResponseBody
ServicesListResponseBody
ServicesInfo
ServicesState
ServicesGetResponseBody
ShutdownShutdownConfig
ShutdownGetResponseBody
ShutdownPoweroffRequestBody
ShutdownRebootRequestBody
TimesyncTimeSyncMode
TimesyncGetResponseBody
TimesyncSetRequestBody
UpdateInfo
UpdateState
UpdateGetResponseBody
TaskInfo
HealthApplmgmtGetResponseBody
HealthDatabasestorageGetResponseBody
HealthDatabasestorageHealthLevel
HealthLoadHealthLevel
HealthLoadGetResponseBody
HealthMemHealthLevel
HealthMemGetResponseBody
HealthSoftwarepackagesHealthLevel
HealthSoftwarepackagesGetResponseBody
HealthStorageHealthLevel
HealthStorageGetResponseBody
HealthSwapHealthLevel
HealthSwapGetResponseBody
HealthSystemHealthLevel
HealthSystemGetResponseBody
HealthSystemLastcheckResponseBody
InfraprofileConfigsImportProfileSpec
InfraprofileConfigsValidationStatus
InfraprofileConfigsProfileInfo
InfraprofileConfigsValidationResult
InfraprofileNotifications
InfraprofileConfigsProfilesSpec
LocalAccountsPolicyInfo
LocalAccountsPolicyGetResponseBody
LocalAccountsPolicySetRequestBody
LoggingForwardingProtocol
LoggingForwardingGetResponseBody
LoggingForwardingSetRequestBody
LoggingForwardingTestRequestBody
LoggingForwardingTestResponseBody
LoggingForwardingConnectionStatusState
LoggingForwardingConnectionStatus
LoggingForwardingConfig
NetworkingInterfacesInterfaceInfo
NetworkingInterfacesInterfaceStatus
NetworkingInterfacesGetResponseBody
NetworkingInterfacesListResponseBody
NetworkingInterfacesIpv4Info
NetworkingInterfacesIpv6Info
NetworkingNoProxyGetResponseBody
NetworkingNoProxySetRequestBody
NetworkingProxyProtocol
NetworkingProxyTestRequestBody
NetworkingProxyListResponseBody
NetworkingProxySetRequestBody
NetworkingProxyGetResponseBody
NetworkingProxyTestResponseBody
NetworkingProxyServerStatus
NetworkingProxyConfig
NetworkingProxyTestResult
NetworkingDnsDomainsAddRequestBody
NetworkingDnsDomainsListResponseBody
NetworkingDnsDomainsSetRequestBody
NetworkingDnsHostnameTestStatusInfo
NetworkingDnsHostnameMessageStatus
NetworkingDnsHostnameTestStatus
NetworkingDnsHostnameGetResponseBody
NetworkingDnsHostnameSetRequestBody
NetworkingDnsHostnameTestRequestBody
NetworkingDnsHostnameTestResponseBody
NetworkingDnsHostnameMessage
NetworkingDnsServersTestResponseBody
NetworkingDnsServersTestStatusInfo
NetworkingDnsServersGetResponseBody
NetworkingDnsServersDNSServerMode
NetworkingDnsServersTestRequestBody
NetworkingDnsServersSetRequestBody
NetworkingDnsServersTestStatus
NetworkingDnsServersAddRequestBody
NetworkingDnsServersMessage
NetworkingDnsServersMessageStatus
NetworkingFirewallInboundSetRequestBody
NetworkingFirewallInboundRule
NetworkingFirewallInboundPolicy
NetworkingFirewallInboundGetResponseBody
NetworkingInterfacesIpv4Mode
NetworkingInterfacesIpv4GetResponseBody
NetworkingInterfacesIpv4SetRequestBody
NetworkingInterfacesIpv6AddressInfo
NetworkingInterfacesIpv6Origin
NetworkingInterfacesIpv6Status
NetworkingInterfacesIpv6GetResponseBody
NetworkingInterfacesIpv6SetRequestBody
NetworkingInterfacesIpv6Address
RecoveryBackupValidateRequestBody
RecoveryBackupValidateResponseBody
RecoveryBackupLocalizableMessage
RecoveryBackupReturnResult
RecoveryBackupBackupRequest
RecoveryBackupLocationType
RecoveryBackupReturnStatus
RecoveryRestoreMetadata
RecoveryRestoreLocalizableMessage
RecoveryRestoreLocationType
RecoveryRestoreValidateRequestBody
RecoveryRestoreValidateResponseBody
RecoveryRestoreRestoreRequest
RecoveryBackupJobListResponseBody
RecoveryBackupJobLocalizableMessage
RecoveryBackupJobGetResponseBody
RecoveryBackupJobBackupJobStatus
RecoveryBackupJobLocationType
RecoveryBackupJobCancelResponseBody
RecoveryBackupJobBackupRequest
RecoveryBackupJobCreateRequestBody
RecoveryBackupJobReturnResult
RecoveryBackupJobReturnStatus
RecoveryBackupJobBackupRestoreProcessState
RecoveryBackupJobCreateResponseBody
RecoveryBackupPartsPart
RecoveryBackupPartsLocalizableMessage
RecoveryBackupPartsGetResponseBody
RecoveryBackupPartsListResponseBody
RecoveryBackupSchedulesCreateRequestBody
RecoveryBackupSchedulesListResponseBody
RecoveryBackupSchedulesRunRequestBody
RecoveryBackupSchedulesRunResponseBody
RecoveryBackupSchedulesGetResponseBody
RecoveryBackupSchedulesRecurrenceInfo
RecoveryBackupSchedulesRetentionInfo
RecoveryBackupSchedulesDayOfWeek
RecoveryBackupSchedulesUpdateRequestBody
RecoveryBackupSchedulesUpdateSpec
RecoveryBackupSchedulesCreateSpec
RecoveryBackupSchedulesInfo
RecoveryBackupSystemNameListResponseBody
RecoveryBackupJobDetailsType
RecoveryBackupJobDetailsListResponseBody
RecoveryBackupJobDetailsInfo
RecoveryBackupJobDetailsFilterSpec
RecoveryBackupJobDetailsBuildInfo
RecoveryBackupSystemNameArchiveInfo
RecoveryBackupSystemNameArchiveFilterSpec
RecoveryBackupSystemNameArchiveSummary
RecoveryBackupSystemNameArchiveGetResponseBody
RecoveryBackupSystemNameArchiveListResponseBody
RecoveryReconciliationJobInfo
RecoveryReconciliationJobCreateSpec
RecoveryReconciliationJobStatus
RecoveryReconciliationJobCreateRequestBody
RecoveryReconciliationJobCreateResponseBody
RecoveryReconciliationJobGetResponseBody
RecoveryRestoreJobReturnStatus
RecoveryRestoreJobRestoreJobStatus
RecoveryRestoreJobBackupRestoreProcessState
RecoveryRestoreJobRestoreRequest
RecoveryRestoreJobLocationType
RecoveryRestoreJobCancelResponseBody
RecoveryRestoreJobCreateRequestBody
RecoveryRestoreJobGetResponseBody
RecoveryRestoreJobLocalizableMessage
RecoveryRestoreJobReturnResult
RecoveryRestoreJobCreateResponseBody
SystemStorageStorageChange
SystemStorageStorageMapping
SystemStorageListResponseBody
SystemStorageResizeExResponseBody
SystemTimeSystemTimeStruct
SystemTimeGetResponseBody
SystemUptimeGetResponseBody
SystemVersionVersionStruct
SystemVersionGetResponseBody
SystemSecurityGlobalFipsInfo
SystemSecurityGlobalFipsUpdateSpec
SystemTimeTimezoneGetResponseBody
SystemTimeTimezoneSetRequestBody
UpdatePendingStageAndInstallRequestBody
UpdatePendingValidateRequestBody
UpdatePendingInfo
UpdatePendingQuestionInputType
UpdatePendingSourceType
UpdatePendingListResponseBody
UpdatePendingPrecheckResponseBody
UpdatePendingPrecheckResult
UpdatePendingGetResponseBody
UpdatePendingInstallRequestBody
Notifications
UpdatePendingQuestion
UpdatePendingValidateResponseBody
UpdatePolicyConfig
UpdatePolicyInfo
UpdatePolicyDayOfWeek
UpdatePolicyGetResponseBody
UpdatePolicySetRequestBody
UpdatePolicyTime
UpdateStagedInfo
UpdateStagedGetResponseBody
VcenterSettingsV1Notifications
VcenterSettingsV1DesiredState
VcenterSettingsV1ConfigInfo
VcenterSettingsV1ConfigScanSpec
VcenterSettingsV1ConfigCreateSpec
VmonServiceUpdateRequestBody
VmonServiceInfo
VmonServiceUpdateSpec
VmonServiceStartupType
VmonServiceHealth
VmonServiceState
VmonServiceGetResponseBody
VmonServiceListDetailsResponseBody
Notification
SubtaskInfo
InfraprofileTaskInfo
InfraprofileNotification
UpdateCommonInfoPriority
UpdateCommonInfoSeverity
UpdateCommonInfoCategory
UpdateCommonInfo
UpdateServiceInfo
UpdateSummary
VcenterSettingsV1ComplianceResult
VcenterSettingsV1ScanResultComplianceStatus
VcenterSettingsV1ScanResult
VcenterSettingsV1DiffResult
VcenterSettingsV1Notification
VcenterSettingsV1TaskInfo
VcenterSettingsV1ConfigComponentsApplmgmtConsolecli
VcenterSettingsV1ConfigComponentsApplmgmtDnsServerConfiguration
VcenterSettingsV1ConfigComponentsApplmgmtFirewallRulePolicy
VcenterSettingsV1ConfigComponentsApplmgmtShell
VcenterSettingsV1ConfigComponentsApplmgmtSoftwareUpdatePolicyAutoUpdateNotification
VcenterSettingsV1ConfigComponentsApplmgmtLocalAccountsPolicy
VcenterSettingsV1ConfigComponentsApplmgmtFirewallRulePolicyPolicy
VcenterSettingsV1ConfigComponentsApplmgmtSmtp
VcenterSettingsV1ConfigComponentsApplmgmtApplianceManagement
VcenterSettingsV1ConfigComponentsApplmgmtProxyConfiguration
VcenterSettingsV1ConfigComponentsApplmgmtApplianceNetwork
VcenterSettingsV1ConfigComponentsApplmgmtTime
VcenterSettingsV1ConfigComponentsApplmgmtLogForwardingProtocol
VcenterSettingsV1ConfigComponentsApplmgmtLogForwarding
VcenterSettingsV1ConfigComponentsApplmgmtNtp
VcenterSettingsV1ConfigComponentsApplmgmtRetentionInfo
VcenterSettingsV1ConfigComponentsApplmgmtProxyConfigurationProtocol
VcenterSettingsV1ConfigComponentsApplmgmtDcui
VcenterSettingsV1ConfigComponentsApplmgmtLocalAccounts
VcenterSettingsV1ConfigComponentsApplmgmtTimesyncTimeSyncMode
VcenterSettingsV1ConfigComponentsApplmgmtTimesync
VcenterSettingsV1ConfigComponentsApplmgmtBackupSchedule
VcenterSettingsV1ConfigComponentsApplmgmtTimeUpdateDay
VcenterSettingsV1ConfigComponentsApplmgmtSsh
VcenterSettingsV1ConfigComponentsApplmgmtRecurrenceInfoDayOfWeek
VcenterSettingsV1ConfigComponentsApplmgmtRecurrenceInfo
VcenterSettingsV1ConfigComponentsApplmgmtSoftwareUpdatePolicy
VcenterSettingsV1ConfigComponentsApplmgmtDnsServerConfigurationDNSServerMode
VcenterSettingsV1ConfigComponentsApplmgmtTimezone
VcenterSettingsV1ConfigComponentsAuthmanagementGlobalPermission
VcenterSettingsV1ConfigComponentsAuthmanagementTokenPolicy
VcenterSettingsV1ConfigComponentsAuthmanagementLockoutPolicy
VcenterSettingsV1ConfigComponentsAuthmanagementPasswordPolicy
VcenterSettingsV1ConfigComponentsAuthmanagementPrincipal
VcenterSettingsV1ConfigComponentsAuthmanagementAuthenticationManagement
VcenterSettingsV1ConfigComponentsAuthmanagementPrivileges
VcenterSettingsV1ConfigComponentsAuthmanagementRoles
RecoveryBackupLocationSpec
Getting Started
API Categories
Access
Expand
Appliance
Expand
Health
Expand
Infraprofile
Expand
Local Accounts
Expand
Logging
Expand
Networking
Expand
Recovery
Expand
System
Expand
Update
Expand
vCenter
Expand
vMon
Expand
Data Structures
REST API Index
Feedback
Was this page helpful?
Yes
No
Your feedback will be directly sent to the engineers.
Submit