Archive connector

1 minute readReference

createArchiveConnector

Creates a new archiveConnector object.

Arguments

Argument Name Type Description

archiveConnectorName

String

(Required) Unique name of the archive connector.

archiveDataFormat

ArchiveDataFormat

The data format that the connector consumes the archived data in.

archiveScript

String

Script registered to connect to the archive system and store the data being archived.

description

String

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

enabled

Boolean

Whether the connector is enabled. If true, then any previously enabled archive connector will be disabled.

Positional arguments

archiveConnectorName

Usage

ec-perl

$cmdr->createArchiveConnector(<archiveConnectorName>, {<optionals>});

ectool

ectool createArchiveConnector archiveConnectorName [optionals]

deleteArchiveConnector

Deletes the specified archiveConnector object.

Arguments

Argument Name Type Description

archiveConnectorName

String

(Required) Unique name of the archive connector.

Positional arguments

archiveConnectorName

Usage

ec-perl

$cmdr->deleteArchiveConnector(<archiveConnectorName>);

ectool

ectool deleteArchiveConnector archiveConnectorName

getArchiveConnector

Retrieves the specified archiveConnector object.

Arguments

Argument Name Type Description

archiveConnectorName

String

(Required) Unique name of the archive connector.

Positional arguments

archiveConnectorName

Usage

ec-perl

$cmdr->getArchiveConnector(<archiveConnectorName>);

ectool

ectool getArchiveConnector archiveConnectorName

getArchiveConnectors

Retrieves all archiveConnector objects.

Arguments

None.

Positional arguments

None.

Usage

ec-perl

$cmdr->getArchiveConnectors();

ectool

ectool getArchiveConnectors

modifyArchiveConnector

Modifies the specified archiveConnector object.

Arguments

Argument Name Type Description

archiveConnectorName

String

(Required) Unique name of the archive connector.

actualParameters

Map

Actual parameter values for the configured archive connector.

archiveDataFormat

ArchiveDataFormat

The data format that the connector consumes the archived data in.

archiveScript

String

Script registered to connect to the archive system and store the data being archived.

clearActualParameters

Boolean

True if the archive connector should remove all actual parameters.

description

String

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

enabled

Boolean

Whether the connector is enabled. If true, then any previously enabled archive connector will be disabled.

newName

String

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

Positional arguments

archiveConnectorName

Usage

ec-perl

$cmdr->modifyArchiveConnector(<archiveConnectorName>, {<optionals>});

ectool

ectool modifyArchiveConnector archiveConnectorName [optionals]