vcenter_host

Add a new standalone host in the vCenter inventory

Collection: vmware.vmware_rest

Full Name: vmware.vmware_rest.vcenter_host

Synopsis

Add a new standalone host in the vCenter inventory

Parameters

Name	Type	Required	Default	Description
vcenter_hostname	string	yes		The hostname or IP address of the vSphere vCenter
If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead.
vcenter_username	string	yes		The vSphere vCenter username
If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead.
vcenter_password	string	yes		The vSphere vCenter password
If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead.
vcenter_validate_certs	bool		`true`	Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted.
If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead.
vcenter_rest_log_file	string			You can use this optional parameter to set the location of a log file.
This file will be used to record the HTTP REST interaction.
The file will be stored on the host that runs the module.
If the value is not specified in the task, the value of
environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
session_timeout	float			Timeout settings for client session.
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
The default value is 300s.
folder	string			Host and cluster folder in which the new standalone host should be created.
This field is currently required. In the future, if this field is unset, 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 structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_folder_info).
force_add	bool			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 unset, forceAdd is default to false.
host	string			Identifier of the host to be disconnected.
The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_host_info). Required with I(state=[‘absent’, ‘connect’, ‘disconnect’])
hostname	string			The IP address or DNS resolvable name of the host. Required with I(state=[‘present’])
password	string			The password for the administrator account on the host. Required with I(state=[‘present’])
port	int			The port of the host.
If unset, port 443 will be used.
state	string		`present`	Operation to perform; allowed values: absent, connect, disconnect, present.
thumbprint	string			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 field is optional and it is only relevant when the value of I(thumbprint_verification) is THUMBPRINT.
thumbprint_verification	string			The I(thumbprint_verification) enumerated type defines the thumbprint verification schemes for a host’s SSL certificate. Required with I(state=[‘present’])
user_name	string			The administrator account on the host. Required with I(state=[‘present’])

Example

yaml

- name: Connect the host(s)
  vmware.vmware_rest.vcenter_host:
    hostname: "{{ lookup('env', 'ESXI1_HOSTNAME') }}"
    user_name: "{{ lookup('env', 'ESXI1_USERNAME') }}"
    password: "{{ lookup('env', 'ESXI1_PASSWORD') }}"
    thumbprint_verification: NONE
    folder: '{{ my_host_folder.folder }}'