modifyDashboard

Back to index

Summary

Modifies a dashboard.
projectName
Stringrequired
The name for the project that must be unique among all projects.
dashboardName
Stringrequired
Unique name of the dashboard within the project.
clearColumns
Booleanoptional
Whether or not to clear columns for the dashboard.
column
Arrayoptional
List of the columns to display for the dashboard of type COMMAND_CENTER.
customize
Booleanoptional
Set to true to create a custom copy of the out-of-the-box Release Command Center dashboard.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
layout
Stringoptional
Layout to use for adding the widgets to the dashboard.
Possible values: "FLOW"
newName
Stringoptional
The new name for an existing object that is being renamed.
type
Stringoptional
Type of the dashboard.
Possible values: "COMMAND_CENTER", "STANDARD"

Usage

Perl

$cmdr->modifyDashboard( "test-projectName", # projectName "test-dashboardName" # dashboardName # optionals );

ectool

ectool modifyDashboard \ "test-projectName" `# projectName` \ "test-dashboardName" `# dashboardName` \ # optionals

Examples

Perl

$cmdr->modifyDashboard("Default", "Executive Overview", {newName => "Weekly Overview"});

ectool

ectool modifyDashboard Default "Executive Overview" --newName "Weekly Overview"