REST Resource: projects.locations.nfsShares

Resource: NfsShare

An NFS share.

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

string

Output only. The name of the NFS share.

nfsShareId

string

Output only. An identifier for the NFS share, generated by the backend.

state

enum (State)

The state of the NFS share.

volume

string

The volume containing the share.

allowedClients[]

object (AllowedClient)

List of allowed access points.

labels

map (key: string, value: string)

Labels as key value pairs.

State

The possible states for this NFS share.

Enums
STATE_UNSPECIFIED The share is in an unknown state.
PROVISIONED The share has been provisioned.

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
}
Fields
network

string

The network the access point sits on.

shareIp

string

The IP address of the share on this network.

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.

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.

Methods

get

Get details of a single NFS share.

list

List NFS shares.

patch

Update details of a single NFS share.