alliedtelesis.awplus.awplus_user (1.0.0) — module

Install collection

Install with ansible-galaxy collection install alliedtelesis.awplus:==1.0.0

Add to requirements.yml

  collections:
    - name: alliedtelesis.awplus
      version: 1.0.0

Description

This module provides declarative management of the local usernames configured on network devices. It allows playbooks to manage either individual usernames or the aggregate of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Inputs

    
name:
    description:
    - The username to be configured on the AlliedWare Plus device. This argument accepts
      a string value and is mutually exclusive with the C(aggregate) argument. Please
      note that this option is not same as C(provider username).

purge:
    default: false
    description:
    - Instructs the module to consider the resource definition absolute. It will remove
      any previously configured usernames on the device with the exception of the `admin`
      user (the current defined set of users).
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Configures the state of the username definition as it relates to the device operational
      configuration. When set to I(present), the username(s) should be configured in the
      device active configuration and when set to I(absent) the username(s) should not
      be in the device active configuration

aggregate:
    aliases:
    - users
    - collection
    description:
    - The set of username objects to be configured on the remote AlliedWare Plus device.
      The list entries can either be the username or a hash of username and properties.
      This argument is mutually exclusive with the C(name) argument.

privilege:
    description:
    - The C(privilege) argument configures the privilege level of the user when logged
      into the system. This argument accepts integer values in the range of 1 to 15.

hashed_password:
    description:
    - This option allows configuring hashed passwords on AlliedWare Plus device.
    suboptions:
      value:
        description:
        - The actual hashed password to be configured on the device
        required: true

configured_password:
    description:
    - The password to be configured on the AlliedWare Plus device. The password needs
      to be provided in clear and it will be encrypted on the device. Please note that
      this option is not same as C(provider password).

Outputs

commands:
  description: Show the commands sent.
  returned: always
  sample:
  - interface port1.0.5
  - static-channel-group 2 member-filters
  type: list