fmgr_hotspot20_hsprofile – Configure hotspot profile.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name
,var name
,var.name
New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- hotspot20_hsprofile - Configure hotspot profile. type: dict
- 3gpp_plmn (Alias name: 3gpp-plmn) 3gpp plmn name. type: str more...
- access_network_asra (Alias name: access-network-asra) Enable/disable additional step required for access (asra). type: str choices: [disable, enable] more...
- access_network_esr (Alias name: access-network-esr) Enable/disable emergency services reachable (esr). type: str choices: [disable, enable] more...
- access_network_internet (Alias name: access-network-internet) Enable/disable connectivity to the internet. type: str choices: [disable, enable] more...
- access_network_type (Alias name: access-network-type) Access network type. type: str choices: [private-network, private-network-with-guest-access, chargeable-public-network, free-public-network, personal-device-network, emergency-services-only-network, test-or-experimental, wildcard] more...
- access_network_uesa (Alias name: access-network-uesa) Enable/disable unauthenticated emergency service accessible (uesa). type: str choices: [disable, enable] more...
- anqp_domain_id (Alias name: anqp-domain-id) Anqp domain id (0-65535). type: int more...
- bss_transition (Alias name: bss-transition) Enable/disable basic service set (bss) transition support. type: str choices: [disable, enable] more...
- conn_cap (Alias name: conn-cap) Connection capability name. type: str more...
- deauth_request_timeout (Alias name: deauth-request-timeout) Deauthentication request timeout (in seconds). type: int more...
- dgaf Enable/disable downstream group-addressed forwarding (dgaf). type: str choices: [disable, enable] more...
- domain_name (Alias name: domain-name) Domain name. type: str more...
- gas_comeback_delay (Alias name: gas-comeback-delay) Gas comeback delay (0 or 100 - 4000 milliseconds, default = 500). type: int more...
- gas_fragmentation_limit (Alias name: gas-fragmentation-limit) Gas fragmentation limit (512 - 4096, default = 1024). type: int more...
- hessid Homogeneous extended service set identifier (hessid). type: str more...
- ip_addr_type (Alias name: ip-addr-type) Ip address type name. type: str more...
- l2tif Enable/disable layer 2 traffic inspection and filtering. type: str choices: [disable, enable] more...
- nai_realm (Alias name: nai-realm) Nai realm list name. type: str more...
- name Hotspot profile name. type: str more...
- network_auth (Alias name: network-auth) Network authentication name. type: str more...
- oper_friendly_name (Alias name: oper-friendly-name) Operator friendly name. type: str more...
- osu_provider (Alias name: osu-provider) Manually selected list of osu provider(s). type: list or str more...
- osu_ssid (Alias name: osu-ssid) Online sign up (osu) ssid. type: str more...
- pame_bi (Alias name: pame-bi) Enable/disable pre-association message exchange bssid independent (pame-bi). type: str choices: [disable, enable] more...
- proxy_arp (Alias name: proxy-arp) Enable/disable proxy arp. type: str choices: [disable, enable] more...
- qos_map (Alias name: qos-map) Qos map set id. type: str more...
- roaming_consortium (Alias name: roaming-consortium) Roaming consortium list name. type: str more...
- venue_group (Alias name: venue-group) Venue group. type: str choices: [unspecified, assembly, business, educational, factory, institutional, mercantile, residential, storage, utility, vehicular, outdoor] more...
- venue_name (Alias name: venue-name) Venue name. type: str more...
- venue_type (Alias name: venue-type) Venue type. type: str choices: [unspecified, arena, stadium, passenger-terminal, amphitheater, amusement-park, place-of-worship, convention-center, library, museum, restaurant, theater, bar, coffee-shop, zoo-or-aquarium, emergency-center, doctor-office, bank, fire-station, police-station, post-office, professional-office, research-facility, attorney-office, primary-school, secondary-school, university-or-college, factory, hospital, long-term-care-facility, rehab-center, group-home, prison-or-jail, retail-store, grocery-market, auto-service-station, shopping-mall, gas-station, private, hotel-or-motel, dormitory, boarding-house, automobile, airplane, bus, ferry, ship-or-boat, train, motor-bike, muni-mesh-network, city-park, rest-area, traffic-control, bus-stop, kiosk] more...
- wan_metrics (Alias name: wan-metrics) Wan metric name. type: str more...
- wnm_sleep_mode (Alias name: wnm-sleep-mode) Enable/disable wireless network management (wnm) sleep mode. type: str choices: [disable, enable] more...
- advice_of_charge (Alias name: advice-of-charge) Advice of charge. type: str more...
- oper_icon (Alias name: oper-icon) Operator icon. type: str more...
- osu_provider_nai (Alias name: osu-provider-nai) Osu provider nai. type: str more...
- release Hotspot 2. type: int more...
- terms_and_conditions (Alias name: terms-and-conditions) Terms and conditions. type: str more...
- venue_url (Alias name: venue-url) Venue name. type: str more...
- wba_charging_currency (Alias name: wba-charging-currency) Three letter currency code. type: str more...
- wba_charging_rate (Alias name: wba-charging-rate) Number of currency units per kilobyte. type: int more...
- wba_data_clearing_provider (Alias name: wba-data-clearing-provider) Wba id of data clearing provider. type: str more...
- wba_financial_clearing_provider (Alias name: wba-financial-clearing-provider) Wba id of financial clearing provider. type: str more...
- wba_open_roaming (Alias name: wba-open-roaming) Enable/disable wba open roaming support. type: str choices: [disable, enable] more...
Notes
Note
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state: present directive.
To delete an object, use state: absent directive
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- 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]>
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.