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