Class: Ansible::Ruby::Modules::Aos_blueprint_param

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Aos_blueprint_param

Defined in:

lib/ansible/ruby/modules/generated/network/aos/aos_blueprint_param.rb

Overview

Apstra AOS Blueprint Parameter module let you manage your Blueprint Parameter easily. You can create access, define and delete Blueprint Parameter. The list of Parameters supported is different per Blueprint. The option I(get_param_list) can help you to access the list of supported Parameters for your blueprint. This module is idempotent and support the I(check) mode. It’s using the AOS REST API.

Instance Method Summary

• #blueprint ⇒ String

  Blueprint Name or Id as defined in AOS.

• #get_param_list ⇒ Boolean^?

  Get the complete list of supported parameters for this blueprint and the description of those parameters.

• #name ⇒ String^?

  Name of blueprint parameter, as defined by AOS design template.

• #param_map ⇒ Hash^?

  Defines the aos-pyez collection that will is used to map the user-defined item name into the AOS unique ID value.

• #session ⇒ String

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

• #state ⇒ :present, ...

  Indicate what is the expected state of the Blueprint Parameter (present or not).

• #value ⇒ Hash^?

  Blueprint parameter value.

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

#blueprint ⇒ String

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

attribute :blueprint

#get_param_list ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/network/aos/aos_blueprint_param.rb', line 28

attribute :get_param_list

#name ⇒ String^?

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

attribute :name

#param_map ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/network/aos/aos_blueprint_param.rb', line 36

attribute :param_map

#session ⇒ String

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

attribute :session

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/network/aos/aos_blueprint_param.rb', line 32

attribute :state

#value ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/network/aos/aos_blueprint_param.rb', line 24

attribute :value