Snapshot

3 minute readReference

createSnapshot

Creates a new snapshot of the specified application or microservice.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

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

snapshotName

String

(Required) Name of the snapshot; must be unique within the snapshot container.

componentVersions

Map

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

description

String

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

environmentName

String

The name of environment from which snapshot be created.

environmentProjectName

String

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

Positional arguments

projectName, applicationName, snapshotName

Usage

ec-perl

$cmdr->createSnapshot(<projectName>, <applicationName>, <snapshotName>, {<optionals>});

ectool

ectool createSnapshot projectName, applicationName, snapshotName, [optionals]

deleteSnapshot

Deletes a snapshot from an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

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

snapshotName

String

(Required) Name of the snapshot; must be unique within the snapshot container.

Positional arguments

projectName, applicationName, snapshotName

Usage

ec-perl

$cmdr->deleteSnapshot(<projectName>, <applicationName>, <snapshotName>);

ectool

ectool deleteSnapshot projectName, applicationName, snapshotName

getPartialApplicationRevision

Retrieves a partial application when a snapshot is created.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

revisionNumber

Integer

(Required) Revision number.

Positional arguments

projectName, applicationName, revisionNumber

Usage

ec-perl

$cmdr->getPartialApplicationRevision(<projectName>, <applicationName>, <revisionNumber>);

ectool

ectool getPartialApplicationRevision projectName, applicationName, revisionNumber

getSnapshot

Retrieves a snapshot by name.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

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

snapshotName

String

(Required) Name of the snapshot; must be unique within the snapshot container.

Positional arguments

projectName, applicationName, snapshotName

Usage

ec-perl

$cmdr->getSnapshot(<projectName>, <applicationName>, <snapshotName>);

ectool

ectool getSnapshot projectName, applicationName, snapshotName

getSnapshotEnvironments

Retrieves a list of environments deployed in the specified snapshot.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

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

snapshotName

String

(Required) Name of the snapshot; must be unique within the snapshot container.

Positional arguments

projectName, applicationName, snapshotName

Usage

ec-perl

$cmdr->getSnapshotEnvironments(<projectName>, <applicationName>, <snapshotName>);

ectool

ectool getSnapshotEnvironments projectName, applicationName, snapshotName

getSnapshots

Retrieves all snapshots in an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

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

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->getSnapshots(<projectName>, <applicationName>);

ectool

ectool getSnapshots projectName, applicationName

modifySnapshot

Modifies an existing snapshot of an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

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

snapshotName

String

(Required) Name of the snapshot; must be unique within the snapshot container.

componentVersions

Map

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

description

String

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

environmentName

String

The name of environment from which snapshot be created.

environmentProjectName

String

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

newName

String

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

Positional arguments

projectName, applicationName, snapshotName

Usage

ec-perl

$cmdr->modifySnapshot(<projectName>, <applicationName>, <snapshotName>, {<optionals>});

ectool

ectool modifySnapshot projectName, applicationName, snapshotName, [optionals]