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

Inherits:
Base show all
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 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

#blueprint ⇒ String

Returns Blueprint Name or Id as defined in AOS.

Returns:

  • (String) —

    Blueprint Name or Id as defined in AOS.



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

attribute :blueprint

#get_param_list ⇒ Boolean?

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

Returns:

  • (Boolean, nil) —

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



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

attribute :get_param_list

#name ⇒ String?

Returns Name of blueprint parameter, as defined by AOS design template. You can use the option I(get_param_list) to get the complete list of supported parameters for your blueprint.

Returns:

  • (String, nil) —

    Name of blueprint parameter, as defined by AOS design template. You can use the option I(get_param_list) to get the complete list of supported parameters for your blueprint.



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

attribute :name

#param_map ⇒ Hash?

Returns Defines the aos-pyez collection that will is used to map the user-defined item name into the AOS unique ID value. For example, if the caller provides an IP address pool I(param_value) called “Server-IpAddrs”, then the aos-pyez collection is ‘IpPools’. Some I(param_map) are already defined by default like I(logical_device_maps).

Returns:

  • (Hash, nil) —

    Defines the aos-pyez collection that will is used to map the user-defined item name into the AOS unique ID value. For example, if the caller provides an IP address pool I(param_value) called “Server-IpAddrs”, then the aos-pyez collection is ‘IpPools’. Some I(param_map) are already defined by default like I(logical_device_maps).



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

attribute :param_map

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

attribute :session

#state ⇒ :present, ...

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

Returns:

  • (:present, :absent, nil) —

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



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

attribute :state

#value ⇒ Hash?

Returns Blueprint parameter value. This value may be transformed by using the I(param_map) field; used when the blueprint parameter requires an AOS unique ID value.

Returns:

  • (Hash, nil) —

    Blueprint parameter value. This value may be transformed by using the I(param_map) field; used when the blueprint parameter requires an AOS unique ID value.



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

attribute :value