fortinet.fortimanager.fmgr_hotspot20_hsprofile 模块 – 配置热点配置文件。

注意

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

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

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

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

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 客户端。
hotspot20_hsprofile 字典	设置的顶级参数。
3gpp_plmn 别名：3gpp-plmn 字符串	3GPP PLMN 名称。
access_network_asra 别名：access-network-asra 字符串	启用/禁用访问所需的附加步骤 选项 "disable" "enable"
access_network_esr 别名：access-network-esr 字符串	启用/禁用紧急服务可达性 选项 "disable" "enable"
access_network_internet 别名：access-network-internet 字符串	启用/禁用互联网连接。 选项 "disable" "enable"
access_network_type 别名：access-network-type 字符串	接入网络类型。 选项 "private-network" "private-network-with-guest-access" "chargeable-public-network" "free-public-network" "personal-device-network" "emergency-services-only-network" "test-or-experimental" "wildcard"
access_network_uesa 别名：access-network-uesa 字符串	启用/禁用未经身份验证的紧急服务可访问性 选项 "disable" "enable"
advice_of_charge 别名：advice-of-charge 字符串	收费建议。
anqp_domain_id 别名：anqp-domain-id 整数	ANQP 域 ID
bss_transition 别名：bss-transition 字符串	启用/禁用基本服务集 选项 "disable" "enable"
conn_cap 别名：conn-cap 字符串	连接能力名称。
deauth_request_timeout 别名：deauth-request-timeout 整数	身份验证请求超时
dgaf 字符串	启用/禁用下行组地址转发 选项 "disable" "enable"
domain_name 别名：domain-name 字符串	域名。
gas_comeback_delay 别名：gas-comeback-delay 整数	GAS 回归延迟
gas_fragmentation_limit 别名：gas-fragmentation-limit 整数	GAS 分片限制
hessid 字符串	同质扩展服务集标识符
ip_addr_type 别名：ip-addr-type 字符串	IP 地址类型名称。
l2tif 字符串	启用/禁用第 2 层流量检查和过滤。 选项 "disable" "enable"
nai_realm 别名：nai-realm 字符串	NAI 领域列表名称。
name 字符串 / 必需	热点配置文件名称。
network_auth 别名：network-auth 字符串	网络认证名称。
oper_friendly_name 别名：oper-friendly-name 字符串	运营商友好名称。
oper_icon 别名：oper-icon 字符串	运营商图标。
osu_provider 别名：osu-provider 任意	(列表或字符串) 手动选择的OSU提供商列表
osu_provider_nai 别名：osu-provider-nai 字符串	OSU提供商NAI。
osu_ssid 别名：osu-ssid 字符串	在线注册
pame_bi 别名：pame-bi 字符串	启用/禁用预关联消息交换BSSID独立 选项 "disable" "enable"
proxy_arp 别名：proxy-arp 字符串	启用/禁用代理ARP。 选项 "disable" "enable"
qos_map 别名：qos-map 字符串	QoS MAP设置ID。
版本 整数	热点2.
roaming_consortium 别名：roaming-consortium 字符串	漫游联盟列表名称。
terms_and_conditions 别名：terms-and-conditions 字符串	条款和条件。
venue_group 别名：venue-group 字符串	场所组。 选项 "未指定" "组装" "商业" "教育" "工厂" "机构" "商业" "住宅" "存储" "公用事业" "车辆" "户外"
venue_name 别名：venue-name 字符串	场所名称。
venue_type 别名：venue-type 字符串	场所类型。 选项 "未指定" "竞技场" "体育场" "旅客候机楼" "露天剧场" "游乐园" "礼拜场所" "会议中心" "图书馆" "博物馆" "饭店" "剧院" "酒吧" "咖啡店" "动物园或水族馆" "急救中心" "诊所" "银行" "消防站" "警察局" "邮局" "专业办公室" "研究机构" "律师事务所" "小学" "中学" "大学或学院" "工厂" "医院" "长期护理机构" "康复中心" "集体宿舍" "监狱或看守所" "零售店" "杂货市场" "汽车服务站" "购物中心" "加油站" "私人" "酒店或汽车旅馆" "宿舍" "寄宿公寓" "汽车" "飞机" "公共汽车" "渡轮" "船" "火车" "摩托车" "市政网状网络" "城市公园" "休息区" "交通管制" "公共汽车站" "售货亭"
venue_url 别名：venue-url 字符串	场所名称。
wan_metrics 别名：wan-metrics 字符串	WAN指标名称。
wba_charging_currency 别名：wba-charging-currency 字符串	三位字母货币代码。
wba_charging_rate 别名：wba-charging-rate 整数	每千字节的货币单位数。
wba_data_clearing_provider 别名：wba-data-clearing-provider 字符串	数据清除提供商的WBA ID。
wba_financial_clearing_provider 别名：wba-financial-clearing-provider 字符串	财务结算提供商的WBA ID。
wba_open_roaming 别名：wba-open-roaming 字符串	启用/禁用WBA开放漫游支持。 选项 "disable" "enable"
wnm_sleep_mode 别名：wnm-sleep-mode 字符串	启用/禁用无线网络管理 选项 "disable" "enable"
proposed_method 字符串	底层Json RPC请求的覆盖方法。 选项 "更新" "设置" "添加"
rc_failed 列表 / 元素=整数	将覆盖失败条件的rc代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的rc代码列表。
状态 字符串 / 必需	创建、更新或删除对象的指令。 选项 "存在" "不存在"
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有助于完成这项工作。

• 要创建或更新对象，请使用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 hotspot profile.
      fortinet.fortimanager.fmgr_hotspot20_hsprofile:
        # 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]>
        hotspot20_hsprofile:
          3gpp_plmn: <string>
          access_network_asra: <value in [disable, enable]>
          access_network_esr: <value in [disable, enable]>
          access_network_internet: <value in [disable, enable]>
          access_network_type: <value in [private-network, private-network-with-guest-access, chargeable-public-network, ...]>
          access_network_uesa: <value in [disable, enable]>
          anqp_domain_id: <integer>
          bss_transition: <value in [disable, enable]>
          conn_cap: <string>
          deauth_request_timeout: <integer>
          dgaf: <value in [disable, enable]>
          domain_name: <string>
          gas_comeback_delay: <integer>
          gas_fragmentation_limit: <integer>
          hessid: <string>
          ip_addr_type: <string>
          l2tif: <value in [disable, enable]>
          nai_realm: <string>
          name: <string>
          network_auth: <string>
          oper_friendly_name: <string>
          osu_provider: <list or string>
          osu_ssid: <string>
          pame_bi: <value in [disable, enable]>
          proxy_arp: <value in [disable, enable]>
          qos_map: <string>
          roaming_consortium: <string>
          venue_group: <value in [unspecified, assembly, business, ...]>
          venue_name: <string>
          venue_type: <value in [unspecified, arena, stadium, ...]>
          wan_metrics: <string>
          wnm_sleep_mode: <value in [disable, enable]>
          advice_of_charge: <string>
          oper_icon: <string>
          osu_provider_nai: <string>
          release: <integer>
          terms_and_conditions: <string>
          venue_url: <string>
          wba_charging_currency: <string>
          wba_charging_rate: <integer>
          wba_data_clearing_provider: <string>
          wba_financial_clearing_provider: <string>
          wba_open_roaming: <value in [disable, enable]>

返回值

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

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

作者

• 杜欣伟 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑琳 (@chillancezen)

• 沈方 (@fshen01)

• 卢洪宾 (@fgtdev-hblu)

集合链接

• 问题追踪器
• 主页
• 代码库 (源代码)