gvc - Control Plane

Manage global virtual clouds For a detailed overview, please visit the gvc’s reference page.

cpln gvc [SUBCOMMAND]

Commands:
  cpln gvc access-report <ref>         Show the access report for the referenced global virtual cloud
  cpln gvc add-location <ref>          Add one or more locations to the referenced global virtual cloud
  cpln gvc audit [ref]                 Retrieve audit trail events for the referenced global virtual cloud
  cpln gvc clone <ref>                 Create a clone of the referenced global virtual cloud; this will only duplicate its spec.  [aliases: copy]
  cpln gvc create                      Create a new global virtual cloud
  cpln gvc delete <ref...>             Delete GVCs by name
  cpln gvc delete-all-workloads <ref>  Delete all workloads for the referenced global virtual cloud
  cpln gvc edit <ref>                  Edit the referenced global virtual cloud, as YAML, within an editor
  cpln gvc eventlog <ref>              Show the event log of the referenced global virtual cloud  [aliases: log]
  cpln gvc get [ref...]                Retrieve one or more referenced global virtual clouds
  cpln gvc patch <ref>                 Update the referenced global virtual cloud's metadata using an input file
  cpln gvc permissions                 Show the grantable permissions for a global virtual cloud object type
  cpln gvc query                       Find all the global virtual clouds based on the given query
  cpln gvc remove-location <ref>       Remove one or more locations from the referenced global virtual cloud
  cpln gvc tag <ref...>                Manage the tags belonging to one or more referenced global virtual clouds
  cpln gvc update <ref>                Update properties of the referenced global virtual cloud

Options:
  --help  Show help  [boolean]

gvc access-report

Show the access report for the referenced global virtual cloud Usage

cpln gvc access-report <ref> [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Display the user / service account / group permissions for the ‘demo-gvc’ global virtual cloud within the ‘demo-cpln-organization’ organization

cpln gvc access-report demo-gvc --org demo-cpln-organization

+----------------------+--------------------------------------------------------+--------+
|PERMISSION            |PRINCIPAL                                               |GRANTED |
|----------------------|--------------------------------------------------------|--------|
|configureLoadBalancer |/org/demo-cpln-organization/group/superusers            |manage  |
|configureLoadBalancer |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|create                |/org/demo-cpln-organization/group/superusers            |manage  |
|create                |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|delete                |/org/demo-cpln-organization/group/superusers            |manage  |
|delete                |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|edit                  |/org/demo-cpln-organization/group/superusers            |manage  |
|edit                  |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|manage                |/org/demo-cpln-organization/group/superusers            |manage  |
|manage                |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
|view                  |/org/demo-cpln-organization/group/viewers               |view    |
|view                  |/org/demo-cpln-organization/group/superusers            |manage  |
|view                  |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
+----------------------+--------------------------------------------------------+--------+

gvc add-location

Add one or more locations to the referenced global virtual cloud Usage

cpln gvc add-location <ref...> --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --location  Location to add  [required]
  --dry-run   Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

The gvc, named ‘demo-gvc’, in the examples below was already created with ‘aws-eu-central-1’ as one of its locations.

Add one location to a global virtual cloud

cpln gvc add-location demo-gvc --location aws-us-west-2 --org demo-cpln-organization

+---------+------------+--------------+--------------+-------+-----------------+--------------+
|NAME     |DESCRIPTION |CREATED       |ALIAS         |DOMAIN |LOCATIONS        |TAGS          |
|---------|------------|--------------|--------------|-------|-----------------|--------------|
|demo-gvc |demo-gvc    |5 minutes ago |dek0sewa7frpp |       |aws-eu-central-1 |drink="water" |
|         |            |              |              |       |aws-us-west-2    |              |
+---------+------------+--------------+--------------+-------+-----------------+--------------+

Add multiple locations to a global virtual cloud

cpln gvc add-location demo-gvc --location aws-us-west-2 --location gcp-us-east1 --org demo-cpln-organization

+---------+------------+--------------+--------------+-------+-----------------+--------------+
|NAME     |DESCRIPTION |CREATED       |ALIAS         |DOMAIN |LOCATIONS        |TAGS          |
|---------|------------|--------------|--------------|-------|-----------------|--------------|
|demo-gvc |demo-gvc    |5 minutes ago |dek0sewa7frpp |       |aws-eu-central-1 |drink="water" |
|         |            |              |              |       |aws-us-west-2    |              |
|         |            |              |              |       |gcp-us-east1     |              |
+---------+------------+--------------+--------------+-------+-----------------+--------------+

gvc audit

Retrieve audit trail events for the referenced global virtual cloud Usage

cpln gvc audit [ref] [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.

Command options:
  --subject  Filter by subject (serviceaccount name or user email)  [string]
  --context  Audit context name (the 'cpln' context displays Control Plane actions)  [string] [default: "cpln"]
  --since    Relative lookback window from now (e.g., 1h, 24h, 7d). Mutually exclusive with --from/--to  [string] [default: "7d"]
  --from     Start time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 7d, 1h). Cannot be used with --since  [string]
  --to       End time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 1d, 30m)  [string]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

gvc clone

Create a clone of the referenced global virtual cloud; this will only duplicate its spec. Usage

cpln gvc clone <ref> --name CLONE_NAME [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --name         Set the name for the clone  [required]
  --description  Optional description, defaults to the name if not set
  --tag          Attach tags (e.g., --tag drink=water)
  --dry-run      Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln gvc clone demo-gvc --name demo-gvc-clone --org demo-cpln-organization

+---------------+------------------+--------+--------------+-------+-----------------+--------------+
|NAME           |DESCRIPTION       |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS          |
|---------------|------------------|--------|--------------|-------|-----------------|--------------|
|demo-gvc-clone |Clone of demo-gvc |Now     |m7k7kkqjxc514 |       |aws-eu-central-1 |drink="water" |
|               |                  |        |              |       |aws-us-west-2    |              |
|               |                  |        |              |       |gcp-us-east1     |              |
+---------------+------------------+--------+--------------+-------+-----------------+--------------+

gvc create

Create a new global virtual cloud Usage

cpln gvc create --name GVC_NAME --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]

Reference

Command options:
  --name                 Name of the new global virtual cloud  [required]
  --description, --desc  Optional description, defaults to the name if not set
  --location             One or more locations to associate with this new global virtual cloud  [required]
  --env                  Environment variables in KEY=VALUE format
  --tag                  Attach tags (e.g., --tag drink=water)
  --dry-run              Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Query spec options:
  --query-match     Query filter type  [choices: "all", "none", "any"] [default: "all"]
  --query-property  Property to query
  --query-tag       Tag to query
  --query-rel       Relation to query

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Options

name
- Minimum Length: 3
- Maximum Length: 64
- Only lowercase characters
- Must begin with a character
- Allowed special characters: -

Example

Create an new GVC with a single location

cpln gvc create --name demo-gvc --location aws-eu-central-1 --desc demo-gvc --tag drink=water --org demo-cpln-organization

+---------+------------+--------+--------------+-------+-----------------+--------------+
|NAME     |DESCRIPTION |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS          |
|---------|------------|--------|--------------|-------|-----------------|--------------|
|demo-gvc |demo-gvc    |Now     |dek0sewa7frpp |       |aws-eu-central-1 |drink="water" |
+---------+------------+--------+--------------+-------+-----------------+--------------+

gvc delete

Delete GVCs by name Usage

cpln gvc delete <ref...> [OPTIONS]

Deleting a gvc will remove all associated resources (workloads, etc.)

Reference

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]

Command options:
  --force  Bypass warnings and/or safety checks  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Delete a gvc

cpln gvc delete demo-gvc-delete-1 --org demo-cpln-organization

If the delete was successful, a new command prompt will be shown.

Delete multiple gvcs

cpln gvc delete demo-gvc-delete-1 demo-gvc-delete-2 --org demo-cpln-organization

If the delete was successful, a new command prompt will be shown.

gvc delete-all-workloads

Delete all workloads for the referenced global virtual cloud Usage

cpln gvc delete-all-workloads <ref> [OPTIONS]

Deleting all the associated workloads will remove all associated resources (containers, etc.)

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Delete all workloads

cpln gvc delete-all-workloads demo-gvc-with-workloads --org demo-cpln-organization

+------------+------------+------------------------+------+--------+-----------------------------------------------------------+-----+
|NAME        |DESCRIPTION |GVC                     |READY |CREATED |ENDPOINT                                                   |TAGS |
|------------|------------|------------------------|------|--------|-----------------------------------------------------------|-----|
|workload-02 |workload-02 |demo-gvc-with-workloads |      |Now     |https://workload-02-e895w3txnw5pc.geta3p46gfrsp.t.cpln.app |     |
|workload-01 |workload-01 |demo-gvc-with-workloads |      |Now     |https://workload-01-e895w3txnw5pc.geta3p46gfrsp.t.cpln.app |     |
+------------+------------+------------------------+------+--------+-----------------------------------------------------------+-----+

gvc edit

Edit the referenced global virtual cloud, as YAML, within an editor Usage

cpln gvc edit <ref> [OPTIONS]

The default editor can be set by using the EDITOR environment variable.

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --replace, -r  Replace instead of patch/merge  [boolean] [default: false]
  --dry-run      Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln gvc edit demo-gvc --org demo-cpln-organization

Your default editor will be launched.

Once any modifications are saved, the updates will be sent to the API.

gvc eventlog

Show the event log of the referenced global virtual cloud Usage

cpln gvc eventlog <ref> [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln gvc eventlog demo-gvc --org demo-cpln-organization

The event log for the referenced gvc will be shown.

gvc get

Retrieve one or more referenced global virtual clouds Usage

cpln gvc get [ref...] [OPTIONS]

An empty reference will return all references

Reference

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [default: []]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Get all gvcs

cpln gvc get --org demo-cpln-organization

+------------------------+------------------------+--------------+--------------+-------+-----------------+--------------+
|NAME                    |DESCRIPTION             |CREATED       |ALIAS         |DOMAIN |LOCATIONS        |TAGS          |
|------------------------|------------------------|--------------|--------------|-------|-----------------|--------------|
|demo-gvc                |demo-gvc                |5 minutes ago |dek0sewa7frpp |       |aws-eu-central-1 |drink="water" |
|                        |                        |              |              |       |aws-us-west-2    |              |
|                        |                        |              |              |       |gcp-us-east1     |              |
|demo-gvc-get-1          |demo-gvc-get-1          |Now           |jyqg9e0ev8kjr |       |aws-eu-central-1 |              |
|demo-gvc-get-2          |demo-gvc-get-2          |Now           |pgpc7zz6hpy9y |       |aws-eu-central-1 |              |
|demo-gvc-identity       |demo-gvc-identity       |5 minutes ago |chvhh6m1pxftw |       |aws-eu-central-1 |              |
|demo-gvc-with-workloads |demo-gvc-with-workloads |Now           |e895w3txnw5pc |       |aws-eu-central-1 |              |
|demo-gvc-workload       |demo-gvc-workload       |5 minutes ago |4razc9rbmer7r |       |aws-eu-central-1 |              |
+------------------------+------------------------+--------------+--------------+-------+-----------------+--------------+

Get one gvc

cpln gvc get demo-gvc-get-1 --org demo-cpln-organization

+---------------+---------------+--------+--------------+-------+-----------------+-----+
|NAME           |DESCRIPTION    |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS |
|---------------|---------------|--------|--------------|-------|-----------------|-----|
|demo-gvc-get-1 |demo-gvc-get-1 |Now     |jyqg9e0ev8kjr |       |aws-eu-central-1 |     |
+---------------+---------------+--------+--------------+-------+-----------------+-----+

Get multiple gvcs

cpln gvc get demo-gvc-get-1 demo-gvc-get-2 --org demo-cpln-organization

+---------------+---------------+--------+--------------+-------+-----------------+-----+
|NAME           |DESCRIPTION    |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS |
|---------------|---------------|--------|--------------|-------|-----------------|-----|
|demo-gvc-get-1 |demo-gvc-get-1 |Now     |jyqg9e0ev8kjr |       |aws-eu-central-1 |     |
|demo-gvc-get-2 |demo-gvc-get-2 |Now     |pgpc7zz6hpy9y |       |aws-eu-central-1 |     |
+---------------+---------------+--------+--------------+-------+-----------------+-----+

gvc patch

Update the referenced global virtual cloud’s metadata using an input file Usage

cpln gvc patch <ref> --file FILE_NAME [OPTIONS]

Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --file, -f  File to load the patch from. Use `--file -` to enable input from stdin.  [required]
  --dry-run   Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln gvc patch demo-gvc --file update.json --org demo-cpln-organization

The changes within the JSON file will be performed against the referenced gvc.

gvc permissions

Show the grantable permissions for a global virtual cloud object type Usage

cpln gvc permissions [OPTIONS]

Reference

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

cpln gvc permissions --org demo-cpln-organization

+----------------------+---------------------------+----------------------------------------------------------+
|NAME                  |DESCRIPTION                |IMPLIES                                                   |
|----------------------|---------------------------|----------------------------------------------------------|
|configureLoadBalancer |Principal can configure LB |                                                          |
|create                |Create new gvcs            |                                                          |
|delete                |Delete existing gvcs       |                                                          |
|edit                  |Modify existing gvcs       |view                                                      |
|manage                |Full access                |configureLoadBalancer, create, delete, edit, manage, view |
|view                  |Read-only access           |                                                          |
+----------------------+---------------------------+----------------------------------------------------------+

gvc query

Find all the global virtual clouds based on the given query Usage

cpln gvc query QUERY_OPTIONS [OPTIONS]

Reference

Query options:
  --match             Query filter type  [choices: "all", "none", "any"] [default: "all"]
  --property, --prop  Property to query
  --tag               Tag to query
  --rel               Relation to query

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Use the --match option to display all, none, or any of the results based on a given property or tag

Search for a gvc based on the name property

cpln gvc query --match any --prop name=demo-gvc --org demo-cpln-organization

+---------+------------+--------------+--------------+-------+-----------------+--------------+
|NAME     |DESCRIPTION |CREATED       |ALIAS         |DOMAIN |LOCATIONS        |TAGS          |
|---------|------------|--------------|--------------|-------|-----------------|--------------|
|demo-gvc |demo-gvc    |5 minutes ago |dek0sewa7frpp |       |aws-eu-central-1 |drink="water" |
|         |            |              |              |       |aws-us-west-2    |              |
|         |            |              |              |       |gcp-us-east1     |              |
+---------+------------+--------------+--------------+-------+-----------------+--------------+

Search for a gvc based on the description property

cpln gvc query --match any --prop description="demo-gvc" --org demo-cpln-organization

+---------+------------+--------------+--------------+-------+-----------------+--------------+
|NAME     |DESCRIPTION |CREATED       |ALIAS         |DOMAIN |LOCATIONS        |TAGS          |
|---------|------------|--------------|--------------|-------|-----------------|--------------|
|demo-gvc |demo-gvc    |5 minutes ago |dek0sewa7frpp |       |aws-eu-central-1 |drink="water" |
|         |            |              |              |       |aws-us-west-2    |              |
|         |            |              |              |       |gcp-us-east1     |              |
+---------+------------+--------------+--------------+-------+-----------------+--------------+

Search for a gvc based on a tag

cpln gvc query --match any --tag drink=water --org demo-cpln-organization

+---------+------------+--------------+--------------+-------+-----------------+--------------+
|NAME     |DESCRIPTION |CREATED       |ALIAS         |DOMAIN |LOCATIONS        |TAGS          |
|---------|------------|--------------|--------------|-------|-----------------|--------------|
|demo-gvc |demo-gvc    |5 minutes ago |dek0sewa7frpp |       |aws-eu-central-1 |drink="water" |
|         |            |              |              |       |aws-us-west-2    |              |
|         |            |              |              |       |gcp-us-east1     |              |
+---------+------------+--------------+--------------+-------+-----------------+--------------+

Search for a gvc based on a property and tag

cpln gvc query --match any --prop description="demo-gvc" --tag drink=water --org demo-cpln-organization

+---------+------------+--------------+--------------+-------+-----------------+--------------+
|NAME     |DESCRIPTION |CREATED       |ALIAS         |DOMAIN |LOCATIONS        |TAGS          |
|---------|------------|--------------|--------------|-------|-----------------|--------------|
|demo-gvc |demo-gvc    |5 minutes ago |dek0sewa7frpp |       |aws-eu-central-1 |drink="water" |
|         |            |              |              |       |aws-us-west-2    |              |
|         |            |              |              |       |gcp-us-east1     |              |
+---------+------------+--------------+--------------+-------+-----------------+--------------+

gvc remove-location

Remove one or more locations from the referenced global virtual cloud Usage

cpln gvc remove-location <ref...> --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Command options:
  --location  Location to remove  [required]
  --dry-run   Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

The gvc, named ‘demo-gvc-with-locations’, in the examples below was already created with four locations. A gvc must have at least one location.

Remove one location from a global virtual cloud

cpln gvc remove-location demo-gvc-with-locations --location azure-eastus2 --org demo-cpln-organization

+------------------------+------------------------+--------+--------------+-------+-----------------+-----+
|NAME                    |DESCRIPTION             |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS |
|------------------------|------------------------|--------|--------------|-------|-----------------|-----|
|demo-gvc-with-locations |demo-gvc-with-locations |Now     |7f7qzt0d339gr |       |aws-eu-central-1 |     |
|                        |                        |        |              |       |aws-us-west-2    |     |
|                        |                        |        |              |       |gcp-us-east1     |     |
+------------------------+------------------------+--------+--------------+-------+-----------------+-----+

Remove multiple locations from a global virtual cloud

cpln gvc remove-location demo-gvc-with-locations --location aws-us-west-2 --location aws-eu-central-1 --org demo-cpln-organization

+------------------------+------------------------+--------+--------------+-------+-------------+-----+
|NAME                    |DESCRIPTION             |CREATED |ALIAS         |DOMAIN |LOCATIONS    |TAGS |
|------------------------|------------------------|--------|--------------|-------|-------------|-----|
|demo-gvc-with-locations |demo-gvc-with-locations |Now     |7f7qzt0d339gr |       |gcp-us-east1 |     |
+------------------------+------------------------+--------+--------------+-------+-------------+-----+

gvc tag

Manage the tags belonging to one or more referenced global virtual clouds Usage

cpln gvc tag <ref...> --tag KEY=VALUE [OPTIONS]

Built-in tags, which begin with cpln/*, can’t be modified.

Reference

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]

Command options:
  --tag         Attach tags (e.g., --tag drink=water)
  --remove-tag  Remove tags (e.g., --remove-tag tagname)
  --dry-run     Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Example

Add a tag to a gvc

cpln gvc tag demo-gvc-tag-1 --tag drink=water --org demo-cpln-organization

+---------------+---------------+--------+--------------+-------+-----------------+--------------+
|NAME           |DESCRIPTION    |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS          |
|---------------|---------------|--------|--------------|-------|-----------------|--------------|
|demo-gvc-tag-1 |demo-gvc-tag-1 |Now     |c82m7fxt93s8e |       |aws-eu-central-1 |drink="water" |
+---------------+---------------+--------+--------------+-------+-----------------+--------------+

Update same tag (after running the example above)

cpln gvc tag demo-gvc-tag-1 --tag drink=coffee --org demo-cpln-organization

+---------------+---------------+--------+--------------+-------+-----------------+---------------+
|NAME           |DESCRIPTION    |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS           |
|---------------|---------------|--------|--------------|-------|-----------------|---------------|
|demo-gvc-tag-1 |demo-gvc-tag-1 |Now     |c82m7fxt93s8e |       |aws-eu-central-1 |drink="coffee" |
+---------------+---------------+--------+--------------+-------+-----------------+---------------+

Remove tag (after running the example above)

cpln gvc tag demo-gvc-tag-1 --remove-tag drink --org demo-cpln-organization

+---------------+---------------+--------+--------------+-------+-----------------+-----+
|NAME           |DESCRIPTION    |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS |
|---------------|---------------|--------|--------------|-------|-----------------|-----|
|demo-gvc-tag-1 |demo-gvc-tag-1 |Now     |c82m7fxt93s8e |       |aws-eu-central-1 |     |
+---------------+---------------+--------+--------------+-------+-----------------+-----+

Add same tag to multiple gvcs

cpln gvc tag demo-gvc-tag-1 demo-gvc-tag-2 --tag multiple-gvcs=true --org demo-cpln-organization

+---------------+---------------+--------+--------------+-------+-----------------+---------------------+
|NAME           |DESCRIPTION    |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS                 |
|---------------|---------------|--------|--------------|-------|-----------------|---------------------|
|demo-gvc-tag-1 |demo-gvc-tag-1 |Now     |c82m7fxt93s8e |       |aws-eu-central-1 |multiple-gvcs="true" |
|demo-gvc-tag-2 |demo-gvc-tag-2 |Now     |3q7neh8nh9zye |       |aws-eu-central-1 |multiple-gvcs="true" |
+---------------+---------------+--------+--------------+-------+-----------------+---------------------+

Update same tag on multiple gvcs (after running the example above)

cpln gvc tag demo-gvc-tag-1 demo-gvc-tag-2 --tag multiple-gvcs=demo-gvc --org demo-cpln-organization

+---------------+---------------+--------+--------------+-------+-----------------+-------------------------+
|NAME           |DESCRIPTION    |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS                     |
|---------------|---------------|--------|--------------|-------|-----------------|-------------------------|
|demo-gvc-tag-1 |demo-gvc-tag-1 |Now     |c82m7fxt93s8e |       |aws-eu-central-1 |multiple-gvcs="demo-gvc" |
|demo-gvc-tag-2 |demo-gvc-tag-2 |Now     |3q7neh8nh9zye |       |aws-eu-central-1 |multiple-gvcs="demo-gvc" |
+---------------+---------------+--------+--------------+-------+-----------------+-------------------------+

Remove same tag from multiple gvcs (after running the example above)

cpln gvc tag demo-gvc-tag-1 demo-gvc-tag-2 --remove-tag multiple-gvcs --org demo-cpln-organization

+---------------+---------------+--------+--------------+-------+-----------------+-----+
|NAME           |DESCRIPTION    |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS |
|---------------|---------------|--------|--------------|-------|-----------------|-----|
|demo-gvc-tag-1 |demo-gvc-tag-1 |Now     |c82m7fxt93s8e |       |aws-eu-central-1 |     |
|demo-gvc-tag-2 |demo-gvc-tag-2 |Now     |3q7neh8nh9zye |       |aws-eu-central-1 |     |
+---------------+---------------+--------+--------------+-------+-----------------+-----+

gvc update

Update properties of the referenced global virtual cloud Usage

cpln gvc update <ref> --set UPDATE_PROPERTY [OPTIONS]

Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]

Update Properties:
  --set    Update the following properties (e.g., --set description="Updated Description"):

           description                           string
           tags.<key>                            string
           spec.pullSecretLinks                  string[]
           spec.staticPlacement.locationLinks    string[]
           spec.tracing.sampling                 number
           spec.tracing.lightstep.endpoint       string
           spec.tracing.lightstep.credentials    string[]
           spec.env.<name>.value                 string

           Arrays can be appended to, replaced, or removed using the `+=`, `=`, or `-=` operators, respectively.
  --unset  Unset a property (same paths as --set, e.g., --unset description)

Command options:
  --dry-run  Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim  [boolean]

Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --help  Show help  [boolean]

Common Options Reference

Options

The --set option allows the modification of the following global virtual cloud properties:
- description
  - Description of the global virtual cloud
  - Type: string
- tags
  - Tags (key=value) associated with the global virtual cloud
  - Type: string
- spec.pullSecretLinks
  - Array of pull secret links belonging to the global virtual cloud
  - Type: string[]
- spec.domain
  - The domain linked to this global virtual cloud
  - Type: string
- spec.staticPlacement.locationLinks
  - Array of location links belonging to the global virtual cloud
  - Type: string[]

Example

For the examples below, the initial gvc is configured as:

+----------------+----------------+--------+--------------+-------+-----------------+-----+
|NAME            |DESCRIPTION     |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS |
|----------------|----------------|--------|--------------|-------|-----------------|-----|
|demo-gvc-update |demo-gvc-update |Now     |3332ykvczw0nt |       |aws-eu-central-1 |     |
+----------------+----------------+--------+--------------+-------+-----------------+-----+

Update a gvc’s description

cpln gvc update demo-gvc-update --set description="new description" --org demo-cpln-organization

+----------------+----------------+--------+--------------+-------+-----------------+-----+
|NAME            |DESCRIPTION     |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS |
|----------------|----------------|--------|--------------|-------|-----------------|-----|
|demo-gvc-update |new description |Now     |3332ykvczw0nt |       |aws-eu-central-1 |     |
+----------------+----------------+--------+--------------+-------+-----------------+-----+

Update a gvc’s tag

cpln gvc update demo-gvc-update --set tags.demo-key=demo-value --org demo-cpln-organization

+----------------+----------------+--------+--------------+-------+-----------------+----------------------+
|NAME            |DESCRIPTION     |CREATED |ALIAS         |DOMAIN |LOCATIONS        |TAGS                  |
|----------------|----------------|--------|--------------|-------|-----------------|----------------------|
|demo-gvc-update |new description |Now     |3332ykvczw0nt |       |aws-eu-central-1 |demo-key="demo-value" |
+----------------+----------------+--------+--------------+-------+-----------------+----------------------+