fortiswitch_router_policy – Policy routing configuration in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify router feature and policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0

Requirements

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

  • ansible>=2.11

FortiSW Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.0.3
fortiswitch_router_policy yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • 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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • router_policy - Policy routing configuration. type: dict
    • comments - Description/comments. type: str
    • dst - Destination ip and mask. type: str
    • end_port - End port number. type: int
    • gateway - IP address of gateway. type: str
    • input_device - Incoming interface name. Source system.interface.name. type: str
    • interface - Interface configuration. type: list member_path: interface:name
      • name - Interface name Source system.interface.name. type: str required: true
      • pbr_map_name - PBR policy map name. type: str
    • nexthop_group - Nexthop group (ECMP) configuration. type: list member_path: nexthop_group:name
      • name - Name. type: str required: true
      • nexthop - Nexthop configuration. type: list member_path: nexthop_group:name/nexthop:id
        • id - Id (1-64). type: int required: true
        • nexthop_ip - IP address of nexthop. type: str
        • nexthop_vrf_name - VRF name. Source router.vrf.name. type: str
    • output_device - Outgoing interface name. Source system.interface.name. type: str
    • pbr_map - PBR map configuration. type: list member_path: pbr_map:name
      • comments - Description/comments. type: str
      • name - Name. type: str required: true
      • rule - Rule. type: list
        • dst - Destination ip and mask. type: str
        • nexthop_group_name - Nexthop group name. Used for ECMP. type: str
        • nexthop_ip - IP address of nexthop. type: str
        • nexthop_vrf_name - Nexthop vrf name. Source router.vrf.name. type: str
        • seq_num - Rule seq-num (1-10000). type: int
        • src - Source ip and mask. type: str
    • protocol - Protocol number. type: int
    • seq_num - Sequence number. type: int
    • src - Source ip and mask. type: str
    • start_port - Start port number. type: int
    • tos - Terms of service bit pattern. type: str
    • tos_mask - Terms of service evaluated bits. type: str

Examples

- hosts: fortiswitch01
  collections:
    - fortinet.fortiswitch
  connection: httpapi
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Policy routing configuration.
    fortiswitch_router_policy:
      state: "present"
      router_policy:
        comments: "<your_own_value>"
        dst: "<your_own_value>"
        end_port: "5"
        gateway: "<your_own_value>"
        input_device: "<your_own_value> (source system.interface.name)"
        interface:
         -
            name: "default_name_9 (source system.interface.name)"
            pbr_map_name: "<your_own_value>"
        nexthop_group:
         -
            name: "default_name_12"
            nexthop:
             -
                id:  "14"
                nexthop_ip: "<your_own_value>"
                nexthop_vrf_name: "<your_own_value> (source router.vrf.name)"
        output_device: "<your_own_value> (source system.interface.name)"
        pbr_map:
         -
            comments: "<your_own_value>"
            name: "default_name_20"
            rule:
             -
                dst: "<your_own_value>"
                nexthop_group_name: "<your_own_value>"
                nexthop_ip: "<your_own_value>"
                nexthop_vrf_name: "<your_own_value> (source router.vrf.name)"
                seq_num: "26"
                src: "<your_own_value>"
        protocol: "28"
        seq_num: "29"
        src: "<your_own_value>"
        start_port: "31"
        tos: "<your_own_value>"
        tos_mask: "<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 fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch 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
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

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)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.