community.vmware.vmware_host_lockdown_exceptions module – Manage Lockdown Mode Exception Users
Note
This module is part of the community.vmware collection (version 4.7.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 community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_host_lockdown_exceptions
.
New in community.vmware 3.1.0
Synopsis
This module can be used to manage Lockdown Mode Exception Users.
Please specify
hostname
as vCenter IP or hostname only, as lockdown operations are not possible from standalone ESXi server.
Parameters
Parameter |
Comments |
---|---|
Name of cluster. All host systems from given cluster used to manage exception users. Required parameter, if |
|
List of ESXi hostname to manage exception users. Required parameter, if |
|
List of Lockdown Mode Exception Users. To remove all Exception Users, |
|
The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable |
|
Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable |
|
If If If Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: Remove all Lockdown Mode Exception Users on a host
community.vmware.vmware_host_lockdown:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
exception_users: []
state: set
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
metadata about exception users of Host systems Returned: always Sample: |