logging_servers

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

Overview

Name	logging_servers
Type	Resource
Id	google.vmwareengine.logging_servers

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of this logging server. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/loggingServers/my-logging-server
createTime	string (google-datetime)	Output only. Creation time of this resource.
hostname	string	Required. Fully-qualified domain name (FQDN) or IP Address of the logging server.
port	integer (int32)	Required. Port number at which the logging server receives logs.
protocol	string	Required. Protocol used by vCenter to send logs to a logging server.
sourceType	string	Required. The type of component that produces logs that will be forwarded to this logging server.
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Last update time of this resource.

list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of this logging server. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/loggingServers/my-logging-server
createTime	string (google-datetime)	Output only. Creation time of this resource.
hostname	string	Required. Fully-qualified domain name (FQDN) or IP Address of the logging server.
port	integer (int32)	Required. Port number at which the logging server receives logs.
protocol	string	Required. Protocol used by vCenter to send logs to a logging server.
sourceType	string	Required. The type of component that produces logs that will be forwarded to this logging server.
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Last update time of this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, privateCloudsId, loggingServersId		Gets details of a logging server.
list	select	projectsId, locationsId, privateCloudsId	pageSize, pageToken, filter, orderBy	Lists logging servers configured for a given private cloud.
create	insert	projectsId, locationsId, privateCloudsId	loggingServerId, requestId	Create a new logging server for a given private cloud.
patch	update	projectsId, locationsId, privateCloudsId, loggingServersId	updateMask, requestId	Updates the parameters of a single logging server. Only fields specified in update_mask are applied.
delete	delete	projectsId, locationsId, privateCloudsId, loggingServersId	requestId	Deletes a single logging server.

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
loggingServersId	string
privateCloudsId	string
projectsId	string
filter	string
loggingServerId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a logging server.

SELECT
name,
createTime,
hostname,
port,
protocol,
sourceType,
uid,
updateTime
FROM google.vmwareengine.logging_servers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND loggingServersId = '{{ loggingServersId }}' -- required;

list

Lists logging servers configured for a given private cloud.

SELECT
name,
createTime,
hostname,
port,
protocol,
sourceType,
uid,
updateTime
FROM google.vmwareengine.logging_servers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Create a new logging server for a given private cloud.

INSERT INTO google.vmwareengine.logging_servers (
data__hostname,
data__port,
data__protocol,
data__sourceType,
projectsId,
locationsId,
privateCloudsId,
loggingServerId,
requestId
)
SELECT 
'{{ hostname }}',
{{ port }},
'{{ protocol }}',
'{{ sourceType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ privateCloudsId }}',
'{{ loggingServerId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: logging_servers
  props:
    - name: projectsId
      value: string
      description: Required parameter for the logging_servers resource.
    - name: locationsId
      value: string
      description: Required parameter for the logging_servers resource.
    - name: privateCloudsId
      value: string
      description: Required parameter for the logging_servers resource.
    - name: hostname
      value: string
      description: >
        Required. Fully-qualified domain name (FQDN) or IP Address of the logging server.
        
    - name: port
      value: integer
      description: >
        Required. Port number at which the logging server receives logs.
        
    - name: protocol
      value: string
      description: >
        Required. Protocol used by vCenter to send logs to a logging server.
        
      valid_values: ['PROTOCOL_UNSPECIFIED', 'UDP', 'TCP', 'TLS', 'SSL', 'RELP']
    - name: sourceType
      value: string
      description: >
        Required. The type of component that produces logs that will be forwarded to this logging server.
        
      valid_values: ['SOURCE_TYPE_UNSPECIFIED', 'ESXI', 'VCSA']
    - name: loggingServerId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the parameters of a single logging server. Only fields specified in update_mask are applied.

UPDATE google.vmwareengine.logging_servers
SET 
data__hostname = '{{ hostname }}',
data__port = {{ port }},
data__protocol = '{{ protocol }}',
data__sourceType = '{{ sourceType }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND loggingServersId = '{{ loggingServersId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single logging server.

DELETE FROM google.vmwareengine.logging_servers
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND loggingServersId = '{{ loggingServersId }}' --required
AND requestId = '{{ requestId }}';