Skip to content

Latest commit

 

History

History
383 lines (339 loc) · 16.8 KB

fortios_firewall_multicast_address.rst

File metadata and controls

383 lines (339 loc) · 16.8 KB
Raw
source:fortios_firewall_multicast_address.py
orphan:

fortios_firewall_multicast_address -- Configure multicast addresses 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 multicast_address 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.14

Tips

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

FortiOS Version Compatibility


Supported Version Ranges
fortios_firewall_multicast_address v6.0.0 -> latest

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_multicast_address - Configure multicast addresses. type: dict more...
    Supported Version Ranges
    firewall_multicast_address v6.0.0 -> latest
    • associated_interface - Interface associated with the address object. When setting up a policy, only addresses associated with this interface are available. Source system.interface.name. type: str more...
      Supported Version Ranges
      associated_interface v6.0.0 -> latest
    • color - Integer value to determine the color of the icon in the GUI (1 - 32). type: int more...
      Supported Version Ranges
      color v6.0.0 -> latest
    • comment - Comment. type: str more...
      Supported Version Ranges
      comment v6.0.0 -> latest
    • end_ip - Final IPv4 address (inclusive) in the range for the address. type: str more...
      Supported Version Ranges
      end_ip v6.0.0 -> latest
    • name - Multicast address name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • start_ip - First IPv4 address (inclusive) in the range for the address. type: str more...
      Supported Version Ranges
      start_ip v6.0.0 -> latest
    • subnet - Broadcast address and subnet. type: str more...
      Supported Version Ranges
      subnet v6.0.0 -> latest
    • tagging - Config object tagging. type: list member_path: tagging:name more...
      Supported Version Ranges
      tagging v6.0.0 -> latest
      • category - Tag category. Source system.object-tagging.category. type: str more...
        Supported Version Ranges
        category v6.0.0 -> latest
      • name - Tagging entry name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
      • tags - Tags. type: list member_path: tagging:name/tags:name more...
        Supported Version Ranges
        tags v6.0.0 -> latest
        • name - Tag name. Source system.object-tagging.tags.name. type: str required: true more...
          Supported Version Ranges
          name v6.0.0 -> latest
    • type - Type of address object: multicast IP address range or broadcast IP/mask to be treated as a multicast address. type: str choices: multicastrange, broadcastmask more...
      Supported Version Ranges
      type v6.0.0 -> latest
      [multicastrange] v6.0.0 -> latest
      [broadcastmask] v6.0.0 -> latest
    • visibility - Enable/disable visibility of the multicast address on the GUI. type: str choices: enable, disable more...
      Supported Version Ranges
      visibility v6.0.0 -> v6.2.7
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure multicast addresses.
  fortinet.fortios.fortios_firewall_multicast_address:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_multicast_address:
          associated_interface: "<your_own_value> (source system.interface.name)"
          color: "0"
          comment: "Comment."
          end_ip: "<your_own_value>"
          name: "default_name_7"
          start_ip: "<your_own_value>"
          subnet: "<your_own_value>"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_12"
                  tags:
                      -
                          name: "default_name_14 (source system.object-tagging.tags.name)"
          type: "multicastrange"
          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.