Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

modifyEnvironmentInventoryItem

Back to index

Summary

Modifies an existing environment inventory item.
projectName
Stringrequired
The name for the project that must be unique among all projects.
environmentName
Stringrequired
The name of the environment.
applicationName
Stringrequired
Application that owns the inventory item.
componentName
Stringrequired
Component that owns the inventory item.
resourceName
Stringrequired
Resource where the item is installed.
applicationTierName
Stringoptional
Name of the application tier.
artifactName
Stringoptional
Artifact name for the inventory item.
artifactSource
Stringoptional
Source of the artifact.
artifactUrl
Stringoptional
Url of the artifact. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].
artifactVersion
Stringoptional
Artifact version for the inventory item.
clusterName
Stringoptional
Cluster where the item is installed.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
environmentProjectName
Stringoptional
Name for the project to which the environment or environment template belongs to.
microserviceName
Stringoptional
Service that owns the inventory item.
status
Stringoptional
Inventory deployment status.
Possible values: "success", "warning", "error", "skipped", "notRun"

Usage

Perl

$cmdr->modifyEnvironmentInventoryItem(
  "test-projectName", # projectName
  "test-environmentName", # environmentName
  "test-applicationName", # applicationName
  "test-componentName", # componentName
  "test-resourceName" # resourceName
  # optionals
);
▼

ectool

ectool modifyEnvironmentInventoryItem \
  "test-projectName" `# projectName` \
  "test-environmentName" `# environmentName` \
  "test-applicationName" `# applicationName` \
  "test-componentName" `# componentName` \
  "test-resourceName" `# resourceName` \
  # optionals
▼

Examples

Perl

$cmdr->modifyEnvironmentInventoryItem("Default", "PROD", "Deploy", "WAR file", "Server 1", {artifactVersion => "V3"});
▼

ectool

ectool modifyEnvironmentInventoryItem "Default" "PROD" "Deploy" "WAR file" "Server 1" --artifactVersion "V3"
▼