/ home / drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_vpn_ssl_settings_authenticationrule

drmofu.fortimanager.fmgr_vpn_ssl_settings_authenticationrule (2.2.2) — module

Authentication rule for SSL VPN.

| "added in version" 2.1.0 of drmofu.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

 - 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>

Inputs

vdom:
description: the parameter (vdom) in requested url
required: true
type: str

state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str

device:
description: the parameter (device) in requested url
required: true
type: str

rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list

enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool

access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str

rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list

proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str

bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool

workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str

forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str

workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int

vpn_ssl_settings_authenticationrule:
description: the top level parameters set
required: false
suboptions:
auth:
choices:
- any
- local
- radius
- ldap
- tacacs+
- peer
description: SSL VPN authentication method restriction.
type: str
cipher:
choices:
- any
- high
- medium
description: SSL VPN cipher strength.
type: str
client-cert:
choices:
- disable
- enable
description: Enable/disable SSL VPN client certificate restrictive.
type: str
groups:
description: User groups.
type: str
id:
description: ID
type: int
portal:
description: SSL VPN portal.
type: str
realm:
description: SSL VPN realm.
type: str
source-address:
description: Source address of incoming traffic.
type: str
source-address-negate:
choices:
- disable
- enable
description: Enable/disable negated source address match.
type: str
source-address6:
description: IPv6 source address of incoming traffic.
type: str
source-address6-negate:
choices:
- disable
- enable
description: Enable/disable negated source IPv6 address match.
type: str
source-interface:
description: SSL VPN source interface of incoming traffic.
type: str
user-peer:
description: Name of user peer.
type: str
users:
description: User name.
type: str
type: dict

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list