arubanetworks.aoscx.aoscx (4.3.2) — connection

Install collection

Install with ansible-galaxy collection install arubanetworks.aoscx:==4.3.2

Add to requirements.yml

  collections:
    - name: arubanetworks.aoscx
      version: 4.3.2

Description

This connection plugin provides a REST API connection to AOS-CX switches.

Inputs

    
host:
    default: inventory_hostname
    description: 'Specifies the remote device FQDN or IP address to establish the connection
      to.

      '
    vars:
    - name: ansible_host

port:
    description: 'Specifies the port on the remote device that listens for connections
      when establishing the connection. SSL is always used.

      '
    env:
    - name: ANSIBLE_REMOTE_PORT
    ini:
    - key: remote_port
      section: defaults
    type: int
    vars:
    - name: ansible_aoscx_port

password:
    description: 'Configures the user password used to authenticate to the remote device
      when needed for the device API.

      '
    vars:
    - name: ansible_password
    - name: ansible_aoscx_pass
    - name: ansible_aoscx_password

use_proxy:
    default: true
    description: Whether to use https_proxy for requests.
    type: boolean
    vars:
    - name: ansible_aoscx_use_proxy

network_os:
    description: 'Configures the device platform network operating system. This value
      is used to load the correct plugin to communicate with the remote device.

      '
    vars:
    - name: ansible_network_os

remote_user:
    description: 'The username used to authenticate to the remote device when the API
      connection is first established. If the remote_user is not specified, the connection
      will use the username of the logged in user. Can be configured from the CLI via
      the C(--user) or C(-u) options.

      '
    env:
    - name: ANSIBLE_REMOTE_USER
    ini:
    - key: remote_user
      section: defaults
    vars:
    - name: ansible_user

rest_version:
    default: '10.04'
    description: 'Configures REST version, default version is 10.04, but 10.08 or 10.09
      can be used in a specific host or globaly if it is set as an environment variable.

      '
    env:
    - name: ANSIBLE_AOSCX_REST_VERSION
    type: string
    vars:
    - name: ansible_aoscx_rest_version

validate_certs:
    default: true
    description: Whether to validate SSL certificates.
    type: boolean
    vars:
    - name: ansible_aoscx_validate_certs

persistent_log_messages:
    default: false
    description: 'This flag will enable logging the command executed and response received
      from target device in the ansible log file. For this option to work ''log_path''
      ansible configuration option is required to be set to a file path with write access.
      Be sure to fully understand the security implications of enabling this option as
      it could create a security vulnerability by logging sensitive information in log
      file.

      '
    env:
    - name: ANSIBLE_PERSISTENT_LOG_MESSAGES
    ini:
    - key: log_messages
      section: persistent_connection
    type: boolean
    vars:
    - name: ansible_persistent_log_messages

persistent_command_timeout:
    default: 30
    description: 'Configures, in seconds, the amount of time to wait for a command to
      return from the remote device. If this timer is exceeded before the command returns,
      the connection plugin will raise an exception and close.

      '
    env:
    - name: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT
    ini:
    - key: command_timeout
      section: persistent_connection
    type: int
    vars:
    - name: ansible_command_timeout

persistent_connect_timeout:
    default: 30
    description: 'Configures, in seconds, the amount of time to wait when trying to initially
      establish a persistent connection. If this value expires before the connection to
      the remote device is completed, the connection will fail.

      '
    env:
    - name: ANSIBLE_PERSISTENT_CONNECT_TIMEOUT
    ini:
    - key: connect_timeout
      section: persistent_connection
    type: int
    vars:
    - name: ansible_connect_timeout