Update details of a single server.

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: baremetalsolution2 --scope <scope> projects locations-instances-patch ...

Required Scalar Argument

<name> (string)
- Immutable. The resource name of this Instance. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/instances/{instance}

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:

Instance:
  create-time: string
  firmware-version: string
  hyperthreading-enabled: boolean
  id: string
  interactive-serial-console-enabled: boolean
  kms-key-version: string
  labels: { string: string }
  login-info: string
  machine-type: string
  name: string
  network-template: string
  os-image: string
  pod: string
  ssh-keys: [string]
  state: string
  update-time: string
  workload-profile: 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 . create-time=voluptua.
- Output only. Create a time stamp.
firmware-version=at
- Output only. The firmware version for the instance.
hyperthreading-enabled=false
- True if you enable hyperthreading for the server, otherwise false. The default value is false.
id=amet.
- Output only. An identifier for the Instance, generated by the backend.
interactive-serial-console-enabled=true
- Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
kms-key-version=amet.
- Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}.
labels=key=duo
- Labels as key value pairs.
- the value will be associated with the given key
login-info=ipsum
- Output only. Text field about info for logging in.
machine-type=gubergren
- Immutable. The server type. Available server types
name=lorem
- Immutable. The resource name of this Instance. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/instances/{instance}
network-template=gubergren
- Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".
os-image=eos
- The OS image currently installed on the server.
pod=dolor
- Immutable. Pod name. Pod is an independent part of infrastructure. Instance can only be connected to the assets (networks, volumes) allocated in the same pod.
ssh-keys=ea
- Optional. List of SSH Keys used during instance provisioning.
- Each invocation of this argument appends the given value to the array.
state=ipsum
- Output only. The state of the server.
update-time=invidunt
- Output only. Update a time stamp.
workload-profile=amet
- The workload profile for the instance.

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 update-mask=string
- The list of fields to update. The currently supported fields are: labels hyperthreading_enabled os_image ssh_keys kms_key_version

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").