vmware.vmware_rest.appliance_access_ssh
Set enabled state of the SSH-based controlled CLI.
Version added: 2.0.0
Set enabled state of the SSH-based controlled CLI.
The below requirements are needed on the host that executes this module.
vSphere 7.0.3 or greater
python >= 3.6
aiohttp
Parameter
Choices/Defaults
Comments
enabled
boolean
/ required
SSH-based controlled CLI is enabled. This parameter is mandatory.
session_timeout
float
added in 2.1.0
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.
state
string
vcenter_hostname
string
/ required
The hostname or IP address of the vSphere vCenter
If the value is not specified in the task, the value of environment variable VMWARE_HOST
will be used instead.
vcenter_password
string
/ required
The vSphere vCenter password
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD
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 run the module.
If the value is not specified in the task, the value of
environment variable VMWARE_REST_LOG_FILE
will be used instead.
vcenter_username
string
/ required
The vSphere vCenter username
If the value is not specified in the task, the value of environment variable VMWARE_USER
will be used instead.
vcenter_validate_certs
boolean
Allows connection when SSL certificates are not valid. Set to false
when certificates are not trusted.
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS
will be used instead.
- Tested on vSphere 7.0.3
- name : Ensure the SSH access ie enabled
vmware.vmware_rest.appliance_access_ssh :
enabled : true
register : result
Common return values are documented here , the following are the fields unique to this module:
Key
Returned
Description
value
integer
On success
Ensure the SSH access ie enabled
Sample:
1
Ansible Cloud Team (@ansible-collections)