fortinet.fortimanager.fmgr_pkg_authentication_rule module – Configure Authentication Rules.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.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_pkg_authentication_rule.

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

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

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

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

pkg

string / required

The parameter (pkg) in requested url.

pkg_authentication_rule

dictionary

The top level parameters set.

active_auth_method

string

Select an active authentication method.

string

Enable/disable to use device certificate as authentication cookie

Choices:

  • "disable"

  • "enable"

comments

string

Comment.

cors_depth

integer

Depth to allow CORS access

cors_stateful

string

Enable/disable allowance of CORS access

Choices:

  • "disable"

  • "enable"

dstaddr

any

(list or str) Select an IPv4 destination address from available options.

dstaddr6

any

(list or str) Select an IPv6 destination address from available options.

ip_based

string

Enable/disable IP-based authentication.

Choices:

  • "disable"

  • "enable"

name

string / required

Authentication rule name.

protocol

string

Select the protocol to use for authentication

Choices:

  • "http"

  • "ftp"

  • "socks"

  • "ssh"

srcaddr

any

(list or str) Select an IPv4 source address from available options.

srcaddr6

any

(list or str) Select an IPv6 source address.

srcintf

any

(list or str) Incoming

sso_auth_method

string

Select a single-sign on

status

string

Enable/disable this authentication rule.

Choices:

  • "disable"

  • "enable"

transaction_based

string

Enable/disable transaction based authentication

Choices:

  • "disable"

  • "enable"

string

Enable/disable Web authentication cookies

Choices:

  • "disable"

  • "enable"

web_portal

string

Enable/disable web portal for proxy transparent policy

Choices:

  • "disable"

  • "enable"

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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"

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

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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 Authentication Rules.
      fortinet.fortimanager.fmgr_pkg_authentication_rule:
        # 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>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_authentication_rule:
          active_auth_method: <string>
          comments: <string>
          ip_based: <value in [disable, enable]>
          name: <string>
          protocol: <value in [http, ftp, socks, ...]>
          srcaddr: <list or string>
          srcaddr6: <list or string>
          sso_auth_method: <string>
          status: <value in [disable, enable]>
          transaction_based: <value in [disable, enable]>
          web_auth_cookie: <value in [disable, enable]>
          web_portal: <value in [disable, enable]>
          dstaddr: <list or string>
          dstaddr6: <list or string>
          srcintf: <list or string>
          cors_depth: <integer>
          cors_stateful: <value in [disable, enable]>
          cert_auth_cookie: <value in [disable, enable]>

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

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_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)