File: //snap/google-cloud-cli/current/lib/surface/network_management/connectivity_tests/update.yaml
- release_tracks: [GA, BETA]
help_text:
brief: |
Update an existing connectivity test.
description: |
Update an existing connectivity test with the given name.
examples: |
The following command updates a connectivity test with the name my-test,
modifying the description and destination IP address.
$ {command} my-test \
--description='update dst addr' --destination-ip-address='10.142.0.3'
arguments:
resource:
spec: !REF googlecloudsdk.command_lib.network_management.resources:connectivityTest
help_text: |
Name of the connectivity test you want to update.
params:
- group:
mutex: true
params:
- arg_name: source-instance
api_field: connectivityTest.source.instance
help_text: |
A Compute Engine instance URI as the source endpoint.
- arg_name: clear-source-instance
type: bool
help_text: |
Clear existing source instance.
- arg_name: source-network
api_field: connectivityTest.source.network
help_text: |
A VPC network URI where the source is located.
- arg_name: source-network-type
api_field: connectivityTest.source.networkType
help_text: |
Type of the network where the source is located.
choices:
- enum_value: gcp-network
arg_value: gcp-network
help_text: Network in Google Cloud Platform.
- enum_value: non-gcp-network
arg_value: non-gcp-network
help_text: Network outside Google Cloud Platform.
default: gcp-network
- group:
mutex: true
params:
- arg_name: source-ip-address
api_field: connectivityTest.source.ipAddress
help_text: |
The IP address of the source which can be an external or internal IP.
- arg_name: clear-source-ip-address
type: bool
help_text: |
Clear existing source IP address.
- arg_name: source-project
api_field: connectivityTest.source.projectId
help_text: |
Project ID of the source endpoint.
- group:
mutex: true
params:
- arg_name: source-gke-master-cluster
api_field: connectivityTest.source.gkeMasterCluster
help_text: |
A cluster URI for Google Kubernetes Engine master as the source endpoint.
- arg_name: clear-source-gke-master-cluster
type: bool
help_text: |
Clear existing source cluster for Google Kubernetes Engine master.
- group:
mutex: true
params:
- arg_name: source-cloud-sql-instance
api_field: connectivityTest.source.cloudSqlInstance
help_text: |
A Cloud SQL instance URI as the source endpoint.
- arg_name: clear-source-cloud-sql-instance
type: bool
help_text: |
Clear existing source Cloud SQL instance.
- group:
mutex: true
params:
- arg_name: source-cloud-function
api_field: connectivityTest.source.cloudFunction.uri
help_text: |
A Cloud function URI as the source endpoint.
- arg_name: clear-source-cloud-function
type: bool
help_text: |
Clear existing source Cloud function.
- group:
mutex: true
params:
- arg_name: source-app-engine-version
api_field: connectivityTest.source.appEngineVersion.uri
help_text: |
App Engine version URI as the source endpoint.
- arg_name: clear-source-app-engine-version
type: bool
help_text: |
Clear existing source App Engine version.
- group:
mutex: true
params:
- arg_name: source-cloud-run-revision
api_field: connectivityTest.source.cloudRunRevision.uri
help_text: |
Cloud Run revision URI as the source endpoint.
- arg_name: clear-source-cloud-run-revision
type: bool
help_text: |
Clear existing source Cloud Run revision.
- group:
mutex: true
params:
- arg_name: destination-instance
api_field: connectivityTest.destination.instance
help_text: |
A Compute Engine instance URI as the destination endpoint.
- arg_name: clear-destination-instance
type: bool
help_text:
Clear existing destination instance.
- arg_name: destination-network
api_field: connectivityTest.destination.network
help_text: |
A VPC network URI where the destination is located.
- arg_name: destination-port
api_field: connectivityTest.destination.port
help_text: |
The IP protocol port of the destination. Only applicable when protocol is
TCP or UDP.
- group:
mutex: true
params:
- arg_name: destination-ip-address
api_field: connectivityTest.destination.ipAddress
help_text: |
The IP address of the destination which can be an external or internal IP.
- arg_name: clear-destination-ip-address
type: bool
help_text: |
Clear existing destination IP address.
- arg_name: destination-project
api_field: connectivityTest.destination.projectId
help_text: |
Project ID of the destination endpoint.
- arg_name: destination-fqdn
api_field: connectivityTest.destination.fqdn
help_text: |
A hostname as the destination endpoint. Only applicable for Google Kubernetes Engine.
- group:
mutex: true
params:
- arg_name: destination-gke-master-cluster
api_field: connectivityTest.destination.gkeMasterCluster
help_text: |
A cluster URI for Google Kubernetes Engine master as the destination endpoint.
- arg_name: clear-destination-gke-master-cluster
type: bool
help_text: |
Clear existing destination cluster for Google Kubernetes Engine master.
- group:
mutex: true
params:
- arg_name: destination-cloud-sql-instance
api_field: connectivityTest.destination.cloudSqlInstance
help_text: |
A Cloud SQL instance URI as the destination endpoint.
- arg_name: clear-destination-cloud-sql-instance
type: bool
help_text: |
Clear existing destination Cloud SQL instance.
- group:
mutex: true
params:
- arg_name: destination-forwarding-rule
api_field: connectivityTest.destination.forwardingRule
help_text: |
A forwarding rule URI as the destination endpoint.
- arg_name: clear-destination-forwarding-rule
type: bool
help_text: |
Clear existing destination forwarding rule.
- group:
mutex: true
params:
- arg_name: destination-redis-instance
api_field: connectivityTest.destination.redisInstance
help_text: |
A Redis instance URI as the destination endpoint.
- arg_name: clear-destination-redis-instance
type: bool
help_text: |
Clear existing destination Redis Instance.
- group:
mutex: true
params:
- arg_name: destination-redis-cluster
api_field: connectivityTest.destination.redisCluster
help_text: |
A Redis cluster URI as the destination endpoint.
- arg_name: clear-destination-redis-cluster
type: bool
help_text: |
Clear existing destination Redis Cluster.
- arg_name: description
api_field: connectivityTest.description
help_text: |
The description of the connectivity test.
- arg_name: protocol
api_field: connectivityTest.protocol
help_text: |
Type of protocol for the test. When not provided, "TCP" is assumed.
- arg_name: round-trip
type: bool
api_field: connectivityTest.roundTrip
help_text: |
This boolean controls whether return traces (from the destination to the
source) will be additionally calculated if packet successfully reaches
the destination from the source. Use --no-round-trip to disable.
- arg_name: bypass-firewall-checks
type: bool
api_field: connectivityTest.bypassFirewallChecks
help_text: |
This boolean controls whether to skip firewall checking. Use
--no-bypass-firewall-checks to disable.
- arg_name: other-projects
api_field: connectivityTest.relatedProjects
repeated: true
help_text: |
IDs of other projects involved in the connectivity test, besides
the source and destination project.
- arg_name: labels
api_field: connectivityTest.labels.additionalProperties
metavar: KEY=VALUE
help_text: |
List of label KEY=VALUE pairs to add.
type:
arg_dict:
spec:
- api_field: key
- api_field: value
async:
collection: networkmanagement.projects.locations.global.operations
request:
BETA:
api_version: v1beta1
modify_request_hooks:
- googlecloudsdk.command_lib.network_management.util:ValidateInstanceNames
- googlecloudsdk.command_lib.network_management.util:ValidateNetworkURIs
- googlecloudsdk.command_lib.network_management.util:ClearEndpointAttrsBeta
- googlecloudsdk.command_lib.network_management.util:ValidateGKEMasterClustersURIs
- googlecloudsdk.command_lib.network_management.util:ValidateCloudSQLInstancesURIs
- googlecloudsdk.command_lib.network_management.util:ValidateCloudFunctionsURIs
- googlecloudsdk.command_lib.network_management.util:ValidateAppEngineVersionsURIs
- googlecloudsdk.command_lib.network_management.util:ValidateCloudRunRevisionsURIs
- googlecloudsdk.command_lib.network_management.util:ValidateForwardingRulesURIs
- googlecloudsdk.command_lib.network_management.util:ValidateRedisInstancesURIs
- googlecloudsdk.command_lib.network_management.util:ValidateRedisClustersURIs
- googlecloudsdk.command_lib.network_management.util:ValidateFqdn
GA:
api_version: v1
modify_request_hooks:
- googlecloudsdk.command_lib.network_management.util:ValidateInstanceNames
- googlecloudsdk.command_lib.network_management.util:ValidateNetworkURIs
- googlecloudsdk.command_lib.network_management.util:ClearEndpointAttrs
- googlecloudsdk.command_lib.network_management.util:ValidateGKEMasterClustersURIs
- googlecloudsdk.command_lib.network_management.util:ValidateCloudSQLInstancesURIs
- googlecloudsdk.command_lib.network_management.util:ValidateCloudFunctionsURIs
- googlecloudsdk.command_lib.network_management.util:ValidateAppEngineVersionsURIs
- googlecloudsdk.command_lib.network_management.util:ValidateCloudRunRevisionsURIs
- googlecloudsdk.command_lib.network_management.util:ValidateForwardingRulesURIs
- googlecloudsdk.command_lib.network_management.util:ValidateRedisInstancesURIs
- googlecloudsdk.command_lib.network_management.util:ValidateRedisClustersURIs
- googlecloudsdk.command_lib.network_management.util:ValidateFqdn
method: patch
collection: networkmanagement.projects.locations.global.connectivityTests
update:
read_modify_update: true