Skip to content

Latest commit

 

History

History
351 lines (307 loc) · 15.4 KB

fortios_user_password_policy.rst

File metadata and controls

351 lines (307 loc) · 15.4 KB
Raw
source:fortios_user_password_policy.py
orphan:

fortios_user_password_policy -- Configure user password policy in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user 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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_user_password_policy v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • user_password_policy - Configure user password policy. type: dict more...
    Supported Version Ranges
    user_password_policy v6.0.0 -> latest
    • expire_days - Time in days before the user"s password expires. type: int more...
      Supported Version Ranges
      expire_days v6.0.0 -> latest
    • expire_status - Enable/disable password expiration. type: str choices: enable, disable more...
      Supported Version Ranges
      expire_status v7.4.1 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • expired_password_renewal - Enable/disable renewal of a password that already is expired. type: str choices: enable, disable more...
      Supported Version Ranges
      expired_password_renewal v6.2.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • min_change_characters - Minimum number of unique characters in new password which do not exist in old password (0 - 128). type: int more...
      Supported Version Ranges
      min_change_characters v7.4.1 -> latest
    • min_lower_case_letter - Minimum number of lowercase characters in password (0 - 128). type: int more...
      Supported Version Ranges
      min_lower_case_letter v7.4.1 -> latest
    • min_non_alphanumeric - Minimum number of non-alphanumeric characters in password (0 - 128). type: int more...
      Supported Version Ranges
      min_non_alphanumeric v7.4.1 -> latest
    • min_number - Minimum number of numeric characters in password (0 - 128). type: int more...
      Supported Version Ranges
      min_number v7.4.1 -> latest
    • min_upper_case_letter - Minimum number of uppercase characters in password (0 - 128). type: int more...
      Supported Version Ranges
      min_upper_case_letter v7.4.1 -> latest
    • minimum_length - Minimum password length (8 - 128). type: int more...
      Supported Version Ranges
      minimum_length v7.4.1 -> latest
    • name - Password policy name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • reuse_password - Enable/disable reuse of password. If both reuse-password and min-change-characters are enabled, min-change-characters overrides. type: str choices: enable, disable more...
      Supported Version Ranges
      reuse_password v7.4.1 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • warn_days - Time in days before a password expiration warning message is displayed to the user upon login. type: int more...
      Supported Version Ranges
      warn_days v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure user password policy.
  fortinet.fortios.fortios_user_password_policy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_password_policy:
          expire_days: "180"
          expire_status: "enable"
          expired_password_renewal: "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"
          name: "default_name_12"
          reuse_password: "enable"
          warn_days: "15"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.