vmware.vmware_rest.appliance_access_shell module – Set enabled state of BASH, that is, access to BASH from within the controlled CLI.

Note

This module is part of the vmware.vmware_rest collection (version 2.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: vmware.vmware_rest.appliance_access_shell.

New in vmware.vmware_rest 2.0.0

Synopsis

  • Set enabled state of BASH, that is, access to BASH from within the controlled CLI.

Requirements

The below requirements are needed on the host that executes this module.

  • vSphere 7.0.2 or greater

  • python >= 3.6

  • aiohttp

Parameters

Parameter

Comments

enabled

boolean / required

Enabled can be set to true or false This parameter is mandatory.

Choices:

  • false

  • true

session_timeout

float

added in vmware.vmware_rest 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

Choices:

  • "set" ← (default)

timeout

integer / required

The timeout (in seconds) specifies how long you enable the Shell access. The maximum timeout is 86400 seconds(1 day). This parameter is mandatory.

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.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Tested on vSphere 7.0.2

Examples

- name: Disable the Shell
  vmware.vmware_rest.appliance_access_shell:
    enabled: false
    timeout: 600

- name: Enable the Shell with a timeout
  vmware.vmware_rest.appliance_access_shell:
    enabled: true
    timeout: 600
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

value

dictionary

Disable the Shell

Returned: On success

Sample: {"enabled": 0, "timeout": 0}

Authors

  • Ansible Cloud Team (@ansible-collections)