Overview Package Class Deprecated Help

script
TargetParameter

This class is used to define parameters used in a script. There must be one parameter object for each parameter specified in a target script. Parameters are define in the script version and contain a name and value. The value can have a default specified for it that can be overridden. Note: This object must be configured through the TargetScript.

public class TargetParameter

Properties
checkBoxValueDefined Identifies if the parameter was specified using the checkbox value on the UI. It is used to identify the user selected the check value on the UI (used when editing the target).

type=boolean
access=read-create
default=false
mode The mode for the parameter.

type=script.ParameterMode
default=modify
paramType The type of the parameter.

type=script.ParameterType
access=read-create
default=string
parameterName The name of the parameter (must be the same as the one defined in the script version).

type=string
access=read-create
default=
minimum=1
maximum=255
Mandatory on create
Displayed(tab/group)=Parameter Name
runtime Identifies if the parameter is specified at runtime (must be the same as the one defined in the script version).

type=boolean
access=read-create
default=false
spanObjectPointer A pointer to the parent spanEnabled object.

type=string
access=read-only
default=
minimum=0
maximum=252
unset Identifies if the parameter is to be unset. This is only applicable to objects that allow "unset".

type=boolean
default=false
value The value of the parameter.

type=string
default=
minimum=0
maximum=4000
Displayed(tab/group)=Value
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

configure

This method is used to create or configure target parameters.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
configInfo : generic.CommonManagedContainmentEntityConfigurationInformation - The target parameter configuration information.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : Pointer - The target parameter full name.
Exceptions:
script.TargetParameter.configureException