monitoring_points

Creates, updates, deletes, gets or lists a monitoring_points resource.

Overview

Name	monitoring_points
Type	Resource
Id	google.networkmanagement.monitoring_points

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}
autoGeoLocationEnabled	boolean	Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint.
connectionStatus	string	Output only. Connection status of the MonitoringPoint. (CONNECTION_STATUS_UNSPECIFIED, ONLINE, OFFLINE)
createTime	string (google-datetime)	Output only. The time the MonitoringPoint was created.
deploymentType	string	Output only. The deployment type of the MonitoringPoint. (DEPLOYMENT_TYPE_UNSPECIFIED, DOCKER, PODMAN, HELM)
displayName	string	Output only. Display name of the MonitoringPoint.
errors	array	Output only. The codes of errors detected in the MonitoringPoint.
geoLocation	object	Output only. The geographical location of the MonitoringPoint. (id: GeoLocation)
guid	string	Output only. The GUID of the MonitoringPoint.
host	object	Output only. The host information of the MonitoringPoint. (id: Host)
hostname	string	Output only. The hostname of the MonitoringPoint.
networkInterfaces	array	Output only. The network interfaces of the MonitoringPoint.
originatingIp	string	Output only. IP address visible when MonitoringPoint connects to the provider.
providerTags	array	Output only. The provider tags of the MonitoringPoint.
type	string	Output only. Deployment type of the MonitoringPoint.
updateTime	string (google-datetime)	Output only. The time the MonitoringPoint was updated.
upgradeAvailable	boolean	Output only. Indicates if an upgrade is available for the MonitoringPoint.
upgradeType	string	Output only. The type of upgrade available for the MonitoringPoint. (UPGRADE_TYPE_UNSPECIFIED, MANUAL, MANAGED, SCHEDULED, AUTO, EXTERNAL)
version	string	Output only. Version of the software running on the MonitoringPoint.

list

Name	Datatype	Description
name	string	Identifier. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}
autoGeoLocationEnabled	boolean	Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint.
connectionStatus	string	Output only. Connection status of the MonitoringPoint. (CONNECTION_STATUS_UNSPECIFIED, ONLINE, OFFLINE)
createTime	string (google-datetime)	Output only. The time the MonitoringPoint was created.
deploymentType	string	Output only. The deployment type of the MonitoringPoint. (DEPLOYMENT_TYPE_UNSPECIFIED, DOCKER, PODMAN, HELM)
displayName	string	Output only. Display name of the MonitoringPoint.
errors	array	Output only. The codes of errors detected in the MonitoringPoint.
geoLocation	object	Output only. The geographical location of the MonitoringPoint. (id: GeoLocation)
guid	string	Output only. The GUID of the MonitoringPoint.
host	object	Output only. The host information of the MonitoringPoint. (id: Host)
hostname	string	Output only. The hostname of the MonitoringPoint.
networkInterfaces	array	Output only. The network interfaces of the MonitoringPoint.
originatingIp	string	Output only. IP address visible when MonitoringPoint connects to the provider.
providerTags	array	Output only. The provider tags of the MonitoringPoint.
type	string	Output only. Deployment type of the MonitoringPoint.
updateTime	string (google-datetime)	Output only. The time the MonitoringPoint was updated.
upgradeAvailable	boolean	Output only. Indicates if an upgrade is available for the MonitoringPoint.
upgradeType	string	Output only. The type of upgrade available for the MonitoringPoint. (UPGRADE_TYPE_UNSPECIFIED, MANUAL, MANAGED, SCHEDULED, AUTO, EXTERNAL)
version	string	Output only. Version of the software running on the MonitoringPoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, networkMonitoringProvidersId, monitoringPointsId		Gets the MonitoringPoint resource.
list	select	projectsId, locationsId, networkMonitoringProvidersId	pageSize, pageToken	Lists MonitoringPoints for a given network monitoring provider.
download_install_script	exec	projectsId, locationsId, networkMonitoringProvidersId	staticIpAddress.domain, privateConnectivityEnabled, _password, timeZone.version, hostname, staticIpAddress.ipAddress, staticIpAddress.netmask, ntpServerAddress, ntpServerSecondaryAddress, staticIpAddress.gatewayAddress, staticIpAddress.dnsServerAddress, timeZone.id, monitoringPointType, staticIpAddress.dnsServerSecondaryAddress, useDhcp	Downloads an install script for MonitoringPoints for a given network monitoring provider.
download_server_connect_config	exec	projectsId, locationsId, networkMonitoringProvidersId		Downloads the server connect configuration for a given network monitoring provider.
download_recreate_install_script	exec	projectsId, locationsId, networkMonitoringProvidersId, monitoringPointsId	hostname	Downloads an install script for a specific Container MonitoringPoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
monitoringPointsId	string
networkMonitoringProvidersId	string
projectsId	string
_password	string
hostname	string
monitoringPointType	string
ntpServerAddress	string
ntpServerSecondaryAddress	string
pageSize	integer (int32)
pageToken	string
privateConnectivityEnabled	boolean
staticIpAddress.dnsServerAddress	string
staticIpAddress.dnsServerSecondaryAddress	string
staticIpAddress.domain	string
staticIpAddress.gatewayAddress	string
staticIpAddress.ipAddress	string
staticIpAddress.netmask	string
timeZone.id	string
timeZone.version	string
useDhcp	boolean

SELECT examples

get

Gets the MonitoringPoint resource.

SELECT
name,
autoGeoLocationEnabled,
connectionStatus,
createTime,
deploymentType,
displayName,
errors,
geoLocation,
guid,
host,
hostname,
networkInterfaces,
originatingIp,
providerTags,
type,
updateTime,
upgradeAvailable,
upgradeType,
version
FROM google.networkmanagement.monitoring_points
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND networkMonitoringProvidersId = '{{ networkMonitoringProvidersId }}' -- required
AND monitoringPointsId = '{{ monitoringPointsId }}' -- required
;

list

Lists MonitoringPoints for a given network monitoring provider.

SELECT
name,
autoGeoLocationEnabled,
connectionStatus,
createTime,
deploymentType,
displayName,
errors,
geoLocation,
guid,
host,
hostname,
networkInterfaces,
originatingIp,
providerTags,
type,
updateTime,
upgradeAvailable,
upgradeType,
version
FROM google.networkmanagement.monitoring_points
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND networkMonitoringProvidersId = '{{ networkMonitoringProvidersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

Lifecycle Methods

download_install_script

Downloads an install script for MonitoringPoints for a given network monitoring provider.

EXEC google.networkmanagement.monitoring_points.download_install_script 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@networkMonitoringProvidersId='{{ networkMonitoringProvidersId }}' --required, 
@staticIpAddress.domain='{{ staticIpAddress.domain }}', 
@privateConnectivityEnabled={{ privateConnectivityEnabled }}, 
@_password='{{ _password }}', 
@timeZone.version='{{ timeZone.version }}', 
@hostname='{{ hostname }}', 
@staticIpAddress.ipAddress='{{ staticIpAddress.ipAddress }}', 
@staticIpAddress.netmask='{{ staticIpAddress.netmask }}', 
@ntpServerAddress='{{ ntpServerAddress }}', 
@ntpServerSecondaryAddress='{{ ntpServerSecondaryAddress }}', 
@staticIpAddress.gatewayAddress='{{ staticIpAddress.gatewayAddress }}', 
@staticIpAddress.dnsServerAddress='{{ staticIpAddress.dnsServerAddress }}', 
@timeZone.id='{{ timeZone.id }}', 
@monitoringPointType='{{ monitoringPointType }}', 
@staticIpAddress.dnsServerSecondaryAddress='{{ staticIpAddress.dnsServerSecondaryAddress }}', 
@useDhcp={{ useDhcp }}
;

download_server_connect_config

Downloads the server connect configuration for a given network monitoring provider.

EXEC google.networkmanagement.monitoring_points.download_server_connect_config 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@networkMonitoringProvidersId='{{ networkMonitoringProvidersId }}' --required
;

download_recreate_install_script

Downloads an install script for a specific Container MonitoringPoint.

EXEC google.networkmanagement.monitoring_points.download_recreate_install_script 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@networkMonitoringProvidersId='{{ networkMonitoringProvidersId }}' --required, 
@monitoringPointsId='{{ monitoringPointsId }}' --required, 
@hostname='{{ hostname }}'
;