fortinet.fortimanager.fmgr_user_passwordpolicy 模块 – 配置用户密码策略。

注意

此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_user_passwordpolicy。

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，这些参数和值在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选择

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务的日志记录。

选择

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=integer

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / elements=integer

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

用于创建、更新或删除对象的指令。

选择

  • "present"

  • "absent"

user_passwordpolicy

字典

顶级参数集。

expire_days

别名：expire-days

整数

用户密码到期前的天数。

expire_status

别名：expire-status

字符串

启用/禁用密码过期。

选择

  • "disable"

  • "enable"

expired_password_renewal

别名：expired-password-renewal

字符串

启用/禁用续订已过期的密码。

选择

  • "disable"

  • "enable"

min_change_characters

别名：min-change-characters

整数

新密码中不包含在旧密码中的唯一字符的最小数量

min_lower_case_letter

别名：min-lower-case-letter

整数

密码中小写字符的最小数量

min_non_alphanumeric

别名：min-non-alphanumeric

整数

密码中非字母数字字符的最小数量

min_number

别名：min-number

整数

密码中数字字符的最小数量

min_upper_case_letter

别名：min-upper-case-letter

整数

密码中大写字符的最小数量

minimum_length

别名：minimum-length

整数

最小密码长度

name

字符串 / 必需

密码策略名称。

reuse_password

别名：reuse-password

字符串

启用/禁用密码重用。

选择

  • "disable"

  • "enable"

reuse_password_limit

别名：reuse-password-limit

整数

密码可以重用的次数

warn_days

别名：warn-days

整数

在密码到期警告消息在用户登录时显示给用户之前的天数。

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 adom，该值可以是 global 和其他包括 root 的值。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间（秒）。

默认值： 300

备注

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case) 命名。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您将收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此项工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 rc 时，运行模块可能会失败。 您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure user password policy.
      fortinet.fortimanager.fmgr_user_passwordpolicy:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        user_passwordpolicy:
          expire_days: <integer>
          name: <string>
          warn_days: <integer>
          expired_password_renewal: <value in [disable, enable]>
          expire_status: <value in [disable, enable]>
          min_change_characters: <integer>
          min_lower_case_letter: <integer>
          min_non_alphanumeric: <integer>
          min_number: <integer>
          min_upper_case_letter: <integer>
          minimum_length: <integer>
          reuse_password: <value in [disable, enable]>
          reuse_password_limit: <integer>

返回值

常用的返回值已在此处记录 此处，以下是此模块独有的字段

键

描述

元数据

字典

请求的结果。

返回: 始终

request_url

字符串

请求的完整 URL。

返回: 始终

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 始终

示例: 0

response_data

列表 / 元素=字符串

API 响应。

返回: 始终

response_message

字符串

API 响应的描述性消息。

返回: 始终

示例: "OK."

system_information

字典

目标系统的信息。

返回: 始终

rc

整数

请求的状态。

返回: 始终

示例: 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)