arubanetworks.aos_switch.arubaoss_tacacs_profile (1.7.0) — module

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 implements rest apis which can be used to configure TACACS Server

Usage examples

Scanned by Steampunk Spotter

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

- name: Creates tacacs-server host 10.1.1.1 with key Aruba!
  arubaoss_tacacs_profile:
    command: config_tacacs_server
    ip_address: 10.1.1.1
    auth_key: "Aruba!"
    is_oobm: true

Scanned by Steampunk Spotter

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

- name: Deletes tacacs-server host 10.1.1.1 with key Aruba!
  arubaoss_tacacs_profile:
    command: config_tacacs_server
    ip_address: 10.1.1.1
    auth_key: "Aruba!"
    config: delete

Scanned by Steampunk Spotter

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

- name: Creates global TACACS+ authentication key
  arubaoss_tacacs_profile:
    command: config_tacacs_profile
    global_auth_key: "Aruba!"

Scanned by Steampunk Spotter

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

- name: Configure global TACACS+ settings
  arubaoss_tacacs_profile:
    command: config_tacacs_profile
    global_auth_key: "Aruba!"
    dead_time: 60
    time_out: 10

Scanned by Steampunk Spotter

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

- name: Deletes Global TACACS+ settings
  arubaoss_tacacs_profile:
    command: config_tacacs_profile
    global_auth_key: ""

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

config:
    choices:
    - create
    - delete
    default: create
    description: To configure or unconfigure the required command.
    required: false

command:
    choices:
    - config_tacacs_profile
    - config_tacacs_server
    description: Function name calls according to configuration required. choice config_tacacs_server
      - Configure a TACACS+ server. choice config_tacacs_profile - Configure global TACACS+
      profile.
    required: true

is_oobm:
    default: false
    description: Use oobm interface to connect the server. Used with the config_tacacs_server
    required: false
    type: bool

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

auth_key:
    description: Configure the server authentication key. Used with the config_tacacs_server
      command.
    required: false
    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

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

time_out:
    default: 5
    description: TACACS server response timeout. Used with the config_tacacs_profile command.
    required: false
    type: int

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

dead_time:
    default: 0
    description: Dead time for unavailable TACACS+ servers. Used with the config_tacacs_profile
      command.
    required: false
    type: int

ip_address:
    description: TACACS Server IP Address. Used with the config_tacacs_server command.
    required: false
    type: str

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

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

      '
    type: bool

global_auth_key:
    description: Configure the default authentication key for all TACACS+ servers. Used
      with the config_tacacs_profile command. To delete, pass in empty string ''.
    required: false
    type: str

ordering_sequence:
    default: false
    description: Enables reordering upon deletion of existing server. Used with the config_tacacs_profile
      command.
    required: false
    type: bool