Vcenter Host create
Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by Vcenter Host CreateSpec ThumbprintVerification.
Specification for the new host to be created.
Show optional properties
{
"hostname": "string",
"user_name": "string",
"password": "string",
"thumbprint_verification": "string"
}{
"hostname": "string",
"port": 0,
"user_name": "string",
"password": "string",
"folder": "string",
"thumbprint_verification": "string",
"thumbprint": "string",
"ssl_certificate": "string",
"force_add": false
}The IP address or DNS resolvable name of the host.
The port of the host.
If missing or null, port 443 will be used.
The administrator account on the host.
The password for the administrator account on the host.
Host and cluster folder in which the new standalone host should be created.
This property is currently required. In the future, if this property is missing or null, the system will attempt to choose a suitable folder for the host; if a folder cannot be chosen, the host creation operation will fail.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Folder. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Folder.
Type of host's SSL certificate verification to be done.
For more information see: Vcenter Host CreateSpec ThumbprintVerification.
The thumbprint of the SSL certificate, which the host is expected to have. The thumbprint is always computed using the SHA1 hash and is the string representation of that hash in the format: xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx where, 'x' represents a hexadecimal digit.
This property is optional and it is only relevant when the value of thumbprint_verification is Vcenter Host CreateSpec ThumbprintVerification.THUMBPRINT.
The SSL certificate in PEM format, which the host is expected to have.
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of thumbprint_verification is Vcenter Host CreateSpec ThumbprintVerification.CERTIFICATE.
Whether host should be added to the vCenter Server even if it is being managed by another vCenter Server. The original vCenterServer loses connection to the host.
If missing or null, forceAdd is default to false.
The newly created identifier of the host in vCenter.
The response will be an identifier for the resource type: HostSystem.
Vapi Std Errors AlreadyExists if the host with the same name is already present.
Vapi Std Errors InvalidArgument:
- if the host name is invalid.
- if the host folder is invalid.
- if the SSL thumbprint specified is invalid.
- if the PEM SSL certificate in CreateSpec.sslCertificate is invalid.
- if both CreateSpec.thumbprint and CreateSpec.sslCertificate are set.
- if the CreateSpec.sslCertificate argument is not set, and the CreateSpec.thumbprint argument is set, but the SHA-1 hashing algorithm is currently disabled for computing certificate thumbprints.
Vapi Std Errors InvalidElementType if the host folder id does not support vSphere compute resource as its children type.
Vapi Std Errors ResourceInUse if the host is already being managed by another vCenter Server
Vapi Std Errors Unsupported if the software version on the host is not supported.
"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 user name or password for the administration account on the host are invalid.
if the user can not be 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 the user doesn't have the required privileges.
"Vapi Std Errors Unauthorized Object"if there is no folder associated with the folder property in the system.
"Vapi Std Errors NotFound Object"Vapi Std Errors Error:
- if installation of VirtualCenter agent on a host fails.
- if the system reports an error while responding to the request.
Vapi Std Errors UnableToAllocateResource if there are not enough licenses to add the host.
"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 system is unable to communicate with a service to complete the request.
"Vapi Std Errors ServiceUnavailable Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"hostname:"string","password:"string","thumbprint_verification:"string","user_name:"string"}' https://{api_host}/api/vcenter/host