Viewing details of a cluster network

Cluster Networks for VPC is available for select customers only. Contact IBM Support if you are interested in using this functionality.

View details of your cluster network, such as its name, creation date, and CRN. You can also manage and create subnets and interfaces within the cluster network. For example, you can specify the subnet CIDR and define reserved IP addresses.

Before you begin

Review Planning considerations and Known issues and limitations.

You can view details of a cluster network with the UI, CLI, API, or Terraform.

Viewing details of a cluster network in the UI

To view details of a cluster network interface in the IBM Cloud console, follow these steps:

From your browser, open the IBM Cloud console and log in to your account.
Select the Navigation Menu , then click Infrastructure > Cluster networks.
In the Cluster networks for VPC table, locate the cluster network for which you want to view details, then click the name of that cluster network.
View the details of your cluster network in the Cluster network details section.

Viewing details of a cluster network in the CLI

To view the details of a cluster network in the CLI, follow these steps:

Set up your CLI environment.

Enable the following feature flag:

export IBMCLOUD_IS_FEATURE_CLUSTER_NETWORK=true

Log in to your account with the CLI. After you enter the password, the system prompts for the account and region that you want to use:
```
ibmcloud login --sso
```
To view details of a cluster network, enter the following command:
```
ibmcloud is cluster-network CLUSTER_NETWORK [--output JSON] [-q, --quiet]
```
Where:

CLUSTER_NETWORK

ID or name of the cluster network.

-output

Specify output format, only JSON is supported. One of: JSON.

-q, --quiet

Suppress verbose output.

Command examples

To view cluster network my-cl-net-2 by name:

ibmcloud is cl-net my-cl-net-2

To view cluster network my-cl-net-2 by ID:

ibmcloud is cl-net 7208-353ec740-c1b1-4778-b7a1-8c77a365e435

Viewing details of a cluster network with the API

To view details of a cluster network with the API, follow these steps:

Set up your API environment with the right variables.
Store any additional variables to be used in the API commands; for example:

version (string): The API version, in format YYYY-MM-DD.

When all variables are initiated, run the following command to view details of the cluster network:

curl -X POST "$vpc_api_endpoint/v1/cluster_networks/$cluster_network_id?version=$tomorrow&generation=2&maturity=development" -H "Authorization: Bearer $iam_token"

To view the complete set of cluster network APIs, see the VPC API reference.