Check the status of a VPC spoke

When you propose a Virtual Private Cloud (VPC) spoke connection to a hub, the spoke is not fully operational until the hub administrator accepts the spoke. This page describes how you can check the status of a spoke after you have proposed it.

Before you begin

Before you get started, review the following sections.

Create or select a project

To make it easier to configure Network Connectivity Center, start by identifying a valid project.

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Install the Google Cloud CLI.

5. To initialize the gcloud CLI, run the following command:

   gcloud init

6. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

7. Make sure that billing is enabled for your Google Cloud project.

8. Install the Google Cloud CLI.

9. To initialize the gcloud CLI, run the following command:

   gcloud init

4. If you are using the Google Cloud CLI, set your project ID by using the gcloud config set command.

   gcloud config set project PROJECT_ID

   Replace PROJECT_ID with your unique project ID.

   The gcloud CLI instructions on this page assume that you have set your project ID.

5. To confirm that you set the project ID correctly, use the gcloud config list command.

   gcloud config list --format='text(core.project)'

Enable the Network Connectivity API

Before you can perform any tasks using Network Connectivity Center, you must enable the Network Connectivity API.

Console

To enable the Network Connectivity API, do the following:

1. In the Google Cloud console, go to the Network Connectivity Center page.

   Go to Network Connectivity Center

2. Click Enable.

Alternatively, you can enable the API by using the Google Cloud console API Library, as described in Enabling APIs.

Permissions required for this task

To perform this task, you must have been granted the following permissions or the following IAM roles.

Permissions

• networkconnectivity.spokes.get

Roles (one of the following)

• roles/networkconnectivity.hubAdmin
• roles/networkconnectivity.spokeAdmin
• roles/networkconnectivity.hubViewer

Spoke states

The following table describes the different states that a spoke might be in after it is proposed to the hub administrator.

Spoke state	State reason	Description
ACTIVE	The reasons field is empty.	This means that the hub administrator has accepted the spoke and the spoke is fully operational.
INACTIVE	PENDING_REVIEW	This means that the spoke is not operational, and that the hub administrator has not yet accepted or rejected the spoke.
INACTIVE	REJECTED	This means that the spoke is not operational because the hub administrator has rejected the spoke.
OBSOLETE	The reasons field is empty.	This means that the hub has been deleted. Once in this state, the state never changes, and the spoke can only be deleted.

Get the status of a spoke proposal

To get the status of a spoke that you have proposed in a different project from the hub, follow these steps.

gcloud

Run the gcloud network-connectivity spokes describe command.

gcloud network-connectivity spokes describe SPOKE_NAME \
    --global

Replace SPOKE_NAME with the name of the spoke for which you want to check the status, such as my-spoke.

API

To describe a spoke, use the networkconnectivity.spokes.get method.

 GET https://networkconnectivity.googleapis.com/v1/projects/PROJECT_ID/locations/global/spokes/SPOKE_NAME

Replace the following:

• PROJECT_ID: the project ID of the project that contains the spoke
• SPOKE_NAME: the name of the spoke for which you want to get status

What's next

• To create hubs and spokes, see Work with hubs and spokes.
• To view a list of partners whose solutions are integrated with Network Connectivity Center, see Network Connectivity Center partners.
• To find solutions for common issues, see Troubleshooting.
• To get details about API and gcloud commands, see APIs and reference.