Getting Instance Information

Use this topic to learn how to get information about Cloud Filestore instances.

Before you begin

If you want to use the command-line examples in this topic, enable the gcloud command-line tool by installing the Cloud SDK.

Getting information about all instances

You can get information about your Cloud Filestore instances by going to the Cloud Filestore instances page or by using the following procedure.

1. Get a list of instances in a project by running the instances list command, replacing [VALUES_IN_BRACKETS] with the appropriate values:

   gcloud filestore instances list \
       --project=[PROJECT_ID] \
       --zone=[ZONE]
   

   where:

   • [PROJECT_ID] is the ID of the GCP project that contains the instance. You can skip this flag if you have set the gcloud default project and want to use that.
   • [ZONE] is the GCP zone for which you want to list Cloud Filestore instances. If you skip this flag, instances in all zones are returned. Run the gcloud filestore zones list command to get a list of supported zones.

Response

The response to the instances list command is similar to the following:

INSTANCE_NAME  ZONE            TIER      CAPACITY_GB  FILESHARE_NAME  IP_ADDRESS  STATE   CREATE_TIME
nfs-loc        europe-west1-b  STANDARD  1024         nfs1            10.0.5.2    READY   2017-10-09T22:11:28
nfs3           us-central1-c   STANDARD  1024         acme            10.0.6.2    READY   2017-11-06T09:37:18

Example

The following command lists all of the Cloud Filestore instances in project myproject:

gcloud filestore instances list \
    --project=myproject

Getting information about a specific instance

Use one of the following procedures to get information about a specific Cloud Filestore instance.

GCP console

1. Go to the Cloud Filestore instances page
2. Click the instance ID to open the instance details page.

gcloud

Get information about a Cloud Filestore instance by running the instances describe command, replacing [VALUES_IN_BRACKETS] with the appropriate values:

gcloud filestore instances describe [INSTANCE_ID] \
    --project=[PROJECT_ID] \
    --zone=[ZONE]

where:

• [INSTANCE_ID] is the identifier of the Cloud Filestore instance.
• [PROJECT_ID] is the ID of the GCP project that contains the Cloud Filestore instance. You can skip this flag if you have set the gcloud default project and want to use that.
• [ZONE] is the GCP zone in which the Cloud Filestore instance resides. Run the gcloud filestore zones list command to get a list of supported zones. You can skip this flag if you have set the gcloud default zone by running the gcloud config set filestore/zone command.

Response

The response to the instances describe command is similar to the following:

createTime: '2017-11-06T16:49:36.852873Z'
fileShares:
- capacityGb: '1024'
  name: nfs-vol
name: projects/filestore-test/locations/europe-west1-b/instances/nfs
networks:
- ipAddresses:
  - 10.0.5.2
  network: default
  reservedIpRange: 10.0.5.0/29
state: READY
tier: STANDARD

These fields represent the following values:

• createTime: The time the instance was created, in RFC3339 format.
• capacityGb: The size of the Cloud Filestore fileshare in binary gigabytes (GB), where 1 GB = 1024³ bytes.
• (fileShares) name: The name of the Cloud Filestore fileshare. Use this along with the IP address identified by the ipaddresses value to mount the fileshare on a client.
• name: The fully qualified name of the instance.
• ipaddresses: The IP address for the instance. Use this value along with the fileshare name to mount the Cloud Filestore fileshare on a client.
• network: The name of the VPC network the instance uses.
• reservedIpRange: The IP address block reserved for the use of the instance.
• state: The state of the instance.
• tier: The Cloud Filestore service tier of the instance.

Example

The following command provides information about the test-nfs instance in project myproject, in zone us-central1-c.

gcloud filestore instances describe test-nfs \
    --project=myproject \
    --zone=us-central1-c

What's next

• Create another instance.
• Mount the Cloud Filestore fileshare on a Compute Engine VM instance.
• Access the Cloud Filestore fileshare from a Google Kubernetes Engine cluster.