fortinet.fortimanager.fmgr_vpn_ssl_settings_authenticationrule module – Authentication rule for SSL VPN.
Note
This module is part of the fortinet.fortimanager collection (version 2.3.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_vpn_ssl_settings_authenticationrule
.
New in fortinet.fortimanager 2.1.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
the parameter (device) in requested url |
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
the parameter (vdom) in requested url |
|
the top level parameters set |
|
SSL VPN authentication method restriction. Choices:
|
|
SSL VPN cipher strength. Choices:
|
|
Enable/disable SSL VPN client certificate restrictive. Choices:
|
|
(list or str) User groups. |
|
ID |
|
SSL VPN portal. |
|
SSL VPN realm. |
|
(list or str) Source address of incoming traffic. |
|
Enable/disable negated source address match. Choices:
|
|
(list or str) IPv6 source address of incoming traffic. |
|
Enable/disable negated source IPv6 address match. Choices:
|
|
(list or str) SSL VPN source interface of incoming traffic. |
|
Name of user peer. |
|
(list or str) User name. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Authentication rule for SSL VPN.
fmgr_vpn_ssl_settings_authenticationrule:
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, ...]
device: <your own value>
vdom: <your own value>
state: <value in [present, absent]>
vpn_ssl_settings_authenticationrule:
auth: <value in [any, local, radius, ...]>
cipher: <value in [any, high, medium]>
client-cert: <value in [disable, enable]>
groups: <list or string>
id: <integer>
portal: <string>
realm: <string>
source-address: <list or string>
source-address-negate: <value in [disable, enable]>
source-address6: <list or string>
source-address6-negate: <value in [disable, enable]>
source-interface: <list or string>
user-peer: <string>
users: <list or string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |