W3cubDocs

/Ansible

aos_device - Manage Devices on AOS Server

New in version 2.3.

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 (on host that executes module)

  • aos-pyez >= 0.6.0

Options

parameter required default choices comments
approve
 no no
  • yes
  • no
The approve argument instruct the module to convert a device in quarantine mode into approved mode.
id
 no
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
 no
When approving a device using the approve argument, it's possible define the location of the device.
name
 no
The device serial-number; i.e. uniquely identifies the device in the AOS system. Only one of name or id can be set.
session
 yes
An existing AOS session as obtained by aos_login module.
state
 no normal
  • normal
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 is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

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

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/aos_device_module.html