getEnvironmentInventoryItem

Back to index

Summary

Retrieves an 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.

artifactName

Stringoptional

Artifact name for the inventory item.

clusterName

Stringoptional

Cluster where the item is installed.

environmentProjectName

Stringoptional

Name for the project to which the environment or environment template belongs to.

includeResourceDetails

Booleanoptional

True to include resource details (default is false).

microserviceName

Stringoptional

Service that owns the inventory item.

Usage

Perl

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

ectool

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

Examples

Perl

$cmdr->getEnvironmentInventoryItem("Default", "Test Lab", "Save snapshot", "WAR file", "QA server", {environmentProjectName => "QA only"});▼

ectool

ectool getEnvironmentInventoryItem "Default" "Test Lab" "Save snapshot" "WAR file" "QA server" --environmentProjectName "QA only"▼