Skip to content

Latest commit

 

History

History
333 lines (289 loc) · 14.4 KB

fortios_router_multicast6.rst

File metadata and controls

333 lines (289 loc) · 14.4 KB
Raw
source:fortios_router_multicast6.py
orphan:

fortios_router_multicast6 -- Configure IPv6 multicast 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 router feature and multicast6 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_router_multicast6 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
  • router_multicast6 - Configure IPv6 multicast. type: dict more...
    Supported Version Ranges
    router_multicast6 v6.0.0 -> latest
    • interface - Protocol Independent Multicast (PIM) interfaces. type: list member_path: interface:name more...
      Supported Version Ranges
      interface v6.0.0 -> latest
      • hello_holdtime - Time before old neighbor information expires in seconds (1 - 65535). type: int more...
        Supported Version Ranges
        hello_holdtime v6.0.0 -> latest
      • hello_interval - Interval between sending PIM hello messages in seconds (1 - 65535). type: int more...
        Supported Version Ranges
        hello_interval v6.0.0 -> latest
      • name - Interface name. Source system.interface.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
    • multicast_pmtu - Enable/disable PMTU for IPv6 multicast. type: str choices: enable, disable more...
      Supported Version Ranges
      multicast_pmtu v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • multicast_routing - Enable/disable IPv6 multicast routing. type: str choices: enable, disable more...
      Supported Version Ranges
      multicast_routing v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • pim_sm_global - PIM sparse-mode global settings. type: dict more...
      Supported Version Ranges
      pim_sm_global v6.0.0 -> latest
      • register_rate_limit - Limit of packets/sec per source registered through this RP (0 means unlimited). type: int more...
        Supported Version Ranges
        register_rate_limit v6.0.0 -> latest
      • rp_address - Statically configured RP addresses. type: list member_path: pim_sm_global/rp_address:id more...
        Supported Version Ranges
        rp_address v6.0.0 -> latest
        • id - ID of the entry. see Notes. type: int required: true more...
          Supported Version Ranges
          id v6.0.0 -> latest
        • ip6_address - RP router IPv6 address. type: str more...
          Supported Version Ranges
          ip6_address v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure IPv6 multicast.
  fortinet.fortios.fortios_router_multicast6:
      vdom: "{{ vdom }}"
      router_multicast6:
          interface:
              -
                  hello_holdtime: ""
                  hello_interval: "30"
                  name: "default_name_6 (source system.interface.name)"
          multicast_pmtu: "enable"
          multicast_routing: "enable"
          pim_sm_global:
              register_rate_limit: "0"
              rp_address:
                  -
                      id: "12"
                      ip6_address: "<your_own_value>"

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.