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
list

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
`coldTierSizeUsedGib`	`string (int64)`	Output only. Total cold tier data rounded down to the nearest GiB used by the storage 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. (ENCRYPTION_TYPE_UNSPECIFIED, SERVICE_MANAGED, CLOUD_KMS)
`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.
`hotTierSizeUsedGib`	`string (int64)`	Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool.
`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.
`mode`	`string`	Optional. Mode of the storage pool. This field is used to control whether the user can perform ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`. (MODE_UNSPECIFIED, DEFAULT, ONTAP)
`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 (QOS_TYPE_UNSPECIFIED, AUTO, MANUAL)
`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
`scaleType`	`string`	Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified. (SCALE_TYPE_UNSPECIFIED, SCALE_TYPE_DEFAULT, SCALE_TYPE_SCALEOUT)
`serviceLevel`	`string`	Required. Service level of the storage pool (SERVICE_LEVEL_UNSPECIFIED, PREMIUM, EXTREME, STANDARD, FLEX)
`state`	`string`	Output only. State of the storage pool (STATE_UNSPECIFIED, READY, CREATING, DELETING, UPDATING, RESTORING, DISABLED, ERROR)
`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)
`type`	`string`	Optional. Type of the storage pool. This field is used to control whether the pool supports `FILE` based volumes only or `UNIFIED` (both `FILE` and `BLOCK`) volumes. If not specified during creation, it defaults to `FILE`. (STORAGE_POOL_TYPE_UNSPECIFIED, FILE, UNIFIED)
`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.

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
`coldTierSizeUsedGib`	`string (int64)`	Output only. Total cold tier data rounded down to the nearest GiB used by the storage 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. (ENCRYPTION_TYPE_UNSPECIFIED, SERVICE_MANAGED, CLOUD_KMS)
`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.
`hotTierSizeUsedGib`	`string (int64)`	Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool.
`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.
`mode`	`string`	Optional. Mode of the storage pool. This field is used to control whether the user can perform ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`. (MODE_UNSPECIFIED, DEFAULT, ONTAP)
`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 (QOS_TYPE_UNSPECIFIED, AUTO, MANUAL)
`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
`scaleType`	`string`	Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified. (SCALE_TYPE_UNSPECIFIED, SCALE_TYPE_DEFAULT, SCALE_TYPE_SCALEOUT)
`serviceLevel`	`string`	Required. Service level of the storage pool (SERVICE_LEVEL_UNSPECIFIED, PREMIUM, EXTREME, STANDARD, FLEX)
`state`	`string`	Output only. State of the storage pool (STATE_UNSPECIFIED, READY, CREATING, DELETING, UPDATING, RESTORING, DISABLED, ERROR)
`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)
`type`	`string`	Optional. Type of the storage pool. This field is used to control whether the pool supports `FILE` based volumes only or `UNIFIED` (both `FILE` and `BLOCK`) volumes. If not specified during creation, it defaults to `FILE`. (STORAGE_POOL_TYPE_UNSPECIFIED, FILE, UNIFIED)
`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`, `orderBy`, `pageToken`, `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.
`switch`	`exec`	`projectsId`, `locationsId`, `storagePoolsId`		This operation will switch the active/replica zone for a regional storagePool.
`validate_directory_service`	`exec`	`projectsId`, `locationsId`, `storagePoolsId`		ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.
`restore_volume`	`exec`	`projectsId`, `locationsId`, `storagePoolsId`		Restores a backup to an ONTAP-mode 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`
`storagePoolsId`	`string`
`filter`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`storagePoolId`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Returns the description of the specified storage pool by poolId.

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

Returns descriptions of all storage pools owned by the caller.

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

`INSERT` examples

create
Manifest

Creates a new storage pool.

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

# Description fields are for documentation purposes
- name: storage_pools
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the storage_pools resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the storage_pools resource.
  - name: zone
    value: "{{ zone }}"
    description: |
      Optional. Specifies the active zone for regional storagePool.
  - name: kmsConfig
    value: "{{ kmsConfig }}"
    description: |
      Optional. Specifies the KMS config to be used for volume encryption.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Name of the storage pool
  - name: type
    value: "{{ type }}"
    description: |
      Optional. Type of the storage pool. This field is used to control whether the pool supports `FILE` based volumes only or `UNIFIED` (both `FILE` and `BLOCK`) volumes. If not specified during creation, it defaults to `FILE`.
    valid_values: ['STORAGE_POOL_TYPE_UNSPECIFIED', 'FILE', 'UNIFIED']
  - name: allowAutoTiering
    value: {{ allowAutoTiering }}
    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: "{{ replicaZone }}"
    description: |
      Optional. Specifies the replica zone for regional storagePool.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. Description of the storage pool
  - name: scaleType
    value: "{{ scaleType }}"
    description: |
      Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified.
    valid_values: ['SCALE_TYPE_UNSPECIFIED', 'SCALE_TYPE_DEFAULT', 'SCALE_TYPE_SCALEOUT']
  - name: serviceLevel
    value: "{{ serviceLevel }}"
    description: |
      Required. Service level of the storage pool
    valid_values: ['SERVICE_LEVEL_UNSPECIFIED', 'PREMIUM', 'EXTREME', 'STANDARD', 'FLEX']
  - name: qosType
    value: "{{ qosType }}"
    description: |
      Optional. QoS (Quality of Service) Type of the storage pool
    valid_values: ['QOS_TYPE_UNSPECIFIED', 'AUTO', 'MANUAL']
  - name: network
    value: "{{ network }}"
    description: |
      Required. VPC Network name. Format: projects/{project}/global/networks/{network}
  - name: activeDirectory
    value: "{{ activeDirectory }}"
    description: |
      Optional. Specifies the Active Directory to be used for creating a SMB volume.
  - name: hotTierSizeGib
    value: "{{ hotTierSizeGib }}"
    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: psaRange
    value: "{{ psaRange }}"
    description: |
      Optional. This field is not implemented. The values provided in this field are ignored.
  - name: totalThroughputMibps
    value: "{{ totalThroughputMibps }}"
    description: |
      Optional. Custom Performance Total Throughput of the pool (in MiBps)
  - name: totalIops
    value: "{{ totalIops }}"
    description: |
      Optional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the total_throughput_mibps
  - name: customPerformanceEnabled
    value: {{ customPerformanceEnabled }}
    description: |
      Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
  - name: mode
    value: "{{ mode }}"
    description: |
      Optional. Mode of the storage pool. This field is used to control whether the user can perform ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`.
    valid_values: ['MODE_UNSPECIFIED', 'DEFAULT', 'ONTAP']
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels as key value pairs
  - name: ldapEnabled
    value: {{ ldapEnabled }}
    description: |
      Optional. Flag indicating if the pool is NFS LDAP enabled or not.
  - name: capacityGib
    value: "{{ capacityGib }}"
    description: |
      Required. Capacity in GIB of the pool
  - name: globalAccessAllowed
    value: {{ globalAccessAllowed }}
    description: |
      Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
  - name: enableHotTierAutoResize
    value: {{ enableHotTierAutoResize }}
    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: storagePoolId
    value: "{{ storagePoolId }}"

`UPDATE` examples

patch

Updates the storage pool properties with the full spec

UPDATE google.netapp.storage_pools
SET 
data__zone = '{{ zone }}',
data__kmsConfig = '{{ kmsConfig }}',
data__name = '{{ name }}',
data__type = '{{ type }}',
data__allowAutoTiering = {{ allowAutoTiering }},
data__replicaZone = '{{ replicaZone }}',
data__description = '{{ description }}',
data__scaleType = '{{ scaleType }}',
data__serviceLevel = '{{ serviceLevel }}',
data__qosType = '{{ qosType }}',
data__network = '{{ network }}',
data__activeDirectory = '{{ activeDirectory }}',
data__hotTierSizeGib = '{{ hotTierSizeGib }}',
data__psaRange = '{{ psaRange }}',
data__totalThroughputMibps = '{{ totalThroughputMibps }}',
data__totalIops = '{{ totalIops }}',
data__customPerformanceEnabled = {{ customPerformanceEnabled }},
data__mode = '{{ mode }}',
data__labels = '{{ labels }}',
data__ldapEnabled = {{ ldapEnabled }},
data__capacityGib = '{{ capacityGib }}',
data__globalAccessAllowed = {{ globalAccessAllowed }},
data__enableHotTierAutoResize = {{ enableHotTierAutoResize }}
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

switch
validate_directory_service
restore_volume

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
;

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 }}"
}'
;

Restores a backup to an ONTAP-mode volume.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​