Documentation

aos_login - Login to AOS server for session token

New in version 2.3.

Synopsis

  • Obtain the AOS server session token by providing the required username and password credentials. Upon successful authentication, this module will return the session-token that is required by all subsequent AOS module usage. On success the module will automatically populate ansible facts with the variable aos_session This module is not idempotent and do not support check mode.

Options

parameter required default choices comments
passwd
no admin
Password to use when connecting to the AOS server.
port
no 8888
Port number to use when connecting to the AOS server.
server
yes
Address of the AOS Server on which you want to open a connection.
user
no admin
Login username to use when connecting to the AOS server.

Examples

- name: Create a session with the AOS-server
  aos_login:
    server: "{{ inventory_hostname }}"
    user: admin
    passwd: admin

- name: Use the newly created session (register is not mandatory)
  aos_ip_pool:
    session: "{{ aos_session }}"
    name: my_ip_pool
    state: present

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.