modifyArchiveConnector

Summary

Modifies the specified archiveConnector object.

Stringrequired

Unique name of the archive connector.

Mapoptional

Actual parameter values for the configured archive connector.

Stringoptional

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

Possible values: "JSON", "XML"

Stringoptional

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

Booleanoptional

True if the archive connector should remove all actual parameters.

Stringoptional

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

Booleanoptional

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

Stringoptional

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

$cmdr->modifyArchiveConnector(
  "test-archiveConnectorName" # archiveConnectorName
  # optionals
);▼

ectool modifyArchiveConnector \
  "test-archiveConnectorName" `# archiveConnectorName` \
  # optionals▼

$cmdr->modifyArchiveConnector("MyArchiveConnector", newName-> "MyOtherArchiveConnector");▼

ectool modifyArchiveConnector "MyArchiveConnector" --newName "MyOtherArchiveConnector"▼