Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Utility - exportSnapshotRun_1

Utility - exportSnapshotRun

Description :

This command exports the results of a Snapshot Job run index to a file. You must identify the job run by its run number.

Use the optional templateGrpName, templateName and serverName arguments to export one run index result at a time, in a situation where your Snapshot Job finds multiple snapshots.

For a server object based Snapshot Job, you can leave templateGrpName and templateName empty. Also, for a template based Snapshot Job, if there is only one template used, you can leave templateGrpName and templateName empty.

The following example shows how to export a Snapshot Job's run index results.

Return type : java.lang.Void

Command Input :

Variable Name

Variable Type

Description

jobGroupName

String

Fully qualified job group where the Snapshot Job is stored.

jobName

String

Name of the Snapshot Job to export.

runId

Integer

Job Run Id of the Snapshot Job run to export.

templateGrpName

String

Fully qualified template group name of the template used in the Snapshot job.

templateName

String

Name of the template used in the Snapshot job.

serverName

String

Name of the target server used in the Snapshot job.

exportFileName

String

Name of the file that holds the export.

exportType

String

Format for saving exported results (CSV or HTML).

Example

The following example shows how to export the job run result of a Snapshot Job.

Script





Utility exportSnapshotRun  "/sampleJobGroup"  "sampleJob" 2000006  "/tmpGrp" "tmp1" "server1" "C:/temp/sampleJobResult.csv" "CSV" 



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

Comments