This is the latest (stable) Ansible community documentation. For Red Hat Ansible Automation Platform subscriptions, see Life Cycle for version details.

fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_neighbor 模块 – SD-WAN 邻居表。

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_neighbor。

fortinet.fortimanager 2.1.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 列表 / elements=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / elements=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。 选项 "present" "absent"
wanprof 字符串 / 必需	请求 URL 中的参数 (wanprof)。
wanprof_system_virtualwanlink_neighbor 字典	设置的顶级参数。
health_check 别名：health-check 字符串	SD-WAN 健康检查名称。
ip 字符串	邻居的 IP 地址。
member 字符串	成员序列号。
role 字符串	邻居的角色。 选项 "primary" "secondary" "standalone"
sla_id 别名：sla-id 整数	SLA ID。
workspace_locking_adom 字符串	要在工作区模式下锁定的 FortiManager 的 adom，该值可以是 global 和其他包括 root 的 adom。
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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SD-WAN neighbor table.
      fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_neighbor:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        wanprof: <your own value>
        state: present # <value in [present, absent]>
        wanprof_system_virtualwanlink_neighbor:
          health_check: <string>
          ip: <string>
          member: <string>
          role: <value in [primary, secondary, standalone]>
          sla_id: <integer>

返回值

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

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

作者

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

集合链接

• 问题跟踪器
• 主页
• 仓库（源代码）