fmgd_router_multicast_interface – PIM interfaces.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • router_multicast_interface - PIM interfaces. type: dict
    • bfd Enable/disable protocol independent multicast (pim) bidirectional forwarding detection (bfd). type: str choices: [disable, enable] more...
    • cisco_exclude_genid (Alias name: cisco-exclude-genid) Exclude genid from hello packets (compatibility with old cisco ios). type: str choices: [disable, enable] more...
    • dr_priority (Alias name: dr-priority) Dr election priority. type: int more...
    • hello_holdtime (Alias name: hello-holdtime) Time before old neighbor information expires (0 - 65535 sec, default = 105). type: int more...
    • hello_interval (Alias name: hello-interval) Interval between sending pim hello messages (0 - 65535 sec, default = 30). type: int more...
    • igmp Igmp. type: dict more...
      • access_group (Alias name: access-group) Groups igmp hosts are allowed to join. type: list more...
      • immediate_leave_group (Alias name: immediate-leave-group) Groups to drop membership for immediately after receiving igmpv2 leave. type: list more...
      • last_member_query_count (Alias name: last-member-query-count) Number of group specific queries before removing group (2 - 7, default = 2). type: int more...
      • last_member_query_interval (Alias name: last-member-query-interval) Timeout between igmpv2 leave and removing group (1 - 65535 msec, default = 1000). type: int more...
      • query_interval (Alias name: query-interval) Interval between queries to igmp hosts (1 - 65535 sec, default = 125). type: int more...
      • query_max_response_time (Alias name: query-max-response-time) Maximum time to wait for a igmp query response (1 - 25 sec, default = 10). type: int more...
      • query_timeout (Alias name: query-timeout) Timeout between queries before becoming querying unit for network (60 - 900, default = 255). type: int more...
      • router_alert_check (Alias name: router-alert-check) Enable/disable require igmp packets contain router alert option. type: str choices: [disable, enable] more...
      • version Maximum version of igmp to support. type: str choices: [1, 2, 3] more...
    • join_group (Alias name: join-group) Join group. type: list more...
      • address Multicast group ip address. type: str more...
    • multicast_flow (Alias name: multicast-flow) Acceptable source for multicast group. type: list more...
    • name Interface name. type: str more...
    • neighbour_filter (Alias name: neighbour-filter) Routers acknowledged as neighbor routers. type: list more...
    • passive Enable/disable listening to igmp but not participating in pim. type: str choices: [disable, enable] more...
    • pim_mode (Alias name: pim-mode) Pim operation mode. type: str choices: [sparse-mode, dense-mode] more...
    • propagation_delay (Alias name: propagation-delay) Delay flooding packets on this interface (100 - 5000 msec, default = 500). type: int more...
    • rp_candidate (Alias name: rp-candidate) Enable/disable compete to become rp in elections. type: str choices: [disable, enable] more...
    • rp_candidate_group (Alias name: rp-candidate-group) Multicast groups managed by this rp. type: list more...
    • rp_candidate_interval (Alias name: rp-candidate-interval) Rp candidate advertisement interval (1 - 16383 sec, default = 60). type: int more...
    • rp_candidate_priority (Alias name: rp-candidate-priority) Routers priority as rp. type: int more...
    • rpf_nbr_fail_back (Alias name: rpf-nbr-fail-back) Enable/disable fail back for rpf neighbor query. type: str choices: [disable, enable] more...
    • rpf_nbr_fail_back_filter (Alias name: rpf-nbr-fail-back-filter) Filter for fail back rpf neighbors. type: list more...
    • state_refresh_interval (Alias name: state-refresh-interval) Interval between sending state-refresh packets (1 - 100 sec, default = 60). type: int more...
    • static_group (Alias name: static-group) Statically set multicast groups to forward out. type: list more...
    • ttl_threshold (Alias name: ttl-threshold) Minimum ttl of multicast packets that will be forwarded (applied only to new multicast routes) (1 - 255, default = 1). type: int more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: PIM interfaces.
      fortinet.fmgdevice.fmgd_router_multicast_interface:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        router_multicast_interface:
          name: "your value" # Required variable, string
          # bfd: <value in [disable, enable]>
          # cisco_exclude_genid: <value in [disable, enable]>
          # dr_priority: <integer>
          # hello_holdtime: <integer>
          # hello_interval: <integer>
          # igmp:
          #   access_group: <list or string>
          #   immediate_leave_group: <list or string>
          #   last_member_query_count: <integer>
          #   last_member_query_interval: <integer>
          #   query_interval: <integer>
          #   query_max_response_time: <integer>
          #   query_timeout: <integer>
          #   router_alert_check: <value in [disable, enable]>
          #   version: <value in [1, 2, 3]>
          # join_group:
          #   - address: <string>
          # multicast_flow: <list or string>
          # neighbour_filter: <list or string>
          # passive: <value in [disable, enable]>
          # pim_mode: <value in [sparse-mode, dense-mode]>
          # propagation_delay: <integer>
          # rp_candidate: <value in [disable, enable]>
          # rp_candidate_group: <list or string>
          # rp_candidate_interval: <integer>
          # rp_candidate_priority: <integer>
          # rpf_nbr_fail_back: <value in [disable, enable]>
          # rpf_nbr_fail_back_filter: <list or string>
          # state_refresh_interval: <integer>
          # static_group: <list or string>
          # ttl_threshold: <integer>

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)