New in version 2.5.
hostname
as vCenter IP or hostname only, as lockdown operations are not possible from standalone ESXi server.The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
cluster_name | Name of cluster. All host systems from given cluster used to manage lockdown. Required parameter, if esxi_hostname is not set. | |
esxi_hostname | List of ESXi hostname to manage lockdown. Required parameter, if cluster_name is not set.See examples for specifications. | |
hostname str | 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 VMWARE_HOST will be used instead.Environment variable supported added in version 2.6. | |
password str | The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.Environment variable supported added in version 2.6. aliases: pass, pwd | |
port int (added in 2.5) | Default: 443 | The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.Environment variable supported added in version 2.6. |
state (added in 2.5) |
| State of hosts system If set to present , all host systems will be set in lockdown mode.If host system is already in lockdown mode and set to present , no action will be taken.If set to absent , all host systems will be removed from lockdown mode.If host system is already out of lockdown mode and set to absent , no action will be taken. |
username str | The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.Environment variable supported added in version 2.6. aliases: admin, user | |
validate_certs bool |
| 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.Environment variable supported added in version 2.6. If set to yes , please make sure Python >= 2.7.9 is installed on the given machine. |
Note
- name: Enter host system into lockdown mode vmware_host_lockdown: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' esxi_hostname: '{{ esxi_hostname }}' state: present delegate_to: localhost - name: Exit host systems from lockdown mode vmware_host_lockdown: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' esxi_hostname: '{{ esxi_hostname }}' state: absent delegate_to: localhost - name: Enter host systems into lockdown mode vmware_host_lockdown: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' esxi_hostname: - '{{ esxi_hostname_1 }}' - '{{ esxi_hostname_2 }}' state: present delegate_to: localhost - name: Exit host systems from lockdown mode vmware_host_lockdown: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' esxi_hostname: - '{{ esxi_hostname_1 }}' - '{{ esxi_hostname_2 }}' state: absent delegate_to: localhost - name: Enter all host system from cluster into lockdown mode vmware_host_lockdown: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' cluster_name: '{{ cluster_name }}' state: present delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
results dict | always | metadata about state of Host system lock down Sample: {'host_lockdown_state': {'DC0_C0': {'current_state': 'present', 'desired_state': 'present', 'previous_state': 'absent'}}} |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vmware_host_lockdown_module.html