ansible.builtin.aos_device (v2.4.6.0-1) — module

Manage Devices on AOS Server

| "added in version" 2.3 of ansible.builtin"

Authors: Damien Garros (@dgarros)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.4.6.0.post1

Description

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 I(normal) is supported but the goal is to extend this module with additional state. This module is idempotent and support the I(check) mode. It's using the AOS REST API.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Approve a new device
  aos_device:
    session: "{{ aos_session }}"
    name: D2060B2F105429GDABCD123
    state: 'normal'
    approve: true
    location: "rack-45, ru-18"

Inputs

    
id:
    description:
    - The AOS internal id for a device; i.e. uniquely identifies the device in the AOS
      system. Only one of I(name) or I(id) can be set.

name:
    description:
    - The device serial-number; i.e. uniquely identifies the device in the AOS system.
      Only one of I(name) or I(id) can be set.

state:
    choices:
    - normal
    default: normal
    description:
    - Define in which state the device should be. Currently only I(normal) is supported
      but the goal is to add I(maint) and I(decomm).

approve:
    choices:
    - 'yes'
    - 'no'
    default: 'no'
    description:
    - The approve argument instruct the module to convert a device in quarantine mode
      into approved mode.

session:
    description:
    - An existing AOS session as obtained by M(aos_login) module.
    required: true

location:
    description:
    - When approving a device using the I(approve) argument, it's possible define the
      location of the device.