- source
fmgr_user_local.py
- orphan
2.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- 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.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> latest
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- adom - The parameter in requested url type: str required: true
- user_local - Configure local users. type: dict
- auth_concurrent_override (Alias name: auth-concurrent-override) Enable/disable overriding the policy-auth-concurrent under config system global. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- auth_concurrent_value (Alias name: auth-concurrent-value) Maximum number of concurrent logins permitted from the same user. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- authtimeout Time in minutes before the authentication timeout for a user is reached. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- email_to (Alias name: email-to) Two-factor recipients email address. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- fortitoken Two-factor recipients fortitoken serial number. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- id User id. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- ldap_server (Alias name: ldap-server) Name of ldap server with which the user must authenticate. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- name User name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- passwd Users password. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- passwd_policy (Alias name: passwd-policy) Password policy to apply to this user, as defined in config user password-policy. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ppk_identity (Alias name: ppk-identity) Ikev2 postquantum preshared key identity. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ppk_secret (Alias name: ppk-secret) Ikev2 postquantum preshared key (ascii string or hexadecimal encoded with a leading 0x). type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- radius_server (Alias name: radius-server) Name of radius server with which the user must authenticate. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- sms_custom_server (Alias name: sms-custom-server) Two-factor recipients sms server. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- sms_phone (Alias name: sms-phone) Two-factor recipients mobile phone number. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- sms_server (Alias name: sms-server) Send sms through fortiguard or other external server. type: str choices: [fortiguard, custom]
more...
Supported Version Ranges:
v6.0.0 -> latest
- status Enable/disable allowing the local user to authenticate with the fortigate unit. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- tacacs__server (Alias name: tacacs+-server) Name of tacacs+ server with which the user must authenticate. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- two_factor (Alias name: two-factor) Enable/disable two-factor authentication. type: str choices: [disable, fortitoken, email, sms, fortitoken-cloud]
more...
Supported Version Ranges:
v6.0.0 -> latest
- type Authentication method. type: str choices: [password, radius, tacacs+, ldap]
more...
Supported Version Ranges:
v6.0.0 -> latest
- workstation Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- two_factor_authentication (Alias name: two-factor-authentication) Authentication method by fortitoken cloud. type: str choices: [fortitoken, email, sms]
more...
Supported Version Ranges:
v6.2.5 -> latest
- two_factor_notification (Alias name: two-factor-notification) Notification method for user activation by fortitoken cloud. type: str choices: [email, sms]
more...
Supported Version Ranges:
v6.2.5 -> latest
- username_case_sensitivity (Alias name: username-case-sensitivity) Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as distinct or equivalent). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.5 -> v6.2.12
,v6.4.1 -> latest
- username_case_insensitivity (Alias name: username-case-insensitivity) Enable/disable case sensitivity when performing username matching (uppercase and lowercase letters are treated either as distinct or equivalent). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.0 -> latest
- username_sensitivity (Alias name: username-sensitivity) Enable/disable case and accent sensitivity when performing username matching (accents are stripped and case is ignored when disabled). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.9 -> v6.2.12
,v6.4.7 -> v6.4.14
,v7.0.1 -> latest
- history0 type: list
more...
Supported Version Ranges:
v7.4.1 -> latest
- history1 type: list
more...
Supported Version Ranges:
v7.4.1 -> latest
- qkd_profile (Alias name: qkd-profile) Quantum key distribution (qkd) profile. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest
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
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure local users.
fortinet.fortimanager.fmgr_user_local:
bypass_validation: false
adom: ansible
state: present
user_local:
id: 1
name: ansible-test-local
passwd: fortinet
status: disable
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the local users
fortinet.fortimanager.fmgr_fact:
facts:
selector: "user_local"
params:
adom: "ansible"
local: "your_value"
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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)