fortinet.fortimanager.fmgr_wanopt_profile_ftp 模块 – 启用/禁用 FTP WAN 优化并配置 FTP WAN 优化功能。

注意

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

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

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

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

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 客户端进行身份验证。
profile 字符串 / 必需	请求 URL 中的参数 (profile)。
proposed_method 字符串	覆盖底层 Json RPC 请求的方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / elements=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / elements=整数	将覆盖成功条件的 rc 代码列表。
wanopt_profile_ftp 字典	设置的顶层参数。
byte_caching 别名：byte-caching 字符串	启用/禁用 HTTP 的字节缓存。选项 `"disable"` `"enable"`
log_traffic 别名：log-traffic 字符串	启用/禁用日志记录。选项 `"disable"` `"enable"`
port 任意	(列表) FTP 的单个端口号或端口号范围。
prefer_chunking 别名：prefer-chunking 字符串	为 HTTP WAN 优化选择动态或固定大小的数据分块。选项 `"dynamic"` `"fix"`
protocol_opt 别名：protocol-opt 字符串	选择特定于协议的优化或通用 TCP 优化。选项 `"protocol"` `"tcp"`
secure_tunnel 别名：secure-tunnel 字符串	启用/禁用使用 SSL 保护 WAN Opt 隧道。选项 `"disable"` `"enable"`
ssl 字符串	启用/禁用 SSL/TLS 卸载选项 `"disable"` `"enable"`
status 字符串	启用/禁用 HTTP WAN 优化。选项 `"disable"` `"enable"`
tunnel_sharing 别名：tunnel-sharing 字符串	用于主动/非主动和/或交互式/非交互式协议的隧道共享模式。选项 `"private"` `"shared"` `"express-shared"`
workspace_locking_adom 字符串	在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是全局的和其他值，包括 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 有助于完成此工作。
通常，当返回非零 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: Enable/disable FTP WAN Optimization and configure FTP WAN Optimization features.
      fortinet.fortimanager.fmgr_wanopt_profile_ftp:
        # 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>
        profile: <your own value>
        wanopt_profile_ftp:
          byte_caching: <value in [disable, enable]>
          log_traffic: <value in [disable, enable]>
          port: <list or integer>
          prefer_chunking: <value in [dynamic, fix]>
          secure_tunnel: <value in [disable, enable]>
          status: <value in [disable, enable]>
          tunnel_sharing: <value in [private, shared, express-shared]>
          protocol_opt: <value in [protocol, tcp]>
          ssl: <value in [disable, enable]>

返回值 

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

键	描述
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=字符串	如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。返回：复杂类型

作者

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