fortinet.fortios.fortios_router_multicast6 (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 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

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

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

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

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

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

router_multicast6:
    default: null
    description:
    - Configure IPv6 multicast.
    suboptions:
      interface:
        description:
        - Protocol Independent Multicast (PIM) interfaces.
        elements: dict
        suboptions:
          hello_holdtime:
            description:
            - Time before old neighbor information expires in seconds (1 - 65535).
            type: int
          hello_interval:
            description:
            - Interval between sending PIM hello messages in seconds (1 - 65535).
            type: int
          name:
            description:
            - Interface name. Source system.interface.name.
            required: true
            type: str
        type: list
      multicast_pmtu:
        choices:
        - enable
        - disable
        description:
        - Enable/disable PMTU for IPv6 multicast.
        type: str
      multicast_routing:
        choices:
        - enable
        - disable
        description:
        - Enable/disable IPv6 multicast routing.
        type: str
      pim_sm_global:
        description:
        - PIM sparse-mode global settings.
        suboptions:
          register_rate_limit:
            description:
            - Limit of packets/sec per source registered through this RP (0 means unlimited).
            type: int
          rp_address:
            description:
            - Statically configured RP addresses.
            elements: dict
            suboptions:
              id:
                description:
                - ID of the entry. see <a href='#notes'>Notes</a>.
                required: true
                type: int
              ip6_address:
                description:
                - RP router IPv6 address.
                type: str
            type: list
        type: dict
    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