View VM properties

View virtual machines (VMs) that have been created within a project and see details associated with each, such as the ingress IP address, the egress IP address, and its status, such as Running.

Before you begin

To use gdcloud command-line interface (CLI) commands, ensure that you have downloaded, installed, and configured the gdcloud CLI. All commands for Distributed Cloud use the gdcloud or kubectl CLI, and require an operating system (OS) environment.

Get the kubeconfig file path

To run commands against the org admin cluster, ensure you have the following resources:

1. Locate the org admin cluster name, or ask your Platform Administrator (PA) what the cluster name is.

2. Sign in and generate the kubeconfig file for the org admin cluster if you don't have one.

3. Use the path to the kubeconfig file of the org admin cluster to replace ORG_ADMIN_KUBECONFIG in these instructions.

Request permissions and access

To perform the tasks listed in this page, you must have the Project VirtualMachine Admin role. Follow the steps to verify that you have the Project VirtualMachine Admin (project-vm-admin) role in the namespace of the project where the VM resides.

For VM operations using the GDC console or the gdcloud CLI, request your Project IAM Admin to assign you both the Project VirtualMachine Admin role and the Project Viewer (project-viewer) role.

Get a list of VMs

You can list the VMs available in a project by using the GDC console, gdcloud CLI, or kubectl.

gdcloud compute instances list --project PROJECT

kubectl --kubeconfig ORG_ADMIN_KUBECONFIG \
    get virtualmachines.virtualmachine.gdc.goog -n PROJECT

Locate IP addresses for a VM

See the IP addresses page for instructions on viewing the IP address information for a given VM.

View a VM source image

You can view the source image of a VM.

  DISK=`kubectl --kubeconfig ORG_ADMIN_KUBECONFIG get virtualmachines.virtualmachine.gdc.goog \
    -n PROJECT VM_NAME \
    -o jsonpath={.spec.disks[?(@.boot==true)].virtualMachineDiskRef.name}`

  kubectl --kubeconfig ORG_ADMIN_KUBECONFIG get virtualmachinedisk.virtualmachine.gdc.goog \
    -n PROJECT $DISK -o jsonpath={.spec.source.image.name}