Documentation

aos_login – Login to AOS server for session token

New in version 2.3.

DEPRECATED

Removed in Ansible:
 version: 2.9
Why:This module does not support AOS 2.1 or later
Alternative:See new modules at https://www.ansible.com/ansible-apstra.

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.

Requirements

The below requirements are needed on the host that executes this module.

  • aos-pyez >= 0.6.1

Parameters

Parameter Choices/Defaults Comments
passwd
-
Default:
"admin"
Password to use when connecting to the AOS server.
port
-
Default:
443
Port number to use when connecting to the AOS server.
server
- / required
Address of the AOS Server on which you want to open a connection.
user
-
Default:
"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 will be removed in version 2.9. [deprecated]
  • For more information see DEPRECATED.

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.