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.1.4).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_system_password_policy.

New in version 2.10: of fortinet.fortios

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.9.0

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • no ← (default)

  • yes

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • present

  • absent

system_password_policy

dictionary

Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared keys.

apply_to

list / elements=string

Apply password policy to administrator passwords or IPsec pre-shared keys or both. Separate entries with a space.

Choices:

  • admin-password

  • ipsec-preshared-key

change_4_characters

string

Enable/disable changing at least 4 characters for a new password (This attribute overrides reuse-password if both are enabled).

Choices:

  • enable

  • disable

expire_day

integer

Number of days after which passwords expire (1 - 999 days).

expire_status

string

Enable/disable password expiration.

Choices:

  • enable

  • disable

min_change_characters

integer

Minimum number of unique characters in new password which do not exist in old password (This attribute overrides reuse-password if both are enabled).

min_lower_case_letter

integer

Minimum number of lowercase characters in password (0 - 128).

min_non_alphanumeric

integer

Minimum number of non-alphanumeric characters in password (0 - 128).

min_number

integer

Minimum number of numeric characters in password (0 - 128).

min_upper_case_letter

integer

Minimum number of uppercase characters in password (0 - 128).

minimum_length

integer

Minimum password length (8 - 128).

reuse_password

string

Enable/disable reusing of password (if both reuse-password and change-4-characters are enabled, change-4-characters overrides).

Choices:

  • enable

  • disable

status

string

Enable/disable setting a password policy for locally defined administrator passwords and IPsec VPN pre-shared keys.

Choices:

  • enable

  • disable

vdom

string

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: “root”

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared keys.
    fortios_system_password_policy:
      vdom:  "{{ vdom }}"
      system_password_policy:
        apply_to: "admin-password"
        change_4_characters: "enable"
        expire_day: "5"
        expire_status: "enable"
        min_change_characters: "7"
        min_lower_case_letter: "8"
        min_non_alphanumeric: "9"
        min_number: "10"
        min_upper_case_letter: "11"
        minimum_length: "12"
        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

string

Build number of the fortigate image

Returned: always

Sample: “1547”

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: “PUT”

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: “200”

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: “id”

name

string

Name of the table used to fulfill the request

Returned: always

Sample: “urlfilter”

path

string

Path of the table used to fulfill the request

Returned: always

Sample: “webfilter”

revision

string

Internal revision number

Returned: always

Sample: “17.0.2.10658”

serial

string

Serial number of the unit

Returned: always

Sample: “FGVMEVYYQT3AB5352”

status

string

Indication of the operation’s result

Returned: always

Sample: “success”

vdom

string

Virtual domain used

Returned: always

Sample: “root”

version

string

Version of the FortiGate

Returned: always

Sample: “v5.6.3”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)