Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

modifyPlugin

Back to index

Summary

Modifies a 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. Therefore, when the Plugin Manager is run in the web server context, it provides additional information and functionality.
pluginName
Stringrequired
The name of the plugin.
author
Stringoptional
The name of the plugin author.
authorUrl
Stringoptional
The URL of the plugin author. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].
category
Stringoptional
The category of the plugin.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
extensionVersion
Integeroptional
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
Stringoptional
Label to display in lists for the plugin.
pluginWizardBased
Booleanoptional
Whether the plugin is based on Plugin Wizard.
repositoryUrl
Stringoptional
The URL of plugin's repository. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].
supportLevel
Integeroptional
The support level for the plugin.
supportsConfigurations
Booleanoptional
Whether the plugin supports plugin configurations. If true, then the plugin configuration procedures, CreateConfiguration and DeleteConfiguration will be automatically created.

Usage

Perl

$cmdr->modifyPlugin(
  "test-pluginName" # pluginName
  # optionals
);
▼

ectool

ectool modifyPlugin \
  "test-pluginName" `# pluginName` \
  # optionals
▼

Examples

Perl

$cmdr->modifyPlugin('TheWidget', {description => "new description"});
▼

ectool

ectool modifyPlugin TheWidget --description "new description"
▼