IntroductionRoadmap to CloudBees Flow APIsUsing the CloudBees Flow Perl APICloudBees Flow Perl API Response and Element GlossaryUsing the CloudBees Flow RESTful APIUsing the Flow DSLUsing the CloudBees Flow Groovy APIUsing JRubyCloudBees Flow Error MessagesCloudBees Flow Perl API Response and Element Glossary
IntroductionACL ManagementApplication DependencyApplicationsApplication Tier Artifact ManagementCatalogsChange HistoryComponentsCredential ManagementCustom FiltersDatabase ConfigurationData RetentionDevOps InsightDirectory Provider ManagementDynamic EnvironmentsEmail Configuration ManagementEmail Notifier ManagementEnvironmentEnvironment TierGateway and Zone ManagementInstalling or Upgrading Remote AgentsJob ManagementMicroservicesObject TagsParameter ManagementPersonasPipelines and ReleasesPlugin ManagementProcedure ManagementProcessProcess DependencyProcess StepProject ManagementProperty ManagementResource ManagementRolling DeploySchedule ManagementServer ManagementSingle Sign-OnSnapshotsTier MapUser and Group ManagementWait DependenciesWebhhook ManagementWorkflow Definition ManagementWorkflow ManagementWork ItemsWorkspace ManagementMiscellaneous Management
IntroductionExamples
Introductionaclaclentryactualparameteractualparametersappdepapplicationappservicemappingapptierarchiveconnectorartifactartifactversioncatalogcatalogitemclustercomponentcontainercredentialdashboarddashboardcolumndataretentiondeployerappdeployerconfdeployerservicedeployhistorydirproviderdoisdatasourceemailconfigemailnotifierentitychangeenvinvenvironmentenvmapenvtemeplateenvtemptierenvtemptiermapenvtemptiermappingenvtemptierresourcemappingenvtierenvvareventsubflowruntimeformaloutparamformalparamgategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparampersonapersonacatpersonapagepipelinepipelinerunnamepluginportprocdependprocedureprocessprocstepprojectpropertyreleasereportreportfilterreportobjassocreportobjattrreportobjtyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartrollingrundiscoverysamlidentitysamlserviceschedulesearchfilterserverserviceserviceacctserviceclusterservicedepservicemapsessionsnapshotstagestatestatedeftagtasktiermaptiermappingtransdeftransitionuserutilitywaitdependwidgetwidgetfilteroverrideworkdefworkflowworkitemworkspacezone
Groovy API argument models

Resource Management

13 minute readReference

addResourcesToPool

Adds resources to the specified resource pool (a named group of resources).

You must specify a resourcePoolName.

Arguments Descriptions

resourcePoolName

Name for the resource pool that must be unique among all resource pools. The resource pool has one or more resources.

Argument Type: String

resourceNames

(Optional) List of resources to add to the resource pool.

Argument Type: Collection

Positional arguments

resourcePoolName

Response

None or a status OK message.

ec-perl

syntax: $cmdr->addResourcesToPool(<resourcePoolName>, {<optionals>});

Example

$cmdr->addResourcesToPool("Test Station 1", {resourceNames => ["Server1", "Server2", "Server3"]});
▼

ectool

syntax: `ectool addResourcesToPool <resourcePoolName> [optionals] `

Example

ectool addResourcesToPool "Test Station 1" --resourceNames Server1 Server2 Server3
▼

Back to top

addResourceToEnvironmentTier

Adds a resource to the specified environment tier.

You must specify the resourceName, projectName, environmentName. and environmentTierName arguments.

Arguments Descriptions

resourceName

Name for the resource that must be unique among all resources.

Argument Type: String

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

environmentName

Name of the environment that must be unique among all projects.

Argument Type: String

environmentTierName

Name for the environment tier that must be unique among all tiers for the environment.

Argument Type: String

rollingDeployPhaseName

(Optional) Name for the rolling deploy phase to be associated with the resource.

Argument Type: String

Positional arguments

resourceName, projectName, environmentName, environmentTierName

Response

None or a status OK message.

ec-perl

syntax: $<object>->addResourceToEnvironmentTier(<resourceName>, <projectName>, <environmentName>, <environmentTierName>, {<optionals>});

Example

$ec->addResourceToEnvironmentTier("Web Server", "Default", "DEV", "DB Server", {rollingDeployPhaseName => "Blue UAT demo"});
▼

ectool

syntax: addResourceToEnvironmentTier <resourceName> <projectName> <environmentName> <environmentTierName> [optionals]

Example

ectool addResourceToEnvironmentTier "Web Server" "Default" "DEV" "DB Server" --rollingDeployPhaseName "Blue UAT demo"
▼

Back to top

createResource

Creates a new resource. For a proxy resource, the `proxyHostName` and `proxyPort` arguments refer to the proxying CloudBees Flow agent. The `hostName` and `port` arguments refer to the proxy target.
Arguments Descriptions

resourceName

Name of the new resource that must be unique among all resources.

Argument Type: String

artifactCacheDirectory

(Optional) Directory on the agent host where retrieved artifacts are stored.

Argument Type: String

block

(Optional) < Boolean flag— 0|1|true|false >

A newly created resource will be pinged. This argument makes the createResource call block until the result of the ping is known. The default is false .

Argument Type: Boolean

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>

Argument Type: String

hostName

(Optional) If it is an ordinary resource, the name or IP address of the machine containing the CloudBees Flow agent for this resource .

If this is a proxy resource, the name or IP address of the proxy target.

Argument Type: String

hostType

(Optional) Type of the host: CONCURRENT (deprecated) or REGISTERED

  • If the license on the server is a concurrent resource license, hostType defaults to CONCURRENT.

  • If the license on the server is a registered host license, hostType defaults to REGISTERED.

  • If the license on the server is a mixed-mode license (concurrent resources and registered hosts), you must specify the host type, CONCURRENT or REGISTERED, when adding a resource.

Argument Type: String

pools

(Optional) A space-separated list of one or more pool names where this resource is a member. Steps defined to run on a resource pool will run on any available member (resource) in the pool.

Argument Type: String

This argument is deprecated and is replaced by the resourcePools argument.

port

(Optional) The CloudBees Flow agent port number for an ordinary resource. If a port number is not specified, the default agent port is used. The default agent port can be configured on the "Server Settings" page in the automation platform UI. For a proxy resource, this is the port number for the service running on the proxy target that will run commands on behalf of the CloudBees Flow agent. For ssh, the default is 22.

Argument Type: Integer

proxyCustomization

(Optional) Customized Perl code specifying how the proxy resource communicates with the proxy target. This argument is applicable only for proxy resources.

Argument Type: String

proxyHostName

(Optional) The name or IP address of the computer containing the CloudBees Flow Agent used for a proxy resource.

Argument Type: String

proxyPort

(Optional) The CloudBees Flow agent port number for a proxy resource. See the port argument description for more details.

Argument Type: Integer

proxyProtocol

(Optional) Protocol for communicating with the proxy target. Defaults to ssh. (This argument is not exposed in the CloudBees Flow UI at this time.)

Argument Type: String

repositoryNames

(Optional) A list of one or more repository names. Each repository name is listed on a "new line."

Argument Type: String

resourceDisabled

(Optional) < Boolean flag— 0|1|true|false >

If this is set to 1, CloudBees Flow will not start new steps on this resource. The default is false.

Argument Type: Boolean

resourcePools

(Optional) A comma-separated list of one or more pool names where this resource is a member. Spaces and commas in pool names are allowed. Steps defined to run on a resource pool will run on any available member (resource) in the pool.

Argument Type: String

This argument replaces the pools argument.

To create one pool with a space in its name:

--resourcePools "Test Pool"
▼

To create multiple pools with spaces in their names:

--resourcePools "Test Pool One, Test Pool Two"
▼

To create a pool with a comma in its name:

--resourcePools "[Test Pool, One]"
▼

shell

(Optional) This sets a default shell for running step commands on this resource. The default is "cmd /q /c" for a Windows agent and "sh -e" for a UNIX agent.

Argument Type: String

stepLimit

(Optional) Limits the number of steps that can run on the resource at one time. Setting the limit to `1 ` enforces serial access to the resource.

Argument Type: Integer

trusted

(Optional) < Boolean flag— 0|1|true|false >

If this is set to 1 or true, the resource is trusted . Agents can be either trusted or untrusted :

  • trusted —The CloudBees Flow server verifies the agent’s identity using SSL certificate verification.

  • untrusted —The CloudBees Flow server does not verify agent identity. An untrusted agent could be a security risk.

Argument Type: Boolean

useSSL

(Optional) < Boolean flag— 0|1|true|false >

Use this flag to define whether SSL is used for server-agent communication, or if you need to use SSL to communicate with your Active Directory servers. The default is 1 or true.

Transport Layer Security (TLS) has replaced Secure Sockets Layer version 3.0 (SSLv3) on the CloudBees Flow web server and the CloudBees Flow server.

Argument Type: Boolean

workspaceName

(Optional) Name of the workspace that the resource uses.

Argument Type: String

zoneName

(Optional) The name of the zone where this resource resides.

Argument Type: String

Positional arguments

resourceName

Response

None or a status OK message.

ec-perl

syntax: $cmdr->createResource(<resourceName>, {<optionals>});

Example

$cmdr->createResource("Test Machine 1", {hostName => "localhost", pools => "P1 P2"});
▼

ectool

syntax: ectool createResource <resourceName> [optionals]

Example

ectool createResource "Test Machine 1" --hostName localhost --pools "P1 P2"
▼

Back to top

createResourcePool

Creates a new pool for resources.

You must specify a resourcePoolName.

Arguments Descriptions

resourcePoolName

Name for the resource pool that must be unique among all resource pools.

Argument Type: String

autoDelete

(Optional) < Boolean flag— 0|1|true|false > – If this is set to 1 or true, the resource pool is deleted automatically when the last resource is removed from the pool.

Argument Type: Boolean

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>

Argument Type: String

orderingFilter

(Optional) A Javascript block invoked when scheduling resources for a pool. A Javascript block is not required unless you need to override the default resource ordering behavior.

Argument Type: String

resourceNames

(Optional) A list of resource names to add to the pool. This value does not need to refer to an existing resource. Any names that do not resolve to an existing resource will be skipped when assigning resources to steps.

Argument Type: Collection

resourcePoolDisabled

(Optional) < Boolean flag— 0|1|true|false > –If this is set to 1 or true, any runnable steps that refer to the pool will block until the pool is enabled again.

Argument Type: Boolean

Positional arguments

resourcePoolName

Response

Returns a resourcePool object.

ec-perl

syntax: $cmdr->createResourcePool(<resourcePoolName>, {<optionals>});

Example

$cmdr->createResourcePool ("Test Machines", {resourceName => ["Machine1", "Machine2"]});
▼

ectool

syntax: ` ectool createResourcePool <resourcePoolName> [optionals]`

Example

ectool createResourcePool "Test Machines" --resourceNames "Machine1" "Machine2
▼

Back to top

deleteResource

Deletes a resource.

You must enter a resourceName.

Arguments Descriptions

resourceName

Name of the resource that must be unique among all resources.

Argument Type: String

Positional arguments

resourceName

Response

None or a status OK message.

ec-perl

syntax: $cmdr->deleteResource(<resourceName>);

Example

$cmdr->deleteResource("Tester 1");
▼

ectool

syntax: ectool deleteResource <resourceName>

Example

ectool deleteResource "Tester 1"
▼

Back to top

deleteResourcePool

Deletes a resource pool.

You must enter a resourcePoolName.

Arguments Descriptions

resourcePoolName

Name for the resource pool that must be unique among all resource pools. A resource pool contains one or more resources.

Argument Type: String

Positional arguments

resourcePoolName

Response

None or a status OK message.

ec-perl

syntax: $cmdr->deleteResourcePool(<resourcePoolName>);

Example

$cmdr->deleteResourcePool("Test Suite 1");
▼

ectool

syntax: ectool deleteResourcePool <resourcePoolName>

Example

ectool deleteResourcePool "Test Suite 1"
▼

Back to top

getResource

Retrieves a resource by its name.

You must specify resourceName.

Arguments Descriptions

resourceName

Name for the resource that must be unique among all resources.

Argument Type: String

Positional arguments

resourceName

Response

One resource element, which includes the resource ID, name, agent state, time created, host name, owner, port, disabled flag, shell, step limit, workspace name, and so on. If using zones and gateways, `getResource ` returns a list of gateways where this resource participates.

ec-perl

syntax: $cmdr->getResource(<resourceName>);

Example

$cmdr->getResource("Test Resource 1");
▼

ectool

syntax: ectool getResource <resourceName>

Example

ectool getResource "Test Resource 1"
▼

Back to top

getResources

Retrieves all resources.

Arguments Descriptions

None

–

Positional arguments

None

Response

Zero or more resource elements.

ec-perl

syntax: $cmdr->getResources();

Example

$cmdr->getResources();
▼

ectool

syntax: ectool getResources

Example

ectool getResources
▼

Back to top

getResourcesInEnvironmentTier

Retrieves the list of resources in an environment tier.

You must specify the projectName, environmentName and environmentTierName.

Arguments Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

environmentName

Name of the environment that must be unique among all projects.

Argument Type: String

environmentTierName

Name for the environment tier that must be unique among all tiers for the environment.

Argument Type: String

Positional arguments

projectName, environmentName, environmentTierName

Response

Retrieves zero or more resource elements in the specified environment tier.

ec-perl

Syntax:

$<object>->getResourcesInEnvironmentTier(<projectName>, <environmentName>, <environmentTierName>);
▼

Example:

$ec->getResourcesInEnvironmentTier("Default", "PROD", "Tomcat");
▼

ectool

Syntax:

getResourcesInEnvironmentTier <projectName> <environmentName> <environmentTierName>
▼

Example:

ectool getResourcesInEnvironmentTier "Default" "PROD" "Tomcat"
▼

Back to top

getResourcesInPool

Retrieves a list of resources in a pool.

You must specify a resourcePoolName.

Arguments Descriptions

resourcePoolName

The name of a resource pool containing one or more resources.

Argument Type: String

jobStepId

(Optional) The unique CloudBees Flow-generated identifier (a UUID) for a job step that is assigned automatically when the job step is created. This is UUID of the job step related to this pool.

Argument type: UUID

Positional arguments

resourcePoolName

Response

An XML stream containing zero or more resource elements.

ec-perl

syntax: $cmdr->getResourcesInPool(<resourcePoolName>, {<optionals>});

Example

$cmdr->getResourcesInPool("Windows Pool");
▼

ectool

syntax: ectool getResourcesInPool <resourcePoolName> [optionals]

Example

ectool getResourcesInPool "Windows Pool"
▼

Back to top

getResourcePool

Retrieves a specified resource pool by name.

You must specify a resourcePoolName.

Arguments Descriptions

resourcePoolName

Name for the resource pool that must be unique among all resource pools.

Argument Type: String

Positional arguments

resourcePoolName

Response

An XML stream containing one resourcePool element.

ec-perl

syntax: $cmdr->getResourcePool(<resourcePoolName>);

Example

$cmdr->getResourcePool("Windows Pool");
▼

ectool

syntax: ectool getResourcePool <resourcePoolName>

Example

ectool getResourcePool "Windows Pool"
▼

Back to top

getResourcePools

Retrieves a list of resource pools.

Arguments Descriptions

None

–

Positional arguments

None

Response

An XML stream containing zero or more resourcePool elements.

ec-perl

syntax: $cmdr->getResourcePools;

Example

$cmdr->getResourcePools;
▼

ectool

syntax: ectool getResourcePools

Example

ectool getResourcePools
▼

Back to top

getResourceUsage

Retrieves resource usage information.

Arguments Descriptions

None

–

Positional arguments

None

Response

An XML stream containing zero or more resourceUsage elements.

ec-perl

syntax: $cmdr->getResourceUsage;

Example

$cmdr->getResourceUsage;
▼

ectool

syntax: ectool getResourceUsage

Example

ectool getResourceUsage
▼

Back to top

modifyResource

Modifies an existing resource. For a proxy resource, the proxyHostName and proxyPort arguments refer to the proxying CloudBees Flow agent. The hostName and port arguments refer to the proxy target.

You must specify a resourceName.

Arguments Descriptions

resourceName

Name for the resource that must be unique among all resources.

Argument Type: String

artifactCacheDirectory

(Optional) The directory on the agent host where retrieved artifacts are stored.

Argument Type: String

block

(Optional) < Boolean flag— 0|1|true|false >

A newly modified resource will be pinged. This argument makes the modifyResource call "block" until the result of the ping is known. The default is "false".

Argument Type: Boolean

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>

Argument Type: String

hostName

(Optional) The name or IP address for the CloudBees Flow machine containing the agent for this resource.

Argument Type: String

hostType

(Optional) Type of the host: CONCURRENT or REGISTERED

  • If the license on the server is a concurrent resource license, hostType defaults to CONCURRENT.

  • If the license on the server is a registered host license, hostType defaults to REGISTERED.

  • If the license on the server is a mixed-mode license (concurrent resources and registered hosts), you must specify the host type, CONCURRENT or REGISTERED.

Argument Type: String

newName

(Optional) New name of an existing resource.

Argument Type: String

pools

(Optional) A space-separated list of one or more pool names where this resource is a member. Steps defined to run on a resource pool will run on any available member (resource) in the pool.

Argument Type: String

This argument is deprecated and is replaced by the resourcePools argument.

port

(Optional) The port number for the CloudBees Flow agent. Default is to the default agent port, but you can change this port number because of port conflicts or multiple agents running on the same machine.

Argument Type: Integer

proxyCustomization

(Optional) Customized Perl code specifying how the proxy resource communicates with the proxy target. This applies only to proxy resources.

Argument Type: String

proxyHostName

(Optional) The IP address of the computer containing the CloudBees Flow Agent used for a proxy resource.

Argument Type: String

proxyPort

(Optional) The CloudBees Flow agent port number for a proxy resource. See the port argument for more details.

Argument Type: Integer

proxyProtocol

(Optional) Protocol for communicating with the proxy target. Defaults to ssh. This argument is not exposed in the CloudBees Flow UI at this time.

Argument Type: String

repositoryNames

(Optional) A list of repository names with each repository name listed on a "new line".

Argument Type: String

resourceDisabled

< Boolean flag— 0|1|true|false > If this is set to 1 or true, CloudBees Flow will not start new steps on this resource.

Argument Type: String

resourcePools

(Optional) A comma-separated list of one or more pool names where this resource is a member. Spaces and commas in pool names are allowed. Steps defined to run on a resource pool will run on any available member (resource) in the pool.

Argument Type: String

This argument replaces the pools argument.

To create one pool with a space in its name:

--resourcePools "Test Pool"
▼

To create multiple pools with spaces in their names:

--resourcePools "Test Pool One, Test Pool Two"
▼

To create a pool with a comma in its name:

--resourcePools "[Test Pool, One]"
▼

shell

(Optional) This sets a default shell for running step commands on this resource. The default is "cmd /q /c" for a Windows agent and "sh -e" for a UNIX agent.

Argument Type: String

stepLimit

(Optional) This limits the number of steps that can be running on the resource at one time. Setting this value to 1 is a good way to enforce serial access to the resource.

Argument Type: String

trusted

(Optional) < Boolean flag— 0|1|true|false > If this is set to 1 or true, the resource is trusted . Agents can be either trusted or untrusted :

  • trusted—The CloudBees Flow server verifies the agent’s identity using SSL certificate verification.

  • untrusted—The CloudBees Flow server does not verify agent identity. An untrusted agent could be a security risk.

Argument Type: Boolean

useSSL

(Optional) < Boolean flag — 0|1|true|false > Use this flag to define whether or not SSL is used for server-agent communication, or if you need to use SSL to communicate with your Active Directory servers. The default is 1 or true.

Transport Layer Security (TLS) has replaced Secure Sockets Layer version 3.0 (SSLv3) on the CloudBees Flow web server and the CloudBees Flow server.

Argument Type: Boolean

workspaceName

(Optional) Name of the default workspace where job output is stored.

Argument Type: String

zoneName

(Optional) Name of the zone where this resource resides, which must be unique among all zones.

Argument Type: String

Positional arguments

resourceName

Response

Returns a modified resource object.

ec-perl

syntax: $cmdr->modifyResource(<resourceName>, {<optionals>});

Example

$cmdr->modifyResource("Test Resource 1", {stepLimit => 5, shell => "bash"});
▼

ectool

syntax: ectool modifyResource <resourceName> [optionals]

Example

ectool modifyResource "Test Resource 1" --stepLimit 5 --shell "bash"
▼

Back to top

modifyResourcePool

Modifies an existing resource pool.

You must specify a resourcePoolName.

Arguments Descriptions

resourcePoolName

Name for the resource pool that must be unique among all resource pools. A resource pool contains one or more resources.

Argument Type: String

autoDelete

(Optional) < Boolean flag— 0|1|true|false >

If this is set to 1 or true, the resource pool will be deleted automatically when the last resource is removed form the pool.

Argument Type: Boolean

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>

Argument Type: String

newName

(Optional) Any new unique name for this resource pool.

Argument Type: String

orderingFilter

(Optional) A Javascript block invoked when scheduling resources for a pool. A Javascript block is not required unless you need to override the default resource ordering behavior.

Argument Type: String

resourceNames

(Optional) A list of resource names to add to the pool. This value does not need to refer to an existing resource. Any names that do not resolve to an existing resource will be skipped when assigning resources to steps.

Argument Type: Collection

resourcePoolDisabled

(Optional) < Boolean flag— 0|1|true|false >

If this is set 1 or true, any runnable steps that refer to the pool will block until the pool is enabled again.

Argument Type: Boolean

Positional arguments

resourcePoolName

Response

Returns the modified resourcePool object.

ec-perl

syntax: $cmdr->modifyResourcePool(<resourcePoolName>, {<optionals>});

Example

$cmdr->modifyResourcePool("Windows Pool", {resourcePoolDisabled => 1});
▼

ectool

syntax: ectool modifyResourcePool <resourcePoolName> [optionals]

Example

ectool modifyResourcePool "Windows Pool" --resourcePoolDisabled 1
▼

Back to top

pingAllResources

Pings all resources.

Arguments Description

block

(Optional) < Boolean flag — 0|1|true|false >

The default value= "0" ( false ), which means the call will return immediately. If you want the call to wait for responses from every resource before returning, use the value of "1" (true).

Argument Type: Boolean

Positional arguments

None

Response

None or a status OK message.

ec-perl

syntax: $cmdr->pingAllResources ({<optionals>});

Example

$cmdr->pingAllResources();
▼

ectool

syntax: ectool pingAllResources [optionals]

Example

ectool pingAllResources
▼

Back to top

pingResource

Pings the specified resource.

You must specify the resourceName.

Arguments Descriptions

resourceName

Name for the resource that must be unique among all resources.

Argument Type: String

Positional arguments

resourceName

Response

None or a status OK message.

ec-perl

syntax: $cmdr->pingResource(<resourceName>);

Example

$cmdr->pingResource("Test Resource 1");
▼

ectool

syntax: ectool pingResource <resourceName>

Example

ectool pingResource "Test Resource 1"
▼

Back to top

removeResourceFromEnvironmentTier

Removes a resource from the specified environment tier.

You must specify the resourceName, projectName, environmentName. and environmentTierName.

Arguments Descriptions

resourceName

Name for the resource that must be unique among all resources.

Argument Type: String

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

environmentName

Name of the environment that must be unique among all projects.

Argument Type: String

environmentTierName

Name for the environment tier that must be unique among all tiers for the environment.

Argument Type: String

Response

Removes the resource from an environment tier.

ec-perl

Syntax:

$<object>->removeResourceFromEnvironmentTier(<resourceName>, <projectName>,  <environmentName>, <environmentTierName>);
▼

Example:

$ec->removeResourceFromEnvironmentTier("Web server", "Default", "QA", "Tomcat");
▼

ectool

Syntax:

removeResourceFromEnvironmentTier <resourceName> <projectName>  <environmentName> <environmentTierName>
▼

Example:

ectool removeResourceFromEnvironmentTier "Web server" "Default" "QA" "Tomcat"
▼

Back to top

removeResourcesFromPool

Removes resources from the specified resource pool.

You must specify a resourcePoolName.

Arguments Descriptions

resourcePoolName

Name for the resource pool that must be unique among all resource pools.

Argument Type: String

resourceNames

(Optional) The list of resources to remove from this pool.

Argument Type: Collection

Positional arguments

resourcePoolName

Response

Removes the selected resources from the resource pool.

ec-perl

syntax: $<object>->removeResourcesFromPool(<resourcePoolName>, {<optionals>});

Example

$ec->removeResourcesFromPool("Test machines", {resourceNames => ["Tester 1", "Tester 2", "Tester3"]});
▼

ectool

syntax: ectool removeResourcesFromPool <resourcePoolName> (optionals)

Example

ectool removeResourcesFromPool "Test machines" --resourceNames "Tester 1" "Tester 2" "Tester 3"
▼

Back to top

runDiscovery

Runs the Discover procedure in a plugin to discover contents of a list or set of resources, and store settings for them in the ec_discovery property sheets.

You must specify the pluginKey, pluginName, projectName, environmentName, environmentTierName, configurationName.

Arguments Descriptions

pluginKey

The version independent name of the plugin.

Argument type: String

pluginName

The name of the plugin.

Argument type: String

projectName

The name of the project.

Argument type: String

environmentName

The name of the environment.

Argument type: String

environmentTierName

The name of the environment tier.

Argument type: String

configurationName

The name of the plugin configuration.

Argument type: String

resourceNames

(Optional) List of resources to use for discovery..

Argument type: Collection

Positional arguments

pluginKey, pluginName, projectName, environmentName, environmentTierName, configurationName

Response

None or a status OK message.

ec-perl

syntax: $<object>->runDiscovery(<pluginKey>, <pluginName>, <projectName>, <environmentName>, <environmentTierName>, <configurationName>, {<optionals>});

Example

$ec->runDiscovery("EC-OpenStack", "OpenStack", "Default", "PROD", "DB server", "SQLconfig",
{resourceNames => DB1 DB3 DB7});
▼

ectool

syntax: ectool runDiscovery <pluginKey> <pluginName> <projectName> <environmentName> <environmentTierName> <configurationName> [optionals]

Example

ectool runDiscovery "EC-OpenStack" "OpenStack" "Default" "PROD" "DB server" "SQLconfig" --resourceNames DB1 DB3 DB7}
▼

Back to top

signCertificate

Signs an agent certificate.

Arguments Descriptions

certificateData

A Privacy Enhanced Mail (PEM) encoded certificate signing request.

Argument Type: String

Positional arguments

certificateData

Response

None or a status OK message.

ec-perl

syntax: $cmdr->signCertificate (<certificateData>);

Example

$cmdr->signCertificate ("MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD");
▼

ectool

syntax: ectool signCertificate <certificateData>

Example

ectool signCertificate "MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD"
▼

Back to top

Property Management
Rolling Deploy