modifyResourcePool

Back to index

Summary

Modifies an existing resource pool.
resourcePoolName
Stringrequired
Name for the resource pool; must be unique among all resource pools.
autoDelete
Booleanoptional
If true, the pool is deleted when the last resource is deleted.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
newName
Stringoptional
The new name for an existing object that is being renamed.
orderingFilter
Stringoptional
JavaScript fragment that returns custom ordering of resources in a pool.
resourceName
Arrayoptional
List of resources to add/remove from the pool.
resourcePoolDisabled
Booleanoptional
True means the resourcePool will not be allocated to job steps.

Usage

Perl

$cmdr->modifyResourcePool( "test-resourcePoolName" # resourcePoolName # optionals );

ectool

ectool modifyResourcePool \ "test-resourcePoolName" `# resourcePoolName` \ # optionals

Examples

Perl

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

ectool

ectool modifyResourcePool "Windows Pool" --resourcePoolDisabled 1