CloudShell Version: 9.0 GA

Help Version: 1.0

CloudShell
TestShell
Api Guide
View / Download All Help Versions
API Guide
You are here: Shell Development and Blueprint Design API > Packaging API > Updating Blueprints > Add Global Blueprint Inputs

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:

Name

Direction

Required

Description

topology_name

In

Yes

The name of the blueprint

globalInputName

In

Yes

The name of the global input that you want to add

inputType

In

Yes

The data type of the input: String, Lookup, Numeric

defaultValue

In

No, but an empty string

'' is still required if a default value is not

provided.

A default value that you want to define for the input in case it is left empty

description

In

No, but an empty string

'' is still required if a description is not

provided.

A short description that you want to add to the input

possibleValues

In

No, but an empty list

[] is still required if a value is not

provided.

A list of possible values for the input

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