modifySnapshot

Back to index

Summary

Modifies an existing snapshot of an application.

projectName

Stringrequired

The name for the project that must be unique among all projects.

applicationName

Stringrequired

The name of application from which the snapshot should be created.

snapshotName

Stringrequired

Name of the snapshot; must be unique within the snapshot container.

componentVersion

Arrayoptional

Component names and version used for snapshot. Use keyword LATEST to indicate the latest version.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentName

Stringoptional

The name of environment from which snapshot be created.

environmentProjectName

Stringoptional

Name for the project to which the environment or environment template belongs to.

newName

Stringoptional

The new name for an existing object that is being renamed.

Usage

Perl

$cmdr->modifySnapshot(
  "test-projectName", # projectName
  "test-applicationName", # applicationName
  "test-snapshotName" # snapshotName
  # optionals
);▼

ectool

ectool modifySnapshot \
  "test-projectName" `# projectName` \
  "test-applicationName" `# applicationName` \
  "test-snapshotName" `# snapshotName` \
  # optionals▼

Examples

Perl

$cmdr->modifySnapshot("Default", "Deploy", "Beta Version 4", {description => "Internal use only"} );▼

ectool

ectool modifySnapshot "Default" "Deploy" "Beta Version 4" --description "Beta only"▼