Gcp/vmwareengine

@swamp/gcp/vmwareenginev2026.06.16.1· 1d agoMODELS

01README

Google Cloud vmwareengine infrastructure models

02Release Notes

Updated: privateclouds

03Models20

@swamp/gcp/vmwareengine/announcementsv2026.06.08.1announcements.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a announcements

Argument	Type	Required	Description
identifier	string	yes	The name of the announcements

fn sync()

Sync announcements state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List announcements resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of announcement runs, you can exclude the ones named `example-announcement` by specifying `name != "example-announcement"`. You can also filter nested fields. To fil
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of announcements to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Announcement for the resources of Vmware Engine.

@swamp/gcp/vmwareengine/datastoresv2026.06.08.1datastores.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
description?	string	no	Optional. User-provided description for this datastore
nfsDatastore?	object	no	The NFS datastore configuration.
datastoreId?	string	no	Required. The user-provided identifier of the datastore to be created. This identifier must be unique among each `Datastore` within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
requestId?	string	no	Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a datastores

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a datastores

Argument	Type	Required	Description
identifier	string	yes	The name of the datastores

fn update(waitForReady?: boolean)

Update datastores attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the datastores

Argument	Type	Required	Description
identifier	string	yes	The name of the datastores

fn sync()

Sync datastores state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, requestId?: string, maxPages?: number)

List datastores resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of datastores, you can exclude the ones named `example-datastore` by specifying `name != "example-datastore"`. To filter on multiple expressions, provide e
orderBy?	string	no	Optional. Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	Optional. The maximum number of results to return in one page. The maximum value is coerced to 1000. The default value of this field is 500.
requestId?	string	no	Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Represents a datastore resource.

@swamp/gcp/vmwareengine/locationsv2026.06.08.1locations.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.

fn get(identifier: string)

Get a locations

Argument	Type	Required	Description
identifier	string	yes	The name of the locations

fn sync()

Sync locations state from GCP

fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)

List locations resources

Argument	Type	Required	Description
extraLocationTypes?	string	no	Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?	string	no	A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize?	number	no	The maximum number of results to return. If not set, the service selects a default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_dns_bind_permission()

get dns bind permission

Resources

state(infinite)— A resource that represents a Google Cloud location.

@swamp/gcp/vmwareengine/networkpeeringsv2026.06.08.1networkpeerings.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
description?	string	no	Optional. User-provided description for this network peering.
exchangeSubnetRoutes?	boolean	no	Optional. True if full mesh connectivity is created and managed automatically between peered networks; false otherwise. Currently this field is always true because Google Compute Engine automatically creates and manages subnetwork routes between two VPC networks when peering state is 'ACTIVE'.
exportCustomRoutes?	boolean	no	Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.
exportCustomRoutesWithPublicIp?	boolean	no	Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.
importCustomRoutes?	boolean	no	Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.
importCustomRoutesWithPublicIp?	boolean	no	Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field.
peerMtu?	number	no	Optional. Maximum transmission unit (MTU) in bytes. The default value is `1500`. If a value of `0` is provided for this field, VMware Engine uses the default value instead.
peerNetwork?	string	no	Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the `peer_network_type` is VMWARE_ENGINE_NETWORK, specify the name in the form: `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. Otherwise specify the name in the form: `projects/{project}/global/networks/{network_id}`, where `{project}` can either be a project numb
peerNetworkType?	enum	no	Required. The type of the network to peer with the VMware Engine network.
vmwareEngineNetwork?	string	no	Required. The relative resource name of the VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}` can either be a project number or a project ID.
networkPeeringId?	string	no	Required. The user-provided identifier of the new `NetworkPeering`. This identifier must be unique among `NetworkPeering` resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
requestId?	string	no	Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation wi
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a networkPeerings

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a networkPeerings

Argument	Type	Required	Description
identifier	string	yes	The name of the networkPeerings

fn update(waitForReady?: boolean)

Update networkPeerings attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the networkPeerings

Argument	Type	Required	Description
identifier	string	yes	The name of the networkPeerings

fn sync()

Sync networkPeerings state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List networkPeerings resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of network peerings, you can exclude the ones named `example-peering` by specifying `name != "example-peering"`. To filter on multiple expressions, provide each sepa
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of network peerings to return in one page. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Details of a network peering.

@swamp/gcp/vmwareengine/networkpeerings-peeringroutesv2026.06.08.1networkpeerings_peeringroutes.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a peeringRoutes

Argument	Type	Required	Description
identifier	string	yes	The name of the peeringRoutes

fn sync()

Sync peeringRoutes state from GCP

fn list(filter?: string, pageSize?: number, maxPages?: number)

List peeringRoutes resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. Currently, only filtering on the `direction` field is supported. To return routes imported from the peer network, provide "direction=INCOMING". To return routes exported from the VMware Engine network, provide "direction=OUTGOING". Other filter expressions return an error.
pageSize?	number	no	The maximum number of peering routes to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Exchanged network peering route.

@swamp/gcp/vmwareengine/networkpoliciesv2026.06.08.1networkpolicies.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
description?	string	no	Optional. User-provided description for this network policy.
edgeServicesCidr?	string	no	Required. IP address range in CIDR notation used to create internet access and external IP access. An RFC 1918 CIDR block, with a "/26" prefix, is required. The range cannot overlap with any prefixes either in the consumer VPC network or in use by the private clouds attached to that VPC network.
externalIp?	object	no	Represents a network service that is managed by a `NetworkPolicy` resource. A network service provides a way to control an aspect of external access to VMware workloads. For example, whether the VMware workloads in the private clouds governed by a network policy can access or be accessed from the internet.
internetAccess?	object	no	Represents a network service that is managed by a `NetworkPolicy` resource. A network service provides a way to control an aspect of external access to VMware workloads. For example, whether the VMware workloads in the private clouds governed by a network policy can access or be accessed from the internet.
vmwareEngineNetwork?	string	no	Optional. The relative resource name of the VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}` can either be a project number or a project ID.
networkPolicyId?	string	no	Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent `projects/{my-project}/locations/{us-central1}/networkPolicies` and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc
requestId?	string	no	Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation wi
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a networkPolicies

fn get(identifier: string)

Get a networkPolicies

Argument	Type	Required	Description
identifier	string	yes	The name of the networkPolicies

fn update()

Update networkPolicies attributes

fn delete(identifier: string)

Delete the networkPolicies

Argument	Type	Required	Description
identifier	string	yes	The name of the networkPolicies

fn sync()

Sync networkPolicies state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List networkPolicies resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of network policies, you can exclude the ones named `example-policy` by specifying `name != "example-policy"`. To filter on multiple expressions, provide each separa
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of network policies to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn fetch_external_addresses()

fetch external addresses

Resources

state(infinite)— Represents a network policy resource. Network policies are regional resources...

@swamp/gcp/vmwareengine/networkpolicies-externalaccessrulesv2026.06.08.1networkpolicies_externalaccessrules.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
action?	enum	no	The action that the external access rule performs.
description?	string	no	User-provided description for this external access rule.
destinationIpRanges?	array	no	If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify `0.0.0.0/0`. To match a specific external IP address, specify it using the `IpRange.external_address` property.
destinationPorts?	array	no	A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: `["22"]`, `["80","443"]`, or `["12345-12349"]`. To match all destination ports, specify `["0-65535"]`.
ipProtocol?	string	no	The IP protocol to which the external access rule applies. This value can be one of the following three protocol strings (not case-sensitive): `tcp`, `udp`, or `icmp`.
priority?	number	no	External access rule priority, which determines the external access rule to use when multiple rules apply. If multiple rules have the same priority, their ordering is non-deterministic. If specific ordering is required, assign unique priorities to enforce such ordering. The external access rule priority is an integer from 100 to 4096, both inclusive. Lower integers indicate higher precedence. For example, a rule with priority `100` has higher precedence than a rule with priority `101`.
sourceIpRanges?	array	no	If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, `ExternalAddress` resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify `0.0.0.0/0`.
sourcePorts?	array	no	A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: `["22"]`, `["80","443"]`, or `["12345-12349"]`. To match all source ports, specify `["0-65535"]`.
externalAccessRuleId?	string	no	Required. The user-provided identifier of the `ExternalAccessRule` to be created. This identifier must be unique among `ExternalAccessRule` resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (s
requestId?	string	no	A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a externalAccessRules

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a externalAccessRules

Argument	Type	Required	Description
identifier	string	yes	The name of the externalAccessRules

fn update(waitForReady?: boolean)

Update externalAccessRules attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the externalAccessRules

Argument	Type	Required	Description
identifier	string	yes	The name of the externalAccessRules

fn sync()

Sync externalAccessRules state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List externalAccessRules resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of external access rules, you can exclude the ones named `example-rule` by specifying `name != "example-rule"`. To filter on multiple expressions, provide each separ
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of external access rules to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— External access firewall rules for filtering incoming traffic destined to `Ex...

@swamp/gcp/vmwareengine/nodetypesv2026.06.08.1nodetypes.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a nodeTypes

Argument	Type	Required	Description
identifier	string	yes	The name of the nodeTypes

fn sync()

Sync nodeTypes state from GCP

fn list(filter?: string, pageSize?: number, maxPages?: number)

List nodeTypes resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of node types, you can exclude the ones named `standard-72` by specifying `name != "standard-72"`. To filter on multiple expressions, provide each separate expressio
pageSize?	number	no	The maximum number of node types to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Describes node type.

@swamp/gcp/vmwareengine/privatecloudsv2026.06.16.1privateclouds.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
description?	string	no	User-provided description for this private cloud.
encryptionConfig?	object	no	Encryption configuration for a private cloud.
hcx?	object	no	Details about a HCX Cloud Manager appliance.
managementCluster?	object	no	Management cluster configuration.
networkConfig?	object	no	Network configuration in the consumer project with which the peering has to be done.
nsx?	object	no	Details about a NSX Manager appliance.
type?	enum	no	Optional. Type of the private cloud. Defaults to STANDARD.
vcenter?	object	no	Details about a vCenter Server management appliance.
privateCloudId?	string	no	Required. The user-provided identifier of the private cloud to be created. This identifier must be unique among each `PrivateCloud` within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
requestId?	string	no	Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a privateClouds

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a privateClouds

Argument	Type	Required	Description
identifier	string	yes	The name of the privateClouds

fn update(waitForReady?: boolean)

Update privateClouds attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the privateClouds

Argument	Type	Required	Description
identifier	string	yes	The name of the privateClouds

fn sync()

Sync privateClouds state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List privateClouds resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of private clouds, you can exclude the ones named `example-pc` by specifying `name != "example-pc"`. You can also filter nested fields. For example, you could specif
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of private clouds to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_dns_forwarding()

get dns forwarding

fn get_iam_policy()

get iam policy

fn migrate_management_vms(clusterId?: any, etag?: any, requestId?: any)

migrate management vms

Argument	Type	Required
clusterId?	any	no
etag?	any	no
requestId?	any	no

fn private_cloud_deletion_now(etag?: any, requestId?: any)

private cloud deletion now

Argument	Type	Required	Description
etag?	any	no
requestId?	any	no

fn reset_nsx_credentials(requestId?: any)

reset nsx credentials

Argument	Type	Required	Description
requestId?	any	no

fn reset_vcenter_credentials(requestId?: any, username?: any)

reset vcenter credentials

Argument	Type	Required	Description
requestId?	any	no
username?	any	no

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn show_nsx_credentials()

show nsx credentials

fn show_vcenter_credentials()

show vcenter credentials

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

fn undelete(requestId?: any)

undelete

Argument	Type	Required	Description
requestId?	any	no

fn update_dns_forwarding(createTime?: any, forwardingRules?: any, name?: any, updateTime?: any)

update dns forwarding

Argument	Type	Required
createTime?	any	no
forwardingRules?	any	no
name?	any	no
updateTime?	any	no

Resources

state(infinite)— Represents a private cloud resource. Private clouds of type `STANDARD` and `T...

@swamp/gcp/vmwareengine/privateclouds-clustersv2026.06.08.1privateclouds_clusters.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
autoscalingSettings?	object	no	Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud.
nodeTypeConfigs?	record	no	Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`).
stretchedClusterConfig?	object	no	Configuration of a stretched cluster.
clusterId?	string	no	Required. The user-provided identifier of the new `Cluster`. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
requestId?	string	no	Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a clusters

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a clusters

Argument	Type	Required	Description
identifier	string	yes	The name of the clusters

fn update(waitForReady?: boolean)

Update clusters attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the clusters

Argument	Type	Required	Description
identifier	string	yes	The name of the clusters

fn sync()

Sync clusters state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List clusters resources

Argument	Type	Required	Description
filter?	string	no	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-cluster") (nodeCount = "3") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "example-cluster-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") ```
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of clusters to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy()

get iam policy

fn mount_datastore(datastoreMountConfig?: any, ignoreColocation?: any, requestId?: any, validateOnly?: any)

mount datastore

Argument	Type	Required
datastoreMountConfig?	any	no
ignoreColocation?	any	no
requestId?	any	no
validateOnly?	any	no

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

fn unmount_datastore(datastore?: any, requestId?: any, validateOnly?: any)

unmount datastore

Argument	Type	Required
datastore?	any	no
requestId?	any	no
validateOnly?	any	no

Resources

state(infinite)— A cluster in a private cloud.

@swamp/gcp/vmwareengine/privateclouds-clusters-nodesv2026.06.08.1privateclouds_clusters_nodes.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a nodes

Argument	Type	Required	Description
identifier	string	yes	The name of the nodes

fn sync()

Sync nodes state from GCP

fn list(pageSize?: number, maxPages?: number)

List nodes resources

Argument	Type	Required	Description
pageSize?	number	no	The maximum number of nodes to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Node in a cluster.

@swamp/gcp/vmwareengine/privateclouds-externaladdressesv2026.06.08.1privateclouds_externaladdresses.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
description?	string	no	User-provided description for this resource.
internalIp?	string	no	The internal IP address of a workload VM.
externalAddressId?	string	no	Required. The user-provided identifier of the `ExternalAddress` to be created. This identifier must be unique among `ExternalAddress` resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section
requestId?	string	no	Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operatio
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a externalAddresses

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a externalAddresses

Argument	Type	Required	Description
identifier	string	yes	The name of the externalAddresses

fn update(waitForReady?: boolean)

Update externalAddresses attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the externalAddresses

Argument	Type	Required	Description
identifier	string	yes	The name of the externalAddresses

fn sync()

Sync externalAddresses state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List externalAddresses resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of IP addresses, you can exclude the ones named `example-ip` by specifying `name != "example-ip"`. To filter on multiple expressions, provide each separate expressio
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of external IP addresses to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Represents an allocated external IP address and its corresponding internal IP...

@swamp/gcp/vmwareengine/privateclouds-hcxactivationkeysv2026.06.08.1privateclouds_hcxactivationkeys.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
hcxActivationKeyId?	string	no	Required. The user-provided identifier of the `HcxActivationKey` to be created. This identifier must be unique among `HcxActivationKey` resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (secti
requestId?	string	no	A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the sam
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a hcxActivationKeys

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a hcxActivationKeys

Argument	Type	Required	Description
identifier	string	yes	The name of the hcxActivationKeys

fn sync()

Sync hcxActivationKeys state from GCP

fn list(pageSize?: number, maxPages?: number)

List hcxActivationKeys resources

Argument	Type	Required	Description
pageSize?	number	no	The maximum number of HCX activation keys to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy()

get iam policy

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— HCX activation key. A default key is created during private cloud provisionin...

@swamp/gcp/vmwareengine/privateclouds-loggingserversv2026.06.08.1privateclouds_loggingservers.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
hostname?	string	no	Required. Fully-qualified domain name (FQDN) or IP Address of the logging server.
port?	number	no	Required. Port number at which the logging server receives logs.
protocol?	enum	no	Required. Protocol used by vCenter to send logs to a logging server.
sourceType?	enum	no	Required. The type of component that produces logs that will be forwarded to this logging server.
loggingServerId?	string	no	Required. The user-provided identifier of the `LoggingServer` to be created. This identifier must be unique among `LoggingServer` resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5
requestId?	string	no	Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation wi
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a loggingServers

fn get(identifier: string)

Get a loggingServers

Argument	Type	Required	Description
identifier	string	yes	The name of the loggingServers

fn update()

Update loggingServers attributes

fn delete(identifier: string)

Delete the loggingServers

Argument	Type	Required	Description
identifier	string	yes	The name of the loggingServers

fn sync()

Sync loggingServers state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List loggingServers resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of logging servers, you can exclude the ones named `example-server` by specifying `name != "example-server"`. To filter on multiple expressions, provide each separat
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of logging servers to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Logging server to receive vCenter or ESXi logs.

@swamp/gcp/vmwareengine/privateclouds-managementdnszonebindingsv2026.06.08.1privateclouds_managementdnszonebindings.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
description?	string	no	User-provided description for this resource.
vmwareEngineNetwork?	string	no	Network to bind is a VMware Engine network. Specify the name in the following form for VMware engine network: `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. `{project}` can either be a project number or a project ID.
vpcNetwork?	string	no	Network to bind is a standard consumer VPC. Specify the name in the following form for consumer VPC network: `projects/{project}/global/networks/{network_id}`. `{project}` can either be a project number or a project ID.
managementDnsZoneBindingId?	string	no	Required. The user-provided identifier of the `ManagementDnsZoneBinding` resource to be created. This identifier must be unique among `ManagementDnsZoneBinding` resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org
requestId?	string	no	Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operatio
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a managementDnsZoneBindings

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a managementDnsZoneBindings

Argument	Type	Required	Description
identifier	string	yes	The name of the managementDnsZoneBindings

fn update(waitForReady?: boolean)

Update managementDnsZoneBindings attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the managementDnsZoneBindings

Argument	Type	Required	Description
identifier	string	yes	The name of the managementDnsZoneBindings

fn sync()

Sync managementDnsZoneBindings state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List managementDnsZoneBindings resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of Management DNS Zone Bindings, you can exclude the ones named `example-management-dns-zone-binding` by specifying `name != "example-management-dns-zone-binding"`.
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of management DNS zone bindings to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn repair(requestId?: any)

repair

Argument	Type	Required	Description
requestId?	any	no

Resources

state(infinite)— Represents a binding between a network and the management DNS zone. A managem...

@swamp/gcp/vmwareengine/privateclouds-subnetsv2026.06.08.1privateclouds_subnets.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
gatewayIp?	string	no	The IP address of the gateway of this subnet. Must fall within the IP prefix defined above.
ipCidrRange?	string	no	The IP address range of the subnet in CIDR format '10.0.0.0/24'.
name?	string	no	Output only. Identifier. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet`
state?	enum	no	Output only. The state of the resource.
type?	string	no	Output only. The type of the subnet. For example "management" or "userDefined".
vlanId?	number	no	Output only. VLAN ID of the VLAN on which the subnet is configured
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a subnets

Argument	Type	Required	Description
identifier	string	yes	The name of the subnets

fn update(waitForReady?: boolean)

Update subnets attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn sync()

Sync subnets state from GCP

fn list(pageSize?: number, maxPages?: number)

List subnets resources

Argument	Type	Required	Description
pageSize?	number	no	The maximum number of subnets to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Subnet in a private cloud. Either `management` subnets (such as vMotion) that...

@swamp/gcp/vmwareengine/privateclouds-upgradesv2026.06.08.1privateclouds_upgrades.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
componentUpgrades?	array	no	Output only. Output Only. The list of component upgrades.
createTime?	string	no	Output only. Output Only. Creation time of this resource.
description?	string	no	Output only. Output Only. The description of the upgrade. This is used to provide additional information about the private cloud upgrade, such as the upgrade's purpose, the changes included in the upgrade, or any other relevant information about the upgrade.
endTime?	string	no	Output only. Output Only. End time of the upgrade.
estimatedDuration?	string	no	Output only. Output Only. The estimated total duration of the upgrade. This information can be used to plan or schedule upgrades to minimize disruptions. Please note that the estimated duration is only an estimate. The actual upgrade duration may vary.
etag?	string	no	The etag for the upgrade resource. If this is provided on update, it must match the server's etag.
name?	string	no	Output only. Identifier. The resource name of the private cloud `Upgrade`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade`
schedule?	object	no	Schedule for the upgrade.
startVersion?	string	no	Output only. Output Only. The start version
state?	enum	no	Output only. The current state of the upgrade.
targetVersion?	string	no	Output only. Output Only. The target version
type?	enum	no	Output only. Output Only. The type of upgrade.
uid?	string	no	Output only. System-generated unique identifier for the resource.
updateTime?	string	no	Output only. Output Only. Last update time of this resource.
version?	string	no	Output only.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a upgrades

Argument	Type	Required	Description
identifier	string	yes	The name of the upgrades

fn update(waitForReady?: boolean)

Update upgrades attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn sync()

Sync upgrades state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List upgrades resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of upgrades, you can exclude the ones named `example-upgrade1` by specifying `name != "example-upgrade1"`. You can also filter nested fields. To filter on multiple e
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of `Upgrades` to return in one page. The service may return fewer resources than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Describes Private cloud Upgrade.

@swamp/gcp/vmwareengine/privateconnectionsv2026.06.08.1privateconnections.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
description?	string	no	Optional. User-provided description for this private connection.
routingMode?	enum	no	Optional. Routing Mode. Default value is set to GLOBAL. For type = PRIVATE_SERVICE_ACCESS, this field can be set to GLOBAL or REGIONAL, for other types only GLOBAL is supported.
serviceNetwork?	string	no	Required. Service network to create private connection. Specify the name in the following form: `projects/{project}/global/networks/{network_id}` For type = PRIVATE_SERVICE_ACCESS, this field represents servicenetworking VPC, e.g. projects/project-tp/global/networks/servicenetworking. For type = NETAPP_CLOUD_VOLUME, this field represents NetApp service VPC, e.g. projects/project-tp/global/networks/netapp-tenant-vpc. For type = DELL_POWERSCALE, this field represent Dell service VPC, e.g. projects
type?	enum	no	Required. Private connection type.
vmwareEngineNetwork?	string	no	Required. The relative resource name of Legacy VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}`, `{location}` will be same as specified in private connection resource name and `{vmware_engine_network_id}` will be in the form of `{location}`-default e.g. projects/project/locations/us-central1/vmwareEngineNetworks/us-central1-default.
privateConnectionId?	string	no	Required. The user-provided identifier of the new private connection. This identifier must be unique among private connection resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
requestId?	string	no	Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation wi
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a privateConnections

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a privateConnections

Argument	Type	Required	Description
identifier	string	yes	The name of the privateConnections

fn update(waitForReady?: boolean)

Update privateConnections attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the privateConnections

Argument	Type	Required	Description
identifier	string	yes	The name of the privateConnections

fn sync()

Sync privateConnections state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List privateConnections resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of private connections, you can exclude the ones named `example-connection` by specifying `name != "example-connection"`. To filter on multiple expressions, provide
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of private connections to return in one page. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Private connection resource that provides connectivity for VMware Engine priv...

@swamp/gcp/vmwareengine/privateconnections-peeringroutesv2026.06.08.1privateconnections_peeringroutes.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a peeringRoutes

Argument	Type	Required	Description
identifier	string	yes	The name of the peeringRoutes

fn sync()

Sync peeringRoutes state from GCP

fn list(pageSize?: number, maxPages?: number)

List peeringRoutes resources

Argument	Type	Required	Description
pageSize?	number	no	The maximum number of peering routes to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Exchanged network peering route.

@swamp/gcp/vmwareengine/vmwareenginenetworksv2026.06.08.1vmwareenginenetworks.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
description?	string	no	User-provided description for this VMware Engine network.
type?	enum	no	Required. VMware Engine network type.
requestId?	string	no	Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation wi
vmwareEngineNetworkId?	string	no	Required. The user-provided identifier of the new VMware Engine network. This identifier must be unique among VMware Engine network resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * For networks of type LEGACY, adheres to the format: `{region-id}-default`. Replace `{region-id}` with the region where you want to create the VMware Engine network. For example, "us-central1-default". * Only contains 1-63 alphanumeric chara
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a vmwareEngineNetworks

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a vmwareEngineNetworks

Argument	Type	Required	Description
identifier	string	yes	The name of the vmwareEngineNetworks

fn update(waitForReady?: boolean)

Update vmwareEngineNetworks attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the vmwareEngineNetworks

Argument	Type	Required	Description
identifier	string	yes	The name of the vmwareEngineNetworks

fn sync()

Sync vmwareEngineNetworks state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List vmwareEngineNetworks resources

Argument	Type	Required	Description
filter?	string	no	A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of network peerings, you can exclude the ones named `example-network` by specifying `name != "example-network"`. To filter on multiple expressions, provide each sepa
orderBy?	string	no	Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize?	number	no	The maximum number of results to return in one page. The maximum value is coerced to 1000. The default value of this field is 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— VMware Engine network resource that provides connectivity for VMware Engine p...

04Previous Versions17

2026.06.08.2Jun 8, 2026

Updated: locations, announcements, datastores, networkpeerings, networkpeerings_peeringroutes, networkpolicies, networkpolicies_externalaccessrules, nodetypes, privateclouds, privateclouds_clusters, privateclouds_clusters_nodes, privateclouds_externaladdresses, privateclouds_hcxactivationkeys, privateclouds_loggingservers, privateclouds_managementdnszonebindings, privateclouds_subnets, privateclouds_upgrades, privateconnections, privateconnections_peeringroutes, vmwareenginenetworks

2026.06.07.1Jun 7, 2026

Updated: locations, announcements, datastores, networkpeerings, networkpeerings_peeringroutes, networkpolicies, networkpolicies_externalaccessrules, nodetypes, privateclouds, privateclouds_clusters, privateclouds_clusters_nodes, privateclouds_externaladdresses, privateclouds_hcxactivationkeys, privateclouds_loggingservers, privateclouds_managementdnszonebindings, privateclouds_subnets, privateclouds_upgrades, privateconnections, privateconnections_peeringroutes, vmwareenginenetworks

2026.05.26.1May 26, 2026

Updated: locations, privateclouds

Modified 1 models

2026.05.25.1May 25, 2026

Updated: locations, announcements, datastores, networkpeerings, networkpeerings_peeringroutes, networkpolicies, networkpolicies_externalaccessrules, nodetypes, privateclouds, privateclouds_clusters, privateclouds_clusters_nodes, privateclouds_externaladdresses, privateclouds_hcxactivationkeys, privateclouds_loggingservers, privateclouds_managementdnszonebindings, privateclouds_subnets, privateclouds_upgrades, privateconnections, privateconnections_peeringroutes, vmwareenginenetworks

Modified 20 models

2026.05.24.1May 24, 2026

Updated: locations, announcements, datastores, networkpeerings, networkpeerings_peeringroutes, networkpolicies, networkpolicies_externalaccessrules, nodetypes, privateclouds, privateclouds_clusters, privateclouds_clusters_nodes, privateclouds_externaladdresses, privateclouds_hcxactivationkeys, privateclouds_loggingservers, privateclouds_managementdnszonebindings, privateclouds_subnets, privateclouds_upgrades, privateconnections, privateconnections_peeringroutes, vmwareenginenetworks

2026.05.21.2May 21, 2026

Updated: locations, announcements, datastores, networkpeerings, networkpeerings_peeringroutes, networkpolicies, networkpolicies_externalaccessrules, nodetypes, privateclouds, privateclouds_clusters, privateclouds_clusters_nodes, privateclouds_externaladdresses, privateclouds_hcxactivationkeys, privateclouds_loggingservers, privateclouds_managementdnszonebindings, privateclouds_subnets, privateclouds_upgrades, privateconnections, privateconnections_peeringroutes, vmwareenginenetworks

2026.05.21.1May 21, 2026

Modified 3 models

2026.05.19.2May 19, 2026

2026.05.19.1May 19, 2026

2026.05.18.1May 18, 2026

2026.04.23.1Apr 23, 2026

2026.04.04.1Apr 4, 2026

Updated: privateclouds_upgrades

2026.04.03.3Apr 3, 2026

Updated: locations, announcements, datastores, networkpeerings, networkpeerings_peeringroutes, networkpolicies, networkpolicies_externalaccessrules, nodetypes, privateclouds, privateclouds_clusters, privateclouds_clusters_nodes, privateclouds_externaladdresses, privateclouds_hcxactivationkeys, privateclouds_loggingservers, privateclouds_managementdnszonebindings, privateclouds_subnets, privateclouds_upgrades, privateconnections, privateconnections_peeringroutes, vmwareenginenetworks

2026.04.03.1Apr 3, 2026

Updated: locations, announcements, datastores, networkpeerings, networkpeerings_peeringroutes, networkpolicies, networkpolicies_externalaccessrules, nodetypes, privateclouds, privateclouds_clusters, privateclouds_clusters_nodes, privateclouds_externaladdresses, privateclouds_hcxactivationkeys, privateclouds_loggingservers, privateclouds_managementdnszonebindings, privateclouds_subnets, privateclouds_upgrades, privateconnections, privateconnections_peeringroutes, vmwareenginenetworks

2026.04.02.2Apr 2, 2026

Updated: networkpeerings, networkpolicies, networkpolicies_externalaccessrules, privateclouds, privateclouds_clusters, privateclouds_externaladdresses, privateconnections, vmwareenginenetworks

2026.03.31.1Mar 31, 2026

Updated: networkpeerings, networkpolicies, networkpolicies_externalaccessrules, privateclouds, privateclouds_clusters, privateclouds_externaladdresses, privateconnections, vmwareenginenetworks

2026.03.27.1Mar 27, 2026

Added: locations, announcements, datastores, networkpeerings, networkpeerings_peeringroutes, networkpolicies, networkpolicies_externalaccessrules, nodetypes, privateclouds, privateclouds_clusters, privateclouds_clusters_nodes, privateclouds_externaladdresses, privateclouds_hcxactivationkeys, privateclouds_loggingservers, privateclouds_managementdnszonebindings, privateclouds_subnets, privateclouds_upgrades, privateconnections, privateconnections_peeringroutes, vmwareenginenetworks

05Stats

100 / 100

Downloads

Archive size

219.3 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

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

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#gcp #google-cloud #vmwareengine #cloud #infrastructure