Gcp/networkmanagement
@swamp/gcp/networkmanagementv2026.06.03.1
01README
Google Cloud networkmanagement infrastructure models
02Release Notes
- Updated: global_connectivitytests
03Models
@swamp/gcp/networkmanagement/global-connectivitytestsv2026.06.03.1global_connectivitytests.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| bypassFirewallChecks? | boolean | Whether the analysis should skip firewall checking. Default value is false. |
| description? | string | The user-supplied description of the Connectivity Test. Maximum of 512 characters. |
| destination? | object | Source or destination of the Connectivity Test. |
| labels? | record | Resource labels to represent user-provided metadata. |
| name? | string | Identifier. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}` |
| probingDetails? | object | Results of active probing from the last run of the test. |
| protocol? | string | IP Protocol of the test. When not provided, "TCP" is assumed. |
| reachabilityDetails? | object | Results of the configuration analysis from the last run of the test. |
| relatedProjects? | array | Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries. |
| returnReachabilityDetails? | object | Results of the configuration analysis from the last run of the test. |
| roundTrip? | boolean | Whether run analysis for the return path from destination to source. Default value is false. |
| source? | object | Source or destination of the Connectivity Test. |
| testId? | string | Required. The logical name of the Connectivity Test in your project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a connectivityTests
fn get(identifier: string)
Get a connectivityTests
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connectivityTests |
fn update()
Update connectivityTests attributes
fn delete(identifier: string)
Delete the connectivityTests
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connectivityTests |
fn sync()
Sync connectivityTests state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List connectivityTests resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Lists the `ConnectivityTests` that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `>`, `<=`, `>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/proj-1/locations/global/connectivit |
| orderBy? | string | Field to use to sort the list. |
| pageSize? | number | Number of `ConnectivityTests` to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy()
get iam policy
fn rerun()
rerun
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A Connectivity Test for a network reachability analysis.
@swamp/gcp/networkmanagement/locationsv2026.05.26.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | 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 | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | 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 | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/networkmanagement/networkmonitoringprovidersv2026.05.27.1networkmonitoringproviders.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| providerType? | enum | Required. Type of the NetworkMonitoringProvider. |
| networkMonitoringProviderId? | string | Required. The ID to use for the NetworkMonitoringProvider resource, which will become the final component of the NetworkMonitoringProvider resource's name. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a networkMonitoringProviders
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a networkMonitoringProviders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the networkMonitoringProviders |
fn delete(identifier: string)
Delete the networkMonitoringProviders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the networkMonitoringProviders |
fn sync()
Sync networkMonitoringProviders state from GCP
fn list(pageSize?: number, maxPages?: number)
List networkMonitoringProviders resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn generate_monitoring_point_config()
generate monitoring point config
fn generate_provider_access_token()
generate provider access token
Resources
state(infinite)— Message describing NetworkMonitoringProvider resource.
@swamp/gcp/networkmanagement/networkmonitoringproviders-monitoringpointsv2026.05.27.1networkmonitoringproviders_monitoringpoints.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a monitoringPoints
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the monitoringPoints |
fn sync()
Sync monitoringPoints state from GCP
fn list(pageSize?: number, maxPages?: number)
List monitoringPoints resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn download_install_script()
download install script
fn download_recreate_install_script()
download recreate install script
fn download_server_connect_config()
download server connect config
Resources
state(infinite)— Message describing MonitoringPoint resource.
@swamp/gcp/networkmanagement/networkmonitoringproviders-networkpathsv2026.05.26.1networkmonitoringproviders_networkpaths.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a networkPaths
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the networkPaths |
fn sync()
Sync networkPaths state from GCP
fn list(pageSize?: number, maxPages?: number)
List networkPaths resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of network paths to return. The service may return fewer than this value. If unspecified, at most 20 network pathswill be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Message describing NetworkPath resource.
@swamp/gcp/networkmanagement/networkmonitoringproviders-webpathsv2026.05.26.1networkmonitoringproviders_webpaths.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a webPaths
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the webPaths |
fn sync()
Sync webPaths state from GCP
fn list(pageSize?: number, maxPages?: number)
List webPaths resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of web paths to return. The service may return fewer than this value. If unspecified, at most 20 web paths will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Message describing WebPath resource.
@swamp/gcp/networkmanagement/vpcflowlogsconfigsv2026.05.25.1vpcflowlogsconfigs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| aggregationInterval? | enum | Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. |
| crossProjectMetadata? | enum | Optional. Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED. |
| description? | string | Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters. |
| filterExpr? | string | Optional. Export filter used to define which VPC Flow Logs should be logged. |
| flowSampling | number | |
| interconnectAttachment? | string | Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name} |
| labels? | record | Optional. Resource labels to represent user-provided metadata. |
| metadata? | enum | Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA. |
| metadataFields? | array | Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA. |
| name? | string | Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` - For organization-level configurations: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` |
| network? | string | Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/global/networks/{name} |
| state? | enum | Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config. |
| subnet? | string | Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{name} |
| vpnTunnel? | string | Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name} |
| vpcFlowLogsConfigId? | string | Required. ID of the `VpcFlowLogsConfig`. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create(waitForReady?: boolean)
Create a vpcFlowLogsConfigs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a vpcFlowLogsConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the vpcFlowLogsConfigs |
fn update(waitForReady?: boolean)
Update vpcFlowLogsConfigs attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the vpcFlowLogsConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the vpcFlowLogsConfigs |
fn sync()
Sync vpcFlowLogsConfigs state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List vpcFlowLogsConfigs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). |
| orderBy? | string | Optional. Field to use to sort the list. |
| pageSize? | number | Optional. Number of `VpcFlowLogsConfigs` to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A configuration to generate VPC Flow Logs.
04Previous Versions
2026.05.27.1May 27, 2026
- Updated: global_connectivitytests, networkmonitoringproviders, networkmonitoringproviders_monitoringpoints
2026.05.26.1May 26, 2026
- Added: networkmonitoringproviders, networkmonitoringproviders_monitoringpoints, networkmonitoringproviders_networkpaths, networkmonitoringproviders_webpaths
- Updated: locations, global_connectivitytests
Added 4 models
2026.05.25.1May 25, 2026
- Updated: locations, vpcflowlogsconfigs, global_connectivitytests
Removed 4, modified 3 models
2026.05.24.1May 24, 2026
- Updated: locations, vpcflowlogsconfigs, global_connectivitytests, networkmonitoringproviders, networkmonitoringproviders_monitoringpoints, networkmonitoringproviders_networkpaths, networkmonitoringproviders_webpaths
2026.05.21.2May 21, 2026
- Updated: locations, vpcflowlogsconfigs, global_connectivitytests, networkmonitoringproviders, networkmonitoringproviders_monitoringpoints, networkmonitoringproviders_networkpaths, networkmonitoringproviders_webpaths
2026.05.21.1May 21, 2026
Modified 1 models
2026.05.20.1May 20, 2026
- Added: networkmonitoringproviders, networkmonitoringproviders_monitoringpoints, networkmonitoringproviders_networkpaths, networkmonitoringproviders_webpaths
- Updated: global_connectivitytests
Added 4 models
2026.05.19.3May 19, 2026
Removed 4 models
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
- Added: networkmonitoringproviders, networkmonitoringproviders_monitoringpoints, networkmonitoringproviders_networkpaths, networkmonitoringproviders_webpaths
Added 4 models
2026.05.18.2May 18, 2026
2026.05.01.1May 1, 2026
- Updated: global_connectivitytests
2026.04.23.1Apr 23, 2026
2026.04.04.1Apr 4, 2026
- Updated: global_connectivitytests
2026.04.03.3Apr 3, 2026
- Updated: locations, vpcflowlogsconfigs, global_connectivitytests
2026.04.03.1Apr 3, 2026
- Updated: locations, vpcflowlogsconfigs, global_connectivitytests
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: locations, vpcflowlogsconfigs, global_connectivitytests
05Stats
A
100 / 100
Downloads
0
Archive size
78.0 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 types1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels