Gateway

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.

Arguments

Argument Name	Type	Description
gatewayName	String	(Required) The gateway name.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
gatewayDisabled	Boolean	True means this artifact repository is disabled.
hostName1	String	The domain name or IP address resourceName2 uses to send messages to resourceName1.
hostName2	String	The domain name or IP address resourceName1 uses to send messages to resourceName2.
port1	Integer	Port number resourceName2 uses to send messages to resourceName1.
port2	Integer	Port number resourceName1 uses to send messages to resourceName2.
resourceName1	String	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	String	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.

Argument Name

Type

Description

gatewayName

String

(Required) The gateway name.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

gatewayDisabled

Boolean

True means this artifact repository is disabled.

hostName1

String

The domain name or IP address resourceName2 uses to send messages to resourceName1.

hostName2

String

The domain name or IP address resourceName1 uses to send messages to resourceName2.

port1

Integer

Port number resourceName2 uses to send messages to resourceName1.

port2

Integer

Port number resourceName1 uses to send messages to resourceName2.

resourceName1

String

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

String

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.

Positional arguments

gatewayName

Usage

ec-perl

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

ectool

ectool createGateway gatewayName, [optionals]▼

deleteGateway

Deletes a gateway.

Arguments

Argument Name	Type	Description
gatewayName	String	(Required) The gateway name.

Argument Name

Type

Description

gatewayName

String

(Required) The gateway name.

Positional arguments

gatewayName

Usage

ec-perl

$cmdr->deleteGateway(<gatewayName>);▼

ectool

ectool deleteGateway gatewayName▼

getGateway

Finds a gateway by name.

Arguments

Argument Name	Type	Description
gatewayName	String	(Required) The gateway name.

Argument Name

Type

Description

gatewayName

String

(Required) The gateway name.

Positional arguments

gatewayName

Usage

ec-perl

$cmdr->getGateway(<gatewayName>);▼

ectool

ectool getGateway gatewayName▼

getGateways

Retrieves all gateways.

Arguments

None.

Positional arguments

None.

Usage

ec-perl

$cmdr->getGateways();▼

ectool

ectool getGateways▼

modifyGateway

Modifies an existing gateway.

Arguments

Argument Name	Type	Description
gatewayName	String	(Required) The gateway name.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
gatewayDisabled	Boolean	True means this artifact repository is disabled.
hostName1	String	The domain name or IP address resourceName2 uses to send messages to resourceName1.
hostName2	String	The domain name or IP address resourceName1 uses to send messages to resourceName2.
newName	String	The new name for an existing object that is being renamed.
port1	Integer	Port number resourceName2 uses to send messages to resourceName1.
port2	Integer	Port number resourceName1 uses to send messages to resourceName2.
resourceName1	String	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	String	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.

Argument Name

Type

Description

gatewayName

String

(Required) The gateway name.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

gatewayDisabled

Boolean

True means this artifact repository is disabled.

hostName1

String

The domain name or IP address resourceName2 uses to send messages to resourceName1.

hostName2

String

The domain name or IP address resourceName1 uses to send messages to resourceName2.

newName

String

The new name for an existing object that is being renamed.

port1

Integer

Port number resourceName2 uses to send messages to resourceName1.

port2

Integer

Port number resourceName1 uses to send messages to resourceName2.

resourceName1

String

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

String

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.

Positional arguments

gatewayName

Usage

ec-perl

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

ectool

ectool modifyGateway gatewayName, [optionals]▼