Class: Ansible::Ruby::Modules::Aos_device

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/aos/aos_device.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#approve ⇒ :yes, ...

Returns The approve argument instruct the module to convert a device in quarantine mode into approved mode.

Returns:

  • (:yes, :no, nil) —

    The approve argument instruct the module to convert a device in quarantine mode into approved mode.



27
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_device.rb', line 27

attribute :approve

#id ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



20
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_device.rb', line 20

attribute :id

#location ⇒ Array<String>, ...

Returns When approving a device using the I(approve) argument, it’s possible define the location of the device.

Returns:

  • (Array<String>, String, nil) —

    When approving a device using the I(approve) argument, it’s possible define the location of the device.



31
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_device.rb', line 31

attribute :location

#name ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



16
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_device.rb', line 16

attribute :name

#session ⇒ String

Returns An existing AOS session as obtained by M(aos_login) module.

Returns:

  • (String) —

    An existing AOS session as obtained by M(aos_login) module.



12
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_device.rb', line 12

attribute :session

#state ⇒ :normal?

Returns 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).

Returns:

  • (:normal, nil) —

    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).



23
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_device.rb', line 23

attribute :state