Skip to main content

@swamp/gcp/netapp

v2026.04.23.1

Google Cloud netapp infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudnetappcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/netapp

@swamp/gcp/netapp/activedirectoriesv2026.04.23.1activedirectories.ts

Global Arguments

ArgumentTypeDescription
administrators?arrayOptional. Users to be added to the Built-in Admininstrators group.
aesEncryption?booleanIf enabled, AES encryption will be enabled for SMB communication.
backupOperators?arrayOptional. Users to be added to the Built-in Backup Operator active directory group.
description?stringDescription of the active directory.
dns?stringRequired. Comma separated list of DNS server IP addresses for the Active Directory domain.
domain?stringRequired. Name of the Active Directory domain
encryptDcConnections?booleanIf enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
kdcHostname?stringName of the active directory machine. This optional parameter is used only while creating kerberos volume
kdcIp?stringKDC server IP address for the active directory machine.
labels?recordLabels for the active directory.
ldapSigning?booleanSpecifies whether or not the LDAP traffic needs to be signed.
name?stringIdentifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
netBiosPrefix?stringRequired. NetBIOSPrefix is used as a prefix for SMB server name.
nfsUsersWithLdap?booleanIf enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
organizationalUnit?stringThe Organizational Unit (OU) within the Windows Active Directory the user belongs to.
password?stringRequired. Password of the Active Directory domain administrator.
securityOperators?arrayOptional. Domain users to be given the SeSecurityPrivilege.
site?stringThe Active Directory site the service will limit Domain Controller discovery too.
username?stringRequired. Username of the Active Directory domain administrator.
activeDirectoryId?stringRequired. ID of the active directory to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a activeDirectories
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a activeDirectories
ArgumentTypeDescription
identifierstringThe name of the activeDirectories
updateUpdate activeDirectories attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the activeDirectories
ArgumentTypeDescription
identifierstringThe name of the activeDirectories
syncSync activeDirectories state from GCP

Resources

state(infinite)— ActiveDirectory is the public representation of the active directory config.
@swamp/gcp/netapp/backuppoliciesv2026.04.23.1backuppolicies.ts

Global Arguments

ArgumentTypeDescription
dailyBackupLimit?numberNumber of daily backups to keep. Note that the minimum daily backup limit is 2.
description?stringDescription of the backup policy.
enabled?booleanIf enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
labels?recordResource labels to represent user provided metadata.
monthlyBackupLimit?numberNumber of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
name?stringIdentifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
weeklyBackupLimit?numberNumber of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
backupPolicyId?stringRequired. The ID to use for the backup policy. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a backupPolicies
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a backupPolicies
ArgumentTypeDescription
identifierstringThe name of the backupPolicies
updateUpdate backupPolicies attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the backupPolicies
ArgumentTypeDescription
identifierstringThe name of the backupPolicies
syncSync backupPolicies state from GCP

Resources

state(infinite)— Backup Policy.
@swamp/gcp/netapp/backupvaultsv2026.04.23.1backupvaults.ts

Global Arguments

ArgumentTypeDescription
backupRegion?stringOptional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}`
backupRetentionPolicy?objectRetention policy for backups in the backup vault
backupVaultType?enumOptional. Type of backup vault to be created. Default is IN_REGION.
description?stringDescription of the backup vault.
kmsConfig?stringOptional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`
labels?recordResource labels to represent user provided metadata.
name?stringIdentifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
backupVaultId?stringRequired. The ID to use for the backupVault. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a backupVaults
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a backupVaults
ArgumentTypeDescription
identifierstringThe name of the backupVaults
updateUpdate backupVaults attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the backupVaults
ArgumentTypeDescription
identifierstringThe name of the backupVaults
syncSync backupVaults state from GCP

Resources

state(infinite)— A NetApp BackupVault.
@swamp/gcp/netapp/backupvaults-backupsv2026.04.23.1backupvaults_backups.ts

Global Arguments

ArgumentTypeDescription
description?stringA description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
labels?recordResource labels to represent user provided metadata.
name?stringIdentifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
sourceSnapshot?stringIf specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
sourceVolume?stringVolume full name of this backup belongs to. Either source_volume or ontap_source should be provided. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`
backupId?stringRequired. The ID to use for the backup. The ID must be unique within the specified backupVault. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a backups
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a backups
ArgumentTypeDescription
identifierstringThe name of the backups
updateUpdate backups attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the backups
ArgumentTypeDescription
identifierstringThe name of the backups
syncSync backups state from GCP

Resources

state(infinite)— A NetApp Backup.
@swamp/gcp/netapp/hostgroupsv2026.04.23.1hostgroups.ts

Global Arguments

ArgumentTypeDescription
description?stringOptional. Description of the host group.
hosts?arrayRequired. The list of hosts associated with the host group.
labels?recordOptional. Labels of the host group.
name?stringIdentifier. The resource name of the host group. Format: `projects/{project_number}/locations/{location_id}/hostGroups/{host_group_id}`.
osType?enumRequired. The OS type of the host group. It indicates the type of operating system used by all of the hosts in the HostGroup. All hosts in a HostGroup must be of the same OS type. This can be set only when creating a HostGroup.
type?enumRequired. Type of the host group.
hostGroupId?stringRequired. ID of the host group to create. Must be unique within the parent resource. Must contain only letters, numbers, and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a hostGroups
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a hostGroups
ArgumentTypeDescription
identifierstringThe name of the hostGroups
updateUpdate hostGroups attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the hostGroups
ArgumentTypeDescription
identifierstringThe name of the hostGroups
syncSync hostGroups state from GCP

Resources

state(infinite)— Host group is a collection of hosts that can be used for accessing a Block Vo...
@swamp/gcp/netapp/kmsconfigsv2026.04.23.1kmsconfigs.ts

Global Arguments

ArgumentTypeDescription
cryptoKeyName?stringRequired. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`
description?stringDescription of the KmsConfig.
labels?recordLabels as key value pairs
name?stringIdentifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`
kmsConfigId?stringRequired. Id of the requesting KmsConfig. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a kmsConfigs
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a kmsConfigs
ArgumentTypeDescription
identifierstringThe name of the kmsConfigs
updateUpdate kmsConfigs attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the kmsConfigs
ArgumentTypeDescription
identifierstringThe name of the kmsConfigs
syncSync kmsConfigs state from GCP
encryptencrypt
verifyverify

Resources

state(infinite)— KmsConfig is the customer-managed encryption key(CMEK) configuration.
@swamp/gcp/netapp/locationsv2026.04.23.1locations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/netapp/storagepoolsv2026.04.23.1storagepools.ts

Global Arguments

ArgumentTypeDescription
activeDirectory?stringOptional. Specifies the Active Directory to be used for creating a SMB volume.
allowAutoTiering?booleanOptional. 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.
capacityGib?stringRequired. Capacity in GIB of the pool
customPerformanceEnabled?booleanOptional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
description?stringOptional. Description of the storage pool
enableHotTierAutoResize?booleanOptional. 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.
hotTierSizeGib?stringOptional. 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?stringOptional. Specifies the KMS config to be used for volume encryption.
labels?recordOptional. Labels as key value pairs
ldapEnabled?booleanOptional. Flag indicating if the pool is NFS LDAP enabled or not.
mode?enumOptional. Mode of the storage pool. This field is used to control whether the user can perform the ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`.
name?stringIdentifier. Name of the storage pool
network?stringRequired. VPC Network name. Format: projects/{project}/global/networks/{network}
psaRange?stringOptional. This field is not implemented. The values provided in this field are ignored.
qosType?enumOptional. QoS (Quality of Service) Type of the storage pool
replicaZone?stringOptional. Specifies the replica zone for regional storagePool.
scaleType?enumOptional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified.
serviceLevel?enumRequired. Service level of the storage pool
totalIops?stringOptional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the total_throughput_mibps
totalThroughputMibps?stringOptional. Custom Performance Total Throughput of the pool (in MiBps)
type?enumOptional. 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`.
zone?stringOptional. Specifies the active zone for regional storagePool.
storagePoolId?stringRequired. Id of the requesting storage pool. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
createCreate a storagePools
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a storagePools
ArgumentTypeDescription
identifierstringThe name of the storagePools
updateUpdate storagePools attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the storagePools
ArgumentTypeDescription
identifierstringThe name of the storagePools
syncSync storagePools state from GCP
switchswitch
validate_directory_servicevalidate directory service
ArgumentTypeDescription
directoryServiceType?any

Resources

state(infinite)— StoragePool is a container for volumes with a service level and capacity. Vol...
@swamp/gcp/netapp/volumesv2026.04.23.1volumes.ts

Global Arguments

ArgumentTypeDescription
backupConfig?objectBackupConfig contains backup related config on a volume.
blockDevices?arrayOptional. Block devices for the volume. Currently, only one block device is permitted per Volume.
cacheParameters?objectCache Parameters for the volume.
capacityGib?stringRequired. Capacity in GIB of the volume
cloneDetails?objectDetails about a clone volume.
description?stringOptional. Description of the volume
exportPolicy?objectDefines the export policy for the volume.
hybridReplicationParameters?objectThe Hybrid Replication parameters for the volume.
kerberosEnabled?booleanOptional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
labels?recordOptional. Labels as key value pairs
largeCapacity?booleanOptional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the `large_capacity_config` field instead. This field and `large_capacity_config` are mutually exclusive.
largeCapacityConfig?objectConfiguration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool.
multipleEndpoints?booleanOptional. 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?stringIdentifier. Name of the volume
protocols?arrayRequired. Protocols required for the volume
restoreParameters?objectThe RestoreParameters if volume is created from a snapshot or backup.
restrictedActions?arrayOptional. List of actions that are restricted on this volume.
securityStyle?enumOptional. Security Style of the Volume
shareName?stringRequired. Share name of the volume
smbSettings?arrayOptional. SMB share settings for the volume.
snapReserve?numberOptional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.
snapshotDirectory?booleanOptional. 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?objectSnapshot Policy for a volume.
storagePool?stringRequired. StoragePool name of the volume
throughputMibps?numberOptional. Throughput of the volume (in MiB/s)
tieringPolicy?objectDefines tiering policy for the volume.
unixPermissions?stringOptional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.
volumeId?stringRequired. Id of the requesting volume. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a volumes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a volumes
ArgumentTypeDescription
identifierstringThe name of the volumes
updateUpdate volumes attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the volumes
ArgumentTypeDescription
identifierstringThe name of the volumes
syncSync volumes state from GCP
establish_peeringestablish peering
ArgumentTypeDescription
peerClusterName?any
peerIpAddresses?any
peerSvmName?any
peerVolumeName?any
restorerestore
ArgumentTypeDescription
backup?any
fileList?any
restoreDestinationPath?any
revertrevert
ArgumentTypeDescription
snapshotId?any

Resources

state(infinite)— Volume provides a filesystem that you can mount.
@swamp/gcp/netapp/volumes-quotarulesv2026.04.23.1volumes_quotarules.ts

Global Arguments

ArgumentTypeDescription
description?stringOptional. Description of the quota rule
diskLimitMib?numberRequired. The maximum allowed disk space in MiB.
labels?recordOptional. Labels of the quota rule
name?stringIdentifier. The resource name of the quota rule. Format: `projects/{project_number}/locations/{location_id}/volumes/volumes/{volume_id}/quotaRules/{quota_rule_id}`.
target?stringOptional. The quota rule applies to the specified user or group, identified by a Unix UID/GID, Windows SID, or null for default.
type?enumRequired. The type of quota rule.
quotaRuleId?stringRequired. ID of the quota rule to create. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore or a number, and a 63 character maximum.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a quotaRules
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a quotaRules
ArgumentTypeDescription
identifierstringThe name of the quotaRules
updateUpdate quotaRules attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the quotaRules
ArgumentTypeDescription
identifierstringThe name of the quotaRules
syncSync quotaRules state from GCP

Resources

state(infinite)— QuotaRule specifies the maximum disk space a user or group can use within a v...
@swamp/gcp/netapp/volumes-replicationsv2026.04.23.1volumes_replications.ts

Global Arguments

ArgumentTypeDescription
clusterLocation?stringOptional. Location of the user cluster.
description?stringA description about this replication relationship.
destinationVolumeParameters?objectDestinationVolumeParameters specify input parameters used for creating destination volume.
hybridPeeringDetails?objectHybridPeeringDetails contains details about the hybrid peering.
hybridReplicationUserCommands?objectUserCommands contains the commands to be executed by the customer.
labels?recordResource labels to represent user provided metadata.
name?stringIdentifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
replicationSchedule?enumRequired. Indicates the schedule for replication.
transferStats?objectTransferStats reports all statistics related to replication transfer.
replicationId?stringRequired. ID of the replication to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a replications
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a replications
ArgumentTypeDescription
identifierstringThe name of the replications
updateUpdate replications attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the replications
ArgumentTypeDescription
identifierstringThe name of the replications
syncSync replications state from GCP
establish_peeringestablish peering
ArgumentTypeDescription
peerClusterName?any
peerIpAddresses?any
peerSvmName?any
peerVolumeName?any
resumeresume
reverse_directionreverse direction
stopstop
ArgumentTypeDescription
force?any
action_syncsync

Resources

state(infinite)— Replication is a nested resource under Volume, that describes a cross-region ...
@swamp/gcp/netapp/volumes-snapshotsv2026.04.23.1volumes_snapshots.ts

Global Arguments

ArgumentTypeDescription
description?stringA description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
labels?recordResource labels to represent user provided metadata.
name?stringIdentifier. The resource name of the snapshot. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`.
snapshotId?stringRequired. ID of the snapshot to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a snapshots
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a snapshots
ArgumentTypeDescription
identifierstringThe name of the snapshots
updateUpdate snapshots attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the snapshots
ArgumentTypeDescription
identifierstringThe name of the snapshots
syncSync snapshots state from GCP

Resources

state(infinite)— Snapshot is a point-in-time version of a Volume's content.