Command Line Interface (CLI)

Installation

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

Installation - 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

Installation - Using Homebrew / Linuxbrew

Follow these instructions to install homebrew.

Execute the following command:

copy
brew tap controlplane-com/cpln && brew install cpln

If you are running Apple Silicon (M1/M2), Rosetta must be installed.

copy
softwareupdate --install-rosetta

Execute the following command to update:

copy
brew update && brew upgrade

Installation - 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.tgz85d45558d98f0ba54fd21f52cdf33171e6b546b3330213096e93d6d361dad9c0
Linuxcpln-linux.tgz4b602ccc728fc21586d1b73d6bd21375355e2f25babdf0c242577da79d3c1e22
Windows 10/11cpln-win.zip61dc21a1c7d012e631fd18b4e96cca2efc7d9d39ec065986d8836266025dd89a
TIP
  • For macOS with M1/M2, please install using npm or brew.

  • 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 10/11tar -xvf cpln-win.zip

The package contains two executables:

  • cpln: The Control Plane CLI.
  • docker-credential-cpln: An executable 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
NOTE

If you wish to enable auto-completion in the zsh shell, make sure you have the following commands at the beginning of your ~/.zshrc file:

copy
autoload -U compinit
compinit
TIP

Autocomplete workaround for users of Cygwin:

After executing the cpln misc install-completion command:

  1. Copy the cpln.bash file from C:/Users/<username>/.config/tabtab/cpln.bash to C:/cygwin64/home/<username>/.config/tabtab/cpln.bash
  2. Edit or create a new .bashrc file at C:/cygwin64/home/<username>/.bashrc
  3. Add the following line to the .bashrc file: . C:/cygwin64/home/<username>/.config/tabtab/cpln.bash

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 account Manage accounts 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 convert Convert k8s files to cpln files cpln delete Delete resources from files cpln domain Manage custom domains cpln group Manage groups cpln gvc Manage global virtual clouds cpln helm Manage helm releases on cpln 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 [ref] 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 mk8s Manage an mk8s cluster 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 stack manage docker-compose files [aliases: compose] cpln task Manage pending tasks cpln user Manage users cpln volumeset Manage a persistent volumeset within a global virtual cloud cpln workload Manage workloads within a global virtual cloud [aliases: w]

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

© 2024 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.


account

Manage accounts

copy
cpln account [SUBCOMMAND]

Commands: cpln account get [ref...] Get accounts by id or list accounts

Options: --help Show help [boolean]


account Subcommands


account get

Get accounts by id or list accounts

Usage

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

An empty reference will return all references

Reference

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

Context options: --profile Override the profile. The default profile can be set using the cpln profile set-default command or by setting the CPLN_PROFILE environment variable

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

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

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

Options: --help Show help [boolean]

Common Options Reference


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 manifest Generate a manifest for running an agent in K8S 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln agent access-report demo-agent --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln agent create --name demo-agent --desc demo-agent --tag drink=water --org demo-cpln-organization
{
"agentId": "4d9a3d65-3128-4af1-bfc3-1423b419d111",
"agentLink": "/org/demo-cpln-organization/agent/demo-agent",
"hubEndpoint": "https://hub.test.cpln.io",
"registrationToken": "a2czfP7VTiE2a9pZpiGCIX-MAQliyoFlIyAnKY8HuL3OXc-bhMrjwidg/K6XR09"
}

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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]

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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 references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all agents
$ cpln agent get --org demo-cpln-organization
+-----------------+-----------------------------------------+--------------+--------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------------|-----------------------------------------|--------------|--------------|
|demo-agent |demo-agent |1 minute ago |drink="water" |
|demo-agent-get-1 |demo-agent-get-1 |0 minutes ago | |
|demo-agent-get-2 |demo-agent-get-2 |0 minutes ago | |
+-----------------+-----------------------------------------+--------------+--------------+
  • 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 ago | |
+-----------------+-----------------------------------------+--------------+-----+
  • 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 ago | |
|demo-agent-get-2 |demo-agent-get-2 |0 minutes ago | |
+-----------------+-----------------------------------------+--------------+-----+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Return the details of a deployed agent. The example below was for an agent deployed at AWS.
$ cpln agent info demo-agent --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 manifest

Generate a manifest for running an agent in K8S

Usage

copy
cpln agent manifest --bootstrap-file FILE_NAME --namespace NAME_SPACE [OPTIONS]
Reference

Command options: --bootstrap-file Path to the bootstrap config file [required] --namespace, -n Namespace where the agent deployment(s) will live [required] --image Advanced use: Use a different agent Docker image --cluster Add metadata to agent's environment, useful to remind you which cluster an agent is running in --replicas Number of agents deployments to create [default: 1] --create-namespace Create the namespace [boolean][default: true]

Options: --help Show help [boolean]

Common Options Reference


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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln agent patch demo-agent --file update.json --org demo-cpln-organization
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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
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 --org demo-cpln-organization
+-----------+-----------------------------------------+-------------+--------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------|-----------------------------------------|-------------|--------------|
|demo-agent |demo-agent |1 minute ago |drink="water" |
+-----------+-----------------------------------------+-------------+--------------+
  • Search for an agent based on the description property
$ cpln agent query --match any --prop description="demo-agent" --org demo-cpln-organization
+-----------+-----------------------------------------+-------------+--------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------|-----------------------------------------|-------------|--------------|
|demo-agent |demo-agent |1 minute ago |drink="water" |
+-----------+-----------------------------------------+-------------+--------------+
  • Search for an agent based on a tag
$ cpln agent query --match any --tag drink=water --org demo-cpln-organization
+-----------+-----------------------------------------+-------------+--------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------|-----------------------------------------|-------------|--------------|
|demo-agent |demo-agent |1 minute ago |drink="water" |
+-----------+-----------------------------------------+-------------+--------------+
  • Search for an agent based on a property and tag
$ cpln agent query --match any --prop description="demo-agent" --tag drink=water --org demo-cpln-organization
+-----------+-----------------------------------------+-------------+--------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------|-----------------------------------------|-------------|--------------|
|demo-agent |demo-agent |1 minute ago |drink="water" |
+-----------+-----------------------------------------+-------------+--------------+

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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag
$ cpln agent tag demo-agent --tag drink=water --org demo-cpln-organization
+-----------+-----------------------------------------+-------------+--------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------|-----------------------------------------|-------------|--------------|
|demo-agent |demo-agent |1 minute ago |drink="water" |
+-----------+-----------------------------------------+-------------+--------------+
  • Update same tag (after running the example above)
$ cpln agent tag demo-agent --tag drink=coffee --org demo-cpln-organization
+-----------+-----------------------------------------+-------------+---------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------|-----------------------------------------|-------------|---------------|
|demo-agent |demo-agent |1 minute ago |drink="coffee" |
+-----------+-----------------------------------------+-------------+---------------+
  • Remove tag (after running the example above)
$ cpln agent tag demo-agent --remove drink --org demo-cpln-organization
+-----------+-----------------------------------------+-------------+-----+
|NAME |DESCRIPTION |CREATED |TAGS |
|-----------|-----------------------------------------|-------------|-----|
|demo-agent |demo-agent |1 minute ago | |
+-----------+-----------------------------------------+-------------+-----+

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 --bootstrap-file bootstrap.config --org demo-cpln-organization
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"):

copy
description string
tags.&lt;key&gt; 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • The --set option allows the modification of the following 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 ago | |
+------------------+-----------------------------------------+--------------+-----+
  • Update an agent's description
$ cpln agent update demo-agent-update --set description="new description" --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+-----+
|NAME |DESCRIPTION |CREATED |TAGS |
|------------------|-----------------------------------------|--------------|-----|
|demo-agent-update |new description |0 minutes ago | |
+------------------+-----------------------------------------+--------------+-----+
  • Update an agent's tag
$ cpln agent update demo-agent-update --set tags.demo-key=demo-value --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+----------------------+
|NAME |DESCRIPTION |CREATED |TAGS |
|------------------|-----------------------------------------|--------------|----------------------|
|demo-agent-update |new description |0 minutes ago |demo-key="demo-value" |
+------------------+-----------------------------------------+--------------+----------------------+

apply

Create or update a resource using an input file.

Refer to the cpln apply guide for additional details.

Usage

copy
cpln apply [OPTIONS]
Reference

Command options: --file, -f File to load and use for the command. Use --file - to enable input from stdin. [required] --k8s Set this true if input file is k8s config file [boolean] --ready Set this true if apply should wait for objects to be ready before exiting [boolean]

Context options: --profile Override the profile. The default profile can be set using the cpln profile set-default command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the cpln profile update command --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean] --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; this will only duplicate its spec. [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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; this will only duplicate its spec.

Usage

copy
cpln auditctx 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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]

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln auditctx edit demo-audit-context --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln auditctx eventlog demo-audit-context --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 references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all 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 the referenced audit context's metadata 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln auditctx patch demo-audit-context --file 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
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 an audit context based on the description property
$ cpln auditctx query --match any --prop description="demo-audit-context" --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|------------|
|demo-audit-context |demo-audit-context |default |type="demo" |
+-------------------+-----------------------------------------+--------+------------+
  • Search for an audit context 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 an audit context based on a property and tag
$ cpln auditctx query --match any --prop description="demo-audit-context" --tag type=demo --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|------------|
|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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag
$ cpln auditctx tag demo-audit-context --tag drink=water --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+--------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|--------------|
|demo-audit-context |demo-audit-context |default |drink="water" |
| | | |type="demo" |
+-------------------+-----------------------------------------+--------+--------------+
  • Update same tag (after running the example above)
$ cpln auditctx tag demo-audit-context --tag drink=coffee --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+---------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|---------------|
|demo-audit-context |demo-audit-context |default |drink="coffee" |
| | | |type="demo" |
+-------------------+-----------------------------------------+--------+---------------+
  • Remove tag (after running the example above)
$ cpln auditctx tag demo-audit-context --remove drink --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"):

copy
description string
tags.&lt;key&gt; 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • The --set option allows the modification of the following 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="new description" --org demo-cpln-organization
+-------------------+-----------------------------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-----------------------------------------|--------|------------|
|demo-audit-context |new 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 |new 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 create-ngs Create a NGS 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln cloudaccount access-report demo-cloud-account-aws --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]
INFO

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::&lt;account number&gt;:role/&lt;name&gt; --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln cloudaccount create-aws --name demo-cloud-account-aws --role-arn arn:aws:iam::123412341234:role/cpln-demo-cpln-organization --org demo-cpln-organization
+-----------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------|-----------------------------------------|---------|-----------------------------------------------------------|--------------|-----|
|demo-cloud-account-aws |demo-cloud-account-aws |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes ago | |
+-----------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+

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 name of the secret which will be created. --url The URL of the deployed function app. --code The URL of the deployed function app. --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln cloudaccount create-azure --name demo-cloud-account-azure --secret azure-secret --url https://function.app.url --code code --org demo-cpln-organization
+-------------------------+-----------------------------------------+---------+-----+--------------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-------------------------|-----------------------------------------|---------|-----|--------------|-----|
|demo-cloud-account-azure |demo-cloud-account-azure |azure | |0 minutes ago | |
+-------------------------+-----------------------------------------+---------+-----+--------------+-----+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln cloudaccount create-gcp --name demo-cloud-account-gcp --project-id 1234abc --org demo-cpln-organization
+-----------------------+-----------------------------------------+---------+--------+--------------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------|-----------------------------------------|---------|--------|--------------|-----|
|demo-cloud-account-gcp |demo-cloud-account-gcp |gcp |1234abc |0 minutes ago | |
+-----------------------+-----------------------------------------+---------+--------+--------------+-----+

cloudaccount create-ngs

Create a NGS cloud account

Usage

copy
cpln cloudaccount create-ngs --name ACCOUNT_NAME --secret SECRET_REFERENCE [OPTIONS]
Reference

Command options: --name Name of the new account [required] --description, --desc Optional description, defaults to the name if not set --secret The secret used to authenticate to NGS [required] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln cloudaccount delete demo-cloud-account-aws --org demo-cpln-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]

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln cloudaccount edit demo-cloud-account-aws --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln cloudaccount eventlog demo-cloud-account-aws --org demo-cpln-organization
The event log for the referenced cloud account 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 references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all cloud accounts
$ cpln cloudaccount get --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|-----------------------------------------------------------|--------------|-----|
|demo-cloud-account-aws |demo-cloud-account-aws |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |2 minutes ago | |
|demo-cloud-account-aws-get-1 |demo-cloud-account-aws-get-1 |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes ago | |
|demo-cloud-account-aws-get-2 |demo-cloud-account-aws-get-2 |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes ago | |
|demo-cloud-account-azure |demo-cloud-account-azure |azure | |2 minutes ago | |
|demo-cloud-account-gcp |demo-cloud-account-gcp |gcp |1234abc |2 minutes ago | |
+-----------------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+
  • Get one cloud account
$ cpln cloudaccount get demo-cloud-account-aws-get-1 --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|-----------------------------------------------------------|--------------|-----|
|demo-cloud-account-aws-get-1 |demo-cloud-account-aws-get-1 |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes ago | |
+-----------------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+
  • Get multiple cloud accounts
$ cpln cloudaccount get demo-cloud-account-aws-get-1 demo-cloud-account-aws-get-2 --org demo-cpln-organization
+-----------------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------------|-----------------------------------------|---------|-----------------------------------------------------------|--------------|-----|
|demo-cloud-account-aws-get-1 |demo-cloud-account-aws-get-1 |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes ago | |
|demo-cloud-account-aws-get-2 |demo-cloud-account-aws-get-2 |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |0 minutes ago | |
+-----------------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln cloudaccount patch demo-cloud-account-aws --file 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln cloudaccount 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
NOTE

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

  • Search for a cloud account based on the name property
$ cpln cloudaccount query --match any --prop name=demo-cloud-account-aws --org demo-cpln-organization
+-----------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------|-----------------------------------------|---------|-----------------------------------------------------------|--------------|-----|
|demo-cloud-account-aws |demo-cloud-account-aws |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |3 minutes ago | |
+-----------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+
  • Search for a cloud account based on the description property
$ cpln cloudaccount query --match any --prop description="demo-cloud-account-aws" --org demo-cpln-organization
+-----------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------|-----------------------------------------|---------|-----------------------------------------------------------|--------------|-----|
|demo-cloud-account-aws |demo-cloud-account-aws |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |3 minutes ago | |
+-----------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+
  • Search for a cloud account based on a tag
$ cpln cloudaccount query --match any --tag drink=water --org demo-cpln-organization
+-----+-----------------------------------------+---------+-----+--------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
+-----+-----------------------------------------+---------+-----+--------+-----+
  • Search for a cloud account based on a property and tag
$ cpln cloudaccount query --match any --prop description="demo-cloud-account-aws" --tag drink=water --org demo-cpln-organization
+-----------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-----------------------|-----------------------------------------|---------|-----------------------------------------------------------|--------------|-----|
|demo-cloud-account-aws |demo-cloud-account-aws |aws |arn:aws:iam::123412341234:role/cpln-demo-cpln-organization |3 minutes ago | |
+-----------------------+-----------------------------------------+---------+-----------------------------------------------------------+--------------+-----+

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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag to a cloud account
$ cpln cloudaccount tag demo-cloud-account-azure --tag drink=water --org demo-cpln-organization
+-------------------------+-----------------------------------------+---------+-----+--------------+--------------+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-------------------------|-----------------------------------------|---------|-----|--------------|--------------|
|demo-cloud-account-azure |demo-cloud-account-azure |azure | |3 minutes ago |drink="water" |
+-------------------------+-----------------------------------------+---------+-----+--------------+--------------+
  • Update same tag (after running the example above)
$ cpln cloudaccount tag demo-cloud-account-azure --tag drink=coffee --org demo-cpln-organization
+-------------------------+-----------------------------------------+---------+-----+--------------+---------------+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-------------------------|-----------------------------------------|---------|-----|--------------|---------------|
|demo-cloud-account-azure |demo-cloud-account-azure |azure | |3 minutes ago |drink="coffee" |
+-------------------------+-----------------------------------------+---------+-----+--------------+---------------+
  • Remove tag (after running the example above)
$ cpln cloudaccount tag demo-cloud-account-azure --remove drink --org demo-cpln-organization
+-------------------------+-----------------------------------------+---------+-----+--------------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-------------------------|-----------------------------------------|---------|-----|--------------|-----|
|demo-cloud-account-azure |demo-cloud-account-azure |azure | |3 minutes ago | |
+-------------------------+-----------------------------------------+---------+-----+--------------+-----+
  • Add same tag to multiple cloud accounts
$ cpln cloudaccount tag demo-cloud-account-azure demo-cloud-account-gcp --tag multiple-cloudaccounts=true --org demo-cpln-organization
+-------------------------+-----------------------------------------+---------+--------+--------------+------------------------------+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-------------------------|-----------------------------------------|---------|--------|--------------|------------------------------|
|demo-cloud-account-azure |demo-cloud-account-azure |azure | |3 minutes ago |multiple-cloudaccounts="true" |
|demo-cloud-account-gcp |demo-cloud-account-gcp |gcp |1234abc |3 minutes ago |multiple-cloudaccounts="true" |
+-------------------------+-----------------------------------------+---------+--------+--------------+------------------------------+
  • Update same tag on multiple cloud accounts (after running the example above)
$ cpln cloudaccount tag demo-cloud-account-azure demo-cloud-account-gcp --tag multiple-cloudaccounts=demo-cloudaccount --org demo-cpln-organization
+-------------------------+-----------------------------------------+---------+--------+--------------+-------------------------------------------+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-------------------------|-----------------------------------------|---------|--------|--------------|-------------------------------------------|
|demo-cloud-account-azure |demo-cloud-account-azure |azure | |3 minutes ago |multiple-cloudaccounts="demo-cloudaccount" |
|demo-cloud-account-gcp |demo-cloud-account-gcp |gcp |1234abc |3 minutes ago |multiple-cloudaccounts="demo-cloudaccount" |
+-------------------------+-----------------------------------------+---------+--------+--------------+-------------------------------------------+
  • Remove same tag from multiple cloud accounts (after running the example above)
$ cpln cloudaccount tag demo-cloud-account-azure demo-cloud-account-gcp --remove multiple-cloudaccounts --org demo-cpln-organization
+-------------------------+-----------------------------------------+---------+--------+--------------+-----+
|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |
|-------------------------|-----------------------------------------|---------|--------|--------------|-----|
|demo-cloud-account-azure |demo-cloud-account-azure |azure | |3 minutes ago | |
|demo-cloud-account-gcp |demo-cloud-account-gcp |gcp |1234abc |3 minutes ago | |
+-------------------------+-----------------------------------------+---------+--------+--------------+-----+

convert

Convert k8s files to cpln files

Refer to the cpln convert guide for additional details.

Usage

copy
cpln convert [OPTIONS]
Reference

Command options: --file, -f File to load and use for the command. Use --file - to enable input from stdin. [required] --protocol Protocol to use for all container ports [choices: "http", "http2", "grpc", "tcp"]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

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

Common Options Reference


delete

Delete resources from files

Refer to the cpln delete guide for additional details.

Usage

copy
cpln delete [OPTIONS]
Reference

Command options: --file, -f File to load and use for the command. Use --file - to enable input from stdin. [required] --k8s Set this true if input file is k8s config file [boolean]

Context options: --profile Override the profile. The default profile can be set using the cpln profile set-default command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the cpln profile update command --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

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

Common Options Reference


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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln domain delete demo.globalvirtualcloud.com --org demo-cpln-organization
The referenced domain will be removed from the referenced organization.

domain edit

Edit the referenced domain, as YAML, within an editor

Usage

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

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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 references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Show a domain
$ cpln domain get demo.globalvirtualcloud.com --org demo-cpln-organization
+----------------------------+-----------------------------------------+---------------+
|NAME |DESCRIPTION |TAGS |
|----------------------------|-----------------------------------------|---------------|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |drink="coffee" |
+----------------------------+-----------------------------------------+---------------+
  • 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 |drink="coffee" |
|demo2.globalvirtualcloud.com |demo2.globalvirtualcloud.com |demo-domain="true" |
+-----------------------------+-----------------------------------------+-------------------+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln domain patch demo.globalvirtualcloud.com --file update.json --org demo-cpln-organization
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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
NOTE

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

  • Search for a 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 |drink="coffee" |
+----------------------------+-----------------------------------------+---------------+
  • Search for a 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 |drink="coffee" |
+----------------------------+-----------------------------------------+---------------+
  • Search for a domain based on a tag
$ cpln domain query --match any --tag demo-domain="true" --org demo-cpln-organization
+-----------------------------+-----------------------------------------+-------------------+
|NAME |DESCRIPTION |TAGS |
|-----------------------------|-----------------------------------------|-------------------|
|demo2.globalvirtualcloud.com |demo2.globalvirtualcloud.com |demo-domain="true" |
+-----------------------------+-----------------------------------------+-------------------+
  • Search for a domain based on a property and tag
$ cpln domain query --match any --prop description="FQDN: demo.globalvirtualcloud.com" --tag demo-domain="true" --org demo-cpln-organization
+-----------------------------+-----------------------------------------+-------------------+
|NAME |DESCRIPTION |TAGS |
|-----------------------------|-----------------------------------------|-------------------|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |drink="coffee" |
|demo2.globalvirtualcloud.com |demo2.globalvirtualcloud.com |demo-domain="true" |
+-----------------------------+-----------------------------------------+-------------------+

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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag to a domain
$ cpln domain tag demo.globalvirtualcloud.com --tag drink=water --org demo-cpln-organization
+----------------------------+-----------------------------------------+--------------+
|NAME |DESCRIPTION |TAGS |
|----------------------------|-----------------------------------------|--------------|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |drink="water" |
+----------------------------+-----------------------------------------+--------------+
  • Update same tag (after running the example above)
$ cpln domain tag demo.globalvirtualcloud.com --tag drink=coffee --org demo-cpln-organization
+----------------------------+-----------------------------------------+---------------+
|NAME |DESCRIPTION |TAGS |
|----------------------------|-----------------------------------------|---------------|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |drink="coffee" |
+----------------------------+-----------------------------------------+---------------+
  • Remove tag (after running the example above)
$ cpln domain tag demo.globalvirtualcloud.com --remove name --org demo-cpln-organization
+----------------------------+-----------------------------------------+---------------+
|NAME |DESCRIPTION |TAGS |
|----------------------------|-----------------------------------------|---------------|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |drink="coffee" |
+----------------------------+-----------------------------------------+---------------+
  • 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 |drink="coffee" |
| | |multiple-domains="true" |
|demo2.globalvirtualcloud.com |demo2.globalvirtualcloud.com |demo-domain="true" |
| | |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 |drink="coffee" |
| | |multiple-domains="demo-domain" |
|demo2.globalvirtualcloud.com |demo2.globalvirtualcloud.com |demo-domain="true" |
| | |multiple-domains="demo-domain" |
+-----------------------------+-----------------------------------------+-------------------------------+
  • Remove same tag from multiple domain (after running the example above)
$ cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --remove multiple-domains --org demo-cpln-organization
+-----------------------------+-----------------------------------------+-------------------+
|NAME |DESCRIPTION |TAGS |
|-----------------------------|-----------------------------------------|-------------------|
|demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |drink="coffee" |
|demo2.globalvirtualcloud.com |demo2.globalvirtualcloud.com |demo-domain="true" |
+-----------------------------+-----------------------------------------+-------------------+

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; this will only duplicate its spec. [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln group access-report demo-group --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a user to a group
$ cpln group add-member demo-group --email test-128@example.com --org demo-cpln-organization
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group |demo-group |3 minutes ago |links |default |drink="water" |
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
  • Add a service account to a group using email
$ cpln group add-member demo-group --serviceaccount controlplane --org demo-cpln-organization
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group |demo-group |3 minutes ago |links |default |drink="water" |
+-----------+-----------------------------------------+--------------+-------+--------+--------------+

group clone

Create a clone of the referenced group; this will only duplicate its spec.

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln group clone demo-group --name demo-group-clone --org demo-cpln-organization
+-----------------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group-clone |Clone of demo-group |0 minutes ago |links |default |drink="water" |
+-----------------+-----------------------------------------+--------------+-------+--------+--------------+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln group create --name demo-group --desc demo-group --tag drink=water --org demo-cpln-organization
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group |demo-group |0 minutes ago |links |default |drink="water" |
+-----------+-----------------------------------------+--------------+-------+--------+--------------+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln group delete demo-group --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]

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln group eventlog demo-group --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 references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all groups
$ cpln group get --org demo-cpln-organization
+-----------------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group |demo-group |4 minutes ago |links |default |drink="water" |
|demo-group-get-1 |demo-group-get-1 |0 minutes ago |links |default | |
|demo-group-get-2 |demo-group-get-2 |0 minutes ago |links |default | |
|superusers |Built-in group for all administrators... |3 years ago |links |builtin | |
|viewers |Built-in group for read-only access |3 years ago |links |builtin | |
+-----------------+-----------------------------------------+--------------+-------+--------+--------------+
  • Get one group
$ cpln group get demo-group-get-1 --org demo-cpln-organization
+-----------------+-----------------------------------------+--------------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|--------------|-------|--------|-----|
|demo-group-get-1 |demo-group-get-1 |0 minutes ago |links |default | |
+-----------------+-----------------------------------------+--------------+-------+--------+-----+
  • Get multiple groups
$ cpln group get demo-group-get-1 demo-group-get-2 --org demo-cpln-organization
+-----------------+-----------------------------------------+--------------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|--------------|-------|--------|-----|
|demo-group-get-1 |demo-group-get-1 |0 minutes ago |links |default | |
|demo-group-get-2 |demo-group-get-2 |0 minutes ago |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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln group patch demo-group --file 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
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 the name property
$ cpln group query --match any --prop name=demo-group --org demo-cpln-organization
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group |demo-group |4 minutes ago |links |default |drink="water" |
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
  • Search for a group based on the description property
$ cpln group query --match any --prop description="demo-group" --org demo-cpln-organization
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group |demo-group |4 minutes ago |links |default |drink="water" |
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
  • Search for a group based on a tag
$ cpln group query --match any --tag drink=water --org demo-cpln-organization
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group |demo-group |4 minutes ago |links |default |drink="water" |
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
  • Search for a group based on a property and tag
$ cpln group query --match any --prop description="demo-group" --tag drink=water --org demo-cpln-organization
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group |demo-group |4 minutes ago |links |default |drink="water" |
+-----------+-----------------------------------------+--------------+-------+--------+--------------+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
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 --email test-128@example.com --org demo-cpln-organization
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group |demo-group |4 minutes ago |links |default |drink="water" |
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
  • Remove a service account to a group using email
$ cpln group remove-member demo-group --serviceaccount controlplane --org demo-cpln-organization
+-----------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group |demo-group |4 minutes ago |links |default |drink="water" |
+-----------+-----------------------------------------+--------------+-------+--------+--------------+

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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag to a group
$ cpln group tag demo-group-tag-1 --tag drink=water --org demo-cpln-organization
+-----------------+-----------------------------------------+--------------+-------+--------+--------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|--------------|-------|--------|--------------|
|demo-group-tag-1 |demo-group-tag-1 |0 minutes ago |links |default |drink="water" |
+-----------------+-----------------------------------------+--------------+-------+--------+--------------+
  • Update same tag (after running the example above)
$ cpln group tag demo-group-tag-1 --tag drink=coffee --org demo-cpln-organization
+-----------------+-----------------------------------------+--------------+-------+--------+---------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|--------------|-------|--------|---------------|
|demo-group-tag-1 |demo-group-tag-1 |0 minutes ago |links |default |drink="coffee" |
+-----------------+-----------------------------------------+--------------+-------+--------+---------------+
  • Remove tag (after running the example above)
$ cpln group tag demo-group-tag-1 --remove drink --org demo-cpln-organization
+-----------------+-----------------------------------------+--------------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|--------------|-------|--------|-----|
|demo-group-tag-1 |demo-group-tag-1 |0 minutes ago |links |default | |
+-----------------+-----------------------------------------+--------------+-------+--------+-----+
  • Add same tag to multiple groups
$ cpln group tag demo-group-tag-1 demo-group-tag-2 --tag multiple-groups=true --org demo-cpln-organization
+-----------------+-----------------------------------------+--------------+-------+--------+-----------------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|--------------|-------|--------|-----------------------|
|demo-group-tag-1 |demo-group-tag-1 |0 minutes ago |links |default |multiple-groups="true" |
|demo-group-tag-2 |demo-group-tag-2 |0 minutes ago |links |default |multiple-groups="true" |
+-----------------+-----------------------------------------+--------------+-------+--------+-----------------------+
  • Update same tag on multiple groups (after running the example above)
$ cpln group tag demo-group-tag-1 demo-group-tag-2 --tag multiple-groups=demo-group --org demo-cpln-organization
+-----------------+-----------------------------------------+--------------+-------+--------+-----------------------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|--------------|-------|--------|-----------------------------|
|demo-group-tag-1 |demo-group-tag-1 |0 minutes ago |links |default |multiple-groups="demo-group" |
|demo-group-tag-2 |demo-group-tag-2 |0 minutes ago |links |default |multiple-groups="demo-group" |
+-----------------+-----------------------------------------+--------------+-------+--------+-----------------------------+
  • Remove same tag from multiple groups (after running the example above)
$ cpln group tag demo-group-tag-1 demo-group-tag-2 --remove multiple-groups --org demo-cpln-organization
+-----------------+-----------------------------------------+--------------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|-----------------|-----------------------------------------|--------------|-------|--------|-----|
|demo-group-tag-1 |demo-group-tag-1 |0 minutes ago |links |default | |
|demo-group-tag-2 |demo-group-tag-2 |0 minutes ago |links |default | |
+-----------------+-----------------------------------------+--------------+-------+--------+-----+

group update

Update properties of the referenced group

Usage

copy
cpln group 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"):

copy
description string
tags.&lt;key&gt; 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • The --set option allows the modification of the following 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 ago |links |default | |
+------------------+-----------------------------------------+--------------+-------+--------+-----+
  • Update an group's description
$ cpln group update demo-group-update --set description="new description" --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|--------------|-------|--------|-----|
|demo-group-update |new description |0 minutes ago |links |default | |
+------------------+-----------------------------------------+--------------+-------+--------+-----+
  • Update an group's tags
$ cpln group update demo-group-update --set tags.demo-key=demo-value --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+-------+--------+----------------------+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|-----------------------------------------|--------------|-------|--------|----------------------|
|demo-group-update |new description |0 minutes ago |links |default |demo-key="demo-value" |
+------------------+-----------------------------------------+--------------+-------+--------+----------------------+
  • 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 |new description |0 minutes ago |links |default |demo-key="demo-value" |
+------------------+-----------------------------------------+--------------+-------+--------+----------------------+
  • 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 |new description |0 minutes ago |links |default |demo-key="demo-value" |
+------------------+-----------------------------------------+--------------+-------+--------+----------------------+

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

Options: --help Show help [boolean]


gvc 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Display the user / service account / group permissions for the 'demo-gvc' global virtual cloud within the 'demo-cpln-organization' organization
$ cpln gvc access-report demo-gvc --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|create |/org/demo-cpln-organization/group/superusers |manage |
|create |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|delete |/org/demo-cpln-organization/group/superusers |manage |
|delete |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|edit |/org/demo-cpln-organization/group/superusers |manage |
|edit |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|manage |/org/demo-cpln-organization/group/superusers |manage |
|manage |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/viewers |view |
|view |/org/demo-cpln-organization/group/superusers |manage |
|view |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
+-----------+--------------------------------------------------------+--------+

gvc add-location

Add one or more locations to the referenced global virtual cloud

Usage

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
NOTE

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

  • Add one location to a global virtual cloud
$ cpln gvc add-location demo-gvc --location aws-us-west-2 --org demo-cpln-organization
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------|-----------------------------------------|--------------|--------------|----------|-----------------|--------------|
|demo-gvc |demo-gvc |5 minutes ago |qtsrhr1j0gbsm | |aws-eu-central-1 |drink="water" |
| | | | | |aws-us-west-2 | |
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
  • Add multiple locations to a global virtual cloud
$ cpln gvc add-location demo-gvc --location aws-us-west-2 --location gcp-us-east1 --org demo-cpln-organization
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------|-----------------------------------------|--------------|--------------|----------|-----------------|--------------|
|demo-gvc |demo-gvc |5 minutes ago |qtsrhr1j0gbsm | |aws-eu-central-1 |drink="water" |
| | | | | |aws-us-west-2 | |
| | | | | |gcp-us-east1 | |
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+

gvc clone

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

Usage

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

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

Command options: --name Set the name for the clone [required] --description Optional description, defaults to the name if not set --tag Attach tags (e.g., --tag drink=water)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln gvc clone demo-gvc --name demo-gvc-clone --org demo-cpln-organization
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|--------------|--------------|----------|-----------------|--------------|
|demo-gvc-clone |Clone of demo-gvc |0 minutes ago |5cjppt4qcw8n8 | |aws-eu-central-1 |drink="water" |
| | | | | |aws-us-west-2 | |
| | | | | |gcp-us-east1 | |
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+

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] --env Environment variables in KEY=VALUE format --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • name
    • Minimum Length: 3
    • Maximum Length: 64
    • Only lowercase characters
    • Must begin with a character
    • Allowed special characters: -
Example
  • Create an new GVC with a single location
$ cpln gvc create --name demo-gvc --location aws-eu-central-1 --desc demo-gvc --tag drink=water --org demo-cpln-organization
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------|-----------------------------------------|--------------|--------------|----------|-----------------|--------------|
|demo-gvc |demo-gvc |0 minutes ago |qtsrhr1j0gbsm | |aws-eu-central-1 |drink="water" |
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+

gvc delete

Delete GVCs by name

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: []]

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Delete a gvc
$ cpln gvc delete demo-gvc-delete-1 --org demo-cpln-organization
If the delete was successful, a new command prompt will be shown.
  • Delete multiple gvcs
$ cpln gvc delete demo-gvc-delete-1 demo-gvc-delete-2 --org demo-cpln-organization
If the delete was successful, a new command prompt will be shown.

gvc delete-all-workloads

Delete all workloads for the referenced global virtual cloud

Usage

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Delete all workloads
$ cpln gvc delete-all-workloads demo-gvc-with-workloads --org demo-cpln-organization
+------------+-----------------------------------------+------------------------+----------+--------------+---------------------------------------------+-----+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|------------|-----------------------------------------|------------------------|----------|--------------|---------------------------------------------|-----|
|workload-01 |workload-01 |demo-gvc-with-workloads | |0 minutes ago |https://workload-01-1h64077xm3pwt.t.cpln.app | |
|workload-02 |workload-02 |demo-gvc-with-workloads | |0 minutes ago |https://workload-02-1h64077xm3pwt.t.cpln.app | |
+------------+-----------------------------------------+------------------------+----------+--------------+---------------------------------------------+-----+

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]

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

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

gvc eventlog

Show the event log of the referenced global virtual cloud

Usage

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln gvc eventlog demo-gvc --org demo-cpln-organization
The event log for the referenced gvc will be shown.

gvc get

Retrieve one or more referenced global virtual clouds

Usage

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

An empty reference will return all references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all gvcs
$ cpln gvc get --org demo-cpln-organization
+------------------------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|------------------------|-----------------------------------------|--------------|--------------|----------|-----------------|--------------|
|demo-gvc |demo-gvc |5 minutes ago |qtsrhr1j0gbsm | |aws-eu-central-1 |drink="water" |
| | | | | |aws-us-west-2 | |
| | | | | |gcp-us-east1 | |
|demo-gvc-get-1 |demo-gvc-get-1 |0 minutes ago |1djj53r51j66w | |aws-eu-central-1 | |
|demo-gvc-get-2 |demo-gvc-get-2 |0 minutes ago |539kqv4p14tv6 | |aws-eu-central-1 | |
|demo-gvc-identity |demo-gvc-identity |5 minutes ago |h9g25ky33nwf8 | |aws-eu-central-1 | |
|demo-gvc-with-workloads |demo-gvc-with-workloads |0 minutes ago |1h64077xm3pwt | |aws-eu-central-1 | |
|demo-gvc-workload |demo-gvc-workload |6 minutes ago |x08pdgjs9hhjj | |aws-eu-central-1 | |
+------------------------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
  • Get one gvc
$ cpln gvc get demo-gvc-get-1 --org demo-cpln-organization
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|--------------|--------------|----------|-----------------|-----|
|demo-gvc-get-1 |demo-gvc-get-1 |0 minutes ago |1djj53r51j66w | |aws-eu-central-1 | |
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
  • Get multiple gvcs
$ cpln gvc get demo-gvc-get-1 demo-gvc-get-2 --org demo-cpln-organization
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|--------------|--------------|----------|-----------------|-----|
|demo-gvc-get-1 |demo-gvc-get-1 |0 minutes ago |1djj53r51j66w | |aws-eu-central-1 | |
|demo-gvc-get-2 |demo-gvc-get-2 |0 minutes ago |539kqv4p14tv6 | |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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln gvc patch demo-gvc --file update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced gvc.

gvc permissions

Show the grantable permissions for a global virtual cloud object type

Usage

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln gvc permissions --org demo-cpln-organization
+-------+-----------------------------------------+-----------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|-----------------------------------|
|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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
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 the name property
$ cpln gvc query --match any --prop name=demo-gvc --org demo-cpln-organization
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------|-----------------------------------------|--------------|--------------|----------|-----------------|--------------|
|demo-gvc |demo-gvc |5 minutes ago |qtsrhr1j0gbsm | |aws-eu-central-1 |drink="water" |
| | | | | |aws-us-west-2 | |
| | | | | |gcp-us-east1 | |
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
  • Search for a gvc based on the description property
$ cpln gvc query --match any --prop description="demo-gvc" --org demo-cpln-organization
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------|-----------------------------------------|--------------|--------------|----------|-----------------|--------------|
|demo-gvc |demo-gvc |5 minutes ago |qtsrhr1j0gbsm | |aws-eu-central-1 |drink="water" |
| | | | | |aws-us-west-2 | |
| | | | | |gcp-us-east1 | |
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
  • Search for a gvc based on a tag
$ cpln gvc query --match any --tag drink=water --org demo-cpln-organization
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------|-----------------------------------------|--------------|--------------|----------|-----------------|--------------|
|demo-gvc |demo-gvc |5 minutes ago |qtsrhr1j0gbsm | |aws-eu-central-1 |drink="water" |
| | | | | |aws-us-west-2 | |
| | | | | |gcp-us-east1 | |
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
  • Search for a gvc based on a property and tag
$ cpln gvc query --match any --prop description="demo-gvc" --tag drink=water --org demo-cpln-organization
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------|-----------------------------------------|--------------|--------------|----------|-----------------|--------------|
|demo-gvc |demo-gvc |5 minutes ago |qtsrhr1j0gbsm | |aws-eu-central-1 |drink="water" |
| | | | | |aws-us-west-2 | |
| | | | | |gcp-us-east1 | |
+---------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+

gvc remove-location

Remove one or more locations from the referenced global virtual cloud

Usage

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
NOTE

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

  • Remove one location from a global virtual cloud
$ cpln gvc remove-location demo-gvc-with-locations --location azure-eastus2 --org demo-cpln-organization
+------------------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|------------------------|-----------------------------------------|--------------|--------------|----------|-----------------|-----|
|demo-gvc-with-locations |demo-gvc-with-locations |0 minutes ago |h7kd0ta4zjapc | |aws-eu-central-1 | |
| | | | | |aws-us-west-2 | |
| | | | | |gcp-us-east1 | |
+------------------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
  • Remove multiple locations from a global virtual cloud
$ cpln gvc remove-location demo-gvc-with-locations --location aws-us-west-2 --location aws-eu-central-1 --org demo-cpln-organization
+------------------------+-----------------------------------------+--------------+--------------+----------+-------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|------------------------|-----------------------------------------|--------------|--------------|----------|-------------|-----|
|demo-gvc-with-locations |demo-gvc-with-locations |0 minutes ago |h7kd0ta4zjapc | |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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag to a gvc
$ cpln gvc tag demo-gvc-tag-1 --tag drink=water --org demo-cpln-organization
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|--------------|--------------|----------|-----------------|--------------|
|demo-gvc-tag-1 |demo-gvc-tag-1 |0 minutes ago |sj94vv1gm20qj | |aws-eu-central-1 |drink="water" |
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+--------------+
  • Update same tag (after running the example above)
$ cpln gvc tag demo-gvc-tag-1 --tag drink=coffee --org demo-cpln-organization
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+---------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|--------------|--------------|----------|-----------------|---------------|
|demo-gvc-tag-1 |demo-gvc-tag-1 |0 minutes ago |sj94vv1gm20qj | |aws-eu-central-1 |drink="coffee" |
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+---------------+
  • Remove tag (after running the example above)
$ cpln gvc tag demo-gvc-tag-1 --remove drink --org demo-cpln-organization
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|--------------|--------------|----------|-----------------|-----|
|demo-gvc-tag-1 |demo-gvc-tag-1 |0 minutes ago |sj94vv1gm20qj | |aws-eu-central-1 | |
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
  • Add same tag to multiple gvcs
$ cpln gvc tag demo-gvc-tag-1 demo-gvc-tag-2 --tag multiple-gvcs=true --org demo-cpln-organization
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+---------------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|--------------|--------------|----------|-----------------|---------------------|
|demo-gvc-tag-1 |demo-gvc-tag-1 |0 minutes ago |sj94vv1gm20qj | |aws-eu-central-1 |multiple-gvcs="true" |
|demo-gvc-tag-2 |demo-gvc-tag-2 |0 minutes ago |wj0nzx8839b0c | |aws-eu-central-1 |multiple-gvcs="true" |
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+---------------------+
  • Update same tag on multiple gvcs (after running the example above)
$ cpln gvc tag demo-gvc-tag-1 demo-gvc-tag-2 --tag multiple-gvcs=demo-gvc --org demo-cpln-organization
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+-------------------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|--------------|--------------|----------|-----------------|-------------------------|
|demo-gvc-tag-1 |demo-gvc-tag-1 |0 minutes ago |sj94vv1gm20qj | |aws-eu-central-1 |multiple-gvcs="demo-gvc" |
|demo-gvc-tag-2 |demo-gvc-tag-2 |0 minutes ago |wj0nzx8839b0c | |aws-eu-central-1 |multiple-gvcs="demo-gvc" |
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+-------------------------+
  • Remove same tag from multiple gvcs (after running the example above)
$ cpln gvc tag demo-gvc-tag-1 demo-gvc-tag-2 --remove multiple-gvcs --org demo-cpln-organization
+---------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|---------------|-----------------------------------------|--------------|--------------|----------|-----------------|-----|
|demo-gvc-tag-1 |demo-gvc-tag-1 |0 minutes ago |sj94vv1gm20qj | |aws-eu-central-1 | |
|demo-gvc-tag-2 |demo-gvc-tag-2 |0 minutes ago |wj0nzx8839b0c | |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"):

copy
description string
tags.&lt;key&gt; string
spec.pullSecretLinks string[]
spec.staticPlacement.locationLinks string[]
spec.tracing.sampling number
spec.tracing.lightstep.endpoint string
spec.tracing.lightstep.credentials string[]
spec.env.&lt;name&gt;.value 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • The --set option allows the modification of the following global virtual cloud properties:
    • description
      • Description of the global virtual cloud
      • Type: string
    • tags
      • Tags (key=value) associated with the global virtual cloud
      • Type: string
    • spec.pullSecretLinks
      • Array of pull secret links belonging to the global virtual cloud
      • Type: string[]
    • spec.domain
      • The domain linked to this global virtual cloud
      • Type: string
    • spec.staticPlacement.locationLinks
      • Array of location links belonging to the global virtual cloud
      • Type: string[]
Example
  • For the examples below, the initial gvc is configured as:
+----------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|--------------|--------------|----------|-----------------|-----|
|demo-gvc-update |demo-gvc-update |0 minutes ago |g57qtdt86tsjr | |aws-eu-central-1 | |
+----------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
  • Update a gvc's description
$ cpln gvc update demo-gvc-update --set description="new description" --org demo-cpln-organization
+----------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|--------------|--------------|----------|-----------------|-----|
|demo-gvc-update |new description |0 minutes ago |g57qtdt86tsjr | |aws-eu-central-1 | |
+----------------+-----------------------------------------+--------------+--------------+----------+-----------------+-----+
  • Update a gvc's tag
$ cpln gvc update demo-gvc-update --set tags.demo-key=demo-value --org demo-cpln-organization
+----------------+-----------------------------------------+--------------+--------------+----------+-----------------+----------------------+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|-----------------------------------------|--------------|--------------|----------|-----------------|----------------------|
|demo-gvc-update |new description |0 minutes ago |g57qtdt86tsjr | |aws-eu-central-1 |demo-key="demo-value" |
+----------------+-----------------------------------------+--------------+--------------+----------+-----------------+----------------------+

helm

Manage helm releases on cpln

Refer to the cpln helm guide for additional details.

copy
cpln helm [SUBCOMMAND]

Commands: cpln helm install [release][chart] Install a release [aliases: apply] cpln helm list Show a list of releases cpln helm show <release> Show state of a release cpln helm template [release][chart] Generate cpln resources from a template cpln helm uninstall <release> Uninstall a release [aliases: destroy, delete]

Options: --help Show help [boolean]


helm Subcommands


helm install

Install a release

Usage

copy
cpln helm install [release] [chart] [OPTIONS]
Reference

Positionals: release The release name [string] chart Path to chart [string]

Command options: --wait If set, will wait until all Workloads are in a ready state before marking the release as successful. It will wait for as long as --timeout [boolean] --timeout The amount of seconds to wait for workloads to be ready before timing out. Works only if the "wait" option is set to true. [number][default: 300] --set Set values on the command line (can specify multiple or separate values: --set key1=val1 --set key2=val2) --set-string Set STRING values on the command line (can specify multiple or separate values: --set-string key1=val1 --set-string key2=val2) --set-file Set values from respective files specified via the command line (can specify multiple or separate values: --set-file key1=path1 --set-file key2=path2) --description, --desc Add a custom description [string] --generate-name, -g Generate the name (and omit the NAME parameter) [boolean] --post-renderer The path to an executable to be used for post rendering. If it exists in $PATH, the binary will be used, otherwise it will try to look for the executable at the given path [string] --post-renderer-args An argument to the post-renderer (can specify multiple or separate values: --post-renderer-args arg1 --post-renderer-args arg2) (default []) [default: []] --repo Chart repository url where to locate the requested chart [string] --values, -f Specify values in a YAML file or a URL (can specify multiple or separate values: --values value1.yaml --values values2.yaml) [string] --verify Verify the package before using it [boolean] --tag Attach tags (e.g., --tag drink=water) --remove Remove tags (e.g., --remove tagname)

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

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


helm list

Show a list of releases

Usage

copy
cpln helm list [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


helm show

Show state of a release

Usage

copy
cpln helm show <release> [OPTIONS]
Reference

Positionals: release The release name [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


helm template

Generate cpln resources from a template

Usage

copy
cpln helm template [release] [chart] [OPTIONS]
Reference

Positionals: release The release name [string] chart Path to chart [string]

Command options: --set Set values on the command line (can specify multiple or separate values: --set key1=val1 --set key2=val2) --set-string Set STRING values on the command line (can specify multiple or separate values: --set-string key1=val1 --set-string key2=val2) --set-file Set values from respective files specified via the command line (can specify multiple or separate values: --set-file key1=path1 --set-file key2=path2) --description, --desc Add a custom description [string] --generate-name, -g Generate the name (and omit the NAME parameter) [boolean] --post-renderer The path to an executable to be used for post rendering. If it exists in $PATH, the binary will be used, otherwise it will try to look for the executable at the given path [string] --post-renderer-args An argument to the post-renderer (can specify multiple or separate values: --post-renderer-args arg1 --post-renderer-args arg2) (default []) [default: []] --repo Chart repository url where to locate the requested chart [string] --values, -f Specify values in a YAML file or a URL (can specify multiple or separate values: --values value1.yaml --values values2.yaml) [string] --verify Verify the package before using it [boolean]

Context options: --profile Override the profile. The default profile can be set using the cpln profile set-default command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the cpln profile update command --gvc Override the global virtual cloud. The default global virtual cloud 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]

Common Options Reference


helm uninstall

Uninstall a release

Usage

copy
cpln helm uninstall <release> [OPTIONS]
Reference

Positionals: release The release name [string][required]

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

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

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


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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln identity access-report demo-identity --org demo-cpln-organization --gvc demo-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/viewers |view |
|view |/org/demo-cpln-organization/group/superusers |manage |
|view |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
+-----------+--------------------------------------------------------+--------+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln identity create --name demo-identity --desc demo-identity --tag drink=water --org demo-cpln-organization --gvc demo-gvc-identity
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|--------------|
|demo-identity |demo-identity |demo-gvc-identity |cpln-demo-cpln-organi-gxkmaeh2 |0 minutes ago | |drink="water" |
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln identity delete demo-identity --org demo-cpln-organization --gvc demo-gvc-identity
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]

Command options: --replace, -r Replace instead of patch/merge [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 --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln identity edit demo-identity --org demo-cpln-organization --gvc demo-gvc-identity
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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln identity eventlog demo-identity --org demo-cpln-organization --gvc demo-gvc-identity
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 references

Reference

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

Context options: --profile Override the profile. The default profile can be set using the cpln profile set-default command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the cpln profile update command --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

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-gvc-identity
+--------------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|--------------|
|demo-identity |demo-identity |demo-gvc-identity |cpln-demo-cpln-organi-gxkmaeh2 |6 minutes ago | |drink="water" |
|demo-identity-get-1 |demo-identity-get-1 |demo-gvc-identity |cpln-demo-cpln-organi-czssdb02 |0 minutes ago | | |
|demo-identity-get-2 |demo-identity-get-2 |demo-gvc-identity |cpln-demo-cpln-organi-9re2q80t |0 minutes ago | | |
+--------------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
  • Get one identity
$ cpln identity get demo-identity-get-1 --org demo-cpln-organization --gvc demo-gvc-identity
+--------------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|-----|
|demo-identity-get-1 |demo-identity-get-1 |demo-gvc-identity |cpln-demo-cpln-organi-czssdb02 |0 minutes ago | | |
+--------------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+-----+
  • Get multiple identities
$ cpln identity get demo-identity-get-1 demo-identity-get-2 --org demo-cpln-organization --gvc demo-gvc-identity
+--------------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|-----|
|demo-identity-get-1 |demo-identity-get-1 |demo-gvc-identity |cpln-demo-cpln-organi-czssdb02 |0 minutes ago | | |
|demo-identity-get-2 |demo-identity-get-2 |demo-gvc-identity |cpln-demo-cpln-organi-9re2q80t |0 minutes ago | | |
+--------------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+-----+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln identity patch demo-identity --file update.json --org demo-cpln-organization --gvc demo-gvc-identity
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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln identity permissions --org demo-cpln-organization --gvc demo-gvc-identity
+-------+-----------------------------------------+----------------------------------------+
|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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
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 --gvc demo-gvc-identity
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|--------------|
|demo-identity |demo-identity |demo-gvc-identity |cpln-demo-cpln-organi-gxkmaeh2 |7 minutes ago | |drink="water" |
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
  • Search for an identity based on the description property
$ cpln identity query --match any --prop description="demo-identity" --org demo-cpln-organization --gvc demo-gvc-identity
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|--------------|
|demo-identity |demo-identity |demo-gvc-identity |cpln-demo-cpln-organi-gxkmaeh2 |7 minutes ago | |drink="water" |
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
  • Search for an identity based on a tag
$ cpln identity query --match any --tag drink=water --org demo-cpln-organization --gvc demo-gvc-identity
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|--------------|
|demo-identity |demo-identity |demo-gvc-identity |cpln-demo-cpln-organi-gxkmaeh2 |7 minutes ago | |drink="water" |
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
  • Search for an identity based on a property and tag
$ cpln identity query --match any --prop description="demo-identity" --tag drink=water --org demo-cpln-organization --gvc demo-gvc-identity
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|--------------|
|demo-identity |demo-identity |demo-gvc-identity |cpln-demo-cpln-organi-gxkmaeh2 |7 minutes ago | |drink="water" |
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+

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) --remove Remove tags (e.g., --remove tagname)

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag
$ cpln identity tag demo-identity --tag drink=water --org demo-cpln-organization --gvc demo-gvc-identity
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|--------------|
|demo-identity |demo-identity |demo-gvc-identity |cpln-demo-cpln-organi-gxkmaeh2 |7 minutes ago | |drink="water" |
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+--------------+
  • Update same tag (after running the example above)
$ cpln identity tag demo-identity --tag drink=coffee --org demo-cpln-organization --gvc demo-gvc-identity
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+---------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|---------------|
|demo-identity |demo-identity |demo-gvc-identity |cpln-demo-cpln-organi-gxkmaeh2 |7 minutes ago | |drink="coffee" |
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+---------------+
  • Remove tag (after running the example above)
$ cpln identity tag demo-identity --remove drink --org demo-cpln-organization --gvc demo-gvc-identity
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|--------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|-----|
|demo-identity |demo-identity |demo-gvc-identity |cpln-demo-cpln-organi-gxkmaeh2 |7 minutes ago | | |
+--------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+-----+

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

copy
description string
tags.&lt;key&gt; 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • The --set option allows the modification of the following 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-update |demo-identity-update |demo-gvc-identity |cpln-demo-cpln-organi-h4tb353h |0 minutes ago | | |
+---------------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+-----+
  • Update an identity's description
$ cpln identity update demo-identity-update --set description="new description" --org demo-cpln-organization --gvc demo-gvc-identity
+---------------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|---------------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|-----|
|demo-identity-update |new description |demo-gvc-identity |cpln-demo-cpln-organi-h4tb353h |0 minutes ago | | |
+---------------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+-----+
  • Update an identity's tag
$ cpln identity update demo-identity-update --set tags.demo-key=demo-value --org demo-cpln-organization --gvc demo-gvc-identity
+---------------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+----------------------+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|---------------------|-----------------------------------------|------------------|-------------------------------|--------------|----------|----------------------|
|demo-identity-update |new description |demo-gvc-identity |cpln-demo-cpln-organi-h4tb353h |0 minutes ago | |demo-key="demo-value" |
+---------------------+-----------------------------------------+------------------+-------------------------------+--------------+----------+----------------------+

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. If using buildpacks, everything after -- will be passed down to the pack executable. cpln image copy <ref> Copy an image from one org to another. This will make sure that docker-login has been run against the source and destination org, then will pull, tag and push the image to the destination org. 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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. If using buildpacks, everything after -- will be passed down to the pack executable.

Usage

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

To push an image using this command, the docker-credential-cpln executable 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, for example heroku/buildpacks:20, gcr.io/buildpacks/builder:v1, paketobuildpacks/builder:base, etc. [default: "heroku/buildpacks:20"] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln image build demo-image:1 --push demo-cpln-organization -- --env CPLN_IMAGE_BUILD=true
If the build was successful, the newly generated container image will be pushed to the referenced org's private registry.
If using buildpacks, every flag after the -- is passed to the pack binary.
Below are the available flags from the pack build command.
Pack Build uses Cloud Native Buildpacks to create a runnable app image from source code.
Pack Build requires an image name, which will be generated from the source code. Build defaults to the current directory, but you can use \`--path\` to specify another source code directory. Build requires a \`builder\`, which can either be provided directly to build using \`--builder\`, or can be set using the \`set-default-builder\` command. For more on how to use \`pack build\`, see: https://buildpacks.io/docs/app-developer-guide/build-an-app/.
Usage:
pack build <image-name> [flags]
Examples:
pack build test_img --path apps/test-app --builder cnbs/sample-builder:bionic
Flags:
-B, --builder string Builder image
-b, --buildpack strings Buildpack to use. One of:
a buildpack by id and version in the form of '<buildpack>@<version>',
path to a buildpack directory (not supported on Windows),
path/URL to a buildpack .tar or .tgz file, or
a packaged buildpack image name in the form of '<hostname>/<repo>[:<tag>]'
Repeat for each buildpack in order, or supply once by comma-separated list
-r, --buildpack-registry string Buildpack Registry by name
--cache-image string Cache build layers in remote registry. Requires --publish
--clear-cache Clear image's associated cache before building
-D, --default-process string Set the default process type. (default "web")
-d, --descriptor string Path to the project descriptor file
--docker-host string Address to docker daemon that will be exposed to the build container.
If not set (or set to empty string) the standard socket location will be used.
Special value 'inherit' may be used in which case DOCKER_HOST environment variable will be used.
This option may set DOCKER_HOST environment variable for the build container if needed.
-e, --env stringArray Build-time environment variable, in the form 'VAR=VALUE' or 'VAR'.
When using latter value-less form, value will be taken from current
environment at the time this command is executed.
This flag may be specified multiple times and will override
individual values defined by --env-file.
Repeat for each env in order (comma-separated lists not accepted)
NOTE: These are NOT available at image runtime.
--env-file stringArray Build-time environment variables file
One variable per line, of the form 'VAR=VALUE' or 'VAR'
When using latter value-less form, value will be taken from current
environment at the time this command is executed
NOTE: These are NOT available at image runtime."
--gid int Override GID of user's group in the stack's build and run images. The provided value must be a positive number
-h, --help Help for 'build'
--lifecycle-image string Custom lifecycle image to use for analysis, restore, and export when builder is untrusted.
--network string Connect detect and build containers to network
-p, --path string Path to app dir or zip-formatted file (defaults to current working directory)
--previous-image string Set previous image to a particular tag reference, digest reference, or (when performing a daemon build) image ID
--publish Publish to registry
--pull-policy string Pull policy to use. Accepted values are always, never, and if-not-present. (default "always")
--run-image string Run image (defaults to default stack's run image)
-t, --tag strings Additional tags to push the output image to.
Tags should be in the format 'image:tag' or 'repository/image:tag'.
Repeat for each tag in order, or supply once by comma-separated list
--trust-builder Trust the provided builder
All lifecycle phases will be run in a single container (if supported by the lifecycle).
--volume stringArray Mount host volume into the build container, in the form '<host path>:<target path>[:<options>]'.
- 'host path': Name of the volume or absolute directory path to mount.
- 'target path': The path where the file or directory is available in the container.
- 'options' (default "ro"): An optional comma separated list of mount options.
- "ro", volume contents are read-only.
- "rw", volume contents are readable and writeable.
- "volume-opt=<key>=<value>", can be specified more than once, takes a key-value pair consisting of the option name and its value.
Repeat for each volume in order (comma-separated lists not accepted)
--workspace string Location at which to mount the app dir in the build image
Global Flags:
--no-color Disable color output
-q, --quiet Show less output
--timestamps Enable timestamps in output
-v, --verbose Show more output

image copy

Copy an image from one org to another. This will make sure that docker-login has been run against the source and destination org, then will pull, tag and push the image to the destination org.

Usage

copy
cpln image copy <ref> --to-name IMAGE:TAG --to-org TARGET_ORG --to-profile TARGET_ORG_PROFILE [OPTIONS]
Reference

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

Command options: --to-name Name and tag for the image --to-org Target org to copy the image to --to-profile Profile to use for accessing the "to-org" argument --cleanup Cleans up the pulled and retagged image [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 --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Copying image between orgs within the same profile
copy
cpln image copy SOURCE_IMAGE:TAG --to-name TARGET_IMAGE:NEW_TAG --to-org TARGET_ORG

The profile service principal (user/service account) must have the proper permissions to pull/push images in the current and target org.

  • Copying image between orgs using different profiles
copy
cpln image copy SOURCE_IMAGE:TAG --to-name TARGET_IMAGE:NEW_TAG --to-org TARGET_ORG --to-profile TARGET_ORG_PROFILE

This command will copy an image from the current org to the target org.

The current profile service principal (user/service account) must have the proper permissions to pull images in the current org (default profile).

The referenced --to-profile service principal (user/service account) must have the proper permissions to push images to the target org.

This command allows the copying of images between different orgs using user or service account profiles.


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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln image delete demo-image:1 --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

Command options: --ignore-output Ignore the output of this command.

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln image docker-login demo-image:1 --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]

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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 references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all images
$ cpln image get --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+-------------+----------------------------+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|-------------|----------------------------|
|demo-image:1 |demo-cpln-organization.registry.test.cpln.io/demo-image:1 |sha256:3fe719... |4 months ago | |
|demo-image:2 |demo-cpln-organization.registry.test.cpln.io/demo-image:2 |sha256:3fe719... |3 years ago |description="Demo Image #1" |
+-------------+----------------------------------------------------------+-----------------+-------------+----------------------------+
  • 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.test.cpln.io/demo-image:1 |sha256:3fe719... |4 months ago | |
+-------------+----------------------------------------------------------+-----------------+-------------+-----+
  • 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.test.cpln.io/demo-image:1 |sha256:3fe719... |4 months ago | |
|demo-image:2 |demo-cpln-organization.registry.test.cpln.io/demo-image:2 |sha256:3fe719... |3 years ago |description="Demo Image #1" |
+-------------+----------------------------------------------------------+-----------------+-------------+----------------------------+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln image patch demo-image:1 --file 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
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.test.cpln.io/demo-image:1 |sha256:3fe719... |4 months ago | |
+-------------+----------------------------------------------------------+-----------------+-------------+-----+
  • Search for an image based on the description 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.test.cpln.io/demo-image:2 |sha256:3fe719... |3 years ago |description="Demo Image #1" |
+-------------+----------------------------------------------------------+-----------------+------------+----------------------------+
  • Search for an image based on a tag
$ cpln image query --match any --tag description="Demo Image #1" --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+------------+----------------------------+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|------------|----------------------------|
|demo-image:2 |demo-cpln-organization.registry.test.cpln.io/demo-image:2 |sha256:3fe719... |3 years ago |description="Demo Image #1" |
+-------------+----------------------------------------------------------+-----------------+------------+----------------------------+
  • Search for an image based on a property and tag
$ cpln image query --match any --prop name="demo-image" --tag description="Demo Image #1" --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+------------+----------------------------+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|------------|----------------------------|
|demo-image:2 |demo-cpln-organization.registry.test.cpln.io/demo-image:2 |sha256:3fe719... |3 years ago |description="Demo Image #1" |
+-------------+----------------------------------------------------------+-----------------+------------+----------------------------+

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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag
$ cpln image tag demo-image:1 --tag drink=water --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+-------------+--------------+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|-------------|--------------|
|demo-image:1 |demo-cpln-organization.registry.test.cpln.io/demo-image:1 |sha256:3fe719... |4 months ago |drink="water" |
+-------------+----------------------------------------------------------+-----------------+-------------+--------------+
  • Update same tag (after running the example above)
$ cpln image tag demo-image:1 --tag drink=coffee --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+-------------+---------------+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|-------------|---------------|
|demo-image:1 |demo-cpln-organization.registry.test.cpln.io/demo-image:1 |sha256:3fe719... |4 months ago |drink="coffee" |
+-------------+----------------------------------------------------------+-----------------+-------------+---------------+
  • Remove tag (after running the example above)
$ cpln image tag demo-image:1 --remove drink --org demo-cpln-organization
+-------------+----------------------------------------------------------+-----------------+-------------+-----+
|NAME |PULL |DIGEST |CREATED |TAGS |
|-------------|----------------------------------------------------------|-----------------|-------------|-----|
|demo-image:1 |demo-cpln-organization.registry.test.cpln.io/demo-image:1 |sha256:3fe719... |4 months ago | |
+-------------+----------------------------------------------------------+-----------------+-------------+-----+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln location access-report aws-eu-central-1 --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/viewers |view |
|view |/org/demo-cpln-organization/group/superusers |manage |
|view |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
+-----------+--------------------------------------------------------+--------+

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]

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln location edit aws-eu-central-1 --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 references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all 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 aws-eu-central-1 --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" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------+
  • Get multiple locations
$ 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" |
+-------------+-----------------------------------------+---------+--------+---------+--------+-------------------------------+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln location patch aws-eu-central-1 --file 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
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 the name property
$ cpln location query --match any --prop name=aws-eu-central-1 --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 the description property
$ 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 description="Azure, East US 2" --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" |
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+-------------------------------+

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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag to a location
$ cpln location tag aws-eu-central-1 --tag drink=water --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" |
| | | | | | |drink="water" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------+
  • Update same tag (after running the example above)
$ cpln location tag aws-eu-central-1 --tag drink=coffee --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" |
| | | | | | |drink="coffee" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+------------------------+
  • Remove tag (after running the example above)
$ cpln location tag aws-eu-central-1 --remove drink --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-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" |
| | | | | | |multiple-locations="demo-location" |
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
| | | | | | |multiple-locations="demo-location" |
+-----------------+-----------------------------------------+---------+--------+-------------+--------+-----------------------------------+
  • Remove same tag from multiple locations (after running the example above)
$ cpln location tag aws-eu-central-1 azure-eastus2 --remove 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 [ref] [OPTIONS]
Reference

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

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

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 logs' 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, -f Tail the logs (follow) [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: "0"] --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: "default"] --direction Sort order of logs [choices: "forward", "backward"][default: "forward"]

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.

mk8s

Manage an mk8s cluster

copy
cpln mk8s [SUBCOMMAND]

Commands: cpln mk8s access-report <ref> Show the access report for the referenced mk8s cluster cpln mk8s clone <ref> Create a clone of the referenced mk8s cluster; this will only duplicate its spec. [aliases: copy] cpln mk8s dashboard <ref> Open the k8s dashboard for an mk8s cluster cpln mk8s delete <ref...> Delete one or more referenced mk8s clusters cpln mk8s edit <ref> Edit the referenced mk8s cluster, as YAML, within an editor cpln mk8s eventlog <ref> Show the event log of the referenced mk8s cluster [aliases: log] cpln mk8s get [ref...] Retrieve one or more referenced mk8s cluster cpln mk8s join <ref> Join compute nodes to a cluster cpln mk8s kubeconfig <ref> Create a kubeconfig for a cluster. cpln mk8s patch <ref> Update the referenced mk8s cluster's metadata using an input file cpln mk8s permissions Show the grantable permissions for an mk8s cluster object type cpln mk8s query Find all the mk8s clusters based on the given query cpln mk8s tag <ref...> Manage the tags belonging to one or more referenced mk8s clusters cpln mk8s update <ref> Update properties of the referenced mk8s cluster

Options: --help Show help [boolean]


mk8s Subcommands


mk8s access-report

Show the access report for the referenced mk8s cluster

Usage

copy
cpln mk8s access-report <ref> [OPTIONS]
Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s clone

Create a clone of the referenced mk8s cluster; this will only duplicate its spec.

Usage

copy
cpln mk8s 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)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s dashboard

Open the k8s dashboard for an mk8s cluster

Usage

copy
cpln mk8s dashboard <ref> [OPTIONS]
Reference

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

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s delete

Delete one or more referenced mk8s clusters

Usage

copy
cpln mk8s delete <ref...> [OPTIONS]
Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s edit

Edit the referenced mk8s cluster, as YAML, within an editor

Usage

copy
cpln mk8s 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]

Command options: --replace, -r Replace instead of patch/merge [boolean][default: false]

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s eventlog

Show the event log of the referenced mk8s cluster

Usage

copy
cpln mk8s eventlog <ref> [OPTIONS]
Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s get

Retrieve one or more referenced mk8s cluster

Usage

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

An empty reference will return all references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s join

Join compute nodes to a cluster

Usage

copy
cpln mk8s join <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

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

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

Command options: --type Type of join configuration to produce:

copy
* cloud-init: produces a cloud-init script suitable for cloud deployments.
* join-script: results in a simple script that can be evaluated as root on a node [required] [choices: "cloud-init", "join-script"]

--options Some providers support extra options (e.g., --options nodepool=ingress)

Options: --help Show help [boolean]

Common Options Reference


mk8s kubeconfig

Create a kubeconfig for a cluster.

Usage

copy
cpln mk8s kubeconfig <ref> [OPTIONS]
Reference

Command options: --file, -f file to save kubeconfig to, default is $KUBECONFIG if set, otherwise ~/.kube/config. Use "-" to dump to stdout. New kubeconfig will be merged into the existing one

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s patch

Update the referenced mk8s cluster's metadata using an input file

Usage

copy
cpln mk8s 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]

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s permissions

Show the grantable permissions for an mk8s cluster object type

Usage

copy
cpln mk8s permissions [OPTIONS]
Reference

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s query

Find all the mk8s clusters based on the given query

Usage

copy
cpln mk8s 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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s tag

Manage the tags belonging to one or more referenced mk8s clusters

Usage

copy
cpln mk8s 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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


mk8s update

Update properties of the referenced mk8s cluster

Usage

copy
cpln mk8s 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"):

copy
description string
tags.&lt;key&gt; string
spec.version string [required]

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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 |
|exec |/org/demo-cpln-organization/group/superusers |manage |
|exec |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|exec.echo |/org/demo-cpln-organization/group/superusers |manage |
|exec.echo |/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: --accountId Id of the billing account [required] --name Name of the new organization [required] --description, --desc Optional description, defaults to the name if not set --invitee Emails of users to invite to the org as superuser(admin) [required] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • name
    • Minimum Length: 3
    • Maximum Length: 64
    • Only lowercase characters
    • Must begin with a character
    • Allowed special characters: -
Example
$ cpln org create --name demo-cpln-organization --acountId ACCOUNT_ID --invitee EMAIL
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]

Command options: --replace, -r Replace instead of patch/merge [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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln 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 references

Reference

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

Context options: --profile Override the profile. The default profile can be set using the cpln profile set-default command or by setting the CPLN_PROFILE environment variable

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all organizations
$ cpln org get
+-----------------------+-----------------------------------------+----------------------------+----------------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|----------------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
| | | |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+----------------------+
  • Get one organization
$ cpln org get demo-cpln-organization
+-----------------------+-----------------------------------------+----------------------------+----------------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|----------------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
| | | |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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln org patch demo-cpln-organization --file 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln org permissions
+-----------------+-----------------------------------------+------------------------------------------------------------------------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-----------------|-----------------------------------------|------------------------------------------------------------------------------------------------------|
|edit |Modify org |view |
|exec |Grantees can execute all commands on ... |exec.echo |
|exec.echo |Grantees can execute the echo command | |
|grafanaAdmin |Grantees are made Admin in Grafana, o... | |
|manage |Full access |edit, exec, exec.echo, 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
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 |demo-key="demo-value" |
| | | |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 |demo-key="demo-value" |
| | | |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+----------------------+
  • Search for an 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 |demo-key="demo-value" |
| | | |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+----------------------+
  • Search for an 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 |demo-key="demo-value" |
| | | |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) --remove Remove tags (e.g., --remove tagname)

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag
$ cpln org tag demo-cpln-organization --tag drink=water
+-----------------------+-----------------------------------------+----------------------------+----------------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|----------------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
| | | |drink="water" |
| | | |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+----------------------+
  • Update same tag (after running the example above)
$ cpln org tag demo-cpln-organization --tag drink=coffee
+-----------------------+-----------------------------------------+----------------------------+----------------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|----------------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
| | | |drink="coffee" |
| | | |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+----------------------+
  • Remove tag (after running the example above)
$ cpln org tag demo-cpln-organization --remove drink
+-----------------------+-----------------------------------------+----------------------------+----------------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|----------------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
| | | |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"):

copy
description string
tags.&lt;key&gt; 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • The --set option allows the modification of the following 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 |demo-key="demo-value" |
| | | |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+----------------------+
  • Update an organization's description
$ cpln org update demo-cpln-organization --set description="new description"
+-----------------------+-----------------------------------------+----------------------------+----------------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|----------------------|
|demo-cpln-organization |new description |/org/demo-cpln-organization |demo-key="demo-value" |
| | | |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+----------------------+
  • Update an organization's tag
$ cpln org update demo-cpln-organization --set tags.demo-key=demo-value
+-----------------------+-----------------------------------------+----------------------------+----------------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|----------------------|
|demo-cpln-organization |new description |/org/demo-cpln-organization |demo-key="demo-value" |
| | | |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+----------------------+

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln policy access-report demo-policy --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 |
+-----------+--------------------------------------------------------+--------+

policy add-binding

Bind one or more permissions to the referenced policy and associate it with one or more users / service accounts / groups / identities

Usage

copy
cpln policy add-binding <ref> --permission PERMISSION_NAME COMMAND_OPTIONS [OPTIONS]
Reference

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

Command options: --email User email to add permission --serviceaccount Service account name to add permission --group Group name to add permission --identity Identity link to add permission --permission Permission 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Bind the view permission to the referenced policy named `demo-policy-add-binding` and associate it with the built-in controlplane service account
$ cpln policy add-binding demo-policy --permission view --serviceaccount controlplane --org demo-cpln-organization
+------------+-----------------------------------------+--------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|--------------|------------|--------|--------|--------------|
|demo-policy |demo-policy |9 minutes ago |org |all |default |drink="water" |
+------------+-----------------------------------------+--------------+------------+--------+--------+--------------+

policy clone

Clone a policy

Usage

copy
cpln policy 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln policy clone demo-policy --name demo-policy-clone --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------------|-----------------------------------------|--------------|------------|--------|--------|--------------|
|demo-policy-clone |Clone of demo-policy |0 minutes ago |org |all |default |drink="water" |
+------------------+-----------------------------------------+--------------+------------+--------+--------+--------------+

policy create

Create a new policy

Usage

copy
cpln policy create --name POLICY_NAME --target-king TARGET [OPTIONS]
Reference

Command options: --name Name of the new policy, type - to generate a valid name [required] --description, --desc Optional description, defaults to the name if not set --target-kind Select a target kind for this policy [required][choices: "account", "agent", "auditctx", "cloudaccount", "domain", "dbcluster", "group", "gvc", "identity", "image", "location", "memcachecluster", "org", "policy", "quota", "secret", "serviceaccount", "spicedbcluster", "task", "user", "volumeset", "workload"] --all Apply policy to all instances of the kind [boolean] --resource Enumerate resource names to add to the policy --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln policy create --name demo-policy --target-kind org --all --desc demo-policy --tag drink=water --org demo-cpln-organization
+------------+-----------------------------------------+--------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|--------------|------------|--------|--------|--------------|
|demo-policy |demo-policy |0 minutes ago |org |all |default |drink="water" |
+------------+-----------------------------------------+--------------+------------+--------+--------+--------------+

policy delete

Delete one or more referenced policies

Usage

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

Deleting a policy will remove all associated resources (targets, bindings, 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln policy delete demo-policy --org demo-cpln-organization
If the delete was successful, a new command prompt will be shown.

policy edit

Edit the referenced policy, as YAML, within an editor

Usage

copy
cpln policy 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]

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

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

policy eventlog

Show the event log of the referenced policy

Usage

copy
cpln policy eventlog <ref> [OPTIONS]
Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln policy eventlog demo-policy --org demo-cpln-organization
The event log for the referenced policy will be shown.

policy get

Retrieve one or more referenced policies

Usage

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

An empty reference will return all references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all policies
$ cpln policy get --org demo-cpln-organization
+---------------------------+-----------------------------------------+--------------+----------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|---------------------------|-----------------------------------------|--------------|----------------|--------|--------|--------------|
|demo-policy |demo-policy |9 minutes ago |org |all |default |drink="water" |
|demo-policy-get-1 |demo-policy-get-1 |0 minutes ago |org |all |default | |
|demo-policy-get-2 |demo-policy-get-2 |0 minutes ago |org |all |default | |
|superusers-agent |Built-in policy granting full access ... |3 years ago |agent |all |builtin | |
|superusers-auditctx |Built-in policy granting full access ... |3 years ago |auditctx |all |builtin | |
|superusers-cloudaccount |Built-in policy granting full access ... |3 years ago |cloudaccount |all |builtin | |
|superusers-domain |Built-in policy granting full access ... |3 years ago |domain |all |builtin | |
|superusers-group |Built-in policy granting full access ... |3 years ago |group |all |builtin | |
|superusers-gvc |Built-in policy granting full access ... |3 years ago |gvc |all |builtin | |
|superusers-identity |Built-in policy granting full access ... |3 years ago |identity |all |builtin | |
|superusers-image |Built-in policy granting full access ... |3 years ago |image |all |builtin | |
|superusers-location |Built-in policy granting full access ... |3 years ago |location |all |builtin | |
|superusers-memcachecluster |Built-in policy granting full access ... |1 year ago |memcachecluster |all |builtin | |
|superusers-mk8s |Built-in policy granting full access ... |11 months ago |mk8s |all |builtin | |
|superusers-org |Built-in policy granting full access ... |3 years ago |org |all |builtin | |
|superusers-policy |Built-in policy granting full access ... |3 years ago |policy |all |builtin | |
|superusers-quota |Built-in policy granting full access ... |3 years ago |quota |all |builtin | |
|superusers-secret |Built-in policy granting full access ... |3 years ago |secret |all |builtin | |
|superusers-serviceaccount |Built-in policy granting full access ... |3 years ago |serviceaccount |all |builtin | |
|superusers-spicedbcluster |Built-in policy granting full access ... |4 months ago |spicedbcluster |all |builtin | |
|superusers-task |Built-in policy granting full access ... |3 years ago |task |all |builtin | |
|superusers-user |Built-in policy granting full access ... |3 years ago |user |all |builtin | |
|superusers-volumeset |Built-in policy granting full access ... |10 months ago |volumeset |all |builtin | |
|superusers-workload |Built-in policy granting full access ... |3 years ago |workload |all |builtin | |
|viewers-agent |Built-in policy granting read-only ac... |3 years ago |agent |all |builtin | |
|viewers-auditctx |Built-in policy granting read-only ac... |3 years ago |auditctx |all |builtin | |
|viewers-cloudaccount |Built-in policy granting read-only ac... |3 years ago |cloudaccount |all |builtin | |
|viewers-domain |Built-in policy granting read-only ac... |3 years ago |domain |all |builtin | |
|viewers-group |Built-in policy granting read-only ac... |3 years ago |group |all |builtin | |
|viewers-gvc |Built-in policy granting read-only ac... |3 years ago |gvc |all |builtin | |
|viewers-identity |Built-in policy granting read-only ac... |3 years ago |identity |all |builtin | |
|viewers-image |Built-in policy granting read-only ac... |3 years ago |image |all |builtin | |
|viewers-location |Built-in policy granting read-only ac... |3 years ago |location |all |builtin | |
|viewers-memcachecluster |Built-in policy granting read-only ac... |1 year ago |memcachecluster |all |builtin | |
|viewers-mk8s |Built-in policy granting read-only ac... |11 months ago |mk8s |all |builtin | |
|viewers-policy |Built-in policy granting read-only ac... |3 years ago |policy |all |builtin | |
|viewers-quota |Built-in policy granting read-only ac... |3 years ago |quota |all |builtin | |
|viewers-secret |Built-in policy granting read-only ac... |3 years ago |secret |all |builtin | |
|viewers-serviceaccount |Built-in policy granting read-only ac... |3 years ago |serviceaccount |all |builtin | |
|viewers-spicedbcluster |Built-in policy granting read-only ac... |4 months ago |spicedbcluster |all |builtin | |
|viewers-task |Built-in policy granting read-only ac... |3 years ago |task |all |builtin | |
|viewers-user |Built-in policy granting read-only ac... |3 years ago |user |all |builtin | |
|viewers-volumeset |Built-in policy granting read-only ac... |10 months ago |volumeset |all |builtin | |
|viewers-workload |Built-in policy granting read-only ac... |3 years ago |workload |all |builtin | |
+---------------------------+-----------------------------------------+--------------+----------------+--------+--------+--------------+
  • Get one policy
$ cpln policy get demo-policy-get-1 --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+------------+--------+--------+-----+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------------|-----------------------------------------|--------------|------------|--------|--------|-----|
|demo-policy-get-1 |demo-policy-get-1 |0 minutes ago |org |all |default | |
+------------------+-----------------------------------------+--------------+------------+--------+--------+-----+
  • Get multiple policies
$ cpln policy get demo-policy-get-1 demo-policy-get-2 --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+------------+--------+--------+-----+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------------|-----------------------------------------|--------------|------------|--------|--------|-----|
|demo-policy-get-1 |demo-policy-get-1 |0 minutes ago |org |all |default | |
|demo-policy-get-2 |demo-policy-get-2 |0 minutes ago |org |all |default | |
+------------------+-----------------------------------------+--------------+------------+--------+--------+-----+

policy patch

Update the referenced policy's metadata using an input file

Usage

copy
cpln policy 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln policy patch demo-policy --file update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced policy.

policy permissions

Show the grantable permissions for a policy object type

Usage

copy
cpln policy permissions [OPTIONS]
Reference

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln policy permissions --org demo-cpln-organization
+-------+-----------------------------------------+-----------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|-----------------------------------|
|create |Create new policies | |
|delete |Delete existing policies | |
|edit |Modify existing policies |view |
|manage |Full access |create, delete, edit, manage, view |
|view |Read-only view | |
+-------+-----------------------------------------+-----------------------------------+

policy query

Find all the policies based on the given query

Usage

copy
cpln policy 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
NOTE

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

  • Search for a policy based on the name property
$ cpln policy query --match any --prop name=demo-policy --org demo-cpln-organization
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|---------------|------------|--------|--------|--------------|
|demo-policy |demo-policy |10 minutes ago |org |all |default |drink="water" |
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+
  • Search for a policy based on the description property
$ cpln policy query --match any --prop description="demo-policy" --org demo-cpln-organization
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|---------------|------------|--------|--------|--------------|
|demo-policy |demo-policy |10 minutes ago |org |all |default |drink="water" |
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+
  • Search for a policy based on a tag
$ cpln policy query --match any --tag drink=water --org demo-cpln-organization
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|---------------|------------|--------|--------|--------------|
|demo-policy |demo-policy |10 minutes ago |org |all |default |drink="water" |
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+
  • Search for a policy based on a property and tag
$ cpln policy query --match any --prop description="demo-policy" --tag drink=water --org demo-cpln-organization
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|---------------|------------|--------|--------|--------------|
|demo-policy |demo-policy |10 minutes ago |org |all |default |drink="water" |
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+

policy remove-binding

Remove the bindings of one or more permissions from the referenced policy and disassociate it from one or more users / service accounts / groups / identities

Usage

copy
cpln policy remove-permission <ref> --permission PERMISSION_NAME COMMAND_OPTIONS [OPTIONS]
Reference

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

Command options: --email User email to remove permission --serviceaccount Service account name to remove permission --group Group name to remove permission --identity Identity link to remove permission --permission Permission 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Remove the binding of the view permission from the policy named demo-policy and disassociate it with the built-in controlplane service account.
$ cpln policy remove-binding demo-policy --permission manage --serviceaccount controlplane --org demo-cpln-organization
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|---------------|------------|--------|--------|--------------|
|demo-policy |demo-policy |10 minutes ago |org |all |default |drink="water" |
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+

policy tag

Manage the tags belonging to one or more referenced policies

Usage

copy
cpln policy 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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag to a policy
$ cpln policy tag demo-policy-tag-1 --tag drink=water --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------------|-----------------------------------------|--------------|------------|--------|--------|--------------|
|demo-policy-tag-1 |demo-policy-tag-1 |0 minutes ago |org |all |default |drink="water" |
+------------------+-----------------------------------------+--------------+------------+--------+--------+--------------+
  • Update same tag (after running the example above)
$ cpln policy tag demo-policy-tag-1 --tag drink=coffee --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+------------+--------+--------+---------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------------|-----------------------------------------|--------------|------------|--------|--------|---------------|
|demo-policy-tag-1 |demo-policy-tag-1 |0 minutes ago |org |all |default |drink="coffee" |
+------------------+-----------------------------------------+--------------+------------+--------+--------+---------------+
  • Remove tag (after running the example above)
$ cpln policy tag demo-policy-tag-1 --remove drink --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+------------+--------+--------+-----+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------------|-----------------------------------------|--------------|------------|--------|--------|-----|
|demo-policy-tag-1 |demo-policy-tag-1 |0 minutes ago |org |all |default | |
+------------------+-----------------------------------------+--------------+------------+--------+--------+-----+
  • Add same tag to multiple policies
$ cpln policy tag demo-policy-tag-1 demo-policy-tag-2 --tag multiple-policies=true --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+------------+--------+--------+-------------------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------------|-----------------------------------------|--------------|------------|--------|--------|-------------------------|
|demo-policy-tag-1 |demo-policy-tag-1 |0 minutes ago |org |all |default |multiple-policies="true" |
|demo-policy-tag-2 |demo-policy-tag-2 |0 minutes ago |org |all |default |multiple-policies="true" |
+------------------+-----------------------------------------+--------------+------------+--------+--------+-------------------------+
  • Update same tag on multiple policies (after running the example above)
$ cpln policy tag demo-policy-tag-1 demo-policy-tag-2 --tag multiple-policies=demo-policy --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+------------+--------+--------+--------------------------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------------|-----------------------------------------|--------------|------------|--------|--------|--------------------------------|
|demo-policy-tag-1 |demo-policy-tag-1 |0 minutes ago |org |all |default |multiple-policies="demo-policy" |
|demo-policy-tag-2 |demo-policy-tag-2 |0 minutes ago |org |all |default |multiple-policies="demo-policy" |
+------------------+-----------------------------------------+--------------+------------+--------+--------+--------------------------------+
  • Remove same tag from multiple policies (after running the example above)
$ cpln policy tag demo-policy-tag-1 demo-policy-tag-2 --remove multiple-policies --org demo-cpln-organization
+------------------+-----------------------------------------+--------------+------------+--------+--------+-----+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------------|-----------------------------------------|--------------|------------|--------|--------|-----|
|demo-policy-tag-1 |demo-policy-tag-1 |0 minutes ago |org |all |default | |
|demo-policy-tag-2 |demo-policy-tag-2 |0 minutes ago |org |all |default | |
+------------------+-----------------------------------------+--------------+------------+--------+--------+-----+

policy update

Update properties of the referenced policy

Usage

copy
cpln policy 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"):

copy
description string
tags.&lt;key&gt; string
targetLinks string[]
target { 'all' }
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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • The --set option allows the modification of the following policy properties:
    • description
      • Description of the policy
      • Type: string
    • tags
      • Tags (key=value) associated with the policy
      • Type: string
    • targetLinks
      • Array of target links belonging to the policy
      • Type: string
    • target
      • The target of the policy
      • Type: string
      • Allowed values: 'all'
Example
  • For the examples below, the initial policy is configured as:
+------------+-----------------------------------------+--------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|--------------|------------|--------|--------|--------------|
|demo-policy |demo-policy |0 minutes ago |org |all |default |drink="water" |
+------------+-----------------------------------------+--------------+------------+--------+--------+--------------+
  • Update a policy's description
$ cpln policy update demo-policy --set description="new description" --org demo-cpln-organization
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|---------------|------------|--------|--------|--------------|
|demo-policy |new description |10 minutes ago |org |all |default |drink="water" |
+------------+-----------------------------------------+---------------+------------+--------+--------+--------------+
  • Update a policy's tags
$ cpln policy update demo-policy --set tags.demo-key=demo-value --org demo-cpln-organization
+------------+-----------------------------------------+---------------+------------+--------+--------+----------------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|---------------|------------|--------|--------|----------------------|
|demo-policy |new description |10 minutes ago |org |all |default |demo-key="demo-value" |
| | | | | | |drink="water" |
+------------+-----------------------------------------+---------------+------------+--------+--------+----------------------+
  • Add to a policy's target links.
$ cpln policy update demo-policy --set targetLinks+="/org/demo-cpln-organization/gvc/demo-gvc-policy" --org demo-cpln-organization
+------------+-----------------------------------------+---------------+------------+--------+--------+----------------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|---------------|------------|--------|--------|----------------------|
|demo-policy |new description |10 minutes ago |org |all |default |demo-key="demo-value" |
| | | | | | |drink="water" |
+------------+-----------------------------------------+---------------+------------+--------+--------+----------------------+
  • Remove from a policy's target links.
$ cpln policy update demo-policy --set targetLinks-="/org/demo-cpln-organization/gvc/demo-gvc-policy" --org demo-cpln-organization
+------------+-----------------------------------------+---------------+------------+--------+--------+----------------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|---------------|------------|--------|--------|----------------------|
|demo-policy |new description |10 minutes ago |org |all |default |demo-key="demo-value" |
| | | | | | |drink="water" |
+------------+-----------------------------------------+---------------+------------+--------+--------+----------------------+
  • Update a policy's target to all
$ cpln policy update demo-policy --set target=all --org demo-cpln-organization
+------------+-----------------------------------------+---------------+------------+--------+--------+----------------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|-----------------------------------------|---------------|------------|--------|--------|----------------------|
|demo-policy |new description |10 minutes ago |org |all |default |demo-key="demo-value" |
| | | | | | |drink="water" |
+------------+-----------------------------------------+---------------+------------+--------+--------+----------------------+

profile

Manage local profiles

For a detailed overview, please visit the manage CLI profiles guide.

copy
cpln profile [SUBCOMMAND]

Commands: cpln profile delete <profiles...> Delete one or more referenced profiles cpln profile get [profiles...] Retrieve one or more profiles cpln profile login [ref] Create a profile named "default" and launch a browser to begin the interactive login process cpln profile set-default <profile> Set the referenced profile as the default cpln profile token [profile] Show the JWT token of the referenced profile cpln profile update <profile> Manage the referenced profile [aliases: create]

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


profile Subcommands


profile delete

Delete one or more referenced profiles

Usage

copy
cpln profile delete <profiles...> [OPTIONS]
Reference

Positionals: profile One or more profile names to delete

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

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

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

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

Common Options Reference

Example
  • Delete one profile
$ cpln profile delete default
A table showing the profile details will return if the delete was successful. Otherwise, an empty table will be displayed.
  • Delete multiple profiles
$ cpln profile delete demo-profile@example.com default
A table showing the profile details will return if the delete was successful. Otherwise, an empty table will be displayed.

profile get

Retrieve one or more profiles

Usage

copy
cpln profile get [profiles...] [OPTIONS]
NOTE

An empty reference will return all references

Reference

Positionals: profiles One or more profiles to show [array]default: []]

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

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

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

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

Common Options Reference

Example
$ cpln profile get default
+--------+---------------------+--------+-------+-------------------------+----------+----------+-------+-----------+
|PROFILE |EMAIL |DEFAULT |ACTIVE |ENDPOINT |ORG |GVC |OUTPUT |TIMESTAMPS |
|--------|---------------------|--------|-------|-------------------------|----------|----------|-------|-----------|
|default |test-128@example.com |* |* |https://api.test.cpln.io | | |text |age |
+--------+---------------------+--------+-------+-------------------------+----------+----------+-------+-----------+

profile login

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

Usage

copy
cpln profile login [ref] [OPTIONS]
Reference

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

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

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

Common Options Reference

Example
$ cpln profile login
A new browser will open displaying the Control Plane login page.
If the login was successful, the browser will indicate that it can be closed. The CLI will display the login results. Press
Control-C to exit the CLI login.
If the login failed, the browser and be closed and the CLI will return to the command prompt. Run \`cpln profile login\` again to
restart the login.

profile set-default

Set the referenced profile as the default

Usage

copy
cpln profile set-default <profile> [OPTIONS]
Reference

Positionals: profile Profile name to be set as the default [required]

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

Common Options Reference

Example
$ cpln profile set-default demo-profile
The referenced profile will be set as the default for all future executions of the CLI commands.
If the set was successful, the command prompt will return. Otherwise, the error will be shown.

profile token

Show the JWT token of the referenced profile

Usage

copy
cpln profile token [profile] [OPTIONS]
NOTE

An empty reference will return the token for the default profile

Reference

Positionals: profile Profile to retrieve the token for

Command options: --serve Serve token on a local server [boolean] --port Port for the local server [number][default: 43200] --jwt View your jwt for the token server [boolean] --generateToken Generate a new jwt token for the token server [boolean]

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

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

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

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

Common Options Reference

Example
$ cpln profile token demo-profile
A valid JWT token for the referenced profile "demo-profile" will be shown.
Token Server Usage
- 'cpln profile token --serve': Create a server (default port of 43200) instead of outputting the token directly.
This command generates a profile specific token to authenticate against this token server.
- 'cpln profile token --serve --port PORT': Sets the port of the token server.
- 'cpln profile token --jwt': Outputs the token server token for the profile.
- 'cpln profile token --generateToken': Regenerates a token for the profile, for the token server.
An example use case is to integrate the server to a Postman collection. The collection can then make requests to the Control Plane API
without needing to manually copy the token. After the server is running, by executing the 'cpln profile token --serve' command , the user
can utilize the Pre-request script below in Postman:
------------------------
const postRequest = {
url: "http://localhost:" + pm.environment.get("cplnTokenServerPort") + "/" + pm.environment.get("profile") + "/token",
method: 'GET',
header: {
'authorization': "Bearer " + pm.environment.get("cplnTokenServerToken")
},
};
pm.sendRequest(postRequest, (err, response) => {
pm.environment.set("token", response.text());
})
------------------------

profile update

Manage the referenced profile

Usage

copy
cpln profile update <profile> COMMAND_OPTIONS [OPTIONS]
Reference

Positionals: profile Name of the profile to update. If it does not exist, a new profile with that name will be created [required]

Command options: --login Launch a browser to begin the interactive login process using the referenced profile --default Set the given profile as the default --org Set the given organization as the default organization of the referenced profile --gvc Set the given GVC as the default GVC of the referenced profile

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

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

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

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

Common Options Reference

Example
  • Create a new profile
$ cpln profile update new-profile
If the referenced profile name doesn't exist, a new one will be created.
  • Perform an interactive login using a custom profile
$ cpln profile update new-profile --login
A browser will open displaying the Control Plane login page.
If the login was successful, a new profile with the given name will be created
(if it doesn't already exist) and the browser will indicate that it can be closed.
This profile will be marked as the default and used by any future CLI command.
The CLI will display the login results. Press Control-C to exit the CLI login.
If the login failed, the CLI will return to the command prompt.
Run the command again to restart the login flow.
  • Set the referenced profile as the default profile
$ cpln profile update new-profile --default
If the update was successful, the referenced profile will be set as the default for all future cpln commands.
  • Set a default organization and GVC on the referenced profile
$ cpln profile update new-profile --org demo-cpln-organization --gvc demo-gvc
The referenced organization and GVC will be set as the default on the referenced profile.
Any future execution of a cpln command will use those values.

quota

Show quotas

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

copy
cpln quota [SUBCOMMAND]

Commands: cpln quota edit <ref> Edit the referenced quota, as YAML, within an editor cpln quota get [ref...] Retrieve one or more referenced quotas cpln quota patch <ref> Update the referenced quota's metadata using an input file cpln quota permissions Show the grantable permissions for a quota object type cpln quota query Find all the quotas based on the given query

Options: --help Show help [boolean]


quota Subcommands


quota edit

Edit the referenced quota, as YAML, within an editor

Usage

copy
cpln quota 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]

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln quota edit b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

quota get

Retrieve one or more referenced quotas

Usage

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

An empty reference will return all references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all quotas
$ cpln quota get --org demo-cpln-organization
+-------------------------------------+----------------------+-----------------------------------------+--------+--------+-----+----------+----------------------------------+
|ID |NAME |DESCRIPTION |ORIGIN |CURRENT |MAX |UNIT |DIMENSIONS |
|-------------------------------------|----------------------|-----------------------------------------|--------|--------|-----|----------|----------------------------------|
|189a7ef1-d6b5-4496-9bbc-eb933a64cb81 |agents |Max number of agents |builtin |4 |10 |count | |
|263e8e49-db2f-4445-be29-d8021a4e4015 |workloads-per-gvc |Max number of workloads in a gvc |builtin |1 |20 |count |gvcLink="demo-gvc-workload" |
|27acde85-acee-4e4a-a8d7-a00cba61b9a4 |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |5 |count |gvcLink="demo-cpln-gvc" |
|2e5fdd72-ce2d-4fc7-9c99-1a4389137084 |identities-per-gvc |Max number of workload identities in ... |builtin |4 |20 |count |gvcLink="demo-gvc-identity" |
|3319b55b-c307-4240-ba79-f1892c76f70e |memory-per-workload |Max memory per container |builtin |0 |1024 |MiB | |
|3dd4d521-6c5f-44a9-90bd-ae7f25fe2fca |replicas-per-workload |Max replicas per workload |builtin |0 |5 |count | |
|605d0bd8-1263-447c-a925-b5712bd7c5ae |cpu-per-workload |Max CPU per container |builtin |0 |1000 |millicore | |
|60d1b9df-a8be-4825-8313-79e908ba4d7e |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |20 |count |gvcLink="demo-gvc-with-workloads" |
|6d68c00c-7019-4b68-81cd-990ce092ead3 |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |5 |count |gvcLink="test-gvc" |
|96b373be-d7e1-4e5a-b2dd-db4de190c59d |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |5 |count |gvcLink="demo-gvc-get-streams" |
|b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a |gvcs |Max number of gvc's |builtin |10 |20 |count | |
|b4e49406-5671-480e-919c-4ec313949698 |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |3 |count |gvcLink="quick-start-4" |
|ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 |domains |Max number of domains |builtin |2 |20 |count | |
|d2e6bffd-f479-4824-976e-d5037a43a27f |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |5 |count |gvcLink="demo-gvc-logs" |
|e31e22c9-3a7e-4548-bb2c-9467ca820381 |cloudaccounts |Max number of cloudaccounts |builtin |5 |10 |count | |
+-------------------------------------+----------------------+-----------------------------------------+--------+--------+-----+----------+----------------------------------+
  • Get one quota
$ cpln quota get b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --org demo-cpln-organization
+-------------------------------------+-----+-----------------------------------------+--------+--------+----+------+-----------+
|ID |NAME |DESCRIPTION |ORIGIN |CURRENT |MAX |UNIT |DIMENSIONS |
|-------------------------------------|-----|-----------------------------------------|--------|--------|----|------|-----------|
|b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a |gvcs |Max number of gvc's |builtin |10 |20 |count | |
+-------------------------------------+-----+-----------------------------------------+--------+--------+----+------+-----------+
  • Get multiple quotas
$ cpln quota get b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 --org demo-cpln-organization
+-------------------------------------+--------+-----------------------------------------+--------+--------+----+------+-----------+
|ID |NAME |DESCRIPTION |ORIGIN |CURRENT |MAX |UNIT |DIMENSIONS |
|-------------------------------------|--------|-----------------------------------------|--------|--------|----|------|-----------|
|b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a |gvcs |Max number of gvc's |builtin |10 |20 |count | |
|ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 |domains |Max number of domains |builtin |2 |20 |count | |
+-------------------------------------+--------+-----------------------------------------+--------+--------+----+------+-----------+

quota patch

Update the referenced quota's metadata using an input file

Usage

copy
cpln quota 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln quota patch b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --file update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced quota.

quota permissions

Show the grantable permissions for a quota object type

Usage

copy
cpln quota permissions [OPTIONS]
Reference

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln quota permissions --org demo-cpln-organization
+-------+-----------------------------------------+---------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|---------------------------|
|create |Create new quotas | |
|edit |Modify existing quotas |view |
|manage |Full access |create, edit, manage, view |
|view |Read-only access | |
+-------+-----------------------------------------+---------------------------+

quota query

Find all the quotas based on the given query

Usage

copy
cpln quota 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
NOTE

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

  • Search for a quota based on a property named description
$ cpln quota query --match any --prop description="Max number of domains" --org demo-cpln-organization
+-------------------------------------+--------+-----------------------------------------+--------+--------+----+------+-----------+
|ID |NAME |DESCRIPTION |ORIGIN |CURRENT |MAX |UNIT |DIMENSIONS |
|-------------------------------------|--------|-----------------------------------------|--------|--------|----|------|-----------|
|ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 |domains |Max number of domains |builtin |2 |20 |count | |
+-------------------------------------+--------+-----------------------------------------+--------+--------+----+------+-----------+

rest

Submit REST requests against the API

copy
cpln rest [SUBCOMMAND]

Commands: cpln rest create <path> Submit a POST request followed by a GET request against the referenced path cpln rest delete <path> Submit a DELETE request against the referenced path cpln rest edit <path> Launches the default editor with the contents of the referenced path cpln rest get <path> Submit a GET request against the referenced path cpln rest patch <path> Submit a PATCH request against the referenced path cpln rest post <path> Submit a POST request against the referenced path cpln rest put <path> Submit a PUT request against the referenced path

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]


rest Subcommands


rest create

Submit a POST request followed by a GET request against the referenced path

Usage

copy
cpln rest create <path> --file FILE_NAME [OPTIONS]
NOTE

If using the option --file -, press Control-D (or Control-Z if you are using Windows) to submit the request

Reference

Positionals: path Resource path (e.g., /org/test/user/adam) [required]

Command options: --file, -f File to load the request from. Use --file - to enable input from stdin. --header, -H HTTP headers in curl format: "x-header: value" [array]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln rest create /org --file create-org.json
The metadata contained within the JSON file will be performed against the referenced path as a POST request.
If successful, a GET request will be performed on the resource and outputted to stdout.

rest delete

Submit a DELETE request against the referenced path

Usage

copy
cpln rest delete <path> [OPTIONS]
Reference

Positionals: path Resource path (e.g., /org/test/user/adam) [required]

Command options: --header, -H HTTP headers in curl format: "x-header: value" [array]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln rest delete /org/demo-cpln-organization/gvc/demo-gvc
The GVC with the reference \`/org/demo-cpln-organization/gvc/demo-gvc\` will be deleted.

rest edit

Launches the default editor with the contents of the referenced path

Usage

copy
cpln rest edit <path> [OPTIONS]
NOTE

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

Reference

Positionals: path Resource path (e.g., /org/test/user/adam) [required]

Command options: --header, -H HTTP headers in curl format: "x-header: value" [array]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln rest edit /org/demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API as a PATCH request.

rest get

Submit a GET request against the referenced path

Usage

copy
cpln rest get <path> [OPTIONS]
NOTE

An empty reference will return all references

Reference

Positionals: path Resource path (e.g., /org/test/user/adam) [required]

Command options: --header, -H HTTP headers in curl format: "x-header: value" [array]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln rest get /org/demo-cpln-organization
+-----------------------+-----------------------------------------+----------------------------+----------------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|-----------------------------------------|----------------------------|----------------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
| | | |type="demo" |
+-----------------------+-----------------------------------------+----------------------------+----------------------+

rest patch

Submit a PATCH request against the referenced path

Usage

copy
cpln rest patch <path> --file FILE_NAME [OPTIONS]
NOTE

If using the option --file -, press Control-D (or Control-Z if you are using Windows) to submit the request

Reference

Positionals: path Resource path (e.g., /org/test/user/adam) [required]

Command options: --file, -f File to load the request from. Use --file - to enable input from stdin. --header, -H HTTP headers in curl format: "x-header: value" [array]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln rest patch /org/demo-cpln-organization --file update-org.json
The metadata contained within the JSON file will be performed against the referenced path as a PATCH request.

rest post

Submit a POST request against the referenced path

Usage

copy
cpln rest post <path> --file FILE_NAME [OPTIONS]
NOTE

If using the option --file -, press Control-D (or Control-Z if you are using Windows) to submit the request

Reference

Positionals: path Resource path (e.g., /org/test/user/adam) [required]

Command options: --file, -f File to load the request from. Use --file - to enable input from stdin. --header, -H HTTP headers in curl format: "x-header: value" [array]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln rest post /org --file new-org.json
The metadata contained within the JSON file will be performed against the referenced path as a POST request.

rest put

Submit a PUT request against the referenced path

Usage

copy
cpln rest put <path> [OPTIONS]
NOTE

If using the option --file -, press Control-D (or Control-Z if you are using Windows) to submit the request

Reference

Positionals: path Resource path (e.g., /org/test/user/adam) [required]

Command options: --file, -f File to load the request from. Use --file - to enable input from stdin. --header, -H HTTP headers in curl format: "x-header: value" [array]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln rest put /org/demo-cpln-organization --file update-org.json
The metadata contained within the JSON file will be performed against the referenced path as a PUT request.

secret

Manage secrets

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

copy
cpln secret [SUBCOMMAND]

Commands: cpln secret access-report <ref> Show the access report for the referenced secret cpln secret clone <ref> Create a clone of the referenced secret [aliases: copy] cpln secret create-aws Create a new AWS secret cpln secret create-azure-connector Create a new Azure Connector secret cpln secret create-azure-sdk Create a new Azure SDK secret cpln secret create-dictionary Create a new dictionary secret [aliases: create-dict] cpln secret create-docker Create a new Docker secret cpln secret create-ecr Create a new ECR secret cpln secret create-gcp Create a new GCP secret cpln secret create-keypair Create a new KeyPair secret cpln secret create-nats Create a new nats account secret cpln secret create-opaque Create a new opaque secret cpln secret create-tls Create a new TLS secret cpln secret create-userpass Create a new Username/Password secret cpln secret delete <ref...> Delete one or more referenced secrets cpln secret edit <ref> Edit the referenced secret, as YAML, within an editor cpln secret eventlog <ref> Show the event log of the referenced secret [aliases: log] cpln secret get [ref...] Retrieve one or more referenced secrets cpln secret patch <ref> Update the referenced secret's metadata using an input file cpln secret permissions Show the grantable permissions for a secret object type cpln secret query Find all the secrets based on the given query cpln secret reveal [ref] Show the secret in plaintext cpln secret tag <ref...> Manage the tags belonging to one or more referenced secrets cpln secret update <ref> Update properties of the referenced secret

Options: --help Show help [boolean]


secret Subcommands


secret access-report

Show the access report for the referenced secret

Usage

copy
cpln secret access-report <ref> [OPTIONS]
Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln secret access-report demo-secret --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 |
|reveal |/org/demo-cpln-organization/group/superusers |manage |
|reveal |/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 |
+-----------+--------------------------------------------------------+--------+

secret clone

Create a clone of the referenced secret

Usage

copy
cpln secret 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln secret clone demo-secret --name demo-secret-clone --org demo-cpln-organization
+------------------+-----------------------------------------+---------+--------------+--------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------------|-----------------------------------------|---------|--------------|--------------|
|demo-secret-clone |Clone of demo-secret |userpass |0 minutes ago |drink="water" |
+------------------+-----------------------------------------+---------+--------------+--------------+

secret create-aws

Create a new AWS secret

Usage

copy
cpln secret create-aws --name SECRET_NAME --access-key AWS_ACCESS_KEY --secret-key AWS_SECRET_KEY [OPTIONS]
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --access-key AWS access key [required] --secret-key AWS secret key [required] --role-arn AWS role. Optional: Only if using "assumeRole" --external-id AWS IAM Role External Id --external-id AWS IAM Role External Id --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


secret create-azure-connector

Create a new Azure Connector secret

Usage

copy
cpln secret create-azure-connector --name SECRET_NAME --url DEPLOYMENT_URL --code FUNCTION_APP_CODE [OPTIONS]
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --url URL of the azure connector function [required] --code Code of the azure connector function [required] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


secret create-azure-sdk

Create a new Azure SDK secret

Usage

copy
cpln secret create-azure-sdk --name SECRET_NAME [OPTIONS]
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --file, -f Load the secret from a file. The file is usually created using the command az ad sp create-for-rbac [required] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


secret create-dictionary

Create a new dictionary secret

Usage

copy
cpln secret create-dictionary --name SECRET_NAME --entry KEY=VALUE [OPTIONS]
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --entry Add an entry to the dictionary. Use the syntax: key=value [required] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


secret create-docker

Create a new Docker secret

Usage

copy
cpln secret create-docker --name SECRET_NAME --file FILE_NAME
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --file, -f Load the docker config from a file (e.g., ~/.docker/config.json) [required] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


secret create-ecr

Create a new ECR secret

Usage

copy
cpln secret create-ecr --name SECRET_NAME --access-key AWS_ACCESS_KEY --repo ECR_REPO [OPTIONS]
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --access-key AWS access key [required] --secret-key AWS secret key [required] --role-arn AWS role. Optional: Only if using "assumeRole" --repo ECR repository URI (e.g., AWS_ACCOUNT_ID.dkr.ecr.REGION.amazonaws.com/REPO_NAME) [required] --external-id AWS IAM Role External Id --external-id AWS IAM Role External Id --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


secret create-gcp

Create a new GCP secret

Usage

copy
cpln secret create-gcp --name FILE_NAME --file FILE_NAME [OPTIONS]
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --file, -f Load the secret from a file. The file is usually exported from the GCP console [required] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


secret create-keypair

Create a new KeyPair secret

Usage

copy
cpln secret create-keypair --name SECRET_NAME --secret PATH_TO_SECRET_KEY [OPTIONS]
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --secret Path to the secret key file [required] --public Path to the public key file --passphrase Passpharse for the private key --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


secret create-nats

Create a new nats account secret

Usage

copy
cpln secret create-nats --name SECRET_NAME --account-id ACCOUNT_ID --private-key PRIVATE_KEY [OPTIONS]
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --account-id Account Id of the NATS account [required] --private-key Private Key to access the NATS account [required] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


secret create-opaque

Create a new opaque secret

Usage

copy
cpln secret create-opaque --name SECRET_NAME --file FILE_NAME [OPTIONS]
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --file, -f Load the secret content from a file, use - for stdin [required] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


secret create-tls

Create a new TLS secret

Usage

copy
cpln secret create-tls --name SECRET_NAME --key PATH_TO_KEY --cert PATH_TO_CERTIFICATE [OPTIONS]
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --key Path to the private key file in PEM format [required] --cert Path to the certificate file in PEM format [required] --chain Path to the certificate chain file in PEM format --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


secret create-userpass

Create a new Username/Password secret

Usage

copy
cpln secret create-userpass --name SECRET_NAME --username USERNAME --password PASSWORD [OPTIONS]
Reference

Command options: --name Name of the secret [required] --description, --desc Optional description, defaults to the name if not set --username Username [required] --password Password [required] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln secret create-userpass --name demo-secret --username username --password password --desc demo-secret --tag drink=water --org demo-cpln-organization
+------------+-----------------------------------------+---------+--------------+--------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------|-----------------------------------------|---------|--------------|--------------|
|demo-secret |demo-secret |userpass |0 minutes ago |drink="water" |
+------------+-----------------------------------------+---------+--------------+--------------+

secret delete

Delete one or more referenced secrets

Usage

copy
cpln secret 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln secret delete demo-secret --org demo-cpln-organization
If the delete was successful, a new command prompt will be shown.

secret edit

Edit the referenced secret, as YAML, within an editor

Usage

copy
cpln secret edit <ref> [OPTIONS]
NOTE

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

Reference

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

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

secret eventlog

Show the event log of the referenced secret

Usage

copy
cpln secret eventlog <ref> [OPTIONS]
Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln secret eventlog demo-secret --org demo-cpln-organization
The event log for the referenced secret will be shown.

secret get

Retrieve one or more referenced secrets

Usage

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

An empty reference will return all references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all secrets
$ cpln secret get --org demo-cpln-organization
+------------------+-----------------------------------------+----------------+---------------+--------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------------|-----------------------------------------|----------------|---------------|--------------|
|azure-secret |azure-secret |azure-connector |12 minutes ago | |
|demo-secret |demo-secret |userpass |11 minutes ago |drink="water" |
|demo-secret-get-1 |demo-secret-get-1 |userpass |0 minutes ago | |
|demo-secret-get-2 |demo-secret-get-2 |userpass |0 minutes ago | |
+------------------+-----------------------------------------+----------------+---------------+--------------+
  • Get one secret
$ cpln secret get demo-secret-get-1 --org demo-cpln-organization
+------------------+-----------------------------------------+---------+--------------+-----+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------------|-----------------------------------------|---------|--------------|-----|
|demo-secret-get-1 |demo-secret-get-1 |userpass |0 minutes ago | |
+------------------+-----------------------------------------+---------+--------------+-----+
  • Get multiple secrets
$ cpln secret get demo-secret-get-1 demo-secret-get-2 --org demo-cpln-organization
+------------------+-----------------------------------------+---------+--------------+-----+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------------|-----------------------------------------|---------|--------------|-----|
|demo-secret-get-1 |demo-secret-get-1 |userpass |0 minutes ago | |
|demo-secret-get-2 |demo-secret-get-2 |userpass |0 minutes ago | |
+------------------+-----------------------------------------+---------+--------------+-----+

secret patch

Update the referenced secret's metadata using an input file

Usage

copy
cpln secret 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln secret patch demo-secret --file update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced secret.

secret permissions

Show the grantable permissions for a secret object type

Usage

copy
cpln secret permissions [OPTIONS]
Reference

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln secret permissions --org demo-cpln-organization
+-------+-----------------------------------------+------------------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|------------------------------------------------|
|create |Create new secrets | |
|delete |Delete secrets | |
|edit |Modify existing secrets |view, reveal |
|manage |Full access |create, delete, edit, manage, reveal, use, view |
|reveal |Reveal the plaintext of the secret |view |
|use |Refer to this secret from other entit... |view |
|view |Read-only access excluding plaintext | |
+-------+-----------------------------------------+------------------------------------------------+

secret query

Find all the secrets based on the given query

Usage

copy
cpln secret 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
NOTE

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

  • Search for a secret based on the name property
$ cpln secret query --match any --prop name=demo-secret --org demo-cpln-organization
+------------+-----------------------------------------+---------+---------------+--------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------|-----------------------------------------|---------|---------------|--------------|
|demo-secret |demo-secret |userpass |11 minutes ago |drink="water" |
+------------+-----------------------------------------+---------+---------------+--------------+
  • Search for a secret based on the description property
$ cpln secret query --match any --prop description="demo-secret" --org demo-cpln-organization
+------------+-----------------------------------------+---------+---------------+--------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------|-----------------------------------------|---------|---------------|--------------|
|demo-secret |demo-secret |userpass |11 minutes ago |drink="water" |
+------------+-----------------------------------------+---------+---------------+--------------+
  • Search for a secret based on a tag
$ cpln secret query --match any --tag drink=water --org demo-cpln-organization
+------------+-----------------------------------------+---------+---------------+--------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------|-----------------------------------------|---------|---------------|--------------|
|demo-secret |demo-secret |userpass |12 minutes ago |drink="water" |
+------------+-----------------------------------------+---------+---------------+--------------+
  • Search for a secret based on a property and tag
$ cpln secret query --match any --prop description="demo-secret" --tag drink=water --org demo-cpln-organization
+------------+-----------------------------------------+---------+---------------+--------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------|-----------------------------------------|---------|---------------|--------------|
|demo-secret |demo-secret |userpass |12 minutes ago |drink="water" |
+------------+-----------------------------------------+---------+---------------+--------------+

secret reveal

Show the secret in plaintext

Usage

copy
cpln secret reveal [ref] [OPTIONS]
Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Reveal the secret of a UserPass secret
$ cpln secret reveal demo-secret --org demo-cpln-organization
+------------+-----------------------------------------+---------+---------------+--------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------|-----------------------------------------|---------|---------------|--------------|
|demo-secret |demo-secret |userpass |12 minutes ago |drink="water" |
+------------+-----------------------------------------+---------+---------------+--------------+

secret tag

Manage the tags belonging to one or more referenced secrets

Usage

copy
cpln secret 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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag to a secret
$ cpln secret tag demo-secret-tag-1 --tag drink=water --org demo-cpln-organization
+------------------+-----------------------------------------+---------+--------------+--------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------------|-----------------------------------------|---------|--------------|--------------|
|demo-secret-tag-1 |demo-secret-tag-1 |userpass |0 minutes ago |drink="water" |
+------------------+-----------------------------------------+---------+--------------+--------------+
  • Update same tag (after running the example above)
$ cpln secret tag demo-secret-tag-1 --tag drink=coffee --org demo-cpln-organization
+------------------+-----------------------------------------+---------+--------------+---------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------------|-----------------------------------------|---------|--------------|---------------|
|demo-secret-tag-1 |demo-secret-tag-1 |userpass |0 minutes ago |drink="coffee" |
+------------------+-----------------------------------------+---------+--------------+---------------+
  • Remove tag (after running the example above)
$ cpln secret tag demo-secret-tag-1 --remove drink --org demo-cpln-organization
+------------------+-----------------------------------------+---------+--------------+-----+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------------|-----------------------------------------|---------|--------------|-----|
|demo-secret-tag-1 |demo-secret-tag-1 |userpass |0 minutes ago | |
+------------------+-----------------------------------------+---------+--------------+-----+
  • Add same tag to multiple secrets
$ cpln secret tag demo-secret-tag-1 demo-secret-tag-2 --tag multiple-secrets=true --org demo-cpln-organization
+------------------+-----------------------------------------+---------+--------------+------------------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------------|-----------------------------------------|---------|--------------|------------------------|
|demo-secret-tag-1 |demo-secret-tag-1 |userpass |0 minutes ago |multiple-secrets="true" |
|demo-secret-tag-2 |demo-secret-tag-2 |userpass |0 minutes ago |multiple-secrets="true" |
+------------------+-----------------------------------------+---------+--------------+------------------------+
  • Update same tag on multiple secrets (after running the example above)
$ cpln secret tag demo-secret-tag-1 demo-secret-tag-2 --tag multiple-secrets=demo-secret --org demo-cpln-organization
+------------------+-----------------------------------------+---------+--------------+-------------------------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------------|-----------------------------------------|---------|--------------|-------------------------------|
|demo-secret-tag-1 |demo-secret-tag-1 |userpass |0 minutes ago |multiple-secrets="demo-secret" |
|demo-secret-tag-2 |demo-secret-tag-2 |userpass |0 minutes ago |multiple-secrets="demo-secret" |
+------------------+-----------------------------------------+---------+--------------+-------------------------------+
  • Remove same tag from multiple secrets (after running the example above)
$ cpln secret tag demo-secret-tag-1 demo-secret-tag-2 --remove multiple-secrets --org demo-cpln-organization
+------------------+-----------------------------------------+---------+--------------+-----+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|------------------|-----------------------------------------|---------|--------------|-----|
|demo-secret-tag-1 |demo-secret-tag-1 |userpass |0 minutes ago | |
|demo-secret-tag-2 |demo-secret-tag-2 |userpass |0 minutes ago | |
+------------------+-----------------------------------------+---------+--------------+-----+

secret update

Update properties of the referenced secret

Usage

copy
cpln secret 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"):

copy
description string
tags.&lt;key&gt; 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • The --set option allows the modification of the following secret properties:
    • description
      • Description of the secret
      • Type: string
    • tags
      • Tags (key=value) associated with the secret
      • Type: string
    • targetLinks
      • Array of target links belonging to the secret
      • Type: string
    • target
      • The target of the secret
      • Type: string
      • Allowed values: 'all'
Example
  • For the examples below, the initial secret is configured as:
+-------------------+-----------------------------------------+---------+--------------+-----+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|-------------------|-----------------------------------------|---------|--------------|-----|
|demo-secret-update |demo-secret-update |userpass |0 minutes ago | |
+-------------------+-----------------------------------------+---------+--------------+-----+
  • Update a secret's description
$ cpln secret update demo-secret-update --set description="new description" --org demo-cpln-organization
+-------------------+-----------------------------------------+---------+--------------+-----+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|-------------------|-----------------------------------------|---------|--------------|-----|
|demo-secret-update |new description |userpass |0 minutes ago | |
+-------------------+-----------------------------------------+---------+--------------+-----+
  • Update a secret's tag
$ cpln secret update demo-secret-update --set tags.demo-key=demo-value --org demo-cpln-organization
+-------------------+-----------------------------------------+---------+--------------+----------------------+
|NAME |DESCRIPTION |TYPE |CREATED |TAGS |
|-------------------|-----------------------------------------|---------|--------------|----------------------|
|demo-secret-update |new description |userpass |0 minutes ago |demo-key="demo-value" |
+-------------------+-----------------------------------------+---------+--------------+----------------------+

serviceaccount

Manage service accounts

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

copy
cpln serviceaccount [SUBCOMMAND]

Commands: cpln serviceaccount access-report <ref> Show the access report for the referenced service account cpln serviceaccount add-key <ref> Add a key to the reference service account cpln serviceaccount clone <ref> Create a clone of the referenced service account; this will only duplicate its spec. [aliases: copy] cpln serviceaccount create Create a new service account cpln serviceaccount delete <ref...> Delete one or more referenced service accounts cpln serviceaccount edit <ref> Edit the referenced service account, as YAML, within an editor cpln serviceaccount eventlog <ref> Show the event log of the referenced service account [aliases: log] cpln serviceaccount get [ref...] Retrieve one or more referenced service accounts cpln serviceaccount patch <ref> Update the referenced service account's metadata using an input file cpln serviceaccount permissions Show the grantable permissions for a service account object type cpln serviceaccount query Find all the service accounts based on the given query cpln serviceaccount remove-key <ref> Remove a key from the reference service account cpln serviceaccount tag <ref...> Manage the tags belonging to one or more referenced service accounts

Options: --help Show help [boolean]


serviceaccount Subcommands


serviceaccount access-report

Show the access report for the referenced service account

Usage

copy
cpln serviceaccount access-report <ref> [OPTIONS]
Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln serviceaccount access-report demo-service-account --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|addKey |/org/demo-cpln-organization/group/superusers |manage |
|addKey |/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/superusers |manage |
|view |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/viewers |view |
+-----------+--------------------------------------------------------+--------+

serviceaccount add-key

Add a key to the reference service account

Usage

copy
cpln serviceaccount add-key <ref> --description KEY_DESCRIPTION [OPTIONS]
Reference

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

Command options: --description, --desc Short description for the new key [required]

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
NOTE

The 'key' property returned from the add-key command will only be displayed once. There is no way to retrieve the key in the future.

$ cpln serviceaccount add-key demo-service-account --desc demo-key --org demo-cpln-organization
{
"description": "demo-key",
"created": "2024-03-10T18:30:32.320Z",
"key": "sqSijAQHPFcnksa4.ZGVtby1jcGxuLW9yZ2FuaXphdGlvbi5kZW1vLXNlcnZpY2UtYWNjb3VudC5zbzRvZ1FsdVljdmpoa183WVZWRDR0VTZUNlRuQ1VTbEw0OThJSDQ4RklZ.KYYwL8EtVXeBYo4bfRZS-QoNEI1ylTKDxdUKiMqhvHI"
}

serviceaccount clone

Create a clone of the referenced service account; this will only duplicate its spec.

Usage

copy
cpln serviceaccount 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln serviceaccount clone demo-service-account --name demo-service-account-clone --org demo-cpln-organization
+---------------------------+-----------------------------------------+--------------+--------+-----+--------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------------|-----------------------------------------|--------------|--------|-----|--------------|
|demo-service-account-clone |Clone of demo-service-account |0 minutes ago |default | |drink="water" |
+---------------------------+-----------------------------------------+--------------+--------+-----+--------------+

serviceaccount create

Create a new service account

Usage

copy
cpln serviceaccount create --name SERVICE_ACCOUNT_NAME [OPTIONS]
Reference

Command options: --name Name of the new secret [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln serviceaccount create --name demo-service-account --desc demo-service-account --tag drink=water --org demo-cpln-organization
+---------------------+-----------------------------------------+--------------+--------+-----+--------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------|-----------------------------------------|--------------|--------|-----|--------------|
|demo-service-account |demo-service-account |0 minutes ago |default | |drink="water" |
+---------------------+-----------------------------------------+--------------+--------+-----+--------------+

serviceaccount delete

Delete one or more referenced service accounts

Usage

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

Deleting a service account will remove all associated keys

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln serviceaccount delete demo-service-account --org demo-cpln-organization
If the delete was successful, a new command prompt will be shown.

serviceaccount edit

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

Usage

copy
cpln serviceaccount 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]

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln serviceaccount edit demo-service-account --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

serviceaccount eventlog

Show the event log of the referenced service account

Usage

copy
cpln serviceaccount eventlog <ref> [OPTIONS]
Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln serviceaccount eventlog demo-service-account --org demo-cpln-organization
The event log for the referenced service account will be shown.

serviceaccount get

Retrieve one or more referenced service accounts

Usage

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

An empty reference will return all references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all service accounts
$ cpln serviceaccount get --org demo-cpln-organization
+---------------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------------|-----------------------------------------|---------------|--------|-----------------|--------------|
|controlplane |Built-in serviceaccount used by Contr... |3 years ago |builtin | | |
|cpln-user |cpln-user |5 months ago |default |sOajhentlsc226k8 | |
|demo-service-account |demo-service-account |12 minutes ago |default |sqSijAQHPFcnksa4 |drink="water" |
|demo-service-account-get-1 |demo-service-account-get-1 |0 minutes ago |default | | |
|demo-service-account-get-2 |demo-service-account-get-2 |0 minutes ago |default | | |
+---------------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
  • Get one service account
$ cpln serviceaccount get demo-service-account-get-1 --org demo-cpln-organization
+---------------------------+-----------------------------------------+--------------+--------+-----+-----+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------------|-----------------------------------------|--------------|--------|-----|-----|
|demo-service-account-get-1 |demo-service-account-get-1 |0 minutes ago |default | | |
+---------------------------+-----------------------------------------+--------------+--------+-----+-----+
  • Get multiple service accounts
$ cpln serviceaccount get demo-service-account-get-1 demo-service-account-get-2 --org demo-cpln-organization
+---------------------------+-----------------------------------------+--------------+--------+-----+-----+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------------|-----------------------------------------|--------------|--------|-----|-----|
|demo-service-account-get-1 |demo-service-account-get-1 |0 minutes ago |default | | |
|demo-service-account-get-2 |demo-service-account-get-2 |0 minutes ago |default | | |
+---------------------------+-----------------------------------------+--------------+--------+-----+-----+

serviceaccount patch

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

Usage

copy
cpln serviceaccount 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln serviceaccount patch demo-service-account --file update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced service account.

serviceaccount permissions

Show the grantable permissions for a service account object type

Usage

copy
cpln serviceaccount permissions [OPTIONS]
Reference

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln serviceaccount permissions --org demo-cpln-organization
+-------+-----------------------------------------+-------------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|-------------------------------------------|
|addKey |Add key to an existing service account | |
|create |Create new service accounts | |
|delete |Delete service accounts | |
|edit |Modify existing resources |view |
|manage |Full access |addKey, create, delete, edit, manage, view |
|view |Read-only access | |
+-------+-----------------------------------------+-------------------------------------------+

serviceaccount query

Find all the service accounts based on the given query

Usage

copy
cpln serviceaccount 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
NOTE

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

  • Search for a service account based on the name property
$ cpln serviceaccount query --match any --prop name=demo-service-account --org demo-cpln-organization
+---------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------|-----------------------------------------|---------------|--------|-----------------|--------------|
|demo-service-account |demo-service-account |13 minutes ago |default |sqSijAQHPFcnksa4 |drink="water" |
+---------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
  • Search for a service account based on the description property
$ cpln serviceaccount query --match any --prop description="demo-service-account" --org demo-cpln-organization
+---------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------|-----------------------------------------|---------------|--------|-----------------|--------------|
|demo-service-account |demo-service-account |13 minutes ago |default |sqSijAQHPFcnksa4 |drink="water" |
+---------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
  • Search for a service account based on a tag
$ cpln serviceaccount query --match any --tag drink=water --org demo-cpln-organization
+---------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------|-----------------------------------------|---------------|--------|-----------------|--------------|
|demo-service-account |demo-service-account |13 minutes ago |default |sqSijAQHPFcnksa4 |drink="water" |
+---------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
  • Search for a service account based on a property and tag
$ cpln serviceaccount query --match any --prop description="demo-service-account" --tag drink=water --org demo-cpln-organization
+---------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------|-----------------------------------------|---------------|--------|-----------------|--------------|
|demo-service-account |demo-service-account |13 minutes ago |default |sqSijAQHPFcnksa4 |drink="water" |
+---------------------+-----------------------------------------+---------------+--------+-----------------+--------------+

serviceaccount remove-key

Remove a key from the reference service account

Usage

copy
cpln serviceaccount remove-key <ref> --key KEY_TO_REMOVE [OPTIONS]
Reference

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

Command options: --key Name of the key to remove. Can be repeated. [required]

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • For the example below, the created service account key is:
+---------------------+-----------------------------------------+--------------+--------+-----+--------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------|-----------------------------------------|--------------|--------|-----|--------------|
|demo-service-account |demo-service-account |0 minutes ago |default | |drink="water" |
+---------------------+-----------------------------------------+--------------+--------+-----+--------------+
  • Remove key
$ cpln serviceaccount remove-key demo-service-account --key sjwtzyIavWcDXPM8 --org demo-cpln-organization
+---------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------|-----------------------------------------|---------------|--------|-----------------|--------------|
|demo-service-account |demo-service-account |13 minutes ago |default |sqSijAQHPFcnksa4 |drink="water" |
+---------------------+-----------------------------------------+---------------+--------+-----------------+--------------+

serviceaccount tag

Manage the tags belonging to one or more referenced service accounts

Usage

copy
cpln serviceaccount 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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag to a service account
$ cpln serviceaccount tag demo-service-account-tag-1 --tag drink=water --org demo-cpln-organization
+---------------------------+-----------------------------------------+--------------+--------+-----+--------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------------|-----------------------------------------|--------------|--------|-----|--------------|
|demo-service-account-tag-1 |demo-service-account-tag-1 |0 minutes ago |default | |drink="water" |
+---------------------------+-----------------------------------------+--------------+--------+-----+--------------+
  • Update same tag (after running the example above)
$ cpln serviceaccount tag demo-service-account-tag-1 --tag drink=coffee --org demo-cpln-organization
+---------------------------+-----------------------------------------+--------------+--------+-----+---------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------------|-----------------------------------------|--------------|--------|-----|---------------|
|demo-service-account-tag-1 |demo-service-account-tag-1 |0 minutes ago |default | |drink="coffee" |
+---------------------------+-----------------------------------------+--------------+--------+-----+---------------+
  • Remove tag (after running the example above)
$ cpln serviceaccount tag demo-service-account-tag-1 --remove drink --org demo-cpln-organization
+---------------------------+-----------------------------------------+--------------+--------+-----+-----+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------------|-----------------------------------------|--------------|--------|-----|-----|
|demo-service-account-tag-1 |demo-service-account-tag-1 |0 minutes ago |default | | |
+---------------------------+-----------------------------------------+--------------+--------+-----+-----+
  • Add same tag to multiple service accounts
$ cpln serviceaccount tag demo-service-account-tag-1 demo-service-account-tag-2 --tag multiple-serviceaccounts=true --org demo-cpln-organization
+---------------------------+-----------------------------------------+--------------+--------+-----+--------------------------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------------|-----------------------------------------|--------------|--------|-----|--------------------------------|
|demo-service-account-tag-1 |demo-service-account-tag-1 |0 minutes ago |default | |multiple-serviceaccounts="true" |
|demo-service-account-tag-2 |demo-service-account-tag-2 |0 minutes ago |default | |multiple-serviceaccounts="true" |
+---------------------------+-----------------------------------------+--------------+--------+-----+--------------------------------+
  • Update same tag on multiple service accounts (after running the example above)
$ cpln serviceaccount tag demo-service-account-tag-1 demo-service-account-tag-2 --tag multiple-serviceaccounts=demo-serviceaccount --org demo-cpln-organization
+---------------------------+-----------------------------------------+--------------+--------+-----+-----------------------------------------------+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------------|-----------------------------------------|--------------|--------|-----|-----------------------------------------------|
|demo-service-account-tag-1 |demo-service-account-tag-1 |0 minutes ago |default | |multiple-serviceaccounts="demo-serviceaccount" |
|demo-service-account-tag-2 |demo-service-account-tag-2 |0 minutes ago |default | |multiple-serviceaccounts="demo-serviceaccount" |
+---------------------------+-----------------------------------------+--------------+--------+-----+-----------------------------------------------+
  • Remove same tag from multiple service accounts (after running the example above)
$ cpln serviceaccount tag demo-service-account-tag-1 demo-service-account-tag-2 --remove multiple-serviceaccounts --org demo-cpln-organization
+---------------------------+-----------------------------------------+--------------+--------+-----+-----+
|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS |
|---------------------------|-----------------------------------------|--------------|--------|-----|-----|
|demo-service-account-tag-1 |demo-service-account-tag-1 |0 minutes ago |default | | |
|demo-service-account-tag-2 |demo-service-account-tag-2 |0 minutes ago |default | | |
+---------------------------+-----------------------------------------+--------------+--------+-----+-----+

stack

manage docker-compose files

Refer to the Compose Deploy guide for additional details.

copy
cpln stack [SUBCOMMAND]

Commands: cpln stack deploy deploy from a docker-compose file [aliases: up] cpln stack manifest Generate a CPLN apply file from a docker-compose file cpln stack rm Delete objects from a docker-compose file [aliases: down]

Options: --help Show help [boolean]


stack Subcommands


stack deploy

deploy from a docker-compose file

Refer to the compose deploy guide for more details.

Usage

copy
cpln stack deploy [OPTIONS]
Reference

Command options: --directory, --dir Path to parent folder of docker-compose file --compose-file Name of the docker-compose file if alternative naming was used

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Assuming there is a docker compose project in the current directory
$ cpln stack deploy
Created /org/demo-cpln-organization/secret/demo-secret
Created /org/demo-cpln-organization/gvc/demo-cpln-gvc/identity/demo-identity
Created /org/demo-cpln-organization/gvc/demo-cpln-gvc/volumeset/demo-volume
Created /org/demo-cpln-organization/gvc/demo-cpln-gvc/workload/demo-workload
Created /org/demo-cpln-organization/policy/demo-policy

stack manifest

Generate a CPLN spec file from a compose project. Outputs result to stdout. Note: this command will build and push images to CPLN

Usage

copy
cpln stack manifest [OPTIONS]
Reference

Command options: --directory, --dir Path to parent folder of docker-compose file --compose-file Name of the docker-compose file if alternative naming was used

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

Options: --help Show help [boolean]

Common Options Reference

Example
  • Assuming there is a docker compose project in the current directory.
$ cpln stack manifest
copy
kind: secret
name: demo-secret
description: demo-secret
type: opaque
data:
encoding: plain
payload: demo secret
---
kind: identity
name: demo-identity
description: Identity to allow demo-workload to reveal secret
---
kind: volumeset
name: demo-volume
description: demo-volume
spec:
fileSystemType: ext4
initialCapacity: 10
performanceClass: general-purpose-ssd
---
kind: workload
name: demo-workload
description: demo-workload
spec:
type: standard
containers:
- name: demo-workload-container
cpu: 250m
memory: 53Mi
ports:
- number: 3000
image: demo-image:1.0
volumes:
- path: /secrets/secret.txt
uri: 'cpln://secret/demo-secret'
recoveryPolicy: retain
defaultOptions:
capacityAI: false
identityLink: /org/demo-cpln-organization/gvc/demo-cpln-gvc/identity/demo-identity
firewallConfig:
external:
inboundAllowCIDR:
- 0.0.0.0/0
outboundAllowCIDR:
- 0.0.0.0/0
---
kind: policy
name: demo-policy
description: Policy for workloads to reveal demo-secret
bindings:
- permissions:
- reveal
principalLinks:
- /org/demo-cpln-organization/gvc/demo-cpln-gvc/identity/demo-identity
targetKind: secret
targetLinks:
- /org/demo-cpln-organization/secret/demo-secret

stack rm

Delete all resources generated from a docker compose project.

Usage

copy
cpln stack rm [OPTIONS]
Reference

Command options: --directory, --dir Path to parent folder of docker-compose file --compose-file Name of the docker-compose file if alternative naming was used

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Assuming there is a docker compose project in the current directory
$ cpln stack rm
Deleted /org/demo-cpln-organization/secret/demo-secret
Deleted /org/demo-cpln-organization/gvc/demo-cpln-gvc/identity/demo-identity
Deleted /org/demo-cpln-organization/gvc/demo-cpln-gvc/volumeset/demo-volume
Deleted /org/demo-cpln-organization/gvc/demo-cpln-gvc/workload/demo-workload
Deleted /org/demo-cpln-organization/policy/demo-policy

task

Manage pending tasks

copy
cpln task [SUBCOMMAND]

Commands: cpln task complete <ref> Complete the referenced task cpln task delete <ref...> Delete one or more referenced tasks cpln task get [ref...] Retrieve one or more referenced tasks cpln task get-mine [ref...] Retrieve one or more referenced tasks for the current or overridden profile [aliases: mine] cpln task permissions Show the grantable permissions for a task object type cpln task query Find all the tasks based on the given query

Options: --help Show help [boolean]


task Subcommands


task complete

Complete the referenced task

Usage

copy
cpln task complete <ref> --answer {accept|reject} [OPTIONS]
Reference

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

Command options: --answer Accept or reject referenced task [required][choices: "accept", "reject"]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


task delete

Delete one or more referenced tasks

Usage

copy
cpln task 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


task get

Retrieve one or more referenced tasks

Usage

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

An empty reference will return all references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference


task get-mine

Retrieve one or more referenced tasks for the current or overridden profile

Usage

copy
cpln task get-mine [ref...] [OPTIONS]
NOTE

An empty reference will return all tasks for the current or overridden profile

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


task permissions

Show the grantable permissions for a task object type

Usage

copy
cpln task permissions [OPTIONS]
Reference

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln task permissions --org demo-cpln-organization
+-------+-----------------------------------------+---------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|---------------------------|
|delete |Delete/Cancel existing tasks | |
|edit |Modify existing tasks |view |
|manage |Full access |delete, edit, manage, view |
|view |Read-only access | |
+-------+-----------------------------------------+---------------------------+

task query

Find all the tasks based on the given query

Usage

copy
cpln task 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


user

Manage users

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

copy
cpln user [SUBCOMMAND]

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

Options: --help Show help [boolean]


user Subcommands


user access-report

Show the access report for the referenced user

Usage

copy
cpln user access-report <ref> [OPTIONS]
Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln user access-report test-128@example.com --org demo-cpln-organization
+------------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|------------|--------------------------------------------------------|--------|
|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 |
|impersonate |/org/demo-cpln-organization/group/superusers |manage |
|impersonate |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|invite |/org/demo-cpln-organization/group/superusers |manage |
|invite |/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 |
+------------+--------------------------------------------------------+--------+

user delete

Delete one or more referenced users

Usage

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

Deleting a user will remove all associated resources (permissions, group memberships, 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln user delete demo-user@controlplane.com --org demo-cpln-organization
If the delete was successful, a new command prompt will be shown.

user edit

Edit the referenced user, as YAML, within an editor

Usage

copy
cpln user 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]

Command options: --replace, -r Replace instead of patch/merge [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln user edit test-128@example.com --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

user eventlog

Show the event log of the referenced user

Usage

copy
cpln user eventlog <ref> [OPTIONS]
Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln user eventlog test-128@example.com --org demo-cpln-organization
The event log for the referenced user will be shown.

user get

Retrieve one or more referenced users

Usage

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

An empty reference will return all references

Reference

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

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all users
$ cpln user get --org demo-cpln-organization
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
|ID |FULL NAME |EMAIL |CREATED |IDP |TAGS |
|-----------------------------|---------------------|---------------------|------------|---------|-------------------------------------|
|HkKCu6TcHIMB8ON8iXayuKw5oop2 |test-128@example.com |test-128@example.com |3 years ago |firebase |firebase/sign_in_provider="password" |
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
  • Get one user
$ cpln user get test-128@example.com --org demo-cpln-organization
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
|ID |FULL NAME |EMAIL |CREATED |IDP |TAGS |
|-----------------------------|---------------------|---------------------|------------|---------|-------------------------------------|
|HkKCu6TcHIMB8ON8iXayuKw5oop2 |test-128@example.com |test-128@example.com |3 years ago |firebase |firebase/sign_in_provider="password" |
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+

user invite

Invite users to the current or overridden organization

Usage

copy
cpln user invite --email EMAIL_ADDRESS [--group GROUP_NAME] [OPTIONS]
Reference

Command options: --email Email address of the user to invite [required] --group Primary group to add the user to after they accept an invitation

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln user invite --email demo@controlplane.com --org demo-cpln-organization
If the invite request was successful, a JSON output with the task ID will be shown.

user patch

Update the referenced user's metadata using an input file

Usage

copy
cpln user 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln user patch test-128@example.com --file update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced user.

user permissions

Show the grantable permissions for a user object type

Usage

copy
cpln user permissions [OPTIONS]
Reference

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln user permissions --org demo-cpln-organization
+------------+-----------------------------------------+------------------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|------------|-----------------------------------------|------------------------------------------------|
|delete |Delete existing users | |
|edit |Modify existing users |view |
|impersonate |Lets you impersonate a user | |
|invite |Can invite users to this org | |
|manage |Full access |delete, edit, impersonate, invite, manage, view |
|view |Read-only access | |
+------------+-----------------------------------------+------------------------------------------------+

user query

Find all the users based on the given query

Usage

copy
cpln user 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
NOTE

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

  • Search for a user based on a property
$ cpln user query --match any --prop email=test-128@example.com --org demo-cpln-organization
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
|ID |FULL NAME |EMAIL |CREATED |IDP |TAGS |
|-----------------------------|---------------------|---------------------|------------|---------|-------------------------------------|
|HkKCu6TcHIMB8ON8iXayuKw5oop2 |test-128@example.com |test-128@example.com |3 years ago |firebase |firebase/sign_in_provider="password" |
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
  • Search for a user based on a tag
$ cpln user query --match any --tag firebase/sign_in_provider="password" --org demo-cpln-organization
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
|ID |FULL NAME |EMAIL |CREATED |IDP |TAGS |
|-----------------------------|---------------------|---------------------|------------|---------|-------------------------------------|
|HkKCu6TcHIMB8ON8iXayuKw5oop2 |test-128@example.com |test-128@example.com |3 years ago |firebase |firebase/sign_in_provider="password" |
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
  • Search for a user based on a property and tag
$ cpln user query --match any --prop email=test-128@example.com --tag firebase/sign_in_provider="password" --org demo-cpln-organization
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
|ID |FULL NAME |EMAIL |CREATED |IDP |TAGS |
|-----------------------------|---------------------|---------------------|------------|---------|-------------------------------------|
|HkKCu6TcHIMB8ON8iXayuKw5oop2 |test-128@example.com |test-128@example.com |3 years ago |firebase |firebase/sign_in_provider="password" |
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+

user tag

Manage the tags belonging to one or more referenced users

Usage

copy
cpln user 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) --remove Remove tags (e.g., --remove tagname)

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

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

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag
$ cpln user tag test-128@example.com --tag drink=water --org demo-cpln-organization
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
|ID |FULL NAME |EMAIL |CREATED |IDP |TAGS |
|-----------------------------|---------------------|---------------------|------------|---------|-------------------------------------|
|HkKCu6TcHIMB8ON8iXayuKw5oop2 |test-128@example.com |test-128@example.com |3 years ago |firebase |drink="water" |
| | | | | |firebase/sign_in_provider="password" |
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
  • Update same tag (after running the example above)
$ cpln user tag test-128@example.com --tag drink=coffee --org demo-cpln-organization
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
|ID |FULL NAME |EMAIL |CREATED |IDP |TAGS |
|-----------------------------|---------------------|---------------------|------------|---------|-------------------------------------|
|HkKCu6TcHIMB8ON8iXayuKw5oop2 |test-128@example.com |test-128@example.com |3 years ago |firebase |drink="coffee" |
| | | | | |firebase/sign_in_provider="password" |
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
  • Remove tag (after running the example above)
$ cpln user tag test-128@example.com --remove drink --org demo-cpln-organization
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
|ID |FULL NAME |EMAIL |CREATED |IDP |TAGS |
|-----------------------------|---------------------|---------------------|------------|---------|-------------------------------------|
|HkKCu6TcHIMB8ON8iXayuKw5oop2 |test-128@example.com |test-128@example.com |3 years ago |firebase |firebase/sign_in_provider="password" |
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+

user update

Update properties of the referenced user

Usage

copy
cpln user 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"):

copy
tags.&lt;key&gt; 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • The --set option allows the modification of the following user properties:
    • description
      • Description of the user
      • Type: string
    • tags
      • Tags (key=value) associated with the user
      • Type: string
Example
  • For the examples below, the initial user is configured as:
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
|ID |FULL NAME |EMAIL |CREATED |IDP |TAGS |
|-----------------------------|---------------------|---------------------|------------|---------|-------------------------------------|
|HkKCu6TcHIMB8ON8iXayuKw5oop2 |test-128@example.com |test-128@example.com |3 years ago |firebase |firebase/sign_in_provider="password" |
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
  • Update a user's tag
$ cpln user update test-128@example.com --set tags.user-name="test-128" --org demo-cpln-organization
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
|ID |FULL NAME |EMAIL |CREATED |IDP |TAGS |
|-----------------------------|---------------------|---------------------|------------|---------|-------------------------------------|
|HkKCu6TcHIMB8ON8iXayuKw5oop2 |test-128@example.com |test-128@example.com |3 years ago |firebase |firebase/sign_in_provider="password" |
| | | | | |user-name="test-128" |
+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+

volumeset

Manage a persistent volumeset within a global virtual cloud

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

copy
cpln volumeset [SUBCOMMAND]

Commands: cpln volumeset access-report <ref> Show the access report for the referenced volume set cpln volumeset clone <ref> Create a clone of the referenced volume set; this will only duplicate its spec. [aliases: copy] cpln volumeset create Create a new volume set cpln volumeset delete <ref...> Delete one or more referenced volume sets cpln volumeset edit <ref> Edit the referenced volume set, as YAML, within an editor cpln volumeset eventlog <ref> Show the event log of the referenced volume set [aliases: log] cpln volumeset expand <ref> Expand the size of one or more volumes in the referenced volume set cpln volumeset get [ref...] Retrieve one or more referenced volume sets cpln volumeset patch <ref> Update the referenced volume set's metadata using an input file cpln volumeset permissions Show the grantable permissions for a volume set object type cpln volumeset query Find all the volume sets based on the given query cpln volumeset snapshot Manage volume set snapshots cpln volumeset tag <ref...> Manage the tags belonging to one or more referenced volume sets cpln volumeset update <ref> Update properties of the referenced volume set

Options: --help Show help [boolean]


volumeset Subcommands


volumeset access-report

Show the access report for the referenced volume set

Usage

copy
cpln volumeset 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset clone

Create a clone of the referenced volume set; this will only duplicate its spec.

Usage

copy
cpln volumeset 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 --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset create

Create a new volume set

Usage

copy
cpln volumeset create --name NAME [OPTIONS]
Reference

Command options: --name Name of the new volume set [required] --description, --desc Optional description, defaults to the name if not set --performance-class Performance class of the volume set [choices: "general-purpose-ssd", "premium-low-latency-ssd"][default: "general-purpose-ssd"] --file-system-type File system [choices: "xfs", "ext4"][default: "xfs"] --initial-capacity Initial capacity in GB [number][default: 10] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset delete

Delete one or more referenced volume sets

Usage

copy
cpln volumeset 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset edit

Edit the referenced volume set, as YAML, within an editor

Usage

copy
cpln volumeset 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]

Command options: --replace, -r Replace instead of patch/merge [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 --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset eventlog

Show the event log of the referenced volume set

Usage

copy
cpln volumeset 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset expand

Expand the size of one or more volumes in the referenced volume set

Usage

copy
cpln volumeset expand <ref> [OPTIONS]
Reference

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

Command options: --new-size The new storage capacity of the volume in GiB [number][required] --location A global virtual cloud location [string] --volume-index The index of the volume of which a snapshot should be taken [number]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset get

Retrieve one or more referenced volume sets

Usage

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

An empty reference will return all references

Reference

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

Context options: --profile Override the profile. The default profile can be set using the cpln profile set-default command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the cpln profile update command --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Command options: --all-gvcs Show volume sets from all the global virtual clouds within the current or overridden organization [boolean]

Options: --help Show help [boolean]

Common Options Reference


volumeset patch

Update the referenced volume set's metadata using an input file

Usage

copy
cpln volumeset 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset permissions

Show the grantable permissions for a volume set object type

Usage

copy
cpln volumeset 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset query

Find all the volume sets based on the given query

Usage

copy
cpln volumeset 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset snapshot

Manage volume set snapshots

copy
cpln volumeset snapshot [SUBCOMMAND]

Commands: cpln volumeset snapshot create <ref> Create one or more snapshots by a volume set reference cpln volumeset snapshot delete <ref> Delete one or more snapshots by a volume set reference cpln volumeset snapshot get <ref> Retrieve one or more snapshots by a volume set reference cpln volumeset snapshot restore <ref> Restore a snapshot to a volume

Options: --help Show help [boolean]


snapshot Subcommands


volumeset snapshot create

Create one or more snapshots by a volume set reference

Usage

copy
cpln volumeset snapshot create <ref> [OPTIONS]
Reference

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

Command options: --snapshot-name Name of the snapshot [string][required] --location A global virtual cloud location [string] --volume-index The index of the volume of which a snapshot should be taken [number] --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset snapshot delete

Delete one or more snapshots by a volume set reference

Usage

copy
cpln volumeset snapshot delete <ref> [OPTIONS]
Reference

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

Command options: --snapshot-name Name of the snapshot [string][required] --location A global virtual cloud location [string] --volume-index The index of the volume of which a snapshot should be taken [number]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset snapshot get

Retrieve one or more snapshots by a volume set reference

Usage

copy
cpln volumeset snapshot get <ref> [OPTIONS]
Reference

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

Command options: --snapshot-name Name of the snapshot [string] --location A global virtual cloud location [string] --volume-index The index of the volume of which a snapshot should be taken [number]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset snapshot restore

Restore a snapshot to a volume

Usage

copy
cpln volumeset snapshot restore <ref> [OPTIONS]
Reference

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

Command options: --snapshot-name Name of the snapshot [string][required] --location A global virtual cloud location [string][required] --volume-index The index of the volume of which a snapshot should be taken [number][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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset tag

Manage the tags belonging to one or more referenced volume sets

Usage

copy
cpln volumeset 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) --remove Remove tags (e.g., --remove tagname)

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


volumeset update

Update properties of the referenced volume set

Usage

copy
cpln volumeset 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"):

copy
description string
tags.&lt;key&gt; string
spec.initialCapacity number
spec.performanceClass { 'general-purpose-ssd' | 'premium-low-latency-ssd' }
spec.fileSystemType { 'xfs' | 'ext4' } [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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


workload

Manage workloads within a global virtual cloud

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

copy
cpln workload [SUBCOMMAND]

Commands: cpln workload access-report <ref> Show the access report for the referenced workload cpln workload clone <ref> Create a clone of the referenced workload; this will only duplicate its spec. [aliases: copy] cpln workload connect <ref> Connect to a replica of the workload cpln workload create Create a new workload cpln workload cron Manage cron workloads cpln workload delete <ref...> Delete one or more referenced workloads cpln workload edit <ref> Edit the referenced workload, as YAML, within an editor cpln workload eventlog <ref> Show the event log of the referenced workload [aliases: log] cpln workload exec <ref> Exec a command on a replica of the workload cpln workload force-redeployment <ref...> Force redeployment of the workload(s) cpln workload get [ref...] Retrieve one or more referenced workloads cpln workload get-deployments <ref> Retrieve the current deployments of the referenced workload cpln workload get-replicas <ref> Get the replicas of the referenced workload in a given location [deprecated: This subcommand is deprecated, use 'replica get' instead.] cpln workload open <ref> Open the referenced workload's endpoint in your browser cpln workload patch <ref> Update the referenced workload's metadata using an input file cpln workload permissions Show the grantable permissions for a workload object type cpln workload query Find all the workloads based on the given query cpln workload replica Manage workload replicas cpln workload run Run a command with a workload instance cpln workload start <ref...> Start the workload(s) cpln workload stop <ref...> Stop the workload(s) cpln workload tag <ref...> Manage the tags belonging to one or more referenced workloads cpln workload update <ref> Update properties of the referenced workload

Options: --help Show help [boolean]


workload Subcommands


workload access-report

Show the access report for the referenced workload

Usage

copy
cpln workload 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Display the user / service account / group permissions for the 'demo-workload' workload withing the 'demo-cpln-gvc' global virtual cloud within the 'demo-cpln-organization' organization
$ cpln workload access-report demo-workload --org demo-cpln-organization --gvc demo-gvc-workload
+---------------------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|---------------------|--------------------------------------------------------|--------|
|connect |/org/demo-cpln-organization/group/superusers |manage |
|connect |/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 |
|exec |/org/demo-cpln-organization/group/superusers |manage |
|exec |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|exec.runCronWorkload |/org/demo-cpln-organization/group/superusers |manage |
|exec.runCronWorkload |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|exec.stopReplica |/org/demo-cpln-organization/group/superusers |manage |
|exec.stopReplica |/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 |
+---------------------+--------------------------------------------------------+--------+

workload clone

Create a clone of the referenced workload; this will only duplicate its spec.

Usage

copy
cpln workload 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 --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln workload clone demo-workload --name demo-workload-clone --org demo-cpln-organization --gvc demo-gvc-workload
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+--------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------------|-----------------------------------------|------------------|----------|--------------|-----------------------------------------------------|--------------|
|demo-workload-clone |Clone of demo-workload |demo-gvc-workload | |0 minutes ago |https://demo-workload-clone-x08pdgjs9hhjj.t.cpln.app |drink="water" |
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+--------------+

workload connect

Connect to a replica of the workload

If multiple replicas are running, use the --replica flag to specify the replica. Use the subcommand get-replicas to view the current list of replicas.

Refer to the cpln workload connect guide for additional details.

Usage

copy
cpln workload connect <ref> --location LOCATION [OPTIONS]
Reference

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

Command options: --location A global virtual cloud location [string] --replica Replica of the deployment --container Container name of the workload --shell, -s Shell to open on replica [default: "bash"]

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


workload create

Create a new workload

Usage

copy
cpln workload create --name WORKLOAD_NAME --image IMAGE_NAME [OPTIONS]
TIP

When creating a new workload and the image was pushed to your org's private repository, use the image name shortcut //image/IMAGE_NAME.

For Example: cpln workload create --name WORKLOAD_NAME --image //image/IMAGE_NAME

Reference

Command options: --name Name of the new workload [required] --description, --desc Optional description, defaults to the name if not set --type Workload type [choices: "serverless", "standard"][default: "serverless"] --image Name of the container image [required] --port Port to expose [number][default: 8080] --env Environment variables in KEY=VALUE format --public Unconstrained ingress & egress for the workload [boolean] --identity Attach the named identity to the workload spec --enable-debug Enables debug response headers when the headers "x-cpln-debug: true" is in the request. [boolean][default: false] --inherit-env Inherits the environment variables set at GVC level. [boolean][default: false] --container-name Name of the container item --cpu Allocate CPU resources [default: "50m"] --memory, --mem Allocate Memory [default: "128Mi"] --volume Mount Object Store (S3, GCS, AzureBlob) buckets as file system. E.g. s3://backups@/mnt/storage --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • name
    • Type: string
    • Minimum Length: 3
    • Maximum Length: 64
    • Only lowercase characters
    • Must begin with a character
    • Allowed special characters: -
  • image
    • Type: string
  • port
    • Type: number
    • Default: 8080
    • Minimum Value: 80
    • Maximum Value: 65535
  • cpu
    • Type: string
    • Default: 150m
  • memory
    • Type: string
    • Default: 128Mi

NOTE: The ratio between CPU to Memory can be at most 1/8.

Example
$ cpln workload create --name demo-workload --image gcr.io/knative-samples/helloworld-go --desc demo-workload --tag drink=water --org demo-cpln-organization --gvc demo-gvc-workload
+--------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------+--------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------|-----------------------------------------|------------------|----------|--------------|-----------------------------------------------|--------------|
|demo-workload |demo-workload |demo-gvc-workload | |0 minutes ago |https://demo-workload-x08pdgjs9hhjj.t.cpln.app |drink="water" |
+--------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------+--------------+

workload cron

Manage cron workloads

copy
cpln workload cron [SUBCOMMAND]

Commands: cpln workload cron get <ref> Get a list of job executions for the referenced workload cpln workload cron start <ref> Start a cron job

Options: --help Show help [boolean]


cron Subcommands


workload cron get

Get a list of job executions for the referenced workload

Usage

copy
cpln workload cron get <ref> [OPTIONS]
Reference

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

Command options: --location A global virtual cloud location [string]

Context options: --profile Override the profile. The default profile can be set using the cpln profile set-default command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the cpln profile update command --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


workload cron start

Start a cron job

Usage

copy
cpln workload cron start <ref> [OPTIONS]
Reference

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

Command options: --location A global virtual cloud location [string] --container-name Name of the container [string] --env One or more environment variables in KEY=VALUE format [string] --command Override the entrypoint [string] --arg One or more custom command line argument that will be sent to the container [string] --file, -f File to load and use for the command. Use --file - to enable input from stdin.

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


workload delete

Delete one or more referenced workloads

Usage

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

Deleting a workload will remove all associated resources (containers, 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 --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Delete a workload
$ cpln cpln workload delete demo-workload-1 --org demo-cpln-organization --gvc demo-gvc-workload
If the delete was successful, a new command prompt will be shown.
  • Delete multiple workloads
$ cpln workload delete demo-workload-1 demo-workload-2 --org demo-cpln-organization --gvc demo-gvc-workload
If the delete was successful, a new command prompt will be shown.

workload edit

Edit the referenced workload, as YAML, within an editor

Usage

copy
cpln workload 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]

Command options: --replace, -r Replace instead of patch/merge [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 --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln workload edit demo-workload --org demo-cpln-organization --gvc demo-gvc-workload
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.

workload eventlog

Show the event log of the referenced workload

Usage

copy
cpln workload 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln workload eventlog demo-workload --org demo-cpln-organization --gvc demo-gvc-workload
The event log for the referenced workload will be shown.

workload exec

Exec a command on a replica of the workload.

Refer to the cpln workload exec guide for additional details.

Usage

copy
cpln workload exec <ref> --location LOCATION -- COMMAND ARG1 ARG2 [OPTIONS]
Reference

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

Command options: --location A global virtual cloud location [string] --replica Replica of the deployment --container Container name of the workload -- Command to execute on replica

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Execute a command
copy
cpln workload exec index --location aws-eu-central-1 -- ls /etc | grep group

workload force-redeployment

Force redeployment of the referenced workload(s).

Usage

copy
cpln workload force-redeployment <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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


workload get

Retrieve one or more referenced workloads

Usage

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

An empty reference will return all references

Reference

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

Context options: --profile Override the profile. The default profile can be set using the cpln profile set-default command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the cpln profile update command --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Command options: --all-gvcs Show workloads from all the global virtual clouds within the current or overridden organization [boolean]

Options: --help Show help [boolean]

Common Options Reference

Example
  • Get all workloads
$ cpln workload get --org demo-cpln-organization --gvc demo-gvc-workload
+--------------------+-----------------------------------------+------------------+------+---------------+-----------------------------------------------------+--------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------------|-----------------------------------------|------------------|------|---------------|-----------------------------------------------------|--------------|
|demo-workload |demo-workload |demo-gvc-workload |true |15 minutes ago |https://demo-workload-x08pdgjs9hhjj.t.cpln.app |drink="water" |
|demo-workload-get-1 |demo-workload-get-1 |demo-gvc-workload |false |0 minutes ago |https://demo-workload-get-1-x08pdgjs9hhjj.t.cpln.app | |
|demo-workload-get-2 |demo-workload-get-2 |demo-gvc-workload |false |0 minutes ago |https://demo-workload-get-2-x08pdgjs9hhjj.t.cpln.app | |
+--------------------+-----------------------------------------+------------------+------+---------------+-----------------------------------------------------+--------------+
  • Get one workload
$ cpln workload get demo-workload-get-1 --org demo-cpln-organization --gvc demo-gvc-workload
+--------------------+-----------------------------------------+------------------+------+--------------+-----------------------------------------------------+-----+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------------|-----------------------------------------|------------------|------|--------------|-----------------------------------------------------|-----|
|demo-workload-get-1 |demo-workload-get-1 |demo-gvc-workload |false |0 minutes ago |https://demo-workload-get-1-x08pdgjs9hhjj.t.cpln.app | |
+--------------------+-----------------------------------------+------------------+------+--------------+-----------------------------------------------------+-----+
  • Get multiple workloads
$ cpln workload get demo-workload-get-1 demo-workload-get-2 --org demo-cpln-organization --gvc demo-gvc-workload
+--------------------+-----------------------------------------+------------------+------+--------------+-----------------------------------------------------+-----+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------------|-----------------------------------------|------------------|------|--------------|-----------------------------------------------------|-----|
|demo-workload-get-1 |demo-workload-get-1 |demo-gvc-workload |false |0 minutes ago |https://demo-workload-get-1-x08pdgjs9hhjj.t.cpln.app | |
|demo-workload-get-2 |demo-workload-get-2 |demo-gvc-workload |false |0 minutes ago |https://demo-workload-get-2-x08pdgjs9hhjj.t.cpln.app | |
+--------------------+-----------------------------------------+------------------+------+--------------+-----------------------------------------------------+-----+

workload get-deployments

Retrieve the current deployments of the referenced workload

Usage

copy
cpln workload get-deployments <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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln workload get-deployments demo-workload-get-deployments --gvc demo-gvc-get-deployments --org demo-cpln-organization
+-----------------+--------------+---------------------------------------------------------------------------------+
|NAME/LOCATION |MODIFIED |STATUS |
|-----------------|--------------|---------------------------------------------------------------------------------|
|aws-eu-central-1 |0 minutes ago |endpoint="https://demo-workload-get-deployments-dta8cb6daad8a.aws-eu-central-... |
| | |expectedDeploymentVersion=2 |
| | |internal={"podStatus":{},"podsValidZone":true,"timestamp":"2024-02-29T22:04:0... |
| | |lastProcessedVersion=2 |
| | |message="" |
| | |ready=true |
| | |message="" |
| | |ready=true |
| | |remote="https://a4e2dc319c383ac09ceeed0475a71f33.remote.cpln.io" |
| | |versions=[{"message":"Replica(s) Initializing...","ready":true,"containers":{... |
| | |versions=[{"message":"Replica(s) Initializing...","ready":true,"containers":{... |
+-----------------+--------------+---------------------------------------------------------------------------------+

workload get-replicas

Get the replicas of the referenced workload in a given location

Usage

copy
cpln workload get-replicas <ref> --location LOCATION [OPTIONS]
Reference

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

Command options: --location A global virtual cloud location [string]

Context options: --profile Override the profile. The default profile can be set using the cpln profile set-default command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the cpln profile update command --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln workload get-replicas demo-workload --location aws-eu-central-1 --gvc demo-gvc --org demo-cpln-organization
+-----------------------------------------------+
|REPLICA |
|-----------------------------------------------|
|demo-workload-00118-deployment-655f87bffb-nmxxr|
+-----------------------------------------------+

workload open

Open the referenced workload's endpoint in your browser

Usage

copy
cpln workload open <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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Open the endpoint of the referenced workload
$ cpln workload open demo-workload --gvc demo-gvc --org $2
The endpoint for this workload will be opened in the default browser

workload patch

Update the referenced workload's metadata using an input file

Usage

copy
cpln workload 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln workload patch demo-workload --file workload-update.json --org $2
The changes within the JSON file will be performed against the referenced workload.

To update the workload options (i.e., Capacity AI, Scaling Strategy) using the CLI, use the example below to pipe the updated JSON or YAML text to the patch command:

echo '{"spec": {"defaultOptions": {"autoscaling": {"metric": "cpu", "target": 90}, "capacityAI": false}}}' | cpln workload patch WORKLOAD_NAME --f - --org ORG_NAME --gvc GVC_NAME

workload permissions

Show the grantable permissions for a workload object type

Usage

copy
cpln workload 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
$ cpln workload permissions --org demo-cpln-organization --gvc demo-gvc-workload
+---------------------+-----------------------------------------+------------------------------------------------------------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|---------------------|-----------------------------------------|------------------------------------------------------------------------------------------|
|connect |Connect to replica (open an interacti... | |
|create |Create new workloads | |
|delete |Delete existing workloads | |
|edit |Modify existing workloads |view |
|exec |Execute commands |exec.runCronWorkload, exec.stopReplica |
|exec.runCronWorkload |Force a cron-workload to run | |
|exec.stopReplica |Force a replica to be stopped | |
|manage |Full access |connect, create, delete, edit, exec, exec.runCronWorkload, exec.stopReplica, manage, view |
|view |Read-only access | |
+---------------------+-----------------------------------------+------------------------------------------------------------------------------------------+

workload query

Find all the workloads based on the given query

Usage

copy
cpln workload 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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
NOTE

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

  • Search for a workload based on the name property
$ cpln workload query --match any --prop name=demo-workload --org demo-cpln-organization --gvc demo-gvc-workload
+--------------+-----------------------------------------+------------------+----------+---------------+-----------------------------------------------+--------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------|-----------------------------------------|------------------|----------|---------------|-----------------------------------------------|--------------|
|demo-workload |demo-workload |demo-gvc-workload | |15 minutes ago |https://demo-workload-x08pdgjs9hhjj.t.cpln.app |drink="water" |
+--------------+-----------------------------------------+------------------+----------+---------------+-----------------------------------------------+--------------+
  • Search for a workload based on the description property
$ cpln workload query --match any --prop description="demo-workload" --org demo-cpln-organization --gvc demo-gvc-workload
+--------------+-----------------------------------------+------------------+----------+---------------+-----------------------------------------------+--------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------|-----------------------------------------|------------------|----------|---------------|-----------------------------------------------|--------------|
|demo-workload |demo-workload |demo-gvc-workload | |15 minutes ago |https://demo-workload-x08pdgjs9hhjj.t.cpln.app |drink="water" |
+--------------+-----------------------------------------+------------------+----------+---------------+-----------------------------------------------+--------------+
  • Search for a workload based on a tag
$ cpln workload query --match any --tag drink=water --org demo-cpln-organization --gvc demo-gvc-workload
+--------------+-----------------------------------------+------------------+----------+---------------+-----------------------------------------------+--------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------|-----------------------------------------|------------------|----------|---------------|-----------------------------------------------|--------------|
|demo-workload |demo-workload |demo-gvc-workload | |15 minutes ago |https://demo-workload-x08pdgjs9hhjj.t.cpln.app |drink="water" |
+--------------+-----------------------------------------+------------------+----------+---------------+-----------------------------------------------+--------------+
  • Search for a workload based on a property and tag
$ cpln workload query --match any --prop description="demo-workload" --tag drink=water --org demo-cpln-organization --gvc demo-gvc-workload
+--------------+-----------------------------------------+------------------+----------+---------------+-----------------------------------------------+--------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------|-----------------------------------------|------------------|----------|---------------|-----------------------------------------------|--------------|
|demo-workload |demo-workload |demo-gvc-workload | |15 minutes ago |https://demo-workload-x08pdgjs9hhjj.t.cpln.app |drink="water" |
+--------------+-----------------------------------------+------------------+----------+---------------+-----------------------------------------------+--------------+

workload replica

Manage workload replicas

copy
cpln workload replica [SUBCOMMAND]

Commands: cpln workload replica get <ref> Get the replica of the referenced workload in a given location

Options: --help Show help [boolean]


replica Subcommands


workload replica get

Get the replica of the referenced workload in a given location

Usage

copy
cpln workload replica get <ref> [OPTIONS]
Reference

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

Command options: --replica-name Name of the replica [string] --location A global virtual cloud location [string]

Context options: --profile Override the profile. The default profile can be set using the cpln profile set-default command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the cpln profile update command --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference


workload run

Run a command with a workload instance.

Refer to the cpln workload run guide for additional details.

NOTE

Most basic usage is cpln workload run -- ls -al.

This will create a new workload to execute the command, it uses an ubuntu base image.

Other examples are:

If you have a workload you want to reuse: cpln workload run --clone WORKLOAD_NAME -- ls -al

-- <command>: Must always be at the end.

Optional flags:

--rm: To clean up afterwards.

-i: To connect to the session.

--cpu and --mem: To override the default resources.

--location: To override the location. (By default the first location fetched from your gvc).

Usage

copy
cpln workload run -- COMMAND [OPTIONS]
Reference

Command options: --clone Clone a workload --tag Attach tags (e.g., --tag drink=water) --image Override image --interactive, -i Make the session interactive [boolean][default: false] --remove, --rm Deletes the workload after the command is run [boolean][default: false] --cpu Set allocated CPU for the main container --memory, --mem Set allocated memory for the main container --env Environment variables in KEY=VALUE format --command, -c Container command --arg, -a Container args --shell, -s Shell to use, only valid when interactive flag is true [default: "bash"] --location Location to run the command --container Which container to run the command in, only used when "clone" option is used -- Command to execute on replica

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
copy
cpln workload run --org demo-cpln-organization --gvc demo-gvc -- ls -al

workload start

Start the workload(s)

Usage

copy
cpln workload start <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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
copy
cpln workload start demo-workload --org demo-cpln-organization --gvc demo-gvc

workload stop

Stop the workload(s)

Usage

copy
cpln workload stop <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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
copy
cpln workload stop demo-workload --org demo-cpln-organization --gvc demo-gvc

workload tag

Manage the tags belonging to one or more referenced workloads

Usage

copy
cpln workload 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) --remove Remove tags (e.g., --remove tagname)

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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Example
  • Add a tag to a workload
$ cpln workload tag demo-workload-tag-1 --tag drink=water --org demo-cpln-organization --gvc demo-gvc-workload
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+--------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------------|-----------------------------------------|------------------|----------|--------------|-----------------------------------------------------|--------------|
|demo-workload-tag-1 |demo-workload-tag-1 |demo-gvc-workload | |0 minutes ago |https://demo-workload-tag-1-x08pdgjs9hhjj.t.cpln.app |drink="water" |
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+--------------+
  • Update same tag (after running the example above)
$ cpln workload tag demo-workload-tag-1 --tag drink=coffee --org demo-cpln-organization --gvc demo-gvc-workload
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+---------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------------|-----------------------------------------|------------------|----------|--------------|-----------------------------------------------------|---------------|
|demo-workload-tag-1 |demo-workload-tag-1 |demo-gvc-workload | |0 minutes ago |https://demo-workload-tag-1-x08pdgjs9hhjj.t.cpln.app |drink="coffee" |
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+---------------+
  • Remove tag (after running the example above)
$ cpln workload tag demo-workload-tag-1 --remove drink --org demo-cpln-organization --gvc demo-gvc-workload
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+-----+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------------|-----------------------------------------|------------------|----------|--------------|-----------------------------------------------------|-----|
|demo-workload-tag-1 |demo-workload-tag-1 |demo-gvc-workload | |0 minutes ago |https://demo-workload-tag-1-x08pdgjs9hhjj.t.cpln.app | |
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+-----+
  • Add same tag to multiple workloads
$ cpln workload tag demo-workload-tag-1 demo-workload-tag-2 --tag multiple-workloads=true --org demo-cpln-organization --gvc demo-gvc-workload
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+--------------------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------------|-----------------------------------------|------------------|----------|--------------|-----------------------------------------------------|--------------------------|
|demo-workload-tag-1 |demo-workload-tag-1 |demo-gvc-workload | |0 minutes ago |https://demo-workload-tag-1-x08pdgjs9hhjj.t.cpln.app |multiple-workloads="true" |
|demo-workload-tag-2 |demo-workload-tag-2 |demo-gvc-workload | |0 minutes ago |https://demo-workload-tag-2-x08pdgjs9hhjj.t.cpln.app |multiple-workloads="true" |
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+--------------------------+
  • Update same tag on multiple workloads (after running the example above)
$ cpln workload tag demo-workload-tag-1 demo-workload-tag-2 --tag multiple-workloads=demo-workload --org demo-cpln-organization --gvc demo-gvc-workload
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+-----------------------------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------------|-----------------------------------------|------------------|----------|--------------|-----------------------------------------------------|-----------------------------------|
|demo-workload-tag-1 |demo-workload-tag-1 |demo-gvc-workload | |0 minutes ago |https://demo-workload-tag-1-x08pdgjs9hhjj.t.cpln.app |multiple-workloads="demo-workload" |
|demo-workload-tag-2 |demo-workload-tag-2 |demo-gvc-workload | |0 minutes ago |https://demo-workload-tag-2-x08pdgjs9hhjj.t.cpln.app |multiple-workloads="demo-workload" |
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+-----------------------------------+
  • Remove same tag from multiple workload (after running the example above)
$ cpln workload tag demo-workload-tag-1 demo-workload-tag-2 --remove multiple-workloads --org demo-cpln-organization --gvc demo-gvc-workload
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+-----+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|--------------------|-----------------------------------------|------------------|----------|--------------|-----------------------------------------------------|-----|
|demo-workload-tag-1 |demo-workload-tag-1 |demo-gvc-workload | |0 minutes ago |https://demo-workload-tag-1-x08pdgjs9hhjj.t.cpln.app | |
|demo-workload-tag-2 |demo-workload-tag-2 |demo-gvc-workload | |0 minutes ago |https://demo-workload-tag-2-x08pdgjs9hhjj.t.cpln.app | |
+--------------------+-----------------------------------------+------------------+----------+--------------+-----------------------------------------------------+-----+

workload update

Update properties of the referenced workload

Usage

copy
cpln workload 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"):

copy
description string
tags.&lt;key&gt; string
spec.identityLink string
spec.containers.&lt;name&gt;.image string
spec.containers.&lt;name&gt;.workingDir string
spec.containers.&lt;name&gt;.metrics.port string
spec.containers.&lt;name&gt;.metrics.path string
spec.containers.&lt;name&gt;.cpu string
spec.containers.&lt;name&gt;.memory string
spec.containers.&lt;name&gt;.command string
spec.containers.&lt;name&gt;.args string[]
spec.containers.&lt;name&gt;.env.&lt;name&gt;.value string
spec.containers.&lt;name&gt;.inheritEnv boolean
spec.firewallConfig.external.inboundAllowCIDR string[]
spec.firewallConfig.external.outboundAllowHostname string[]
spec.firewallConfig.external.outboundAllowCIDR string[]
spec.firewallConfig.internal.inboundAllowType { 'none' | 'same-gvc' | 'same-org' | 'workload-list' }
spec.firewallConfig.internal.inboundAllowWorkload string[]
spec.defaultOptions.autoscaling.metric { 'concurrency' | 'cpu' | 'rps' }
spec.defaultOptions.autoscaling.target number
spec.defaultOptions.autoscaling.minScale number
spec.defaultOptions.autoscaling.maxScale number
spec.defaultOptions.autoscaling.scaleToZeroDelay number
spec.defaultOptions.autoscaling.maxConcurrency number
spec.defaultOptions.timeoutSeconds number
spec.defaultOptions.capacityAI boolean
spec.defaultOptions.debug boolean
spec.defaultOptions.suspend boolean
spec.job.schedule string
spec.job.concurrencyPolicy { 'Forbid' | 'Replace' }
spec.job.historyLimit number
spec.job.restartPolicy { 'OnFailure' | 'Never' }
spec.job.activeDeadlineSeconds number
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 --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", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]

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

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

Options: --help Show help [boolean]

Common Options Reference

Options
  • The --set option allows the modification of the following workload properties:
    • `description1
      • Description of the workload
      • Type: string
    • tags
      • Tags (key=value) associated with the workload
      • Type: string
    • spec.identityLink
      • The identity of the workload
      • Type: string
    • spec.containers\.<name\>.image
      • The name of the container image to be pulled
      • Type: string
    • spec.containers\.<name\>.port
      • The port to serve traffic over
      • Type: number
    • spec.containers\.<name\>.cpu
      • The amount of cpu units available to the workload
      • Default: 150m
      • Type: string
    • spec.containers\.<name\>.memory
      • The amount of memory available to the workload
      • Default: 128Mi
      • Type: string
    • spec.containers\.<name\>.env\.<name\>.value
      • The environment variables to be available to the workload
      • Type: string
    • spec.firewallConfig.external.outboundAllowHostname
      • The list of hostnames that the workload is allowed to call
      • Type: string[]
    • spec.firewallConfig.external.outboundAllowCIDR
      • The list of CIDR values that the workload is allowed to call
      • Type: string[]
    • spec.firewallConfig.external.inboundAllowCIDR
      • The list of CIDR values that are allowed to call the workload
      • Type: string[]
      • Tip: Use the value ["0.0.0.0/0"] to allow all inbound requests
    • spec.firewallConfig.internal.inboundAllowType
      • The allowed inbound types to a workload
      • Type: string
      • Allowed values: 'none' | 'same-gvc' | 'same-org' | 'workload-list'
    • spec.firewallConfig.internal.inboundAllowWorkload
      • If the inbound allow type is 'workload-list', this property will be active and contain the names of other workloads that can communicate with this workload
      • Type: string[]
      • Allowed values: Other workload names within the same global virtual cloud

NOTE: The ratio between CPU to Memory can be at most 1/8.

Example
  • For the examples below, the initial workload is configured as:
+---------------------+-----------------------------------------+------------------+----------+--------------+------------------------------------------------------+-----+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|---------------------|-----------------------------------------|------------------|----------|--------------|------------------------------------------------------|-----|
|demo-workload-update |demo-workload-update |demo-gvc-workload | |0 minutes ago |https://demo-workload-update-x08pdgjs9hhjj.t.cpln.app | |
+---------------------+-----------------------------------------+------------------+----------+--------------+------------------------------------------------------+-----+
  • Update an workload's description
$ cpln workload update demo-workload-update --set description="new description" --org demo-cpln-organization --gvc demo-gvc-workload
+---------------------+-----------------------------------------+------------------+----------+--------------+------------------------------------------------------+-----+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|---------------------|-----------------------------------------|------------------|----------|--------------|------------------------------------------------------|-----|
|demo-workload-update |new description |demo-gvc-workload | |0 minutes ago |https://demo-workload-update-x08pdgjs9hhjj.t.cpln.app | |
+---------------------+-----------------------------------------+------------------+----------+--------------+------------------------------------------------------+-----+
  • Update an workload's tags
$ cpln workload update demo-workload-update --set tags.demo-key=demo-value --org demo-cpln-organization --gvc demo-gvc-workload
+---------------------+-----------------------------------------+------------------+----------+--------------+------------------------------------------------------+----------------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|---------------------|-----------------------------------------|------------------|----------|--------------|------------------------------------------------------|----------------------|
|demo-workload-update |new description |demo-gvc-workload | |0 minutes ago |https://demo-workload-update-x08pdgjs9hhjj.t.cpln.app |demo-key="demo-value" |
+---------------------+-----------------------------------------+------------------+----------+--------------+------------------------------------------------------+----------------------+
  • Update a workload's Image

NOTE: Use the convention //image/IMAGE:TAG to reference an image residing within the current org's private repository.

$ cpln workload update demo-workload-update --set spec.containers.helloworld-go.image=gcr.io/knative-samples/helloworld-go:latest --org demo-cpln-organization --gvc demo-gvc-workload
+---------------------+-----------------------------------------+------------------+----------+--------------+------------------------------------------------------+----------------------+
|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |
|---------------------|-----------------------------------------|------------------|----------|--------------|------------------------------------------------------|----------------------|
|demo-workload-update |new description |demo-gvc-workload | |0 minutes ago |https://demo-workload-update-x08pdgjs9hhjj.t.cpln.app |demo-key="demo-value" |
+---------------------+-----------------------------------------+------------------+----------+--------------+------------------------------------------------------+----------------------+

Common Options

The options listed below are common to most of the subcommands.

Use the option --help on each subcommand to view the options available.

Command

  • --name
    • Name of the resource being created
    • Type: string
  • --description or --desc
    • Description of the resource
    • If the description is not given, it will be the same as the name
    • Type: string
  • --tag
    • Add one or more tags to a resource
    • Type: string
    • Format: key=value
    • The syntax tag=value tries to guess the JSON type of the value, so true would be processed as a boolean. To force a string value, use --tag id:1234. This would result in the string 1234 recorded as the value.
    • Example: --tag environment=prod
  • --file or -f
    • Type: string
    • Use --file - to enable input from standard input
    • Used by the apply command and patch subcommand
  • --manage
    • Perform this command in the browser

Context

  • --profile
    • Override the default profile
    • or use the command cpln profile set-default to set a default profile
    • or set the environment variable CPLN_PROFILE to set a default profile
  • --org
    • Override the default organization
    • or use the command cpln profile update to set a default organization
  • --gvc
    • Override the default global virtual cloud
    • or use the command cpln profile update to set a default global virtual cloud

Format

  • --output or -o
    • Set the output format
    • Type: string
    • Available choices: text, json, and yaml
    • Default: text
    • If the output is truncated, use json or yaml to view the full response.
  • --color
    • Colorize the output
    • Type: boolean
    • Default: true
    • Color is disabled if stdout is not a terminal
  • --ts
    • Format of timestamps
    • Type: string
    • Available choices: iso, local, and age
    • Only active when the output is set to text --output=text
  • --max
    • Maximum number of records to display
    • Type: number
    • Default: 0 (all records)
    • A value less than 1 will return all records

Query

Used within the query subcommands:

  • --match
    • Query filter type
    • Type: string
    • Available choices: all, none, and any
    • Default: all
  • --property or --prop
    • Property to query
    • Type: string
    • Can be any resource property such as name or description
    • Example: --property name=demo-agent
  • --tag
    • Tag to query
    • Type: string
    • Can be any attached tag on a resource
    • Example: --tag environment=prod
  • --rel
    • Relation to query
    • Type: string

Request

  • --token
    • Override the authorization token
    • Type: string
    • Default: The authorization token linked to the current profile
    • Hint: Use the command cpln profile token to obtain the token for the default or a specific profile
  • --endpoint
  • --insecure or -k
    • Type: boolean
    • Ignore TLS errors

Debug

  • --verbose or -v
    • Enable verbose output to standard error
  • --debug or -d
    • Display all HTTP communications to the API endpoint

Global Options

help

Display the CLI help menu

Usage

copy
cpln --help
copy
cpln COMMAND --help
copy
cpln COMMAND SUBCOMMAND --help

version

Display the CLI version

Usage

copy
cpln --version
Copyright © 2024 Control Plane Corporation. All rights reserved. Revision 6e8b046b
Contents