modifyHook

Back to index

Summary

Modifies an existing hook in a resource template.
hookName
Stringrequired
Name for the hook; must be unique among all hooks.
broadcast
Booleanoptional
Broadcast flag.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
hookParameter
Arrayoptional
Hook parameters.
hookType
Stringoptional
Hook type.
Possible values: "POST_CONFIGURATION", "POST_PROVISIONING", "POST_TEARDOWN", "PRE_CONFIGURATION", "PRE_PROVISIONING", "PRE_TEARDOWN"
newName
Stringoptional
The new name for an existing object that is being renamed.
procedureName
Stringoptional
Hook procedure name.
procedurePluginKey
Stringoptional
Procedure plugin key.
procedureProjectName
Stringoptional
Procedure project name.
projectName
Stringoptional
ProjectName of the entity that owns the hook.
resourceTemplateName
Stringoptional
Name of the resource template.

Usage

Perl

$cmdr->modifyHook( "test-hookName" # hookName # optionals );

ectool

ectool modifyHook \ "test-hookName" `# hookName` \ # optionals

Examples

Perl

$cmdr->modifyHook("config", {newName => "prod_config"});

ectool

ectool modifyHook "config" --newName "prod_config"