Esx Hosts Software get
Returns details about the current software specification applied to the host.
This operation was added in vSphere API 7.0.2.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VcIntegrity.lifecycleSoftwareSpecification.Read.
ConnectionSpec connection spec for the host.
Show optional properties
{
"auth_type": "string"
}{
"auth_type": "string",
"host_credential": {
"host_name": "string",
"user_name": "string",
"password": "string",
"port": 0,
"ssl_thumb_print": "string",
"ssl_certificate": "string"
},
"host": "string"
}Specifies what type of authentication (AuthenticationType) is to be used when connecting with the host. USERNAME_PASSWORD is intended to be used when connecting to a host that is not currently part of the vCenter inventory. EXISTING is intented for hosts that are in vCenter inventory, in which case, HostServiceTicket will be used to connect to the host.
For more information see: Esx Hosts Software ConnectionSpec AuthenticationType.
This property was added in vSphere API 7.0.2.0.
Specifies the host details to be used during the GET /esx/software operation
This property was added in vSphere API 7.0.2.0.
This property is optional and it is only relevant when the value of auth_type is Esx Hosts Software ConnectionSpec AuthenticationType.USERNAME_PASSWORD.
Specifies the host Managed Object ID to be used during the GET /esx/software operation
This property was added in vSphere API 7.0.2.0.
This property is optional and it is only relevant when the value of auth_type is Esx Hosts Software ConnectionSpec AuthenticationType.EXISTING.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.
Info details about the current software specification applied to the host.
"Esx Hosts Software Info Object"Notifications returned by the get operation.
This property was added in vSphere API 7.0.2.0.
Host software information returned by the get operation.
This property was added in vSphere API 7.0.2.0.
Vapi Std Errors InvalidArgument if the ConnectionSpec.HostCredentials property of spec is invalid.
Vapi Std Errors UnverifiedPeer If the SSL certificate of the target node cannot be validated by comparing with the thumbprint provided in ConnectionSpec.HostCredentials#sslThumbPrint or the full certificate provided in ConnectionSpec.HostCredentials#sslCertificate. The value of the {@link UnverifiedPeer#data) {@term field} will be a {@term structure} that contains the {@term fields} defined in {@link com.vmware.esx.hosts.CertificateInfo}.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the caller is not authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
If there is no ConnectionSpec.HostCredentials#hostName property associated with host id in the system.
"Vapi Std Errors NotFound Object"If there is some unknown internal error. The accompanying error message will give more details about the failure.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
If the service is not available.
"Vapi Std Errors ServiceUnavailable Object" curl -H 'Authorization: <value>' https://{api_host}/api/esx/software