f5networks.f5_modules.bigip_password_policy (1.28.0) — module

Manages the authentication password policy on a BIG-IP

| "added in version" 1.0.0 of f5networks.f5_modules"

Authors: Tim Rupp (@caphrim007)

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0


Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

Manages the authentication password policy on a BIG-IP device.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Change password policy to require 2 numeric characters
  bigip_password_policy:
    required_numeric: 2
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

    
provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      no_f5_teem:
        default: false
        description:
        - If C(yes), TEEM telemetry data is not sent to F5.
        - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
        - Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
        type: bool
      password:
        aliases:
        - pass
        - pwd
        description:
        - The password for the user account used to connect to the BIG-IP or the BIG-IQ.
        - You may omit this option by setting the environment variable C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host or the BIG-IQ host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      timeout:
        description:
        - Specifies the timeout in seconds for communicating with the network device for
          either connecting or sending commands.  If the timeout is exceeded before the
          operation is completed, the module will error.
        type: int
      transport:
        choices:
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
          privileges on the device.
        - You may omit this option by setting the environment variable C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(no), SSL certificates are not validated. Use this only on personally controlled
          sites using self-signed certificates.
        - You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: 1.0.0
    version_added_collection: f5networks.f5_modules

min_length:
    description:
    - Specifies the minimum number of characters in a valid password.
    - This value must be between 6 and 255.
    type: int

max_duration:
    description:
    - Specifies the maximum number of days a password is valid.
    type: int

min_duration:
    description:
    - Specifies the minimum number of days a password is valid.
    type: int

password_memory:
    description:
    - Specifies whether the user has configured the BIG-IP system to remember a password
      on a specific computer and how many passwords to remember.
    type: int

required_numeric:
    description:
    - Specifies the number of numeric characters that must be present in a password for
      the password to be valid.
    type: int

required_special:
    description:
    - Specifies the number of special characters that must be present in a password for
      the password to be valid.
    type: int

expiration_warning:
    description:
    - Specifies the number of days before a password expires.
    - This value determines when the BIG-IP system automatically warns users their password
      is about to expire.
    type: int

max_login_failures:
    description:
    - Specifies the number of consecutive unsuccessful login attempts the system allows
      before locking out the user.
    - Specify zero (0) to disable this parameter.
    type: int

policy_enforcement:
    description:
    - Enables or disables the password policy on the BIG-IP system.
    type: bool

required_lowercase:
    description:
    - Specifies the number of lowercase alpha characters that must be present in a password
      for the password to be valid.
    type: int

required_uppercase:
    description:
    - Specifies the number of uppercase alpha characters that must be present in a password
      for the password to be valid.
    type: int

Outputs

expiration_warning:
  description: The new expiration warning.
  returned: changed
  sample: 7
  type: int
max_duration:
  description: The new max duration.
  returned: changed
  sample: 99999
  type: int
max_login_failures:
  description: The new max login failures.
  returned: changed
  sample: 0
  type: int
min_duration:
  description: The new minimum duration.
  returned: changed
  sample: 0
  type: int
min_length:
  description: The new minimum password length.
  returned: changed
  sample: 6
  type: int
password_memory:
  description: The new number of remembered passwords
  returned: changed
  sample: 0
  type: int
policy_enforcement:
  description: The new policy enforcement setting.
  returned: changed
  sample: true
  type: bool
required_lowercase:
  description: The lowercase requirement.
  returned: changed
  sample: 1
  type: int
required_numeric:
  description: The numeric requirement.
  returned: changed
  sample: 2
  type: int
required_special:
  description: The special character requirement.
  returned: changed
  sample: 1
  type: int
required_uppercase:
  description: The uppercase character requirement.
  returned: changed
  sample: 1
  type: int