Command Line Interface

Installation

The Control Plane CLI (cpln) can be installed by using either npm or downloading the specific binary package for the target operating system.

Using npm

Preferred Installation Method

Execute the following command to install the CLI:

copy
npm install -g @controlplane/cli

Execute the following command to update the CLI:

copy
npm update -g @controlplane/cli

Binary Package

In cases where Node.js cannot be used, select the package that matches the target operating system:

macOS

Linux

Windows

View Checksum
OSFilesha256
macOScpln-macos.tgz5d263a9f71b1942b95c2b2e71327a6c71fbaa6f03290b063bacd99c6ec669c10
Linuxcpln-linux.tgzb9424388e905e8ba260cba47da475a7192ba2e418cef1b917610e96226a369e8
Windows 10cpln-win.zipa59b055d445d7c49cc023950a8ff5ca9643dc3a7aeda1f38ad7eed4e564b31fe
TIP
  • After the package has been downloaded, decompress it to a location within the PATH

  • Decompression helper commands:

    OSCommand
    macOSgunzip cpln-macos.tgz && open cpln-macos.tar
    Linuxtar -xvf cpln-linux.tgz
    Windows 10tar -xvf cpln-win.zip

The package contains two executables:

  • cpln: The Control Plane CLI.
  • docker-credential-cpln: A tool required by the CLI allowing Docker to authenticate to your org's private image registry.

Autocomplete

After installing the CLI, enabling autocomplete will help the user quickly iterate through the commands by entering the first few letters of a command and pressing the Tab key.

copy
cpln misc install-completion

Commands

The Control Plane CLI is executed by running:

cpln COMMAND SUBCOMMAND [OPTIONS]

The following commands are available (viewable by running cpln --help):

cpln <command>

Commands: cpln agent Manage agents cpln apply Create or update a resource using an input file cpln auditctx Manage audit contexts cpln cloudaccount Manage cloud accounts cpln domain Manage custom domains cpln group Manage groups cpln gvc Manage global virtual clouds cpln identity Manage identities within a global virtual cloud [aliases: id] cpln image Manage images and configure Docker login cpln location Manage locations [aliases: loc] cpln login Create a profile named "default" and launch a browser to begin the interactive login process cpln logs <query> Show logs cpln misc Miscellaneous helper commands cpln org Manage organizations cpln policy Manage access policies cpln profile Manage local profiles cpln quota Show quotas cpln rest Submit REST requests against the API cpln secret Manage secrets cpln serviceaccount Manage service accounts [aliases: sa] cpln task Manage pending tasks cpln user Manage users cpln workload Manage workloads within a global virtual cloud [aliases: w]

Options: --help Show help [boolean] --version Show version number [boolean]

© 2021 Control Plane Corporation

Each command and associated subcommands are described below.

NOTE

The referenced objects in the subcommands follow this pattern:

[ref]: Optional object

[ref...]: One or more optional objects

<ref>: Required object

<ref...>: One or more required objects

TIP

If the response from a command is truncated, use the following options to view the complete response:

  • In JSON: --output json or -o json
  • In YAML: --output yaml or -o yaml
TIP

Most of the commands require that the org and/or the GVC be referred to using the --org and/or --gvc options.

In order to avoid entering these options for each command, the default profile can be updated to refer to a default org and/or GVC using the cpln profile update command.

Example: cpln profile update default --org demo-cpln-organization --gvc demo-cpln-gvc

This command will update the default profile to use the demo-cpln-organization org and the demo-cpln-gvc GVC when executing a command that requires an org and/or GVC. The --org and --gvc will not longer be required.


agent

Manage agents

For a detailed overview, please visit the agent's reference page.

copy
cpln agent [SUBCOMMAND]

Commands: cpln agent access-report <ref> Show the access report for the referenced agent cpln agent create Create a new agent cpln agent delete <ref...> Delete one or more referenced agents cpln agent edit <ref> Edit the referenced agent, as YAML, within an editor cpln agent eventlog <ref> Show the event log of the referenced agent [aliases: log] cpln agent get [ref...] Retrieve one or more referenced agents cpln agent info <ref> Get info about an agent cpln agent patch <ref> Update the referenced agent's metadata using an input file cpln agent permissions Show the grantable permissions for an agent object type cpln agent query Find all the agents based on the given query cpln agent tag <ref...> Manage the tags belonging to one or more referenced agents cpln agent up Run an agent within a local Docker instance cpln agent update <ref> Update properties of the referenced agent

Options: --help Show help [boolean]


agent Subcommands


agent access-report

Show the access report for the referenced agent

Usage

copy
cpln agent 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"]
--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]
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 agent access-report demo-agent-access-report --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|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 |
|use |/org/demo-cpln-organization/group/superusers |manage |
|use |/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 |
+-----------+--------------------------------------------------------+--------+

agent create

Create a new agent

Usage

copy
cpln agent create --name AGENT_NAME [OPTIONS]
Reference
Command options:
--name Name of the agent [required]
--description, --desc Optional description, defaults to the name if not set
--tag Attach tags (e.g., --tag drink=water)
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"]
--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]
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 agent create --name demo-agent-create --org demo-cpln-organization
{
"agentId": "a9daa5c4-7c8b-4a13-ad37-98d9ab2cf620",
"agentLink": "/org/demo-cpln-organization/agent/demo-agent-create",
"hubEndpoint": "https://hub.cpln.io",
"registrationToken": "a2bKyKfVSd4H9feT_Q53iDzvICaxnU9P8ry0MhBVbnJhygN9yEXJToEA/wUHIC7"
}

agent delete

Delete one or more referenced agents

Usage

copy
cpln agent delete <ref...> [OPTIONS]
Reference
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [required] [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"]
--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]
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 agent delete demo-agent --org demo-cpln-organization
If the delete was successful, a new command prompt will be shown.

agent edit

Edit the referenced agent, as YAML, within an editor

Usage

copy
cpln agent edit <ref> [OPTIONS]
NOTE

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]
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"]
--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]
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 agent edit demo-agent --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

agent eventlog

Show the event log of the referenced agent

Usage

copy
cpln agent 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"]
--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]
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 agent eventlog demo-agent --org demo-cpln-organization
The event log for the referenced agent will be shown.

agent get

Retrieve one or more referenced agents

Usage

copy
cpln agent get [ref...] [OPTIONS]
NOTE

An empty reference will return all agents

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"]
--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]
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 agents
$ cpln agent get --org demo-cpln-organization
+-----------------+-----------------------------------------+----------+-----+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------------|-----------------------------------------|----------|-----|
|demo-agent-get-1 |demo-agent-get-1 |0 minutes | |
|demo-agent-get-2 |demo-agent-get-2 |0 minutes | |
|demo-agent-get-3 |demo-agent-get-3 |0 minutes | |
+-----------------+-----------------------------------------+----------+-----+
  • Get one agent
$ cpln agent get demo-agent-get-1 --org demo-cpln-organization
+-----------------+-----------------------------------------+----------+-----+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------------|-----------------------------------------|----------|-----|
|demo-agent-get-1 |demo-agent-get-1 |0 minutes | |
+-----------------+-----------------------------------------+----------+-----+
  • Get multiple agents
$ cpln agent get demo-agent-get-1 demo-agent-get-2 --org demo-cpln-organization
+-----------------+-----------------------------------------+----------+-----+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------------|-----------------------------------------|----------|-----|
|demo-agent-get-1 |demo-agent-get-1 |0 minutes | |
|demo-agent-get-2 |demo-agent-get-2 |0 minutes | |
+-----------------+-----------------------------------------+----------+-----+

agent info

Get info about an agent

Usage

copy
cpln agent info <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"]
--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]
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
  • Return the details of a deployed agent. The example below was for an agent deployed at AWS.
$ cpln agent info demo-agent-aws --org demo-cpln-organization
{
"env": {
"cpuPlatform": "x86_64",
"image": "ami-0fff5e2863a768052",
"id": "i-01adfe256a82a2a76",
"machineType": "t2.micro",
"zone": "us-west-2c",
"internalIP": "172.31.13.246",
"hostname": "ip-172-31-13-246.us-west-2.compute.internal",
"vpc": "vpc-29e3c451",
"subnet": "subnet-b11e9dec",
"accountId": "015716931765",
"cloudProvider": "aws"
},
"lastActive": "2021-05-01T00:26:55.945Z",
"serviceCount": 0,
"peerCount": 0
}

agent patch

Update the referenced agent's metadata using an input file

Usage

copy
cpln agent patch <ref> --file FILE_NAME [OPTIONS]
NOTE

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]
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"]
--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]
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 agent patch demo-agent --file agent-update.json --org demo-cpln-organization"
copy
The changes within the JSON file will be performed against the referenced agent.

agent permissions

Show the grantable permissions for an agent object type

Usage

copy
cpln agent 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"]
--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]
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 agent permissions --org demo-cpln-organization
+-------+-----------------------------------------+----------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|----------------------------------------|
|create |Create new agents | |
|delete |Delete service agents | |
|edit |Modify existing agents |view |
|manage |Full access |create, delete, edit, manage, use, view |
|use |Use an agent as in an identity |view |
|view |Read-only access | |
+-------+-----------------------------------------+----------------------------------------+

agent query

Find all the agents based on the given query

Usage

copy
cpln agent 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 Tag 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"]
--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]
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
NOTE

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

  • Search for an agent based on the name property
$ cpln agent query --match any --prop name=demo-agent-query --org demo-cpln-organization
+-----------------+-----------------------------------------+----------+-------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------------|-----------------------------------------|----------|-------------|
|demo-agent-query |Sample Agent |0 minutes |agent="demo" |
+-----------------+-----------------------------------------+----------+-------------+
  • Search for an agent based on the description property
$ cpln agent query --match any --prop description="Sample Agent" --org demo-cpln-organization
+-----------------+-----------------------------------------+----------+-------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------------|-----------------------------------------|----------|-------------|
|demo-agent-query |Sample Agent |0 minutes |agent="demo" |
+-----------------+-----------------------------------------+----------+-------------+
  • Search for a agent based on a tag
$ cpln agent query --match any --tag agent=demo --org demo-cpln-organization
+-----------------+-----------------------------------------+----------+-------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------------|-----------------------------------------|----------|-------------|
|demo-agent-query |Sample Agent |0 minutes |agent="demo" |
+-----------------+-----------------------------------------+----------+-------------+
  • Search for a agent based on a property and tag
$ cpln agent query --match any --prop description="Sample Agent" --tag agent=demo --org demo-cpln-organization
+-----------------+-----------------------------------------+----------+-------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------------|-----------------------------------------|----------|-------------|
|demo-agent-query |Sample Agent |0 minutes |agent="demo" |
+-----------------+-----------------------------------------+----------+-------------+

agent tag

Manage the tags belonging to one or more referenced agents

Usage

copy
cpln agent tag <ref...> --tag KEY=VALUE [OPTIONS]
NOTE

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)
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"]
--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]
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 agent
$ cpln agent tag demo-agent-tag --tag name="Demo Agent" --org demo-cpln-organization
+---------------+-----------------------------------------+----------+------------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|---------------|-----------------------------------------|----------|------------------|
|demo-agent-tag |demo-agent-tag |0 minutes |name="Demo Agent" |
+---------------+-----------------------------------------+----------+------------------+
  • Update same tag (after running the example above)
$ cpln agent tag demo-agent-tag --tag name="Replaced Tag" --org demo-cpln-organization
+---------------+-----------------------------------------+----------+--------------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|---------------|-----------------------------------------|----------|--------------------|
|demo-agent-tag |demo-agent-tag |0 minutes |name="Replaced Tag" |
+---------------+-----------------------------------------+----------+--------------------+
  • Remove tag (after running the example above)
$ cpln agent tag demo-agent-tag --tag name= --org demo-cpln-organization
+---------------+-----------------------------------------+----------+-----+
|NAME |DESCRIPTION |CREATED |TAGS |
|---------------|-----------------------------------------|----------|-----|
|demo-agent-tag |demo-agent-tag |0 minutes | |
+---------------+-----------------------------------------+----------+-----+

agent up

Run an agent within a local Docker instance

Usage

copy
cpln agent up --bootstrap-file FILE_NAME [--background] [OPTIONS]
Reference
Command options:
--bootstrap-file Path to the bootstrap config file [required]
--background, -b If set, run the agent as a background process [boolean]
--image Advanced use: Use a different agent Docker image
--net Docker network to use [default: "bridge"]
Options:
--help Show help [boolean]

Common Options Reference

Example
$ cpln agent up demo-agent --bootstrap-file bootstrap.config
The Control Plane agent will be executed in a local Docker instance using the referenced bootstrap config file

agent update

Update properties of the referenced agent

Usage

copy
cpln agent 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 [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"]
--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]
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 agent properties:
    • description
      • Description of the agent
      • Type: string
    • tags
      • Tags (key=value) associated with the agent
      • Type: string
Example
  • For the examples below, the initial agent is configured as:
+------------------+-----------------------------------------+----------+-----+
|NAME |DESCRIPTION |CREATED |TAGS |
|------------------|-----------------------------------------|----------|-----|
|demo-agent-update |demo-agent-update |0 minutes | |
+------------------+-----------------------------------------+----------+-----+
  • Update an agent's description
$ cpln agent update demo-agent-update --set description="Agent With An Updated Description" --org demo-cpln-organization
+------------------+-----------------------------------------+----------+-----+
|NAME |DESCRIPTION |CREATED |TAGS |
|------------------|-----------------------------------------|----------|-----|
|demo-agent-update |Agent With An Updated Description |0 minutes | |
+------------------+-----------------------------------------+----------+-----+
  • Update an agent's tag
$ cpln agent update demo-agent-update --set tags.agent-name=demo --org demo-cpln-organization
+------------------+-----------------------------------------+----------+------------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|------------------|-----------------------------------------|----------|------------------|
|demo-agent-update |Agent With An Updated Description |0 minutes |agent-name="demo" |
+------------------+-----------------------------------------+----------+------------------+

apply

Create or update a resource using an input file

Usage

copy
cpln apply --file FILE_NAME [OPTIONS]
Reference

Command options: --file, -f File to load the request from. Use --file - to enable input from stdin. [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 --gvc Override the global virtual cloud. The default global virtual cloud 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"] --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]

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] --version Show version number [boolean]

Common Options Reference

Example
$ cpln apply --file action.json
The actions within the JSON file will be performed against the API.

auditctx

Manage audit contexts

For a detailed overview, please visit the audit context's reference page.

copy
cpln auditctx [SUBCOMMAND]

Commands: cpln auditctx access-report <ref> Show the access report for the referenced audit context cpln auditctx clone <ref> Create a clone of the referenced audit context [aliases: copy] cpln auditctx create Create a new audit context cpln auditctx edit <ref> Edit the referenced audit context, as YAML, within an editor cpln auditctx eventlog <ref> Show the event log of the referenced audit context [aliases: log] cpln auditctx get [ref...] Retrieve one or more referenced audit contexts cpln auditctx patch <ref> Update the referenced audit context's metadata using an input file cpln auditctx permissions Show the grantable permissions for an audit context object type cpln auditctx query Find all the audit contexts based on the given query cpln auditctx tag <ref...> Manage the tags belonging to one or more referenced audit contexts cpln auditctx update <ref> Update properties of the referenced audit context

Options: --help Show help [boolean]


auditctx Subcommands


auditctx access-report

Show the access report for the referenced audit context

Usage

copy
cpln auditctx 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"]
--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]
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 auditctx access-report demo-audit-context --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|create |/org/demo-cpln-organization/group/superusers |manage |
|create |/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 |
|readAudit |/org/demo-cpln-organization/group/superusers |manage |
|readAudit |/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 |
|writeAudit |/org/demo-cpln-organization/group/superusers |manage |
|writeAudit |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
+-----------+--------------------------------------------------------+--------+

auditctx clone

Create a clone of the referenced audit context

Usage

copy
cpln auditctx clone <ref> --name AUDIT_CONTEXT_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)
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"]
--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]
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 auditctx clone demo-audit-context --name demo-audit-context-clone --org demo-cpln-organization
┌─────────────────────────┬─────────────────────────────────────────┬────────┬─────┐
│NAME │DESCRIPTION │ORIGIN │TAGS │
├─────────────────────────┼─────────────────────────────────────────┼────────┼─────┤
│demo-audit-context-clone │Clone of demo-audit-context │default │ │
└─────────────────────────┴─────────────────────────────────────────┴────────┴─────┘

auditctx create

Create a new audit context

Usage

copy
cpln auditctx create --name AUDIT_CONTEXT_NAME [OPTIONS]
Reference
Command options:
--name Name of the new audit context [required]
--description, --desc Optional description, defaults to the name if not set
--tag Attach tags (e.g., --tag drink=water)
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"]
--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]
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 auditctx create --name demo-audit-context --org demo-cpln-organization
┌───────────────────┬─────────────────────────────────────────┬────────┬─────┐
│NAME │DESCRIPTION │ORIGIN │TAGS │
├───────────────────┼─────────────────────────────────────────┼────────┼─────┤
│demo-audit-context │demo-audit-context │default │ │
└───────────────────┴─────────────────────────────────────────┴────────┴─────┘

auditctx edit

Edit the referenced audit context, as YAML, within an editor

Usage

copy
cpln auditctx edit <ref> [OPTIONS]
NOTE

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]
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"]
--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]
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 auditctx edit demo-audit-contxt --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

auditctx eventlog

Show the event log of the referenced audit context

Usage

copy
cpln auditctx 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"]
--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]
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 auditctx eventlog demo-auditctx --org demo-cpln-organization
The event log for the referenced audit context will be shown.

auditctx get

Retrieve one or more referenced audit contexts

Usage

copy
cpln auditctx get [ref...] [OPTIONS]
NOTE

An empty reference will return all audit contexts.

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"]
--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]
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 audit contexts
$ cpln auditctx get --org demo-cpln-organization
+-------------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------------|-----------------------------------------|--------|------------|
|cpln |Audit of your CPLN org |builtin | |
|demo-audit-context |demo-audit-context |default |type="demo" |
|demo-audit-context-clone |Clone of demo-audit-context |default | |
+-------------------------+-----------------------------------------+--------+------------+
  • Get one audit context
$ cpln auditctx get demo-audit-context --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|------------|
|demo-audit-context |demo-audit-context |default |type="demo" |
+-------------------+-----------------------------------------+--------+------------+
  • Get multiple audit contexts
$ cpln auditctx get demo-audit-context cpln --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|------------|
|demo-audit-context |demo-audit-context |default |type="demo" |
|cpln |Audit of your CPLN org |builtin | |
+-------------------+-----------------------------------------+--------+------------+

auditctx patch

Update an audit context's metadata by using an input file

Usage

copy
cpln auditctx patch <ref> --file FILE_NAME [OPTIONS]
NOTE

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]
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"]
--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]
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 auditctx patch demo-audit-context --file audit-context-update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced audit context.

auditctx permissions

Show the grantable permissions for an audit context object type

Usage

copy
cpln auditctx 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"]
--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]
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 auditctx permissions --org demo-cpln-organization
+-----------+-----------------------------------------+--------------------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-----------|-----------------------------------------|--------------------------------------------------|
|create |Create new contexts | |
|edit |Modify existing contexts |view |
|manage |Full access |create, edit, manage, readAudit, view, writeAudit |
|readAudit |Read from this context |view |
|view |Read-only view | |
|writeAudit |Write to this context |view |
+-----------+-----------------------------------------+--------------------------------------------------+

auditctx query

Find all the audit contexts based on the given query

Usage

copy
cpln auditctx 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 Tag 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"]
--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]
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
NOTE

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

  • Search for an audit context based on the name property
$ cpln auditctx query --match any --prop name=demo-audit-context --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|------------|
|demo-audit-context |demo-audit-context |default |type="demo" |
+-------------------+-----------------------------------------+--------+------------+
  • Search for audit contexts based on the description property
$ cpln auditctx query --match any --prop description="Clone of demo-audit-context" --org demo-cpln-organization
+-------------------------+-----------------------------------------+--------+-----+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------------|-----------------------------------------|--------|-----|
|demo-audit-context-clone |Clone of demo-audit-context |default | |
+-------------------------+-----------------------------------------+--------+-----+
  • Search for audit contexts based on a tag
$ cpln auditctx query --match any --tag type=demo --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|------------|
|demo-audit-context |demo-audit-context |default |type="demo" |
+-------------------+-----------------------------------------+--------+------------+
  • Search for audit contexts based on a property and tag
$ cpln auditctx query --match any --prop description="Audit of your CPLN org" --tag type=demo --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|------------|
|cpln |Audit of your CPLN org |builtin | |
|demo-audit-context |demo-audit-context |default |type="demo" |
+-------------------+-----------------------------------------+--------+------------+

auditctx tag

Manage the tags belonging to one or more referenced audit contexts

Usage

copy
cpln auditctx tag <ref...> --tag KEY=VALUE [OPTIONS]
NOTE

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)
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"]
--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]
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 audit context
$ cpln auditctx tag demo-audit-context --tag name="Demo Audit Context" --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+--------------------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|--------------------------|
|demo-audit-context |demo-audit-context |default |name="Demo Audit Context" |
| | | |type="demo" |
+-------------------+-----------------------------------------+--------+--------------------------+
  • Update same tag (after running the example above)
$ cpln auditctx tag demo-audit-context --tag name="Replaced Tag" --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+--------------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|--------------------|
|demo-audit-context |demo-audit-context |default |name="Replaced Tag" |
| | | |type="demo" |
+-------------------+-----------------------------------------+--------+--------------------+
  • Remove tag (after running the example above)
$ cpln auditctx tag demo-audit-context --tag name= --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|------------|
|demo-audit-context |demo-audit-context |default |type="demo" |
+-------------------+-----------------------------------------+--------+------------+

auditctx update

Update properties of the referenced audit context

Usage

copy
cpln auditctx 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 [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"]
--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]
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 audit context properties:
    • description
      • Description of the audit context
      • Type: string
    • tags
      • Tags (key=value) associated with the audit context
      • Type: string
Example
  • For the examples below, the initial audit context is configured as:
+-------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|------------|
|demo-audit-context |demo-audit-context |default |type="demo" |
+-------------------+-----------------------------------------+--------+------------+
  • Update an audit context's description
$ cpln auditctx update demo-audit-context --set description="Audit Text With An Updated Description" --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|------------|
|demo-audit-context |Audit Text With An Updated Description |default |type="demo" |
+-------------------+-----------------------------------------+--------+------------+
  • Update an audit context's tag
$ cpln auditctx update demo-audit-context --set tags.type=updated --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+---------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|---------------|
|demo-audit-context |Audit Text With An Updated Description |default |type="updated" |
+-------------------+-----------------------------------------+--------+---------------+

cloudaccount

Manage cloud accounts

For a detailed overview, please visit the cloud account's reference page.

copy
cpln cloudaccount [SUBCOMMAND]

Commands: cpln cloudaccount access-report <ref> Show the access report for the referenced cloud account cpln cloudaccount create-aws Create an AWS cloud account cpln cloudaccount create-azure Create an Azure cloud account cpln cloudaccount create-gcp Create a GCP cloud account cpln cloudaccount delete <ref...> Delete one or more referenced cloud accounts cpln cloudaccount edit <ref> Edit the referenced cloud account, as YAML, within an editor cpln cloudaccount eventlog <ref> Show the event log of the referenced cloud account [aliases: log] cpln cloudaccount get [ref...] Retrieve one or more referenced cloud accounts cpln cloudaccount patch <ref> Update the referenced cloud account's metadata using an input file cpln cloudaccount permissions Show the grantable permissions for a cloud account object type cpln cloudaccount query Find all the cloud accounts based on the given query cpln cloudaccount tag <ref...> Manage the tags belonging to one or more referenced cloud accounts

Options: --help Show help [boolean]


cloudaccount Subcommands


cloudaccount access-report

Show the access report for the referenced cloud account

Usage

copy
cpln cloudaccount 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"]
--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]
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 cloudaccount access-report demo-aws-cloud-account-access-report --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|browse |/org/demo-cpln-organization/group/superusers |manage |
|browse |/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 |
+-----------+--------------------------------------------------------+--------+

cloudaccount create-aws

Create an AWS cloud account

Usage

copy
cpln cloudaccount create-aws --name ACCOUNT_NAME --role-arn ROLE_ARN [OPTIONS]
TIP

By defining an AWS cloud account, you enable workloads to consume services from a specific AWS account. The Control Plane CLI (cpln) provides account-specific instructions for registering an AWS cloud account with Control Plane. Simply execute cpln cloudaccount create-aws --how to obtain step-by-step instructions. The instructions emitted are specific to the organization for the currently logged-on cpln user. To override the organization, pass the --org ORG_NAME option.

Reference
Command options:
--name Name of the new account
--description, --desc Optional description, defaults to the name if not set
--role-arn ARN of the role used by Control Plane to manage the account, in format `arn:aws:iam::<account number>:role/<name>`
--how Show the steps on how to create and configure your AWS account [boolean]
--tag Attach tags (e.g., --tag drink=water)
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"]
--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]
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 cloudaccount create-aws --name demo-aws-cloud-account --role-arn arn:aws:iam::123412341234:role/cpln-demo-cpln-organization --org demo-cpln-organization
+-----------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------|-----------------------------------------|---------|-----------------------------------------------------------|----------|-----|
|demo-aws-cloud-account |demo-aws-cloud-account |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes | |
+-----------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+-----+

cloudaccount create-azure

Create an Azure cloud account

Usage

copy
cpln cloudaccount create-azure --name ACCOUNT_NAME --secret AZURE_SECRET [OPTIONS]
INFO

By defining an Azure cloud account, you enable workloads to consume services from a specific Azure account. The Control Plane CLI (cpln) provides account-specific instructions for registering an Azure cloud account with Control Plane. Simply execute cpln cloudaccount create-azure --how to obtain step-by-step instructions. The instructions emitted are specific to the organization for the currently logged-on cpln user. To override the organization, pass the --org ORG_NAME option.

Reference
Command options:
--name Name of the new account
--description, --desc Optional description, defaults to the name if not set
--secret The SDK secret used to authenticate to Azure
--how Show the steps on how to create and configure your Azure subscription [boolean]
--tag Attach tags (e.g., --tag drink=water)
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"]
--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]
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 cloudaccount create-azure --name demo-azure-cloud-account --secret azure_secret --org demo-cpln-organization
+-------------------------+-----------------------------------------+---------+-----+----------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-------------------------|-----------------------------------------|---------|-----|----------|-----|
|demo-azure-cloud-account |demo-azure-cloud-account |azure | |0 minutes | |
+-------------------------+-----------------------------------------+---------+-----+----------+-----+

cloudaccount create-gcp

Create a GCP cloud account

Usage

copy
cpln cloudaccount create-gcp --name ACCOUNT_NAME --project-id PROJECT_ID [OPTIONS]
INFO

By defining a GCP cloud account, you enable workloads to consume services from a specific GCP account. The Control Plane CLI (cpln) provides account-specific instructions for registering a GCP cloud account with Control Plane. Simply execute cpln cloudaccount create-gcp --how to obtain step-by-step instructions. The instructions emitted are specific to the organization for the currently logged-on cpln user. To override the organization, pass the --org ORG_NAME option.

Reference
Command options:
--name Name of the new account
--description, --desc Optional description, defaults to the name if not set
--project-id The ID of the project that Control Plane will manage
--how Show the steps on how to create and configure your GCP project [boolean]
--tag Attach tags (e.g., --tag drink=water)
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"]
--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]
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 cloudaccount create-gcp --name demo-gcp-cloud-account --project-id 1234abc --org demo-cpln-organization
+-----------------------+-----------------------------------------+---------+--------+----------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------|-----------------------------------------|---------|--------|----------|-----|
|demo-gcp-cloud-account |demo-gcp-cloud-account |gcp |1234abc |0 minutes | |
+-----------------------+-----------------------------------------+---------+--------+----------+-----+

cloudaccount delete

Delete one or more referenced cloud accounts

Usage

copy
cpln cloudaccount delete <ref...> [OPTIONS]
CAUTION

Deleting a cloud account will not remove any configuration at the associated cloud provider

Reference
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [required] [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"]
--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]
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 cloud account
$ cpln cloudaccount demo-gcp-cloud-account --org demo-organization
If the delete was successful, a new command prompt will be shown.
  • Delete multiple cloud accounts
$ cpln cloudaccount demo-gcp-cloud-account demo-azure-cloud-account --org demo-organization
If the delete was successful, a new command prompt will be shown.

cloudaccount edit

Edit the referenced cloud account, as YAML, within an editor

Usage

copy
cpln cloudaccount edit <ref> [OPTIONS]
NOTE

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]
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"]
--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]
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 cloudaccount edit demo-gcp-cloud-account --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

cloudaccount eventlog

Show the event log of the referenced cloud account

Usage

copy
cpln cloudaccount 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"]
--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]
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 cloudacccount eventlog demo-azure-cloud-account --org demo-cpln-organization
The event log for the referenced cloud acccount will be shown.

cloudaccount get

Retrieve one or more referenced cloud accounts

Usage

copy
cpln cloudaccount get [ref...] [OPTIONS]
NOTE

An empty reference will return all cloud accounts

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"]
--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]
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 cloud accounts
$ cpln cloudaccount get --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|-----------------------------------------------------------|----------|-----|
|demo-aws-cloud-account-get |demo-aws-cloud-account-get |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes | |
|demo-azure-cloud-account-get |demo-azure-cloud-account-get |azure | |0 minutes | |
|demo-gcp-cloud-account-get |demo-gcp-cloud-account-get |gcp |1234abc |0 minutes | |
+-----------------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+-----+
  • Get one cloud account
$ cpln cloudaccount get demo-aws-cloud-account-get --org demo-cpln-organization
+---------------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|---------------------------|-----------------------------------------|---------|-----------------------------------------------------------|----------|-----|
|demo-aws-cloud-account-get |demo-aws-cloud-account-get |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes | |
+---------------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+-----+
  • Get multiple cloud accounts
$ cpln cloudaccount get demo-azure-cloud-account-get demo-gcp-cloud-account-get --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+--------+----------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|--------|----------|-----|
|demo-azure-cloud-account-get |demo-azure-cloud-account-get |azure | |0 minutes | |
|demo-gcp-cloud-account-get |demo-gcp-cloud-account-get |gcp |1234abc |0 minutes | |
+-----------------------------+-----------------------------------------+---------+--------+----------+-----+

cloudaccount patch

Update the referenced cloud account's metadata using an input file

Usage

copy
cpln cloudaccount patch <ref> --file FILE_NAME [OPTIONS]
NOTE

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]
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"]
--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]
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 cloudaccount patch demo-gcp-cloud-account --file cloud-account-update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced cloud account.

cloudaccount permissions

Show the grantable permissions for a cloud account object type

Usage

copy
cpln cloudaccount 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"]
--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]
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 account permissions --org demo-cpln-organization
+-------+-----------------------------------------+-------------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|-------------------------------------------|
|browse |Browse account contents |view |
|create |Create new cloud accounts | |
|delete |Delete existing cloud accounts | |
|edit |Modify existing cloud accounts |view, browse |
|manage |Full access |browse, create, delete, edit, manage, view |
|view |Read-only access | |
+-------+-----------------------------------------+-------------------------------------------+

cloudaccount query

Find all the cloud accounts based on the given query

Usage

copy
cpln cloudaccount 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 Tag 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"]
--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]
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
NOTE

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

  • Search for an cloud account based on the name property
$ cpln cloudaccount query --match any --prop name=demo-aws-cloud-account-get --org demo-cpln-organization
+---------------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+----------------+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|---------------------------|-----------------------------------------|---------|-----------------------------------------------------------|----------|----------------|
|demo-aws-cloud-account-get |demo-aws-cloud-account-get |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes |account="cloud" |
+---------------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+----------------+
  • Search for an cloud account based on the description property
$ cpln cloudaccount query --match any --prop description="Azure Cloud Account" --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+-----+----------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|-----|----------|-----|
|demo-azure-cloud-account-get |Azure Cloud Account |azure | |0 minutes | |
+-----------------------------+-----------------------------------------+---------+-----+----------+-----+
  • Search for a cloud account based on a tag
$ cpln cloudaccount query --match any --tag account=cloud --org demo-cpln-organization
+---------------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+----------------+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|---------------------------|-----------------------------------------|---------|-----------------------------------------------------------|----------|----------------|
|demo-aws-cloud-account-get |demo-aws-cloud-account-get |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes |account="cloud" |
+---------------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+----------------+
  • Search for a cloud account based on a property and tag
$ cpln cloudaccount query --match any --prop description="Azure Cloud Account" --tag account=cloud --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+----------------+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|-----------------------------------------------------------|----------|----------------|
|demo-aws-cloud-account-get |demo-aws-cloud-account-get |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes |account="cloud" |
|demo-azure-cloud-account-get |Azure Cloud Account |azure | |0 minutes | |
+-----------------------------+-----------------------------------------+---------+-----------------------------------------------------------+----------+----------------+

cloudaccount tag

Manage the tags belonging to one or more referenced cloud accounts

Usage

copy
cpln cloudaccount tag <ref...> --tag KEY=VALUE [OPTIONS]
NOTE

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)
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"]
--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]
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 cloud account
$ cpln cloudaccount tag demo-azure-cloud-account-tag --tag name="Demo Cloud Account" --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+-----+----------+--------------------------+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|-----|----------|--------------------------|
|demo-azure-cloud-account-tag |demo-azure-cloud-account-tag |azure | |0 minutes |name="Demo Cloud Account" |
+-----------------------------+-----------------------------------------+---------+-----+----------+--------------------------+
  • Update same tag (after running the example above)
$ cpln cloudaccount tag demo-azure-cloud-account-tag --tag name="Replaced Tag" --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+-----+----------+--------------------+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|-----|----------|--------------------|
|demo-azure-cloud-account-tag |demo-azure-cloud-account-tag |azure | |0 minutes |name="Replaced Tag" |
+-----------------------------+-----------------------------------------+---------+-----+----------+--------------------+
  • Remove tag (after running the example above)
$ cpln cloudaccount tag demo-azure-cloud-account-tag --tag name= --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+-----+----------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|-----|----------|-----|
|demo-azure-cloud-account-tag |demo-azure-cloud-account-tag |azure | |0 minutes | |
+-----------------------------+-----------------------------------------+---------+-----+----------+-----+
  • Add same tag to multiple cloud accounts
$ cpln cloudaccount tag demo-azure-cloud-account-tag demo-gcp-cloud-account-tag --tag multiple-cloudaccounts=true --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+--------+----------+----------------------------+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|--------|----------|----------------------------|
|demo-azure-cloud-account-tag |demo-azure-cloud-account-tag |azure | |0 minutes |multiple-cloudaccounts=true |
|demo-gcp-cloud-account-tag |demo-gcp-cloud-account-tag |gcp |1234abc |0 minutes |multiple-cloudaccounts=true |
+-----------------------------+-----------------------------------------+---------+--------+----------+----------------------------+
  • Update same tag on multiple cloud accounts (after running the example above)
$ cpln cloudaccount tag demo-azure-cloud-account-tag demo-gcp-cloud-account-tag --tag multiple-cloudaccounts=demo-cloudaccount --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+--------+----------+-------------------------------------------+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|--------|----------|-------------------------------------------|
|demo-azure-cloud-account-tag |demo-azure-cloud-account-tag |azure | |0 minutes |multiple-cloudaccounts="demo-cloudaccount" |
|demo-gcp-cloud-account-tag |demo-gcp-cloud-account-tag |gcp |1234abc |0 minutes |multiple-cloudaccounts="demo-cloudaccount" |
+-----------------------------+-----------------------------------------+---------+--------+----------+-------------------------------------------+
  • Remove same tag from multiple cloud accounts (after running the example above)
$ cpln cloudaccount tag demo-azure-cloud-account-tag demo-gcp-cloud-account-tag --tag multiple-cloudaccounts= --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+--------+----------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|--------|----------|-----|
|demo-azure-cloud-account-tag |demo-azure-cloud-account-tag |azure | |0 minutes | |
|demo-gcp-cloud-account-tag |demo-gcp-cloud-account-tag |gcp |1234abc |0 minutes | |
+-----------------------------+-----------------------------------------+---------+--------+----------+-----+

domain

Manage custom domains

For a detailed overview, please visit the domain's reference page.

copy
cpln domain [SUBCOMMAND]

Commands: cpln domain access-report <ref> Show the access report for the referenced domain cpln domain create Create a new domain cpln domain delete <ref...> Delete one or more referenced domains cpln domain edit <ref> Edit the referenced domain, as YAML, within an editor cpln domain eventlog <ref> Show the event log of the referenced domain [aliases: log] cpln domain get [ref...] Retrieve one or more referenced domains cpln domain patch <ref> Update the referenced domain's metadata using an input file cpln domain permissions Show the grantable permissions for a domain object type cpln domain query Find all the domains based on the given query cpln domain tag <ref...> Manage the tags belonging to one or more referenced domains

Options: --help Show help [boolean]


domain Subcommands


domain access-report

Show the access report for the referenced domain

Usage

copy
cpln domain 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"]
--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]
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
NOTE

The domain demo.globalvirtualcloud.com has already been added to the demo-cpln-organization organization

$ cpln domain access-report demo.globalvirtualcloud.com --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|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 |
|use |/org/demo-cpln-organization/group/superusers |manage |
|use |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/superusers |manage |
|view |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/viewers |view |
+-----------+--------------------------------------------------------+--------+

domain create

Create a new domain

Usage

copy
cpln domain create --name DOMAIN_NAME [OPTIONS]
NOTE

Ownership of the referenced domain is required by setting a TXT DNS entry.

Please review the instructions here.

Reference
Command options:
--name Fully qualified domain name (e.g., widgets.example.com) [required]
--description, --desc Optional description, defaults to the name if not set
--tag Attach tags (e.g., --tag drink=water)
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"]
--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]
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 domain create --name demo.globalvirtualcloud.com --org demo-cpln-organization
The ownership of the referenced domain will be validated and if successful, added to the referenced organization.

domain delete

Delete one or more referenced domains

Usage

copy
cpln domain delete <ref...> [OPTIONS]
Reference
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [required] [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"]
--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]
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 domain create --name demo.globalvirtualcloud.com --org demo-cpln-organization
The referenced domain will be removed from the referenced organization.

domain edit

NOTE

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

Usage

copy
cpln domain edit <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"]
--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]
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 domain edit demo.globalvirtualcloud.com --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

domain eventlog

Show the event log of the referenced domain

Usage

copy
cpln domain 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"]
--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]
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 domain eventlog demo.globalvirtualcloud.com --org demo-cpln-organization
The event log for the referenced domain will be shown.

domain get

Retrieve one or more referenced domains

Usage

copy
cpln domain get [ref...] [OPTIONS]
NOTE

An empty reference will return all domains

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"]
--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]
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
  • Show a domain
$ cpln domain get demo.globalvirtualcloud.com --org demo-cpln-organization
+----------------------------+-----------------------------------------+-----+
|NAME |DESCRIPTION |TAGS |
|----------------------------|-----------------------------------------|-----|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com | |
+----------------------------+-----------------------------------------+-----+
  • Show multiple domains
$ cpln domain get demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --org demo-cpln-organization
+-----------------------------+-----------------------------------------+-----+
|NAME |DESCRIPTION |TAGS |
|-----------------------------|-----------------------------------------|-----|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com | |
|demo2.globalvirtualcloud.com |demo2.globalvirtualcloud.com | |
+-----------------------------+-----------------------------------------+-----+

domain patch

Update the referenced domain's metadata using an input file

Usage

copy
cpln domain patch <ref> --file FILE_NAME [OPTIONS]
NOTE

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]
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"]
--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]
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 domain patch demo.globalvirtualcloud.com --file domain-update.json
The changes within the JSON file will be performed against the referenced domain.

domain permissions

Show the grantable permissions for a domain object type

Usage

copy
cpln domain 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"]
--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]
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 domain permissions --org demo-cpln-organization
+-------+-----------------------------------------+----------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|----------------------------------------|
|create |Create new domain | |
|delete |Delete a domain | |
|edit |Modify existing domains (only tags ca... |view, use |
|manage |Full access |create, delete, edit, manage, use, view |
|use |Allow a principal to use this domain |view |
|view |Read-only access | |
+-------+-----------------------------------------+----------------------------------------+

domain query

Find all the domains based on the given query

Usage

copy
cpln domain 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 Tag 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"]
--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]
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
NOTE

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

The domain demo.globalvirtualcloud.com has already been added to the demo-cpln-organization organization

  • Search for an domain based on the name property
$ cpln domain query --match any --prop name="demo.globalvirtualcloud.com" --org demo-cpln-organization
+----------------------------+-----------------------------------------+-----+
|NAME |DESCRIPTION |TAGS |
|----------------------------|-----------------------------------------|-----|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com | |
+----------------------------+-----------------------------------------+-----+
  • Search for an domain based on the description property
$ cpln domain query --match any --prop description="FQDN: demo.globalvirtualcloud.com" --org demo-cpln-organization
+----------------------------+-----------------------------------------+-----+
|NAME |DESCRIPTION |TAGS |
|----------------------------|-----------------------------------------|-----|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com | |
+----------------------------+-----------------------------------------+-----+
  • Search for an domain based on a tag
$ cpln domain query --match any --tag demo-domain="true" --org demo-cpln-organization
+-----+-----------------------------------------+-----+
|NAME |DESCRIPTION |TAGS |
+-----+-----------------------------------------+-----+
  • Search for an domain based on a property and tag
$ cpln domain query --match any --prop name="demo.globalvirtualcloud.com" --tag demo-domain="true" --org demo-cpln-organization
+----------------------------+-----------------------------------------+-----+
|NAME |DESCRIPTION |TAGS |
|----------------------------|-----------------------------------------|-----|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com | |
+----------------------------+-----------------------------------------+-----+

domain tag

Manage the tags belonging to one or more referenced domains

Usage

copy
cpln domain tag <ref...> --tag KEY=VALUE [OPTIONS]
NOTE

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)
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"]
--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]
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 domain
$ cpln domain tag demo.globalvirtualcloud.com --tag name="Demo Domain" --org demo-cpln-organization
+----------------------------+-----------------------------------------+-------------------+
|NAME |DESCRIPTION |TAGS |
|----------------------------|-----------------------------------------|-------------------|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |name="Demo Domain" |
+----------------------------+-----------------------------------------+-------------------+
  • Update same tag (after running the example above)
$ cpln domain tag demo.globalvirtualcloud.com --tag name="Replaced Tag" --org demo-cpln-organization
+----------------------------+-----------------------------------------+--------------------+
|NAME |DESCRIPTION |TAGS |
|----------------------------|-----------------------------------------|--------------------|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |name="Replaced Tag" |
+----------------------------+-----------------------------------------+--------------------+
  • Remove tag (after running the example above)
$ cpln domain tag demo.globalvirtualcloud.com --tag name= --org demo-cpln-organization
+----------------------------+-----------------------------------------+-----+
|NAME |DESCRIPTION |TAGS |
|----------------------------|-----------------------------------------|-----|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com | |
+----------------------------+-----------------------------------------+-----+
  • Add same tag to multiple domain
$ cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --tag multiple-domains=true --org demo-cpln-organization
+-----------------------------+-----------------------------------------+----------------------+
|NAME |DESCRIPTION |TAGS |
|-----------------------------|-----------------------------------------|----------------------|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |multiple-domains=true |
|demo2.globalvirtualcloud.com |demo2.globalvirtualcloud.com |multiple-domains=true |
+-----------------------------+-----------------------------------------+----------------------+
  • Update same tag on multiple domain (after running the example above)
$ cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --tag multiple-domains=demo-domain --org demo-cpln-organization
+-----------------------------+-----------------------------------------+-------------------------------+
|NAME |DESCRIPTION |TAGS |
|-----------------------------|-----------------------------------------|-------------------------------|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |multiple-domains="demo-domain" |
|demo2.globalvirtualcloud.com |demo2.globalvirtualcloud.com |multiple-domains="demo-domain" |
+-----------------------------+-----------------------------------------+-------------------------------+
  • Remove same tag from multiple domain (after running the example above)
$ cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --tag multiple-domains= --org demo-cpln-organization
+-----------------------------+-----------------------------------------+-----+
|NAME |DESCRIPTION |TAGS |
|-----------------------------|-----------------------------------------|-----|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com | |
|demo2.globalvirtualcloud.com |demo2.globalvirtualcloud.com | |
+-----------------------------+-----------------------------------------+-----+

group

Manage groups

For a detailed overview, please visit the group's reference page.

copy
cpln group [SUBCOMMAND]

Commands: cpln group access-report <ref> Show the access report for the referenced group cpln group add-member <ref> Add members to the referenced group cpln group clone <ref> Create a clone of the referenced group [aliases: copy] cpln group create Create a new group cpln group delete <ref...> Delete one or more referenced groups cpln group edit <ref> Edit the referenced group, as YAML, within an editor cpln group eventlog <ref> Show the event log of the referenced group [aliases: log] cpln group get [ref...] Retrieve one or more referenced groups cpln group patch <ref> Update the referenced group's metadata using an input file cpln group permissions Show the grantable permissions for a group object type cpln group query Find all the groups based on the given query cpln group remove-member <ref> Remove members from the referenced group cpln group tag <ref...> Manage the tags belonging to one or more referenced groups cpln group update <ref> Update properties of the referenced group

Options: --help Show help [boolean]


group Subcommands


group access-report

Show the access report for the referenced group

Usage

copy
cpln group 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"]
--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]
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 group access-report demo-group-ar --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|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 |
+-----------+--------------------------------------------------------+--------+

group add-member

Add members to the referenced group

Usage

copy
cpln group add-member <ref> --email USER_EMAIL [OPTIONS]
cpln group add-member <ref> --serviceaccount SERVICE_ACCOUNT [OPTIONS]
Reference
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Command options:
--email Email of user to add
--serviceaccount Name of the service account to add
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"]
--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]
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 user to a group
$ cpln group add-member demo-group-add-member --email test-128@example.com --org demo-cpln-organization
+----------------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|----------------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-add-member |demo-group-add-member |0 minutes |links |default | |
+----------------------+-----------------------------------------+----------+-------+--------+-----+
  • Add a service account to a group using email
$ cpln group add-member demo-group-add-member --serviceaccount controlplane --org demo-cpln-organization
+----------------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|----------------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-add-member |demo-group-add-member |0 minutes |links |default | |
+----------------------+-----------------------------------------+----------+-------+--------+-----+

group clone

Create a clone of the referenced group

Usage

copy
cpln group 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)
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"]
--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]
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 group clone demo-group-clone --name demo-group-clone-2 --org demo-cpln-organization
+-------------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-------------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-clone-2 |Clone of demo-group-clone |0 minutes |links |default | |
+-------------------+-----------------------------------------+----------+-------+--------+-----+

group create

Create a new group

Usage

copy
cpln group create --name GROUP_NAME [OPTIONS]
TIP

After creating a new group, use the subcommand add-member to populate the group with users and/or service accounts.

Reference
Command options:
--name Name of the new group [required]
--description, --desc Optional description, defaults to the name if not set
--tag Attach tags (e.g., --tag drink=water)
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
--query-kind Kind to query [choices: "user"]
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"]
--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]
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 group create --name demo-group-create --org demo-cpln-organization
+------------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-create |demo-group-create |0 minutes |links |default | |
+------------------+-----------------------------------------+----------+-------+--------+-----+

group delete

Delete one or more referenced groups

Usage

copy
cpln group delete <ref...> [OPTIONS]
Reference
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [required] [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"]
--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]
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 group delete demo-group-delete --org demo-cpln-organization
If the delete was successful, a new command prompt will be shown.

group edit

Edit the referenced group, as YAML, within an editor

Usage

copy
cpln group edit <ref> [OPTIONS]
NOTE

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]
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"]
--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]
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 group edit demo-group --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

group eventlog

Show the event log of the referenced group

Usage

copy
cpln group 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"]
--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]
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 group eventlog demo-group-eventlog --org demo-cpln-organization
The event log for the referenced group will be shown.

group get

Retrieve one or more referenced groups

Usage

copy
cpln group get [ref...] [OPTIONS]
NOTE

An empty reference will return all groups

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"]
--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]
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 groups
$ cpln group get --org demo-cpln-organization
+------------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-get |demo-group-get |0 minutes |links |default | |
|demo-group-get-02 |demo-group-get-02 |0 minutes |links |default | |
|superusers |Built-in group for all administrators... |9 months |links |builtin | |
|viewers |Built-in group for read-only access |9 months |links |builtin | |
+------------------+-----------------------------------------+----------+-------+--------+-----+
  • Get one group
$ cpln group get demo-group-get --org demo-cpln-organization
+---------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|---------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-get |demo-group-get |0 minutes |links |default | |
+---------------+-----------------------------------------+----------+-------+--------+-----+
  • Get multiple groups
$ cpln group get demo-group-get demo-group-get-02 --org demo-cpln-organization
+------------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-get |demo-group-get |0 minutes |links |default | |
|demo-group-get-02 |demo-group-get-02 |0 minutes |links |default | |
+------------------+-----------------------------------------+----------+-------+--------+-----+

group patch

Update the referenced group's metadata using an input file

Usage

copy
cpln group patch <ref> --file FILE_NAME [OPTIONS]
NOTE

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]
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"]
--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]
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 group patch demo-group --file group-update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced group.

group permissions

Show the grantable permissions for a group object type

Usage

copy
cpln group 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"]
--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]
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 group permissions --org demo-cpln-organization
+-------+-----------------------------------------+-----------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|-----------------------------------|
|create |Create new groups | |
|delete |Delete a group | |
|edit |Modify existing groups |view |
|manage |Full access |create, delete, edit, manage, view |
|view |Read-only view | |
+-------+-----------------------------------------+-----------------------------------+

group query

Find all the groups based on the given query

Usage

copy
cpln group 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 Tag 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"]
--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]
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
NOTE

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

  • Search for a group based on a name
$ cpln group query --match any --prop name="demo-group-query" --org demo-cpln-organization
+-----------------+-----------------------------------------+----------+-------+--------+----------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|----------|-------|--------|----------------|
|demo-group-query |Demo Group |0 minutes |links |default |demo-group=true |
+-----------------+-----------------------------------------+----------+-------+--------+----------------+
  • Search for a group based on a description
$ cpln group query --match any --prop description="Demo Group" --org demo-cpln-organization
+-----------------+-----------------------------------------+----------+-------+--------+----------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|----------|-------|--------|----------------|
|demo-group-query |Demo Group |0 minutes |links |default |demo-group=true |
+-----------------+-----------------------------------------+----------+-------+--------+----------------+
  • Search for a group based on a tag
$ cpln group query --match any --tag demo-group="true" --org demo-cpln-organization
+-----------------+-----------------------------------------+----------+-------+--------+----------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|----------|-------|--------|----------------|
|demo-group-query |Demo Group |0 minutes |links |default |demo-group=true |
+-----------------+-----------------------------------------+----------+-------+--------+----------------+
  • Search for a group based on a property and tag
$ cpln group query --match any --prop name="demo-group-query" --tag demo-group="true" --org demo-cpln-organization
+-----------------+-----------------------------------------+----------+-------+--------+----------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|----------|-------|--------|----------------|
|demo-group-query |Demo Group |0 minutes |links |default |demo-group=true |
+-----------------+-----------------------------------------+----------+-------+--------+----------------+

group remove-member

Remove members from the referenced group

Usage

copy
cpln group remove-member <ref> --email USER_EMAIL [OPTIONS]
cpln group remove-member <ref> --serviceaccount SERVICE_ACCOUNT [OPTIONS]
Reference
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Command options:
--email Email of user to remove
--serviceaccount Name of the service account to remove
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"]
--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]
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
NOTE

The user and service account referenced in the examples below were previously added to the group

  • Remove a user to a group
$ cpln group remove-member demo-group-remove-member --email test-128@example.com --org demo-cpln-organization
+-------------------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-------------------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-remove-member |demo-group-remove-member |0 minutes |links |default | |
+-------------------------+-----------------------------------------+----------+-------+--------+-----+
  • Remove a service account to a group using email
$ cpln group remove-member demo-group-remove-member --serviceaccount controlplane --org demo-cpln-organization
+-------------------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-------------------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-remove-member |demo-group-remove-member |0 minutes |links |default | |
+-------------------------+-----------------------------------------+----------+-------+--------+-----+

group tag

Manage the tags belonging to one or more referenced groups

Usage

copy
cpln group tag <ref...> --tag KEY=VALUE [OPTIONS]
NOTE

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)
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"]
--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]
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 group
$ cpln group tag demo-group-tag --tag name="Demo Organization Group" --org demo-cpln-organization
+---------------+-----------------------------------------+----------+-------+--------+-------------------------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|---------------|-----------------------------------------|----------|-------|--------|-------------------------------|
|demo-group-tag |demo-group-tag |0 minutes |links |default |name="Demo Organization Group" |
+---------------+-----------------------------------------+----------+-------+--------+-------------------------------+
  • Update same tag (after running the example above)
$ cpln group tag demo-group-tag --tag name="Replaced Tag" --org demo-cpln-organization
+---------------+-----------------------------------------+----------+-------+--------+--------------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|---------------|-----------------------------------------|----------|-------|--------|--------------------|
|demo-group-tag |demo-group-tag |0 minutes |links |default |name="Replaced Tag" |
+---------------+-----------------------------------------+----------+-------+--------+--------------------+
  • Remove tag (after running the example above)
$ cpln group tag demo-group-tag --tag name= --org demo-cpln-organization
+---------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|---------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-tag |demo-group-tag |0 minutes |links |default | |
+---------------+-----------------------------------------+----------+-------+--------+-----+
  • Add same tag to multiple groups
$ cpln group tag demo-group-tag demo-group-02-tag --tag multiple-groups=true --org demo-cpln-organization
+------------------+-----------------------------------------+----------+-------+--------+---------------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|----------|-------|--------|---------------------|
|demo-group-tag |demo-group-tag |0 minutes |links |default |multiple-groups=true |
|demo-group-02-tag |demo-group-02-tag |0 minutes |links |default |multiple-groups=true |
+------------------+-----------------------------------------+----------+-------+--------+---------------------+
  • Update same tag on multiple groups (after running the example above)
$ cpln group tag demo-group-tag demo-group-02-tag --tag multiple-group=demo-org --org demo-cpln-organization
+------------------+-----------------------------------------+----------+-------+--------+-----------------------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|----------|-------|--------|-----------------------------|
|demo-group-tag |demo-group-tag |0 minutes |links |default |multiple-groups="demo-group" |
|demo-group-02-tag |demo-group-02-tag |0 minutes |links |default |multiple-groups="demo-group" |
+------------------+-----------------------------------------+----------+-------+--------+-----------------------------+
  • Remove same tag from multiple groups (after running the example above)
$ cpln group tag demo-group-tag demo-group-02-tag --tag multiple-groups= --org demo-cpln-organization
+------------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-tag |demo-group-tag |0 minutes |links |default | |
|demo-group-02-tag |demo-group-02-tag |0 minutes |links |default | |
+------------------+-----------------------------------------+----------+-------+--------+-----+

group update

Update properties of the referenced group

Usage

copy
cpln group update <ref> --set UPDATE_PROPERTIES [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
memberLinks string[]
Arrays can be appended to, replaced, or removed using the `+=`, `=`, or `-=` operators, respectively. [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"]
--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]
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 group properties:
    • description
      • Description of the group
      • Type: string
    • tags
      • Tags (key=value) associated with the group
      • Type: string
    • memberLinks
      • Array of links belonging to members of the group
      • Type: string[]
Example
  • For the examples below, the initial group is configured as:
+------------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-update |demo-group-update |0 minutes |links |default | |
+------------------+-----------------------------------------+----------+-------+--------+-----+
  • Update an group's description
$ cpln group update demo-group-update --set description="Group With Updated Description" --org demo-cpln-organization
+------------------+-----------------------------------------+----------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|----------|-------|--------|-----|
|demo-group-update |Group With Updated Description |0 minutes |links |default | |
+------------------+-----------------------------------------+----------+-------+--------+-----+
  • Update an group's tags
$ cpln group update demo-group-update --set tags.group-name="Demo Group" --org demo-cpln-organization
+------------------+-----------------------------------------+----------+-------+--------+------------------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|----------|-------|--------|------------------------|
|demo-group-update |Group With Updated Description |0 minutes |links |default |group-name="Demo Group" |
+------------------+-----------------------------------------+----------+-------+--------+------------------------+
  • Add to a group's member links. This examples adds the built-in controlplane service account
$ cpln group update demo-group-update --set memberLinks+="/org/demo-cpln-organization/serviceaccount/controlplane" --org demo-cpln-organization
+------------------+-----------------------------------------+----------+-------+--------+------------------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|----------|-------|--------|------------------------|
|demo-group-update |Group With Updated Description |0 minutes |links |default |group-name="Demo Group" |
+------------------+-----------------------------------------+----------+-------+--------+------------------------+
  • Remove from a group's member links. This examples removes the built-in controlplane service account
$ cpln group update demo-group-update --set memberLinks-="/org/demo-cpln-organization/serviceaccount/controlplane" --org demo-cpln-organization
+------------------+-----------------------------------------+----------+-------+--------+------------------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|----------|-------|--------|------------------------|
|demo-group-update |Group With Updated Description |0 minutes |links |default |group-name="Demo Group" |
+------------------+-----------------------------------------+----------+-------+--------+------------------------+

gvc

Manage global virtual clouds

For a detailed overview, please visit the gvc's reference page.

copy
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 clone <ref> Create a clone of the referenced global virtual cloud [aliases: copy] cpln gvc create Create a new global virtual cloud cpln gvc delete <ref...> Delete one or more referenced global virtual clouds 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 Subcommands


gvc access-report

Show the access report for the referenced global virtual cloud

Usage

copy
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"]
--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]
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-ar' global virtual cloud within the 'demo-cpln-organization' organization
$ cpln gvc access-report demo-gvc-ar --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|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/superusers |manage |
|view |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/viewers |view |
+-----------+--------------------------------------------------------+--------+

gvc add-location

Add one or more locations to the referenced global virtual cloud

Usage

copy
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]
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"]
--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]
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
NOTE

The gvc, named 'demo-gvc-add', 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-add --location aws-us-west-2 --org demo-cpln-organization
+-------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|-------------|-----------------------------------------|----------|--------------|----------|-----------------|-----|
|demo-gvc-add |demo-gvc-add |0 minutes |vf37ngme2cc82 | |aws-eu-central-1 | |
| | | | | |aws-us-west-2 | |
+-------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
  • Add multiple locations to a global virtual cloud
$ cpln gvc add-location demo-gvc-add --location aws-us-west-2 --location gcp-us-east1 --org demo-cpln-organization
+-------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|-------------|-----------------------------------------|----------|--------------|----------|-----------------|-----|
|demo-gvc-add |demo-gvc-add |0 minutes |vf37ngme2cc82 | |aws-eu-central-1 | |
| | | | | |aws-us-west-2 | |
| | | | | |gcp-us-east1 | |
+-------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+

gvc clone

Create a clone of the referenced global virtual cloud

Usage

copy
cpln gvc clone <ref> --name GVC_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)
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"]
--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]
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
  • Create a clone of an existing gvc
$ cpln gvc clone demo-gvc-c --name demo-gvc-clone --org demo-cpln-organization
+---------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|----------|--------------|----------|-----------------|-----|
|demo-gvc-clone |Clone of demo-gvc-c |0 minutes |p92grxsqkdn8a | |aws-eu-central-1 | |
+---------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+

gvc create

Create a new global virtual cloud

Usage

copy
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]
--domain Domain associated with this new global virtual cloud
--tag Attach tags (e.g., --tag drink=water)
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"]
--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]
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-create --location aws-eu-central-1 --org demo-cpln-organization
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|----------|--------------|----------|-----------------|-----|
|demo-gvc-create |demo-gvc-create |0 minutes |zvzqn94wssb5m | |aws-eu-central-1 | |
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+

gvc delete

Delete one or more referenced global virtual clouds

Usage

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

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: []]
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"]
--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]
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 --org demo-cpln-organization
If the delete was successful, a new command prompt will be shown.
  • Delete multiple gvcs
$ cpln gvc delete demo-gvc-2-delete demo-gvc-3-delete --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

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

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"]
--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]
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-delete-all --org demo-cpln-organization
+--------------+-----------------------------------------+--------------------+----------+-----------------------------------------------+------------------------------------------------+
|NAME |DESCRIPTION |GVC |CREATED |ENDPOINT |TAGS |
|--------------|-----------------------------------------|--------------------|----------|-----------------------------------------------|------------------------------------------------|
|workload-01-a |workload-01-a |demo-gvc-delete-all |0 minutes |https://workload-01-a-j2xk2c38fmk1r.t.cpln.app |cpln/deployTimestamp="2021-10-15T15:57:31.006Z" |
|workload-02-a |workload-02-a |demo-gvc-delete-all |0 minutes |https://workload-02-a-j2xk2c38fmk1r.t.cpln.app |cpln/deployTimestamp="2021-10-15T15:57:32.009Z" |
+--------------+-----------------------------------------+--------------------+----------+-----------------------------------------------+------------------------------------------------+

gvc edit

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

Usage

copy
cpln gvc edit <ref> [OPTIONS]
NOTE

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]
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"]
--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]
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
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

copy
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"]
--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]
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-eventlog --org demo-cpln-organization
The event log for the referenced global virtual cloud will be shown.

gvc get

Retrieve one or more referenced global virtual clouds

Usage

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

An empty reference will return all global virtual clouds

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"]
--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]
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 a gvc
$ cpln gvc get demo-gvc-01-get --org demo-cpln-organization
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|----------|--------------|----------|-----------------|-----|
|demo-gvc-01-get |demo-gvc-01-get |0 minutes |vkhx2xpxg6a2m | |aws-eu-central-1 | |
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
  • Display multiple gvcs
$ cpln gvc get demo-gvc-01-get demo-gvc-02-get --org demo-cpln-organization
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|----------|--------------|----------|-----------------|-----|
|demo-gvc-01-get |demo-gvc-01-get |0 minutes |vkhx2xpxg6a2m | |aws-eu-central-1 | |
|demo-gvc-02-get |demo-gvc-02-get |0 minutes |z7dydbnzy2v28 | |aws-eu-central-1 | |
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+

gvc patch

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

Usage

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

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]
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"]
--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]
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 gvc-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

copy
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"]
--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]
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 |
|-------|-----------------------------------------|-----------------------------------|
|create |Create new gvcs | |
|delete |Delete existing gvcs | |
|edit |Modify existing gvcs |view |
|manage |Full access |create, delete, edit, manage, view |
|view |Read-only access | |
+-------+-----------------------------------------+-----------------------------------+

gvc query

Find all the global virtual clouds based on the given query

Usage

copy
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 Tag 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"]
--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]
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
NOTE

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 a name
$ cpln gvc query --match any --prop name="demo-gvc-query" --org demo-cpln-organization
+---------------+-----------------------------------------+----------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|----------|--------------|----------|-----------------|--------------|
|demo-gvc-query |Demo GVC |0 minutes |cdbmjkdk7wdv6 | |aws-eu-central-1 |demo-gvc=true |
+---------------+-----------------------------------------+----------+--------------+----------+-----------------+--------------+
  • Search for a gvc based on a description
$ cpln gvc query --match any --prop description="Demo GVC" --org demo-cpln-organization
+---------------+-----------------------------------------+----------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|----------|--------------|----------|-----------------|--------------|
|demo-gvc-query |Demo GVC |0 minutes |cdbmjkdk7wdv6 | |aws-eu-central-1 |demo-gvc=true |
+---------------+-----------------------------------------+----------+--------------+----------+-----------------+--------------+
  • Search for a gvc based on a tag
$ cpln gvc query --match any --tag demo-gvc="true" --org demo-cpln-organization
+---------------+-----------------------------------------+----------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|----------|--------------|----------|-----------------|--------------|
|demo-gvc-query |Demo GVC |0 minutes |cdbmjkdk7wdv6 | |aws-eu-central-1 |demo-gvc=true |
+---------------+-----------------------------------------+----------+--------------+----------+-----------------+--------------+
  • Search for a gvc based on a property and tag
$ cpln gvc query --match any --prop name="demo-org" --tag demo-gvc="true" --org demo-cpln-organization
+---------------+-----------------------------------------+----------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|----------|--------------|----------|-----------------|--------------|
|demo-gvc-query |Demo GVC |0 minutes |cdbmjkdk7wdv6 | |aws-eu-central-1 |demo-gvc=true |
+---------------+-----------------------------------------+----------+--------------+----------+-----------------+--------------+

gvc remove-location

Remove one or more locations from the referenced global virtual cloud

Usage

copy
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]
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"]
--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]
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
NOTE

The gvc, named 'demo-gvc-remove', 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-remove --location azure-eastus2 --org demo-cpln-organization
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|----------|--------------|----------|-----------------|-----|
|demo-gvc-remove |demo-gvc-remove |0 minutes |qdebbqejnvmxy | |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-remove --location aws-us-west-2 --location aws-eu-central-1 --org demo-cpln-organization
+----------------+-----------------------------------------+----------+--------------+----------+-------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|----------|--------------|----------|-------------|-----|
|demo-gvc-remove |demo-gvc-remove |0 minutes |qdebbqejnvmxy | |gcp-us-east1 | |
+----------------+-----------------------------------------+----------+--------------+----------+-------------+-----+

gvc tag

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

Usage

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

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)
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"]
--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]
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 --tag name="Demo Organization GVC" --org demo-cpln-organization
+-------------+-----------------------------------------+----------+--------------+----------+-----------------+-----------------------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|-------------|-----------------------------------------|----------|--------------|----------|-----------------|-----------------------------|
|demo-gvc-tag |demo-gvc-tag |0 minutes |r0b4dhanqk6pg | |aws-eu-central-1 |name="Demo Organization GVC" |
+-------------+-----------------------------------------+----------+--------------+----------+-----------------+-----------------------------+
  • Update same tag (after running the example above)
$ cpln gvc tag demo-gvc-tag --tag name="Replaced Tag" --org demo-cpln-organization
+-------------+-----------------------------------------+----------+--------------+----------+-----------------+--------------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|-------------|-----------------------------------------|----------|--------------|----------|-----------------|--------------------|
|demo-gvc-tag |demo-gvc-tag |0 minutes |r0b4dhanqk6pg | |aws-eu-central-1 |name="Replaced Tag" |
+-------------+-----------------------------------------+----------+--------------+----------+-----------------+--------------------+
  • Remove tag (after running the example above)
$ cpln gvc tag demo-gvc-tag --tag name= --org demo-cpln-organization
+-------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|-------------|-----------------------------------------|----------|--------------|----------|-----------------|-----|
|demo-gvc-tag |demo-gvc-tag |0 minutes |r0b4dhanqk6pg | |aws-eu-central-1 | |
+-------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
  • Add same tag to multiple gvcs
$ cpln gvc tag demo-gvc-tag demo-gvc-02-tag --tag multiple-orgs=true --org demo-cpln-organization
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-------------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|----------|--------------|----------|-----------------|-------------------|
|demo-gvc-tag |demo-gvc-tag |0 minutes |r0b4dhanqk6pg | |aws-eu-central-1 |multiple-orgs=true |
|demo-gvc-02-tag |demo-gvc-02-tag |0 minutes |wnnwps9r1x760 | |aws-eu-central-1 |multiple-orgs=true |
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-------------------+
  • Update same tag on multiple gvcs (after running the example above)
$ cpln gvc tag demo-gvc-tag demo-gvc-02-tag --tag multiple-orgs=demo-org --org demo-cpln-organization
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-------------------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|----------|--------------|----------|-----------------|-------------------------|
|demo-gvc-tag |demo-gvc-tag |0 minutes |r0b4dhanqk6pg | |aws-eu-central-1 |multiple-orgs="demo-org" |
|demo-gvc-02-tag |demo-gvc-02-tag |0 minutes |wnnwps9r1x760 | |aws-eu-central-1 |multiple-orgs="demo-org" |
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-------------------------+
  • Remove same tag from multiple gvcs (after running the example above)
$ cpln gvc tag demo-gvc-tag demo-gvc-02-tag --tag multiple-orgs= --org demo-cpln-organization
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|----------|--------------|----------|-----------------|-----|
|demo-gvc-tag |demo-gvc-tag |0 minutes |r0b4dhanqk6pg | |aws-eu-central-1 | |
|demo-gvc-02-tag |demo-gvc-02-tag |0 minutes |wnnwps9r1x760 | |aws-eu-central-1 | |
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+

gvc update

Update properties of the referenced global virtual cloud

Usage

copy
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.domain string
spec.staticPlacement.locationLinks string[]
Arrays can be appended to, replaced, or removed using the `+=`, `=`, or `-=` operators, respectively. [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"]
--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]
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 |0 minutes |whcr5cgsdmgb0 | |aws-eu-central-1 | |
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
  • Update a gvc's description
$ cpln gvc update demo-gvc-update --set description="GVC With Updated Description" --org demo-cpln-organization
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|----------|--------------|----------|-----------------|-----|
|demo-gvc-update |GVC With Updated Description |0 minutes |whcr5cgsdmgb0 | |aws-eu-central-1 | |
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----+
  • Update a gvc's tags
$ cpln gvc update demo-gvc-update --set tags.org-name="Demo Organization" --org demo-cpln-organization
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----------------------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|----------|--------------|----------|-----------------|-----------------------------|
|demo-gvc-update |GVC With Updated Description |0 minutes |whcr5cgsdmgb0 | |aws-eu-central-1 |org-name="Demo Organization" |
+----------------+-----------------------------------------+----------+--------------+----------+-----------------+-----------------------------+
  • Update a gvc's domain
$ cpln gvc update demo-gvc-update --set spec.domain=demo.globalvirtualcloud.com --org demo-cpln-organization
If the update was successful, the referenced domain will be associated with the referenced gvc.

identity

Manage identities within a global virtual cloud

For a detailed overview, please visit the identity's reference page.

copy
cpln identity [SUBCOMMAND]

Commands: cpln identity access-report <ref> Show the access report for the referenced identity cpln identity create Create a new identity cpln identity delete <ref...> Delete one or more referenced identities cpln identity edit <ref> Edit the referenced identity, as YAML, within an editor cpln identity eventlog <ref> Show the event log of the referenced identity [aliases: log] cpln identity get [ref...] Retrieve one or more referenced identities cpln identity patch <ref> Update the referenced identity's metadata using an input file cpln identity permissions Show the grantable permissions for an identity object type cpln identity query Find all the identities based on the given query cpln identity tag <ref...> Manage the tags belonging to one or more referenced identities cpln identity update <ref> Update properties of the referenced identity

Options: --help Show help [boolean]


identity Subcommands


identity access-report

Show the access report for the referenced identity

Usage

copy
cpln identity 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
--gvc Override the global virtual cloud. The default global virtual cloud 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"]
--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]
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 identity access-report demo-identity --org demo-cpln-organization --gvc demo-cpln-gvc-identity
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|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 |
|use |/org/demo-cpln-organization/group/superusers |manage |
|use |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/superusers |manage |
|view |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/viewers |view |
+-----------+--------------------------------------------------------+--------+

identity create

Create a new identity

Usage

copy
cpln identity create --name IDENTITY_NAME [OPTIONS]
Reference
Command options:
--name Name of the new identity [required]
--description, --desc Optional description, defaults to the name if not set
--tag Attach tags (e.g., --tag drink=water)
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
--gvc Override the global virtual cloud. The default global virtual cloud 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"]
--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]
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 identity create --name demo-identity --desc "Sample Identity" --org demo-cpln-organization --gvc demo-cpln-gvc-identity
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|-----|
|demo-identity |Sample Identity |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | | |
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+

identity delete

Delete one or more referenced identities

Usage

copy
cpln identity delete <ref...> [OPTIONS]
Reference
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [required] [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
--gvc Override the global virtual cloud. The default global virtual cloud 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"]
--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]
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 identity delete demo-identity --org demo-cpln-organization --gvc demo-cpln-gvc
If the delete was successful, a new command prompt will be shown.

identity edit

Edit the referenced identity, as YAML, within an editor

Usage

copy
cpln identity edit <ref> [OPTIONS]
NOTE

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]
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
--gvc Override the global virtual cloud. The default global virtual cloud 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"]
--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]
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 identity edit demo-identity --org demo-cpln-organization --gvc demo-cpln-gvc
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

identity eventlog

Show the event log of the referenced identity

Usage

copy
cpln identity 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
--gvc Override the global virtual cloud. The default global virtual cloud 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"]
--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]
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 identity eventlog demo-identity --org demo-cpln-organization --gvc demo-cpln-gvc
The event log for the referenced identity will be shown.

identity get

Retrieve one or more referenced identities

Usage

copy
cpln identity get [ref...] [OPTIONS]
NOTE

An empty reference will return all identities

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
--gvc Override the global virtual cloud. The default global virtual cloud 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"]
--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]
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]
Command options:
--all-gvcs Show identities from all gvcs in the org [boolean]
Options:
--help Show help [boolean]

Common Options Reference

Example
  • Get all identities
$ cpln identity get --org demo-cpln-organization --gvc demo-cpln-gvc-identity
+----------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+------------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|----------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|------------------|
|demo-identity |Sample Identity |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | | |
|demo-identity-2 |demo-identity-2 |demo-cpln-gvc-identity |cpln-demo-cpln-organi-c48n0126 |0 minutes | |identity_number=2 |
+----------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+------------------+
  • Get one identity
$ cpln identity get demo-identity --org demo-cpln-organization --gvc demo-cpln-gvc-identity
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|-----|
|demo-identity |Sample Identity |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | | |
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
  • Get multiple identities
$ cpln identity get demo-identity demo-identity-2 --org demo-cpln-organization --gvc demo-cpln-gvc-identity
+----------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+------------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|----------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|------------------|
|demo-identity |Sample Identity |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | | |
|demo-identity-2 |demo-identity-2 |demo-cpln-gvc-identity |cpln-demo-cpln-organi-c48n0126 |0 minutes | |identity_number=2 |
+----------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+------------------+

identity patch

Update the referenced identity's metadata using an input file

Usage

copy
cpln identity patch <ref> --file FILE_NAME [OPTIONS]
NOTE

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]
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
--gvc Override the global virtual cloud. The default global virtual cloud 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"]
--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]
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 identity patch demo-identity --file identity-update.json --org demo-cpln-organization --gvc demo-cpln-gvc
The changes within the JSON file will be performed against the referenced identity.

identity permissions

Show the grantable permissions for an identity object type

Usage

copy
cpln identity 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
--gvc Override the global virtual cloud. The default global virtual cloud 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"]
--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]
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 identity permissions --org demo-cpln-organization
+-------+-----------------------------------------+----------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|----------------------------------------|
|create |Create new identities | |
|delete |Delete existing identities | |
|edit |Modify existing identities |view |
|manage |Full access |create, delete, edit, manage, use, view |
|use |Refer to this identity from other ent... |view |
|view |Read-only access | |
+-------+-----------------------------------------+----------------------------------------+

identity query

Find all the identities based on the given query

Usage

copy
cpln identity 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 Tag 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
--gvc Override the global virtual cloud. The default global virtual cloud 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"]
--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]
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
NOTE

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

  • Search for an identity based on the name property
$ cpln identity query --match any --prop name=demo-identity --org demo-cpln-organization
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|-----|
|demo-identity |Sample Identity |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | | |
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
  • Search for identities based on the description property
$ cpln identity query --match any --prop description="Sample Identity" --org demo-cpln-organization
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|-----|
|demo-identity |Sample Identity |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | | |
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
  • Search for identities based on a tag
$ cpln identity query --match any --tag identity_number=2 --org demo-cpln-organization
+----------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+------------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|----------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|------------------|
|demo-identity-2 |demo-identity-2 |demo-cpln-gvc-identity |cpln-demo-cpln-organi-c48n0126 |0 minutes | |identity_number=2 |
+----------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+------------------+
  • Search for identities based on a property and tag
$ cpln identity query --match any --prop description="Sample Identity" --tag identity_number=2 --org demo-cpln-organization
+----------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+------------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|----------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|------------------|
|demo-identity |Sample Identity |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | | |
|demo-identity-2 |demo-identity-2 |demo-cpln-gvc-identity |cpln-demo-cpln-organi-c48n0126 |0 minutes | |identity_number=2 |
+----------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+------------------+

identity tag

Manage the tags belonging to one or more referenced identities

Usage

copy
cpln identity tag <ref...> --tag KEY=VALUE [OPTIONS]
NOTE

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)
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
--gvc Override the global virtual cloud. The default global virtual cloud 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"]
--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]
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 identity
$ cpln identity tag demo-identity --tag name="Demo Agent" --org demo-cpln-organization --gvc demo-cpln-gvc-identity
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+------------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|------------------|
|demo-identity |Sample Identity |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | |name="Demo Agent" |
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+------------------+
  • Update same tag (after running the example above)
$ cpln identity tag demo-identity --tag name="Replaced Tag" --org demo-cpln-organization --gvc demo-cpln-gvc-identity
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+--------------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|--------------------|
|demo-identity |Sample Identity |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | |name="Replaced Tag" |
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+--------------------+
  • Remove tag (after running the example above)
$ cpln identity tag demo-identity --tag name= --org demo-cpln-organization --gvc demo-cpln-gvc-identity
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|-----|
|demo-identity |Sample Identity |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | | |
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+

identity update

Update properties of the referenced identity

Usage

copy
cpln identity 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 [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
--gvc Override the global virtual cloud. The default global virtual cloud 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"]
--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]
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 identity properties:
    • description
      • Description of the identity
      • Type: string
    • tags
      • Tags (key=value) associated with the identity
      • Type: string
Example
  • For the examples below, the initial identity is configured as:
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|-----|
|demo-identity |Sample Identity |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | | |
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
  • Update an identity's description
$ cpln identity update demo-identity --set description="Identity With An Updated Description" --org demo-cpln-organization --gvc demo-cpln-gvc-identity
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|-----|
|demo-identity |Identity With An Updated Description |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | | |
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+-----+
  • Update an identity's tag
$ cpln identity update demo-identity --set tags.identity_number=1 --org demo-cpln-organization --gvc demo-cpln-gvc-identity
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+--------------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|-----------------------|-------------------------------|----------|----------|--------------------|
|demo-identity |Identity With An Updated Description |demo-cpln-gvc-identity |cpln-demo-cpln-organi-05sns6n6 |0 minutes | |identity_number="1" |
+--------------+-----------------------------------------+-----------------------+-------------------------------+----------+----------+--------------------+

image

Manage images and configure Docker login

For a detailed overview, please visit the image's reference page.

copy
cpln image [SUBCOMMAND]

Commands: cpln image access-report <ref> Show the access report for the referenced image cpln image build Build and containerize an application into an image cpln image delete <ref...> Delete one or more referenced images cpln image docker-login Perform a Docker login to the organization's private registry cpln image edit <ref> Edit the referenced image, as YAML, within an editor cpln image get [ref...] Retrieve one or more referenced images cpln image patch <ref> Update the referenced image's metadata using an input file cpln image permissions Show the grantable permissions for an image object type cpln image query Find all the images based on the given query cpln image tag <ref...> Manage the tags belonging to one or more referenced images

Options: --help Show help [boolean]


image Subcommands


image access-report

Show the access report for the referenced image

Usage

copy
cpln image 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"]
--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]
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 image access-report demo-image:1 --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|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 |
|pull |/org/demo-cpln-organization/group/superusers |manage |
|pull |/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 |
+-----------+--------------------------------------------------------+--------+

image build

Build and containerize an application into an image

Usage

copy
cpln image build --name IMAGE_NAME:TAG [OPTIONS]
WARNING

To push an image using this command, the Registry Credential Helper must be installed if the CLI was not installed using npm.

INFO

The option --builder accepts any trusted buildpacks builder.

The default buildpack is heroku/buildpacks:18.

Docker is required to be installed.
Reference
Command options:
--name, -n Name and tag for the image [required]
--dockerfile Path to Dockerfile (e.g.: PATH/Dockerfile). If set, the builder option is not used
--builder Buildpack package to use [default: "heroku/buildpacks:18"]
--dir Directory containing the application [default: "."]
--push Push the new image to the org's private registry [boolean] [default: false]
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"]
--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]
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 image build --name demo-image:1 --push --org demo-cpln-organization
If the build was successful, the newly generated container image will be pushed to the referenced org's private registry.

image delete

Delete one or more referenced images

Usage

copy
cpln image delete <ref...> [OPTIONS]
Reference
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [required] [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"]
--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]
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 image delete demo-image --org demo-cpln-organization
If the delete was successful, a new command prompt will be shown.

image docker-login

Perform a Docker login to the organization's private registry

Usage

copy
cpln image docker-login [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"]
--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]
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 image docker-login --org demo-cpln-organization
If the login was successful, the local Docker instance will have the abiltity to login to the referenced organization's private registry.

image edit

Edit the referenced image, as YAML, within an editor

Usage

copy
cpln image edit <ref> [OPTIONS]
NOTE

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]
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"]
--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]
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 image edit demo-image:1 --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

image get

Retrieve one or more referenced images

Usage

copy
cpln image get [ref...] [OPTIONS]
NOTE

An empty reference will return all images

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"]
--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]
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 images
$ cpln image get --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+---------+-----+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|---------|-----|
|demo-image:1 |demo-cpln-organization.registry.cpln.io/demo-image:1 |sha256:50ed56... |8 months | |
|demo-image:2 |demo-cpln-organization.registry.cpln.io/demo-image:2 |sha256:3fe719... |8 months | |
+-------------+----------------------------------------------------------+-----------------+---------+-----+
  • Get one image
$ cpln image get demo-image:1 --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+---------+-----+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|---------|-----|
|demo-image:1 |demo-cpln-organization.registry.cpln.io/demo-image:1 |sha256:50ed56... |8 months | |
+-------------+----------------------------------------------------------+-----------------+---------+-----+
  • Get multiple images
$ cpln image get demo-image:1 demo-image:2 --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+---------+-----+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|---------|-----|
|demo-image:1 |demo-cpln-organization.registry.cpln.io/demo-image:1 |sha256:50ed56... |8 months | |
|demo-image:2 |demo-cpln-organization.registry.cpln.io/demo-image:2 |sha256:3fe719... |8 months | |
+-------------+----------------------------------------------------------+-----------------+---------+-----+

image patch

Update the referenced image's metadata using an input file

Usage

copy
cpln image patch <ref> --file FILE_NAME [OPTIONS]
NOTE

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]
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"]
--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]
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 image patch demo-image:1 --file image-update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced image.

image permissions

Show the grantable permissions for an image object type

Usage

copy
cpln image 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"]
--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]
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 image permissions --org demo-cpln-organization
+-------+-----------------------------------------+-----------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|-----------------------------------------|
|create |Create new image. You can push if you... |pull |
|delete |Delete | |
|edit |Modify existing image (only tags can ... |view |
|manage |Full access |create, delete, edit, manage, pull, view |
|pull |Image can be pulled |view |
|view |Read-only access | |
+-------+-----------------------------------------+-----------------------------------------+

image query

Find all the images based on the given query

Usage

copy
cpln image 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 Tag 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"]
--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]
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
NOTE

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

  • Search for an image based on the name property
$ cpln image query --match any --prop name=demo-image:1 --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+---------+-----+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|---------|-----|
|demo-image:1 |demo-cpln-organization.registry.cpln.io/demo-image:1 |sha256:50ed56... |8 months | |
+-------------+----------------------------------------------------------+-----------------+---------+-----+
  • Search for an image based on the image tag property
$ cpln image query --match any --prop tag=2 --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+---------+-----+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|---------|-----|
|demo-image:2 |demo-cpln-organization.registry.cpln.io/demo-image:2 |sha256:3fe719... |8 months | |
+-------------+----------------------------------------------------------+-----------------+---------+-----+
  • Search for a image based on a tag
$ cpln image query --match any --tag description="Demo Image #1" --org demo-cpln-organization
+-----+-----+-------+--------+-----+
|NAME |PULL |DIGEST |CREATED |TAGS |
+-----+-----+-------+--------+-----+
  • Search for a image based on a property and tag
$ cpln image query --match any --prop name=demo-image:1 --tag description="Demo Image #1" --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+---------+-----+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|---------|-----|
|demo-image:1 |demo-cpln-organization.registry.cpln.io/demo-image:1 |sha256:50ed56... |8 months | |
+-------------+----------------------------------------------------------+-----------------+---------+-----+

image tag

Manage the tags belonging to one or more referenced images

Usage

copy
cpln image tag <ref...> --tag KEY=VALUE [OPTIONS]
NOTE

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)
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"]
--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]
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 image
$ cpln image tag demo-image:1 --tag example="Demo Image" --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+---------+---------------------+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|---------|---------------------|
|demo-image:1 |demo-cpln-organization.registry.cpln.io/demo-image:1 |sha256:50ed56... |8 months |example="Demo Image" |
+-------------+----------------------------------------------------------+-----------------+---------+---------------------+
  • Update same tag (after running the example above)
$ cpln image tag demo-image:1 --tag example="Replaced Tag" --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+---------+-----------------------+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|---------|-----------------------|
|demo-image:1 |demo-cpln-organization.registry.cpln.io/demo-image:1 |sha256:50ed56... |8 months |example="Replaced Tag" |
+-------------+----------------------------------------------------------+-----------------+---------+-----------------------+
  • Remove tag (after running the example above)
$ cpln image tag demo-image:1 --tag example= --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+---------+-----+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|---------|-----|
|demo-image:1 |demo-cpln-organization.registry.cpln.io/demo-image:1 |sha256:50ed56... |8 months | |
+-------------+----------------------------------------------------------+-----------------+---------+-----+

location

Manage locations

For a detailed overview, please visit the location's reference page.

copy
cpln location [SUBCOMMAND]

Commands: cpln location access-report <ref> Show the access report for the referenced location cpln location edit <ref> Edit the referenced location, as YAML, within an editor cpln location get [ref...] Retrieve one or more referenced locations cpln location patch <ref> Update the referenced locations's metadata using an input file cpln location permissions Show the grantable permissions for a location object type cpln location query Find all the locations based on the given query cpln location tag <ref...> Manage the tags belonging to one or more referenced locations

Options: --help Show help [boolean]


location Subcommands


location access-report

Show the access report for the referenced location

Usage

copy
cpln location 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"]
--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]
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 location access-report gcp-us-east1 --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|create |/org/demo-cpln-organization/group/superusers |manage |
|create |/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 |
|use |/org/demo-cpln-organization/group/superusers |manage |
|use |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/superusers |manage |
|view |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/viewers |view |
+-----------+--------------------------------------------------------+--------+

location edit

Edit the referenced location, as YAML, within an editor

Usage

copy
cpln location edit <ref> [OPTIONS]
NOTE

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]
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"]
--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]
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
NOTE

Only the enabled (boolean) property can be edited.

$ cpln location edit gcp-us-east1 --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

location get

Retrieve one or more referenced locations

Usage

copy
cpln location get [ref...] [OPTIONS]
NOTE

An empty reference will return all locations

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"]
--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]
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 locations
$ cpln location get --org demo-cpln-organization
+-----------------+-----------------------------------------+---------+--------+-------------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|-----------------------------------------|---------|--------|-------------|--------|-------------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
|aws-us-west-2 |AWS, US West (Oregon) |aws |true |us-west-2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="OR" |
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
|gcp-us-east1 |GCP, Moncks Corner, South Carolina, USA |gcp |true |us-east1 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="SC" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+-------------------------------+
  • Get one location
$ cpln location get gcp-us-east1 --org demo-cpln-organization
+-------------+-----------------------------------------+---------+--------+---------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-------------|-----------------------------------------|---------|--------|---------|--------|-------------------------------|
|gcp-us-east1 |GCP, Moncks Corner, South Carolina, USA |gcp |true |us-east1 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="SC" |
+-------------+-----------------------------------------+---------+--------+---------+--------+-------------------------------+
  • Get multiple locations
$ cpln location get gcp-us-east1 aws-us-west-2 --org demo-cpln-organization
+--------------+-----------------------------------------+---------+--------+----------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|--------------|-----------------------------------------|---------|--------|----------|--------|-------------------------------|
|gcp-us-east1 |GCP, Moncks Corner, South Carolina, USA |gcp |true |us-east1 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="SC" |
|aws-us-west-2 |AWS, US West (Oregon) |aws |true |us-west-2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="OR" |
+--------------+-----------------------------------------+---------+--------+----------+--------+-------------------------------+

location patch

Update the referenced locations's metadata using an input file

Usage

copy
cpln location patch <ref> --file FILE_NAME [OPTIONS]
NOTE

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]
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"]
--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]
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 location patch gcp-us-east1 --file location-update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced location.

location permissions

Show the grantable permissions for a location object type

Usage

copy
cpln location 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"]
--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]
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 location permissions --org demo-cpln-organization
+-------+-----------------------------------------+--------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|--------------------------------|
|create |Create new locations | |
|edit |Modify existing locations |view |
|manage |Full access |create, edit, manage, use, view |
|use |Use this location for workload placement |view |
|view |Read-only access | |
+-------+-----------------------------------------+--------------------------------+

location query

Find all the locations based on the given query

Usage

copy
cpln location 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 Tag 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"]
--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]
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
NOTE

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

  • Search for a location based on a name
$ cpln location query --match any --prop name="aws-us-west-2" --org demo-cpln-organization
+--------------+-----------------------------------------+---------+--------+----------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|--------------|-----------------------------------------|---------|--------|----------|--------|-------------------------------|
|aws-us-west-2 |AWS, US West (Oregon) |aws |true |us-west-2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="OR" |
+--------------+-----------------------------------------+---------+--------+----------+--------+-------------------------------+
  • Search for a location based on a description
$ cpln location query --match any --prop description="Azure, East US 2" --org demo-cpln-organization
+--------------+-----------------------------------------+---------+--------+--------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|--------------|-----------------------------------------|---------|--------|--------|--------|-------------------------------|
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
+--------------+-----------------------------------------+---------+--------+--------+--------+-------------------------------+
  • Search for a location based on a tag
$ cpln location query --match any --tag cpln/city="Frankfurt" --org demo-cpln-organization
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|-----------------------------------------|---------|--------|-------------|--------|------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------+
  • Search for a location based on a property and tag
$ cpln location query --match any --prop name="gcp-us-east1" --tag cpln/state="SC" --org demo-cpln-organization
+-------------+-----------------------------------------+---------+--------+---------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-------------|-----------------------------------------|---------|--------|---------|--------|-------------------------------|
|gcp-us-east1 |GCP, Moncks Corner, South Carolina, USA |gcp |true |us-east1 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="SC" |
+-------------+-----------------------------------------+---------+--------+---------+--------+-------------------------------+

location tag

Manage the tags belonging to one or more referenced locations

Usage

copy
cpln location tag <ref...> --tag KEY=VALUE [OPTIONS]
NOTE

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)
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"]
--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]
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 location
$ cpln location tag aws-eu-central-1 --tag name="Demo Location" --org demo-cpln-organization
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|-----------------------------------------|---------|--------|-------------|--------|------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
| | | | | | |name="Demo Location" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------+
  • Update same tag (after running the example above)
$ cpln location tag aws-eu-central-1 --tag name="Replaced Tag" --org demo-cpln-organization
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|-----------------------------------------|---------|--------|-------------|--------|------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
| | | | | | |name="Replaced Tag" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------+
  • Remove tag (after running the example above)
$ cpln location tag aws-eu-central-1 --tag name= --org demo-cpln-organization
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|-----------------------------------------|---------|--------|-------------|--------|------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------+
  • Add same tag to multiple locations
$ cpln location tag aws-eu-central-1 azure-eastus2 --tag multiple-locations=true --org demo-cpln-organization
+-----------------+-----------------------------------------+---------+--------+-------------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|-----------------------------------------|---------|--------|-------------|--------|-------------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
| | | | | | |multiple-locations=true |
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
| | | | | | |multiple-locations=true |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+-------------------------------+
  • Update same tag on multiple locations (after running the example above)
$ cpln location tag aws-eu-central-1 azure-eastus2 --tag multiple-locations=demo-group --org demo-cpln-organization
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|-----------------------------------------|---------|--------|-------------|--------|------------------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
| | | | | | |multiple-locations="demo-locations" |
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
| | | | | | |multiple-locations="demo-locations" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------------------+
  • Remove same tag from multiple locations (after running the example above)
$ cpln location tag aws-eu-central-1 azure-eastus2g --tag multiple-locations= --org demo-cpln-organization
+-----------------+-----------------------------------------+---------+--------+-------------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|-----------------------------------------|---------|--------|-------------|--------|-------------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+-------------------------------+

login

Create a profile named "default" and launch a browser to begin the interactive login process

Usage

copy
cpln login [OPTIONS]
Reference

Options: --help Show help [boolean] --version Show version number [boolean]

Common Options Reference

Example
$ cpln login
Your browser will be launched and redirected to the login page. After a successful login, a local profile
named "default" will be created and the browser window can be closed. Use "Control-C" at the command prompt to
exit the login command if an issues occurs.

logs

Show logs

For a detailed overview, please visit the log's reference page.

Usage

copy
cpln logs <query> [OPTIONS]
TIP

The <query> positional requires a valid LogQL string enclosed within single quotes.

Available query labels: gvc, workload, container, location, provider, replica, stream

Reference

Command options: --tail, -t Tail the logs [boolean] --limit Limit on number of entries to show [default: "30"] --delay-for Delay in tailing by number of seconds to accumulate logs for re-ordering [number][default: &quot;0&quot;] --since Lookback window [default: "1h"] --from Start looking for logs at this absolute time (inclusive) --to Stop looking for logs at this absolute time (exclusive) --output, -o Specify output mode. raw suppresses log labels and timestamp [choices: "default", "raw", "jsonl"][default: &quot;default&quot;] --direction Sort order of logs [choices: "forward", "backward"][default: &quot;forward&quot;]

Positionals: query LogQL query [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

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] --version Show version number [boolean]

Common Options Reference

Example
$ cpln logs '{gvc="demo-gvc-logs",workload="demo-workload-logs"}'
2021-02-23T18:45:03.411Z {workload="demo-workload-logs", container="main", gvc="demo-gvc-logs", location="aws-eu-central-1", provider="aws", replica="712438d4-aee8-44aa-b7a9-c9ed62b6ea69", stream="stderr"} 2021/02/23 18:45:03 Hello world sample started.
2021-02-23T18:45:06.177Z {workload="demo-workload-logs", container="main", gvc="demo-gvc-logs", location="aws-eu-central-1", provider="aws", replica="712438d4-aee8-44aa-b7a9-c9ed62b6ea69", stream="stderr"} 2021/02/23 18:45:06 Hello world received a request.
$ cpln logs '{provider="aws"}'
2021-02-23T18:45:03.411Z {container="main", gvc="demo-gvc-logs", location="aws-eu-central-1", provider="aws", replica="712438d4-aee8-44aa-b7a9-c9ed62b6ea69", stream="stderr", workload="demo-workload-logs"} 2021/02/23 18:45:03 Hello world sample started.
2021-02-23T18:45:06.177Z {container="main", gvc="demo-gvc-logs", location="aws-eu-central-1", provider="aws", replica="712438d4-aee8-44aa-b7a9-c9ed62b6ea69", stream="stderr", workload="demo-workload-logs"} 2021/02/23 18:45:06 Hello world received a request.

misc

Miscellaneous helper commands

copy
cpln misc [SUBCOMMAND]

Commands: cpln misc install-completion Install shell completion to your local profile cpln misc uninstall-completion Uninstall shell completion from your local profile

Options: --help Show help [boolean] --version Show version number [boolean]


misc Subcommands


misc install-completion

Install shell completion to your local profile

Usage

copy
cpln misc install-completion [OPTIONS]
Reference
Command options:
--batch Non-interactive (batch) mode [boolean]
Options:
--help Show help [boolean]
--version Show version number [boolean]

Common Options Reference

Example
$ cpln misc install-completion
Running the command will prompt the user with a few questions. Once compelete, the completion functionality
will be installed. The shell will need to be restarted.

misc uninstall-completion

Uninstall shell completion from your local profile

Usage

copy
cpln misc uninstall-completion [OPTIONS]
Reference
Options:
--help Show help [boolean]
--version Show version number [boolean]

Common Options Reference

Example
$ cpln misc uninstall-completion
The completion functionality will be removed.

org

Manage organizations

For a detailed overview, please visit the org's reference page.

copy
cpln org [SUBCOMMAND]

Commands: cpln org access-report <ref> Show the access report for the referenced organization cpln org create Create a new organization cpln org edit <ref> Edit the referenced organization, as YAML, within an editor cpln org eventlog <ref> Show the event log of the referenced organization [aliases: log] cpln org get [ref...] Retrieve one or more referenced organizations cpln org patch <ref> Update the referenced organization's metadata using an input file cpln org permissions Show the grantable permissions for an organization object type cpln org query Find all the organizations based on the given query cpln org tag <ref...> Manage the tags belonging to one or more referenced organizations cpln org update <ref> Update properties of the referenced organization

Options: --help Show help [boolean]


org Subcommands


org access-report

Show the access report for the referenced organization

Usage

copy
cpln org 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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml"]
--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]
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 org access-report demo-cpln-organization
+-----------------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------------|--------------------------------------------------------|--------|
|edit |/org/demo-cpln-organization/group/superusers |manage |
|edit |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|grafanaAdmin |/org/demo-cpln-organization/group/superusers |manage |
|grafanaAdmin |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|manage |/org/demo-cpln-organization/group/superusers |manage |
|manage |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|readLogs |/org/demo-cpln-organization/group/superusers |manage |
|readLogs |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|readMetrics |/org/demo-cpln-organization/group/superusers |manage |
|readMetrics |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|readUsage |/org/demo-cpln-organization/group/superusers |manage |
|readUsage |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/superusers |manage |
|view |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/-allmembers |view |
|viewAccessReport |/org/demo-cpln-organization/group/superusers |manage |
|viewAccessReport |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
+-----------------+--------------------------------------------------------+--------+

org create

Create a new organization

Usage

copy
cpln org create --name ORG_NAME [OPTIONS]
Reference
Command options:
--name Name of the new organization [required]
--description, --desc Optional description, defaults to the name if not set
--tag Attach tags (e.g., --tag drink=water)
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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml"]
--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]
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
$ cpln org create --name demo-cpln-organization
If successful, the new organization will be created.

org edit

Edit the referenced organization, as YAML, within an editor

Usage

copy
cpln org edit <ref> [OPTIONS]
NOTE

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]
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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml"]
--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]
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 org edit demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

org eventlog

Show the event log of the referenced organization

Usage

copy
cpln org 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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml"]
--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]
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 org eventlog demo-cpln-organization
The event log for the referenced organization will be shown.

org get

Retrieve one or more referenced organizations

Usage

copy
cpln org get [ref...] [OPTIONS]
NOTE

An empty reference will return all organizations

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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml"]
--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]
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 organizations
$ cpln org get
+-----------------------+-----------------------------------------+----------------------------+------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+------------+
  • Get one organization
$ cpln org get demo-cpln-organization
+-----------------------+-----------------------------------------+----------------------------+------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+------------+

org patch

Update the referenced organization's metadata using an input file

Usage

copy
cpln org patch <ref> --file FILE_NAME [OPTIONS]
NOTE

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]
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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml"]
--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]
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 org patch demo-cpln-organization --file org-update.json
The changes within the JSON file will be performed against the referenced organization.

org permissions

Show the grantable permissions for an organization object type

Usage

copy
cpln org 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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml"]
--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]
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 org permissions
+-----------------+-----------------------------------------+-------------------------------------------------------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-----------------|-----------------------------------------|-------------------------------------------------------------------------------------|
|edit |Modify org |view |
|grafanaAdmin |Grantees are made Admin in Grafana, o... | |
|manage |Full access |edit, grafanaAdmin, manage, readLogs, readMetrics, readUsage, view, viewAccessReport |
|readLogs |Grantees can read logs from all workl... |view |
|readMetrics |Grantees can access usage and perform... | |
|readUsage |Grantees can access usage and billing... | |
|view |Read-only view: every org member can ... | |
|viewAccessReport |Grantees can inspect the granted acce... | |
+-----------------+-----------------------------------------+-------------------------------------------------------------------------------------+

org query

Find all the organizations based on the given query

Usage

copy
cpln org 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 Tag 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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml"]
--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]
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
NOTE

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

  • Search for an organization based on the name property
$ cpln org query --match any --prop name=demo-cpln-organization
+-----------------------+-----------------------------------------+----------------------------+------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+------------+
  • Search for an organization based on the description property
$ cpln org query --match any --prop description="Demo Organization"
+-----------------------+-----------------------------------------+----------------------------+------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+------------+
  • Search for a organization based on a tag
$ cpln org query --match any --tag type=demo
+-----------------------+-----------------------------------------+----------------------------+------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+------------+
  • Search for a organization based on a property and tag
$ cpln org query --match any --prop description="Demo Organization" --tag type=demo
+-----------------------+-----------------------------------------+----------------------------+------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+------------+

org tag

Manage the tags belonging to one or more referenced organizations

Usage

copy
cpln org tag <ref...> --tag KEY=VALUE [OPTIONS]
NOTE

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)
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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml"]
--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]
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 an organization
$ cpln org tag demo-cpln-organization --tag name="Demo Org"
+-----------------------+-----------------------------------------+----------------------------+----------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|----------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |name="Demo Org" |
| | | |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+----------------+
  • Update same tag (after running the example above)
$ cpln org tag demo-cpln-organization --tag name="Replaced Tag"
+-----------------------+-----------------------------------------+----------------------------+--------------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|--------------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |name="Replaced Tag" |
| | | |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+--------------------+
  • Remove tag (after running the example above)
$ cpln org tag demo-cpln-organization --tag name=
+-----------------------+-----------------------------------------+----------------------------+------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+------------+

org update

Update properties of the referenced organization

Usage

copy
cpln org 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 [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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml"]
--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]
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 organization properties:
    • description
      • Description of the organization
      • Type: string
    • tags
      • Tags (key=value) associated with the organization
      • Type: string
Example
  • For the examples below, the initial organization is configured as:
+-----------------------+-----------------------------------------+----------------------------+------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+------------+
  • Update an organization's description
$ cpln org update demo-cpln-organization --set description="Agent With An Updated Description"
+-----------------------+-----------------------------------------+----------------------------+------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|------------|
|demo-cpln-organization |Agent With An Updated Description |/org/demo-cpln-organization |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+------------+
  • Update an organization's tag
$ cpln org update demo-cpln-organization --set tags.type="Demo Tag Updated"
+-----------------------+-----------------------------------------+----------------------------+------------------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|------------------------|
|demo-cpln-organization |Agent With An Updated Description |/org/demo-cpln-organization |type="Demo Tag Updated" |
+-----------------------+-----------------------------------------+----------------------------+------------------------+

policy

Manage access policies

For a detailed overview, please visit the policy's reference page.

copy
cpln policy [SUBCOMMAND]

Commands: cpln policy access-report <ref> Show the access report for the referenced policy cpln policy add-binding <ref> Bind one or more permissions to the referenced policy and associate it with one or more users / service accounts / groups / identities cpln policy clone <ref> Clone a policy [aliases: copy] cpln policy create Create a new policy cpln policy delete <ref...> Delete one or more referenced policies cpln policy edit <ref> Edit the referenced policy, as YAML, within an editor cpln policy eventlog <ref> Show the event log of the referenced policy [aliases: log] cpln policy get [ref...] Retrieve one or more referenced policies cpln policy patch <ref> Update the referenced policy's metadata using an input file cpln policy permissions Show the grantable permissions for a policy object type cpln policy query Find all the policies based on the given query cpln policy remove-binding <ref> Remove the bindings of one or more permissions from the referenced policy and disassociate it from one or more users / service accounts / groups / identities cpln policy tag <ref...> Manage the tags belonging to one or more referenced policies cpln policy update <ref> Update properties of the referenced policy

Options: --help Show help [boolean]


policy Subcommands


policy access-report

Show the access report for the referenced policy

Usage

copy
cpln policy 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"]
--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]
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 policy access-report demo-policy-access-report --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|create |/org/demo-cpln-organization/group/superusers