fortinet.fortios.fortios_system_password_policy – Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared keys in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 1.1.8).

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.9: 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		Choices/Defaults	Comments
access_token string			Token-based authentication. Generated from GUI of Fortigate.
system_password_policy dictionary			Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared keys.
	apply_to string	Choices: admin-password ipsec-preshared-key	Apply password policy to administrator passwords or IPsec pre-shared keys or both. Separate entries with a space.
	change_4_characters string	Choices: enable disable	Enable/disable changing at least 4 characters for a new password (This attribute overrides reuse-password if both are enabled).
	expire_day integer		Number of days after which passwords expire (1 - 999 days).
	expire_status string	Choices: enable disable	Enable/disable password expiration.
	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	Choices: enable disable	Enable/disable reusing of password (if both reuse-password and change-4-characters are enabled, change-4-characters overrides).
	status string	Choices: enable disable	Enable/disable setting a password policy for locally defined administrator passwords and IPsec VPN pre-shared keys.
vdom string		Default: "root"	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.

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_lower_case_letter: "7"
        min_non_alphanumeric: "8"
        min_number: "9"
        min_upper_case_letter: "10"
        minimum_length: "11"
        reuse_password: "enable"
        status: "enable"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
build string	always	Build number of the fortigate image Sample: 1547
http_method string	always	Last method used to provision the content into FortiGate Sample: PUT
http_status string	always	Last result given by FortiGate on last operation applied Sample: 200
mkey string	success	Master key (id) used in the last call to FortiGate Sample: id
name string	always	Name of the table used to fulfill the request Sample: urlfilter
path string	always	Path of the table used to fulfill the request Sample: webfilter
revision string	always	Internal revision number Sample: 17.0.2.10658
serial string	always	Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string	always	Indication of the operation's result Sample: success
vdom string	always	Virtual domain used Sample: root
version string	always	Version of the FortiGate 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)