Class: Ansible::Ruby::Modules::Aos_blueprint

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

Overview

Apstra AOS Blueprint module let you manage your Blueprint easily. You can create create and delete Blueprint by Name or ID. You can also use it to retrieve all data from a blueprint. 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

#id ⇒ Object?

Returns AOS Id of the IP Pool to manage (can’t be used to create a new IP Pool). Only one of I(name) or I(id) can be set.

Returns:

  • (Object, nil) —

    AOS Id of the IP Pool to manage (can’t be used to create a new IP Pool). Only one of I(name) or I(id) can be set.



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

attribute :id

#name ⇒ String?

Returns Name of the Blueprint to manage. Only one of I(name) or I(id) can be set.

Returns:

  • (String, nil) —

    Name of the Blueprint to manage. Only one of I(name) or I(id) can be set.



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

attribute :name

#reference_arch ⇒ String?

Returns When creating a blueprint, this value identifies a known AOS reference architecture value. I(Refer to AOS-server documentation for available values).

Returns:

  • (String, nil) —

    When creating a blueprint, this value identifies a known AOS reference architecture value. I(Refer to AOS-server documentation for available values).



35
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_blueprint.rb', line 35

attribute :reference_arch

#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_blueprint.rb', line 12

attribute :session

#state ⇒ :present, ...

Returns Indicate what is the expected state of the Blueprint.

Returns:

  • (:present, :absent, :"build-ready", nil) —

    Indicate what is the expected state of the Blueprint.



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

attribute :state

#template ⇒ String?

Returns When creating a blueprint, this value identifies, by name, an existing engineering design template within the AOS-server.

Returns:

  • (String, nil) —

    When creating a blueprint, this value identifies, by name, an existing engineering design template within the AOS-server.



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

attribute :template

#timeout ⇒ Integer?

Returns When I(state=build-ready), this timeout identifies timeout in seconds to wait before declaring a failure.

Returns:

  • (Integer, nil) —

    When I(state=build-ready), this timeout identifies timeout in seconds to wait before declaring a failure.



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

attribute :timeout