W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_pkg_authentication_rule – Configure Authentication Rules.

Note

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

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 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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
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.
comments
string
Comment.
dstaddr
string
Select an IPv4 destination address from available options. Required for web proxy authentication.
dstaddr6
string
Select an IPv6 destination address from available options. Required for web proxy authentication.
ip-based
string
    Choices:
  • disable
  • enable
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from ...
name
string
Authentication rule name.
protocol
string
    Choices:
  • http
  • ftp
  • socks
  • ssh
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are ask...
srcaddr
string
Select an IPv4 source address from available options. Required for web proxy authentication.
srcaddr6
string
Select an IPv6 source address. Required for web proxy authentication.
srcintf
string
Incoming (ingress) interface.
sso-auth-method
string
Select a single-sign on (SSO) authentication method.
status
string
    Choices:
  • disable
  • enable
Enable/disable this authentication rule.
transaction-based
string
    Choices:
  • disable
  • enable
Enable/disable transaction based authentication (default = disable).
web-auth-cookie
string
    Choices:
  • disable
  • enable
Enable/disable Web authentication cookies (default = disable).
web-portal
string
    Choices:
  • disable
  • enable
Enable/disable web portal for proxy transparent policy (default = enable).
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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: Configure Authentication Rules.
     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: <value in [present, absent]>
        pkg_authentication_rule:
           active-auth-method: <value of string>
           comments: <value of string>
           ip-based: <value in [disable, enable]>
           name: <value of string>
           protocol: <value in [http, ftp, socks, ...]>
           srcaddr: <value of string>
           srcaddr6: <value of string>
           sso-auth-method: <value of 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: <value of string>
           dstaddr6: <value of string>
           srcintf: <value of string>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request
response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_pkg_authentication_rule_module.html