Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

getServerStatus

Back to index

Summary

Retrieves the current status of the CloudBees CD/RO server, including log messages generated during the startup sequence.
block
Booleanoptional
True means wait until the server reaches a new state.
diagnostics
Booleanoptional
True to include server diagnostics.
serverStateOnly
Booleanoptional
The response includes only the serverState element.
timeout
Integeroptional
How many seconds before the blocking command times out.

Usage

Perl

$cmdr->getServerStatus(
  # optionals
);
▼

ectool

ectool getServerStatus \
  # optionals
▼

Examples

Perl

$cmdr->getServerStatus();
$cmdr->getServerStatus({diagnostics=>1});
▼

ectool

ectool getServerStatus
ectool getServerStatus --diagnostics 1
▼