Skip to main content
Version: Latest

Add Global Blueprint Inputs

Description: Add a global blueprint input to a specific blueprint.

Signature: add_global_input_to_topology(topology_name, globalInputName, inputType, defaultValue, description, possibleValues)

Parameters:

NameDirectionRequiredDescription
topology_nameInYesThe name of the family
globalInputNameInYesThe name of the attribute
inputTypeInYesIn case of service family, specify if this attribute should be presented to the user who using the service
defaultValueInNo, but an empty string '' is still required if a default value is not provided.Specify the list of allowed values for this attribute (comma separated)
descriptionInNo, but an empty string '' is still required if a default value is not provided.Specify the list of allowed values for this attribute (comma separated)
possibleValuesInNo, but an empty list [] is still required if a default value is not provided.Specify the list of allowed values for this attribute (comma separated)

Sample 1 - with all input values specified (correct call):

packageEditor.add_global_input_to_topology('blueprint1', 'version number', 'String', 'None', 'Please specify the software version', [])

Sample 2 - with only required input values specified (correct call):

packageEditor.add_global_input_to_topology('blueprint1', 'version number', 'String', '', '', [])

Sample 3 - demonstrating an incorrect call (in contrast to Sample 2 above):

packageEditor.add_global_input_to_topology('blueprint1', 'version number', 'String')