fmgd_router_rip – Configure RIP.

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
  • 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_rip - Configure RIP. type: dict
    • default_information_originate (Alias name: default-information-originate) Enable/disable generation of default route. type: str choices: [disable, enable] more...
    • default_metric (Alias name: default-metric) Default metric. type: int more...
    • distance Distance. type: list more...
      • access_list (Alias name: access-list) Access list for route destination. type: list more...
      • distance Distance (1 - 255). type: int more...
      • id Distance id. type: int more...
      • prefix Distance prefix. type: list more...
    • distribute_list (Alias name: distribute-list) Distribute list. type: list more...
      • direction Distribute list direction. type: str choices: [out, in] more...
      • id Distribute list id. type: int more...
      • interface Distribute list interface name. type: list more...
      • listname Distribute access/prefix list name. type: list more...
      • status Status. type: str choices: [disable, enable] more...
    • garbage_timer (Alias name: garbage-timer) Garbage timer in seconds. type: int more...
    • interface Interface. type: list more...
      • auth_keychain (Alias name: auth-keychain) Authentication key-chain name. type: list more...
      • auth_mode (Alias name: auth-mode) Authentication mode. type: str choices: [none, md5, text] more...
      • auth_string (Alias name: auth-string) Authentication string/password. type: list more...
      • flags Flags. type: int more...
      • name Interface name. type: str more...
      • receive_version (Alias name: receive-version) Receive version. type: list choices: [1, 2] more...
      • send_version (Alias name: send-version) Send version. type: list choices: [1, 2] more...
      • send_version2_broadcast (Alias name: send-version2-broadcast) Enable/disable broadcast version 1 compatible packets. type: str choices: [disable, enable] more...
      • split_horizon (Alias name: split-horizon) Enable/disable split horizon. type: str choices: [poisoned, regular] more...
      • split_horizon_status (Alias name: split-horizon-status) Enable/disable split horizon. type: str choices: [disable, enable] more...
    • max_out_metric (Alias name: max-out-metric) Maximum metric allowed to output(0 means not set). type: int more...
    • neighbor Neighbor. type: list more...
      • id Neighbor entry id. type: int more...
      • ip Ip address. type: str more...
    • network Network. type: list more...
      • id Network entry id. type: int more...
      • prefix Network prefix. type: list more...
    • offset_list (Alias name: offset-list) Offset list. type: list more...
      • access_list (Alias name: access-list) Access list name. type: list more...
      • direction Offset list direction. type: str choices: [out, in] more...
      • id Offset-list id. type: int more...
      • interface Interface name. type: list more...
      • offset Offset. type: int more...
      • status Status. type: str choices: [disable, enable] more...
    • passive_interface (Alias name: passive-interface) Passive interface configuration. type: list more...
    • redistribute Redistribute. type: dict more...
      • metric Redistribute metric setting. type: int more...
      • name Redistribute name. type: str more...
      • routemap Route map name. type: list more...
      • status Status. type: str choices: [disable, enable] more...
    • timeout_timer (Alias name: timeout-timer) Timeout timer in seconds. type: int more...
    • update_timer (Alias name: update-timer) Update timer in seconds. type: int more...
    • version Rip version. type: str choices: [1, 2] more...
    • recv_buffer_size (Alias name: recv-buffer-size) Receiving buffer size. 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: Configure RIP.
      fortinet.fmgdevice.fmgd_router_rip:
        # 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>
        router_rip:
          # default_information_originate: <value in [disable, enable]>
          # default_metric: <integer>
          # distance:
          #   - access_list: <list or string>
          #     distance: <integer>
          #     id: <integer>
          #     prefix: <list or string>
          # distribute_list:
          #   - direction: <value in [out, in]>
          #     id: <integer>
          #     interface: <list or string>
          #     listname: <list or string>
          #     status: <value in [disable, enable]>
          # garbage_timer: <integer>
          # interface:
          #   - auth_keychain: <list or string>
          #     auth_mode: <value in [none, md5, text]>
          #     auth_string: <list or string>
          #     flags: <integer>
          #     name: <string>
          #     receive_version:
          #       - "1"
          #       - "2"
          #     send_version:
          #       - "1"
          #       - "2"
          #     send_version2_broadcast: <value in [disable, enable]>
          #     split_horizon: <value in [poisoned, regular]>
          #     split_horizon_status: <value in [disable, enable]>
          # max_out_metric: <integer>
          # neighbor:
          #   - id: <integer>
          #     ip: <string>
          # network:
          #   - id: <integer>
          #     prefix: <list or string>
          # offset_list:
          #   - access_list: <list or string>
          #     direction: <value in [out, in]>
          #     id: <integer>
          #     interface: <list or string>
          #     offset: <integer>
          #     status: <value in [disable, enable]>
          # passive_interface: <list or string>
          # redistribute:
          #   metric: <integer>
          #   name: <string>
          #   routemap: <list or string>
          #   status: <value in [disable, enable]>
          # timeout_timer: <integer>
          # update_timer: <integer>
          # version: <value in [1, 2]>
          # recv_buffer_size: <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)