sachaboudjema.arubaos.arubaos_config (0.1.2) — module

Queries full or partial configuration of a particular configuration node

| "added in version" 2.9.6 of sachaboudjema.arubaos"

Authors: Sacha Boudjema (@sachaboudjema)

preview | supported by community

Install collection

Install with ansible-galaxy collection install sachaboudjema.arubaos:==0.1.2


Add to requirements.yml

  collections:
    - name: sachaboudjema.arubaos
      version: 0.1.2

Description

Queries full or partial configuration of a particular configuration node.

Inputs

    
host:
    description:
    - Hostname or IP Address of the controller.
    - If not set the environment variable C(ANSIBLE_ARUBAOS_HOST) will be used.
    required: true
    type: str

type:
    choices:
    - pending
    - committed
    - local
    - committed,local
    default: None
    description:
    - State of configuration blocks to be retrieved.
    - If the user deletes any configuration which is pending, it is not returned in this
      API call.
    - Only added or modified configurations are retrieved. To get deleted configuration,
      use the 'show configuration pending' command.
    required: false
    type: str

password:
    description:
    - Password used to login to the controller.
    - If not set the environment variable C(ANSIBLE_ARUBAOS_PASSWORD) will be used.
    no_log: true
    required: true
    type: str

username:
    description:
    - Username used to login to the controller.
    - If not set the environment variable C(ANSIBLE_ARUBAOS_USERNAME) will be used.
    required: true
    type: str

client_key:
    default: None
    description:
    - If the client_cert did not have the key, use this parameter. Default option is None.
    required: false
    type: str

client_cert:
    default: None
    description:
    - Set the file path for client certificate validation from server side. Default option
      is None.
    required: false
    type: str

config_path:
    default: None
    description:
    - The hierarchy (complete config-node or config-path) from which the information should
      be retrieved.
    - On a managed device this will be restricted to /mm/mynode.
    - On a stand-alone controller, this will be restricted to /mm and /mm/mynode.
    required: false
    type: str

validate_certs:
    default: None
    description:
    - Set to True to validate server SSL certificate upon HTTPS connection. Default option
      is false.
    required: false
    type: str

Outputs

response:
  description: Effective configuration of the specified node.
  returned: always
  type: dict

See also