// removed jquery ui css and js

Using Parameters

About Parameters and Macros

Parameters (also referred to as macros) are global or tier/step-specific system- or user-defined variables for which values can be provided at deployment time. These parameters can be used as tokens or macros inside the application's configuration file or configuration scripts. At deployment time, the macros are replaced by the actual values specified in the parameter.

The CloudCenter platform allows you to define your own parameters or use the CloudCenter-supported parameters.

Defining Parameters

When adding a new service, you can use global parameters, tier/step-specific system parameters, or user-defined parameters and add values at deployment time.

  • Service Parameters: These parameters are specific to a newly-added/modified service. The parameter is called when a user calls this service. See Define a Custom Service and Service Administration for additional context.
  • Global Parameters: These parameters apply to all tiers and steps within this application (this page).
  • Custom Parameters: These parameters are specified for each step or tier within an application. See Service Properties for additional context.

Parameter Type

Regardless of the parameter being defined at the service level, the global application level, or at a tier level, you can specify the Type for each parameter by selecting one of the following options from the Type dropdown list.

UI Option TypeDescriptionAPI EnumerationAPI Notes
stringProvide an alpha-numeric value (limited to 255 characters).stringUse the valueConstraint attribute to specify constraints.
numberProvide a range of numbers (limited to 255 characters).number
listProvide a list of comma separated text values (limited to 255 characters).listUse the valueList attribute to specify the definition.

WebService is a parameter type introduced in CloudCenter 4.4.

You can provide list of dynamic webservice parameters while deploying a job. From this list, users can select one parameter. The webservice parameter type is available in custom parameters, global parameters, and services. The output should be in the following format:

[{"name":"p1","displayName":"Param 1"},{"name":"p2","displayName":"Param 2"}]

If you configure this parameter type, you must provide the Protocol (HTTP or HTTPS), Web Service URL, and the credentials (Username and Password) for this webservice.

To use this parameter type, you must set the Content-Type to be returned by webservice as application/html.

webserviceUse the webserviceListParams attribute to specify the   definition.
password with confirmation

Provide an alpha-numeric value (limited to 255 characters).

The UI provides a confirmation textbox.

password_inputUse the valueConstraint attribute to specify constraints.

Enter text with no constraints – for example, use this field for a password that just needs to be entered without validation or confirmation.

The UI does not provide a confirmation textbox.


A URL for the download location at the time of orchestration.

Options for pathDescription

Different repositories supported by CloudCenter.

See Shared Artifact Repositories > CloudCenter Repository Types for a list of options.

Format: %REPO_ID_{id}%xyz.war

Example: %REPO_ID_2%xyz.war where 2 is the ID of the repository in CloudCenter

File in Package

Path of the ZIP file defined in the application package of the application profile parent tier.

Example: %PACKAGE_DIR%script.sh


Path for the mounted storage location.

Linux VM Example: /shared

pathText that encodes a URL

You can add any free form text in this area – for example, use this field for to define a parameter with values as file contents, or to define a private key, or to define a script, and so forth.

textareaText of any length (long)

Default Value Usage

The cliqrIgnoreAppFailure parameter does not terminate nodes during a failure and continues to keep all failed application deployment nodes running. If you configure this parameter, then you can enter true or false in the Default Value field to ensure that a VM is or is not terminated if an error is encountered at start up. See Troubleshooting Parameters for additional context.

Granular Control for User-Defined Parameters

The following User Options provide granular control over a user-defined service at any level:

User OptionCheckedUnchecked
Should this parameter be visible to the user?This parameter is visible to users in the Topology Properties sections.This parameter is not visible to users. This allows admins to configure hidden parameters for licensing or tracking purposes (for example, to track how many users are using this service).
Should this parameter be editable by the user?If you check this option, users can override this parameter in the Topology Properties settings.If you do not check the visible check box, this service becomes automatically invisible to the user, and therefore not editable.
Should this parameter be optional?This parameter is optional.This parameter is required.

Supported Parameters


  • No labels
© 2017-2018 Cisco Systems, Inc. All rights reserved