gcp get-instances
Get or list instances
Description
get or list instances
Synopsis
gcp get-instances
[--site <site>]
[<name>]
[--project <project>]
[--zone <zone>]
[--filter <filter>]
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
filter
- (string)
A filter expression that filters resources listed in the response
Example: --filter "name != example-instance"
Default: _None_
Attributes: optional
Examples
gcp get-instances "CassandraInstance" --project "project-1" --zone "us-central1-a" --filter "name != example-instance"
Access Control
To use this command, you need access to the following:
Field | Value |
---|---|
Action | "read" |
Service Type | "gcp" |
Service Instance | |
Namespace | |
Object Type | "instance" |
Object ID | name |
Please see Access Control for details.