drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_user_local Configure local users. | "added in version" 2.0.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 communitydrmofu.fortimanager.fmgr_user_local (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- name: gathering fortimanager facts hosts: fortimanager00 gather_facts: no connection: httpapi collections: - fortinet.fortimanager vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: retrieve all the local users fmgr_fact: facts: selector: 'user_local' params: adom: 'ansible' local: 'your_value'
- hosts: fortimanager00 collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configure local users. fmgr_user_local: bypass_validation: False adom: ansible state: present user_local: id: 1 name: ansible-test-local passwd: fortinet status: disable
adom: description: the parameter (adom) 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 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 user_local: description: the top level parameters set required: false suboptions: auth-concurrent-override: choices: - disable - enable description: Enable/disable overriding the policy-auth-concurrent under config system global. type: str auth-concurrent-value: description: Maximum number of concurrent logins permitted from the same user. type: int authtimeout: description: Time in minutes before the authentication timeout for a user is reached. type: int email-to: description: Two-factor recipients email address. type: str fortitoken: description: Two-factor recipients FortiToken serial number. type: str id: description: User ID. type: int ldap-server: description: Name of LDAP server with which the user must authenticate. type: str name: description: User name. type: str passwd: description: Users password. type: str passwd-policy: description: Password policy to apply to this user, as defined in config user password-policy. type: str ppk-identity: description: IKEv2 Postquantum Preshared Key Identity. type: str ppk-secret: description: IKEv2 Postquantum Preshared Key type: str radius-server: description: Name of RADIUS server with which the user must authenticate. type: str sms-custom-server: description: Two-factor recipients SMS server. type: str sms-phone: description: Two-factor recipients mobile phone number. type: str sms-server: choices: - fortiguard - custom description: Send SMS through FortiGuard or other external server. type: str status: choices: - disable - enable description: Enable/disable allowing the local user to authenticate with the FortiGate unit. type: str tacacs+-server: description: Name of TACACS+ server with which the user must authenticate. type: str two-factor: choices: - disable - fortitoken - email - sms - fortitoken-cloud description: Enable/disable two-factor authentication. type: str two-factor-authentication: choices: - fortitoken - email - sms description: Authentication method by FortiToken Cloud. type: str two-factor-notification: choices: - email - sms description: Notification method for user activation by FortiToken Cloud. type: str type: choices: - password - radius - tacacs+ - ldap description: Authentication method. type: str username-case-insensitivity: choices: - disable - enable description: Enable/disable case sensitivity when performing username matching type: str username-case-sensitivity: choices: - disable - enable description: Enable/disable case sensitivity when performing username matching type: str username-sensitivity: choices: - disable - enable description: Enable/disable case and accent sensitivity when performing username matching type: str workstation: description: Name of the remote user workstation, if you want to limit the user to authenticate only from a particular workstation. type: str type: dict 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
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