modifyGateway

Back to index

Summary

Modifies an existing gateway.

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.

newName

Stringoptional

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

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->modifyGateway(
  "test-gatewayName" # gatewayName
  # optionals
);▼

ectool

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

Examples

Perl

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

ectool

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