Utility resource

2 minute readReference

createUtilityResource

Creates a new utility resource.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

utilityResourceName

String

(Required) Name for utilityResource; must be unique among all utility resources for the environment or environment template.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentName

String

Name of parent environment.

environmentTemplateName

String

Name of parent environmentTemplate.

resourceName

String

The name of the default resource for this utility resource.

Positional arguments

projectName, utilityResourceName

Usage

ec-perl

$cmdr->createUtilityResource(<projectName>, <utilityResourceName>, {<optionals>});

ectool

ectool createUtilityResource projectName utilityResourceName [optionals]

deleteUtilityResource

Deletes a utility resource.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

utilityResourceName

String

(Required) Name for utilityResource; must be unique among all utility resources for the environment or environment template.

environmentName

String

Name of parent environment.

environmentTemplateName

String

Name of parent environmentTemplate.

Positional arguments

projectName, utilityResourceName

Usage

ec-perl

$cmdr->deleteUtilityResource(<projectName>, <utilityResourceName>, {<optionals>});

ectool

ectool deleteUtilityResource projectName utilityResourceName [optionals]

getUtilityResource

Retrieves a utility resource by name.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

utilityResourceName

String

(Required) Name for utilityResource; must be unique among all utility resources for the environment or environment template.

environmentName

String

Name of parent environment.

environmentTemplateName

String

Name of parent environmentTemplate.

Positional arguments

projectName, utilityResourceName

Usage

ec-perl

$cmdr->getUtilityResource(<projectName>, <utilityResourceName>, {<optionals>});

ectool

ectool getUtilityResource projectName utilityResourceName [optionals]

getUtilityResources

Retrieves all utility resources in an environment or environment template.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

Name of parent environment.

environmentTemplateName

String

Name of parent environmentTemplate.

Positional arguments

projectName

Usage

ec-perl

$cmdr->getUtilityResources(<projectName>, {<optionals>});

ectool

ectool getUtilityResources projectName [optionals]

modifyUtilityResource

Modifies a utility resource.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

utilityResourceName

String

(Required) Name for utilityResource; must be unique among all utility resources for the environment or environment template.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentName

String

Name of parent environment.

environmentTemplateName

String

Name of parent environmentTemplate.

newName

String

The new name for an existing object that is being renamed.

resourceName

String

The name of the default resource for this utility resource.

Positional arguments

projectName, utilityResourceName

Usage

ec-perl

$cmdr->modifyUtilityResource(<projectName>, <utilityResourceName>, {<optionals>});

ectool

ectool modifyUtilityResource projectName utilityResourceName [optionals]