fortinet.fortios.fortios_firewall_addrgrp (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 addrgrp 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 address groups.
  fortinet.fortios.fortios_firewall_addrgrp:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_addrgrp:
          allow_routing: "enable"
          category: "default"
          color: "0"
          comment: "Comment."
          exclude: "enable"
          exclude_member:
              -
                  name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)"
          fabric_object: "enable"
          member:
              -
                  name: "default_name_12 (source firewall.address.name firewall.addrgrp.name)"
          name: "default_name_13"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_16"
                  tags:
                      -
                          name: "default_name_18 (source system.object-tagging.tags.name)"
          type: "default"
          uuid: "<your_own_value>"
          visibility: "enable"

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_addrgrp:
    default: null
    description:
    - Configure IPv4 address groups.
    suboptions:
      allow_routing:
        choices:
        - enable
        - disable
        description:
        - Enable/disable use of this group in the static route configuration.
        type: str
      category:
        choices:
        - default
        - ztna-ems-tag
        - ztna-geo-tag
        description:
        - Address group category.
        type: str
      color:
        description:
        - Color of icon on the GUI.
        type: int
      comment:
        description:
        - Comment.
        type: str
      exclude:
        choices:
        - enable
        - disable
        description:
        - Enable/disable address exclusion.
        type: str
      exclude_member:
        description:
        - Address exclusion member.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name.
            required: true
            type: str
        type: list
      fabric_object:
        choices:
        - enable
        - disable
        description:
        - Security Fabric global object setting.
        type: str
      member:
        description:
        - Address objects contained within the group.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name.
            required: true
            type: str
        type: list
      name:
        description:
        - Address group name.
        required: true
        type: str
      tagging:
        description:
        - Config object tagging.
        elements: dict
        suboptions:
          category:
            description:
            - Tag category. Source system.object-tagging.category.
            type: str
          name:
            description:
            - Tagging entry name.
            required: true
            type: str
          tags:
            description:
            - Tags.
            elements: dict
            suboptions:
              name:
                description:
                - Tag name. Source system.object-tagging.tags.name.
                required: true
                type: str
            type: list
        type: list
      type:
        choices:
        - default
        - folder
        description:
        - Address group type.
        type: str
      uuid:
        description:
        - Universally Unique Identifier (UUID; automatically assigned but can be manually
          reset).
        type: str
      visibility:
        choices:
        - enable
        - disable
        description:
        - Enable/disable address visibility in the GUI.
        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