fortinet.fortimanager.fmgr_arrpprofile 模块 – 配置 WiFi 自动无线电资源配置
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。
要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_arrpprofile。
fortinet.fortimanager 2.1.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有需要在使用前调整为数据源的参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
设置的顶级参数。 |
|
注释。 |
|
运行动态自动无线电资源配置的时间 |
|
(列表) DARRP 运行时间的防火墙计划。 |
|
启用/禁用在 DARRP 信道选择阶段 1 中使用 DFS 信道 选项
|
|
启用/禁用在 DARRP 信道选择阶段 1 中使用天气信道 选项
|
|
以秒为单位的周期，用于测量平均传输重试和接收错误 |
|
WiFi ARRP 配置文件名称。 |
|
启用以覆盖设置 darrp-optimize 和 darrp-optimize-schedules 选项
|
|
以秒为单位的周期，用于测量平均信道负载、噪声底限和频谱 RSSI |
|
由于周围的 AP，在 DARRP 信道选择阶段 1 中拒绝信道的阈值 |
|
由于信道负载，在 DARRP 信道选择阶段 1 中拒绝信道的百分比阈值 |
|
由于噪声底限，在 DARRP 信道选择阶段 1 中拒绝信道的 dBm 阈值 |
|
触发 DARRP 监控阶段中信道重新选择的接收错误百分比阈值 |
|
由于频谱 RSSI，在 DARRP 信道选择阶段 1 中拒绝信道的 dBm 阈值 |
|
触发 DARRP 监控阶段中信道重新选择的传输重试百分比阈值 |
|
在 DARRP 信道评分计算中用于信道负载的权重 |
|
在 DARRP 信道评分计算中用于 DFS 信道的权重 |
|
在 DARRP 信道评分计算中用于受管 AP 的权重 |
|
在 DARRP 信道评分计算中用于噪声底限的权重 |
|
在 DARRP 信道评分计算中用于 rogue AP 的权重 |
|
在 DARRP 信道评分计算中用于频谱 RSSI 的权重 |
|
在 DARRP 信道评分计算中用于天气信道的权重 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将被覆盖的失败条件对应的 rc 代码列表。 |
|
将被覆盖的成功条件对应的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
在工作区模式下运行 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 有助于完成此工作。
要创建或更新对象，请使用 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: Configure WiFi Automatic Radio Resource Provisioning
fortinet.fortimanager.fmgr_arrpprofile:
# 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]>
arrpprofile:
comment: <string>
darrp_optimize: <integer>
darrp_optimize_schedules: <list or string>
include_dfs_channel: <value in [no, disable, yes, ...]>
include_weather_channel: <value in [no, disable, yes, ...]>
monitor_period: <integer>
name: <string>
override_darrp_optimize: <value in [disable, enable]>
selection_period: <integer>
threshold_ap: <integer>
threshold_channel_load: <integer>
threshold_noise_floor: <string>
threshold_rx_errors: <integer>
threshold_spectral_rssi: <string>
threshold_tx_retries: <integer>
weight_channel_load: <integer>
weight_dfs_channel: <integer>
weight_managed_ap: <integer>
weight_noise_floor: <integer>
weight_rogue_ap: <integer>
weight_spectral_rssi: <integer>
weight_weather_channel: <integer>
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回：始终 |
|
请求的完整 URL。 返回：始终 示例： |
|
API 请求的状态。 返回：始终 示例： |
|
API 响应。 返回：始终 |
|
API 响应的描述性消息。 返回：始终 示例： |
|
目标系统的信息。 返回：始终 |
|
请求的状态。 返回：始终 示例： |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回：复杂类型 |