fortinet.fortios.fortios_system_password_policy module – Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared keys in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.7).
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.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_password_policy
.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and password_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared keys. |
|
Apply password policy to administrator passwords or IPsec pre-shared keys or both. Separate entries with a space. Choices:
|
|
Enable/disable changing at least 4 characters for a new password (This attribute overrides reuse-password if both are enabled). Choices:
|
|
Number of days after which passwords expire (1 - 999 days). |
|
Enable/disable password expiration. Choices:
|
|
Minimum number of unique characters in new password which do not exist in old password (0 - 128). |
|
Minimum number of lowercase characters in password (0 - 128). |
|
Minimum number of non-alphanumeric characters in password (0 - 128). |
|
Minimum number of numeric characters in password (0 - 128). |
|
Minimum number of uppercase characters in password (0 - 128). |
|
Minimum password length (8 - 128). |
|
Enable/disable reuse of password. If both reuse-password and min-change-characters are enabled, min-change-characters overrides. Choices:
|
|
Enable/disable setting a password policy for locally defined administrator passwords and IPsec VPN pre-shared keys. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared keys.
fortinet.fortios.fortios_system_password_policy:
vdom: "{{ vdom }}"
system_password_policy:
apply_to: "admin-password"
change_4_characters: "enable"
expire_day: "90"
expire_status: "enable"
min_change_characters: "0"
min_lower_case_letter: "0"
min_non_alphanumeric: "0"
min_number: "0"
min_upper_case_letter: "0"
minimum_length: "8"
reuse_password: "enable"
status: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)