community.vmware.vmware_host_firewall_manager module – Manage firewall configurations about an ESXi host
Note
This module is part of the community.vmware collection (version 4.7.1).
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_firewall_manager
.
Synopsis
This module can be used to manage firewall configurations about an ESXi host when ESXi hostname or Cluster name is given.
Parameters
Parameter |
Comments |
---|---|
Name of the cluster. Firewall settings are applied to every ESXi host system in given cluster. If |
|
ESXi hostname. Firewall settings are applied to this ESXi host system. If |
|
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 |
|
A list of Rule set which needs to be managed. Each member of list is rule set name and state to be set the rule. Both rule name and rule state are required parameters. Additional IPs and networks can also be specified Please see examples for more information. Default: |
|
Define the allowed hosts for this rule set. |
|
Whether all hosts should be allowed or not. Choices:
|
|
List of allowed IP addresses. Default: |
|
List of allowed IP networks. Default: |
|
Whether the rule set is enabled or not. Choices:
|
|
Rule set name. |
|
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: Enable vvold rule set for all ESXi Host in given Cluster
community.vmware.vmware_host_firewall_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: cluster_name
rules:
- name: vvold
enabled: true
allowed_hosts:
all_ip: true
delegate_to: localhost
- name: Enable vvold rule set for an ESXi Host
community.vmware.vmware_host_firewall_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
rules:
- name: vvold
enabled: true
allowed_hosts:
all_ip: true
delegate_to: localhost
- name: Manage multiple rule set for an ESXi Host
community.vmware.vmware_host_firewall_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
rules:
- name: vvold
enabled: true
allowed_hosts:
all_ip: true
- name: CIMHttpServer
enabled: false
delegate_to: localhost
- name: Manage IP and network based firewall permissions for ESXi
community.vmware.vmware_host_firewall_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
rules:
- name: gdbserver
enabled: true
allowed_hosts:
all_ip: false
ip_address:
- 192.168.20.10
- 192.168.20.11
- name: CIMHttpServer
enabled: true
allowed_hosts:
all_ip: false
ip_network:
- 192.168.100.0/24
- name: remoteSerialPort
enabled: true
allowed_hosts:
all_ip: false
ip_address:
- 192.168.100.11
ip_network:
- 192.168.200.0/24
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
dict with hostname as key and dict with firewall rule set facts as value Returned: success Sample: |