fortinet.fortios.fortios_router_rip (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 rip 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 RIP.
  fortinet.fortios.fortios_router_rip:
      vdom: "{{ vdom }}"
      router_rip:
          default_information_originate: "enable"
          default_metric: "1"
          distance:
              -
                  access_list: "<your_own_value> (source router.access-list.name)"
                  distance: "0"
                  id: "8"
                  prefix: "<your_own_value>"
          distribute_list:
              -
                  direction: "in"
                  id: "12"
                  interface: "<your_own_value> (source system.interface.name)"
                  listname: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
                  status: "enable"
          garbage_timer: "120"
          interface:
              -
                  auth_keychain: "<your_own_value> (source router.key-chain.name)"
                  auth_mode: "none"
                  auth_string: "<your_own_value>"
                  flags: "8"
                  name: "default_name_22 (source system.interface.name)"
                  receive_version: "1"
                  send_version: "1"
                  send_version2_broadcast: "disable"
                  split_horizon: "poisoned"
                  split_horizon_status: "enable"
          max_out_metric: "0"
          neighbor:
              -
                  id: "30"
                  ip: "<your_own_value>"
          network:
              -
                  id: "33"
                  prefix: "<your_own_value>"
          offset_list:
              -
                  access_list: "<your_own_value> (source router.access-list.name)"
                  direction: "in"
                  id: "38"
                  interface: "<your_own_value> (source system.interface.name)"
                  offset: "0"
                  status: "enable"
          passive_interface:
              -
                  name: "default_name_43 (source system.interface.name)"
          recv_buffer_size: "655360"
          redistribute:
              -
                  metric: "0"
                  name: "default_name_47"
                  routemap: "<your_own_value> (source router.route-map.name)"
                  status: "enable"
          timeout_timer: "180"
          update_timer: "30"
          version: "1"

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

router_rip:
    default: null
    description:
    - Configure RIP.
    suboptions:
      default_information_originate:
        choices:
        - enable
        - disable
        description:
        - Enable/disable generation of default route.
        type: str
      default_metric:
        description:
        - Default metric.
        type: int
      distance:
        description:
        - Distance.
        elements: dict
        suboptions:
          access_list:
            description:
            - Access list for route destination. Source router.access-list.name.
            type: str
          distance:
            description:
            - Distance (1 - 255).
            type: int
          id:
            description:
            - Distance ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          prefix:
            description:
            - Distance prefix.
            type: str
        type: list
      distribute_list:
        description:
        - Distribute list.
        elements: dict
        suboptions:
          direction:
            choices:
            - in
            - out
            description:
            - Distribute list direction.
            type: str
          id:
            description:
            - Distribute list ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          interface:
            description:
            - Distribute list interface name. Source system.interface.name.
            type: str
          listname:
            description:
            - Distribute access/prefix list name. Source router.access-list.name router.prefix-list.name.
            type: str
          status:
            choices:
            - enable
            - disable
            description:
            - Status.
            type: str
        type: list
      garbage_timer:
        description:
        - Garbage timer in seconds.
        type: int
      interface:
        description:
        - RIP interface configuration.
        elements: dict
        suboptions:
          auth_keychain:
            description:
            - Authentication key-chain name. Source router.key-chain.name.
            type: str
          auth_mode:
            choices:
            - none
            - text
            - md5
            description:
            - Authentication mode.
            type: str
          auth_string:
            description:
            - Authentication string/password.
            type: str
          flags:
            description:
            - Flags.
            type: int
          name:
            description:
            - Interface name. Source system.interface.name.
            required: true
            type: str
          receive_version:
            choices:
            - '1'
            - '2'
            description:
            - Receive version.
            elements: str
            type: list
          send_version:
            choices:
            - '1'
            - '2'
            description:
            - Send version.
            elements: str
            type: list
          send_version2_broadcast:
            choices:
            - disable
            - enable
            description:
            - Enable/disable broadcast version 1 compatible packets.
            type: str
          split_horizon:
            choices:
            - poisoned
            - regular
            description:
            - Enable/disable split horizon.
            type: str
          split_horizon_status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable split horizon.
            type: str
        type: list
      max_out_metric:
        description:
        - Maximum metric allowed to output(0 means "not set").
        type: int
      neighbor:
        description:
        - Neighbor.
        elements: dict
        suboptions:
          id:
            description:
            - Neighbor entry ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          ip:
            description:
            - IP address.
            type: str
        type: list
      network:
        description:
        - Network.
        elements: dict
        suboptions:
          id:
            description:
            - Network entry ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          prefix:
            description:
            - Network prefix.
            type: str
        type: list
      offset_list:
        description:
        - Offset list.
        elements: dict
        suboptions:
          access_list:
            description:
            - Access list name. Source router.access-list.name.
            type: str
          direction:
            choices:
            - in
            - out
            description:
            - Offset list direction.
            type: str
          id:
            description:
            - Offset-list ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          interface:
            description:
            - Interface name. Source system.interface.name.
            type: str
          offset:
            description:
            - Offset.
            type: int
          status:
            choices:
            - enable
            - disable
            description:
            - Status.
            type: str
        type: list
      passive_interface:
        description:
        - Passive interface configuration.
        elements: dict
        suboptions:
          name:
            description:
            - Passive interface name. Source system.interface.name.
            required: true
            type: str
        type: list
      recv_buffer_size:
        description:
        - Receiving buffer size.
        type: int
      redistribute:
        description:
        - Redistribute configuration.
        elements: dict
        suboptions:
          metric:
            description:
            - Redistribute metric setting.
            type: int
          name:
            description:
            - Redistribute name.
            required: true
            type: str
          routemap:
            description:
            - Route map name. Source router.route-map.name.
            type: str
          status:
            choices:
            - enable
            - disable
            description:
            - Status.
            type: str
        type: list
      timeout_timer:
        description:
        - Timeout timer in seconds.
        type: int
      update_timer:
        description:
        - Update timer in seconds.
        type: int
      version:
        choices:
        - '1'
        - '2'
        description:
        - RIP version.
        type: str
    type: dict

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

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