: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 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)