REST Resource: projects.locations.nfsShares

Resource: NfsShare

An NFS share.

JSON representation 
{
  "name": string,
  "nfsShareId": string,
  "id": string,
  "state": enum (State),
  "volume": string,
  "allowedClients": [
    {
      object (AllowedClient)
    }
  ],
  "labels": {
    string: string,
    ...
  },
  "requestedSizeGib": string,
  "storageType": enum (StorageType)
}
Fields
name

string

Immutable. The name of the NFS share.
nfsShareId

string

Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use id instead.
id

string

Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfsShareId and will replace it in the future.
state

enum (State)

Output only. The state of the NFS share.
volume

string

Output only. The underlying volume of the share. Created automatically during provisioning.
allowedClients[]

object (AllowedClient)

List of allowed access points.
labels

map (key: string, value: string)

Labels as key value pairs.
requestedSizeGib

string (int64 format)

The requested size, in GiB.
storageType

enum (StorageType)

Immutable. The storage type of the underlying volume.

State

The possible states for this NFS share.

Enums
STATE_UNSPECIFIED The share is in an unknown state.
PROVISIONED The share has been provisioned.
CREATING The NFS Share is being created.
UPDATING The NFS Share is being updated.
DELETING The NFS Share has been requested to be deleted.

AllowedClient

Represents an 'access point' for the share.

JSON representation 
{
  "network": string,
  "shareIp": string,
  "allowedClientsCidr": string,
  "mountPermissions": enum (MountPermissions),
  "allowDev": boolean,
  "allowSuid": boolean,
  "noRootSquash": boolean,
  "nfsPath": string
}
Fields
network

string

The network the access point sits on.
shareIp

string

Output only. The IP address of the share on this network. Assigned automatically during provisioning based on the network's servicesCidr.
allowedClientsCidr

string

The subnet of IP addresses permitted to access the share.
mountPermissions

enum (MountPermissions)

Mount permissions.
allowDev

boolean

Allow dev flag. Which controls whether to allow creation of devices.
allowSuid

boolean

Allow the setuid flag.
noRootSquash

boolean

Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
nfsPath

string

Output only. The path to access NFS, in format shareIP:/InstanceID InstanceID is the generated ID instead of customer provided name. example like "10.0.0.0:/g123456789-nfs001"

MountPermissions

The possible mount permissions.

Enums
MOUNT_PERMISSIONS_UNSPECIFIED Permissions were not specified.
READ NFS share can be mount with read-only permissions.
READ_WRITE NFS share can be mount with read-write permissions.

StorageType

The storage type for a volume.

Enums
STORAGE_TYPE_UNSPECIFIED The storage type for this volume is unknown.
SSD The storage type for this volume is SSD.
HDD This storage type for this volume is HDD.

Methods

create

 Create an NFS share.

delete

 Delete an NFS share.

get

 Get details of a single NFS share.

list

 List NFS shares.

patch

 Update details of a single NFS share.