createEnvironmentInventoryItem
Creates a new environment inventory item.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentName | String | The name of the environment. (Required) |
applicationName | String | Application that owns the inventory item |
applicationTierName | String | Name of the application tier |
artifactName | String | Artifact name for the inventory item |
artifactSource | String | Source of the artifact |
artifactUrl | String | Url of the artifact |
artifactVersion | String | Artifact version for the inventory item |
clusterName | String | Cluster where the item is installed |
componentName | String | Component that owns the inventory item |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
environmentProjectName | String | Name for the project to which the environment or environment template belongs to. |
microserviceName | String | Service that owns the inventory item |
resourceName | String | Resource where the item is installed |
status | String | Inventory deployment status |
deleteEnvironmentInventoryItem
Delete an inventory item
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentName | String | The name of the environment. (Required) |
applicationName | String | Application that owns the inventory item |
microserviceName | String | Service that owns the inventory item |
artifactName | String | Artifact name for the inventory item |
clusterName | String | Cluster where the item is installed |
componentName | String | Component that owns the inventory item |
environmentProjectName | String | Name for the project to which the environment or environment template belongs to. |
resourceName | String | Resource where the item is installed |
getEnvironmentInventory
Retrieve a per-component or microservice grouped list of inventory items
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentName | String | The name of the environment. (Required) |
applicationName | String | The name of the application. (Required) |
applicationEntityRevisionId | String | Revisionid of the versioned object |
environmentProjectName | String | Name for the project to which the environment or environment template belongs to. |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.getEnvironmentInventory(
projectName: 'test-projectName',
environmentName: 'test-environmentName',
applicationName: 'test-applicationName'
/* optional arguments */)
getEnvironmentInventoryItem
Retrieve an inventory item
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentName | String | The name of the environment. (Required) |
applicationName | String | Application that owns the inventory item |
microserviceName | String | Service that owns the inventory item |
artifactName | String | Artifact name for the inventory item |
clusterName | String | Cluster where the item is installed |
componentName | String | Component that owns the inventory item |
environmentProjectName | String | Name for the project to which the environment or environment template belongs to. |
includeResourceDetails | Boolean | True to include resource details (default is false) |
resourceName | String | Resource where the item is installed |
getEnvironmentInventoryItems
Retrieve all inventory items for a given environment
modifyEnvironmentInventoryItem_3
Modifies an existing environment inventory item.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentName | String | The name of the environment. (Required) |
applicationName | String | Application that owns the inventory item |
componentName | String | Component that owns the inventory item |
resourceName | String | Resource where the item is installed |
applicationTierName | String | Name of the application tier |
artifactName | String | Artifact name for the inventory item |
artifactSource | String | Source of the artifact |
artifactUrl | String | Url of the artifact |
artifactVersion | String | Artifact version for the inventory item |
clusterName | String | Cluster where the item is installed |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
environmentProjectName | String | Name for the project to which the environment or environment template belongs to. |
microserviceName | String | Service that owns the inventory item |
status | String | Inventory deployment status |