PARALLAX

appliance_networking_firewall_inbound

Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses

Collection: vmware.vmware_rest

Full Name: vmware.vmware_rest.appliance_networking_firewall_inbound

Synopsis

Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses

Parameters

NameTypeRequiredDefaultDescription
vcenter_hostnamestringyesThe hostname or IP address of the vSphere vCenter
If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead.
vcenter_usernamestringyesThe vSphere vCenter username
If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead.
vcenter_passwordstringyesThe vSphere vCenter password
If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead.
vcenter_validate_certsbooltrueAllows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted.
If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead.
vcenter_rest_log_filestringYou 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 runs the module.
If the value is not specified in the task, the value of
environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
session_timeoutfloatTimeout 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.
ruleslistyesList of address-based firewall rules. This parameter is mandatory.
Valid attributes are:
  • C(address) (str): IPv4 or IPv6 address. ([‘set’]) This key is required with [‘set’].
  • C(prefix) (int): CIDR prefix used to mask address. For example, an IPv4 prefix of 24 ignores the low-order 8 bits of address. ([‘set’]) This key is required with [‘set’].
  • C(policy) (str): I(policy) enumerated type Defines firewall rule policies. ([‘set’]) This key is required with [‘set’].
    • Accepted values:
      • ACCEPT
      • IGNORE
      • REJECT
      • RETURN
  • C(interface_name) (str): The interface to which this rule applies. An empty string indicates that the rule applies to all interfaces. ([‘set’]) | | state | string | | set | Operation to perform; allowed values: set. |

Example

yaml
- name: Ensure the rules parameter is mandatory
  vmware.vmware_rest.appliance_networking_firewall_inbound:
  register: result
  failed_when:
  - not(result.failed)
  - "result.msg == 'missing required arguments: rules'"

- name: Set a firewall rule
  vmware.vmware_rest.appliance_networking_firewall_inbound:
    rules:
    - address: 1.2.3.4
      prefix: 32
      policy: ACCEPT
  register: result
Search
    ↑ ↓ move↵ openesc close