fortinet.fortimanager.fmgr_wanopt_profile 模块 – 配置 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
。
fortinet.fortimanager 1.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有参数和值,这些参数和值在使用前需要调整到数据源。
参数
参数 |
注释 |
---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块架构与 FortiManager API 结构不同时才设置为 True,模块将继续执行而不验证参数。 选项
|
|
启用/禁用任务的日志记录。 选项
|
|
使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
用于底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
用于创建、更新或删除对象的指令。 选项
|
|
顶层参数集。 |
|
可选添加一个身份验证组,以限制对身份验证组中对等方的 WAN 优化隧道的访问。 |
|
Cifs。 |
|
启用/禁用字节缓存。 选项
|
|
启用/禁用日志记录。 选项
|
|
(列表) CIFS 的单个端口号或端口号范围。 |
|
为 WAN 优化选择动态或固定大小的数据分块。 选项
|
|
选择协议特定的优化或通用的 TCP 优化。 选项
|
|
启用/禁用使用 SSL 安全的 WAN Opt 隧道。 选项
|
|
启用/禁用 WAN 优化。 选项
|
|
用于主动/非主动和/或交互式/非交互式协议的隧道共享模式。 选项
|
|
注释。 |
|
Ftp。 |
|
启用/禁用字节缓存。 选项
|
|
启用/禁用日志记录。 选项
|
|
(列表) FTP 的单个端口号或端口号范围。 |
|
为 WAN 优化选择动态或固定大小的数据分块。 选项
|
|
选择协议特定的优化或通用的 TCP 优化。 选项
|
|
启用/禁用使用 SSL 安全的 WAN Opt 隧道。 选项
|
|
启用/禁用 SSL/TLS 卸载 选项
|
|
启用/禁用 WAN 优化。 选项
|
|
用于主动/非主动和/或交互式/非交互式协议的隧道共享模式。 选项
|
|
Http。 |
|
启用/禁用字节缓存。 选项
|
|
启用/禁用日志记录。 选项
|
|
(列表) HTTP 的单个端口号或端口号范围。 |
|
为 WAN 优化选择动态或固定大小的数据分块。 选项
|
|
选择协议特定的优化或通用的 TCP 优化。 选项
|
|
启用/禁用使用 SSL 安全的 WAN Opt 隧道。 选项
|
|
启用/禁用 SSL/TLS 卸载 选项
|
|
(列表) 期望 SSL/TLS 卸载的 HTTPS 流量的端口。 |
|
启用/禁用 WAN 优化。 选项
|
|
配置当配置为 HTTP 流量的配置文件接受非 HTTP 会话时如何处理非 HTTP 流量。 选项
|
|
用于主动/非主动和/或交互式/非交互式协议的隧道共享模式。 选项
|
|
如何处理不符合 HTTP 0 的 HTTP 会话。 选项
|
|
Mapi。 |
|
启用/禁用字节缓存。 选项
|
|
启用/禁用日志记录。 选项
|
|
(列表) MAPI 的单个端口号或端口号范围。 |
|
启用/禁用使用 SSL 安全的 WAN Opt 隧道。 选项
|
|
启用/禁用 WAN 优化。 选项
|
|
用于主动/非主动和/或交互式/非交互式协议的隧道共享模式。 选项
|
|
配置文件名称。 |
|
Tcp。 |
|
启用/禁用字节缓存。 选项
|
|
选择 TCP 字节缓存是仅使用系统内存还是同时使用内存和磁盘空间。 选项
|
|
启用/禁用日志记录。 选项
|
|
TCP 的端口号或端口号范围。 |
|
启用/禁用使用 SSL 安全的 WAN Opt 隧道。 选项
|
|
启用/禁用 SSL/TLS 卸载 选项
|
|
(列表)用于 SSL/TLS 卸载的 HTTPS 流量的预期端口号或端口号范围。 |
|
启用/禁用 WAN 优化。 选项
|
|
用于主动/非主动和/或交互式/非交互式协议的隧道共享模式。 选项
|
|
启用/禁用透明模式。 选项
|
|
用于在工作区模式下运行的 FortiManager 的锁定 ADOM,该值可以是 global 和其他(包括 root)。 |
|
等待其他用户释放工作区锁定的最长时间(秒)。 默认值: |
注释
注意
从 2.4.0 版本开始,所有输入参数都使用下划线命名约定(snake_case)命名。请将参数(例如“var-name”)更改为“var_name”。旧参数名称仍然可用,但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行,顶层参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此工作。
要创建或更新对象,请使用状态 present 指令。
要删除对象,请使用状态 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: Configure WAN optimization profiles.
fortinet.fortimanager.fmgr_wanopt_profile:
# 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>
state: present # <value in [present, absent]>
wanopt_profile:
auth_group: <string>
comments: <string>
name: <string>
transparent: <value in [disable, enable]>
cifs:
byte_caching: <value in [disable, enable]>
log_traffic: <value in [disable, enable]>
prefer_chunking: <value in [dynamic, fix]>
protocol_opt: <value in [protocol, tcp]>
secure_tunnel: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel_sharing: <value in [private, shared, express-shared]>
port: <list or integer>
ftp:
byte_caching: <value in [disable, enable]>
log_traffic: <value in [disable, enable]>
prefer_chunking: <value in [dynamic, fix]>
protocol_opt: <value in [protocol, tcp]>
secure_tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel_sharing: <value in [private, shared, express-shared]>
port: <list or integer>
http:
byte_caching: <value in [disable, enable]>
log_traffic: <value in [disable, enable]>
prefer_chunking: <value in [dynamic, fix]>
protocol_opt: <value in [protocol, tcp]>
secure_tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel_sharing: <value in [private, shared, express-shared]>
tunnel_non_http: <value in [disable, enable]>
unknown_http_version: <value in [best-effort, reject, tunnel]>
port: <list or integer>
ssl_port: <list or integer>
mapi:
byte_caching: <value in [disable, enable]>
log_traffic: <value in [disable, enable]>
secure_tunnel: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel_sharing: <value in [private, shared, express-shared]>
port: <list or integer>
tcp:
byte_caching: <value in [disable, enable]>
byte_caching_opt: <value in [mem-only, mem-disk]>
log_traffic: <value in [disable, enable]>
port: <string>
secure_tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
ssl_port: <list or integer>
status: <value in [disable, enable]>
tunnel_sharing: <value in [private, shared, express-shared]>
返回值
通用返回值在此处记录 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
请求的结果。 返回: always |
|
请求的完整 URL。 返回: always 示例: |
|
API 请求的状态。 返回: always 示例: |
|
API 响应。 返回: always |
|
API 响应的描述性消息。 返回: always 示例: |
|
目标系统的信息。 返回: always |
|
请求的状态。 返回: always 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持,则发出警告。 返回: complex |