storage_pools

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

Overview

Name	storage_pools
Type	Resource
Id	google.netapp.storage_pools

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the storage pool
activeDirectory	string	Optional. Specifies the Active Directory to be used for creating a SMB volume.
allowAutoTiering	boolean	Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
availableThroughputMibps	number (double)	Output only. Available throughput of the storage pool (in MiB/s).
capacityGib	string (int64)	Required. Capacity in GIB of the pool
createTime	string (google-datetime)	Output only. Create time of the storage pool
customPerformanceEnabled	boolean	Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
description	string	Optional. Description of the storage pool
enableHotTierAutoResize	boolean	Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size.
encryptionType	string	Output only. Specifies the current pool encryption key source.
globalAccessAllowed	boolean	Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
hotTierSizeGib	string (int64)	Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set.
kmsConfig	string	Optional. Specifies the KMS config to be used for volume encryption.
labels	object	Optional. Labels as key value pairs
ldapEnabled	boolean	Optional. Flag indicating if the pool is NFS LDAP enabled or not.
network	string	Required. VPC Network name. Format: projects/{project}/global/networks/{network}
psaRange	string	Optional. This field is not implemented. The values provided in this field are ignored.
qosType	string	Optional. QoS (Quality of Service) Type of the storage pool
replicaZone	string	Optional. Specifies the replica zone for regional storagePool.
satisfiesPzi	boolean	Output only. Reserved for future use
satisfiesPzs	boolean	Output only. Reserved for future use
serviceLevel	string	Required. Service level of the storage pool
state	string	Output only. State of the storage pool
stateDetails	string	Output only. State details of the storage pool
totalIops	string (int64)	Optional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the total_throughput_mibps
totalThroughputMibps	string (int64)	Optional. Custom Performance Total Throughput of the pool (in MiBps)
volumeCapacityGib	string (int64)	Output only. Allocated size of all volumes in GIB in the storage pool
volumeCount	integer (int32)	Output only. Volume count of the storage pool
zone	string	Optional. Specifies the active zone for regional storagePool.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the storage pool
activeDirectory	string	Optional. Specifies the Active Directory to be used for creating a SMB volume.
allowAutoTiering	boolean	Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
availableThroughputMibps	number (double)	Output only. Available throughput of the storage pool (in MiB/s).
capacityGib	string (int64)	Required. Capacity in GIB of the pool
createTime	string (google-datetime)	Output only. Create time of the storage pool
customPerformanceEnabled	boolean	Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
description	string	Optional. Description of the storage pool
enableHotTierAutoResize	boolean	Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size.
encryptionType	string	Output only. Specifies the current pool encryption key source.
globalAccessAllowed	boolean	Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
hotTierSizeGib	string (int64)	Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set.
kmsConfig	string	Optional. Specifies the KMS config to be used for volume encryption.
labels	object	Optional. Labels as key value pairs
ldapEnabled	boolean	Optional. Flag indicating if the pool is NFS LDAP enabled or not.
network	string	Required. VPC Network name. Format: projects/{project}/global/networks/{network}
psaRange	string	Optional. This field is not implemented. The values provided in this field are ignored.
qosType	string	Optional. QoS (Quality of Service) Type of the storage pool
replicaZone	string	Optional. Specifies the replica zone for regional storagePool.
satisfiesPzi	boolean	Output only. Reserved for future use
satisfiesPzs	boolean	Output only. Reserved for future use
serviceLevel	string	Required. Service level of the storage pool
state	string	Output only. State of the storage pool
stateDetails	string	Output only. State details of the storage pool
totalIops	string (int64)	Optional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the total_throughput_mibps
totalThroughputMibps	string (int64)	Optional. Custom Performance Total Throughput of the pool (in MiBps)
volumeCapacityGib	string (int64)	Output only. Allocated size of all volumes in GIB in the storage pool
volumeCount	integer (int32)	Output only. Volume count of the storage pool
zone	string	Optional. Specifies the active zone for regional storagePool.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, storagePoolsId		Returns the description of the specified storage pool by poolId.
list	select	projectsId, locationsId	pageSize, pageToken, orderBy, filter	Returns descriptions of all storage pools owned by the caller.
create	insert	projectsId, locationsId	storagePoolId	Creates a new storage pool.
patch	update	projectsId, locationsId, storagePoolsId	updateMask	Updates the storage pool properties with the full spec
delete	delete	projectsId, locationsId, storagePoolsId		Warning! This operation will permanently delete the storage pool.
validate_directory_service	exec	projectsId, locationsId, storagePoolsId		ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.
switch	exec	projectsId, locationsId, storagePoolsId		This operation will switch the active/replica zone for a regional storagePool.

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
storagePoolsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
storagePoolId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Returns the description of the specified storage pool by poolId.

SELECT
name,
activeDirectory,
allowAutoTiering,
availableThroughputMibps,
capacityGib,
createTime,
customPerformanceEnabled,
description,
enableHotTierAutoResize,
encryptionType,
globalAccessAllowed,
hotTierSizeGib,
kmsConfig,
labels,
ldapEnabled,
network,
psaRange,
qosType,
replicaZone,
satisfiesPzi,
satisfiesPzs,
serviceLevel,
state,
stateDetails,
totalIops,
totalThroughputMibps,
volumeCapacityGib,
volumeCount,
zone
FROM google.netapp.storage_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND storagePoolsId = '{{ storagePoolsId }}' -- required;

list

Returns descriptions of all storage pools owned by the caller.

SELECT
name,
activeDirectory,
allowAutoTiering,
availableThroughputMibps,
capacityGib,
createTime,
customPerformanceEnabled,
description,
enableHotTierAutoResize,
encryptionType,
globalAccessAllowed,
hotTierSizeGib,
kmsConfig,
labels,
ldapEnabled,
network,
psaRange,
qosType,
replicaZone,
satisfiesPzi,
satisfiesPzs,
serviceLevel,
state,
stateDetails,
totalIops,
totalThroughputMibps,
volumeCapacityGib,
volumeCount,
zone
FROM google.netapp.storage_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';

INSERT examples

create

Creates a new storage pool.

INSERT INTO google.netapp.storage_pools (
data__name,
data__serviceLevel,
data__capacityGib,
data__description,
data__labels,
data__network,
data__activeDirectory,
data__kmsConfig,
data__ldapEnabled,
data__psaRange,
data__globalAccessAllowed,
data__allowAutoTiering,
data__replicaZone,
data__zone,
data__customPerformanceEnabled,
data__totalThroughputMibps,
data__totalIops,
data__hotTierSizeGib,
data__enableHotTierAutoResize,
data__qosType,
projectsId,
locationsId,
storagePoolId
)
SELECT 
'{{ name }}',
'{{ serviceLevel }}',
'{{ capacityGib }}',
'{{ description }}',
'{{ labels }}',
'{{ network }}',
'{{ activeDirectory }}',
'{{ kmsConfig }}',
{{ ldapEnabled }},
'{{ psaRange }}',
{{ globalAccessAllowed }},
{{ allowAutoTiering }},
'{{ replicaZone }}',
'{{ zone }}',
{{ customPerformanceEnabled }},
'{{ totalThroughputMibps }}',
'{{ totalIops }}',
'{{ hotTierSizeGib }}',
{{ enableHotTierAutoResize }},
'{{ qosType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ storagePoolId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: storage_pools
  props:
    - name: projectsId
      value: string
      description: Required parameter for the storage_pools resource.
    - name: locationsId
      value: string
      description: Required parameter for the storage_pools resource.
    - name: name
      value: string
      description: >
        Identifier. Name of the storage pool
        
    - name: serviceLevel
      value: string
      description: >
        Required. Service level of the storage pool
        
      valid_values: ['SERVICE_LEVEL_UNSPECIFIED', 'PREMIUM', 'EXTREME', 'STANDARD', 'FLEX']
    - name: capacityGib
      value: string
      description: >
        Required. Capacity in GIB of the pool
        
    - name: description
      value: string
      description: >
        Optional. Description of the storage pool
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs
        
    - name: network
      value: string
      description: >
        Required. VPC Network name. Format: projects/{project}/global/networks/{network}
        
    - name: activeDirectory
      value: string
      description: >
        Optional. Specifies the Active Directory to be used for creating a SMB volume.
        
    - name: kmsConfig
      value: string
      description: >
        Optional. Specifies the KMS config to be used for volume encryption.
        
    - name: ldapEnabled
      value: boolean
      description: >
        Optional. Flag indicating if the pool is NFS LDAP enabled or not.
        
    - name: psaRange
      value: string
      description: >
        Optional. This field is not implemented. The values provided in this field are ignored.
        
    - name: globalAccessAllowed
      value: boolean
      description: >
        Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
        
    - name: allowAutoTiering
      value: boolean
      description: >
        Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
        
    - name: replicaZone
      value: string
      description: >
        Optional. Specifies the replica zone for regional storagePool.
        
    - name: zone
      value: string
      description: >
        Optional. Specifies the active zone for regional storagePool.
        
    - name: customPerformanceEnabled
      value: boolean
      description: >
        Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
        
    - name: totalThroughputMibps
      value: string
      description: >
        Optional. Custom Performance Total Throughput of the pool (in MiBps)
        
    - name: totalIops
      value: string
      description: >
        Optional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the total_throughput_mibps
        
    - name: hotTierSizeGib
      value: string
      description: >
        Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set.
        
    - name: enableHotTierAutoResize
      value: boolean
      description: >
        Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size.
        
    - name: qosType
      value: string
      description: >
        Optional. QoS (Quality of Service) Type of the storage pool
        
      valid_values: ['QOS_TYPE_UNSPECIFIED', 'AUTO', 'MANUAL']
    - name: storagePoolId
      value: string

UPDATE examples

patch

Updates the storage pool properties with the full spec

UPDATE google.netapp.storage_pools
SET 
data__name = '{{ name }}',
data__serviceLevel = '{{ serviceLevel }}',
data__capacityGib = '{{ capacityGib }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__network = '{{ network }}',
data__activeDirectory = '{{ activeDirectory }}',
data__kmsConfig = '{{ kmsConfig }}',
data__ldapEnabled = {{ ldapEnabled }},
data__psaRange = '{{ psaRange }}',
data__globalAccessAllowed = {{ globalAccessAllowed }},
data__allowAutoTiering = {{ allowAutoTiering }},
data__replicaZone = '{{ replicaZone }}',
data__zone = '{{ zone }}',
data__customPerformanceEnabled = {{ customPerformanceEnabled }},
data__totalThroughputMibps = '{{ totalThroughputMibps }}',
data__totalIops = '{{ totalIops }}',
data__hotTierSizeGib = '{{ hotTierSizeGib }}',
data__enableHotTierAutoResize = {{ enableHotTierAutoResize }},
data__qosType = '{{ qosType }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND storagePoolsId = '{{ storagePoolsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Warning! This operation will permanently delete the storage pool.

DELETE FROM google.netapp.storage_pools
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND storagePoolsId = '{{ storagePoolsId }}' --required;

Lifecycle Methods

validate_directory_service

ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.

EXEC google.netapp.storage_pools.validate_directory_service 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@storagePoolsId='{{ storagePoolsId }}' --required 
@@json=
'{
"directoryServiceType": "{{ directoryServiceType }}"
}';

switch

This operation will switch the active/replica zone for a regional storagePool.

EXEC google.netapp.storage_pools.switch 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@storagePoolsId='{{ storagePoolsId }}' --required;