fmgr_authentication_scheme – Configure Authentication Schemes.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
|
authentication_scheme | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- authentication_scheme - Configure Authentication Schemes. type: dict
- domain-controller - Domain controller setting. type: str more...
- fsso-agent-for-ntlm - FSSO agent to use for NTLM authentication. type: str more...
- fsso-guest - Enable/disable user fsso-guest authentication (default = disable). type: str choices: [disable, enable] more...
- kerberos-keytab - Kerberos keytab setting. type: str more...
- method - No description for the parameter type: array choices: [ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, saml, cert, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, saml, cert, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, saml, cert, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, saml, cert, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, saml, cert, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, saml, cert, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, saml, cert, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, ntlm, basic, digest, form, negotiate, fsso, rsso, ssh-publickey, saml, cert] more...
- name - Authentication scheme name. type: str more...
- negotiate-ntlm - Enable/disable negotiate authentication for NTLM (default = disable). type: str choices: [disable, enable] more...
- require-tfa - Enable/disable two-factor authentication (default = disable). type: str choices: [disable, enable] more...
- ssh-ca - SSH CA name. type: str more...
- user-database - Authentication server to contain user information; "local" (default) or "123" (for LDAP). type: str more...
- ems-device-owner - Enable/disable SSH public-key authentication with device owner (default = disable). type: str choices: [disable, enable] more...
- saml-server - SAML configuration. type: str more...
- saml-timeout - SAML authentication timeout in seconds. type: int more...
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 Schemes.
fmgr_authentication_scheme:
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>
state: <value in [present, absent]>
authentication_scheme:
domain-controller: <value of string>
fsso-agent-for-ntlm: <value of string>
fsso-guest: <value in [disable, enable]>
kerberos-keytab: <value of string>
method:
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- saml
- cert
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- saml
- cert
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- saml
- cert
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- saml
- cert
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- saml
- cert
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- saml
- cert
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- saml
- cert
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- ntlm
- basic
- digest
- form
- negotiate
- fsso
- rsso
- ssh-publickey
- saml
- cert
name: <value of string>
negotiate-ntlm: <value in [disable, enable]>
require-tfa: <value in [disable, enable]>
ssh-ca: <value of string>
user-database: <value of string>
ems-device-owner: <value in [disable, enable]>
saml-server: <value of string>
saml-timeout: <value of integer>
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict