Overview Package Class Deprecated Help

script
AbstractScript

Base class for all scripts. It contains the common parameters and methods used with all scripts.

public abstract class AbstractScript

Properties
autoSaveResult Identifies if results should automatically be saved to result management.

type=boolean
default=false
Displayed(tab/group)=Save Results from Manual Execution
bundleId The ID of the bundle this script is member of or 0 if this script is not member of any bundle. (Only scripts with Velocity Content Type can be members of a Bundle)

type=int
default=0
Displayed(tab/group)=Member of Bundle (/Member of Bundle)
contentType The contents of the script, if they contain CLI or velocity with CLI/XML API.

type=script.ContentType
access=read-create
default=Velocity
mtosi_description The description of the script.

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=Description
mtosi_id The unique ID of the script.

type=long
access=read-create
default=0
minimum=1
maximum=2147483647
Displayed(tab/group)=Script ID
mtosi_type The category of the script.

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=Type
nextVersionId Identifies the next version of the script.

type=int
access=read-only
default=1
minimum=1
maximum=2147483647
schedule The schedule, if any, that specifies when the script executes.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Schedule (Schedule)
scheduleTask The schedule task, if any, that specifies the binding between the script and the schedule.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Scheduled Task (Schedule)
scopeOfCommandProfilePointer

type=Pointer
default=
scriptMode The mode of the script, if targets can be edited or not.

type=script.ModeType
default=Released
scriptName The name of the script.

type=string
default=
minimum=1
maximum=255
Displayed(tab/group)=Name
scriptState The state of the script, if targets can be executed or not.

type=script.StateType
default=Enable
spanObjectPointer A pointer to the parent spanEnabled object.

type=string
access=read-only
default=
minimum=0
maximum=252
useLatestVersion Identifies if targets should always move to the latest version of the script.

type=boolean
default=false
Displayed(tab/group)=Use Latest Version
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

changeScriptVersion

This method changes the version for a list of targets scripts. The new version full name along with necessary parameters must be specified in the target(s).
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.
listOfTargetScriptConfigInfo : List (generic.CommonManagedEntityConfigurationInformation) - The list of target configuration information.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
script.AbstractScript.changeScriptVersionException

configScriptVersion

This method creates a version of the auto-config script/template (and deletes the older version if exists).
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.
versionConfigInfo : generic.CommonManagedContainmentEntityConfigurationInformation - The script version configuration information.
bodyScript : List (string) - The script version body (list of commands).
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
versionInfo : generic.CommonManagedContainmentEntityInformation - The newly created version information.
Exceptions:
script.AbstractScript.configScriptVersionException

configureScript

This method modifies script information.
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 new script 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 : string - The full name of the configured script.
Exceptions:
script.AbstractScript.configureScriptException

configureTarget

This method creates a target associated to a script.
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 new target 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 : string - The full name of the newly created target script.
Exceptions:
script.AbstractScript.configureTargetException

configureTargets

This method creates multiple targets associated to a script.
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.
listOfTargetScriptConfigInfo : List (generic.CommonManagedContainmentEntityConfigurationInformation) - The list of target script configuration information.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
listOfSummary : List (generic.CommonManagedEntityInformation) - The list of object summaries for the newly created targets.
Exceptions:
script.AbstractScript.configureTargetsException

createScriptVersion

This method creates a version of the script.
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.
versionConfigInfo : generic.CommonManagedContainmentEntityConfigurationInformation - The script version configuration information.
bodyScript : List (string) - The script version body (list of commands).
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
versionInfo : generic.CommonManagedContainmentEntityInformation - The newly created version information.
Exceptions:
script.AbstractScript.createScriptVersionException