Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

modifyProperty

Back to index

Summary

Modifies a regular string or nested property sheet using a combination of property path and context.

  • You must specify a propertyName.

  • The names properties and project are not valid property names.
propertyName
Stringrequired
Name for the property; must be unique within the property sheet.
applicationName
Stringoptional
The name of the application container of the property sheet that owns the property.
applicationTierName
Stringoptional
The name of the application tier container of the property sheet that owns the property.
archiveConnectorName
Stringoptional
The name of the archive connector of the property sheet that owns the property.
artifactName
Stringoptional
The name of the artifact container of the property sheet that owns the property.
artifactVersionName
Stringoptional
The name of the artifactVersion container of the property sheet that owns the property.
catalogItemRunId
Stringoptional
The primary key of the CatalogItemRun container of the property sheet that owns the property.
catalogName
Stringoptional
The name of the catalog of the property sheet that owns the property.
ciBuildDetailName
Stringoptional
The name of the CI build detail of the property sheet that owns the property.
clusterName
Stringoptional
The name of the cluster which owns property sheet.
componentName
Stringoptional
The name of the component container of the property sheet that owns the property.
configName
Stringoptional
The name of the emailConfig container that owns the property.
credentialName
Stringoptional
The name of the credential container of the property sheet that owns the property.
credentialProtected
Booleanoptional
If true, then permissions requiring modify privileges on the property sheet being manipulated will also require execute privileges on credentials attached to the property sheet owner.
dashboardName
Stringoptional
The name of the dashboard of the property sheet that owns the property.
dataRetentionPolicyName
Stringoptional
The name of the data retention policy of the property sheet that owns the property.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
environmentName
Stringoptional
The name of the environment container of the property sheet that owns the property.
environmentTemplateName
Stringoptional
The name of the environment template container of the property sheet that owns the property.
environmentTemplateTierName
Stringoptional
The name of the environment template tier container of the property sheet that owns the property.
environmentTierName
Stringoptional
The name of the environment tier container of the property sheet that owns the property.
expandable
Booleanoptional
Whether or not the property is recursively expandable.
extendedContextSearch
Booleanoptional
For simple property names, whether or not to search objects in the hierarchy to find the desired property.
flowName
Stringoptional
The name of the flow container of the property sheet that owns the property.
flowRuntimeId
Stringoptional
The primary key or name of the flowRuntime container of the property sheet that owns the property.
flowRuntimeName
Stringoptional
The name of the flow runtime container of the property sheet that owns the property.
flowRuntimeStateId
Stringoptional
The primary key or name of the flowRuntimeState container of the property sheet that owns the property.
flowRuntimeStateName
Stringoptional
The name of the flow state container of the property sheet that owns the property.
flowStateName
Stringoptional
The name of the flow state container of the property sheet that owns the property.
flowTransitionName
Stringoptional
The name of the flow transition container of the property sheet that owns the property.
gateType
Stringoptional
The type of the gate which owns property sheet.
Possible values: "POST", "PRE"
gatewayName
Stringoptional
The name of the gateway container of the property sheet.
groupName
Stringoptional
The name of the group container of the property sheet that owns the property.
initialValue
Stringoptional
An initial value for this property. If this property doesn't exist, the server creates it and sets this initial value. If the property already exists, its existing property value is not changed to this value.
jobId
Stringoptional
The primary key or name of the job container of the property sheet that owns the property.
jobStepId
UUIDoptional
The primary key of the job-step container of the property sheet that owns the property.
microserviceName
Stringoptional
The name of the microservice container of the property sheet.
newName
Stringoptional
The new name for an existing object that is being renamed.
notifierName
Stringoptional
The name of the notifier container of the property sheet that owns the property.
objectId
Stringoptional
The object ID as returned by FindObjects.
path
Stringoptional
Property path string.
pipelineName
Stringoptional
The name of the pipeline container of the property sheet that owns the property.
pluginConfigurationName
Stringoptional
The name of the plugin configuration container of the property sheet that owns the property.
pluginName
Stringoptional
The name of the plugin container of the property sheet that owns the property.
procedureName
Stringoptional
The name of the procedure container of the property sheet that owns the property.
processName
Stringoptional
The name of the process, if the container is a process or process step.
processStepName
Stringoptional
The name of the process step, if the container is a process step.
projectName
Stringoptional
The name of the project container of the property sheet that owns the property.
propertySheetId
UUIDoptional
The primary key of the property sheet that owns the property.
propertyType
Stringoptional
Type of property.
Possible values: "sheet", "string"
releaseName
Stringoptional
The name of the release container of the property sheet that owns the property.
reportName
Stringoptional
The name of the report of the property sheet that owns the property.
reportObjectTypeName
Stringoptional
The name of the report object type of the property sheet that owns the property.
repositoryName
Stringoptional
The name of the repository container of the property sheet that owns the property.
resourceName
Stringoptional
The name of the resource container of the property sheet that owns the property.
resourcePoolName
Stringoptional
The name of the resource pool container of the property sheet that owns the property.
resourceTemplateName
Stringoptional
The name of the resource template container of the property sheet that owns the property.
scheduleName
Stringoptional
The name of the schedule container of the property sheet.
scmSyncName
Stringoptional
The name of the SCM Sync container of the property sheet that owns the property.
searchFilterName
Stringoptional
The name of the search filter container of the property sheet.
serviceAccountName
Stringoptional
Retrieves the name of the service account container of the property sheet.
snapshotName
Stringoptional
The name of the snapshot container of the property sheet that owns the property.
stageName
Stringoptional
The name of the stage container of the property sheet that owns the property.
stateDefinitionName
Stringoptional
The name of the state definition container of the property sheet that owns the property.
stateName
Stringoptional
The name of the state container of the property sheet that owns the property.
stepName
Stringoptional
The name of the step container of the property sheet that owns the property.
suppressValueTracking
Booleanoptional
If true, then change tracking will ignore changes that only affect the value of the property, and exports of past states and force imports will preserve the current value.
systemObjectName
Stringoptional
The system object.
Possible values: "admin", "analyticsServerConfigurations", "archiveConnectors", "artifacts", "ciConfigurations", "ciEventsSchemaConfiguration", "ciJobDetails", "ciLoginHistory", "complianceConfiguration", "dataRetentionPolicies", "devOpsForesight", "devOpsInsightServerConfigurations", "directory", "dslClientFiles", "emailConfigs", "forceAbort", "licensing", "log", "personaCategories", "personaPages", "personas", "plugins", "priority", "projects", "reportObjectTypes", "repositories", "resources", "searchFilters", "server", "session", "ssoConfiguration", "ssoLoginHistory", "statsdConfiguration", "tags", "test", "workspaces", "zonesAndGateways"
taskName
Stringoptional
The name of the task which owns property sheet.
transitionDefinitionName
Stringoptional
The name of the transition definition container of the property sheet that owns the property.
transitionName
Stringoptional
The name of the transition container of the property sheet that owns the property.
triggerName
Stringoptional
The name of the trigger which owns property sheet.
userName
Stringoptional
The name of the user container of the property sheet that owns the property.
value
Stringoptional
The value of the property.
widgetName
Stringoptional
The name of the widget of the property sheet that owns the property.
workflowDefinitionName
Stringoptional
The name of the workflow definition container of the property sheet that owns the property.
workflowName
Stringoptional
The name of the workflow container of the property sheet that owns the property.
workspaceName
Stringoptional
The name of the workspace container of the property sheet.
zoneName
Stringoptional
The name of the zone container of the property sheet.

Usage

Perl

$cmdr->modifyProperty(
  "test-propertyName" # propertyName
  # optionals
);
▼

ectool

ectool modifyProperty \
  "test-propertyName" `# propertyName` \
  # optionals
▼

Examples

Perl

$cmdr->modifyProperty("Saved Variables", {description =>
     "Starting configuration of name/value pairs", jobId => 4fa765dd-73f1-11e3-b67e-b0a420524153});
▼

ectool

ectool modifyProperty "Saved Variables" --description "Starting configuration
    of name/value pairs" --jobId 4fa765dd-73f1-11e3-b67e-b0a420524153
▼