fmgd_router_isis – Configure IS-IS.

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_isis - Configure IS-IS. type: dict
    • adjacency_check (Alias name: adjacency-check) Enable/disable adjacency check. type: str choices: [disable, enable] more...
    • adjacency_check6 (Alias name: adjacency-check6) Enable/disable ipv6 adjacency check. type: str choices: [disable, enable] more...
    • adv_passive_only (Alias name: adv-passive-only) Enable/disable is-is advertisement of passive interfaces only. type: str choices: [disable, enable] more...
    • adv_passive_only6 (Alias name: adv-passive-only6) Enable/disable ipv6 is-is advertisement of passive interfaces only. type: str choices: [disable, enable] more...
    • auth_keychain_l1 (Alias name: auth-keychain-l1) Authentication key-chain for level 1 pdus. type: list more...
    • auth_keychain_l2 (Alias name: auth-keychain-l2) Authentication key-chain for level 2 pdus. type: list more...
    • auth_mode_l1 (Alias name: auth-mode-l1) Level 1 authentication mode. type: str choices: [md5, password] more...
    • auth_mode_l2 (Alias name: auth-mode-l2) Level 2 authentication mode. type: str choices: [md5, password] more...
    • auth_password_l1 (Alias name: auth-password-l1) Authentication password for level 1 pdus. type: list more...
    • auth_password_l2 (Alias name: auth-password-l2) Authentication password for level 2 pdus. type: list more...
    • auth_sendonly_l1 (Alias name: auth-sendonly-l1) Enable/disable level 1 authentication send-only. type: str choices: [disable, enable] more...
    • auth_sendonly_l2 (Alias name: auth-sendonly-l2) Enable/disable level 2 authentication send-only. type: str choices: [disable, enable] more...
    • default_originate (Alias name: default-originate) Enable/disable distribution of default route information. type: str choices: [disable, enable] more...
    • default_originate6 (Alias name: default-originate6) Enable/disable distribution of default ipv6 route information. type: str choices: [disable, enable] more...
    • dynamic_hostname (Alias name: dynamic-hostname) Enable/disable dynamic hostname. type: str choices: [disable, enable] more...
    • ignore_lsp_errors (Alias name: ignore-lsp-errors) Enable/disable ignoring of lsp errors with bad checksums. type: str choices: [disable, enable] more...
    • is_type (Alias name: is-type) Is type. type: str choices: [level-1-2, level-1, level-2-only] more...
    • isis_interface (Alias name: isis-interface) Isis interface. type: list more...
      • auth_keychain_l1 (Alias name: auth-keychain-l1) Authentication key-chain for level 1 pdus. type: list more...
      • auth_keychain_l2 (Alias name: auth-keychain-l2) Authentication key-chain for level 2 pdus. type: list more...
      • auth_mode_l1 (Alias name: auth-mode-l1) Level 1 authentication mode. type: str choices: [md5, password] more...
      • auth_mode_l2 (Alias name: auth-mode-l2) Level 2 authentication mode. type: str choices: [md5, password] more...
      • auth_password_l1 (Alias name: auth-password-l1) Authentication password for level 1 pdus. type: list more...
      • auth_password_l2 (Alias name: auth-password-l2) Authentication password for level 2 pdus. type: list more...
      • auth_send_only_l1 (Alias name: auth-send-only-l1) Enable/disable authentication send-only for level 1 pdus. type: str choices: [disable, enable] more...
      • auth_send_only_l2 (Alias name: auth-send-only-l2) Enable/disable authentication send-only for level 2 pdus. type: str choices: [disable, enable] more...
      • circuit_type (Alias name: circuit-type) Is-is interfaces circuit type. type: str choices: [level-1-2, level-1, level-2] more...
      • csnp_interval_l1 (Alias name: csnp-interval-l1) Level 1 csnp interval. type: int more...
      • csnp_interval_l2 (Alias name: csnp-interval-l2) Level 2 csnp interval. type: int more...
      • hello_interval_l1 (Alias name: hello-interval-l1) Level 1 hello interval. type: int more...
      • hello_interval_l2 (Alias name: hello-interval-l2) Level 2 hello interval. type: int more...
      • hello_multiplier_l1 (Alias name: hello-multiplier-l1) Level 1 multiplier for hello holding time. type: int more...
      • hello_multiplier_l2 (Alias name: hello-multiplier-l2) Level 2 multiplier for hello holding time. type: int more...
      • hello_padding (Alias name: hello-padding) Enable/disable padding to is-is hello packets. type: str choices: [disable, enable] more...
      • lsp_interval (Alias name: lsp-interval) Lsp transmission interval (milliseconds). type: int more...
      • lsp_retransmit_interval (Alias name: lsp-retransmit-interval) Lsp retransmission interval (sec). type: int more...
      • mesh_group (Alias name: mesh-group) Enable/disable is-is mesh group. type: str choices: [disable, enable] more...
      • mesh_group_id (Alias name: mesh-group-id) Mesh group id <0-4294967295>, 0: mesh-group blocked. type: int more...
      • metric_l1 (Alias name: metric-l1) Level 1 metric for interface. type: int more...
      • metric_l2 (Alias name: metric-l2) Level 2 metric for interface. type: int more...
      • name Is-is interface name. type: list more...
      • network_type (Alias name: network-type) Is-is interfaces network type. type: str choices: [broadcast, point-to-point, loopback] more...
      • priority_l1 (Alias name: priority-l1) Level 1 priority. type: int more...
      • priority_l2 (Alias name: priority-l2) Level 2 priority. type: int more...
      • status Enable/disable interface for is-is. type: str choices: [disable, enable] more...
      • status6 Enable/disable ipv6 interface for is-is. type: str choices: [disable, enable] more...
      • wide_metric_l1 (Alias name: wide-metric-l1) Level 1 wide metric for interface. type: int more...
      • wide_metric_l2 (Alias name: wide-metric-l2) Level 2 wide metric for interface. type: int more...
    • isis_net (Alias name: isis-net) Isis net. type: list more...
      • id Isis network id. type: int more...
      • net Is-is networks (format = xx. type: str more...
    • lsp_gen_interval_l1 (Alias name: lsp-gen-interval-l1) Minimum interval for level 1 lsp regenerating. type: int more...
    • lsp_gen_interval_l2 (Alias name: lsp-gen-interval-l2) Minimum interval for level 2 lsp regenerating. type: int more...
    • lsp_refresh_interval (Alias name: lsp-refresh-interval) Lsp refresh time in seconds. type: int more...
    • max_lsp_lifetime (Alias name: max-lsp-lifetime) Maximum lsp lifetime in seconds. type: int more...
    • metric_style (Alias name: metric-style) Use old-style (iso 10589) or new-style packet formats. type: str choices: [narrow, narrow-transition, narrow-transition-l1, narrow-transition-l2, wide, wide-l1, wide-l2, wide-transition, wide-transition-l1, wide-transition-l2, transition, transition-l1, transition-l2] more...
    • overload_bit (Alias name: overload-bit) Enable/disable signal other routers not to use us in spf. type: str choices: [disable, enable] more...
    • overload_bit_on_startup (Alias name: overload-bit-on-startup) Overload-bit only temporarily after reboot. type: int more...
    • overload_bit_suppress (Alias name: overload-bit-suppress) Suppress overload-bit for the specific prefixes. type: list choices: [external, interlevel] more...
    • redistribute Redistribute. type: dict more...
      • level Level. type: str choices: [level-1-2, level-1, level-2] more...
      • metric Metric. type: int more...
      • metric_type (Alias name: metric-type) Metric type. type: str choices: [external, internal] more...
      • protocol Protocol name. type: str more...
      • routemap Route map name. type: list more...
      • status Status. type: str choices: [disable, enable] more...
    • redistribute_l1 (Alias name: redistribute-l1) Enable/disable redistribution of level 1 routes into level 2. type: str choices: [disable, enable] more...
    • redistribute_l1_list (Alias name: redistribute-l1-list) Access-list for route redistribution from l1 to l2. type: list more...
    • redistribute_l2 (Alias name: redistribute-l2) Enable/disable redistribution of level 2 routes into level 1. type: str choices: [disable, enable] more...
    • redistribute_l2_list (Alias name: redistribute-l2-list) Access-list for route redistribution from l2 to l1. type: list more...
    • redistribute6 Redistribute6. type: dict more...
      • level Level. type: str choices: [level-1-2, level-1, level-2] more...
      • metric Metric. type: int more...
      • metric_type (Alias name: metric-type) Metric type. type: str choices: [external, internal] more...
      • protocol Protocol name. type: str more...
      • routemap Route map name. type: list more...
      • status Enable/disable redistribution. type: str choices: [disable, enable] more...
    • redistribute6_l1 (Alias name: redistribute6-l1) Enable/disable redistribution of level 1 ipv6 routes into level 2. type: str choices: [disable, enable] more...
    • redistribute6_l1_list (Alias name: redistribute6-l1-list) Access-list for ipv6 route redistribution from l1 to l2. type: list more...
    • redistribute6_l2 (Alias name: redistribute6-l2) Enable/disable redistribution of level 2 ipv6 routes into level 1. type: str choices: [disable, enable] more...
    • redistribute6_l2_list (Alias name: redistribute6-l2-list) Access-list for ipv6 route redistribution from l2 to l1. type: list more...
    • spf_interval_exp_l1 (Alias name: spf-interval-exp-l1) Level 1 spf calculation delay. type: list more...
    • spf_interval_exp_l2 (Alias name: spf-interval-exp-l2) Level 2 spf calculation delay. type: list more...
    • summary_address (Alias name: summary-address) Summary address. type: list more...
      • id Summary address entry id. type: int more...
      • level Level. type: str choices: [level-1-2, level-1, level-2] more...
      • prefix Prefix. type: list more...
    • summary_address6 (Alias name: summary-address6) Summary address6. type: list more...
      • id Prefix entry id. type: int more...
      • level Level. type: str choices: [level-1-2, level-1, level-2] more...
      • prefix6 Ipv6 prefix. type: str 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 IS-IS.
      fortinet.fmgdevice.fmgd_router_isis:
        # 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_isis:
          # adjacency_check: <value in [disable, enable]>
          # adjacency_check6: <value in [disable, enable]>
          # adv_passive_only: <value in [disable, enable]>
          # adv_passive_only6: <value in [disable, enable]>
          # auth_keychain_l1: <list or string>
          # auth_keychain_l2: <list or string>
          # auth_mode_l1: <value in [md5, password]>
          # auth_mode_l2: <value in [md5, password]>
          # auth_password_l1: <list or string>
          # auth_password_l2: <list or string>
          # auth_sendonly_l1: <value in [disable, enable]>
          # auth_sendonly_l2: <value in [disable, enable]>
          # default_originate: <value in [disable, enable]>
          # default_originate6: <value in [disable, enable]>
          # dynamic_hostname: <value in [disable, enable]>
          # ignore_lsp_errors: <value in [disable, enable]>
          # is_type: <value in [level-1-2, level-1, level-2-only]>
          # isis_interface:
          #   - auth_keychain_l1: <list or string>
          #     auth_keychain_l2: <list or string>
          #     auth_mode_l1: <value in [md5, password]>
          #     auth_mode_l2: <value in [md5, password]>
          #     auth_password_l1: <list or string>
          #     auth_password_l2: <list or string>
          #     auth_send_only_l1: <value in [disable, enable]>
          #     auth_send_only_l2: <value in [disable, enable]>
          #     circuit_type: <value in [level-1-2, level-1, level-2]>
          #     csnp_interval_l1: <integer>
          #     csnp_interval_l2: <integer>
          #     hello_interval_l1: <integer>
          #     hello_interval_l2: <integer>
          #     hello_multiplier_l1: <integer>
          #     hello_multiplier_l2: <integer>
          #     hello_padding: <value in [disable, enable]>
          #     lsp_interval: <integer>
          #     lsp_retransmit_interval: <integer>
          #     mesh_group: <value in [disable, enable]>
          #     mesh_group_id: <integer>
          #     metric_l1: <integer>
          #     metric_l2: <integer>
          #     name: <list or string>
          #     network_type: <value in [broadcast, point-to-point, loopback]>
          #     priority_l1: <integer>
          #     priority_l2: <integer>
          #     status: <value in [disable, enable]>
          #     status6: <value in [disable, enable]>
          #     wide_metric_l1: <integer>
          #     wide_metric_l2: <integer>
          # isis_net:
          #   - id: <integer>
          #     net: <string>
          # lsp_gen_interval_l1: <integer>
          # lsp_gen_interval_l2: <integer>
          # lsp_refresh_interval: <integer>
          # max_lsp_lifetime: <integer>
          # metric_style: <value in [narrow, narrow-transition, narrow-transition-l1, ...]>
          # overload_bit: <value in [disable, enable]>
          # overload_bit_on_startup: <integer>
          # overload_bit_suppress:
          #   - "external"
          #   - "interlevel"
          # redistribute:
          #   level: <value in [level-1-2, level-1, level-2]>
          #   metric: <integer>
          #   metric_type: <value in [external, internal]>
          #   protocol: <string>
          #   routemap: <list or string>
          #   status: <value in [disable, enable]>
          # redistribute_l1: <value in [disable, enable]>
          # redistribute_l1_list: <list or string>
          # redistribute_l2: <value in [disable, enable]>
          # redistribute_l2_list: <list or string>
          # redistribute6:
          #   level: <value in [level-1-2, level-1, level-2]>
          #   metric: <integer>
          #   metric_type: <value in [external, internal]>
          #   protocol: <string>
          #   routemap: <list or string>
          #   status: <value in [disable, enable]>
          # redistribute6_l1: <value in [disable, enable]>
          # redistribute6_l1_list: <list or string>
          # redistribute6_l2: <value in [disable, enable]>
          # redistribute6_l2_list: <list or string>
          # spf_interval_exp_l1: <list or integer>
          # spf_interval_exp_l2: <list or integer>
          # summary_address:
          #   - id: <integer>
          #     level: <value in [level-1-2, level-1, level-2]>
          #     prefix: <list or string>
          # summary_address6:
          #   - id: <integer>
          #     level: <value in [level-1-2, level-1, level-2]>
          #     prefix6: <string>

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)