aos_device – Manage Devices on AOS Server¶
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¶
- Apstra AOS Device module let you manage your devices in AOS easily. You can approve devices and define in which state the device should be. Currently only the state normal is supported but the goal is to extend this module with additional state. This module is idempotent and support the check mode. It’s using the AOS REST API.
Requirements¶
The below requirements are needed on the host that executes this module.
- aos-pyez >= 0.6.0
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
approve
boolean
|
|
The approve argument instruct the module to convert a device in quarantine mode into approved mode.
|
|
id
-
|
The AOS internal id for a device; i.e. uniquely identifies the device in the AOS system. Only one of name or id can be set.
|
|
|
location
-
|
When approving a device using the approve argument, it's possible define the location of the device.
|
|
|
name
-
|
The device serial-number; i.e. uniquely identifies the device in the AOS system. Only one of name or id can be set.
|
|
|
session
-
/ required
|
An existing AOS session as obtained by aos_login module.
|
|
|
state
-
|
|
Define in which state the device should be. Currently only normal is supported but the goal is to add maint and decomm.
|
Examples¶
- name: Approve a new device
aos_device:
session: "{{ aos_session }}"
name: D2060B2F105429GDABCD123
state: 'normal'
approve: true
location: "rack-45, ru-18"
Status¶
- This module will be removed in version 2.9. [deprecated]
- For more information see DEPRECATED.
Authors¶
- Damien Garros (@dgarros)
Hint
If you notice any issues in this documentation you can edit this document to improve it.