fortinet.fortios.fortios_firewall_ippool (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ippool category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure IPv4 IP pools.
  fortinet.fortios.fortios_firewall_ippool:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_ippool:
          add_nat64_route: "disable"
          arp_intf: "<your_own_value> (source system.interface.name)"
          arp_reply: "disable"
          associated_interface: "<your_own_value> (source system.interface.name)"
          block_size: "128"
          comments: "<your_own_value>"
          endip: "<your_own_value>"
          endport: "65533"
          name: "default_name_11"
          nat64: "disable"
          num_blocks_per_user: "8"
          pba_timeout: "30"
          permit_any_host: "disable"
          port_per_user: "0"
          source_endip: "<your_own_value>"
          source_startip: "<your_own_value>"
          startip: "<your_own_value>"
          startport: "5117"
          subnet_broadcast_in_ippool: "disable"
          type: "overload"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

firewall_ippool:
    default: null
    description:
    - Configure IPv4 IP pools.
    suboptions:
      add_nat64_route:
        choices:
        - disable
        - enable
        description:
        - Enable/disable adding NAT64 route.
        type: str
      arp_intf:
        description:
        - Select an interface from available options that will reply to ARP requests.
          (If blank, any is selected). Source system.interface.name.
        type: str
      arp_reply:
        choices:
        - disable
        - enable
        description:
        - Enable/disable replying to ARP requests when an IP Pool is added to a policy
          .
        type: str
      associated_interface:
        description:
        - Associated interface name. Source system.interface.name.
        type: str
      block_size:
        description:
        - Number of addresses in a block (64 - 4096).
        type: int
      comments:
        description:
        - Comment.
        type: str
      endip:
        description:
        - Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx).
        type: str
      endport:
        description:
        - Final port number (inclusive) in the range for the address pool .
        type: int
      name:
        description:
        - IP pool name.
        required: true
        type: str
      nat64:
        choices:
        - disable
        - enable
        description:
        - Enable/disable NAT64.
        type: str
      num_blocks_per_user:
        description:
        - Number of addresses blocks that can be used by a user (1 to 128).
        type: int
      pba_timeout:
        description:
        - Port block allocation timeout (seconds).
        type: int
      permit_any_host:
        choices:
        - disable
        - enable
        description:
        - Enable/disable full cone NAT.
        type: str
      port_per_user:
        description:
        - Number of port for each user (32 - 60416).
        type: int
      source_endip:
        description:
        - Final IPv4 address (inclusive) in the range of the source addresses to be translated
          (format xxx.xxx.xxx.xxx).
        type: str
      source_startip:
        description:
        - First IPv4 address (inclusive) in the range of the source addresses to be translated
          (format = xxx.xxx.xxx.xxx).
        type: str
      startip:
        description:
        - First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx).
        type: str
      startport:
        description:
        - First port number (inclusive) in the range for the address pool .
        type: int
      subnet_broadcast_in_ippool:
        choices:
        - disable
        - enable
        description:
        - Enable/disable inclusion of the subnetwork address and broadcast IP address
          in the NAT64 IP pool.
        type: str
      type:
        choices:
        - overload
        - one-to-one
        - fixed-port-range
        - port-block-allocation
        description:
        - 'IP pool type: overload, one-to-one, fixed-port-range, port-block-allocation,
          cgn-resource-allocation (hyperscale vdom only)'
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str