fortinet.fortios.fortios_wireless_controller_hotspot20_h2qp_conn_capability – Configure connection capability in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
To install it use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_hotspot20_h2qp_conn_capability
.
New in version 2.9: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and h2qp_conn_capability category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | ||
state string / required |
| Indicates whether to create or remove the object. | |
vdom string | Default: "root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. | |
wireless_controller_hotspot20_h2qp_conn_capability dictionary | Configure connection capability. | ||
esp_port string |
| Set ESP port service (used by IPsec VPNs) status. | |
ftp_port string |
| Set FTP port service status. | |
http_port string |
| Set HTTP port service status. | |
icmp_port string |
| Set ICMP port service status. | |
ikev2_port string |
| Set IKEv2 port service for IPsec VPN status. | |
ikev2_xx_port string |
| Set UDP port 4500 (which may be used by IKEv2 for IPsec VPN) service status. | |
name string / required | Connection capability name. | ||
pptp_vpn_port string |
| Set Point to Point Tunneling Protocol (PPTP) VPN port service status. | |
ssh_port string |
| Set SSH port service status. | |
tls_port string |
| Set TLS VPN (HTTPS) port service status. | |
voip_tcp_port string |
| Set VoIP TCP port service status. | |
voip_udp_port string |
| Set VoIP UDP port service status. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure connection capability. fortios_wireless_controller_hotspot20_h2qp_conn_capability: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" wireless_controller_hotspot20_h2qp_conn_capability: esp_port: "closed" ftp_port: "closed" http_port: "closed" icmp_port: "closed" ikev2_port: "closed" ikev2_xx_port: "closed" name: "default_name_9" pptp_vpn_port: "closed" ssh_port: "closed" tls_port: "closed" voip_tcp_port: "closed" voip_udp_port: "closed"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_wireless_controller_hotspot20_h2qp_conn_capability_module.html