volumes

Creates, updates, deletes, gets or lists a volumes resource.

Overview

Name	volumes
Type	Resource
Id	google.netapp.volumes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. Name of the volume
activeDirectory	string	Output only. Specifies the ActiveDirectory name of a SMB volume.
backupConfig	object	BackupConfig of the volume. (id: BackupConfig)
blockDevices	array	Optional. Block devices for the volume. Currently, only one block device is permitted per Volume.
cacheParameters	object	Optional. Cache parameters for the volume. (id: CacheParameters)
capacityGib	string (int64)	Required. Capacity in GIB of the volume
coldTierSizeGib	string (int64)	Output only. Size of the volume cold tier data rounded down to the nearest GiB.
createTime	string (google-datetime)	Output only. Create time of the volume
description	string	Optional. Description of the volume
encryptionType	string	Output only. Specified the current volume encryption key source.
exportPolicy	object	Optional. Export policy of the volume (id: ExportPolicy)
hasReplication	boolean	Output only. Indicates whether the volume is part of a replication relationship.
hotTierSizeUsedGib	string (int64)	Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level
hybridReplicationParameters	object	Optional. The Hybrid Replication parameters for the volume. (id: HybridReplicationParameters)
kerberosEnabled	boolean	Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
kmsConfig	string	Output only. Specifies the KMS config to be used for volume encryption.
labels	object	Optional. Labels as key value pairs
largeCapacity	boolean	Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
ldapEnabled	boolean	Output only. Flag indicating if the volume is NFS LDAP enabled or not.
mountOptions	array	Output only. Mount options of this volume
multipleEndpoints	boolean	Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
network	string	Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
protocols	array	Required. Protocols required for the volume
psaRange	string	Output only. This field is not implemented. The values provided in this field are ignored.
replicaZone	string	Output only. Specifies the replica zone for regional volume.
restoreParameters	object	Optional. Specifies the source of the volume to be created from. (id: RestoreParameters)
restrictedActions	array	Optional. List of actions that are restricted on this volume.
securityStyle	string	Optional. Security Style of the Volume
serviceLevel	string	Output only. Service level of the volume
shareName	string	Required. Share name of the volume
smbSettings	array	Optional. SMB share settings for the volume.
snapReserve	number (double)	Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
snapshotDirectory	boolean	Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
snapshotPolicy	object	Optional. SnapshotPolicy for a volume. (id: SnapshotPolicy)
state	string	Output only. State of the volume
stateDetails	string	Output only. State details of the volume
storagePool	string	Required. StoragePool name of the volume
throughputMibps	number (double)	Optional. Throughput of the volume (in MiB/s)
tieringPolicy	object	Tiering policy for the volume. (id: TieringPolicy)
unixPermissions	string	Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
usedGib	string (int64)	Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
zone	string	Output only. Specifies the active zone for regional volume.

list

Name	Datatype	Description
name	string	Identifier. Name of the volume
activeDirectory	string	Output only. Specifies the ActiveDirectory name of a SMB volume.
backupConfig	object	BackupConfig of the volume. (id: BackupConfig)
blockDevices	array	Optional. Block devices for the volume. Currently, only one block device is permitted per Volume.
cacheParameters	object	Optional. Cache parameters for the volume. (id: CacheParameters)
capacityGib	string (int64)	Required. Capacity in GIB of the volume
coldTierSizeGib	string (int64)	Output only. Size of the volume cold tier data rounded down to the nearest GiB.
createTime	string (google-datetime)	Output only. Create time of the volume
description	string	Optional. Description of the volume
encryptionType	string	Output only. Specified the current volume encryption key source.
exportPolicy	object	Optional. Export policy of the volume (id: ExportPolicy)
hasReplication	boolean	Output only. Indicates whether the volume is part of a replication relationship.
hotTierSizeUsedGib	string (int64)	Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level
hybridReplicationParameters	object	Optional. The Hybrid Replication parameters for the volume. (id: HybridReplicationParameters)
kerberosEnabled	boolean	Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
kmsConfig	string	Output only. Specifies the KMS config to be used for volume encryption.
labels	object	Optional. Labels as key value pairs
largeCapacity	boolean	Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
ldapEnabled	boolean	Output only. Flag indicating if the volume is NFS LDAP enabled or not.
mountOptions	array	Output only. Mount options of this volume
multipleEndpoints	boolean	Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
network	string	Output only. VPC Network name. Format: projects/{project}/global/networks/{network}
protocols	array	Required. Protocols required for the volume
psaRange	string	Output only. This field is not implemented. The values provided in this field are ignored.
replicaZone	string	Output only. Specifies the replica zone for regional volume.
restoreParameters	object	Optional. Specifies the source of the volume to be created from. (id: RestoreParameters)
restrictedActions	array	Optional. List of actions that are restricted on this volume.
securityStyle	string	Optional. Security Style of the Volume
serviceLevel	string	Output only. Service level of the volume
shareName	string	Required. Share name of the volume
smbSettings	array	Optional. SMB share settings for the volume.
snapReserve	number (double)	Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
snapshotDirectory	boolean	Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
snapshotPolicy	object	Optional. SnapshotPolicy for a volume. (id: SnapshotPolicy)
state	string	Output only. State of the volume
stateDetails	string	Output only. State details of the volume
storagePool	string	Required. StoragePool name of the volume
throughputMibps	number (double)	Optional. Throughput of the volume (in MiB/s)
tieringPolicy	object	Tiering policy for the volume. (id: TieringPolicy)
unixPermissions	string	Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
usedGib	string (int64)	Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.
zone	string	Output only. Specifies the active zone for regional volume.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, volumesId		Gets details of a single Volume.
list	select	projectsId, locationsId	pageToken, filter, pageSize, orderBy	Lists Volumes in a given project.
create	insert	projectsId, locationsId	volumeId	Creates a new Volume in a given project and location.
patch	update	projectsId, locationsId, volumesId	updateMask	Updates the parameters of a single Volume.
delete	delete	projectsId, locationsId, volumesId	force	Deletes a single Volume.
revert	exec	projectsId, locationsId, volumesId		Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.
restore	exec	projectsId, locationsId, volumesId		Restore files from a backup to a volume.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
volumesId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
volumeId	string

SELECT examples

get

Gets details of a single Volume.

SELECT
name,
activeDirectory,
backupConfig,
blockDevices,
cacheParameters,
capacityGib,
coldTierSizeGib,
createTime,
description,
encryptionType,
exportPolicy,
hasReplication,
hotTierSizeUsedGib,
hybridReplicationParameters,
kerberosEnabled,
kmsConfig,
labels,
largeCapacity,
ldapEnabled,
mountOptions,
multipleEndpoints,
network,
protocols,
psaRange,
replicaZone,
restoreParameters,
restrictedActions,
securityStyle,
serviceLevel,
shareName,
smbSettings,
snapReserve,
snapshotDirectory,
snapshotPolicy,
state,
stateDetails,
storagePool,
throughputMibps,
tieringPolicy,
unixPermissions,
usedGib,
zone
FROM google.netapp.volumes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND volumesId = '{{ volumesId }}' -- required
;

list

Lists Volumes in a given project.

SELECT
name,
activeDirectory,
backupConfig,
blockDevices,
cacheParameters,
capacityGib,
coldTierSizeGib,
createTime,
description,
encryptionType,
exportPolicy,
hasReplication,
hotTierSizeUsedGib,
hybridReplicationParameters,
kerberosEnabled,
kmsConfig,
labels,
largeCapacity,
ldapEnabled,
mountOptions,
multipleEndpoints,
network,
protocols,
psaRange,
replicaZone,
restoreParameters,
restrictedActions,
securityStyle,
serviceLevel,
shareName,
smbSettings,
snapReserve,
snapshotDirectory,
snapshotPolicy,
state,
stateDetails,
storagePool,
throughputMibps,
tieringPolicy,
unixPermissions,
usedGib,
zone
FROM google.netapp.volumes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new Volume in a given project and location.

INSERT INTO google.netapp.volumes (
data__shareName,
data__snapshotPolicy,
data__kerberosEnabled,
data__exportPolicy,
data__throughputMibps,
data__tieringPolicy,
data__name,
data__securityStyle,
data__cacheParameters,
data__restrictedActions,
data__multipleEndpoints,
data__description,
data__largeCapacity,
data__snapshotDirectory,
data__unixPermissions,
data__protocols,
data__storagePool,
data__backupConfig,
data__hybridReplicationParameters,
data__smbSettings,
data__restoreParameters,
data__blockDevices,
data__capacityGib,
data__labels,
data__snapReserve,
projectsId,
locationsId,
volumeId
)
SELECT 
'{{ shareName }}',
'{{ snapshotPolicy }}',
{{ kerberosEnabled }},
'{{ exportPolicy }}',
{{ throughputMibps }},
'{{ tieringPolicy }}',
'{{ name }}',
'{{ securityStyle }}',
'{{ cacheParameters }}',
'{{ restrictedActions }}',
{{ multipleEndpoints }},
'{{ description }}',
{{ largeCapacity }},
{{ snapshotDirectory }},
'{{ unixPermissions }}',
'{{ protocols }}',
'{{ storagePool }}',
'{{ backupConfig }}',
'{{ hybridReplicationParameters }}',
'{{ smbSettings }}',
'{{ restoreParameters }}',
'{{ blockDevices }}',
'{{ capacityGib }}',
'{{ labels }}',
{{ snapReserve }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ volumeId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: volumes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the volumes resource.
    - name: locationsId
      value: string
      description: Required parameter for the volumes resource.
    - name: shareName
      value: string
      description: >
        Required. Share name of the volume
        
    - name: snapshotPolicy
      value: object
      description: >
        Optional. SnapshotPolicy for a volume.
        
    - name: kerberosEnabled
      value: boolean
      description: >
        Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
        
    - name: exportPolicy
      value: object
      description: >
        Optional. Export policy of the volume
        
    - name: throughputMibps
      value: number
      description: >
        Optional. Throughput of the volume (in MiB/s)
        
    - name: tieringPolicy
      value: object
      description: >
        Tiering policy for the volume.
        
    - name: name
      value: string
      description: >
        Identifier. Name of the volume
        
    - name: securityStyle
      value: string
      description: >
        Optional. Security Style of the Volume
        
      valid_values: ['SECURITY_STYLE_UNSPECIFIED', 'NTFS', 'UNIX']
    - name: cacheParameters
      value: object
      description: >
        Optional. Cache parameters for the volume.
        
    - name: restrictedActions
      value: array
      description: >
        Optional. List of actions that are restricted on this volume.
        
    - name: multipleEndpoints
      value: boolean
      description: >
        Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.
        
    - name: description
      value: string
      description: >
        Optional. Description of the volume
        
    - name: largeCapacity
      value: boolean
      description: >
        Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
        
    - name: snapshotDirectory
      value: boolean
      description: >
        Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.
        
    - name: unixPermissions
      value: string
      description: >
        Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
        
    - name: protocols
      value: array
      description: >
        Required. Protocols required for the volume
        
    - name: storagePool
      value: string
      description: >
        Required. StoragePool name of the volume
        
    - name: backupConfig
      value: object
      description: >
        BackupConfig of the volume.
        
    - name: hybridReplicationParameters
      value: object
      description: >
        Optional. The Hybrid Replication parameters for the volume.
        
    - name: smbSettings
      value: array
      description: >
        Optional. SMB share settings for the volume.
        
    - name: restoreParameters
      value: object
      description: >
        Optional. Specifies the source of the volume to be created from.
        
    - name: blockDevices
      value: array
      description: >
        Optional. Block devices for the volume. Currently, only one block device is permitted per Volume.
        
    - name: capacityGib
      value: string
      description: >
        Required. Capacity in GIB of the volume
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs
        
    - name: snapReserve
      value: number
      description: >
        Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
        
    - name: volumeId
      value: string

UPDATE examples

patch

Updates the parameters of a single Volume.

UPDATE google.netapp.volumes
SET 
data__shareName = '{{ shareName }}',
data__snapshotPolicy = '{{ snapshotPolicy }}',
data__kerberosEnabled = {{ kerberosEnabled }},
data__exportPolicy = '{{ exportPolicy }}',
data__throughputMibps = {{ throughputMibps }},
data__tieringPolicy = '{{ tieringPolicy }}',
data__name = '{{ name }}',
data__securityStyle = '{{ securityStyle }}',
data__cacheParameters = '{{ cacheParameters }}',
data__restrictedActions = '{{ restrictedActions }}',
data__multipleEndpoints = {{ multipleEndpoints }},
data__description = '{{ description }}',
data__largeCapacity = {{ largeCapacity }},
data__snapshotDirectory = {{ snapshotDirectory }},
data__unixPermissions = '{{ unixPermissions }}',
data__protocols = '{{ protocols }}',
data__storagePool = '{{ storagePool }}',
data__backupConfig = '{{ backupConfig }}',
data__hybridReplicationParameters = '{{ hybridReplicationParameters }}',
data__smbSettings = '{{ smbSettings }}',
data__restoreParameters = '{{ restoreParameters }}',
data__blockDevices = '{{ blockDevices }}',
data__capacityGib = '{{ capacityGib }}',
data__labels = '{{ labels }}',
data__snapReserve = {{ snapReserve }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND volumesId = '{{ volumesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Volume.

DELETE FROM google.netapp.volumes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND volumesId = '{{ volumesId }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

revert

Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.

EXEC google.netapp.volumes.revert 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@volumesId='{{ volumesId }}' --required 
@@json=
'{
"snapshotId": "{{ snapshotId }}"
}'
;

restore

Restore files from a backup to a volume.

EXEC google.netapp.volumes.restore 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@volumesId='{{ volumesId }}' --required 
@@json=
'{
"restoreDestinationPath": "{{ restoreDestinationPath }}", 
"backup": "{{ backup }}", 
"fileList": "{{ fileList }}"
}'
;