REST Resource: projects.locations.networkMonitoringProviders.monitoringPoints

Resource: MonitoringPoint

Message describing MonitoringPoint resource.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "displayName": string,
  "originatingIp": string,
  "version": string,
  "type": string,
  "connectionStatus": enum (ConnectionStatus),
  "hostname": string,
  "geoLocation": {
    object (GeoLocation)
  },
  "upgradeType": enum (UpgradeType),
  "networkInterfaces": [
    {
      object (NetworkInterface)
    }
  ],
  "errors": [
    enum (ErrorCode)
  ],
  "autoGeoLocationEnabled": boolean,
  "providerTags": [
    {
      object (ProviderTag)
    }
  ],
  "host": {
    object (Host)
  },
  "upgradeAvailable": boolean,
  "guid": string
}
Fields
name

string

Identifier. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{networkMonitoringProvider}/monitoringPoints/{monitoring_point}
createTime

string (Timestamp format)

Output only. The time the MonitoringPoint was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time the MonitoringPoint was updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
displayName

string

Output only. Display name of the MonitoringPoint.
originatingIp

string

Output only. IP address visible when MonitoringPoint connects to the provider.
version

string

Output only. Version of the software running on the MonitoringPoint.
type

string

Output only. Deployment type of the MonitoringPoint.
connectionStatus

enum (ConnectionStatus)

Output only. Connection status of the MonitoringPoint.
hostname

string

Output only. The hostname of the MonitoringPoint.
geoLocation

object (GeoLocation)

Output only. The geographical location of the MonitoringPoint. ;
upgradeType

enum (UpgradeType)

Output only. The type of upgrade available for the MonitoringPoint.
networkInterfaces[]

object (NetworkInterface)

Output only. The network interfaces of the MonitoringPoint.
errors[]

enum (ErrorCode)

Output only. The codes of errors detected in the MonitoringPoint.
autoGeoLocationEnabled

boolean

Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint.
providerTags[]

object (ProviderTag)

Output only. The provider tags of the MonitoringPoint.
host

object (Host)

Output only. The host information of the MonitoringPoint.
upgradeAvailable

boolean

Output only. Indicates if an upgrade is available for the MonitoringPoint.
guid

string

Output only. The GUID of the MonitoringPoint.

ConnectionStatus

Enum for the connection status of MonitoringPoint.

Enums
CONNECTION_STATUS_UNSPECIFIED The default value. This value is used if the status is omitted.
ONLINE MonitoringPoint is online.
OFFLINE MonitoringPoint is offline.

UpgradeType

Enum for the type of upgrade available for the MonitoringPoint.

Enums
UPGRADE_TYPE_UNSPECIFIED The default value. This value is used if the upgrade type is omitted.
MANUAL Upgrades are performed manually.
MANAGED Upgrades are managed.
SCHEDULED Upgrade is scheduled.
AUTO Upgrades are performed automatically.
EXTERNAL Upgrades are performed externally.

NetworkInterface

Message describing network interfaces.

JSON representation 
{
  "interfaceName": string,
  "speed": string,
  "ipAddress": string,
  "cidr": string,
  "macAddress": string,
  "adapterDescription": string,
  "vlanId": string
}
Fields
interfaceName

string

Output only. The name of the network interface. Examples: eth0, eno1
speed

string (int64 format)

Output only. Speed of the interface in millions of bits per second.
ipAddress

string

Output only. The IP address of the interface.
cidr

string

Output only. The IP address of the interface and subnet mask in CIDR format. Examples: 192.168.1.0/24, 2001:db8::/32
macAddress

string

Output only. The MAC address of the interface.
adapterDescription

string

Output only. The description of the interface.
vlanId

string (int64 format)

Output only. The id of the VLAN.

ErrorCode

Enum for the error codes.

Enums
ERROR_CODE_UNSPECIFIED The default value. This value is used if the error code is omitted.
NTP_ERROR Error detected in NTP service.
UPGRADE_ERROR Error detected during the upgrade process.
DOWNLOAD_FAILED Error detected while downloading.

Host

Message describing information about the host.

JSON representation 
{
  "os": string,
  "cloudProvider": string,
  "cloudProjectId": string,
  "cloudInstanceId": string,
  "cloudRegion": string,
  "cloudZone": string,
  "cloudVirtualNetworkIds": [
    string
  ]
}
Fields
os

string

Output only. The operating system of the host.
cloudProvider

string

Output only. The cloud provider of the host.
cloudProjectId

string

Output only. The cloud project id of the host.
cloudInstanceId

string

Output only. The cloud instance id of the host.
cloudRegion

string

Output only. The cloud region of the host.
cloudZone

string

Output only. The cloud zone of the host.
cloudVirtualNetworkIds[]

string

Output only. The ids of cloud virtual networks of the host.

Methods

downloadInstallScript

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

downloadRecreateInstallScript

 Downloads an install script for a specific Container MonitoringPoint.

downloadServerConnectConfig

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

get

 Gets the MonitoringPoint resource.

list

 Lists MonitoringPoints for a given network monitoring provider.