fortinet.fortimanager.fmgr_system_sdnconnector_routetable 模块 – 配置 Azure 路由表。

注意

此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_system_sdnconnector_routetable。

fortinet.fortimanager 2.0.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包括所有需要在使用前调整为数据源的参数和值。

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求的 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块继续执行而不验证参数。选择 `false` ← （默认） `true`
enable_log 布尔值	启用/禁用任务的日志记录。选择 `false` ← （默认） `true`
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	覆盖底层 Json RPC 请求的方法。选择 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
sdn-connector 字符串	已弃用，请使用“sdn_connector”
sdn_connector 字符串	请求的 URL 中的参数 (sdn-connector)。
state 字符串 / 必需	用于创建、更新或删除对象的指令。选择 `"present"` `"absent"`
system_sdnconnector_routetable 字典	顶级参数集。
name 字符串 / 必需	路由表名称。
resource_group 别名：resource-group 字符串	Azure 路由表的资源组。
route 列表 / 元素=字典	路由。
name 字符串	路由名称。
next_hop 别名：next-hop 字符串	下一跳地址。
subscription_id 别名：subscription-id 字符串	Azure 路由表的订阅 ID。
workspace_locking_adom 字符串	在工作区模式下运行的 FortiManager 要锁定的 adom，该值可以是 global 以及其他包括 root 的值。
workspace_locking_timeout 整数	等待其他用户释放工作区锁定的最大秒数。默认值： `300`

备注 

注意

从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case) 命名。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 帮助完成此工作。
要创建或更新对象，请使用 state present 指令。
要删除对象，请使用 state absent 指令。
通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件

示例 

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure Azure route table.
      fortinet.fortimanager.fmgr_system_sdnconnector_routetable:
        bypass_validation: false
        adom: ansible
        sdn-connector: ansible-test-sdn # name
        state: present
        system_sdnconnector_routetable: # available only when type is set to 'azure' in sdn-connector
          name: ansible-test-routetable
          route:
            - name: Ansible-routetable-route
              next-hop: ansible-test

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the Azure route tables
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_sdnconnector_routetable" # available only when type is set to 'azure' in sdn-connector
          params:
            adom: "ansible"
            sdn-connector: "ansible-test-sdn" # name
            route-table: "your_value"

返回值 

常见的返回值记录在此处，以下是此模块特有的字段

键	描述
meta 字典	请求的结果。已返回：始终
request_url 字符串	请求的完整 URL。已返回：始终示例： `"/sys/login/user"`
response_code 整数	API 请求的状态。已返回：始终示例： `0`
response_data 列表 / 元素=字符串	API 响应。已返回：始终
response_message 字符串	API 响应的描述性消息。已返回：始终示例： `"OK."`
system_information 字典	目标系统的信息。已返回：始终
rc 整数	请求的状态。已返回：始终示例： `0`
version_check_warning 列表 / 元素=字符串	如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。已返回：复杂

作者

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)