Gcp/cloudnumberregistry

@swamp/gcp/cloudnumberregistryv2026.06.08.2· 18d agoMODELS

01README

Google Cloud cloudnumberregistry infrastructure models

02Release Notes

Updated: locations, customranges, discoveredranges, ipamadminscopes, realms, registrybooks

03Models6

customranges.tsv2026.06.08.1

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.
attributes?	array	no	Required. The key of the attribute.
description?	string	no	Optional. The description of the CustomRange.
ipv4CidrRange?	string	no	Optional. The IPv4 CIDR range of the CustomRange.
ipv6CidrRange?	string	no	Optional. The IPv6 CIDR range of the CustomRange.
labels?	record	no	Optional. User-defined labels.
name?	string	no	Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`.
parentRange?	string	no	Optional. The resource name of the parent CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. If specified, the parent CustomRange must be in the same RegistryBook. This field is mutually exclusive with the `realm` field, as the Realm is inherited from the parent CustomRange.
realm?	string	no	Optional. The resource name of the Realm associated with the CustomRange, in the format `projects/{project}/locations/{location}/realms/{realm}`. The Realm must be in the same project as the CustomRange. This field must not be set if the `parent_range` field is set, as the Realm will be inherited from the parent CustomRange.
customRangeId?	string	no	Required. The ID to use for the CustomRange, which will become the final segment of the resource name.
requestId?	string	no	Optional. An optional 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 will guarantee that for at least 60 minutes since the first request. 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 same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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()

Create a customRanges

fn get(identifier: string)

Get a customRanges

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

fn update()

Update customRanges attributes

fn delete(identifier: string)

Delete the customRanges

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

fn sync()

Sync customRanges state from GCP

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

List customRanges resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filter expression to filter the results.
orderBy?	string	no	Optional. Hint for how to order the results.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn find_free_ip_ranges()

find free ip ranges

fn show_utilization()

show utilization

discoveredranges.tsv2026.06.08.1

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 discoveredRanges

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

fn sync()

Sync discoveredRanges state from GCP

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

List discoveredRanges resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filter expression to filter the results.
orderBy?	string	no	Optional. Hint for how to order the results.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn find_free_ip_ranges()

find free ip ranges

fn show_utilization()

show utilization

ipamadminscopes.tsv2026.06.08.1

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.
enabledAddonPlatforms?	array	no	Required. Add-on platforms that are enabled for this IpamAdminScope. Cloud Number Registry only discovers the IP addresses from the enabled platforms.
labels?	record	no	Optional. User-defined labels.
name?	string	no	Required. Identifier. The resource name of the IpamAdminScope.
scopes?	array	no	Required. Administrative scopes enabled for IP address discovery and management. For example, "organizations/1234567890". Minimum of 1 scope is required. In preview, only one organization scope is allowed.
ipamAdminScopeId?	string	no	Required. The ID to use for the IpamAdminScope, which will become the final segment of the resource name.
requestId?	string	no	Optional. An optional 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 will guarantee that for at least 60 minutes since the first request. 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 same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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()

Create a ipamAdminScopes

fn get(identifier: string)

Get a ipamAdminScopes

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

fn update()

Update ipamAdminScopes attributes

fn delete(identifier: string)

Delete the ipamAdminScopes

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

fn sync()

Sync ipamAdminScopes state from GCP

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

List ipamAdminScopes resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filter expression to filter the results.
orderBy?	string	no	Optional. Hint for how to order the results.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn check_availability()

check availability

fn cleanup(requestId?: any)

cleanup

Argument	Type	Required	Description
requestId?	any	no

fn disable(requestId?: any)

disable

Argument	Type	Required	Description
requestId?	any	no

locations.tsv2026.06.08.1

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)

realms.tsv2026.06.08.1

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.
aggregatedData?	object	no	Output only. Number of CustomRanges in the Realm.
discoveryMetadata?	object	no	Output only. The time when the resource was created.
ipVersion?	enum	no	Optional. IP version of the Realm.
labels?	record	no	Optional. User-defined labels.
managementType?	enum	no	Required. Management type of the Realm.
name?	string	no	Required. Identifier. The resource name of the Realm.
registryBook?	string	no	Required. Name of the RegistryBook that claims the Realm.
trafficType?	enum	no	Required. Traffic type of the Realm.
realmId?	string	no	Required. The ID to use for the Realm, which will become the final segment of the resource name.
requestId?	string	no	Optional. An optional 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 will guarantee that for at least 60 minutes since the first request.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a realms

fn get(identifier: string)

Get a realms

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

fn update()

Update realms attributes

fn delete(identifier: string)

Delete the realms

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

fn sync()

Sync realms state from GCP

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

List realms resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filter expression to filter the results.
orderBy?	string	no	Optional. Hint for how to order the results.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
view?	string	no	Optional. The view of the Realm to retrieve.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

registrybooks.tsv2026.06.08.1

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.
aggregatedData?	object	no	Output only. Number of CustomRanges in the RegistryBook.
claimedScopes?	array	no	Optional. List of scopes claimed by the RegistryBook. In Preview, Only project scope is supported. Each scope is in the format of projects/{project}. Each scope can only be claimed once.
labels?	record	no	Optional. User-defined labels.
name?	string	no	Required. Identifier. The resource name of the RegistryBook.
registryBookId?	string	no	Required. The ID to use for the RegistryBook, which will become the final segment of the resource name.
requestId?	string	no	Optional. An optional 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 will guarantee that for at least 60 minutes since the first request. 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 same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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()

Create a registryBooks

fn get(identifier: string)

Get a registryBooks

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

fn update()

Update registryBooks attributes

fn delete(identifier: string)

Delete the registryBooks

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

fn sync()

Sync registryBooks state from GCP

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

List registryBooks resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filter expression to filter the results.
orderBy?	string	no	Optional. Hint for how to order the results.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
view?	string	no	Optional. The view of the RegistryBook to retrieve.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn search_ip_resources(orderBy?: any, pageSize?: any, pageToken?: any, query?: any, searchResourceTypes?: any, showUtilization?: any)

search ip resources

Argument	Type	Required
orderBy?	any	no
pageSize?	any	no
pageToken?	any	no
query?	any	no
searchResourceTypes?	any	no
showUtilization?	any	no

04Previous Versions10

2026.06.07.1Jun 7, 2026

Updated: locations, customranges, discoveredranges, ipamadminscopes, realms, registrybooks

2026.06.03.1Jun 3, 2026

Updated: customranges, discoveredranges, ipamadminscopes, realms, registrybooks

2026.05.26.1May 26, 2026

Updated: locations, customranges, discoveredranges, ipamadminscopes, realms, registrybooks

Modified 6 models

2026.05.24.1May 24, 2026

Updated: locations, customranges, discoveredranges, ipamadminscopes, realms, registrybooks

2026.05.21.2May 21, 2026

Updated: locations, customranges, discoveredranges, ipamadminscopes, realms, registrybooks

2026.05.21.1May 21, 2026

2026.05.20.1May 20, 2026

Updated: locations, customranges, discoveredranges, ipamadminscopes, realms, registrybooks

2026.05.19.1May 19, 2026

2026.05.18.1May 18, 2026

2026.05.12.1May 12, 2026

Added: locations, customranges, discoveredranges, ipamadminscopes, realms, registrybooks

05Stats

100 / 100

Downloads

Archive size

65.8 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 #cloudnumberregistry #cloud #infrastructure