Skip to content

Latest commit

 

History

History
484 lines (443 loc) · 20.9 KB

fortios_firewall_addrgrp.rst

File metadata and controls

484 lines (443 loc) · 20.9 KB
Raw
source:fortios_firewall_addrgrp.py
orphan:

fortios_firewall_addrgrp -- Configure IPv4 address groups in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • 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

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

  • ansible>=2.15

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • firewall_addrgrp - Configure IPv4 address groups. type: dict more...
    Supported Version Ranges
    firewall_addrgrp v6.0.0 -> 7.4.3
    • allow_routing - Enable/disable use of this group in the static route configuration. type: str choices: enable, disable more...
      Supported Version Ranges
      allow_routing v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • category - Address group category. type: str choices: default, ztna-ems-tag, ztna-geo-tag more...
      Supported Version Ranges
      category v7.0.0 -> 7.4.3
      [default] v7.0.0 -> 7.4.3
      [ztna-ems-tag] v7.0.0 -> 7.4.3
      [ztna-geo-tag] v7.0.0 -> 7.4.3
    • color - Color of icon on the GUI. type: int more...
      Supported Version Ranges
      color v6.0.0 -> 7.4.3
    • comment - Comment. type: str more...
      Supported Version Ranges
      comment v6.0.0 -> 7.4.3
    • exclude - Enable/disable address exclusion. type: str choices: enable, disable more...
      Supported Version Ranges
      exclude v6.2.0 -> 7.4.3
      [enable] v6.2.0 -> 7.4.3
      [disable] v6.2.0 -> 7.4.3
    • exclude_member - Address exclusion member. type: list member_path: exclude_member:name more...
      Supported Version Ranges
      exclude_member v6.2.0 -> 7.4.3
      • name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
        Supported Version Ranges
        name v6.2.0 -> 7.4.3
    • fabric_object - Security Fabric global object setting. type: str choices: enable, disable more...
      Supported Version Ranges
      fabric_object v6.4.4 -> 7.4.3
      [enable] v6.4.4 -> 7.4.3
      [disable] v6.4.4 -> 7.4.3
    • member - Address objects contained within the group. type: list member_path: member:name more...
      Supported Version Ranges
      member v6.0.0 -> 7.4.3
      • name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> 7.4.3
    • name - Address group name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> 7.4.3
    • tagging - Config object tagging. type: list member_path: tagging:name more...
      Supported Version Ranges
      tagging v6.0.0 -> 7.4.3
      • category - Tag category. Source system.object-tagging.category. type: str more...
        Supported Version Ranges
        category v6.0.0 -> 7.4.3
      • name - Tagging entry name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> 7.4.3
      • tags - Tags. type: list member_path: tagging:name/tags:name more...
        Supported Version Ranges
        tags v6.0.0 -> 7.4.3
        • name - Tag name. Source system.object-tagging.tags.name. type: str required: true more...
          Supported Version Ranges
          name v6.0.0 -> 7.4.3
    • type - Address group type. type: str choices: default, folder more...
      Supported Version Ranges
      type v6.4.0 -> 7.4.3
      [default] v6.4.0 -> 7.4.3
      [folder] v6.4.0 -> 7.4.3
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
      Supported Version Ranges
      uuid v6.0.0 -> 7.4.3
    • visibility - Enable/disable address visibility in the GUI. type: str choices: enable, disable more...
      Supported Version Ranges
      visibility v6.0.0 -> v6.2.7
      [enable] v6.0.0 -> v6.2.7
      [disable] v6.0.0 -> v6.2.7

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- 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"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.