Try SpotterConfigure local users in Fortinet's FortiOS and FortiGate.
| "added in version" 2.9 of ansible.builtin"
Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
pipInstall with pip install ansible==2.9.27
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and local category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure local users.
fortios_user_local:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
user_local:
auth_concurrent_override: "enable"
auth_concurrent_value: "4"
authtimeout: "5"
email_to: "<your_own_value>"
fortitoken: "<your_own_value> (source user.fortitoken.serial-number)"
id: "8"
ldap_server: "<your_own_value> (source user.ldap.name)"
name: "default_name_10"
passwd: "<your_own_value>"
passwd_policy: "<your_own_value> (source user.password-policy.name)"
passwd_time: "<your_own_value>"
ppk_identity: "<your_own_value>"
ppk_secret: "<your_own_value>"
radius_server: "<your_own_value> (source user.radius.name)"
sms_custom_server: "<your_own_value> (source system.sms-server.name)"
sms_phone: "<your_own_value>"
sms_server: "fortiguard"
status: "enable"
two_factor: "disable"
type: "password"
workstation: "<your_own_value>"
host:
description:
- FortiOS or FortiGate IP address.
required: false
type: str
vdom:
default: root
description:
- Virtual domain, among those defined previously. A vdom is a virtual instance of
the FortiGate that can be configured and used as a different unit.
type: str
https:
default: true
description:
- Indicates if the requests towards FortiGate must use HTTPS protocol.
type: bool
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
password:
default: ''
description:
- FortiOS or FortiGate password.
type: str
username:
description:
- FortiOS or FortiGate username.
required: false
type: str
ssl_verify:
default: true
description:
- Ensures FortiGate certificate must be verified by a proper CA.
type: bool
user_local:
default: null
description:
- Configure local users.
suboptions:
auth_concurrent_override:
choices:
- enable
- disable
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 recipient's email address.
type: str
fortitoken:
description:
- Two-factor recipient's FortiToken serial number. Source user.fortitoken.serial-number.
type: str
id:
description:
- User ID.
type: int
ldap_server:
description:
- Name of LDAP server with which the user must authenticate. Source user.ldap.name.
type: str
name:
description:
- User name.
required: true
type: str
passwd:
description:
- User's password.
type: str
passwd_policy:
description:
- Password policy to apply to this user, as defined in config user password-policy.
Source user.password-policy.name.
type: str
passwd_time:
description:
- Time of the last password update.
type: str
ppk_identity:
description:
- IKEv2 Postquantum Preshared Key Identity.
type: str
ppk_secret:
description:
- IKEv2 Postquantum Preshared Key (ASCII string or hexadecimal encoded with a
leading 0x).
type: str
radius_server:
description:
- Name of RADIUS server with which the user must authenticate. Source user.radius.name.
type: str
sms_custom_server:
description:
- Two-factor recipient's SMS server. Source system.sms-server.name.
type: str
sms_phone:
description:
- Two-factor recipient's mobile phone number.
type: str
sms_server:
choices:
- fortiguard
- custom
description:
- Send SMS through FortiGuard or other external server.
type: str
status:
choices:
- enable
- disable
description:
- Enable/disable allowing the local user to authenticate with the FortiGate unit.
type: str
two_factor:
choices:
- disable
- fortitoken
- email
- sms
description:
- Enable/disable two-factor authentication.
type: str
type:
choices:
- password
- radius
- tacacs+
- ldap
description:
- Authentication method.
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
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str