Creating a dynamic route server in the console

To create a dynamic route server in the console, follow these steps:

1. From your browser, open the IBM Cloud console and log in to your account.
2. Select the Navigation menu , and then click Infrastructure > Network > Dynamic route servers.
3. On the Dynamic route servers for VPC page, click Create.
4. Specify the following information:
   • Location - Select the location where the dynamic route server is provisioned.
   • Name - Enter a name for the dynamic route server, such as my-dynamic-route-server.
   • Resource group - Select a resource group for the dynamic route server.
   • Tags - Optionally, add tags to identify this dynamic route server.
   • Access management tags - Optionally, add access management tags to resources to help organize access control relationships. The only supported format for access management tags is key:value. For more information, see Controlling access to resources by using tags.
   • Virtual private cloud - Select the VPC for the dynamic route server.
   • ASN - Enter an ASN value. An ASN is a numeric identifier for the dynamic route server, which identifies your local network for BGP peering and is used to set up a BGP session with other peers.
5. Create a dynamic route server member and click Create dynamic route server in the Summary panel.

Creating a dynamic route server from the CLI

To create a dynamic route server from the CLI, follow these steps:

1. Set up your CLI environment.

2. Log in to your CLI environment. After you enter the password, the system prompts which account and region that you want to use:

   ibmcloud login --sso
   

3. Enable the following feature flag:

   export IBMCLOUD_IS_FEATURE_DYNAMIC_ROUTE_SERVER=true
   

4. Run the following command:

   ibmcloud is dynamic-route-server-create --local-asn LOCAL_ASN (--members MEMBERS_JSON | @MEMBERS_JSON_FILE) [--name NAME] [--resource-group-id RESOURCE_GROUP_ID | --resource-group-name RESOURCE_GROUP_NAME] [--output JSON] [-q, --quiet]
   

Where:

--local-asn

The local autonomous system number (ASN).

--members

A JSON payload that defines the dynamic route server members. You can specify a minimum of one and a maximum of three members. For the data schema, see the members property in the API documentation.

@MEMBERS_JSON_FILE

A file that contains the members JSON payload.

--name

The name of the dynamic route server.

--resource-group-id

The ID of the resource group. This option is mutually exclusive with --resource-group-name.

--resource-group-name

The name of the resource group. This option is mutually exclusive with --resource-group-id.

--output

Output in JSON format.

-q, --quiet

Suppresses verbose output.

To create a dynamic route server member from the CLI, run the following command:

ibmcloud is dynamic-route-server-member-create DYNAMIC_ROUTE_SERVER (--vni VNI | (--vni-auto-delete true | false [--vni-psfm auto | enabled | disabled] --vni-name VNI_NAME [--vni-rip VNI_RIP | (--vni-rip-address VNI_RIP_ADDRESS --vni-rip-auto-delete true | false --vni-rip-name VNI_RIP_NAME)] --vni-subnet VNI_SUBNET [--vpc VPC] --vni-sgs VNI_SGS --vni-ais false | true --vni-ein true | false --vni-ips VNI_RESERVED_IPS_JSON | @VNI_RESERVED_IPS_JSON_FILE --resource-group-id RESOURCE_GROUP_ID | --resource-group-name RESOURCE_GROUP_NAME)) [--name NAME] [--output JSON] [-q, --quiet]

Where:

DYNAMIC_ROUTE_SERVER

The dynamic route server identifier.

--vni

The ID or name of the VNI.

--vni-auto-delete

Indicates whether the VNI is automatically deleted when its target is deleted. One of: true or false.

--vni-psfm

The protocol state filtering mode for the VNI. If auto, protocol state packet filtering is enabled or disabled based on the target resource type of the VNI. One of: auto, enabled, or disabled. The default is auto.

--vni-name

The name of the VNI.

--vni-rip

The ID or name of the reserved IP to bind to the VNI. Required if you don't specify a subnet.

--vni-rip-address

The IP address of the reserved IP to bind to the VNI. Requires a subnet.

--vni-rip-auto-delete

Indicates whether the reserved IP is automatically deleted when its target is deleted or when the reserved IP is unbound. One of: true or false.

--vni-rip-name

The name of the reserved IP to bind to the VNI.

--vni-subnet

The ID or name of the subnet. If you specify a name, use --vpc to specify the VPC for name resolution.

--vpc

The ID or name of the VPC. Required for subnet name resolution.

--vni-sgs

A comma-separated list of the IDs or names of the security groups for the VNI.

--vni-ais

Allow IP spoofing. Indicates whether source IP spoofing is allowed on the VNI. One of: false or true. The default is false.

--vni-ein

Enable infrastructure NAT. Indicates whether the VPC infrastructure performs any needed NAT operations. One of: true or false. The default is true.

--vni-ips

A JSON payload that defines the secondary reserved IP addresses to bind to the VNI.

@VNI_RESERVED_IPS_JSON_FILE

A file that contains the secondary reserved IP addresses JSON payload.

--resource-group-id

The ID of the resource group. This option is mutually exclusive with --resource-group-name.

--resource-group-name

The name of the resource group. This option is mutually exclusive with --resource-group-id.

--name

The name of the dynamic route server member.

--output

Output in JSON format.

-q, --quiet

Suppresses verbose output.

Creating a dynamic route server with the API

To create a dynamic route server with the API, follow these steps:

1. Set up your API environment with the required variables.

2. Store any additional variables to use in the API commands. For example:

   • ResourceGroupId - Find the resource group ID by using the get resource groups command and then populate the variable:

   export ResourceGroupId=<your_resourcegroup_id>
   

3. When all variables are set, create the dynamic route server:

   curl -X POST \
     "$vpc_api_endpoint/v1/dynamic_route_servers?version=$api_version&generation=2" \
     -H "Authorization: Bearer $iam_token" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "my-drs",
       "local_asn": 64514,
       "members": [
         {
           "name": "my-drs-member",
           "virtual_network_interfaces": [
             {
               "id": "VNI_ID"
             }
           ]
         }
       ],
       "resource_group": {
         "id": "abcd1234-5678"
       }
     }'