DeployJob - createComponentBasedDeployJob

DeployJob - createComponentBasedDeployJob

Description :

This command works similarly to createDeployJob , except that the target of the job is a Component.

Return type : DBKey

Command Input :

Variable Name

Variable Type

Description

deployJobName

String

Name assigned to this Deploy Job.

groupId

Integer

ID of the job group where this job is saved.

packageKey

DBKey

Handle associated with the BLPackage for this Deploy Job.

deployType

Integer

Specifies whether this is a basic (0) or advanced (1) Deploy Job.

componentKey

DBKey

Handle to the component that is the target of this Deploy Job.

isSimulateEnabled

Boolean

True indicates the job should include a Simulate phase, during which a dry run is performed without actually deploying the package.

isCommitEnabled

Boolean

True indicates the job should include a Commit phase, during which the package is actually applied to the target server.

isStagedIndirect

Boolean

True indicates the package is delivered to a server functioning as a repeater. During the Commit phase, the package is actually applied to the target server.

logLevel

Integer

Specifies the level of logging to display for the job (0 - ERROR_ONLY, 1 - ERROR_AND_WARNING, 2 - ALL_INFO)

isExecuteByPhase

Boolean

True indicates the flow of the job should be controlled by phase; false indicates the flow is controlled by server. This argument should be set to false for a basic Deploy Job.

isResetOnFailure

Boolean

True indicates the job is automatically reset on failure. This argument should be set to true for a basic Deploy Job.

isRollbackAllowed

Boolean

True indicates that rollback files are left on the target for later use.

isRollbackOnFailure

Boolean

True indicates the job should automatically roll back on failure.

isRebootIfRequired

Boolean

True indicates the server should automatically reboot if necessary.

isCopyLockedFiles

Boolean

True indicates locked files are copied after reboot; false indicates locked files are treated as errors.

isStagingAfterSimulate

Boolean

True indicates staging should start immediately after the Simulate phase is complete. Set this value to false for a basic Deploy Job. For an advanced Deploy Job, this value is typically set to true.

isCommitAfterStaging

Boolean

True indicates the Commit phase should start immediately after staging is complete. This value should be set to false for a basic Deploy Job. For an advanced Deploy Job, this value is typically set to true.

isSingleDeployModeEnabled

Boolean

True indicates the job should run in single deploy mode. Default is false.

isSUMEnabled

Boolean

True indicates that single user mode is enabled, false otherwise. Default is true.

singleUserMode

Integer

If isSUMEnabled is set to true, this variable indicates the setting of the single user mode. Default is 0.

rebootMode

Integer

Indicates which reboot mode to use. Default is 0.

isMaxWaitTimeEnabled

Boolean

True indicates the Max. Wait Time in Deploy Queue option is enabled. Default is false.

maxWaitTime

String

How long a job can wait in the deploy queue before it is declared failed. Expressed in seconds. Default is 30. This variable takes effect only when isMaxWaitTimeEnabled is set to true.

isMaxAgentConnectionTimeEnabled

Boolean

True indicates the Max. Agent Connection Time option is enabled. Default is false.

maxAgentConnectionTime

Integer

The maximum time (in seconds) to try to establish a connection to an agent. This variable takes effect only if isMaxAgentConnectionTimeEnabled is set to true. Default is 60.

isFollowSymlinks

Boolean

True indicates that the Deploy Job should follow symlinks on remote repositories, and copy source files if copying at staging. (To specify copying at staging, set urlTypeName to AGENT_COPY_AT_STAGING in whatever DepotSoftware command you are using to create the software object.) Default is false.

useReconfigRebootAtEndOfJob

Boolean

True if the final reboot on a Solaris system should use a reconfiguration reboot. This value will be ignored unless the reboot option is set >=2. Default is false.

overrideItemReconfigReboot

Integer

This argument indicates whether or not an item based reconfigure reboot on Solaris is allowed. Default is 0 (use item based reconfigure setting). If you set this argument to 1 (ignore item defined reconfigure setting), then the items that request a reconfigure reboot will only do a reboot.

Was this page helpful? Yes No Submitting... Thank you

Comments