fortinet.fortimanager.fmgr_fsp_vlan_interface_vrrp 模块 – VRRP 配置。

注意

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

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

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

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

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 客户端。
fsp_vlan_interface_vrrp 字典	设置的顶级参数。
accept_mode 别名：accept-mode 字符串	接受模式。选择 `"disable"` `"enable"`
adv_interval 别名：adv-interval 整数	Adv 间隔。
ignore_default_route 别名：ignore-default-route 字符串	忽略默认路由。选择 `"disable"` `"enable"`
preempt 字符串	抢占。选择 `"disable"` `"enable"`
priority 整数	优先级。
proxy_arp 别名：proxy-arp 列表 / elements=字典	代理 ARP。
id 整数	ID。
ip 字符串	设置代理 ARP 的 IP 地址。
start_time 别名：start-time 整数	开始时间。
status 字符串	状态。选择 `"disable"` `"enable"`
version 字符串	版本。选择 `"2"` `"3"`
vrdst 任意	（列表）Vrdst。
vrdst_priority 别名：vrdst-priority 整数	Vrdst 优先级。
vrgrp 整数	Vrgrp。
vrid 整数 / 必需	Vrid。
vrip 字符串	Vrip。
proposed_method 字符串	用于底层 Json RPC 请求的覆盖方法。选择 `"update"` `"set"` `"add"`
rc_failed 列表 / elements=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / elements=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	用于创建、更新或删除对象的指令。选择 `"present"` `"absent"`
vlan 字符串 / 必需	请求 URL 中的参数 (vlan)。
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 (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: VRRP configuration.
      fortinet.fortimanager.fmgr_fsp_vlan_interface_vrrp:
        # 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>
        vlan: <your own value>
        state: present # <value in [present, absent]>
        fsp_vlan_interface_vrrp:
          accept_mode: <value in [disable, enable]>
          adv_interval: <integer>
          ignore_default_route: <value in [disable, enable]>
          preempt: <value in [disable, enable]>
          priority: <integer>
          start_time: <integer>
          status: <value in [disable, enable]>
          version: <value in [2, 3]>
          vrdst: <list or string>
          vrdst_priority: <integer>
          vrgrp: <integer>
          vrid: <integer>
          vrip: <string>
          proxy_arp:
            -
              id: <integer>
              ip: <string>

返回值 

通用返回值记录在此处，以下是此模块独有的字段

键	描述
meta 字典	请求的结果。返回：始终
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)
李兴 (@lix-fortinet)
薛杰 (@JieX19)
郑 লিংক (@chillancezen)
沈弗兰克 (@fshen01)
卢红斌 (@fgtdev-hblu)