Steampunk Ansible Documentation - arubanetworks.aos_switch.arubaoss_user (1.7.0) - module - Implements Ansible module for configuring and managing user on device.

Install collection

Install with ansible-galaxy collection install arubanetworks.aos_switch:==1.7.0

Add to requirements.yml

  collections:
    - name: arubanetworks.aos_switch
      version: 1.7.0

Description

This implement rest api's which can be use to manage and configure user on the device. Can configure only operator role via REST

Usage examples

Scanned by Steampunk Spotter

      - name: configure user
        arubaoss_user:
          user_name:  test_user
          user_password: test_user
          user_type: UT_OPERATOR
          password_type: PET_PLAIN_TEXT

Scanned by Steampunk Spotter

      - name: delete user
        arubaoss_user:
          user_name:  test_user
          user_password: test_user
          user_type: UT_OPERATOR
          password_type: PET_PLAIN_TEXT
          state: delete

Scanned by Steampunk Spotter

      - name: configure user sha1
        arubaoss_user:
          user_name: test_user
          user_password: F0347CE3A03A3BA71F596438A2B80DD21C9AF71B
          user_type: UT_OPERATOR
          password_type: PET_SHA1

Inputs

host:
description: 'Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as the destination
address for the transport.

'
type: str

port:
description: 'Specifies the port to use when building the connection to the remote
device.

'
type: int

state:
choices:
- create
- delete
default: create
description:
- Enable or disable
required: false

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

use_ssl:
description: 'Configures use SSL (HTTPS) for access to the remote device.

'
type: bool

password:
description: 'Specifies the password to use to authenticate the connection to the
remote device. This value is used to authenticate the SSH session. If the value
is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD
will be used instead.

'
type: str

provider:
description: A dict object containing connection details.
suboptions:
api_version:
default: None
description: 'Configures (force) API version (vX.Y) for acces to the remote device.

'
type: str
host:
description: 'Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as the destination
address for the transport.

'
type: str
password:
description: 'Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the SSH session. If the
value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD
will be used instead.

'
type: str
port:
description: 'Specifies the port to use when building the connection to the remote
device.

'
type: int
ssh_keyfile:
description: 'Specifies the SSH key to use to authenticate the connection to the
remote device. This value is the path to the key used to authenticate the SSH
session. If the value is not specified in the task, the value of environment
variable ANSIBLE_NET_SSH_KEYFILE will be used instead.

'
type: path
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:
default: aossapi
description: 'Configures the transport (aossapi or network_cli) mode.

'
type: str
use_proxy:
default: false
description: 'Configures use (Local) Proxy for access to the remote device.

'
type: bool
use_ssl:
description: 'Configures use SSL (HTTPS) for access to the remote device.

'
type: bool
username:
description: 'Configures the username to use to authenticate the connection to
the remote device. This value is used to authenticate the SSH session. If the
value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME
will be used instead.

'
type: str
validate_certs:
default: false
description: 'Configures validation of certification for access to the remote
device.

'
type: bool
type: dict

username:
description: 'Configures the username to use to authenticate the connection to the
remote device. This value is used to authenticate the SSH session. If the value
is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME
will be used instead.

'
type: str

user_name:
description:
- user_name that needs to be configured.
required: true

user_type:
choices:
- UT_OPERATOR
- UT_MANAGER
default: UT_OPERATOR
description:
- Type of user being configured.
required: true

api_version:
default: None
description: 'Configures (force) API version (vX.Y) for acces to the remote device.

'
type: str

ssh_keyfile:
description: 'Specifies the SSH key to use to authenticate the connection to the remote
device. This value is the path to the key used to authenticate the SSH session.
If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE
will be used instead.

'
type: path

password_type:
choices:
- PET_PLAIN_TEXT
- PET_SHA1
default: PET_PLAIN_TEXT
description:
- type of password being conifgured
required: true

user_password:
description:
- user password in plain text or sha1
required: true

validate_certs:
default: false
description: 'Configures validation of certification for access to the remote device.

'
type: bool