Updates the parameters of a single Source.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: vmmigration1 --scope <scope> projects locations-sources-patch ...

Required Scalar Argument

  • <name> (string)
    • Output only. The Source name.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Source:
  aws:
    access-key-creds:
      access-key-id: string
      secret-access-key: string
      session-token: string
    aws-region: string
    error:
      code: integer
      message: string
    inventory-security-group-names: [string]
    migration-resources-user-tags: { string: string }
    public-ip: string
    state: string
  azure:
    azure-location: string
    client-secret-creds:
      client-id: string
      client-secret: string
      tenant-id: string
    error:
      code: integer
      message: string
    migration-resources-user-tags: { string: string }
    resource-group-id: string
    state: string
    subscription-id: string
  create-time: string
  description: string
  encryption:
    kms-key: string
  labels: { string: string }
  name: string
  update-time: string
  vmware:
    password: string
    resolved-vcenter-host: string
    thumbprint: string
    username: string
    vcenter-ip: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .aws.access-key-creds access-key-id=at
    • AWS access key ID.
  • secret-access-key=sit
    • Input only. AWS secret access key.
  • session-token=sit

    • Input only. AWS session token. Used only when AWS security token service (STS) is responsible for creating the temporary credentials.
  • .. aws-region=lorem

    • Immutable. The AWS region that the source VMs will be migrated from.
  • error code=86
    • The status code, which should be an enum value of google.rpc.Code.
  • message=duo

    • A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  • .. inventory-security-group-names=elitr

    • AWS security group names to limit the scope of the source inventory.
    • Each invocation of this argument appends the given value to the array.
  • migration-resources-user-tags=key=aliquyam
    • User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix m2vm.
    • the value will be associated with the given key
  • public-ip=erat
    • Output only. The source's public IP. All communication initiated by this source will originate from this IP.
  • state=ut

    • Output only. State of the source as determined by the health check.
  • ..azure azure-location=et

    • Immutable. The Azure location (region) that the source VMs will be migrated from.
  • client-secret-creds client-id=lorem
    • Azure client ID.
  • client-secret=rebum.
    • Input only. Azure client secret.
  • tenant-id=et

    • Azure tenant ID.
  • ..error code=71

    • The status code, which should be an enum value of google.rpc.Code.
  • message=stet

    • A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  • .. migration-resources-user-tags=key=aliquyam

    • User specified tags to add to every M2VM generated resource in Azure. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix m4ce or m2vm.
    • the value will be associated with the given key
  • resource-group-id=kasd
    • Output only. The ID of the Azure resource group that contains all resources related to the migration process of this source.
  • state=lorem
    • Output only. State of the source as determined by the health check.
  • subscription-id=sit

    • Immutable. Azure subscription ID.
  • .. create-time=kasd

    • Output only. The create time timestamp.
  • description=tempor
    • User-provided description of the source.
  • encryption kms-key=dolor

    • Required. The name of the encryption key that is stored in Google Cloud KMS.
  • .. labels=key=amet

    • The labels of the source.
    • the value will be associated with the given key
  • name=sit
    • Output only. The Source name.
  • update-time=rebum.
    • Output only. The update time timestamp.
  • vmware password=sea
    • Input only. The credentials password. This is write only and can not be read in a GET operation.
  • resolved-vcenter-host=ipsum
    • The hostname of the vcenter.
  • thumbprint=ipsum
    • The thumbprint representing the certificate for the vcenter.
  • username=et
    • The credentials username.
  • vcenter-ip=elitr
    • The ip address of the vcenter this Source represents.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p request-id=string

    • A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  • -p update-mask=string

    • Field mask is used to specify the fields to be overwritten in the Source resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").