Using the Perl API
IntroductionAccess tokensACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory provider managementDynamic environmentsEmail configuration managementEmail notifier managementEnvironmentEnvironment tierGateway and zone managementGet application environment inventoryInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementPlugin configuration managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementService accounts for webhooksServer managementSingle sign on for SAMLSnapshotsTier mapTrigger managementUser and group managementUser profile email managementWait dependenciesWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Gateway and Zone Management

5 minute readReference

createGateway

Creates a new gateway.

Scenario: You have two zones, ZoneA and ZoneB. ResourceA in ZoneA is accessible from ResourceB in ZoneB, and conversely—communication between specified gateway resources is enabled with host/port information recorded in each resource object. Other resources in each zone are restricted to talking to resources within their zone only. Creating a gateway between ResourceA and ResourceB to link the two zones enables resources from one zone to communicate with the other using ResourceA and ResourceB.

You must specify gatewayName.

Arguments Descriptions

gatewayName

The name of the gateway that must be unique among all gateway names.

Argument type: String

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

Argument type: String

gatewayDisabled

(Optional) < Boolean flag— 0|1|true|false >

If set to 1 or true, the gateway is disabled.

Argument type: Boolean

hostName1

(Optional) The domain name or IP of the agent where Resource1 resides. This host name is used by Resource2 to communicate with Resource1 . Do not specify this option is you want to use the host name from the Resource1 definition.

Argument type: String

hostName2

(Optional) The domain name or IP of the agent where Resource2 resides. This host name is used by Resource1 to communicate with Resource2 . Do not specify this option is you want to use the host name from the Resource2 definition.

Argument type: String

port1

(Optional) The port number used by Resource1 . The default is the port number used by the resource.

Argument type: Integer

port2

(Optional) The port number used by Resource2 . The default is the port number used by the resource.

Argument type: Integer

resourceName1

(Optional) Name of first resource in the gateway specification. Do not include spaces in the resource name.

Other resources in this resource’s zone forward messages through this resource to agents in the resourceName2 zone.

Argument type: String

resourceName2

(Optional) Name of second resource in the gateway specification. Do not include spaces in the resource name.

Other resources in this resource’s zone forward messages through this resource to agents in the resourceName1 zone.

Argument type: String

Positional arguments

gatewayName

Response

Returns a gateway object.

ec-perl

syntax: $cmdr->createGateway (<gatewayName>, {optionals>});

Example

$cmdr->createGateway ("AB_Gateway",{description => "Gateway linking ZoneA and ZoneB", resourceName1 => "ResourceA", resourceName2 => "ResourceB"});
▼

ectool

syntax: ectool createGateway <gatewayName> …​

Example

ectool createGateway AB_Gateway --description "Gateway linking ZoneA and ZoneB" --resourceName1 "ResourceA" --resourceName2 "ResourceB"
▼

deleteGateway

Deletes a gateway.

You must enter a gatewayName.

Arguments Descriptions

gatewayName

The name of the gateway to delete.

Argument type: String

Positional arguments

gatewayName

Response

None

ec-perl

syntax: $cmdr->deleteGateway (<gatewayName>);

Example

$cmdr->deleteGateway ("AB_Gateway");
▼

ectool

syntax: ectool deleteGateway <gatewayName>

Example

ectool deleteGateway "AB_Gateway"
▼

getGateway

Finds a gateway by name.

You must specify a gatewayName.

Arguments Descriptions

gatewayName

The name of the gateway.

Argument type: String

Positional arguments

gatewayName

Response

Returns one gateway element.

ec-perl

syntax: $cmdr->getGateway (<gatewayName>);

Example

$cmdr->getGateway ("AB_Gateway");
▼

ectool

syntax: ectool getGateway <gatewayName>

Example

ectool getGateway "AB_Gateway"
▼

getGateways

Retrieves all gateways.

Arguments Descriptions

None

–

Positional arguments

None.

Response

Returns one or more gateway elements.

ec-perl

syntax: $cmdr->getGateways();

Example

$cmdr->getGateways();
▼

ectool

syntax: ectool getGateways

Example

ectool getGateways
▼

modifyGateway

Modifies an existing gateway.

You must specify a gatewayName.

Arguments Descriptions

gatewayName

The name of the gateway.

Argument type: String

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

Argument type: String

gatewayDisabled

(Optional) < Boolean flag— 0|1|true|false >

If this is set to 1 or true, the gateway is disabled.

Argument type: Boolean

hostName1

(Optional) The domain name or IP address of the agent where Resource1 resides. This host name is used by Resource2 to communicate with Resource1 . Do not specify this option is you want to use the host name from the Resource1 definition.

Argument type: String

hostName2

(Optional) The domain name or IP address of the agent where Resource2 resides. This host name is used by Resource1 to communicate with Resource2 . Do not specify this option is you want to use the host name from the Resource2 definition.

Argument type: String

newName

(Optional) New name of the gateway.

Argument type: String

port1

(Optional) The port number used by Resource1 . The default is the port number used by the resource.

Argument type: Integer

port2

(Optional) The port number used by Resource2 . The default is the port number used by the resource.

Argument type: Integer

resourceName1

(Optional) Name of first resource in the gateway specification. Do not include spaces in the resource name.

Other resources in this resource’s zone forward messages through this resource to agents in the resourceName2 zone.

Argument type: String

resourceName2

(Optional) Name of second resource in the gateway specification. Do not include spaces in the resource name.

Other resources in this resource’s zone forward messages through this resource to agents in the resourceName1 zone.

Argument type: String

Positional arguments

gatewayName

Response

An updated gateway object.

ec-perl

syntax: $cmdr->modifyGateway (<gatewayName>, {<optionals>});

Example

$cmdr->modifyGateway ("AB_Gateway", {description=> "Gateway linking zoneA and zoneB", resourceName1=> "ResourceA", resourceName2=> "ResourceB"});,
▼

ectool

syntax: ectool modifyGateway <gatewayName> …​

Example

ectool modifyGateway "AB_Gateway" --description "Gateway linking ZoneA and ZoneB" --resourceName1 "ResourceA" --resourceName2 "ResourceB"
▼

createZone

Creates a new zone.

You must specify a zoneName.

Arguments Descriptions

zoneName

The unique name of the zone.

Argument type: String

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

Argument type: String

Positional arguments

zoneName

Response

Returns a zone object.

ec-perl

syntax: $cmdr->createZone (<zoneName>, {<optionals>});

Example

$cmdr->createZone("DevZone", {description => "Zone containing resources that the dev group uses."});
▼

ectool

syntax: ectool createZone <zoneName> [optionals]

Example

ectool createZone DevZone --description "Zone containing resources that the dev group uses."
▼

deleteZone

Deletes an existing zone.

You must specify a zoneName.

Arguments Descriptions

zoneName

The name of the zone to delete.

Argument type: String

Positional arguments

zoneName

Response

None

ec-perl

syntax: $cmdr->deleteZone (<zoneName>);

Example

$cmdr->deleteZone ("Dev Tests");
▼

ectool

syntax: ectool deleteZone <zoneName>

Example

ectool deleteZone "Dev Tests"
Back to Top
▼

getZone

Finds a zone by name.

You must specify a zoneName.

Arguments Descriptions

zoneName

The name of the zone.

Argument type: String

Positional arguments

zoneName

Response

Returns a zone element, including a list of resources belonging to the zone.

ec-perl

syntax: $cmdr->getZone (<zoneName>);

Example

$cmdr->getZone ("Dev Zone");
▼

ectool

syntax: ectool getZone <zoneName>

Example

ectool getZone "Dev Zone"
▼

getZones

Retrieves all zones.

Arguments Descriptions

None

–

Positional arguments

None

Response

Returns a zone object.

ec-perl

syntax: $cmdr->getZones();

Example

$cmdr->getZones();
▼

ectool

syntax: ectool getZones

Example

ectool getZones
▼

modifyZone

Modifies an existing zone.

You must specify a zoneName.

Arguments Descriptions

zoneName

The name of this zone.

Argument type: String

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

Argument type: String

newName

(Optional) New name of the zone.

Argument type: String

Positional arguments

zoneName

Response

Returns an updated zone element.

ec-perl

syntax: $cmdr->modifyZone (<zoneName>, {<optionals>});

Example

$cmdr->modifyZone ("DevZone", {description => "Zone containing resources that the dev group uses."});
▼

ectool

syntax: ectool modifyZone <zoneName> [optionals]

Example

ectool modifyZone "DevZone" --description "Zone containing resources that the dev group uses."
▼
Environment tier
Get application environment inventory