Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

createGateway

Back to index

Summary

Creates a new gateway.

Example 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.

gatewayName
Stringrequired
The gateway name.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
gatewayDisabled
Booleanoptional
True means this artifact repository is disabled.
hostName1
Stringoptional
The domain name or IP address resourceName2 uses to send messages to resourceName1.
hostName2
Stringoptional
The domain name or IP address resourceName1 uses to send messages to resourceName2.
port1
Integeroptional
Port number resourceName2 uses to send messages to resourceName1.
port2
Integeroptional
Port number resourceName1 uses to send messages to resourceName2.
resourceName1
Stringoptional
The name of the first resource in a gateway specification. Other resources in this resource's zone forward messages through this resource to agents in resourceName2's zone.
resourceName2
Stringoptional
The name of the second resource in a gateway specification. Other resources in this resource's zone forward messages through this resource to agents in resourceName1's zone.

Usage

Perl

$cmdr->createGateway(
  "test-gatewayName" # gatewayName
  # optionals
);
▼

ectool

ectool createGateway \
  "test-gatewayName" `# gatewayName` \
  # optionals
▼

Examples

Perl

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

ectool

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