Skip to content

gcp update-instance

Update instance

Description

update instance fields

Synopsis

gcp update-instance
    [--site <site>]
    [<name>]
    [--project <project>]
    [--zone <zone>]
    [--description <description>]
    [--hostname <hostname>]
    [--tags <tags>]

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: optional

name - (string)

     Instance name
     Example: "CassandraInstance"
     Default: _None_      Attributes: optional

project - (string)

     Project name
     Example: --project "project-1"
     Default: _None_      Attributes: optional

zone - (string)

     The name of the zone for this request
     Example: --zone "us-central1-a"
     Default: _None_      Attributes: optional

description - (string)

     The description of the instance
     Example: --description "description-1"
     Default: _None_      Attributes: optional

hostname - (string)

     The hostname of the instance
     Example: --hostname "hostname-1"
     Default: _None_      Attributes: optional

tags - (string)

     Tags to apply to this instance
     Example: --tags "tags-1"
     Default: _None_      Attributes: optional, multiple allowed

Examples

gcp update-instance "CassandraInstance" --project "project-1" --zone "us-central1-a" --description "description-1" --hostname "hostname-1" --tags "tags-1"

Access Control

To use this command, you need access to the following:

Field Value
Action "update"
Service Type "gcp"
Service Instance
Namespace
Object Type "instance"
Object ID name

Please see Access Control for details.