exportPlugin
Exports a plugin to a .zip file. You can use this file to import a plugin to another CloudBees CD/RO server.
installPlugin
Installs a plugin from a .jar or .zip file. Extracts the .jar or .zip file contents on the server and creates a project and a plugin.
Arguments
| Argument Name | Type | Description |
|---|---|---|
url |
String |
(Required) A locator (local file path or network URL) for the plugin to install. |
disableProjectTracking |
Boolean |
If set to true when importing or exporting a project, even if the original project had change tracking enabled, make change tracking of the newly imported or exported project be disabled from its creation. If you don’t need to track changes to the new project, this avoids the change tracking overhead that would otherwise slow down the import operation, and also saves having to subsequently disable change tracking of the reimported project. |
force |
Boolean |
If true, install should ignore a preexisting plugin. |
reducedDetailChangeHistory |
Boolean |
Set to 0 or false to prevent importing a large project that has change tracking enabled from automatically reducing the level of detail that it tracks for the change history of the import — this will make the import operation take longer and put more load on the database, but will allow the Change History feature to still show the full detail of entities owned by the imported project that were created by the import operation. |
modifyPlugin
Modifies an existing plugin.
Some plugin attributes available on the Plugins page are not available in any of the plugin-related APIs. Because some plugin metadata comes from the plugin.xml file, the web server can access this data, but the CloudBees CD/RO server cannot. Thus, the Plugin Manager, when run in the web server context, provides additional information and functionality.
|
Arguments
| Argument Name | Type | Description |
|---|---|---|
pluginName |
String |
(Required) The name of the plugin. |
author |
String |
The name of the plugin author. |
authorUrl |
String |
The URL of the plugin author. |
category |
String |
The category of the plugin. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
extensionVersion |
Integer |
An extension version number should be used when modifying or extending a CloudBees provided plugin. This allows the system to differentiate between the product plugin versions and plugin versions modified or customized by you. |
label |
String |
Label to display in lists for the plugin. |
pluginWizardBased |
Boolean |
Whether the plugin is based on Plugin Wizard. |
repositoryUrl |
String |
The URL of plugin’s repository. |
supportLevel |
Integer |
The support level for the plugin. |
supportsConfigurations |
Boolean |
Whether the plugin supports plugin configurations. If true, then the plugin configuration procedures, CreateConfiguration and DeleteConfiguration will be automatically created. |
promotePlugin
Sets the promoted argument on a plugin. Only one version of a plugin can be promoted at a time, so setting the promoted flag to true on one version sets the flag to false on all other plugins with the same key. The promoted version is the one resolved by an indirect reference of the form $[/plugins/<key>] or a plugin name argument without a specified version.
uninstallPlugin
Uninstalls a plugin and deletes the associated project and any installed files.