Method: projects.locations.migrationJobs.generateSshScript

Generate a SSH configuration script to configure the reverse SSH connectivity.

HTTP request

POST https://datamigration.googleapis.com/v1/{migrationJob}:generateSshScript

Path parameters

Parameters
migrationJob

string

Name of the migration job resource to generate the SSH script.

Authorization requires the following IAM permission on the specified resource migrationJob:

  • datamigration.migrationjobs.generateSshScript

Request body

The request body contains data with the following structure:

JSON representation
{
  "vm": string,
  "vmPort": integer,

  // Union field vm_config can be only one of the following:
  "vmCreationConfig": {
    object (VmCreationConfig)
  },
  "vmSelectionConfig": {
    object (VmSelectionConfig)
  }
  // End of list of possible types for union field vm_config.
}
Fields
vm

string

Required. Bastion VM Instance name to use or to create.

vmPort

integer

The port that will be open on the bastion host

Union field vm_config. The VM configuration vm_config can be only one of the following:
vmCreationConfig

object (VmCreationConfig)

The VM creation configuration

vmSelectionConfig

object (VmSelectionConfig)

The VM selection configuration

Response body

If successful, the response body contains data with the following structure:

Response message for 'migrationJobs.generateSshScript' request.

JSON representation
{
  "script": string
}
Fields
script

string

The ssh configuration script.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

VmCreationConfig

VM creation configuration message

JSON representation
{
  "vmMachineType": string,
  "vmZone": string,
  "subnet": string
}
Fields
vmMachineType

string

Required. VM instance machine type to create.

vmZone

string

The Google Cloud Platform zone to create the VM in.

subnet

string

The subnet name the vm needs to be created in.

VmSelectionConfig

VM selection configuration message

JSON representation
{
  "vmZone": string
}
Fields
vmZone

string

Required. The Google Cloud Platform zone the VM is located.