alliedtelesis.awplus.awplus_user (1.2.2) — module

Manages user configuration of AlliedWare Plus devices

| "added in version" 2.10.4 of alliedtelesis.awplus"

Authors: Darryl Alang

preview | supported by network

Install collection

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


Add to requirements.yml

  collections:
    - name: alliedtelesis.awplus
      version: 1.2.2

Description

This module manages user configuration of AlliedWare Plus devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Using merged

# Before state:
# -------------
# aw1(config)#show running-config | include username
# username manager privilege 15 password 8 $1$bJoVec4D$F4gh6&bDsR4^8J8#1FhJyF

- name: Merge provided configuration with device configuration
  alliedtelesis.awplus.awlus_user:
    config:
      - name: guk
        configured_password: knj94
        privilege: 13
    state: merged
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# After state:
# ------------
# aw1(config)#show running-config | include username
# username manager privilege 15 password 8 $1$bJoVec4D$F4gh6&bDsR4^8J8#1FhJyF
# username guk privilege 13 password 8 $1$bJo84D$TR34MDYn4m!tE&LiF3g0ESoN


# Using replaced

# Before state:
# -------------
# aw1(config)#show running-config | include username
# username manager privilege 15 password 8 $1$bJoVec4D$F4gh6&bDsR4^8J8#1FhJyF
# username guk privilege 13 password 8 $1$bJo84D$TR34MDYn4m!tE&LiF3g0ESoN

- name: Replace device configuration with provided configuration
  alliedtelesis.awplus.awlus_user:
    config:
      - name: guk
        configured_password: cloud
    state: replaced
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# After state:
# ------------
# aw1(config)#show running-config | include username
# username manager privilege 15 password 8 $1$bJoVec4D$F4gh6&bDsR4^8J8#1FhJyF
# username guk privilege 1 password 8 $1$bJo84D$gKJggDF4GgfgFK2VfFS23F


# Using overridden

# Before state:
# -------------
# aw1(config)#show running-config | include username
# username manager privilege 15 password 8 $1$bJoVec4D$F4gh6&bDsR4^8J8#1FhJyF
# username guk privilege 13 password 8 $1$bJo84D$TR34MDYn4m!tE&LiF3g0ESoN
# username minnie privilege 1 password 8 $1$dV7v1SnV$Xh8G7IrfwMTIFdCHnpoFe.


- name: Override device configuration with provided configuration
  alliedtelesis.awplus.awlus_user:
    config:
      - name: manager
        configured_password: foobar
        privilege: 13
    state: overridden
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# After state:
# ------------
# aw1(config)#show running-config | include username
# username manager privilege 13 password 8 $1$bJoVec4D$MiCm!CbUnG3eF5ASftd2Rf


# Using Deleted without any config passed
#"(NOTE: This will delete all of configured resource module attributes from each configured user)"
# Before state:
# -------------
# aw1(config)#show running-config | include username
# username manager privilege 15 password 8 $1$bJoVec4D$F4gh6&bDsR4^8J8#1FhJyF
# username guk privilege 13 password 8 $1$bJo84D$TR34MDYn4m!tE&LiF3g0ESoN
# username minnie privilege 1 password 8 $1$dV7v1SnV$Xh8G7IrfwMTIFdCHnpoFe.

- name: Delete all users
  alliedtelesis.awplus.awplus_user:
    state: deleted

Inputs

    
state:
    choices:
    - merged
    - replaced
    - overridden
    - deleted
    default: merged
    description:
    - The state the configuration should be left in
    - Note that I(state=deleted) and I(state=overridden) will not delete the default user
      B(manager) or will create it if it does not exist.
    type: str

config:
    description: The provided configuration.
    elements: dict
    suboptions:
      configured_password:
        description:
        - The password that the user must enter when logging in. Can be up to 32 characters
          in length.
        - Mutually exclusive with I(hashed_password).
      hashed_password:
        description:
        - The password as a string that has already been encrypted.
        - Mutually exclusive with I(configured_password).
        type: str
      name:
        description:
        - "The login name for the user. Do not use punctuation marks such as single quotes\
          \ (\u2018 \u2018), double quotes (\u201C \u201C), or colons (:) with the user\
          \ login name."
        required: true
        type: str
      privilege:
        description:
        - "The user\u2019s privilege level. This argument accepts integer values in the\
          \ range of 1 to 15 with privilege level 15 having full access to all commands."
        type: int
    type: list

Outputs

after:
  description: The resulting configuration model invocation.
  returned: when changed
  sample: "The configuration returned will always be in the same format\n of the parameters\
    \ above.\n"
before:
  description: The configuration prior to the model invocation.
  returned: always
  sample: "The configuration returned will always be in the same format\n of the parameters\
    \ above.\n"
commands:
  description: The set of commands pushed to the remote device.
  returned: always
  sample:
  - username guk privilege 13 password knj94
  type: list