BlPackage - addLocalParameter
BlPackage - addLocalParameter
Description :
This command adds a local property to a BLPackage. It finds the BLPackage by group name and package name as two separate arguments. The command takes arguments for the new property's name, description, type, and default value. It also takes boolean arguments that indicate whether the property is editable and whether it is required. For a complete syntax of the type strings, see the PropertyClass addProperty command.
Return type : java.lang.Void
Command Input :
Variable Name | Variable Type | Description |
|---|---|---|
blPackageName | String | Name of the BLPackage. |
groupName | String | Name of the group that contains the BlPackage. |
propertyName | String | Name of the property to add. |
propertyDescription | String | Description of the property. |
propertyType | String | The fully qualified syntax of the property's type. |
editable | Boolean | True if editable during Deploy Jobs, false otherwise. |
required | Boolean | True if a value is required at deploy time, false otherwise. |
defaultValueString | String | String representation of the default value. |
Example
This example shows how to add a string property with a default value to a BLPackage. This example adds a property called "install_dir" to an Apache package.
Script
BlPackage addLocalParameter Apache /Applications/WebServers/Unix install_dir "the install directory for apache servers" Primitive:/String true false "/usr/bin"