fortinet.fortimanager.fmgr_vpn_ssl_settings_authenticationrule – Authentication rule for SSL VPN.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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 version 2.10: of fortinet.fortimanager

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

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

device

string / required

the parameter (device) in requested url

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

vdom

string / required

the parameter (vdom) in requested url

vpn_ssl_settings_authenticationrule

dictionary

the top level parameters set

auth

string

SSL VPN authentication method restriction.

Choices:

  • any

  • local

  • radius

  • ldap

  • tacacs+

cipher

string

SSL VPN cipher strength.

Choices:

  • any

  • high

  • medium

client-cert

string

Enable/disable SSL VPN client certificate restrictive.

Choices:

  • disable

  • enable

groups

string

User groups.

id

integer

ID (0 - 4294967295).

portal

string

SSL VPN portal.

realm

string

SSL VPN realm.

source-address

string

Source address of incoming traffic.

source-address-negate

string

Enable/disable negated source address match.

Choices:

  • disable

  • enable

source-address6

string

IPv6 source address of incoming traffic.

source-address6-negate

string

Enable/disable negated source IPv6 address match.

Choices:

  • disable

  • enable

source-interface

string

SSL VPN source interface of incoming traffic.

user-peer

string

Name of user peer.

users

string

User name.

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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: <value of string>
           id: <value of integer>
           portal: <value of string>
           realm: <value of string>
           source-address: <value of string>
           source-address-negate: <value in [disable, enable]>
           source-address6: <value of string>
           source-address6-negate: <value in [disable, enable]>
           source-interface: <value of string>
           user-peer: <value of string>
           users: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)