datacenter_connectors

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

Overview

Name	datacenter_connectors
Type	Resource
Id	google.vmmigration.datacenter_connectors

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The connector's name.
applianceInfrastructureVersion	string	Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance.
applianceSoftwareVersion	string	Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance.
availableVersions	object	Output only. The available versions for updating this appliance. (id: AvailableUpdates)
bucket	string	Output only. The communication channel between the datacenter connector and Google Cloud.
createTime	string (google-datetime)	Output only. The time the connector was created (as an API call, not when it was actually installed).
error	object	Output only. Provides details on the state of the Datacenter Connector in case of an error. (id: Status)
registrationId	string	Immutable. A unique key for this connector. This key is internal to the OVA connector and is supplied with its creation during the registration process and can not be modified.
serviceAccount	string	The service account to use in the connector when communicating with the cloud.
state	string	Output only. State of the DatacenterConnector, as determined by the health checks.
stateTime	string (google-datetime)	Output only. The time the state was last set.
updateTime	string (google-datetime)	Output only. The last time the connector was updated with an API call.
upgradeStatus	object	Output only. The status of the current / last upgradeAppliance operation. (id: UpgradeStatus)
version	string	The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified.

list

Successful response

Name	Datatype	Description
name	string	Output only. The connector's name.
applianceInfrastructureVersion	string	Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance.
applianceSoftwareVersion	string	Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance.
availableVersions	object	Output only. The available versions for updating this appliance. (id: AvailableUpdates)
bucket	string	Output only. The communication channel between the datacenter connector and Google Cloud.
createTime	string (google-datetime)	Output only. The time the connector was created (as an API call, not when it was actually installed).
error	object	Output only. Provides details on the state of the Datacenter Connector in case of an error. (id: Status)
registrationId	string	Immutable. A unique key for this connector. This key is internal to the OVA connector and is supplied with its creation during the registration process and can not be modified.
serviceAccount	string	The service account to use in the connector when communicating with the cloud.
state	string	Output only. State of the DatacenterConnector, as determined by the health checks.
stateTime	string (google-datetime)	Output only. The time the state was last set.
updateTime	string (google-datetime)	Output only. The last time the connector was updated with an API call.
upgradeStatus	object	Output only. The status of the current / last upgradeAppliance operation. (id: UpgradeStatus)
version	string	The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, sourcesId, datacenterConnectorsId		Gets details of a single DatacenterConnector.
list	select	projectsId, locationsId, sourcesId	pageSize, pageToken, filter, orderBy	Lists DatacenterConnectors in a given Source.
create	insert	projectsId, locationsId, sourcesId	datacenterConnectorId, requestId	Creates a new DatacenterConnector in a given Source.
delete	delete	projectsId, locationsId, sourcesId, datacenterConnectorsId	requestId	Deletes a single DatacenterConnector.
upgrade_appliance	exec	projectsId, locationsId, sourcesId, datacenterConnectorsId		Upgrades the appliance relate to this DatacenterConnector to the in-place updateable version.

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
datacenterConnectorsId	string
locationsId	string
projectsId	string
sourcesId	string
datacenterConnectorId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single DatacenterConnector.

SELECT
name,
applianceInfrastructureVersion,
applianceSoftwareVersion,
availableVersions,
bucket,
createTime,
error,
registrationId,
serviceAccount,
state,
stateTime,
updateTime,
upgradeStatus,
version
FROM google.vmmigration.datacenter_connectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sourcesId = '{{ sourcesId }}' -- required
AND datacenterConnectorsId = '{{ datacenterConnectorsId }}' -- required;

list

Lists DatacenterConnectors in a given Source.

SELECT
name,
applianceInfrastructureVersion,
applianceSoftwareVersion,
availableVersions,
bucket,
createTime,
error,
registrationId,
serviceAccount,
state,
stateTime,
updateTime,
upgradeStatus,
version
FROM google.vmmigration.datacenter_connectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sourcesId = '{{ sourcesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new DatacenterConnector in a given Source.

INSERT INTO google.vmmigration.datacenter_connectors (
data__registrationId,
data__serviceAccount,
data__version,
projectsId,
locationsId,
sourcesId,
datacenterConnectorId,
requestId
)
SELECT 
'{{ registrationId }}',
'{{ serviceAccount }}',
'{{ version }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ sourcesId }}',
'{{ datacenterConnectorId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: datacenter_connectors
  props:
    - name: projectsId
      value: string
      description: Required parameter for the datacenter_connectors resource.
    - name: locationsId
      value: string
      description: Required parameter for the datacenter_connectors resource.
    - name: sourcesId
      value: string
      description: Required parameter for the datacenter_connectors resource.
    - name: registrationId
      value: string
      description: >
        Immutable. A unique key for this connector. This key is internal to the OVA connector and is supplied with its creation during the registration process and can not be modified.
        
    - name: serviceAccount
      value: string
      description: >
        The service account to use in the connector when communicating with the cloud.
        
    - name: version
      value: string
      description: >
        The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified.
        
    - name: datacenterConnectorId
      value: string
    - name: requestId
      value: string

DELETE examples

delete

Deletes a single DatacenterConnector.

DELETE FROM google.vmmigration.datacenter_connectors
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND sourcesId = '{{ sourcesId }}' --required
AND datacenterConnectorsId = '{{ datacenterConnectorsId }}' --required
AND requestId = '{{ requestId }}';

Lifecycle Methods

upgrade_appliance

Upgrades the appliance relate to this DatacenterConnector to the in-place updateable version.

EXEC google.vmmigration.datacenter_connectors.upgrade_appliance 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@sourcesId='{{ sourcesId }}' --required, 
@datacenterConnectorsId='{{ datacenterConnectorsId }}' --required 
@@json=
'{
"requestId": "{{ requestId }}"
}';