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

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

Method Details

close()

Close httplib2 connections.

downloadInstallScript(parent, hostname=None, monitoringPointType=None, ntpServerAddress=None, ntpServerSecondaryAddress=None, privateConnectivityEnabled=None, staticIpAddress_dnsServerAddress=None, staticIpAddress_dnsServerSecondaryAddress=None, staticIpAddress_domain=None, staticIpAddress_gatewayAddress=None, staticIpAddress_ipAddress=None, staticIpAddress_netmask=None, timeZone_id=None, timeZone_version=None, useDhcp=None, x__xgafv=None, x_password=None)

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

Args:
parent: string, Required. Parent value for DownloadInstallScriptRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
hostname: string, Required. The hostname of the MonitoringPoint, e.g. "test-vm"
monitoringPointType: string, Required. The type of the monitoring point.
Allowed values
MONITORING_POINT_TYPE_UNSPECIFIED - This value should not be used.
CONTAINER - Monitoring Point that runs in a Docker container.
KVM - Monitoring Point that runs in a Kernel-based Virtual Machine (KVM) hypervisor.
VMWARE - Monitoring Point that runs in a VMware hypervisor.
HELM - Monitoring Point that runs on a K8S Helm.
GCE_VM - Monitoring Point that runs as a startup script in a Compute Engine VM.
AZURE_VM - Monitoring Point that runs as a startup script in an Azure VM.
AWS_EC2 - Monitoring Point that runs as a startup script in an AWS EC2 instance.
ntpServerAddress: string, Optional. Network Time Protocol a user can configure. If the user omits the field, the default is either NTP servers provided in the DHCP lease or a set of well-known NTP servers pre-configured on the monitoring point. This field can be an IP address or FQDN.
ntpServerSecondaryAddress: string, Optional. Second NTP server.
privateConnectivityEnabled: boolean, Optional. For Google Cloud MPs, this field indicates whether the Monitoring Point is deployed in a Private Service Connect deployment. Not used for non-Google Cloud MPs.
staticIpAddress_dnsServerAddress: string, Required. DNS server.
staticIpAddress_dnsServerSecondaryAddress: string, Optional. Second DNS server.
staticIpAddress_domain: string, Optional. Domain name of the MonitoringPoint.
staticIpAddress_gatewayAddress: string, Required. Gateway IP address. Example: "100.80.40.1".
staticIpAddress_ipAddress: string, Required. IP address of the MonitoringPoint.
staticIpAddress_netmask: string, Optional. Networkmask and CIDR range. Example: "255.255.255.0/24"
timeZone_id: string, IANA Time Zone Database time zone. For example "America/New_York".
timeZone_version: string, Optional. IANA Time Zone Database version number. For example "2019a".
useDhcp: boolean, Optional. Dynamic Host Configuration Protocol, is a network management protocol that automatically assigns IP addresses and other network configuration parameters to devices connecting to a network.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
x_password: string, Optional. Password for logging into the MonitoringPoint.

Returns:
An object of the form:

{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
}

downloadRecreateInstallScript(name, hostname=None, x__xgafv=None)

Downloads an install script for a specific Container MonitoringPoint.

Args:
  name: string, Required. Resource name of the MonitoringPoint. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point} (required)
  hostname: string, Optional. The hostname of the MonitoringPoint, e.g. "test-vm"
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
  "data": "A String", # The HTTP request/response body as raw binary.
  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
    {
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  ],
}

downloadServerConnectConfig(parent, x__xgafv=None)

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

Args:
  parent: string, Required. Parent value for DownloadServerConnectConfigRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
  "data": "A String", # The HTTP request/response body as raw binary.
  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
    {
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  ],
}

get(name, x__xgafv=None)

Gets the MonitoringPoint resource.

Args:
  name: string, Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing MonitoringPoint resource.
  "autoGeoLocationEnabled": True or False, # Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint.
  "connectionStatus": "A String", # Output only. Connection status of the MonitoringPoint.
  "createTime": "A String", # Output only. The time the MonitoringPoint was created.
  "deploymentType": "A String", # Output only. The deployment type of the MonitoringPoint.
  "displayName": "A String", # Output only. Display name of the MonitoringPoint.
  "errors": [ # Output only. The codes of errors detected in the MonitoringPoint.
    "A String",
  ],
  "geoLocation": { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint.
    "formattedAddress": "A String", # Formatted address.
    "regionCode": "A String", # Unicode CLDR region code.
  },
  "guid": "A String", # Output only. The GUID of the MonitoringPoint.
  "host": { # Message describing information about the host. # Output only. The host information of the MonitoringPoint.
    "cloudInstanceId": "A String", # Output only. The cloud instance id of the host.
    "cloudProjectId": "A String", # Output only. The cloud project id of the host.
    "cloudProvider": "A String", # Output only. The cloud provider of the host.
    "cloudRegion": "A String", # Output only. The cloud region of the host.
    "cloudVirtualNetworkIds": [ # Output only. The ids of cloud virtual networks of the host.
      "A String",
    ],
    "cloudZone": "A String", # Output only. The cloud zone of the host.
    "os": "A String", # Output only. The operating system of the host.
  },
  "hostname": "A String", # Output only. The hostname of the MonitoringPoint.
  "name": "A String", # Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}`
  "networkInterfaces": [ # Output only. The network interfaces of the MonitoringPoint.
    { # Message describing network interfaces.
      "adapterDescription": "A String", # Output only. The description of the interface.
      "cidr": "A String", # Output only. The IP address of the interface and subnet mask in CIDR format. Examples: 192.168.1.0/24, 2001:db8::/32
      "interfaceName": "A String", # Output only. The name of the network interface. Examples: eth0, eno1
      "ipAddress": "A String", # Output only. The IP address of the interface.
      "macAddress": "A String", # Output only. The MAC address of the interface.
      "speed": "A String", # Output only. Speed of the interface in millions of bits per second.
      "vlanId": "A String", # Output only. The id of the VLAN.
    },
  ],
  "originatingIp": "A String", # Output only. IP address visible when MonitoringPoint connects to the provider.
  "providerTags": [ # Output only. The provider tags of the MonitoringPoint.
    { # Message describing the provider tag.
      "category": "A String", # Output only. The category of the provider tag.
      "resourceType": "A String", # Output only. The resource type of the provider tag.
      "value": "A String", # Output only. The value of the provider tag.
    },
  ],
  "type": "A String", # Output only. Deployment type of the MonitoringPoint.
  "updateTime": "A String", # Output only. The time the MonitoringPoint was updated.
  "upgradeAvailable": True or False, # Output only. Indicates if an upgrade is available for the MonitoringPoint.
  "upgradeType": "A String", # Output only. The type of upgrade available for the MonitoringPoint.
  "version": "A String", # Output only. Version of the software running on the MonitoringPoint.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists MonitoringPoints for a given network monitoring provider.

Args:
  parent: string, Required. Parent value for ListMonitoringPointsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
  pageSize: integer, 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.
  pageToken: string, Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing MonitoringPoints
  "monitoringPoints": [ # The list of MonitoringPoints.
    { # Message describing MonitoringPoint resource.
      "autoGeoLocationEnabled": True or False, # Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint.
      "connectionStatus": "A String", # Output only. Connection status of the MonitoringPoint.
      "createTime": "A String", # Output only. The time the MonitoringPoint was created.
      "deploymentType": "A String", # Output only. The deployment type of the MonitoringPoint.
      "displayName": "A String", # Output only. Display name of the MonitoringPoint.
      "errors": [ # Output only. The codes of errors detected in the MonitoringPoint.
        "A String",
      ],
      "geoLocation": { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint.
        "formattedAddress": "A String", # Formatted address.
        "regionCode": "A String", # Unicode CLDR region code.
      },
      "guid": "A String", # Output only. The GUID of the MonitoringPoint.
      "host": { # Message describing information about the host. # Output only. The host information of the MonitoringPoint.
        "cloudInstanceId": "A String", # Output only. The cloud instance id of the host.
        "cloudProjectId": "A String", # Output only. The cloud project id of the host.
        "cloudProvider": "A String", # Output only. The cloud provider of the host.
        "cloudRegion": "A String", # Output only. The cloud region of the host.
        "cloudVirtualNetworkIds": [ # Output only. The ids of cloud virtual networks of the host.
          "A String",
        ],
        "cloudZone": "A String", # Output only. The cloud zone of the host.
        "os": "A String", # Output only. The operating system of the host.
      },
      "hostname": "A String", # Output only. The hostname of the MonitoringPoint.
      "name": "A String", # Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}`
      "networkInterfaces": [ # Output only. The network interfaces of the MonitoringPoint.
        { # Message describing network interfaces.
          "adapterDescription": "A String", # Output only. The description of the interface.
          "cidr": "A String", # Output only. The IP address of the interface and subnet mask in CIDR format. Examples: 192.168.1.0/24, 2001:db8::/32
          "interfaceName": "A String", # Output only. The name of the network interface. Examples: eth0, eno1
          "ipAddress": "A String", # Output only. The IP address of the interface.
          "macAddress": "A String", # Output only. The MAC address of the interface.
          "speed": "A String", # Output only. Speed of the interface in millions of bits per second.
          "vlanId": "A String", # Output only. The id of the VLAN.
        },
      ],
      "originatingIp": "A String", # Output only. IP address visible when MonitoringPoint connects to the provider.
      "providerTags": [ # Output only. The provider tags of the MonitoringPoint.
        { # Message describing the provider tag.
          "category": "A String", # Output only. The category of the provider tag.
          "resourceType": "A String", # Output only. The resource type of the provider tag.
          "value": "A String", # Output only. The value of the provider tag.
        },
      ],
      "type": "A String", # Output only. Deployment type of the MonitoringPoint.
      "updateTime": "A String", # Output only. The time the MonitoringPoint was updated.
      "upgradeAvailable": True or False, # Output only. Indicates if an upgrade is available for the MonitoringPoint.
      "upgradeType": "A String", # Output only. The type of upgrade available for the MonitoringPoint.
      "version": "A String", # Output only. Version of the software running on the MonitoringPoint.
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
}

Network Management API . projects . locations . networkMonitoringProviders . monitoringPoints

Instance Methods

Method Details