fortios_router_isis – Configure IS-IS in Fortinet’s FortiOS and FortiGate.

New in version 2.9.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and isis category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.9.0

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
  • vdom - 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 default: root
  • router_isis - Configure IS-IS. type: dict
    • adjacency_check - Enable/disable adjacency check. type: str choices: enable, disable
    • adjacency_check6 - Enable/disable IPv6 adjacency check. type: str choices: enable, disable
    • adv_passive_only - Enable/disable IS-IS advertisement of passive interfaces only. type: str choices: enable, disable
    • adv_passive_only6 - Enable/disable IPv6 IS-IS advertisement of passive interfaces only. type: str choices: enable, disable
    • auth_keychain_l1 - Authentication key-chain for level 1 PDUs. Source router.key-chain.name. type: str
    • auth_keychain_l2 - Authentication key-chain for level 2 PDUs. Source router.key-chain.name. type: str
    • auth_mode_l1 - Level 1 authentication mode. type: str choices: password, md5
    • auth_mode_l2 - Level 2 authentication mode. type: str choices: password, md5
    • auth_password_l1 - Authentication password for level 1 PDUs. type: str
    • auth_password_l2 - Authentication password for level 2 PDUs. type: str
    • auth_sendonly_l1 - Enable/disable level 1 authentication send-only. type: str choices: enable, disable
    • auth_sendonly_l2 - Enable/disable level 2 authentication send-only. type: str choices: enable, disable
    • default_originate - Enable/disable distribution of default route information. type: str choices: enable, disable
    • default_originate6 - Enable/disable distribution of default IPv6 route information. type: str choices: enable, disable
    • dynamic_hostname - Enable/disable dynamic hostname. type: str choices: enable, disable
    • ignore_lsp_errors - Enable/disable ignoring of LSP errors with bad checksums. type: str choices: enable, disable
    • is_type - IS type. type: str choices: level-1-2, level-1, level-2-only
    • isis_interface - IS-IS interface configuration. type: list
      • auth_keychain_l1 - Authentication key-chain for level 1 PDUs. Source router.key-chain.name. type: str
      • auth_keychain_l2 - Authentication key-chain for level 2 PDUs. Source router.key-chain.name. type: str
      • auth_mode_l1 - Level 1 authentication mode. type: str choices: md5, password
      • auth_mode_l2 - Level 2 authentication mode. type: str choices: md5, password
      • auth_password_l1 - Authentication password for level 1 PDUs. type: str
      • auth_password_l2 - Authentication password for level 2 PDUs. type: str
      • auth_send_only_l1 - Enable/disable authentication send-only for level 1 PDUs. type: str choices: enable, disable
      • auth_send_only_l2 - Enable/disable authentication send-only for level 2 PDUs. type: str choices: enable, disable
      • circuit_type - IS-IS interface"s circuit type type: str choices: level-1-2, level-1, level-2
      • csnp_interval_l1 - Level 1 CSNP interval. type: int
      • csnp_interval_l2 - Level 2 CSNP interval. type: int
      • hello_interval_l1 - Level 1 hello interval. type: int
      • hello_interval_l2 - Level 2 hello interval. type: int
      • hello_multiplier_l1 - Level 1 multiplier for Hello holding time. type: int
      • hello_multiplier_l2 - Level 2 multiplier for Hello holding time. type: int
      • hello_padding - Enable/disable padding to IS-IS hello packets. type: str choices: enable, disable
      • lsp_interval - LSP transmission interval (milliseconds). type: int
      • lsp_retransmit_interval - LSP retransmission interval (sec). type: int
      • mesh_group - Enable/disable IS-IS mesh group. type: str choices: enable, disable
      • mesh_group_id - Mesh group ID <0-4294967295>, 0: mesh-group blocked. type: int
      • metric_l1 - Level 1 metric for interface. type: int
      • metric_l2 - Level 2 metric for interface. type: int
      • name - IS-IS interface name. Source system.interface.name. type: str required: True
      • network_type - IS-IS interface"s network type type: str choices: broadcast, point-to-point, loopback
      • priority_l1 - Level 1 priority. type: int
      • priority_l2 - Level 2 priority. type: int
      • status - Enable/disable interface for IS-IS. type: str choices: enable, disable
      • status6 - Enable/disable IPv6 interface for IS-IS. type: str choices: enable, disable
      • wide_metric_l1 - Level 1 wide metric for interface. type: int
      • wide_metric_l2 - Level 2 wide metric for interface. type: int
    • isis_net - IS-IS net configuration. type: list
      • id - isis-net ID. type: int required: True
      • net - IS-IS net xx.xxxx. ... .xxxx.xx. type: str
    • lsp_gen_interval_l1 - Minimum interval for level 1 LSP regenerating. type: int
    • lsp_gen_interval_l2 - Minimum interval for level 2 LSP regenerating. type: int
    • lsp_refresh_interval - LSP refresh time in seconds. type: int
    • max_lsp_lifetime - Maximum LSP lifetime in seconds. type: int
    • metric_style - Use old-style (ISO 10589) or new-style packet formats type: str choices: narrow, wide, transition, narrow-transition, narrow-transition-l1, narrow-transition-l2, wide-l1, wide-l2, wide-transition, wide-transition-l1, wide-transition-l2, transition-l1, transition-l2
    • overload_bit - Enable/disable signal other routers not to use us in SPF. type: str choices: enable, disable
    • overload_bit_on_startup - Overload-bit only temporarily after reboot. type: int
    • overload_bit_suppress - Suppress overload-bit for the specific prefixes. type: str choices: external, interlevel
    • redistribute - IS-IS redistribute protocols. type: list
      • level - Level. type: str choices: level-1-2, level-1, level-2
      • metric - Metric. type: int
      • metric_type - Metric type. type: str choices: external, internal
      • protocol - Protocol name. type: str required: True
      • routemap - Route map name. Source router.route-map.name. type: str
      • status - Status. type: str choices: enable, disable
    • redistribute_l1 - Enable/disable redistribution of level 1 routes into level 2. type: str choices: enable, disable
    • redistribute_l1_list - Access-list for route redistribution from l1 to l2. Source router.access-list.name. type: str
    • redistribute_l2 - Enable/disable redistribution of level 2 routes into level 1. type: str choices: enable, disable
    • redistribute_l2_list - Access-list for route redistribution from l2 to l1. Source router.access-list.name. type: str
    • redistribute6 - IS-IS IPv6 redistribution for routing protocols. type: list
      • level - Level. type: str choices: level-1-2, level-1, level-2
      • metric - Metric. type: int
      • metric_type - Metric type. type: str choices: external, internal
      • protocol - Protocol name. type: str required: True
      • routemap - Route map name. Source router.route-map.name. type: str
      • status - Enable/disable redistribution. type: str choices: enable, disable
    • redistribute6_l1 - Enable/disable redistribution of level 1 IPv6 routes into level 2. type: str choices: enable, disable
    • redistribute6_l1_list - Access-list for IPv6 route redistribution from l1 to l2. Source router.access-list6.name. type: str
    • redistribute6_l2 - Enable/disable redistribution of level 2 IPv6 routes into level 1. type: str choices: enable, disable
    • redistribute6_l2_list - Access-list for IPv6 route redistribution from l2 to l1. Source router.access-list6.name. type: str
    • spf_interval_exp_l1 - Level 1 SPF calculation delay. type: str
    • spf_interval_exp_l2 - Level 2 SPF calculation delay. type: str
    • summary_address - IS-IS summary addresses. type: list
      • id - Summary address entry ID. type: int required: True
      • level - Level. type: str choices: level-1-2, level-1, level-2
      • prefix - Prefix. type: str
    • summary_address6 - IS-IS IPv6 summary address. type: list
      • id - Prefix entry ID. type: int required: True
      • level - Level. type: str choices: level-1-2, level-1, level-2
      • prefix6 - IPv6 prefix. type: str

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure IS-IS.
    fortios_router_isis:
      vdom:  "{{ vdom }}"
      router_isis:
        adjacency_check: "enable"
        adjacency_check6: "enable"
        adv_passive_only: "enable"
        adv_passive_only6: "enable"
        auth_keychain_l1: "<your_own_value> (source router.key-chain.name)"
        auth_keychain_l2: "<your_own_value> (source router.key-chain.name)"
        auth_mode_l1: "password"
        auth_mode_l2: "password"
        auth_password_l1: "<your_own_value>"
        auth_password_l2: "<your_own_value>"
        auth_sendonly_l1: "enable"
        auth_sendonly_l2: "enable"
        default_originate: "enable"
        default_originate6: "enable"
        dynamic_hostname: "enable"
        ignore_lsp_errors: "enable"
        is_type: "level-1-2"
        isis_interface:
         -
            auth_keychain_l1: "<your_own_value> (source router.key-chain.name)"
            auth_keychain_l2: "<your_own_value> (source router.key-chain.name)"
            auth_mode_l1: "md5"
            auth_mode_l2: "md5"
            auth_password_l1: "<your_own_value>"
            auth_password_l2: "<your_own_value>"
            auth_send_only_l1: "enable"
            auth_send_only_l2: "enable"
            circuit_type: "level-1-2"
            csnp_interval_l1: "30"
            csnp_interval_l2: "31"
            hello_interval_l1: "32"
            hello_interval_l2: "33"
            hello_multiplier_l1: "34"
            hello_multiplier_l2: "35"
            hello_padding: "enable"
            lsp_interval: "37"
            lsp_retransmit_interval: "38"
            mesh_group: "enable"
            mesh_group_id: "40"
            metric_l1: "41"
            metric_l2: "42"
            name: "default_name_43 (source system.interface.name)"
            network_type: "broadcast"
            priority_l1: "45"
            priority_l2: "46"
            status: "enable"
            status6: "enable"
            wide_metric_l1: "49"
            wide_metric_l2: "50"
        isis_net:
         -
            id:  "52"
            net: "<your_own_value>"
        lsp_gen_interval_l1: "54"
        lsp_gen_interval_l2: "55"
        lsp_refresh_interval: "56"
        max_lsp_lifetime: "57"
        metric_style: "narrow"
        overload_bit: "enable"
        overload_bit_on_startup: "60"
        overload_bit_suppress: "external"
        redistribute:
         -
            level: "level-1-2"
            metric: "64"
            metric_type: "external"
            protocol: "<your_own_value>"
            routemap: "<your_own_value> (source router.route-map.name)"
            status: "enable"
        redistribute_l1: "enable"
        redistribute_l1_list: "<your_own_value> (source router.access-list.name)"
        redistribute_l2: "enable"
        redistribute_l2_list: "<your_own_value> (source router.access-list.name)"
        redistribute6:
         -
            level: "level-1-2"
            metric: "75"
            metric_type: "external"
            protocol: "<your_own_value>"
            routemap: "<your_own_value> (source router.route-map.name)"
            status: "enable"
        redistribute6_l1: "enable"
        redistribute6_l1_list: "<your_own_value> (source router.access-list6.name)"
        redistribute6_l2: "enable"
        redistribute6_l2_list: "<your_own_value> (source router.access-list6.name)"
        spf_interval_exp_l1: "<your_own_value>"
        spf_interval_exp_l2: "<your_own_value>"
        summary_address:
         -
            id:  "87"
            level: "level-1-2"
            prefix: "<your_own_value>"
        summary_address6:
         -
            id:  "91"
            level: "level-1-2"
            prefix6: "<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 fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate 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
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

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)
  • Nicolas Thomas (@thomnico)

Hint

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