Documentation

vmware_host_firewall_manager - Manage firewall configurations about an ESXi host

New in version 2.5.

Synopsis

  • This module can be used to manage firewall configurations about an ESXi host when ESXi hostname or Cluster name is given.

Requirements

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

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
cluster_name
Name of the cluster.
Firewall settings are applied to every ESXi host system in given cluster.
If esxi_hostname is not given, this parameter is required.
esxi_hostname
ESXi hostname.
Firewall settings are applied to this ESXi host system.
If cluster_name is not given, this parameter is required.
hostname
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
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
(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.
rules Default:
[]
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.
Please see examples for more information.
username
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: user, admin
validate_certs
    Choices:
  • no
  • yes
Default:
True
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.

Notes

Note

  • Tested on vSphere 6.5

Examples

- name: Enable vvold rule set for all ESXi Host in given Cluster
  vmware_host_firewall_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: cluster_name
    rules:
        - name: vvold
          enabled: True

- name: Enable vvold rule set for an ESXi Host
  vmware_host_firewall_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    rules:
        - name: vvold
          enabled: True

- name: Manage multiple rule set for an ESXi Host
  vmware_host_firewall_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    rules:
        - name: vvold
          enabled: True
        - name: CIMHttpServer
          enabled: False

Return Values

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

Key Returned Description
rule_set_state
dict
 success
dict with hostname as key and dict with firewall rule set facts as value

Sample:
{'rule_set_state': {'localhost.localdomain': {'CIMHttpServer': {'current_state': True, 'desired_state': True, 'previous_state': True}, 'vvold': {'current_state': True, 'desired_state': True, 'previous_state': True}}}}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Abhijeet Kasurde (@akasurde)

Hint

If you notice any issues in this documentation you can edit this document to improve it.