Transit Gateway CLI

Command options

GATEWAY_ID

ID of the gateway you want details for.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

Request details for gateway.

ibmcloud tg gw $gateway

Command options

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Other commands require a gateway ID. Save the ID as an environment variable so you can use it later, for example:

gateway="bdf8fa2b-c518-9999-9028-f3c9ece86159"

Command options

--name

Name for the new gateway.

--location

Location of the gateway (see possible values by using ibmcloud tg locations)

--routing

Gateway routing of resources (global | local). Select global to connect resources across regions. The default value is local.

--resource-group-id

Optional: Gateway resource group ID. Uses default resource group, if not specified.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

Create a gateway that is named myGateway in us-south with local routing and that uses default resource group.

ibmcloud tg gwc --name myGateway --location us-south

Command options

GATEWAY_ID

ID of the gateway you want to delete.

--force | -f

Optional: Force the delete without confirmation.

--help | -h

Optional: Get help on this command.

Example

Delete gateway with no confirmation.

ibmcloud tg gwd $gateway -f

Command options

GATEWAY_ID

ID of the gateway you want to update.

--name

Optional: New name of the gateway.

--routing

Optional: Gateway routing of resources (global | local). Select global to connect resources across regions. Changing routing from global to local requires all existing connections to be local.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

Update the gateway with a routing value of global.

ibmcloud tg gwu $gateway --routing global

Command options

GATEWAY_ID

ID of the gateway the connection is on.

CONNECTION_ID

ID of the connection you want details for.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

Request details for a specific connection ID.

ibmcloud tg c $gateway $connection

Command options

GATEWAY_ID

ID of the gateway you want connections for.

--all-pages (Select availability at this time)

Lists all connections regardless of whether a --limit size is specified.

--limit (Select availability at this time)

The maximum number of resources to return per page. The default limit is 100. Possible values: 1 ≤ value ≤ 500

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

List the connections on the gateway.

ibmcloud tg cs $gateway

Other commands require a connection ID. Save the ID as an environment variable so you can use it later, for example:

connection="4892849f-368e-9999-bb58-8888fb21e513"

Command options

GATEWAY_ID

ID of the gateway that the new connection is on.

--name

Name for the new connection.

--network-type

Network type of the connection. Values are classic, vpc, directlink, or power_virtual_server.

--network-id

ID of the network connection. For classic, do not set a value. Use the CRN for all other network types. For example, to find the CRN of a VPC:

ibmcloud is vpc VPC_ID --json

--network-account-id

ID of the IBM Cloud account to use for creating a classic connection. Only used with classic type, when the account of the connection is different than the gateway's account.

--default-prefix-filter

Optional: Default prefix filter of the connection (permit | deny).

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

Create a VPC connection that is named vpc-connection and uses vpcCRN="crn:v1:bluemix:public:is:us-south:a/3aa0a9999a1a46258064d84f7f447920::vpc:r134-f87014d5-87d2-46d1-9999-24683082f6bc"

ibmcloud tg cc $gateway --name vpc-connection --network-id $vpcCRN --network-type vpc

Create a Classic connection named classic-conn.

ibmcloud tg cc $gateway --name classic-conn --network-type classic

Command options

GATEWAY_ID

ID of the gateway of the connection that is being deleted.

CONNECTION_ID

ID of the connection that is being deleted.

--force | -f

Optional: Force the delete without confirmation.

--help | -h

Optional: Get help on this command.

Example

Delete connection without confirmation.

ibmcloud tg cd $gateway $connection -f

Command options

GATEWAY_ID ID of the gateway where the new connection is bound.

--name

Name of the new GRE connection.

--zone

Availability zone for the GRE tunnel. Example: us-south-1

--local-gateway-ip

Local gateway IP address for the GRE tunnel connection.

--local-tunnel-ip

Local tunnel IP address for the GRE tunnel connection.

--remote-gateway-ip

Remote gateway IP address for the GRE tunnel connection.

--remote-tunnel-ip

Remote tunnel IP address for the GRE tunnel connection.

--base-connection-id

Optional: ID of the classic network connection that is the underlay for the GRE tunnel. This option is for use only with the gre_tunnel network type.

--base-network-type

Network type of the base connection (classic).

--network-type

Optional: Network type of the GRE connection. The default value is gre_tunnel.

--network-account-id

Optional: ID of account to connect to a classic connection. Use only with classic type when the account of the connection is different than gateway's account.

--remote-bgp-asn

Optional: If the remote BGP ASN is not specified, one is generated.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Examples

Create a GRE tunnel connection that is named gre-connection and uses classic connection 9037f710-8dfb-4948-a2bd-847c8dde96d3 as the base connection.

ibmcloud tg connection-create-gre $gateway --name gre-connection --base-connection-id 9037f710-8dfb-9999-a2bd-847c8dde96d3  --zone us-south-2 --local-gateway-ip 192.168.100.1 --local-tunnel-ip 192.168.101.1 --remote-gateway-ip 10.242.63.12 --remote-tunnel-ip 192.168.101.2

Command options

GATEWAY_ID

ID of the gateway the connection is on.

CONNECTION_ID

ID of the connection you are approving.

--help | -h

Optional: Get help on this command.

Example

Approve the connection request.

ibmcloud tg ca $gateway $connection

Command options

GATEWAY_ID

ID of the gateway where the new connection is bound.

--name

Name of the new GRE connection.

--zone

Availability zone for the GRE tunnel. Example: us-south-1

--local-gateway-ip

Local gateway IP address for the GRE tunnel connection.

--local-tunnel-ip

Local tunnel IP address for the GRE tunnel connection.

--remote-gateway-ip

Remote gateway IP address for the GRE tunnel connection.

--remote-tunnel-ip

Remote tunnel IP address for the GRE tunnel connection.

--base-connection-id

Optional: ID of the classic network connection that is the underlay for the GRE tunnel. This option is for use only with the gre_tunnel network type.

--base-network-type

Optional: Network type of the base connection (classic).

--network-type

Optional: Network type of the GRE connection. Values are gre_tunnel or unbound_gre_tunnel. The default value is gre_tunnel.

--network-account-id

Optional: ID of account to connect to a classic connection. Use only with classic type when the account of the connection is different than gateway's account.

--remote-bgp-asn

Optional: If the remote BGP ASN is not specified, one is generated.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Examples

Create a GRE tunnel connection that is named gre-connection and uses classic connection 9037f710-8dfb-4948-a2bd-847c8dde96d3 as the base connection.

ibmcloud tg connection-gre-create $gateway --name gre-connection --base-connection-id 9037f710-8dfb-9999-a2bd-847c8dde96d3  --zone us-south-2 --local-gateway-ip 192.168.100.1 --local-tunnel-ip 192.168.101.1 --remote-gateway-ip 10.242.63.12 --remote-tunnel-ip 192.168.101.2

Command options

GATEWAY_ID

ID of the gateway the connection is on.

CONNECTION_ID

ID of the connection you are rejecting.

--help | -h

Optional: Get help on this command.

Example

Reject the connection request.

ibmcloud tg cr $gateway $connection

JSON file

{
    "gateway_id": "47f11b01-471c-47d0-9e84-550c88c94055",
    "name": "redundant_gre1",
    "network_type": "redundant_gre",
    "base_network_type": "classic",
    "network_account_id": "28e4d90ac7504be694471ee66e70d0d5",
    "network_id": "crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b",
    "tunnels": [
       {
          "local_gateway_ip": "192.168.100.1",
          "local_tunnel_ip": "192.168.129.2",
          "name": "gre1",
          "remote_bgp_asn": "65010",
          "remote_gateway_ip": "10.242.63.12",
          "remote_tunnel_ip": "192.168.129.1",
          "zone": {
             "name": "us-south-1"
          }
       }, {
          "local_gateway_ip": "192.168.101.1",
          "local_tunnel_ip": "192.168.128.2",
          "name": "gre2",
          "remote_bgp_asn": "65010",
          "remote_gateway_ip": "10.242.63.12",
          "remote_tunnel_ip": "192.168.128.1",
          "zone": {
             "name": "us-south-1"
          }
       }
    ]
}

Command options

gateway_id

ID of the gateway that the new redundant GRE connection is on.

name

Name of the new redundant GRE connection.

network_type

Network type of the connection. Value is redundant_gre.

base_network_type The type of network to use. Options are classic and vpc.

network_account_id

ID of the IBM Cloud account to use for a cross-account classic network. Only used with classic type, when the account of the connection is different than the gateway's account. This option is not valid for the vpc base network type.

network_id

The CRN of the VPC network to use. This option is not valid for the classic base network type. For example, to find the CRN of a VPC:

ibmcloud is vpc VPC_ID --json

tunnels

Information for the GRE tunnels.

local_gateway_ip

Local gateway IP address for the GRE tunnel connection. This field is required for network type redundant_gre connections.

When using a vpc base network type, this IP address must comply with RFC 1918 and not be an IP address within the multicast range of 224.0.0.0 to 239.255.255.255 and cannot be in conflict with any existing networks that are connected to the transit gateway. Also, this IP address cannot be used as the local-gateway-ip for another GRE using the same underlay network.

local_tunnel_ip

Local tunnel IP address assigned to the Transit Gateway side of the tunnel. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses. This field is required for network type redundant_gre connections.

name

Name of the GRE tunnel.

remote_bgp_asn

Optional: If the remote BGP ASN is not specified, one is generated.

remote_gateway_ip

Remote gateway IP address for the GRE tunnel connection.

remote_tunnel_ip

Remote tunnel IP address for the GRE tunnel connection.

zone

Availability zone for the GRE tunnel. Example: us-south-1

Command options

GATEWAY_ID

ID of the gateway that the connection is being updated is on.

CONNECTION_ID

ID of the connection to update.

--name

New name of the connection.

--default-prefix-filter

Optional: Default prefix filter of the connection (permit | deny).

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

Update name of connection to MyConn2.

ibmcloud tg cu $gateway $connection --name MyConn2

Command options

GATEWAY_ID

ID of the gateway where the new connection is bound.

REDUNDANT_GRE_ID

ID of the redundant GRE connection.

--name

Name of the new GRE tunnel.

--zone

Availability zone for the GRE tunnel. Example: us-south-1

--local-gateway-ip

Local gateway IP address for the GRE tunnel connection.

--local-tunnel-ip

Local tunnel IP address for the GRE tunnel connection.

--remote-gateway-ip

Remote gateway IP address for the GRE tunnel connection.

--remote-tunnel-ip

Remote tunnel IP address for the GRE tunnel connection.

--remote-bgp-asn

Optional: If the remote BGP ASN is not specified, one is generated.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

ibmcloud tg redundant-gre-tunnel-add e47d6b9c-095f-4d31-aa47-5c89c2ded820 e4e37e31-8895-4594-be6b-61e8088b53c7 --name gre-tunnel3  --zone us-south-3 --local-gateway-ip 192.193.202.1 --local-tunnel-ip 192.193.237.2 -ibmcloud login -a https://test.cloud.ibm.com -r us-south --sso -remote-gateway-ip 10.186.203.5 --remote-tunnel-ip 192.193.237.1

Command options

GATEWAY_ID

ID of the gateway where the new connection is bound.

REDUNDANT_GRE_ID

ID of the redundant GRE connection.

TUNNEL_ID

ID of the tunnel to be deleted.

--force | -f

Optional: Force the delete without confirmation.

--help | -h

Optional: Get help on this command.

Example

ibmcloud tg redundant-gre-tunnel-remove e47d6b9c-095f-4d31-aa47-5c89c2ded820 e4e37e31-8895-4594-be6b-61e8088b53c7 b97a5cf5-7ee4-4073-b719-f6df36dea08f

Command options

GATEWAY_ID

ID of the gateway where the new connection is bound.

REDUNDANT_GRE_ID

ID of the redundant GRE connection.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--force | -f

Optional: Force the delete without confirmation.

--help | -h

Optional: Get help on this command.

Example

ibmcloud tg ts e47d6b9c-095f-4d31-aa47-5c89c2ded820 e4e37e31-8895-4594-be6b-61e8088b53c7

Command options

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Command options

NAME

Name of the location you want details for.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

Request details for location us-south.

ibmcloud tg location us-south

Command options

GATEWAY_ID

ID of the gateway the prefix filter is being applied to.

CONNECTION_ID

ID of the connection the prefix filter is being applied to.

--prefix

Network prefix that the filter is applied to.

--action

Action to take on the specified prefix (permit | deny).

--le

Optional: Prefix filter that is applied to a subnet mask less than or equal to this value.

--ge

Optional: Prefix filter that is applied to a subnet mask greater than or equal to this value.

--before

Optional: Identifier of the prefix filter this filter should be applied before. If empty, this filter is applied last.

--output

Optional: Specify output format; Only json is supported.

ibmcloud tg pfc 9f559c43-63f4-4da5-b312-b525a8dce185 6c1bdc19-4adb-4760-8cdc-ef3b74b626f7 --prefix 10.0.250.0/24 --action permit

Command options

GATEWAY_ID

ID of the gateway that the prefix filter is deleted from.

CONNECTION_ID

ID of the connection that the prefix filter is deleted from.

FILTER_ID

ID of the prefix filter being deleted.

--force, -f

Force the deletion operation without confirmation.

ibmcloud tg pfd 9f559c43-63f4-4da5-b312-b525a8dce185 6c1bdc19-4adb-4760-8cdc-ef3b74b626f7 b4dbe0a6-c52d-4128-cc32-6f53d86bc82b

Command options

GATEWAY_ID

ID of the gateway to list route reports for.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

List the route reports on the gateway.

ibmcloud tg rrs $gateway

Other commands require a route report ID. Save the ID as an environment variable so you can use it later, for example:

report="4892849f-368e-9999-4444-8888fb21e513"

Command options

GATEWAY_ID

ID of the gateway the route report is from.

REPORT_ID

ID of the route report you want details for.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

Request details for a route report.

ibmcloud tg rr $gateway $report

Command options

GATEWAY_ID

ID of the gateway the route report is created for.

--output json

Optional: Specify whether you want the output displayed in JSON format.

--help | -h

Optional: Get help on this command.

Example

Create a route report for a gateway.

ibmcloud tg rrc $gateway

Command options

GATEWAY_ID

ID of the gateway the report is for.

REPORT_ID

ID of the report you want to delete.

--force | -f

Optional: Force the delete without confirmation.

--help | -h

Optional: Get help on this command.

Example

Delete route report with no confirmation.

ibmcloud tg rrd $gateway $report -f