connectivity_tests

Overview

Name	connectivity_tests
Type	Resource
Id	google.networkmanagement.connectivity_tests

Fields

Name	Datatype	Description
name	string	Required. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}
description	string	The user-supplied description of the Connectivity Test. Maximum of 512 characters.
createTime	string	Output only. The time the test was created.
destination	object	Source or destination of the Connectivity Test.
displayName	string	Output only. The display name of a Connectivity Test.
labels	object	Resource labels to represent user-provided metadata.
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.
source	object	Source or destination of the Connectivity Test.
updateTime	string	Output only. The time the test's configuration was updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	connectivityTestsId, projectsId	Gets the details of a specific Connectivity Test.
list	SELECT	projectsId	Lists all Connectivity Tests owned by a project.
create	INSERT	projectsId	Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. If the endpoint specifications in ConnectivityTest are invalid (for example, containing non-existent resources in the network, or you don't have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN. If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. For more information, see the Connectivity Test documentation.
delete	DELETE	connectivityTestsId, projectsId	Deletes a specific ConnectivityTest.
_list	EXEC	projectsId	Lists all Connectivity Tests owned by a project.
patch	EXEC	connectivityTestsId, projectsId	Updates the configuration of an existing ConnectivityTest. After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result. If the endpoint specifications in ConnectivityTest are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN. If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. See the documentation in ConnectivityTest for for more details.
rerun	EXEC	connectivityTestsId, projectsId	Rerun an existing ConnectivityTest. After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes. If the endpoint specifications in ConnectivityTest become invalid (for example, specified resources are deleted in the network, or you lost read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN.