fortinet.fortianalyzer.faz_cli_system_passwordpolicy (1.4.0) — module

Password policy.

| "added in version" 1.0.0 of fortinet.fortianalyzer"

Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortianalyzer:==1.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortianalyzer
      version: 1.4.0

Description

This module is able to configure a FortiAnalyzer device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Example playbook
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: Password policy.
      fortinet.fortianalyzer.faz_cli_system_passwordpolicy:
        cli_system_passwordpolicy:
          # change_4_characters: disable
          # expire: <value of integer>
          # minimum_length: <value of integer>
          must_contain:
            - upper-case-letter
            - lower-case-letter
            - number
            - non-alphanumeric
          status: disable
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

Inputs

    
log_path:
    default: /tmp/fortianalyzer.ansible.log
    description:
    - The path to save log. Used if enable_log is true.
    - Please use absolute path instead of relative path.
    - If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log
    required: false
    type: str

rc_failed:
    description: the rc codes list with which the conditions to fail will be overriden
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: the rc codes list with which the conditions to succeed will be overriden
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - set
    - update
    - add
    description: The overridden method for the underlying Json RPC request
    required: false
    type: str

bypass_validation:
    default: false
    description: only set to True when module schema diffs with FortiAnalyzer API structure,
      module continues to execute without validating parameters
    required: false
    type: bool

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

cli_system_passwordpolicy:
    description: The top level parameters set.
    required: false
    suboptions:
      change-4-characters:
        choices:
        - disable
        - enable
        description:
        - Enable/disable changing at least 4 characters for new password.
        - disable - Disable changing at least 4 characters for new password.
        - enable - Enable changing at least 4 characters for new password.
        type: str
      expire:
        description: Number of days after which admin users password will expire (0 -
          3650, 0 = never expire).
        type: int
      minimum-length:
        description: Minimum password length.
        type: int
      must-contain:
        choices:
        - upper-case-letter
        - lower-case-letter
        - number
        - non-alphanumeric
        description: no description
        elements: str
        type: list
      status:
        choices:
        - disable
        - enable
        description:
        - Enable/disable password policy.
        - disable - Disable password policy.
        - enable - Enable password policy.
        type: str
    type: dict

Outputs

meta:
  contains:
    request_url:
      description: The full url requested
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current fortianalyzer version.
  returned: complex
  type: list