The Control Plane CLI (cpln) can be installed by using npm, homebrew or by downloading the specific binary package for the target operating system.
Preferred Installation Method
Execute the following command to install the CLI:
copynpm install -g @controlplane/cli
Execute the following command to update the CLI:
copynpm update -g @controlplane/cli
Follow these instructions to install homebrew.
Execute the following command:
copybrew tap controlplane-com/cpln && brew install cpln
If you are running Apple Silicon (M1/M2), Rosetta must be installed.
copysoftwareupdate --install-rosetta
Execute the following command to update:
copybrew update && brew upgrade
In cases where Node.js cannot be used, select the package that matches the target operating system:
OS | File | sha256 |
---|---|---|
macOS | cpln-macos.tgz | acf1b12329c7698f633cfc16ece698e607f6a35cf63946b76dd3c9f2e4de80d4 |
Linux | cpln-linux.tgz | 1d66d1b884f6db80f704ccc5eacf478257dc593aa471c8036f0629e9ae2209fd |
Windows 10/11 | cpln-win.zip | 0302df94b66297e6b9d9395fa260234d168bd3de4c8870e4d6058b7ddbd36ed1 |
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:
OS | Command |
---|---|
macOS | gunzip cpln-macos.tgz && open cpln-macos.tar |
Linux | tar -xvf cpln-linux.tgz |
Windows 10/11 | tar -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.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.
copycpln misc install-completion
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:
copyautoload -U compinitcompinit
Autocomplete workaround for users of Cygwin
:
After executing the cpln misc install-completion
command:
cpln.bash
file from C:/Users/<username>/.config/tabtab/cpln.bash
to C:/cygwin64/home/<username>/.config/tabtab/cpln.bash
.bashrc
file at C:/cygwin64/home/<username>/.bashrc
.bashrc
file: . C:/cygwin64/home/<username>/.config/tabtab/cpln.bash
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.
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
If the response from a command is truncated, use the following options to view the complete response:
--output json
or -o json
--output yaml
or -o yaml
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.
Manage accounts
copycpln account [SUBCOMMAND]
Commands: cpln account get [ref...] Get accounts by id or list accounts
Options: --help Show help [boolean]
account Subcommands
Get accounts by id or list accounts
Usage
copycpln account get [ref...] [OPTIONS]
An empty reference will return all references
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]
Manage agents
For a detailed overview, please visit the agent's reference page.
copycpln 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
Show the access report for the referenced agent
Usage
copycpln agent access-report <ref> [OPTIONS]
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]
$ 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 |+-----------+--------------------------------------------------------+--------+
Create a new agent
Usage
copycpln agent create --name AGENT_NAME [OPTIONS]
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]
$ cpln agent create --name demo-agent --desc demo-agent --tag drink=water --org demo-cpln-organization{"agentId": "6ccaf232-2016-4575-a907-16f9e682ce5e","agentLink": "/org/demo-cpln-organization/agent/demo-agent","hubEndpoint": "https://hub.test.cpln.io","registrationToken": "a2D9icgnn7M9ryzRQoQL5FeXVSdIurB-826XxG4iYY7DNimZlb2DyWsQ/scXH0k"}
Delete one or more referenced agents
Usage
copycpln agent delete <ref...> [OPTIONS]
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]
$ cpln agent delete demo-agent --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Edit the referenced agent, as YAML, within an editor
Usage
copycpln agent edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln agent edit demo-agent --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced agent
Usage
copycpln agent eventlog <ref> [OPTIONS]
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]
$ cpln agent eventlog demo-agent --org demo-cpln-organizationThe event log for the referenced agent will be shown.
Retrieve one or more referenced agents
Usage
copycpln agent get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ 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 | |+-----------------+-----------------+--------------+--------------+
$ 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 | |+-----------------+-----------------+--------------+-----+
$ 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 | |+-----------------+-----------------+--------------+-----+
Get info about an agent
Usage
copycpln agent info <ref> [OPTIONS]
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]
$ 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}
Generate a manifest for running an agent in K8S
Usage
copycpln agent manifest --bootstrap-file FILE_NAME --namespace NAME_SPACE [OPTIONS]
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]
Update the referenced agent's metadata using an input file
Usage
copycpln agent patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln agent patch demo-agent --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced agent.
Show the grantable permissions for an agent object type
Usage
copycpln agent permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+----------------------------+----------------------------------------+
Find all the agents based on the given query
Usage
copycpln agent query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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" |+-----------+------------+-------------+--------------+
$ 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" |+-----------+------------+-------------+--------------+
$ 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" |+-----------+------------+-------------+--------------+
$ 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" |+-----------+------------+-------------+--------------+
Manage the tags belonging to one or more referenced agents
Usage
copycpln agent tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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" |+-----------+------------+-------------+--------------+
$ 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" |+-----------+------------+-------------+---------------+
$ cpln agent tag demo-agent --remove drink --org demo-cpln-organization+-----------+------------+-------------+-----+|NAME |DESCRIPTION |CREATED |TAGS ||-----------|------------|-------------|-----||demo-agent |demo-agent |1 minute ago | |+-----------+------------+-------------+-----+
Run an agent within a local Docker instance
Usage
copycpln agent up --bootstrap-file FILE_NAME [--background] [OPTIONS]
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]
$ cpln agent up --bootstrap-file bootstrap.config --org demo-cpln-organizationThe Control Plane agent will be executed in a local Docker instance using the referenced bootstrap config file
Update properties of the referenced agent
Usage
copycpln agent update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copydescription stringtags.<key> string [required]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the cpln profile update
command
Format options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]
Debug options: --verbose, -v Enable verbose output to stderr [boolean][default: false] --debug, -d Show all HTTP communications [boolean][default: false]
Options: --help Show help [boolean]
--set
option allows the modification of the following agent properties:description
tags
+------------------+------------------+--------------+-----+|NAME |DESCRIPTION |CREATED |TAGS ||------------------|------------------|--------------|-----||demo-agent-update |demo-agent-update |0 minutes ago | |+------------------+------------------+--------------+-----+
$ 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 | |+------------------+----------------+--------------+-----+
$ 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" |+------------------+----------------+--------------+----------------------+
Create or update a resource using an input file.
Refer to the cpln apply guide for additional details.
Usage
copycpln apply [OPTIONS]
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]
$ cpln apply --file action.jsonThe actions within the JSON file will be performed against the API.
Manage audit contexts
For a detailed overview, please visit the audit context's reference page.
copycpln 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
Show the access report for the referenced audit context
Usage
copycpln auditctx access-report <ref> [OPTIONS]
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]
$ 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 |+-----------+--------------------------------------------------------+--------+
Create a clone of the referenced audit context; this will only duplicate its spec.
Usage
copycpln auditctx clone <ref> --name CLONE_NAME [OPTIONS]
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]
$ 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 | |+-------------------------+-----------------------------------------+--------+-----+
Create a new audit context
Usage
copycpln auditctx create --name NAME [OPTIONS]
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]
$ cpln auditctx create --name demo-audit-context --org demo-cpln-organization+-------------------+-----------------------------------------+--------+-----+|NAME |DESCRIPTION |ORIGIN |TAGS ||-------------------|-----------------------------------------|--------|-----||demo-audit-context |demo-audit-context |default | |+-------------------+-----------------------------------------+--------+-----+
Edit the referenced audit context, as YAML, within an editor
Usage
copycpln auditctx edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln auditctx edit demo-audit-context --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced audit context
Usage
copycpln auditctx eventlog <ref> [OPTIONS]
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]
$ cpln auditctx eventlog demo-audit-context --org demo-cpln-organizationThe event log for the referenced audit context will be shown.
Retrieve one or more referenced audit contexts
Usage
copycpln auditctx get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ 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 | |+-------------------------+----------------------------+--------+------------+
$ cpln auditctx get demo-audit-context --org demo-cpln-organization+-------------------+-------------------+--------+------------+|NAME |DESCRIPTION |ORIGIN |TAGS ||-------------------|-------------------|--------|------------||demo-audit-context |demo-audit-context |default |type="demo" |+-------------------+-------------------+--------+------------+
$ 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 | |+-------------------+-----------------------+--------+------------+
Update the referenced audit context's metadata using an input file
Usage
copycpln auditctx patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln auditctx patch demo-audit-context --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced audit context.
Show the grantable permissions for an audit context object type
Usage
copycpln auditctx permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 |+-----------+-------------------------+--------------------------------------------------+
Find all the audit contexts based on the given query
Usage
copycpln auditctx query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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" |+-------------------+-------------------+--------+------------+
$ 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" |+-------------------+-------------------+--------+------------+
$ 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" |+-------------------+-------------------+--------+------------+
$ 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" |+-------------------+-------------------+--------+------------+
Manage the tags belonging to one or more referenced audit contexts
Usage
copycpln auditctx tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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" |+-------------------+-------------------+--------+--------------+
$ 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" |+-------------------+-------------------+--------+---------------+
$ 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" |+-------------------+-------------------+--------+------------+
Update properties of the referenced audit context
Usage
copycpln auditctx update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copydescription stringtags.<key> string [required]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the cpln profile update
command
Format options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]
Debug options: --verbose, -v Enable verbose output to stderr [boolean][default: false] --debug, -d Show all HTTP communications [boolean][default: false]
Options: --help Show help [boolean]
--set
option allows the modification of the following audit context properties:description
tags
+-------------------+-------------------+--------+------------+|NAME |DESCRIPTION |ORIGIN |TAGS ||-------------------|-------------------|--------|------------||demo-audit-context |demo-audit-context |default |type="demo" |+-------------------+-------------------+--------+------------+
$ 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" |+-------------------+----------------+--------+------------+
$ 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" |+-------------------+----------------+--------+---------------+
Manage cloud accounts
For a detailed overview, please visit the cloud account's reference page.
copycpln 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
Show the access report for the referenced cloud account
Usage
copycpln cloudaccount access-report <ref> [OPTIONS]
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]
$ 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 |+-----------+--------------------------------------------------------+--------+
Create an AWS cloud account
Usage
copycpln cloudaccount create-aws --name ACCOUNT_NAME --role-arn ROLE_ARN [OPTIONS]
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.
Command options:
--name Name of the new account
--description, --desc Optional description, defaults to the name if not set
--role-arn ARN of the role used by Control Plane to manage the account, in format arn:aws:iam::<account number>:role/<name>
--how Show the steps on how to create and configure your AWS account [boolean]
--tag Attach tags (e.g., --tag drink=water)
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the cpln profile update
command
Format options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]
Debug options: --verbose, -v Enable verbose output to stderr [boolean][default: false] --debug, -d Show all HTTP communications [boolean][default: false]
Options: --help Show help [boolean]
$ 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 | |+-----------------------+-----------------------+---------+-----------------------------------------------------------+--------------+-----+
Create an Azure cloud account
Usage
copycpln cloudaccount create-azure --name ACCOUNT_NAME --secret AZURE_SECRET [OPTIONS]
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.
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]
$ 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 | |+-------------------------+-------------------------+---------+-----+--------------+-----+
Create a GCP cloud account
Usage
copycpln cloudaccount create-gcp --name ACCOUNT_NAME --project-id PROJECT_ID [OPTIONS]
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.
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]
$ 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 | |+-----------------------+-----------------------+---------+--------+--------------+-----+
Create a NGS cloud account
Usage
copycpln cloudaccount create-ngs --name ACCOUNT_NAME --secret SECRET_REFERENCE [OPTIONS]
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]
Delete one or more referenced cloud accounts
Usage
copycpln cloudaccount delete <ref...> [OPTIONS]
Deleting a cloud account will not remove any configuration at the associated cloud provider
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]
$ cpln cloudaccount delete demo-cloud-account-aws --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Edit the referenced cloud account, as YAML, within an editor
Usage
copycpln cloudaccount edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln cloudaccount edit demo-cloud-account-aws --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced cloud account
Usage
copycpln cloudaccount eventlog <ref> [OPTIONS]
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]
$ cpln cloudaccount eventlog demo-cloud-account-aws --org demo-cpln-organizationThe event log for the referenced cloud account will be shown.
Retrieve one or more referenced cloud accounts
Usage
copycpln cloudaccount get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ 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 | |+-----------------------------+-----------------------------+---------+-----------------------------------------------------------+--------------+-----+
$ 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 | |+-----------------------------+-----------------------------+---------+-----------------------------------------------------------+--------------+-----+
$ 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 | |+-----------------------------+-----------------------------+---------+-----------------------------------------------------------+--------------+-----+
Update the referenced cloud account's metadata using an input file
Usage
copycpln cloudaccount patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln cloudaccount patch demo-cloud-account-aws --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced cloud account.
Show the grantable permissions for a cloud account object type
Usage
copycpln cloudaccount permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+-------------------------------+-------------------------------------------+
Find all the cloud accounts based on the given query
Usage
copycpln cloudaccount query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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 | |+-----------------------+-----------------------+---------+-----------------------------------------------------------+--------------+-----+
$ 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 | |+-----------------------+-----------------------+---------+-----------------------------------------------------------+--------------+-----+
$ cpln cloudaccount query --match any --tag drink=water --org demo-cpln-organization+-----+------------+---------+-----+--------+-----+|NAME |DESCRIPTION |PROVIDER |INFO |CREATED |TAGS |+-----+------------+---------+-----+--------+-----+
$ 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 | |+-----------------------+-----------------------+---------+-----------------------------------------------------------+--------------+-----+
Manage the tags belonging to one or more referenced cloud accounts
Usage
copycpln cloudaccount tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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" |+-------------------------+-------------------------+---------+-----+--------------+--------------+
$ 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" |+-------------------------+-------------------------+---------+-----+--------------+---------------+
$ 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 | |+-------------------------+-------------------------+---------+-----+--------------+-----+
$ 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" |+-------------------------+-------------------------+---------+--------+--------------+------------------------------+
$ 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" |+-------------------------+-------------------------+---------+--------+--------------+-------------------------------------------+
$ 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 k8s files to cpln files
Refer to the cpln convert guide for additional details.
Usage
copycpln convert [OPTIONS]
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]
Delete resources from files
Refer to the cpln delete guide for additional details.
Usage
copycpln delete [OPTIONS]
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]
Manage custom domains
For a detailed overview, please visit the domain's reference page.
copycpln 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
Show the access report for the referenced domain
Usage
copycpln domain access-report <ref> [OPTIONS]
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]
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 |+-----------+--------------------------------------------------------+--------+
Create a new domain
Usage
copycpln domain create --name DOMAIN_NAME [OPTIONS]
Ownership of the referenced domain is required by setting a TXT DNS entry.
Please review the instructions here.
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]
$ cpln domain create --name demo.globalvirtualcloud.com --org demo-cpln-organizationThe ownership of the referenced domain will be validated and if successful, added to the referenced organization.
Delete one or more referenced domains
Usage
copycpln domain delete <ref...> [OPTIONS]
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]
$ cpln domain delete demo.globalvirtualcloud.com --org demo-cpln-organizationThe referenced domain will be removed from the referenced organization.
Edit the referenced domain, as YAML, within an editor
Usage
copycpln domain edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln domain edit demo.globalvirtualcloud.com --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced domain
Usage
copycpln domain eventlog <ref> [OPTIONS]
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]
$ cpln domain eventlog demo.globalvirtualcloud.com --org demo-cpln-organizationThe event log for the referenced domain will be shown.
Retrieve one or more referenced domains
Usage
copycpln domain get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ cpln domain get demo.globalvirtualcloud.com --org demo-cpln-organization+----------------------------+----------------------------------+---------------+|NAME |DESCRIPTION |TAGS ||----------------------------|----------------------------------|---------------||demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |drink="coffee" |+----------------------------+----------------------------------+---------------+
$ 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" |+-----------------------------+----------------------------------+-------------------+
Update the referenced domain's metadata using an input file
Usage
copycpln domain patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln domain patch demo.globalvirtualcloud.com --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced domain.
Show the grantable permissions for a domain object type
Usage
copycpln domain permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+-----------------------------------------+----------------------------------------+
Find all the domains based on the given query
Usage
copycpln domain query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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" |+----------------------------+----------------------------------+---------------+
$ 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" |+----------------------------+----------------------------------+---------------+
$ 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" |+-----------------------------+-----------------------------+-------------------+
$ 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" |+-----------------------------+----------------------------------+-------------------+
Manage the tags belonging to one or more referenced domains
Usage
copycpln domain tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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" |+----------------------------+----------------------------------+--------------+
$ 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" |+----------------------------+----------------------------------+---------------+
$ cpln domain tag demo.globalvirtualcloud.com --remove name --org demo-cpln-organization+----------------------------+----------------------------------+---------------+|NAME |DESCRIPTION |TAGS ||----------------------------|----------------------------------|---------------||demo.globalvirtualcloud.com |FQDN: demo.globalvirtualcloud.com |drink="coffee" |+----------------------------+----------------------------------+---------------+
$ 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" |+-----------------------------+----------------------------------+------------------------+
$ 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" |+-----------------------------+----------------------------------+-------------------------------+
$ 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" |+-----------------------------+----------------------------------+-------------------+
Manage groups
For a detailed overview, please visit the group's reference page.
copycpln 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
Show the access report for the referenced group
Usage
copycpln group access-report <ref> [OPTIONS]
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]
$ 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 |+-----------+--------------------------------------------------------+--------+
Add members to the referenced group
Usage
copycpln group add-member <ref> --email USER_EMAIL [OPTIONS]cpln group add-member <ref> --serviceaccount SERVICE_ACCOUNT [OPTIONS]
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]
$ 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" |+-----------+------------+--------------+-------+--------+--------------+
$ 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" |+-----------+------------+--------------+-------+--------+--------------+
Create a clone of the referenced group; this will only duplicate its spec.
Usage
copycpln group clone <ref> --name CLONE_NAME [OPTIONS]
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]
$ 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" |+-----------------+--------------------+--------------+-------+--------+--------------+
Create a new group
Usage
copycpln group create --name GROUP_NAME [OPTIONS]
After creating a new group, use the subcommand add-member to populate the group with users and/or service accounts.
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]
$ 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" |+-----------+------------+--------------+-------+--------+--------------+
Delete one or more referenced groups
Usage
copycpln group delete <ref...> [OPTIONS]
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]
$ cpln group delete demo-group --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Edit the referenced group, as YAML, within an editor
Usage
copycpln group edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln group edit demo-group --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced group
Usage
copycpln group eventlog <ref> [OPTIONS]
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]
$ cpln group eventlog demo-group --org demo-cpln-organizationThe event log for the referenced group will be shown.
Retrieve one or more referenced groups
Usage
copycpln group get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ 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 | |+-----------------+-----------------------------------------+--------------+-------+--------+--------------+
$ 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 | |+-----------------+-----------------+--------------+-------+--------+-----+
$ 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 | |+-----------------+-----------------+--------------+-------+--------+-----+
Update the referenced group's metadata using an input file
Usage
copycpln group patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln group patch demo-group --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced group.
Show the grantable permissions for a group object type
Usage
copycpln group permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+-----------------------+-----------------------------------+
Find all the groups based on the given query
Usage
copycpln group query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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" |+-----------+------------+--------------+-------+--------+--------------+
$ 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" |+-----------+------------+--------------+-------+--------+--------------+
$ 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" |+-----------+------------+--------------+-------+--------+--------------+
$ 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" |+-----------+------------+--------------+-------+--------+--------------+
Remove members from the referenced group
Usage
copycpln group remove-member <ref> --email USER_EMAIL [OPTIONS]cpln group remove-member <ref> --serviceaccount SERVICE_ACCOUNT [OPTIONS]
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]
The user and service account referenced in the examples below were previously added to the 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" |+-----------+------------+--------------+-------+--------+--------------+
$ 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" |+-----------+------------+--------------+-------+--------+--------------+
Manage the tags belonging to one or more referenced groups
Usage
copycpln group tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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" |+-----------------+-----------------+--------------+-------+--------+--------------+
$ 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" |+-----------------+-----------------+--------------+-------+--------+---------------+
$ 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 | |+-----------------+-----------------+--------------+-------+--------+-----+
$ 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" |+-----------------+-----------------+--------------+-------+--------+-----------------------+
$ 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" |+-----------------+-----------------+--------------+-------+--------+-----------------------------+
$ 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 | |+-----------------+-----------------+--------------+-------+--------+-----+
Update properties of the referenced group
Usage
copycpln group update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copydescription stringtags.<key> stringmemberLinks 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]
--set
option allows the modification of the following group properties:description
tags
memberLinks
+------------------+------------------+--------------+-------+--------+-----+|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS ||------------------|------------------|--------------|-------|--------|-----||demo-group-update |demo-group-update |0 minutes ago |links |default | |+------------------+------------------+--------------+-------+--------+-----+
$ 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 | |+------------------+----------------+--------------+-------+--------+-----+
$ 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" |+------------------+----------------+--------------+-------+--------+----------------------+
$ 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" |+------------------+----------------+--------------+-------+--------+----------------------+
$ 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" |+------------------+----------------+--------------+-------+--------+----------------------+
Manage global virtual clouds
For a detailed overview, please visit the gvc's reference page.
copycpln 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
Show the access report for the referenced global virtual cloud
Usage
copycpln gvc access-report <ref> [OPTIONS]
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]
$ 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 |+-----------+--------------------------------------------------------+--------+
Add one or more locations to the referenced global virtual cloud
Usage
copycpln gvc add-location <ref...> --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]
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]
The gvc, named 'demo-gvc', in the examples below was already created with 'aws-eu-central-1' as one of its locations.
$ 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 |drmagmjww0vx8 | |aws-eu-central-1 |drink="water" || | | | | |aws-us-west-2 | |+---------+------------+--------------+--------------+----------+-----------------+--------------+
$ 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 |drmagmjww0vx8 | |aws-eu-central-1 |drink="water" || | | | | |aws-us-west-2 | || | | | | |gcp-us-east1 | |+---------+------------+--------------+--------------+----------+-----------------+--------------+
Create a clone of the referenced global virtual cloud; this will only duplicate its spec.
Usage
copycpln gvc clone <ref> --name CLONE_NAME [OPTIONS]
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]
$ 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 |qfrfykb4da7nj | |aws-eu-central-1 |drink="water" || | | | | |aws-us-west-2 | || | | | | |gcp-us-east1 | |+---------------+------------------+--------------+--------------+----------+-----------------+--------------+
Create a new global virtual cloud
Usage
copycpln gvc create --name GVC_NAME --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]
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]
name
$ 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 |drmagmjww0vx8 | |aws-eu-central-1 |drink="water" |+---------+------------+--------------+--------------+----------+-----------------+--------------+
Delete GVCs by name
Usage
copycpln gvc delete <ref...> [OPTIONS]
Deleting a gvc will remove all associated resources (workloads, etc.)
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]
$ cpln gvc delete demo-gvc-delete-1 --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
$ cpln gvc delete demo-gvc-delete-1 demo-gvc-delete-2 --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Delete all workloads for the referenced global virtual cloud
Usage
copycpln gvc delete-all-workloads <ref> [OPTIONS]
Deleting all the associated workloads will remove all associated resources (containers, etc.)
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]
$ cpln gvc delete-all-workloads demo-gvc-with-workloads --org demo-cpln-organization+------------+------------+------------------------+----------+--------------+---------------------------------------------+-----+|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS ||------------|------------|------------------------|----------|--------------|---------------------------------------------|-----||workload-02 |workload-02 |demo-gvc-with-workloads | |0 minutes ago |https://workload-02-encchmwhqa0ag.t.cpln.app | ||workload-01 |workload-01 |demo-gvc-with-workloads | |0 minutes ago |https://workload-01-encchmwhqa0ag.t.cpln.app | |+------------+------------+------------------------+----------+--------------+---------------------------------------------+-----+
Edit the referenced global virtual cloud, as YAML, within an editor
Usage
copycpln gvc edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln gvc edit demo-gvc --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced global virtual cloud
Usage
copycpln gvc eventlog <ref> [OPTIONS]
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]
$ cpln gvc eventlog demo-gvc --org demo-cpln-organizationThe event log for the referenced gvc will be shown.
Retrieve one or more referenced global virtual clouds
Usage
copycpln gvc get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ cpln gvc get --org demo-cpln-organization+------------------------+------------------------+--------------+--------------+----------+-----------------+--------------+|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS ||------------------------|------------------------|--------------|--------------|----------|-----------------|--------------||demo-gvc |demo-gvc |5 minutes ago |drmagmjww0vx8 | |aws-eu-central-1 |drink="water" || | | | | |aws-us-west-2 | || | | | | |gcp-us-east1 | ||demo-gvc-get-1 |demo-gvc-get-1 |0 minutes ago |1g4p1dwxmyh6r | |aws-eu-central-1 | ||demo-gvc-get-2 |demo-gvc-get-2 |0 minutes ago |v2b4sjzh4kwec | |aws-eu-central-1 | ||demo-gvc-identity |demo-gvc-identity |5 minutes ago |q51cqwx7p7aha | |aws-eu-central-1 | ||demo-gvc-with-workloads |demo-gvc-with-workloads |0 minutes ago |encchmwhqa0ag | |aws-eu-central-1 | ||demo-gvc-workload |demo-gvc-workload |5 minutes ago |148ej7hqkxkwr | |aws-eu-central-1 | |+------------------------+------------------------+--------------+--------------+----------+-----------------+--------------+
$ 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 |1g4p1dwxmyh6r | |aws-eu-central-1 | |+---------------+---------------+--------------+--------------+----------+-----------------+-----+
$ 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 |1g4p1dwxmyh6r | |aws-eu-central-1 | ||demo-gvc-get-2 |demo-gvc-get-2 |0 minutes ago |v2b4sjzh4kwec | |aws-eu-central-1 | |+---------------+---------------+--------------+--------------+----------+-----------------+-----+
Update the referenced global virtual cloud's metadata using an input file
Usage
copycpln gvc patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln gvc patch demo-gvc --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced gvc.
Show the grantable permissions for a global virtual cloud object type
Usage
copycpln gvc permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+---------------------+-----------------------------------+
Find all the global virtual clouds based on the given query
Usage
copycpln gvc query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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 |drmagmjww0vx8 | |aws-eu-central-1 |drink="water" || | | | | |aws-us-west-2 | || | | | | |gcp-us-east1 | |+---------+------------+--------------+--------------+----------+-----------------+--------------+
$ 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 |drmagmjww0vx8 | |aws-eu-central-1 |drink="water" || | | | | |aws-us-west-2 | || | | | | |gcp-us-east1 | |+---------+------------+--------------+--------------+----------+-----------------+--------------+
$ 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 |drmagmjww0vx8 | |aws-eu-central-1 |drink="water" || | | | | |aws-us-west-2 | || | | | | |gcp-us-east1 | |+---------+------------+--------------+--------------+----------+-----------------+--------------+
$ 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 |drmagmjww0vx8 | |aws-eu-central-1 |drink="water" || | | | | |aws-us-west-2 | || | | | | |gcp-us-east1 | |+---------+------------+--------------+--------------+----------+-----------------+--------------+
Remove one or more locations from the referenced global virtual cloud
Usage
copycpln gvc remove-location <ref...> --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]
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]
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.
$ 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 |k6g2hyj7nb75y | |aws-eu-central-1 | || | | | | |aws-us-west-2 | || | | | | |gcp-us-east1 | |+------------------------+------------------------+--------------+--------------+----------+-----------------+-----+
$ 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 |k6g2hyj7nb75y | |gcp-us-east1 | |+------------------------+------------------------+--------------+--------------+----------+-------------+-----+
Manage the tags belonging to one or more referenced global virtual clouds
Usage
copycpln gvc tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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 |97e1bdnq53gr0 | |aws-eu-central-1 |drink="water" |+---------------+---------------+--------------+--------------+----------+-----------------+--------------+
$ 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 |97e1bdnq53gr0 | |aws-eu-central-1 |drink="coffee" |+---------------+---------------+--------------+--------------+----------+-----------------+---------------+
$ 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 |97e1bdnq53gr0 | |aws-eu-central-1 | |+---------------+---------------+--------------+--------------+----------+-----------------+-----+
$ 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 |97e1bdnq53gr0 | |aws-eu-central-1 |multiple-gvcs="true" ||demo-gvc-tag-2 |demo-gvc-tag-2 |0 minutes ago |86bdhnmp09pdy | |aws-eu-central-1 |multiple-gvcs="true" |+---------------+---------------+--------------+--------------+----------+-----------------+---------------------+
$ 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 |97e1bdnq53gr0 | |aws-eu-central-1 |multiple-gvcs="demo-gvc" ||demo-gvc-tag-2 |demo-gvc-tag-2 |0 minutes ago |86bdhnmp09pdy | |aws-eu-central-1 |multiple-gvcs="demo-gvc" |+---------------+---------------+--------------+--------------+----------+-----------------+-------------------------+
$ 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 |97e1bdnq53gr0 | |aws-eu-central-1 | ||demo-gvc-tag-2 |demo-gvc-tag-2 |0 minutes ago |86bdhnmp09pdy | |aws-eu-central-1 | |+---------------+---------------+--------------+--------------+----------+-----------------+-----+
Update properties of the referenced global virtual cloud
Usage
copycpln gvc update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copydescription stringtags.<key> stringspec.pullSecretLinks string[]spec.staticPlacement.locationLinks string[]spec.tracing.sampling numberspec.tracing.lightstep.endpoint stringspec.tracing.lightstep.credentials string[]spec.env.<name>.value stringArrays 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]
--set
option allows the modification of the following global virtual cloud properties:description
tags
spec.pullSecretLinks
spec.domain
spec.staticPlacement.locationLinks
+----------------+----------------+--------------+--------------+----------+-----------------+-----+|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS ||----------------|----------------|--------------|--------------|----------|-----------------|-----||demo-gvc-update |demo-gvc-update |0 minutes ago |kagnyhwg25wa6 | |aws-eu-central-1 | |+----------------+----------------+--------------+--------------+----------+-----------------+-----+
$ 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 |kagnyhwg25wa6 | |aws-eu-central-1 | |+----------------+----------------+--------------+--------------+----------+-----------------+-----+
$ 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 |kagnyhwg25wa6 | |aws-eu-central-1 |demo-key="demo-value" |+----------------+----------------+--------------+--------------+----------+-----------------+----------------------+
Manage helm releases on cpln
Refer to the cpln helm guide for additional details.
copycpln helm [SUBCOMMAND]
Commands: cpln helm history <release> Fetch release history cpln helm install [release][chart] Install a release [aliases: apply] cpln helm list Show a list of releases cpln helm rollback <release> [revision] Roll back a release to a previous revision 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, del, delete, un] cpln helm upgrade [release][chart] Upgrade a release [aliases: apply]
Options: --help Show help [boolean]
helm Subcommands
Fetch release history
Usage
copycpln helm history <release> [OPTIONS]
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]
Install a release
Usage
copycpln helm install [release] [chart] [OPTIONS]
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]
Show a list of releases
Usage
copycpln helm list [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the 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]
Roll back a release to a previous revision
Usage
copycpln helm rollback <release> [revision] [OPTIONS]
Positionals: release The release name [string][required] revision Revision (version) number. If this argument is omitted or set to 0, it will roll back to the previous release. To see revision numbers, run 'cpln helm history RELEASE'. [string]
Command options: --cleanup-on-fail allow deletion of new resources created in this rollback when rollback fails [boolean][default: false] --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]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the 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]
Show state of a release
Usage
copycpln helm show <release> [OPTIONS]
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]
Generate cpln resources from a template
Usage
copycpln helm template [release] [chart] [OPTIONS]
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]
Uninstall a release
Usage
copycpln helm uninstall <release> [OPTIONS]
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]
Upgrade a release
Usage
copycpln helm upgrade [release] [chart] [OPTIONS]
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]
Manage identities within a global virtual cloud
For a detailed overview, please visit the identity's reference page.
copycpln 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
Show the access report for the referenced identity
Usage
copycpln identity access-report <ref> [OPTIONS]
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]
$ 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 |+-----------+--------------------------------------------------------+--------+
Create a new identity
Usage
copycpln identity create --name IDENTITY_NAME [OPTIONS]
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]
$ 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-7t1qty3g |0 minutes ago | |drink="water" |+--------------+--------------+------------------+-------------------------------+--------------+----------+--------------+
Delete one or more referenced identities
Usage
copycpln identity delete <ref...> [OPTIONS]
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]
$ cpln identity delete demo-identity --org demo-cpln-organization --gvc demo-gvc-identityIf the delete was successful, a new command prompt will be shown.
Edit the referenced identity, as YAML, within an editor
Usage
copycpln identity edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln identity edit demo-identity --org demo-cpln-organization --gvc demo-gvc-identityYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced identity
Usage
copycpln identity eventlog <ref> [OPTIONS]
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]
$ cpln identity eventlog demo-identity --org demo-cpln-organization --gvc demo-gvc-identityThe event log for the referenced identity will be shown.
Retrieve one or more referenced identities
Usage
copycpln identity get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ cpln identity get --org demo-cpln-organization --gvc demo-gvc-identity+--------------------+--------------------+------------------+-------------------------------+--------------+----------+--------------+|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS ||--------------------|--------------------|------------------|-------------------------------|--------------|----------|--------------||demo-identity-get-2 |demo-identity-get-2 |demo-gvc-identity |cpln-demo-cpln-organi-tamafzsd |0 minutes ago | | ||demo-identity-get-1 |demo-identity-get-1 |demo-gvc-identity |cpln-demo-cpln-organi-qrftpk24 |0 minutes ago | | ||demo-identity |demo-identity |demo-gvc-identity |cpln-demo-cpln-organi-7t1qty3g |6 minutes ago | |drink="water" |+--------------------+--------------------+------------------+-------------------------------+--------------+----------+--------------+
$ 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-qrftpk24 |0 minutes ago | | |+--------------------+--------------------+------------------+-------------------------------+--------------+----------+-----+
$ 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-qrftpk24 |0 minutes ago | | ||demo-identity-get-2 |demo-identity-get-2 |demo-gvc-identity |cpln-demo-cpln-organi-tamafzsd |0 minutes ago | | |+--------------------+--------------------+------------------+-------------------------------+--------------+----------+-----+
Update the referenced identity's metadata using an input file
Usage
copycpln identity patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln identity patch demo-identity --file update.json --org demo-cpln-organization --gvc demo-gvc-identityThe changes within the JSON file will be performed against the referenced identity.
Show the grantable permissions for an identity object type
Usage
copycpln identity permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the 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]
$ 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 | |+-------+-----------------------------------------+----------------------------------------+
Find all the identities based on the given query
Usage
copycpln identity query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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-7t1qty3g |6 minutes ago | |drink="water" |+--------------+--------------+------------------+-------------------------------+--------------+----------+--------------+
$ 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-7t1qty3g |6 minutes ago | |drink="water" |+--------------+--------------+------------------+-------------------------------+--------------+----------+--------------+
$ 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-7t1qty3g |6 minutes ago | |drink="water" |+--------------+--------------+------------------+-------------------------------+--------------+----------+--------------+
$ 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-7t1qty3g |6 minutes ago | |drink="water" |+--------------+--------------+------------------+-------------------------------+--------------+----------+--------------+
Manage the tags belonging to one or more referenced identities
Usage
copycpln identity tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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-7t1qty3g |7 minutes ago | |drink="water" |+--------------+--------------+------------------+-------------------------------+--------------+----------+--------------+
$ 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-7t1qty3g |7 minutes ago | |drink="coffee" |+--------------+--------------+------------------+-------------------------------+--------------+----------+---------------+
$ 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-7t1qty3g |7 minutes ago | | |+--------------+--------------+------------------+-------------------------------+--------------+----------+-----+
Update properties of the referenced identity
Usage
copycpln identity update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copydescription stringtags.<key> string [required]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the cpln profile update
command
--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the cpln profile update
command
Format options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]
Debug options: --verbose, -v Enable verbose output to stderr [boolean][default: false] --debug, -d Show all HTTP communications [boolean][default: false]
Options: --help Show help [boolean]
--set
option allows the modification of the following identity properties:description
tags
+---------------------+---------------------+------------------+-------------------------------+--------------+----------+-----+|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS ||---------------------|---------------------|------------------|-------------------------------|--------------|----------|-----||demo-identity-update |demo-identity-update |demo-gvc-identity |cpln-demo-cpln-organi-bgdwbj82 |0 minutes ago | | |+---------------------+---------------------+------------------+-------------------------------+--------------+----------+-----+
$ 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-bgdwbj82 |0 minutes ago | | |+---------------------+----------------+------------------+-------------------------------+--------------+----------+-----+
$ 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-bgdwbj82 |0 minutes ago | |demo-key="demo-value" |+---------------------+----------------+------------------+-------------------------------+--------------+----------+----------------------+
Manage images and configure Docker login
For a detailed overview, please visit the image's reference page.
copycpln 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
Show the access report for the referenced image
Usage
copycpln image access-report <ref> [OPTIONS]
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]
$ 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 |+-----------+--------------------------------------------------------+--------+
Build and containerize an application into an image. If using buildpacks, everything after -- will be passed down to the pack executable.
Usage
copycpln image build --name IMAGE_NAME:TAG [OPTIONS]
To push an image using this command, the docker-credential-cpln executable must be installed if the CLI was not installed using npm.
The option --builder
accepts any trusted buildpacks builder.
The default buildpack is heroku/buildpacks:18
.
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/builder:22, gcr.io/buildpacks/builder:v1, paketobuildpacks/builder:base, etc. [default: "heroku/builder:22"] --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]
$ cpln image build demo-image:1 --push demo-cpln-organization -- --env CPLN_IMAGE_BUILD=trueIf 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:bionicFlags:-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, ora 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 currentenvironment at the time this command is executed.This flag may be specified multiple times and will overrideindividual 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 fileOne variable per line, of the form 'VAR=VALUE' or 'VAR'When using latter value-less form, value will be taken from currentenvironment at the time this command is executedNOTE: 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 builderAll 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 imageGlobal Flags:--no-color Disable color output-q, --quiet Show less output--timestamps Enable timestamps in output-v, --verbose Show more output
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
copycpln image copy <ref> --to-name IMAGE:TAG --to-org TARGET_ORG --to-profile TARGET_ORG_PROFILE [OPTIONS]
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]
copycpln 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.
copycpln 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.
Delete one or more referenced images
Usage
copycpln image delete <ref...> [OPTIONS]
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]
$ cpln image delete demo-image:1 --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Perform a Docker login to the organization's private registry
Usage
copycpln image docker-login [OPTIONS]
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]
$ cpln image docker-login demo-image:1 --org demo-cpln-organizationIf the login was successful, the local Docker instance will have the abiltity to login to the referenced organization's private registry.
Edit the referenced image, as YAML, within an editor
Usage
copycpln image edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln image edit demo-image:1 --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Retrieve one or more referenced images
Usage
copycpln image get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ 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... |7 months ago | ||demo-image:2 |demo-cpln-organization.registry.test.cpln.io/demo-image:2 |sha256:3fe719... |3 years ago |description="Demo Image #1" |+-------------+----------------------------------------------------------+-----------------+-------------+----------------------------+
$ 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... |7 months ago | |+-------------+----------------------------------------------------------+-----------------+-------------+-----+
$ 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... |7 months ago | ||demo-image:2 |demo-cpln-organization.registry.test.cpln.io/demo-image:2 |sha256:3fe719... |3 years ago |description="Demo Image #1" |+-------------+----------------------------------------------------------+-----------------+-------------+----------------------------+
Update the referenced image's metadata using an input file
Usage
copycpln image patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln image patch demo-image:1 --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced image.
Show the grantable permissions for an image object type
Usage
copycpln image permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+-----------------------------------------+-----------------------------------------+
Find all the images based on the given query
Usage
copycpln image query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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... |7 months ago | |+-------------+----------------------------------------------------------+-----------------+-------------+-----+
$ 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" |+-------------+----------------------------------------------------------+-----------------+------------+----------------------------+
$ 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" |+-------------+----------------------------------------------------------+-----------------+------------+----------------------------+
$ 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" |+-------------+----------------------------------------------------------+-----------------+------------+----------------------------+
Manage the tags belonging to one or more referenced images
Usage
copycpln image tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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... |7 months ago |drink="water" |+-------------+----------------------------------------------------------+-----------------+-------------+--------------+
$ 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... |7 months ago |drink="coffee" |+-------------+----------------------------------------------------------+-----------------+-------------+---------------+
$ 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... |7 months ago | |+-------------+----------------------------------------------------------+-----------------+-------------+-----+
Manage locations
For a detailed overview, please visit the location's reference page.
copycpln 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
Show the access report for the referenced location
Usage
copycpln location access-report <ref> [OPTIONS]
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]
$ 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 |+-----------+--------------------------------------------------------+--------+
Edit the referenced location, as YAML, within an editor
Usage
copycpln location edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln location edit aws-eu-central-1 --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Retrieve one or more referenced locations
Usage
copycpln location get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ cpln location get --org demo-cpln-organization+----------------------------+----------------------------------------+---------+--------+------------------------+--------+-------------------------------+|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS ||----------------------------|----------------------------------------|---------|--------|------------------------|--------|-------------------------------||aws-ap-northeast-1 |AWS, Asia Pacific (Tokyo) |aws |true |ap-northeast-1 |builtin |cpln/city="Tokyo" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="Japan" ||aws-ap-northeast-2 |AWS, Asia Pacific (Seoul) |aws |true |ap-northeast-2 |builtin |cpln/city="Seoul" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="South Korea" ||aws-ap-northeast-3 |AWS, Asia Pacific (Osaka) |aws |true |ap-northeast-3 |builtin |cpln/city="Osaka" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="Japan" ||aws-ap-south-1 |AWS, Asia Pacific (Mumbai) |aws |true |ap-south-1 |builtin |cpln/city="Mumbai" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="India" ||aws-ap-southeast-1 |AWS, Asia Pacific (Singapore) |aws |true |ap-southeast-1 |builtin |cpln/city="Singapore" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="Singapore" ||aws-ap-southeast-2 |AWS, Asia Pacific (Sydney) |aws |true |ap-southeast-2 |builtin |cpln/city="Sydney" || | | | | | |cpln/continent="Australia" || | | | | | |cpln/country="Australia" ||aws-ca-central-1 |AWS, Canada (Central) |aws |true |ca-central-1 |builtin |cpln/city="Montréal" || | | | | | |cpln/continent="North America" || | | | | | |cpln/country="Canada" ||aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="Germany" ||aws-eu-north-1 |AWS, Europe (Stockholm) |aws |true |eu-north-1 |builtin |cpln/city="Stockholm" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="Sweden" ||aws-eu-west-1 |AWS, Europe (Ireland) |aws |true |eu-west-1 |builtin |cpln/continent="Europe" || | | | | | |cpln/country="Ireland" ||aws-eu-west-2 |AWS, Europe (London) |aws |true |eu-west-2 |builtin |cpln/city="London" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="United Kingdom" ||aws-eu-west-3 |AWS, Europe (Paris) |aws |true |eu-west-3 |builtin |cpln/city="Paris" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="France" ||aws-il-central-1 |AWS, Israel (Tel Aviv) |aws |true |il-central-1 |builtin |cpln/city="Tel Aviv" || | | | | | |cpln/continent="Middle East" || | | | | | |cpln/country="Israel" ||aws-sa-east-1 |AWS, South America (São Paulo) |aws |true |sa-east-1 |builtin |cpln/city="São Paulo" || | | | | | |cpln/continent="South America" || | | | | | |cpln/country="Brazil" ||aws-us-east-1 |AWS, US East (N. Virginia) |aws |true |us-east-1 |builtin |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="VA" ||aws-us-east-2 |AWS, US East (Ohio) |aws |true |us-east-2 |builtin |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="OH" ||aws-us-west-1 |AWS, US West (N. California) |aws |true |us-west-1 |builtin |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="CA" ||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-eastus |Azure, East US |azure |true |eastus |builtin |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="VA" ||azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="VA" ||azure-southcentralus |Azure, South Central US |azure |true |southcentralus |builtin |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="TX" ||gcp-asia-east1 |GCP, Changhua County, Taiwan |gcp |true |asia-east1 |builtin |cpln/continent="Asia" || | | | | | |cpln/country="Taiwan" ||gcp-asia-east2 |GCP, Hong Kong, China |gcp |true |asia-east2 |builtin |cpln/city="Hong Kong" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="China" ||gcp-asia-northeast1 |GCP, Tokyo, Japan |gcp |true |asia-northeast1 |builtin |cpln/city="Tokyo" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="Japan" ||gcp-asia-northeast2 |GCP, Osaka, Japan |gcp |true |asia-northeast2 |builtin |cpln/city="Osaka" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="Japan" ||gcp-asia-northeast3 |GCP, Seoul, South Korea |gcp |true |asia-northeast3 |builtin |cpln/city="Seoul" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="South Korea" ||gcp-asia-south1 |GCP, Mumbai, India |gcp |true |asia-south1 |builtin |cpln/city="Mumbai" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="India" ||gcp-asia-south2 |GCP, Delhi, India |gcp |true |asia-south2 |builtin |cpln/city="Delhi" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="India" ||gcp-asia-southeast1 |GCP, Jurong West, Singapore |gcp |true |asia-southeast1 |builtin |cpln/city="Jurong West" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="Singapore" ||gcp-asia-southeast2 |GCP, Jakarta, Indonesia |gcp |true |asia-southeast2 |builtin |cpln/city="Jakarta" || | | | | | |cpln/continent="Asia" || | | | | | |cpln/country="Indonesia" ||gcp-australia-southeast1 |GCP, Sydney, Australia |gcp |true |australia-southeast1 |builtin |cpln/city="Sydney" || | | | | | |cpln/continent="Australia" || | | | | | |cpln/country="Australia" ||gcp-australia-southeast2 |GCP, Melbourne, Australia |gcp |true |australia-southeast2 |builtin |cpln/city="Melbourne" || | | | | | |cpln/continent="Australia" || | | | | | |cpln/country="Australia" ||gcp-europe-central2 |GCP, Warsaw, Poland, Europe |gcp |true |europe-central2 |builtin |cpln/city="Warsaw" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="Poland" ||gcp-europe-north1 |GCP, Hamina, Finland, Europe |gcp |true |europe-north1 |builtin |cpln/city="Hamina" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="Finland" ||gcp-europe-west1 |GCP, St. Ghislain, Belgium, Europe |gcp |true |europe-west1 |builtin |cpln/city="St. Ghislain" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="Belgium" ||gcp-europe-west2 |GCP, London, England, Europe |gcp |true |europe-west2 |builtin |cpln/city="London" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="England" ||gcp-europe-west3 |GCP, Frankfurt, Germany, Europe |gcp |true |europe-west3 |builtin |cpln/city="Frankfurt" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="Germany" ||gcp-europe-west4 |GCP, Eemshaven, Netherlands, Europe |gcp |true |europe-west4 |builtin |cpln/city="Eemshaven" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="Netherlands" ||gcp-europe-west6 |GCP, Zurich, Switzerland, Europe |gcp |true |europe-west6 |builtin |cpln/city="Zurich" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="Switzerland" ||gcp-me-west1 |GCP, Tel Aviv, Israel, Middle East |gcp |true |me-west1 |builtin |cpln/city="Tel Aviv" || | | | | | |cpln/continent="Middle East" || | | | | | |cpln/country="Israel" ||gcp-northamerica-northeast1 |GCP, Montréal, Québec, Canada |gcp |true |northamerica-northeast1 |builtin |cpln/city="Montréal" || | | | | | |cpln/continent="North America" || | | | | | |cpln/country="Canada" ||gcp-northamerica-northeast2 |GCP, Toronto, Ontario, Canada |gcp |true |northamerica-northeast2 |builtin |cpln/city="Toronto" || | | | | | |cpln/continent="North America" || | | | | | |cpln/country="Canada" ||gcp-southamerica-east1 |GCP, Osasco, São Paulo, Brazil |gcp |true |southamerica-east1 |builtin |cpln/city="Osasco" || | | | | | |cpln/continent="South America" || | | | | | |cpln/country="Brazil" ||gcp-us-central1 |GCP, Council Bluffs, Iowa, USA |gcp |true |us-central1 |builtin |cpln/city="Council Bluffs" || | | | | | |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="IA" ||gcp-us-east1 |GCP, Moncks Corner, South Carolina, USA |gcp |true |us-east1 |builtin |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="SC" ||gcp-us-east4 |GCP, Ashburn, Northern Virginia, USA |gcp |true |us-east4 |builtin |cpln/city="Ashburn" || | | | | | |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="VA" ||gcp-us-west1 |GCP, The Dalles, Oregon, USA |gcp |true |us-west1 |builtin |cpln/city="The Dalles" || | | | | | |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="OR" ||gcp-us-west2 |GCP, Los Angeles, California, USA |gcp |true |us-west2 |builtin |cpln/city="Los Angeles" || | | | | | |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="CA" ||gcp-us-west3 |GCP, Salt Lake City, Utah, USA |gcp |true |us-west3 |builtin |cpln/city="Salt Lake City" || | | | | | |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="UT" ||gcp-us-west4 |GCP, Las Vegas, Nevada, USA |gcp |true |us-west4 |builtin |cpln/city="Las Vegas" || | | | | | |cpln/continent="North America" || | | | | | |cpln/country="USA" || | | | | | |cpln/state="NV" |+----------------------------+----------------------------------------+---------+--------+------------------------+--------+-------------------------------+
$ 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" |+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
$ 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" |+-------------+----------------------------------------+---------+--------+---------+--------+-------------------------------+
Update the referenced locations's metadata using an input file
Usage
copycpln location patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln location patch aws-eu-central-1 --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced location.
Show the grantable permissions for a location object type
Usage
copycpln location permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+-----------------------------------------+--------------------------------+
Find all the locations based on the given query
Usage
copycpln location query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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" |+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
$ 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" |+--------------+-----------------+---------+--------+--------+--------+-------------------------------+
$ 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" ||gcp-europe-west3 |GCP, Frankfurt, Germany, Europe |gcp |true |europe-west3 |builtin |cpln/city="Frankfurt" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="Germany" |+-----------------+--------------------------------+---------+--------+-------------+--------+------------------------+
$ 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" ||gcp-europe-west3 |GCP, Frankfurt, Germany, Europe |gcp |true |europe-west3 |builtin |cpln/city="Frankfurt" || | | | | | |cpln/continent="Europe" || | | | | | |cpln/country="Germany" |+-----------------+--------------------------------+---------+--------+-------------+--------+-------------------------------+
Manage the tags belonging to one or more referenced locations
Usage
copycpln location tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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" |+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
$ 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" |+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
$ 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" |+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
$ 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" |+-----------------+------------------------+---------+--------+-------------+--------+-------------------------------+
$ 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" |+-----------------+------------------------+---------+--------+-------------+--------+-----------------------------------+
$ 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" |+-----------------+------------------------+---------+--------+-------------+--------+-------------------------------+
Create a profile named "default" and launch a browser to begin the interactive login process
Usage
copycpln login [ref] [OPTIONS]
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]
$ cpln loginYour browser will be launched and redirected to the login page. After a successful login, a local profilenamed "default" will be created and the browser window can be closed. Use "Control-C" at the command prompt toexit the login command if an issues occurs.
Show logs
For a detailed overview, please visit the logs' reference page.
Usage
copycpln logs <query> [OPTIONS]
The <query>
positional requires a valid LogQL string enclosed within single quotes.
Available query labels: gvc
, workload
, container
, location
, provider
, replica
, stream
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]
$ 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.
Miscellaneous helper commands
copycpln 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
Install shell completion to your local profile
Usage
copycpln misc install-completion [OPTIONS]
Command options: --batch Non-interactive (batch) mode [boolean]
Options: --help Show help [boolean] --version Show version number [boolean]
$ cpln misc install-completionRunning the command will prompt the user with a few questions. Once compelete, the completion functionalitywill be installed. The shell will need to be restarted.
Uninstall shell completion from your local profile
Usage
copycpln misc uninstall-completion [OPTIONS]
Options: --help Show help [boolean] --version Show version number [boolean]
$ cpln misc uninstall-completionThe completion functionality will be removed.
Manage an mk8s cluster
copycpln 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
Show the access report for the referenced mk8s cluster
Usage
copycpln mk8s access-report <ref> [OPTIONS]
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]
Create a clone of the referenced mk8s cluster; this will only duplicate its spec.
Usage
copycpln mk8s clone <ref> --name CLONE_NAME [OPTIONS]
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]
Open the k8s dashboard for an mk8s cluster
Usage
copycpln mk8s dashboard <ref> [OPTIONS]
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]
Delete one or more referenced mk8s clusters
Usage
copycpln mk8s delete <ref...> [OPTIONS]
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]
Edit the referenced mk8s cluster, as YAML, within an editor
Usage
copycpln mk8s edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
Show the event log of the referenced mk8s cluster
Usage
copycpln mk8s eventlog <ref> [OPTIONS]
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]
Retrieve one or more referenced mk8s cluster
Usage
copycpln mk8s get [ref...] [OPTIONS]
An empty reference will return all references
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]
Join compute nodes to a cluster
Usage
copycpln mk8s join <ref> [OPTIONS]
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]
Create a kubeconfig for a cluster.
Usage
copycpln mk8s kubeconfig <ref> [OPTIONS]
Command options:
--file, -f file to save kubeconfig to, default is $KUBECONFIG if set, otherwise ~/.kube/config. Use --file -
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]
Update the referenced mk8s cluster's metadata using an input file
Usage
copycpln mk8s patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
Show the grantable permissions for an mk8s cluster object type
Usage
copycpln mk8s permissions [OPTIONS]
Format options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore 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]
Find all the mk8s clusters based on the given query
Usage
copycpln mk8s query QUERY_OPTIONS [OPTIONS]
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]
Manage the tags belonging to one or more referenced mk8s clusters
Usage
copycpln mk8s tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
Update properties of the referenced mk8s cluster
Usage
copycpln mk8s update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copydescription stringtags.<key> stringspec.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]
Manage organizations
For a detailed overview, please visit the org's reference page.
copycpln 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
Show the access report for the referenced organization
Usage
copycpln org access-report <ref> [OPTIONS]
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]
$ 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 |+-----------------+--------------------------------------------------------+--------+
Create a new organization
Usage
copycpln org create --name ORG_NAME [OPTIONS]
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]
name
$ cpln org create --name demo-cpln-organization --acountId ACCOUNT_ID --invitee EMAILIf successful, the new organization will be created.
Edit the referenced organization, as YAML, within an editor
Usage
copycpln org edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln org edit demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced organization
Usage
copycpln org eventlog <ref> [OPTIONS]
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]
$ cpln org eventlog demo-cpln-organizationThe event log for the referenced organization will be shown.
Retrieve one or more referenced organizations
Usage
copycpln org get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ cpln org get+-----------------------+------------------+----------------------------+----------------------+|NAME |DESCRIPTION |LINK |TAGS ||-----------------------|------------------|----------------------------|----------------------||demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" || | | |type="demo" |+-----------------------+------------------+----------------------------+----------------------+
$ 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" |+-----------------------+------------------+----------------------------+----------------------+
Update the referenced organization's metadata using an input file
Usage
copycpln org patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln org patch demo-cpln-organization --file update.jsonThe changes within the JSON file will be performed against the referenced organization.
Show the grantable permissions for an organization object type
Usage
copycpln org permissions [OPTIONS]
Context options:
--profile 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]
$ 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... | |+-----------------+-----------------------------------------+------------------------------------------------------------------------------------------------------+
Find all the organizations based on the given query
Usage
copycpln org query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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" |+-----------------------+------------------+----------------------------+----------------------+
$ 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" |+-----------------------+------------------+----------------------------+----------------------+
$ 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" |+-----------------------+------------------+----------------------------+----------------------+
$ 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" |+-----------------------+------------------+----------------------------+----------------------+
Manage the tags belonging to one or more referenced organizations
Usage
copycpln org tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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" |+-----------------------+------------------+----------------------------+----------------------+
$ 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" |+-----------------------+------------------+----------------------------+----------------------+
$ 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" |+-----------------------+------------------+----------------------------+----------------------+
Update properties of the referenced organization
Usage
copycpln org update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copydescription stringtags.<key> string [required]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
Format options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]
Debug options: --verbose, -v Enable verbose output to stderr [boolean][default: false] --debug, -d Show all HTTP communications [boolean][default: false]
Options: --help Show help [boolean]
--set
option allows the modification of the following organization properties:description
tags
+-----------------------+------------------+----------------------------+----------------------+|NAME |DESCRIPTION |LINK |TAGS ||-----------------------|------------------|----------------------------|----------------------||demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" || | | |type="demo" |+-----------------------+------------------+----------------------------+----------------------+
$ 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" |+-----------------------+----------------+----------------------------+----------------------+
$ 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" |+-----------------------+----------------+----------------------------+----------------------+
Manage access policies
For a detailed overview, please visit the policy's reference page.
copycpln 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
Show the access report for the referenced policy
Usage
copycpln policy access-report <ref> [OPTIONS]
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]
$ 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 |+-----------+--------------------------------------------------------+--------+
Bind one or more permissions to the referenced policy and associate it with one or more users / service accounts / groups / identities
Usage
copycpln policy add-binding <ref> --permission PERMISSION_NAME COMMAND_OPTIONS [OPTIONS]
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]
$ 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" |+------------+------------+--------------+------------+--------+--------+--------------+
Clone a policy
Usage
copycpln policy clone <ref> --name CLONE_NAME [OPTIONS]
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]
$ 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" |+------------------+---------------------+--------------+------------+--------+--------+--------------+
Create a new policy
Usage
copycpln policy create --name POLICY_NAME --target-king TARGET [OPTIONS]
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]
$ 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" |+------------+------------+--------------+------------+--------+--------+--------------+
Delete one or more referenced policies
Usage
copycpln policy delete <ref...> [OPTIONS]
Deleting a policy will remove all associated resources (targets, bindings, etc.)
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]
$ cpln policy delete demo-policy --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Edit the referenced policy, as YAML, within an editor
Usage
copycpln policy edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln policy edit demo-policy --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced policy
Usage
copycpln policy eventlog <ref> [OPTIONS]
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]
$ cpln policy eventlog demo-policy --org demo-cpln-organizationThe event log for the referenced policy will be shown.
Retrieve one or more referenced policies
Usage
copycpln policy get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ 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 ... |2 years ago |memcachecluster |all |builtin | ||superusers-mk8s |Built-in policy granting full access ... |1 year 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 ... |6 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 ... |1 year 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... |2 years ago |memcachecluster |all |builtin | ||viewers-mk8s |Built-in policy granting read-only ac... |1 year 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... |6 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... |1 year ago |volumeset |all |builtin | ||viewers-workload |Built-in policy granting read-only ac... |3 years ago |workload |all |builtin | |+---------------------------+-----------------------------------------+--------------+----------------+--------+--------+--------------+
$ 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 | |+------------------+------------------+--------------+------------+--------+--------+-----+
$ 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 | |+------------------+------------------+--------------+------------+--------+--------+-----+
Update the referenced policy's metadata using an input file
Usage
copycpln policy patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln policy patch demo-policy --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced policy.
Show the grantable permissions for a policy object type
Usage
copycpln policy permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+-------------------------+-----------------------------------+
Find all the policies based on the given query
Usage
copycpln policy query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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 |9 minutes ago |org |all |default |drink="water" |+------------+------------+--------------+------------+--------+--------+--------------+
$ 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 |9 minutes ago |org |all |default |drink="water" |+------------+------------+--------------+------------+--------+--------+--------------+
$ cpln policy query --match any --tag drink=water --org demo-cpln-organization+------------+------------+--------------+------------+--------+--------+--------------+|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS ||------------|------------|--------------|------------|--------|--------|--------------||demo-policy |demo-policy |9 minutes ago |org |all |default |drink="water" |+------------+------------+--------------+------------+--------+--------+--------------+
$ 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 |9 minutes ago |org |all |default |drink="water" |+------------+------------+--------------+------------+--------+--------+--------------+
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
copycpln policy remove-binding <ref> --permission PERMISSION_NAME COMMAND_OPTIONS [OPTIONS]
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]
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 |9 minutes ago |org |all |default |drink="water" |+------------+------------+--------------+------------+--------+--------+--------------+
Manage the tags belonging to one or more referenced policies
Usage
copycpln policy tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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" |+------------------+------------------+--------------+------------+--------+--------+--------------+
$ 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" |+------------------+------------------+--------------+------------+--------+--------+---------------+
$ 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 | |+------------------+------------------+--------------+------------+--------+--------+-----+
$ 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" |+------------------+------------------+--------------+------------+--------+--------+-------------------------+
$ 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" |+------------------+------------------+--------------+------------+--------+--------+--------------------------------+
$ 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 | |+------------------+------------------+--------------+------------+--------+--------+-----+
Update properties of the referenced policy
Usage
copycpln policy update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copydescription stringtags.<key> stringtargetLinks 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]
--set
option allows the modification of the following policy properties:description
tags
targetLinks
target
+------------+------------+--------------+------------+--------+--------+--------------+|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS ||------------|------------|--------------|------------|--------|--------|--------------||demo-policy |demo-policy |0 minutes ago |org |all |default |drink="water" |+------------+------------+--------------+------------+--------+--------+--------------+
$ 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" |+------------+----------------+---------------+------------+--------+--------+--------------+
$ 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" |+------------+----------------+---------------+------------+--------+--------+----------------------+
$ 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" |+------------+----------------+---------------+------------+--------+--------+----------------------+
$ 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" |+------------+----------------+---------------+------------+--------+--------+----------------------+
$ 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" |+------------+----------------+---------------+------------+--------+--------+----------------------+
Manage local profiles
For a detailed overview, please visit the manage CLI profiles guide.
copycpln 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
Delete one or more referenced profiles
Usage
copycpln profile delete <profiles...> [OPTIONS]
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]
$ cpln profile delete defaultA table showing the profile details will return if the delete was successful. Otherwise, an empty table will be displayed.
$ cpln profile delete demo-profile@example.com defaultA table showing the profile details will return if the delete was successful. Otherwise, an empty table will be displayed.
Retrieve one or more profiles
Usage
copycpln profile get [profiles...] [OPTIONS]
An empty reference will return all references
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]
$ 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 |+--------+---------------------+--------+-------+-------------------------+----------+----------+-------+-----------+
Create a profile named "default" and launch a browser to begin the interactive login process
Usage
copycpln profile login [ref] [OPTIONS]
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]
$ cpln profile loginA 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. PressControl-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 torestart the login.
Set the referenced profile as the default
Usage
copycpln profile set-default <profile> [OPTIONS]
Positionals: profile Profile name to be set as the default [required]
Options: --version Show version number [boolean] --help Show help [boolean]
$ cpln profile set-default demo-profileThe 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.
Show the JWT token of the referenced profile
Usage
copycpln profile token [profile] [OPTIONS]
An empty reference will return the token for the default profile
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]
$ cpln profile token demo-profileA 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 APIwithout needing to manually copy the token. After the server is running, by executing the 'cpln profile token --serve' command , the usercan 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());})------------------------
Manage the referenced profile
Usage
copycpln profile update <profile> COMMAND_OPTIONS [OPTIONS]
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]
$ cpln profile update new-profileIf the referenced profile name doesn't exist, a new one will be created.
$ cpln profile update new-profile --loginA 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.
$ cpln profile update new-profile --defaultIf the update was successful, the referenced profile will be set as the default for all future cpln commands.
$ cpln profile update new-profile --org demo-cpln-organization --gvc demo-gvcThe 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.
Show quotas
For a detailed overview, please visit the quota's reference page.
copycpln 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
Edit the referenced quota, as YAML, within an editor
Usage
copycpln quota edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln quota edit b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Retrieve one or more referenced quotas
Usage
copycpln quota get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ 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 | ||27acde85-acee-4e4a-a8d7-a00cba61b9a4 |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |5 |count |gvcLink="demo-cpln-gvc" ||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 | ||45c1c0ed-e056-4ebd-aec9-212b8725331e |identities-per-gvc |Max number of workload identities in ... |builtin |4 |20 |count |gvcLink="demo-gvc-identity" ||605d0bd8-1263-447c-a925-b5712bd7c5ae |cpu-per-workload |Max CPU per container |builtin |0 |1000 |millicore | ||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" ||a483dfab-fc45-493c-ac17-f32d1064237c |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |20 |count |gvcLink="demo-gvc-with-workloads" ||abce044e-ac2c-4284-9523-e3ad1a0e7644 |workloads-per-gvc |Max number of workloads in a gvc |builtin |1 |20 |count |gvcLink="demo-gvc-workload" ||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 | |+-------------------------------------+----------------------+-----------------------------------------+--------+--------+-----+----------+----------------------------------+
$ 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 | |+-------------------------------------+-----+--------------------+--------+--------+----+------+-----------+
$ 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 | |+-------------------------------------+--------+----------------------+--------+--------+----+------+-----------+
Update the referenced quota's metadata using an input file
Usage
copycpln quota patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln quota patch b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced quota.
Show the grantable permissions for a quota object type
Usage
copycpln quota permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+-----------------------+---------------------------+
Find all the quotas based on the given query
Usage
copycpln quota query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property, tag, or relation
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 | |+-------------------------------------+--------+----------------------+--------+--------+----+------+-----------+
Submit REST requests against the API
copycpln 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
Submit a POST request followed by a GET request against the referenced path
Usage
copycpln rest create <path> --file FILE_NAME [OPTIONS]
If using the option --file -, press Control-D (or Control-Z if you are using Windows) to submit the request
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]
$ cpln rest create /org --file create-org.jsonThe 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.
Submit a DELETE request against the referenced path
Usage
copycpln rest delete <path> [OPTIONS]
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]
$ cpln rest delete /org/demo-cpln-organization/gvc/demo-gvcThe GVC with the reference \`/org/demo-cpln-organization/gvc/demo-gvc\` will be deleted.
Launches the default editor with the contents of the referenced path
Usage
copycpln rest edit <path> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln rest edit /org/demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API as a PATCH request.
Submit a GET request against the referenced path
Usage
copycpln rest get <path> [OPTIONS]
An empty reference will return all references
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]
$ 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" |+-----------------------+------------------+----------------------------+----------------------+
Submit a PATCH request against the referenced path
Usage
copycpln rest patch <path> --file FILE_NAME [OPTIONS]
If using the option --file -, press Control-D (or Control-Z if you are using Windows) to submit the request
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]
$ cpln rest patch /org/demo-cpln-organization --file update-org.jsonThe metadata contained within the JSON file will be performed against the referenced path as a PATCH request.
Submit a POST request against the referenced path
Usage
copycpln rest post <path> --file FILE_NAME [OPTIONS]
If using the option --file -, press Control-D (or Control-Z if you are using Windows) to submit the request
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]
$ cpln rest post /org --file new-org.jsonThe metadata contained within the JSON file will be performed against the referenced path as a POST request.
Submit a PUT request against the referenced path
Usage
copycpln rest put <path> [OPTIONS]
If using the option --file -, press Control-D (or Control-Z if you are using Windows) to submit the request
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]
$ cpln rest put /org/demo-cpln-organization --file update-org.jsonThe metadata contained within the JSON file will be performed against the referenced path as a PUT request.
Manage secrets
For a detailed overview, please visit the secret's reference page.
copycpln 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
Show the access report for the referenced secret
Usage
copycpln secret access-report <ref> [OPTIONS]
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]
$ 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 |+-----------+--------------------------------------------------------+--------+
Create a clone of the referenced secret
Usage
copycpln secret clone <ref> --name CLONE_NAME [OPTIONS]
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]
$ 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" |+------------------+---------------------+---------+--------------+--------------+
Create a new AWS secret
Usage
copycpln secret create-aws --name SECRET_NAME --access-key AWS_ACCESS_KEY --secret-key AWS_SECRET_KEY [OPTIONS]
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 --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]
Create a new Azure Connector secret
Usage
copycpln secret create-azure-connector --name SECRET_NAME --url DEPLOYMENT_URL --code FUNCTION_APP_CODE [OPTIONS]
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]
Create a new Azure SDK secret
Usage
copycpln secret create-azure-sdk --name SECRET_NAME [OPTIONS]
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]
Create a new dictionary secret
Usage
copycpln secret create-dictionary --name SECRET_NAME --entry KEY=VALUE [OPTIONS]
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]
Create a new Docker secret
Usage
copycpln secret create-docker --name SECRET_NAME --file FILE_NAME
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]
Create a new ECR secret
Usage
copycpln secret create-ecr --name SECRET_NAME --access-key AWS_ACCESS_KEY --repo ECR_REPO [OPTIONS]
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 --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]
Create a new GCP secret
Usage
copycpln secret create-gcp --name FILE_NAME --file FILE_NAME [OPTIONS]
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]
Create a new KeyPair secret
Usage
copycpln secret create-keypair --name SECRET_NAME --secret PATH_TO_SECRET_KEY [OPTIONS]
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]
Create a new nats account secret
Usage
copycpln secret create-nats --name SECRET_NAME --account-id ACCOUNT_ID --private-key PRIVATE_KEY [OPTIONS]
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]
Create a new opaque secret
Usage
copycpln secret create-opaque --name SECRET_NAME --file FILE_NAME [OPTIONS]
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]
Create a new TLS secret
Usage
copycpln secret create-tls --name SECRET_NAME --key PATH_TO_KEY --cert PATH_TO_CERTIFICATE [OPTIONS]
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]
Create a new Username/Password secret
Usage
copycpln secret create-userpass --name SECRET_NAME --username USERNAME --password PASSWORD [OPTIONS]
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]
$ 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" |+------------+------------+---------+--------------+--------------+
Delete one or more referenced secrets
Usage
copycpln secret delete <ref...> [OPTIONS]
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]
$ cpln secret delete demo-secret --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Edit the referenced secret, as YAML, within an editor
Usage
copycpln secret edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln secret edit demo-secret --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced secret
Usage
copycpln secret eventlog <ref> [OPTIONS]
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]
$ cpln secret eventlog demo-secret --org demo-cpln-organizationThe event log for the referenced secret will be shown.
Retrieve one or more referenced secrets
Usage
copycpln secret get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ cpln secret get --org demo-cpln-organization+------------------+------------------+----------------+---------------+--------------+|NAME |DESCRIPTION |TYPE |CREATED |TAGS ||------------------|------------------|----------------|---------------|--------------||azure-secret |azure-secret |azure-connector |11 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 | |+------------------+------------------+----------------+---------------+--------------+
$ 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 | |+------------------+------------------+---------+--------------+-----+
$ 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 | |+------------------+------------------+---------+--------------+-----+
Update the referenced secret's metadata using an input file
Usage
copycpln secret patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln secret patch demo-secret --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced secret.
Show the grantable permissions for a secret object type
Usage
copycpln secret permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+-----------------------------------------+------------------------------------------------+
Find all the secrets based on the given query
Usage
copycpln secret query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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" |+------------+------------+---------+---------------+--------------+
$ 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" |+------------+------------+---------+---------------+--------------+
$ cpln secret query --match any --tag drink=water --org demo-cpln-organization+------------+------------+---------+---------------+--------------+|NAME |DESCRIPTION |TYPE |CREATED |TAGS ||------------|------------|---------|---------------|--------------||demo-secret |demo-secret |userpass |11 minutes ago |drink="water" |+------------+------------+---------+---------------+--------------+
$ 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 |11 minutes ago |drink="water" |+------------+------------+---------+---------------+--------------+
Show the secret in plaintext
Usage
copycpln secret reveal [ref] [OPTIONS]
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]
$ cpln secret reveal demo-secret --org demo-cpln-organization+------------+------------+---------+---------------+--------------+|NAME |DESCRIPTION |TYPE |CREATED |TAGS ||------------|------------|---------|---------------|--------------||demo-secret |demo-secret |userpass |11 minutes ago |drink="water" |+------------+------------+---------+---------------+--------------+
Manage the tags belonging to one or more referenced secrets
Usage
copycpln secret tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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" |+------------------+------------------+---------+--------------+--------------+
$ 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" |+------------------+------------------+---------+--------------+---------------+
$ 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 | |+------------------+------------------+---------+--------------+-----+
$ 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" |+------------------+------------------+---------+--------------+------------------------+
$ 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" |+------------------+------------------+---------+--------------+-------------------------------+
$ 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 | |+------------------+------------------+---------+--------------+-----+
Update properties of the referenced secret
Usage
copycpln secret update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copydescription stringtags.<key> string [required]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the cpln profile update
command
Format options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]
Debug options: --verbose, -v Enable verbose output to stderr [boolean][default: false] --debug, -d Show all HTTP communications [boolean][default: false]
Options: --help Show help [boolean]
--set
option allows the modification of the following secret properties:description
tags
targetLinks
target
+-------------------+-------------------+---------+--------------+-----+|NAME |DESCRIPTION |TYPE |CREATED |TAGS ||-------------------|-------------------|---------|--------------|-----||demo-secret-update |demo-secret-update |userpass |0 minutes ago | |+-------------------+-------------------+---------+--------------+-----+
$ 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 | |+-------------------+----------------+---------+--------------+-----+
$ 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" |+-------------------+----------------+---------+--------------+----------------------+
Manage service accounts
For a detailed overview, please visit the service account's reference page.
copycpln 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
Show the access report for the referenced service account
Usage
copycpln serviceaccount access-report <ref> [OPTIONS]
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]
$ 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 |+-----------+--------------------------------------------------------+--------+
Add a key to the reference service account
Usage
copycpln serviceaccount add-key <ref> --description KEY_DESCRIPTION [OPTIONS]
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]
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-05-16T15:24:00.282Z","key": "s59GFJRR3gpIb0cg.ZGVtby1jcGxuLW9yZ2FuaXphdGlvbi5kZW1vLXNlcnZpY2UtYWNjb3VudC5ZTUFhbmlkWV90TjlOOTdqZHlMRjR4SXRhTlQ3bUF6LVNuSzFidVZBS3k4.PGCgdfZ92vpa5nM-8qCrsmjCrOkevpAxjv3jyhF7G6k"}
Create a clone of the referenced service account; this will only duplicate its spec.
Usage
copycpln serviceaccount clone <ref> --name CLONE_NAME [OPTIONS]
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]
$ 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" |+---------------------------+------------------------------+--------------+--------+-----+--------------+
Create a new service account
Usage
copycpln serviceaccount create --name SERVICE_ACCOUNT_NAME [OPTIONS]
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]
$ 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" |+---------------------+---------------------+--------------+--------+-----+--------------+
Delete one or more referenced service accounts
Usage
copycpln serviceaccount delete <ref...> [OPTIONS]
Deleting a service account will remove all associated keys
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]
$ cpln serviceaccount delete demo-service-account --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Edit the referenced service account, as YAML, within an editor
Usage
copycpln serviceaccount edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln serviceaccount edit demo-service-account --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced service account
Usage
copycpln serviceaccount eventlog <ref> [OPTIONS]
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]
$ cpln serviceaccount eventlog demo-service-account --org demo-cpln-organizationThe event log for the referenced service account will be shown.
Retrieve one or more referenced service accounts
Usage
copycpln serviceaccount get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ 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 |7 months ago |default |sOajhentlsc226k8 | ||demo-service-account |demo-service-account |12 minutes ago |default |s59GFJRR3gpIb0cg |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 | | |+---------------------------+-----------------------------------------+---------------+--------+-----------------+--------------+
$ 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 | | |+---------------------------+---------------------------+--------------+--------+-----+-----+
$ 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 | | |+---------------------------+---------------------------+--------------+--------+-----+-----+
Update the referenced service account's metadata using an input file
Usage
copycpln serviceaccount patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln serviceaccount patch demo-service-account --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced service account.
Show the grantable permissions for a service account object type
Usage
copycpln serviceaccount permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+---------------------------------------+-------------------------------------------+
Find all the service accounts based on the given query
Usage
copycpln serviceaccount query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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 |12 minutes ago |default |s59GFJRR3gpIb0cg |drink="water" |+---------------------+---------------------+---------------+--------+-----------------+--------------+
$ 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 |12 minutes ago |default |s59GFJRR3gpIb0cg |drink="water" |+---------------------+---------------------+---------------+--------+-----------------+--------------+
$ cpln serviceaccount query --match any --tag drink=water --org demo-cpln-organization+---------------------+---------------------+---------------+--------+-----------------+--------------+|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS ||---------------------|---------------------|---------------|--------|-----------------|--------------||demo-service-account |demo-service-account |12 minutes ago |default |s59GFJRR3gpIb0cg |drink="water" |+---------------------+---------------------+---------------+--------+-----------------+--------------+
$ 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 |12 minutes ago |default |s59GFJRR3gpIb0cg |drink="water" |+---------------------+---------------------+---------------+--------+-----------------+--------------+
Remove a key from the reference service account
Usage
copycpln serviceaccount remove-key <ref> --key KEY_TO_REMOVE [OPTIONS]
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]
+---------------------+---------------------+--------------+--------+-----+--------------+|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS ||---------------------|---------------------|--------------|--------|-----|--------------||demo-service-account |demo-service-account |0 minutes ago |default | |drink="water" |+---------------------+---------------------+--------------+--------+-----+--------------+
$ cpln serviceaccount remove-key demo-service-account --key sbJMPpMQzDE3T8FI --org demo-cpln-organization+---------------------+---------------------+---------------+--------+-----------------+--------------+|NAME |DESCRIPTION |CREATED |ORIGIN |KEYS |TAGS ||---------------------|---------------------|---------------|--------|-----------------|--------------||demo-service-account |demo-service-account |12 minutes ago |default |s59GFJRR3gpIb0cg |drink="water" |+---------------------+---------------------+---------------+--------+-----------------+--------------+
Manage the tags belonging to one or more referenced service accounts
Usage
copycpln serviceaccount tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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" |+---------------------------+---------------------------+--------------+--------+-----+--------------+
$ 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" |+---------------------------+---------------------------+--------------+--------+-----+---------------+
$ 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 | | |+---------------------------+---------------------------+--------------+--------+-----+-----+
$ 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" |+---------------------------+---------------------------+--------------+--------+-----+--------------------------------+
$ 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" |+---------------------------+---------------------------+--------------+--------+-----+-----------------------------------------------+
$ 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 | | |+---------------------------+---------------------------+--------------+--------+-----+-----+
manage docker-compose files
Refer to the Compose Deploy guide for additional details.
copycpln 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
deploy from a docker-compose file
Refer to the compose deploy guide for more details.
Usage
copycpln stack deploy [OPTIONS]
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]
$ cpln stack deployCreated /org/demo-cpln-organization/secret/demo-secretCreated /org/demo-cpln-organization/gvc/demo-cpln-gvc/identity/demo-identityCreated /org/demo-cpln-organization/gvc/demo-cpln-gvc/volumeset/demo-volumeCreated /org/demo-cpln-organization/gvc/demo-cpln-gvc/workload/demo-workloadCreated /org/demo-cpln-organization/policy/demo-policy
Generate a CPLN spec file from a compose project. Outputs result to stdout. Note: this command will build and push images to CPLN
Usage
copycpln stack manifest [OPTIONS]
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]
$ cpln stack manifestcopykind: secretname: demo-secretdescription: demo-secrettype: opaquedata:encoding: plainpayload: demo secret---kind: identityname: demo-identitydescription: Identity to allow demo-workload to reveal secret---kind: volumesetname: demo-volumedescription: demo-volumespec:fileSystemType: ext4initialCapacity: 10performanceClass: general-purpose-ssd---kind: workloadname: demo-workloaddescription: demo-workloadspec:type: standardcontainers:- name: demo-workload-containercpu: 250mmemory: 53Miports:- number: 3000image: demo-image:1.0volumes:- path: /secrets/secret.txturi: 'cpln://secret/demo-secret'recoveryPolicy: retaindefaultOptions:capacityAI: falseidentityLink: /org/demo-cpln-organization/gvc/demo-cpln-gvc/identity/demo-identityfirewallConfig:external:inboundAllowCIDR:- 0.0.0.0/0outboundAllowCIDR:- 0.0.0.0/0---kind: policyname: demo-policydescription: Policy for workloads to reveal demo-secretbindings:- permissions:- revealprincipalLinks:- /org/demo-cpln-organization/gvc/demo-cpln-gvc/identity/demo-identitytargetKind: secrettargetLinks:- /org/demo-cpln-organization/secret/demo-secret
Delete all resources generated from a docker compose project.
Usage
copycpln stack rm [OPTIONS]
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]
$ cpln stack rmDeleted /org/demo-cpln-organization/secret/demo-secretDeleted /org/demo-cpln-organization/gvc/demo-cpln-gvc/identity/demo-identityDeleted /org/demo-cpln-organization/gvc/demo-cpln-gvc/volumeset/demo-volumeDeleted /org/demo-cpln-organization/gvc/demo-cpln-gvc/workload/demo-workloadDeleted /org/demo-cpln-organization/policy/demo-policy
Manage pending tasks
copycpln 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
Complete the referenced task
Usage
copycpln task complete <ref> --answer {accept|reject} [OPTIONS]
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]
Delete one or more referenced tasks
Usage
copycpln task delete <ref...> [OPTIONS]
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]
Retrieve one or more referenced tasks
Usage
copycpln task get [ref...] [OPTIONS]
An empty reference will return all references
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]
Retrieve one or more referenced tasks for the current or overridden profile
Usage
copycpln task get-mine [ref...] [OPTIONS]
An empty reference will return all tasks for the current or overridden profile
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]
Show the grantable permissions for a task object type
Usage
copycpln task permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+-------+-----------------------------+---------------------------+
Find all the tasks based on the given query
Usage
copycpln task query QUERY_OPTIONS [OPTIONS]
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]
Manage users
For a detailed overview, please visit the user's reference page.
copycpln 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
Show the access report for the referenced user
Usage
copycpln user access-report <ref> [OPTIONS]
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]
$ 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 |+------------+--------------------------------------------------------+--------+
Delete one or more referenced users
Usage
copycpln user delete <ref...> [OPTIONS]
Deleting a user will remove all associated resources (permissions, group memberships, etc.)
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]
$ cpln user delete demo-user@controlplane.com --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Edit the referenced user, as YAML, within an editor
Usage
copycpln user edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln user edit test-128@example.com --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced user
Usage
copycpln user eventlog <ref> [OPTIONS]
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]
$ cpln user eventlog test-128@example.com --org demo-cpln-organizationThe event log for the referenced user will be shown.
Retrieve one or more referenced users
Usage
copycpln user get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ 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" ||rMdL2BFDxEeYQPA5qRYGbLivhVS2 |Kyle Cupp |kyle@controlplane.com |2 months ago |firebase |firebase/sign_in_provider="microsoft.com" |+-----------------------------+---------------------+----------------------+-------------+---------+------------------------------------------+
$ 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" |+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
Invite users to the current or overridden organization
Usage
copycpln user invite --email EMAIL_ADDRESS [--group GROUP_NAME] [OPTIONS]
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]
$ cpln user invite --email demo@controlplane.com --org demo-cpln-organizationIf the invite request was successful, a JSON output with the task ID will be shown.
Update the referenced user's metadata using an input file
Usage
copycpln user patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln user patch test-128@example.com --file update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced user.
Show the grantable permissions for a user object type
Usage
copycpln user permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can 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]
$ 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 | |+------------+-----------------------------+------------------------------------------------+
Find all the users based on the given query
Usage
copycpln user query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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" |+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
$ 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" |+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
$ 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" |+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
Manage the tags belonging to one or more referenced users
Usage
copycpln user tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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" |+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
$ 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" |+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
$ 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" |+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
Update properties of the referenced user
Usage
copycpln user update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copytags.<key> string [required]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the cpln profile update
command
Format options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]
Debug options: --verbose, -v Enable verbose output to stderr [boolean][default: false] --debug, -d Show all HTTP communications [boolean][default: false]
Options: --help Show help [boolean]
--set
option allows the modification of the following user properties:+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+|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" |+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
$ 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" |+-----------------------------+---------------------+---------------------+------------+---------+-------------------------------------+
Manage a persistent volumeset within a global virtual cloud
For a detailed overview, please visit the volumeset's reference page.
copycpln volumeset [SUBCOMMAND]
Commands: cpln volumeset access-report <ref> Show the access report for the referenced volume set 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 cpln volumeset volume Manage volume set volumes
Options: --help Show help [boolean]
volumeset Subcommands
Show the access report for the referenced volume set
Usage
copycpln volumeset access-report <ref> [OPTIONS]
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]
Create a new volume set
Usage
copycpln volumeset create --name NAME [OPTIONS]
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]
Delete one or more referenced volume sets
Usage
copycpln volumeset delete <ref...> [OPTIONS]
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]
Edit the referenced volume set, as YAML, within an editor
Usage
copycpln volumeset edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
Show the event log of the referenced volume set
Usage
copycpln volumeset eventlog <ref> [OPTIONS]
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]
Expand the size of one or more volumes in the referenced volume set
Usage
copycpln volumeset expand <ref> [OPTIONS]
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]
Retrieve one or more referenced volume sets
Usage
copycpln volumeset get [ref...] [OPTIONS]
An empty reference will return all references
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]
Update the referenced volume set's metadata using an input file
Usage
copycpln volumeset patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
Show the grantable permissions for a volume set object type
Usage
copycpln volumeset permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the 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]
Find all the volume sets based on the given query
Usage
copycpln volumeset query QUERY_OPTIONS [OPTIONS]
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]
Manage volume set snapshots
copycpln 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
Create one or more snapshots by a volume set reference
Usage
copycpln volumeset snapshot create <ref> [OPTIONS]
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]
Delete one or more snapshots by a volume set reference
Usage
copycpln volumeset snapshot delete <ref> [OPTIONS]
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]
Retrieve one or more snapshots by a volume set reference
Usage
copycpln volumeset snapshot get <ref> [OPTIONS]
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]
Restore a snapshot to a volume
Usage
copycpln volumeset snapshot restore <ref> [OPTIONS]
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]
Manage the tags belonging to one or more referenced volume sets
Usage
copycpln volumeset tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
Update properties of the referenced volume set
Usage
copycpln volumeset update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copydescription stringtags.<key> stringspec.initialCapacity numberspec.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]
Manage volume set volumes
copycpln volumeset volume [SUBCOMMAND]
Commands: cpln volumeset volume delete <ref> Delete one or more volumes by a volume set reference cpln volumeset volume get <ref> Retrieve one or more volumes by a volume set reference
Options: --help Show help [boolean]
volume Subcommands
Delete one or more volumes by a volume set reference
Usage
copycpln volumeset volume delete <ref> [OPTIONS]
Positionals: ref The resource reference. Usually it is the name of the resource. [required]
Command options: --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]
$ cpln volumeset volume delete demo-volume-set --location aws-eu-central-1 --volume-index 0+-----------------+-------------+----------+|LOCATION |VOLUME INDEX |LIFECYCLE ||-----------------|-------------|----------||aws-eu-central-1 |0 |Deleting |+-----------------+-------------+----------+
Retrieve one or more volumes by a volume set reference
Usage
copycpln volumeset volume get <ref> [OPTIONS]
Positionals: ref The resource reference. Usually it is the name of the resource. [required]
Command options: --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]
$ cpln volumeset volume get demo-volume-set+-----------------+-------------+----------+|LOCATION |VOLUME INDEX |LIFECYCLE ||-----------------|-------------|----------||aws-eu-central-1 |0 |Bound |+-----------------+-------------+----------+
Manage workloads within a global virtual cloud
For a detailed overview, please visit the workload's reference page.
copycpln 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
Show the access report for the referenced workload
Usage
copycpln workload access-report <ref> [OPTIONS]
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]
$ 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 |+---------------------+--------------------------------------------------------+--------+
Create a clone of the referenced workload; this will only duplicate its spec.
Usage
copycpln workload clone <ref> --name CLONE_NAME [OPTIONS]
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]
$ 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-148ej7hqkxkwr.t.cpln.app |drink="water" |+--------------------+-----------------------+------------------+----------+--------------+-----------------------------------------------------+--------------+
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
copycpln workload connect <ref> --location LOCATION [OPTIONS]
Positionals: ref The resource reference. Usually it is the name of the resource. [required]
Command options: --location A global virtual cloud location [string][required] --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]
Create a new workload
Usage
copycpln workload create --name WORKLOAD_NAME --image IMAGE_NAME [OPTIONS]
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
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]
name
image
port
cpu
memory
NOTE: The ratio between CPU to Memory can be at most 1/8.
$ 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-148ej7hqkxkwr.t.cpln.app |drink="water" |+--------------+--------------+------------------+----------+--------------+-----------------------------------------------+--------------+
Manage cron workloads
copycpln 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
Get a list of job executions for the referenced workload
Usage
copycpln workload cron get <ref> [OPTIONS]
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]
$ cpln workload cron get demo-cron-workload+-------------------+-----------------+-------------------------------------+-------+----------------------+----------------------+|WORKLOAD |LOCATION |NAME OR COMMAND ID |STATUS |START TIME |COMPLETION TIME ||-------------------|-----------------|-------------------------------------|-------|----------------------|----------------------||demo-cron-workload │aws-eu-central-1 |ce770d2b-2b7f-4415-b41e-961f161bcd86 |Active |3/30/2024, 3:29:47 AM |3/30/2024, 3:30:14 AM |+-------------------+-----------------+-------------------------------------+-------+----------------------+----------------------+
Start a cron job
Usage
copycpln workload cron start <ref> [OPTIONS]
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]
$ cpln workload cron start demo-cron-workload+-------------------+-----------------+-------------------------------------+-------+----------------------+----------------+|WORKLOAD |LOCATION |NAME OR COMMAND ID |STATUS |START TIME |COMPLETION TIME ||-------------------|-----------------|-------------------------------------|-------|----------------------|----------------||demo-cron-workload │aws-eu-central-1 |ce770d2b-2b7f-4415-b41e-961f161bcd86 |Active |3/30/2024, 3:29:47 AM | |+-------------------+-----------------+-------------------------------------+-------+----------------------+----------------+
$ cpln workload cron start demo-cron-workload --container-name demo --command bash --arg echo --arg hello --arg world --env APP_MODE=dev --location aws-eu-central-1+-------------------+-----------------+-------------------------------------+-------+----------------------+----------------+|WORKLOAD |LOCATION |NAME OR COMMAND ID |STATUS |START TIME |COMPLETION TIME ||-------------------|-----------------|-------------------------------------|-------|----------------------|----------------||demo-cron-workload │aws-eu-central-1 |2afa5cbc-049d-455b-96bc-db4cf459def3 |Active |3/30/2024, 3:29:47 AM | |+-------------------+-----------------+-------------------------------------+-------+----------------------+----------------+
Example File
copyname: demoenv:- name: APP_MODEvalue: devcommand: bashargs:- echo- hello- world---name: demoenv:- name: APP_MODEvalue: prodcommand: bashargs:- ls
Usage
$ cpln workload cron start demo-cron-workload --file overrideContainerFile.yaml --location aws-eu-central-1+-------------------+-----------------+-------------------------------------+-------+----------------------+----------------+|WORKLOAD |LOCATION |NAME OR COMMAND ID |STATUS |START TIME |COMPLETION TIME ||-------------------|-----------------|-------------------------------------|-------|----------------------|----------------||demo-cron-workload │aws-eu-central-1 |beac030b-8e54-46c1-acbe-aa19e1682258 |Active |3/30/2024, 3:29:47 AM | |+-------------------+-----------------+-------------------------------------+-------+----------------------+----------------+
Delete one or more referenced workloads
Usage
copycpln workload delete <ref...> [OPTIONS]
Deleting a workload will remove all associated resources (containers, etc.)
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]
$ cpln cpln workload delete demo-workload-1 --org demo-cpln-organization --gvc demo-gvc-workloadIf the delete was successful, a new command prompt will be shown.
$ cpln workload delete demo-workload-1 demo-workload-2 --org demo-cpln-organization --gvc demo-gvc-workloadIf the delete was successful, a new command prompt will be shown.
Edit the referenced workload, as YAML, within an editor
Usage
copycpln workload edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
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]
$ cpln workload edit demo-workload --org demo-cpln-organization --gvc demo-gvc-workloadYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced workload
Usage
copycpln workload eventlog <ref> [OPTIONS]
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]
$ cpln workload eventlog demo-workload --org demo-cpln-organization --gvc demo-gvc-workloadThe event log for the referenced workload will be shown.
Exec a command on a replica of the workload.
Refer to the cpln workload exec guide for additional details.
Usage
copycpln workload exec <ref> --location LOCATION -- COMMAND ARG1 ARG2 [OPTIONS]
Positionals: ref The resource reference. Usually it is the name of the resource. [required]
Command options: --location A global virtual cloud location [string][required] --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]
copycpln workload exec index --location aws-eu-central-1 -- ls /etc | grep group
Force redeployment of the referenced workload(s).
Usage
copycpln workload force-redeployment <ref...> [OPTIONS]
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]
Retrieve one or more referenced workloads
Usage
copycpln workload get [ref...] [OPTIONS]
An empty reference will return all references
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]
$ cpln workload get --org demo-cpln-organization --gvc demo-gvc-workload+--------------------+--------------------+------------------+------+---------------+-----------------------------------------------------+--------------+|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS ||--------------------|--------------------|------------------|------|---------------|-----------------------------------------------------|--------------||demo-workload-get-2 |demo-workload-get-2 |demo-gvc-workload |false |0 minutes ago |https://demo-workload-get-2-148ej7hqkxkwr.t.cpln.app | ||demo-workload-get-1 |demo-workload-get-1 |demo-gvc-workload |false |0 minutes ago |https://demo-workload-get-1-148ej7hqkxkwr.t.cpln.app | ||demo-workload |demo-workload |demo-gvc-workload |true |14 minutes ago |https://demo-workload-148ej7hqkxkwr.t.cpln.app |drink="water" |+--------------------+--------------------+------------------+------+---------------+-----------------------------------------------------+--------------+
$ 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-148ej7hqkxkwr.t.cpln.app | |+--------------------+--------------------+------------------+------+--------------+-----------------------------------------------------+-----+
$ 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-148ej7hqkxkwr.t.cpln.app | ||demo-workload-get-2 |demo-workload-get-2 |demo-gvc-workload |false |0 minutes ago |https://demo-workload-get-2-148ej7hqkxkwr.t.cpln.app | |+--------------------+--------------------+------------------+------+--------------+-----------------------------------------------------+-----+
Retrieve the current deployments of the referenced workload
Usage
copycpln workload get-deployments <ref> [OPTIONS]
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]
$ 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":{... |+-----------------+--------------+---------------------------------------------------------------------------------+
Get the replicas of the referenced workload in a given location
Usage
copycpln workload get-replicas <ref> --location LOCATION [OPTIONS]
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]
$ 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|+-----------------------------------------------+
Open the referenced workload's endpoint in your browser
Usage
copycpln workload open <ref> [OPTIONS]
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]
$ cpln workload open demo-workload --gvc demo-gvc --org $2The endpoint for this workload will be opened in the default browser
Update the referenced workload's metadata using an input file
Usage
copycpln workload patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
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]
$ cpln workload patch demo-workload --file workload-update.json --org $2The 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
Show the grantable permissions for a workload object type
Usage
copycpln workload permissions [OPTIONS]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the 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]
$ 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 | |+---------------------+-----------------------------------------+------------------------------------------------------------------------------------------+
Find all the workloads based on the given query
Usage
copycpln workload query QUERY_OPTIONS [OPTIONS]
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]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ 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 | |14 minutes ago |https://demo-workload-148ej7hqkxkwr.t.cpln.app |drink="water" |+--------------+--------------+------------------+----------+---------------+-----------------------------------------------+--------------+
$ 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 | |14 minutes ago |https://demo-workload-148ej7hqkxkwr.t.cpln.app |drink="water" |+--------------+--------------+------------------+----------+---------------+-----------------------------------------------+--------------+
$ 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 | |14 minutes ago |https://demo-workload-148ej7hqkxkwr.t.cpln.app |drink="water" |+--------------+--------------+------------------+----------+---------------+-----------------------------------------------+--------------+
$ 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 | |14 minutes ago |https://demo-workload-148ej7hqkxkwr.t.cpln.app |drink="water" |+--------------+--------------+------------------+----------+---------------+-----------------------------------------------+--------------+
Manage workload replicas
copycpln workload replica [SUBCOMMAND]
Commands: cpln workload replica get <ref> Get the replica of the referenced workload in a given location cpln workload replica stop <ref> Stop the replica of the referenced workload in a given location
Options: --help Show help [boolean]
replica Subcommands
Get the replica of the referenced workload in a given location
Usage
copycpln workload replica get <ref> [OPTIONS]
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]
Stop the replica of the referenced workload in a given location
Usage
copycpln workload replica stop <ref> [OPTIONS]
Positionals: ref The resource reference. Usually it is the name of the resource. [required]
Command options: --replica-name Name of the replica [string][required] --location A global virtual cloud location [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]
$ cpln workload replica stop demo-workload --replica-name demo-workload-0 --location aws-eu-central-1+-----------------+-----------------+-------------------+---------+----------------------+----------------+|WORKLOAD |LOCATION |REPLICA |STATUS |START TIME |COMPLETION TIME ||-----------------|-----------------|-------------------|---------|----------------------|----------------||demo-workload |aws-eu-central-1 |demo-workload-0 |Stopping |3/30/2024, 4:02:12 AM | |+-----------------+-----------------+-------------------+---------+----------------------+----------------+
Run a command with a workload instance.
Refer to the cpln workload run guide for additional details.
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
copycpln workload run -- COMMAND [OPTIONS]
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]
copycpln workload run --org demo-cpln-organization --gvc demo-gvc -- ls -al
Start the workload(s)
Usage
copycpln workload start <ref...> [OPTIONS]
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]
copycpln workload start demo-workload --org demo-cpln-organization --gvc demo-gvc
Stop the workload(s)
Usage
copycpln workload stop <ref...> [OPTIONS]
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]
copycpln workload stop demo-workload --org demo-cpln-organization --gvc demo-gvc
Manage the tags belonging to one or more referenced workloads
Usage
copycpln workload tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
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]
$ 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-148ej7hqkxkwr.t.cpln.app |drink="water" |+--------------------+--------------------+------------------+----------+--------------+-----------------------------------------------------+--------------+
$ 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-148ej7hqkxkwr.t.cpln.app |drink="coffee" |+--------------------+--------------------+------------------+----------+--------------+-----------------------------------------------------+---------------+
$ 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-148ej7hqkxkwr.t.cpln.app | |+--------------------+--------------------+------------------+----------+--------------+-----------------------------------------------------+-----+
$ 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-148ej7hqkxkwr.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-148ej7hqkxkwr.t.cpln.app |multiple-workloads="true" |+--------------------+--------------------+------------------+----------+--------------+-----------------------------------------------------+--------------------------+
$ 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-148ej7hqkxkwr.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-148ej7hqkxkwr.t.cpln.app |multiple-workloads="demo-workload" |+--------------------+--------------------+------------------+----------+--------------+-----------------------------------------------------+-----------------------------------+
$ 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-148ej7hqkxkwr.t.cpln.app | ||demo-workload-tag-2 |demo-workload-tag-2 |demo-gvc-workload | |0 minutes ago |https://demo-workload-tag-2-148ej7hqkxkwr.t.cpln.app | |+--------------------+--------------------+------------------+----------+--------------+-----------------------------------------------------+-----+
Update properties of the referenced workload
Usage
copycpln workload update <ref> --set UPDATE_PROPERTY [OPTIONS]
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"):
copydescription stringtags.<key> stringspec.identityLink stringspec.containers.<name>.image stringspec.containers.<name>.workingDir stringspec.containers.<name>.metrics.port stringspec.containers.<name>.metrics.path stringspec.containers.<name>.cpu stringspec.containers.<name>.memory stringspec.containers.<name>.command stringspec.containers.<name>.args string[]spec.containers.<name>.env.<name>.value stringspec.containers.<name>.inheritEnv booleanspec.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 numberspec.defaultOptions.autoscaling.minScale numberspec.defaultOptions.autoscaling.maxScale numberspec.defaultOptions.autoscaling.scaleToZeroDelay numberspec.defaultOptions.autoscaling.maxConcurrency numberspec.defaultOptions.timeoutSeconds numberspec.defaultOptions.capacityAI booleanspec.defaultOptions.debug booleanspec.defaultOptions.suspend booleanspec.job.schedule stringspec.job.concurrencyPolicy { 'Forbid' | 'Replace' }spec.job.historyLimit numberspec.job.restartPolicy { 'OnFailure' | 'Never' }spec.job.activeDeadlineSeconds numberArrays 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]
--set
option allows the modification of the following workload properties:tags
spec.identityLink
spec.containers\.<name\>.image
spec.containers\.<name\>.port
spec.containers\.<name\>.cpu
spec.containers\.<name\>.memory
spec.containers\.<name\>.env\.<name\>.value
spec.firewallConfig.external.outboundAllowHostname
spec.firewallConfig.external.outboundAllowCIDR
spec.firewallConfig.external.inboundAllowCIDR
["0.0.0.0/0"]
to allow all inbound requestsspec.firewallConfig.internal.inboundAllowType
spec.firewallConfig.internal.inboundAllowWorkload
NOTE: The ratio between CPU to Memory can be at most 1/8.
+---------------------+---------------------+------------------+----------+--------------+------------------------------------------------------+-----+|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS ||---------------------|---------------------|------------------|----------|--------------|------------------------------------------------------|-----||demo-workload-update |demo-workload-update |demo-gvc-workload | |0 minutes ago |https://demo-workload-update-148ej7hqkxkwr.t.cpln.app | |+---------------------+---------------------+------------------+----------+--------------+------------------------------------------------------+-----+
$ 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-148ej7hqkxkwr.t.cpln.app | |+---------------------+----------------+------------------+----------+--------------+------------------------------------------------------+-----+
$ 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-148ej7hqkxkwr.t.cpln.app |demo-key="demo-value" |+---------------------+----------------+------------------+----------+--------------+------------------------------------------------------+----------------------+
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-148ej7hqkxkwr.t.cpln.app |demo-key="demo-value" |+---------------------+----------------+------------------+----------+--------------+------------------------------------------------------+----------------------+
The options listed below are common to most of the subcommands.
Use the option --help
on each subcommand to view the options available.
--name
--description
or --desc
--tag
1234
recorded as the value.--tag environment=prod
--file
or -f
--file -
to enable input from standard inputapply
command and patch
subcommand--manage
--profile
CPLN_PROFILE
to set a default profile--org
--gvc
--output
or -o
text
, json
, and yaml
text
json
or yaml
to view the full response.--color
true
--ts
iso
, local
, and age
--output=text
--max
0
(all records)Used within the query
subcommands:
--match
all
, none
, and any
all
--property
or --prop
--property name=demo-agent
--tag
--tag environment=prod
--rel
--token
--endpoint
--insecure
or -k
--verbose
or -v
--debug
or -d
Display the CLI help menu
Usage
copycpln --help
copycpln COMMAND --help
copycpln COMMAND SUBCOMMAND --help
Display the CLI version
Usage
copycpln --version