Quickstart
Concepts
Guides
- Command Line Interface
- Configure Resources
- Observability
- Create Resources
- GitOps
- Image Management
External Logging
Kubernetes (Managed)
Bring your Own Kubernetes (BYOK)
- Overview
- Custom Settings
Terraform Provider
Pulumi Provider
Kubernetes Operator
Reference
Command Line Interface
Installation
The Control Plane CLI (cpln) can be installed by using npm, homebrew or by downloading the specific binary package for the target operating system.
- Requires: Node.js version 12+
Execute the following command to install the CLI:
Copy
Ask AI
npm install -g @controlplane/cli
- Requires: Node.js version 12+
Execute the following command to install the CLI:
Copy
Ask AI
npm install -g @controlplane/cli
Follow these instructions to install homebrew.
Execute the following command to install the CLI:
Copy
Ask AI
brew tap controlplane-com/cpln && brew install cpln
In cases where Node.js cannot be used, select the package that matches the target operating system:
| OS | File | sha256 |
|---|---|---|
| macOS-arm64 | cpln-macos-arm64.dmg | 801d7abcba78123d57417159bc22a38a25adf2d9b96bc0428e5a0a93e7b3abee |
| macOS-x64 | cpln-macos-x64.dmg | 175967f3de2a9edb58d4d966321f3655e41d4a75402e25c05b082795368e5e50 |
| Linux | cpln-linux.tgz | ae3cbe70c3e2042eb20d2ad657a7c16fda5bffcbfe6ccba99885bc651e79f9ee |
| Windows 10/11 | cpln-win.zip | 92f30718822d14b3ee59c4e6b54a9b6aba3699391bcb411061f4e0b7022a4855 |
-
After the package has been downloaded, decompress it to a location within the
PATH -
Decompression helper commands:
OS Command macOS-arm64 hdiutil attach cpln-macos-arm64.dmg && cp -R /Volumes/cpln-macos-arm64/cpln /Volumes/cpln-macos-arm64/docker-credential-cpln . && hdiutil detach /Volumes/cpln-macos-arm64 macOS-x64 hdiutil attach cpln-macos-x64.dmg && cp -R /Volumes/cpln-macos-x64/cpln /Volumes/cpln-macos-x64/docker-credential-cpln . && hdiutil detach /Volumes/cpln-macos-x64 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.
Autocomplete
After installing the CLI, enabling autocomplete will help the user quickly iterate through the commands by entering the first few letters of a command and pressing the Tab key.
Copy
Ask AI
cpln 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:
Copy
Ask AI
autoload -U compinit
compinit
Autocomplete workaround for users of Cygwin:
After executing the cpln misc install-completion command:
- Copy the
cpln.bashfile fromC:/Users/<username>/.config/tabtab/cpln.bashtoC:/cygwin64/home/<username>/.config/tabtab/cpln.bash - Edit or create a new
.bashrcfile atC:/cygwin64/home/<username>/.bashrc - Add the following line to the
.bashrcfile:. C:/cygwin64/home/<username>/.config/tabtab/cpln.bash
Commands
The Control Plane CLI is executed by running:
Copy
Ask AI
cpln COMMAND SUBCOMMAND [OPTIONS]
The following commands are available (viewable by running cpln --help):
Copy
Ask AI
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 cp <file-spec-src> <file-spec-dest> Allows you to copy files and directories to and from workloads [aliases: copy]
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 ipset Manage IP Sets
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 operator A Kubernetes operator for Control Plane
cpln org Manage organizations
cpln policy Manage access policies
cpln port-forward <ref> <ports...> Forward one or more local ports to a workload
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]
© 2025 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:
- In JSON:
--output jsonor-o json - In YAML:
--output yamlor-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.
account
Manage accounts
Copy
Ask AI
cpln account [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln account get [ref...] Get accounts by id or list accounts
Options:
--help Show help [boolean]
account Subcommands
account get
Get accounts by id or list accounts
Usage
Copy
Ask AI
cpln account get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
agent
Manage agents
For a detailed overview, please visit the agent’s reference page.
Copy
Ask AI
cpln agent [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln agent access-report <ref> Show the access report for the referenced agent
cpln agent create Create a new agent
cpln agent delete <ref...> Delete one or more referenced agents
cpln agent edit <ref> Edit the referenced agent, as YAML, within an editor
cpln agent eventlog <ref> Show the event log of the referenced agent [aliases: log]
cpln agent get [ref...] Retrieve one or more referenced agents
cpln agent info <ref> Get info about an agent
cpln agent manifest Generate a manifest for running an agent in K8S
cpln agent patch <ref> Update the referenced agent's metadata using an input file
cpln agent permissions Show the grantable permissions for an agent object type
cpln agent query Find all the agents based on the given query
cpln agent tag <ref...> Manage the tags belonging to one or more referenced agents
cpln agent up Run an agent within a local Docker instance
cpln agent update <ref> Update properties of the referenced agent
Options:
--help Show help [boolean]
agent Subcommands
agent access-report
Show the access report for the referenced agent
Usage
Copy
Ask AI
cpln agent access-report <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln agent access-report demo-agent --org demo-cpln-organization
agent create
Create a new agent
Usage
Copy
Ask AI
cpln agent create --name AGENT_NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln agent create --name demo-agent --desc demo-agent --tag drink=water --org demo-cpln-organization
agent delete
Delete one or more referenced agents
Usage
Copy
Ask AI
cpln agent delete <ref...> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln agent delete demo-agent --org demo-cpln-organization
agent edit
Edit the referenced agent, as YAML, within an editor
Usage
Copy
Ask AI
cpln agent edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln agent edit demo-agent --org demo-cpln-organization
agent eventlog
Show the event log of the referenced agent
Usage
Copy
Ask AI
cpln agent eventlog <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln agent eventlog demo-agent --org demo-cpln-organization
agent get
Retrieve one or more referenced agents
Usage
Copy
Ask AI
cpln agent get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Get all agents
Copy
Ask AI
cpln agent get --org demo-cpln-organization
- Get one agent
Copy
Ask AI
cpln agent get demo-agent-get-1 --org demo-cpln-organization
- Get multiple agents
Copy
Ask AI
cpln agent get demo-agent-get-1 demo-agent-get-2 --org demo-cpln-organization
agent info
Get info about an agent
Usage
Copy
Ask AI
cpln agent info <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Return the details of a deployed agent. The example below was for an agent deployed at AWS.
Copy
Ask AI
cpln agent info demo-agent --org demo-cpln-organization
agent manifest
Generate a manifest for running an agent in K8S
Usage
Copy
Ask AI
cpln agent manifest --bootstrap-file FILE_NAME --namespace NAME_SPACE [OPTIONS]
Copy
Ask AI
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]
agent patch
Update the referenced agent’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln agent patch demo-agent --file update.json --org demo-cpln-organization
agent permissions
Show the grantable permissions for an agent object type
Usage
Copy
Ask AI
cpln agent permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln agent permissions --org demo-cpln-organization
agent query
Find all the agents based on the given query
Usage
Copy
Ask AI
cpln agent query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property or tag
- Search for an agent based on the name property
Copy
Ask AI
cpln agent query --match any --prop name=demo-agent --org demo-cpln-organization
- Search for an agent based on the description property
Copy
Ask AI
cpln agent query --match any --prop description="demo-agent" --org demo-cpln-organization
- Search for an agent based on a tag
Copy
Ask AI
cpln agent query --match any --tag drink=water --org demo-cpln-organization
- Search for an agent based on a property and tag
Copy
Ask AI
cpln agent query --match any --prop description="demo-agent" --tag drink=water --org demo-cpln-organization
agent tag
Manage the tags belonging to one or more referenced agents
Usage
Copy
Ask AI
cpln agent tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a tag
Copy
Ask AI
cpln agent tag demo-agent --tag drink=water --org demo-cpln-organization
- Update same tag (after running the example above)
Copy
Ask AI
cpln agent tag demo-agent --tag drink=coffee --org demo-cpln-organization
- Remove tag (after running the example above)
Copy
Ask AI
cpln agent tag demo-agent --remove drink --org demo-cpln-organization
agent up
Run an agent within a local Docker instance
Usage
Copy
Ask AI
cpln agent up --bootstrap-file FILE_NAME [--background] [OPTIONS]
Copy
Ask AI
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]
Copy
Ask AI
cpln agent up --bootstrap-file bootstrap.config --org demo-cpln-organization
agent update
Update properties of the referenced agent
Usage
Copy
Ask AI
cpln agent update <ref> --set UPDATE_PROPERTY [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Update Properties:
--set Update the following properties (e.g., --set description="Updated Description"):
description string
tags.<key> string [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- The
--setoption allows the modification of the following agent properties:description- Description of the agent
- Type: string
tags- Tags (key=value) associated with the agent
- Type: string
- For the examples below, the initial agent is configured as:
Copy
Ask AI
+------------------+------------------+--------------+-----+
|NAME |DESCRIPTION |CREATED |TAGS |
|------------------|------------------|--------------|-----|
|demo-agent-update |demo-agent-update |0 minutes ago | |
+------------------+------------------+--------------+-----+
- Update an agent’s description
Copy
Ask AI
cpln agent update demo-agent-update --set description="new description" --org demo-cpln-organization
- Update an agent’s tag
Copy
Ask AI
cpln agent update demo-agent-update --set tags.demo-key=demo-value --org demo-cpln-organization
apply
Create or update a resource using an input file.
Refer to the cpln apply guide for additional details.
Usage
Copy
Ask AI
cpln apply [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
--version Show version number [boolean]
Copy
Ask AI
cpln apply --file action.json
auditctx
Manage audit contexts
For a detailed overview, please visit the audit context’s reference page.
Copy
Ask AI
cpln auditctx [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln auditctx access-report <ref> Show the access report for the referenced audit context
cpln auditctx clone <ref> Create a clone of the referenced audit context; this will only duplicate its spec. [aliases: copy]
cpln auditctx create Create a new audit context
cpln auditctx edit <ref> Edit the referenced audit context, as YAML, within an editor
cpln auditctx eventlog <ref> Show the event log of the referenced audit context [aliases: log]
cpln auditctx get [ref...] Retrieve one or more referenced audit contexts
cpln auditctx patch <ref> Update the referenced audit context's metadata using an input file
cpln auditctx permissions Show the grantable permissions for an audit context object type
cpln auditctx query Find all the audit contexts based on the given query
cpln auditctx tag <ref...> Manage the tags belonging to one or more referenced audit contexts
cpln auditctx update <ref> Update properties of the referenced audit context
Options:
--help Show help [boolean]
auditctx Subcommands
auditctx access-report
Show the access report for the referenced audit context
Usage
Copy
Ask AI
cpln auditctx access-report <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln auditctx access-report demo-audit-context --org demo-cpln-organization
auditctx clone
Create a clone of the referenced audit context; this will only duplicate its spec.
Usage
Copy
Ask AI
cpln auditctx clone <ref> --name CLONE_NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln auditctx clone demo-audit-context --name demo-audit-context-clone --org demo-cpln-organization
auditctx create
Create a new audit context
Usage
Copy
Ask AI
cpln auditctx create --name NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln auditctx create --name demo-audit-context --org demo-cpln-organization
auditctx edit
Edit the referenced audit context, as YAML, within an editor
Usage
Copy
Ask AI
cpln auditctx edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln auditctx edit demo-audit-context --org demo-cpln-organization
auditctx eventlog
Show the event log of the referenced audit context
Usage
Copy
Ask AI
cpln auditctx eventlog <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln auditctx eventlog demo-audit-context --org demo-cpln-organization
auditctx get
Retrieve one or more referenced audit contexts
Usage
Copy
Ask AI
cpln auditctx get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Get all audit contexts
Copy
Ask AI
cpln auditctx get --org demo-cpln-organization
- Get one audit context
Copy
Ask AI
cpln auditctx get demo-audit-context --org demo-cpln-organization
- Get multiple audit contexts
Copy
Ask AI
cpln auditctx get demo-audit-context cpln --org demo-cpln-organization
auditctx patch
Update the referenced audit context’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln auditctx patch demo-audit-context --file update.json --org demo-cpln-organization
auditctx permissions
Show the grantable permissions for an audit context object type
Usage
Copy
Ask AI
cpln auditctx permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln auditctx permissions --org demo-cpln-organization
auditctx query
Find all the audit contexts based on the given query
Usage
Copy
Ask AI
cpln auditctx query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property or tag
- Search for an audit context based on the name property
Copy
Ask AI
cpln auditctx query --match any --prop name=demo-audit-context --org demo-cpln-organization
- Search for an audit context based on the description property
Copy
Ask AI
cpln auditctx query --match any --prop description="demo-audit-context" --org demo-cpln-organization
- Search for an audit context based on a tag
Copy
Ask AI
cpln auditctx query --match any --tag type=demo --org demo-cpln-organization
- Search for an audit context based on a property and tag
Copy
Ask AI
cpln auditctx query --match any --prop description="demo-audit-context" --tag type=demo --org demo-cpln-organization
auditctx tag
Manage the tags belonging to one or more referenced audit contexts
Usage
Copy
Ask AI
cpln auditctx tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a tag
Copy
Ask AI
cpln auditctx tag demo-audit-context --tag drink=water --org demo-cpln-organization
- Update same tag (after running the example above)
Copy
Ask AI
cpln auditctx tag demo-audit-context --tag drink=coffee --org demo-cpln-organization
- Remove tag (after running the example above)
Copy
Ask AI
cpln auditctx tag demo-audit-context --remove drink --org demo-cpln-organization
auditctx update
Update properties of the referenced audit context
Usage
Copy
Ask AI
cpln auditctx update <ref> --set UPDATE_PROPERTY [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Update Properties:
--set Update the following properties (e.g., --set description="Updated Description"):
description string
tags.<key> string [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- The
--setoption allows the modification of the following audit context properties:description- Description of the audit context
- Type: string
tags- Tags (key=value) associated with the audit context
- Type: string
- For the examples below, the initial audit context is configured as:
Copy
Ask AI
+-------------------+-------------------+--------+------------+
|NAME |DESCRIPTION |ORIGIN |TAGS |
|-------------------|-------------------|--------|------------|
|demo-audit-context |demo-audit-context |default |type="demo" |
+-------------------+-------------------+--------+------------+
- Update an audit context’s description
Copy
Ask AI
cpln auditctx update demo-audit-context --set description="new description" --org demo-cpln-organization
- Update an audit context’s tag
Copy
Ask AI
cpln auditctx update demo-audit-context --set tags.type=updated --org demo-cpln-organization
cloudaccount
Manage cloud accounts
For a detailed overview, please visit the cloud account’s reference page.
Copy
Ask AI
cpln cloudaccount [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln cloudaccount access-report <ref> Show the access report for the referenced cloud account
cpln cloudaccount create-aws Create an AWS cloud account
cpln cloudaccount create-azure Create an Azure cloud account
cpln cloudaccount create-gcp Create a GCP cloud account
cpln cloudaccount create-ngs Create a NGS cloud account
cpln cloudaccount delete <ref...> Delete one or more referenced cloud accounts
cpln cloudaccount edit <ref> Edit the referenced cloud account, as YAML, within an editor
cpln cloudaccount eventlog <ref> Show the event log of the referenced cloud account [aliases: log]
cpln cloudaccount get [ref...] Retrieve one or more referenced cloud accounts
cpln cloudaccount patch <ref> Update the referenced cloud account's metadata using an input file
cpln cloudaccount permissions Show the grantable permissions for a cloud account object type
cpln cloudaccount query Find all the cloud accounts based on the given query
cpln cloudaccount tag <ref...> Manage the tags belonging to one or more referenced cloud accounts
Options:
--help Show help [boolean]
cloudaccount Subcommands
cloudaccount access-report
Show the access report for the referenced cloud account
Usage
Copy
Ask AI
cpln cloudaccount access-report <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln cloudaccount access-report demo-cloud-account-aws --org demo-cpln-organization
cloudaccount create-aws
Create an AWS cloud account
Usage
Copy
Ask AI
cpln 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.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln cloudaccount create-aws --name demo-cloud-account-aws --role-arn arn:aws:iam::123412341234:role/cpln-demo-cpln-organization --org demo-cpln-organization
cloudaccount create-azure
Create an Azure cloud account
Usage
Copy
Ask AI
cpln 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.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln cloudaccount create-azure --name demo-cloud-account-azure --secret azure-secret --url https://function.app.url --code code --org demo-cpln-organization
cloudaccount create-gcp
Create a GCP cloud account
Usage
Copy
Ask AI
cpln 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.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln cloudaccount create-gcp --name demo-cloud-account-gcp --project-id 1234abc --org demo-cpln-organization
cloudaccount create-ngs
Create a NGS cloud account
Usage
Copy
Ask AI
cpln cloudaccount create-ngs --name ACCOUNT_NAME --secret SECRET_REFERENCE [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
cloudaccount delete
Delete one or more referenced cloud accounts
Usage
Copy
Ask AI
cpln cloudaccount delete <ref...> [OPTIONS]
Deleting a cloud account will not remove any configuration at the associated cloud provider
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln cloudaccount delete demo-cloud-account-aws --org demo-cpln-organization
cloudaccount edit
Edit the referenced cloud account, as YAML, within an editor
Usage
Copy
Ask AI
cpln cloudaccount edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln cloudaccount edit demo-cloud-account-aws --org demo-cpln-organization
cloudaccount eventlog
Show the event log of the referenced cloud account
Usage
Copy
Ask AI
cpln cloudaccount eventlog <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln cloudaccount eventlog demo-cloud-account-aws --org demo-cpln-organization
cloudaccount get
Retrieve one or more referenced cloud accounts
Usage
Copy
Ask AI
cpln cloudaccount get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Get all cloud accounts
Copy
Ask AI
cpln cloudaccount get --org demo-cpln-organization
- Get one cloud account
Copy
Ask AI
cpln cloudaccount get demo-cloud-account-aws-get-1 --org demo-cpln-organization
- Get multiple cloud accounts
Copy
Ask AI
cpln cloudaccount get demo-cloud-account-aws-get-1 demo-cloud-account-aws-get-2 --org demo-cpln-organization
cloudaccount patch
Update the referenced cloud account’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln cloudaccount patch demo-cloud-account-aws --file update.json --org demo-cpln-organization
cloudaccount permissions
Show the grantable permissions for a cloud account object type
Usage
Copy
Ask AI
cpln cloudaccount permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln cloudaccount permissions --org demo-cpln-organization
cloudaccount query
Find all the cloud accounts based on the given query
Usage
Copy
Ask AI
cpln cloudaccount query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property or tag
- Search for a cloud account based on the name property
Copy
Ask AI
cpln cloudaccount query --match any --prop name=demo-cloud-account-aws --org demo-cpln-organization
- Search for a cloud account based on the description property
Copy
Ask AI
cpln cloudaccount query --match any --prop description="demo-cloud-account-aws" --org demo-cpln-organization
- Search for a cloud account based on a tag
Copy
Ask AI
cpln cloudaccount query --match any --tag drink=water --org demo-cpln-organization
- Search for a cloud account based on a property and tag
Copy
Ask AI
cpln cloudaccount query --match any --prop description="demo-cloud-account-aws" --tag drink=water --org demo-cpln-organization
cloudaccount tag
Manage the tags belonging to one or more referenced cloud accounts
Usage
Copy
Ask AI
cpln cloudaccount tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a tag to a cloud account
Copy
Ask AI
cpln cloudaccount tag demo-cloud-account-azure --tag drink=water --org demo-cpln-organization
- Update same tag (after running the example above)
Copy
Ask AI
cpln cloudaccount tag demo-cloud-account-azure --tag drink=coffee --org demo-cpln-organization
- Remove tag (after running the example above)
Copy
Ask AI
cpln cloudaccount tag demo-cloud-account-azure --remove drink --org demo-cpln-organization
- Add same tag to multiple cloud accounts
Copy
Ask AI
cpln cloudaccount tag demo-cloud-account-azure demo-cloud-account-gcp --tag multiple-cloudaccounts=true --org demo-cpln-organization
- Update same tag on multiple cloud accounts (after running the example above)
Copy
Ask AI
cpln cloudaccount tag demo-cloud-account-azure demo-cloud-account-gcp --tag multiple-cloudaccounts=demo-cloudaccount --org demo-cpln-organization
- Remove same tag from multiple cloud accounts (after running the example above)
Copy
Ask AI
cpln cloudaccount tag demo-cloud-account-azure demo-cloud-account-gcp --remove multiple-cloudaccounts --org demo-cpln-organization
convert
Convert k8s files to cpln files
Refer to the cpln convert guide for additional details.
Usage
Copy
Ask AI
cpln convert [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
--version Show version number [boolean]
cp
Copy files and directories to and from workloads.
Refer to the cpln cp guide for additional details.
Usage
Copy
Ask AI
cpln cp <file-spec-src> <file-spec-dest> [OPTIONS]
Copy
Ask AI
Positionals:
file-spec-src A path to the source file or directory to copy from. Use a local path or workloadName:path for paths within a workload [string] [required]
file-spec-dest A path to the destination file or directory to copy to. Use a local path or workloadName:path for paths within a workload [string] [required]
Command options:
--location A global virtual cloud location [string]
--container, -c The name of the workload container
--replica The name of the workload deployment replica
--no-preserve The copied file/directory's ownership and permissions will not be preserved in the container [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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
--version Show version number [boolean]
- Copy file from local machine to workload
Copy
Ask AI
cpln cp ./demo-file.txt demo-workload:path/within/workload/ --org demo-cpln-organization --gvc demo-gvc
- Copy directory from local machine to workload
Copy
Ask AI
cpln cp ./demo-directory demo-workload:path/within/workload/ --org demo-cpln-organization --gvc demo-gvc
- Copy file from workload to local machine
Copy
Ask AI
cpln cp demo-workload:path/within/workload/demo-file.txt ./demo-file.txt --org demo-cpln-organization --gvc demo-gvc
- Copy directory from workload to local machine
Copy
Ask AI
cpln cp demo-workload:path/within/workload/demo-directory ./demo-directory --org demo-cpln-organization --gvc demo-gvc
delete
Delete resources from files
Refer to the cpln delete guide for additional details.
Usage
Copy
Ask AI
cpln delete [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
--version Show version number [boolean]
domain
Manage custom domains
For a detailed overview, please visit the domain’s reference page.
Copy
Ask AI
cpln domain [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln domain access-report <ref> Show the access report for the referenced domain
cpln domain create Create a new domain
cpln domain delete <ref...> Delete one or more referenced domains
cpln domain edit <ref> Edit the referenced domain, as YAML, within an editor
cpln domain eventlog <ref> Show the event log of the referenced domain [aliases: log]
cpln domain get [ref...] Retrieve one or more referenced domains
cpln domain patch <ref> Update the referenced domain's metadata using an input file
cpln domain permissions Show the grantable permissions for a domain object type
cpln domain query Find all the domains based on the given query
cpln domain tag <ref...> Manage the tags belonging to one or more referenced domains
Options:
--help Show help [boolean]
domain Subcommands
domain access-report
Show the access report for the referenced domain
Usage
Copy
Ask AI
cpln domain access-report <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
The domain demo.globalvirtualcloud.com has already been added to the demo-cpln-organization organization
Copy
Ask AI
cpln domain access-report demo.globalvirtualcloud.com --org demo-cpln-organization
domain create
Create a new domain
Usage
Copy
Ask AI
cpln domain create --name DOMAIN_NAME [OPTIONS]
Ownership of the referenced domain is required by setting a TXT DNS entry.
Please review the instructions here.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln domain create --name demo.globalvirtualcloud.com --org demo-cpln-organization
domain delete
Delete one or more referenced domains
Usage
Copy
Ask AI
cpln domain delete <ref...> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln domain delete demo.globalvirtualcloud.com --org demo-cpln-organization
domain edit
Edit the referenced domain, as YAML, within an editor
Usage
Copy
Ask AI
cpln domain edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln domain edit demo.globalvirtualcloud.com --org demo-cpln-organization
domain eventlog
Show the event log of the referenced domain
Usage
Copy
Ask AI
cpln domain eventlog <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln domain eventlog demo.globalvirtualcloud.com --org demo-cpln-organization
domain get
Retrieve one or more referenced domains
Usage
Copy
Ask AI
cpln domain get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Show a domain
Copy
Ask AI
cpln domain get demo.globalvirtualcloud.com --org demo-cpln-organization
- Show multiple domains
Copy
Ask AI
cpln domain get demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --org demo-cpln-organization
domain patch
Update the referenced domain’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln domain patch demo.globalvirtualcloud.com --file update.json --org demo-cpln-organization
domain permissions
Show the grantable permissions for a domain object type
Usage
Copy
Ask AI
cpln domain permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln domain permissions --org demo-cpln-organization
domain query
Find all the domains based on the given query
Usage
Copy
Ask AI
cpln domain query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property or tag
- Search for a domain based on the name property
Copy
Ask AI
cpln domain query --match any --prop name=demo.globalvirtualcloud.com --org demo-cpln-organization
- Search for a domain based on the description property
Copy
Ask AI
cpln domain query --match any --prop description="FQDN: demo.globalvirtualcloud.com" --org demo-cpln-organization
- Search for a domain based on a tag
Copy
Ask AI
cpln domain query --match any --tag demo-domain="true" --org demo-cpln-organization
- Search for a domain based on a property and tag
Copy
Ask AI
cpln domain query --match any --prop description="FQDN: demo.globalvirtualcloud.com" --tag demo-domain="true" --org demo-cpln-organization
domain tag
Manage the tags belonging to one or more referenced domains
Usage
Copy
Ask AI
cpln domain tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a tag to a domain
Copy
Ask AI
cpln domain tag demo.globalvirtualcloud.com --tag drink=water --org demo-cpln-organization
- Update same tag (after running the example above)
Copy
Ask AI
cpln domain tag demo.globalvirtualcloud.com --tag drink=coffee --org demo-cpln-organization
- Remove tag (after running the example above)
Copy
Ask AI
cpln domain tag demo.globalvirtualcloud.com --remove name --org demo-cpln-organization
- Add same tag to multiple domain
Copy
Ask AI
cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --tag multiple-domains=true --org demo-cpln-organization
- Update same tag on multiple domain (after running the example above)
Copy
Ask AI
cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --tag multiple-domains=demo-domain --org demo-cpln-organization
- Remove same tag from multiple domain (after running the example above)
Copy
Ask AI
cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --remove multiple-domains --org demo-cpln-organization
group
Manage groups
For a detailed overview, please visit the group’s reference page.
Copy
Ask AI
cpln group [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln group access-report <ref> Show the access report for the referenced group
cpln group add-member <ref> Add members to the referenced group
cpln group clone <ref> Create a clone of the referenced group; this will only duplicate its spec. [aliases: copy]
cpln group create Create a new group
cpln group delete <ref...> Delete one or more referenced groups
cpln group edit <ref> Edit the referenced group, as YAML, within an editor
cpln group eventlog <ref> Show the event log of the referenced group [aliases: log]
cpln group get [ref...] Retrieve one or more referenced groups
cpln group patch <ref> Update the referenced group's metadata using an input file
cpln group permissions Show the grantable permissions for a group object type
cpln group query Find all the groups based on the given query
cpln group remove-member <ref> Remove members from the referenced group
cpln group tag <ref...> Manage the tags belonging to one or more referenced groups
cpln group update <ref> Update properties of the referenced group
Options:
--help Show help [boolean]
group Subcommands
group access-report
Show the access report for the referenced group
Usage
Copy
Ask AI
cpln group access-report <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln group access-report demo-group --org demo-cpln-organization
group add-member
Add members to the referenced group
Usage
Copy
Ask AI
cpln group add-member <ref> --email USER_EMAIL [OPTIONS]
cpln group add-member <ref> --serviceaccount SERVICE_ACCOUNT [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a user to a group
Copy
Ask AI
cpln group add-member demo-group --email test-128@example.com --org demo-cpln-organization
- Add a service account to a group using email
Copy
Ask AI
cpln group add-member demo-group --serviceaccount controlplane --org demo-cpln-organization
group clone
Create a clone of the referenced group; this will only duplicate its spec.
Usage
Copy
Ask AI
cpln group clone <ref> --name CLONE_NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln group clone demo-group --name demo-group-clone --org demo-cpln-organization
group create
Create a new group
Usage
Copy
Ask AI
cpln 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.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln group create --name demo-group --desc demo-group --tag drink=water --org demo-cpln-organization
group delete
Delete one or more referenced groups
Usage
Copy
Ask AI
cpln group delete <ref...> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln group delete demo-group --org demo-cpln-organization
group edit
Edit the referenced group, as YAML, within an editor
Usage
Copy
Ask AI
cpln group edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln group edit demo-group --org demo-cpln-organization
group eventlog
Show the event log of the referenced group
Usage
Copy
Ask AI
cpln group eventlog <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln group eventlog demo-group --org demo-cpln-organization
group get
Retrieve one or more referenced groups
Usage
Copy
Ask AI
cpln group get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Get all groups
Copy
Ask AI
cpln group get --org demo-cpln-organization
- Get one group
Copy
Ask AI
cpln group get demo-group-get-1 --org demo-cpln-organization
- Get multiple groups
Copy
Ask AI
cpln group get demo-group-get-1 demo-group-get-2 --org demo-cpln-organization
group patch
Update the referenced group’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln group patch demo-group --file update.json --org demo-cpln-organization
group permissions
Show the grantable permissions for a group object type
Usage
Copy
Ask AI
cpln group permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln group permissions --org demo-cpln-organization
group query
Find all the groups based on the given query
Usage
Copy
Ask AI
cpln group query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property or tag
- Search for a group based on the name property
Copy
Ask AI
cpln group query --match any --prop name=demo-group --org demo-cpln-organization
- Search for a group based on the description property
Copy
Ask AI
cpln group query --match any --prop description="demo-group" --org demo-cpln-organization
- Search for a group based on a tag
Copy
Ask AI
cpln group query --match any --tag drink=water --org demo-cpln-organization
- Search for a group based on a property and tag
Copy
Ask AI
cpln group query --match any --prop description="demo-group" --tag drink=water --org demo-cpln-organization
group remove-member
Remove members from the referenced group
Usage
Copy
Ask AI
cpln group remove-member <ref> --email USER_EMAIL [OPTIONS]
cpln group remove-member <ref> --serviceaccount SERVICE_ACCOUNT [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
The user and service account referenced in the examples below were previously added to the group
- Remove a user to a group
Copy
Ask AI
cpln group remove-member demo-group --email test-128@example.com --org demo-cpln-organization
- Remove a service account to a group using email
Copy
Ask AI
cpln group remove-member demo-group --serviceaccount controlplane --org demo-cpln-organization
group tag
Manage the tags belonging to one or more referenced groups
Usage
Copy
Ask AI
cpln group tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a tag to a group
Copy
Ask AI
cpln group tag demo-group-tag-1 --tag drink=water --org demo-cpln-organization
- Update same tag (after running the example above)
Copy
Ask AI
cpln group tag demo-group-tag-1 --tag drink=coffee --org demo-cpln-organization
- Remove tag (after running the example above)
Copy
Ask AI
cpln group tag demo-group-tag-1 --remove drink --org demo-cpln-organization
- Add same tag to multiple groups
Copy
Ask AI
cpln group tag demo-group-tag-1 demo-group-tag-2 --tag multiple-groups=true --org demo-cpln-organization
- Update same tag on multiple groups (after running the example above)
Copy
Ask AI
cpln group tag demo-group-tag-1 demo-group-tag-2 --tag multiple-groups=demo-group --org demo-cpln-organization
- Remove same tag from multiple groups (after running the example above)
Copy
Ask AI
cpln group tag demo-group-tag-1 demo-group-tag-2 --remove multiple-groups --org demo-cpln-organization
group update
Update properties of the referenced group
Usage
Copy
Ask AI
cpln group update <ref> --set UPDATE_PROPERTY [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Update Properties:
--set Update the following properties (e.g., --set description="Updated Description"):
description string
tags.<key> string
memberLinks string[]
Arrays can be appended to, replaced, or removed using the `+=`, `=`, or `-=` operators, respectively. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- The
--setoption allows the modification of the following group properties:description- Description of the group
- Type: string
tags- Tags (key=value) associated with the group
- Type: string
memberLinks- Array of links belonging to members of the group
- Type: string[]
- For the examples below, the initial group is configured as:
Copy
Ask AI
+------------------+------------------+--------------+-------+--------+-----+
|NAME |DESCRIPTION |CREATED |FILTER |ORIGIN |TAGS |
|------------------|------------------|--------------|-------|--------|-----|
|demo-group-update |demo-group-update |0 minutes ago |links |default | |
+------------------+------------------+--------------+-------+--------+-----+
- Update an group’s description
Copy
Ask AI
cpln group update demo-group-update --set description="new description" --org demo-cpln-organization
- Update an group’s tags
Copy
Ask AI
cpln group update demo-group-update --set tags.demo-key=demo-value --org demo-cpln-organization
- Add to a group’s member links. This examples adds the built-in controlplane service account
Copy
Ask AI
cpln group update demo-group-update --set memberLinks+="/org/demo-cpln-organization/serviceaccount/controlplane" --org demo-cpln-organization
- Remove from a group’s member links. This examples removes the built-in controlplane service account
Copy
Ask AI
cpln group update demo-group-update --set memberLinks-="/org/demo-cpln-organization/serviceaccount/controlplane" --org demo-cpln-organization
gvc
Manage global virtual clouds
For a detailed overview, please visit the gvc’s reference page.
Copy
Ask AI
cpln gvc [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln gvc access-report <ref> Show the access report for the referenced global virtual cloud
cpln gvc add-location <ref> Add one or more locations to the referenced global virtual cloud
cpln gvc clone <ref> Create a clone of the referenced global virtual cloud; this will only duplicate its spec. [aliases: copy]
cpln gvc create Create a new global virtual cloud
cpln gvc delete <ref...> Delete GVCs by name
cpln gvc delete-all-workloads <ref> Delete all workloads for the referenced global virtual cloud
cpln gvc edit <ref> Edit the referenced global virtual cloud, as YAML, within an editor
cpln gvc eventlog <ref> Show the event log of the referenced global virtual cloud [aliases: log]
cpln gvc get [ref...] Retrieve one or more referenced global virtual clouds
cpln gvc patch <ref> Update the referenced global virtual cloud's metadata using an input file
cpln gvc permissions Show the grantable permissions for a global virtual cloud object type
cpln gvc query Find all the global virtual clouds based on the given query
cpln gvc remove-location <ref> Remove one or more locations from the referenced global virtual cloud
cpln gvc tag <ref...> Manage the tags belonging to one or more referenced global virtual clouds
cpln gvc update <ref> Update properties of the referenced global virtual cloud
Options:
--help Show help [boolean]
gvc Subcommands
gvc access-report
Show the access report for the referenced global virtual cloud
Usage
Copy
Ask AI
cpln gvc access-report <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Display the user / service account / group permissions for the ‘demo-gvc’ global virtual cloud within the ‘demo-cpln-organization’ organization
Copy
Ask AI
cpln gvc access-report demo-gvc --org demo-cpln-organization
gvc add-location
Add one or more locations to the referenced global virtual cloud
Usage
Copy
Ask AI
cpln gvc add-location <ref...> --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
The gvc, named ‘demo-gvc’, in the examples below was already created with ‘aws-eu-central-1’ as one of its locations.
- Add one location to a global virtual cloud
Copy
Ask AI
cpln gvc add-location demo-gvc --location aws-us-west-2 --org demo-cpln-organization
- Add multiple locations to a global virtual cloud
Copy
Ask AI
cpln gvc add-location demo-gvc --location aws-us-west-2 --location gcp-us-east1 --org demo-cpln-organization
gvc clone
Create a clone of the referenced global virtual cloud; this will only duplicate its spec.
Usage
Copy
Ask AI
cpln gvc clone <ref> --name CLONE_NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln gvc clone demo-gvc --name demo-gvc-clone --org demo-cpln-organization
gvc create
Create a new global virtual cloud
Usage
Copy
Ask AI
cpln gvc create --name GVC_NAME --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
name- Minimum Length: 3
- Maximum Length: 64
- Only lowercase characters
- Must begin with a character
- Allowed special characters: -
- Create an new GVC with a single location
Copy
Ask AI
cpln gvc create --name demo-gvc --location aws-eu-central-1 --desc demo-gvc --tag drink=water --org demo-cpln-organization
gvc delete
Delete GVCs by name
Usage
Copy
Ask AI
cpln gvc delete <ref...> [OPTIONS]
Deleting a gvc will remove all associated resources (workloads, etc.)
Copy
Ask AI
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]
Command options:
--force Bypass warnings and/or safety checks [boolean]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Delete a gvc
Copy
Ask AI
cpln gvc delete demo-gvc-delete-1 --org demo-cpln-organization
- Delete multiple gvcs
Copy
Ask AI
cpln gvc delete demo-gvc-delete-1 demo-gvc-delete-2 --org demo-cpln-organization
gvc delete-all-workloads
Delete all workloads for the referenced global virtual cloud
Usage
Copy
Ask AI
cpln gvc delete-all-workloads <ref> [OPTIONS]
Deleting all the associated workloads will remove all associated resources (containers, etc.)
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Delete all workloads
Copy
Ask AI
cpln gvc delete-all-workloads demo-gvc-with-workloads --org demo-cpln-organization
gvc edit
Edit the referenced global virtual cloud, as YAML, within an editor
Usage
Copy
Ask AI
cpln gvc edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln gvc edit demo-gvc --org demo-cpln-organization
gvc eventlog
Show the event log of the referenced global virtual cloud
Usage
Copy
Ask AI
cpln gvc eventlog <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln gvc eventlog demo-gvc --org demo-cpln-organization
gvc get
Retrieve one or more referenced global virtual clouds
Usage
Copy
Ask AI
cpln gvc get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Get all gvcs
Copy
Ask AI
cpln gvc get --org demo-cpln-organization
- Get one gvc
Copy
Ask AI
cpln gvc get demo-gvc-get-1 --org demo-cpln-organization
- Get multiple gvcs
Copy
Ask AI
cpln gvc get demo-gvc-get-1 demo-gvc-get-2 --org demo-cpln-organization
gvc patch
Update the referenced global virtual cloud’s metadata using an input file
Usage
Copy
Ask AI
cpln gvc patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln gvc patch demo-gvc --file update.json --org demo-cpln-organization
gvc permissions
Show the grantable permissions for a global virtual cloud object type
Usage
Copy
Ask AI
cpln gvc permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln gvc permissions --org demo-cpln-organization
gvc query
Find all the global virtual clouds based on the given query
Usage
Copy
Ask AI
cpln gvc query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property or tag
- Search for a gvc based on the name property
Copy
Ask AI
cpln gvc query --match any --prop name=demo-gvc --org demo-cpln-organization
- Search for a gvc based on the description property
Copy
Ask AI
cpln gvc query --match any --prop description="demo-gvc" --org demo-cpln-organization
- Search for a gvc based on a tag
Copy
Ask AI
cpln gvc query --match any --tag drink=water --org demo-cpln-organization
- Search for a gvc based on a property and tag
Copy
Ask AI
cpln gvc query --match any --prop description="demo-gvc" --tag drink=water --org demo-cpln-organization
gvc remove-location
Remove one or more locations from the referenced global virtual cloud
Usage
Copy
Ask AI
cpln gvc remove-location <ref...> --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
The gvc, named ‘demo-gvc-with-locations’, in the examples below was already created with four locations. A gvc must have at least one location.
- Remove one location from a global virtual cloud
Copy
Ask AI
cpln gvc remove-location demo-gvc-with-locations --location azure-eastus2 --org demo-cpln-organization
- Remove multiple locations from a global virtual cloud
Copy
Ask AI
cpln gvc remove-location demo-gvc-with-locations --location aws-us-west-2 --location aws-eu-central-1 --org demo-cpln-organization
gvc tag
Manage the tags belonging to one or more referenced global virtual clouds
Usage
Copy
Ask AI
cpln gvc tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a tag to a gvc
Copy
Ask AI
cpln gvc tag demo-gvc-tag-1 --tag drink=water --org demo-cpln-organization
- Update same tag (after running the example above)
Copy
Ask AI
cpln gvc tag demo-gvc-tag-1 --tag drink=coffee --org demo-cpln-organization
- Remove tag (after running the example above)
Copy
Ask AI
cpln gvc tag demo-gvc-tag-1 --remove drink --org demo-cpln-organization
- Add same tag to multiple gvcs
Copy
Ask AI
cpln gvc tag demo-gvc-tag-1 demo-gvc-tag-2 --tag multiple-gvcs=true --org demo-cpln-organization
- Update same tag on multiple gvcs (after running the example above)
Copy
Ask AI
cpln gvc tag demo-gvc-tag-1 demo-gvc-tag-2 --tag multiple-gvcs=demo-gvc --org demo-cpln-organization
- Remove same tag from multiple gvcs (after running the example above)
Copy
Ask AI
cpln gvc tag demo-gvc-tag-1 demo-gvc-tag-2 --remove multiple-gvcs --org demo-cpln-organization
gvc update
Update properties of the referenced global virtual cloud
Usage
Copy
Ask AI
cpln gvc update <ref> --set UPDATE_PROPERTY [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Update Properties:
--set Update the following properties (e.g., --set description="Updated Description"):
description string
tags.<key> string
spec.pullSecretLinks string[]
spec.staticPlacement.locationLinks string[]
spec.tracing.sampling number
spec.tracing.lightstep.endpoint string
spec.tracing.lightstep.credentials string[]
spec.env.<name>.value string
Arrays can be appended to, replaced, or removed using the `+=`, `=`, or `-=` operators, respectively. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- The
--setoption allows the modification of the following global virtual cloud properties:description- Description of the global virtual cloud
- Type: string
tags- Tags (key=value) associated with the global virtual cloud
- Type: string
spec.pullSecretLinks- Array of pull secret links belonging to the global virtual cloud
- Type: string[]
spec.domain- The domain linked to this global virtual cloud
- Type: string
spec.staticPlacement.locationLinks- Array of location links belonging to the global virtual cloud
- Type: string[]
- For the examples below, the initial gvc is configured as:
Copy
Ask AI
+----------------+----------------+--------------+--------------+----------+-----------------+-----+
|NAME |DESCRIPTION |CREATED |ALIAS |DOMAIN |LOCATIONS |TAGS |
|----------------|----------------|--------------|--------------|----------|-----------------|-----|
|demo-gvc-update |demo-gvc-update |0 minutes ago |bn8g6ga4d0gcy | |aws-eu-central-1 | |
+----------------+----------------+--------------+--------------+----------+-----------------+-----+
- Update a gvc’s description
Copy
Ask AI
cpln gvc update demo-gvc-update --set description="new description" --org demo-cpln-organization
- Update a gvc’s tag
Copy
Ask AI
cpln gvc update demo-gvc-update --set tags.demo-key=demo-value --org demo-cpln-organization
helm
Manage helm releases on cpln
Refer to the cpln helm guide for additional details.
Copy
Ask AI
cpln helm [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln helm get Download extended information of a named release
cpln helm history <release> Fetch release history
cpln helm install [release] [chart] Install a release [aliases: apply]
cpln helm list List releases
cpln helm rollback <release> [revision] Roll back a release to a previous revision
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
Options:
--help Show help [boolean]
helm Subcommands
helm get
Download extended information of a named release
Copy
Ask AI
cpln helm get [SUBCOMMAND]
An empty reference will return all references
Copy
Ask AI
Commands:
cpln helm get all <release> Download all information for a named release
cpln helm get manifest <release> Download the manifest for a named release
cpln helm get notes <release> Download the notes for a named release
cpln helm get values <release> Download the values file for a named release
Options:
--help Show help [boolean]
get Subcommands
helm get all
Download all information for a named release
Usage
Copy
Ask AI
cpln helm get all <release> [OPTIONS]
Copy
Ask AI
Positionals:
release The release name [string] [required]
Command options:
--revision get the named release with revision [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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
helm get manifest
Download the manifest for a named release
Usage
Copy
Ask AI
cpln helm get manifest <release> [OPTIONS]
Copy
Ask AI
Positionals:
release The release name [string] [required]
Command options:
--revision get the named release with revision [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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
helm get notes
Download the notes for a named release
Usage
Copy
Ask AI
cpln helm get notes <release> [OPTIONS]
Copy
Ask AI
Positionals:
release The release name [string] [required]
Command options:
--revision get the named release with revision [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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
helm get values
Download the values file for a named release
Usage
Copy
Ask AI
cpln helm get values <release> [OPTIONS]
Copy
Ask AI
Positionals:
release The release name [string] [required]
Command options:
--all, -a dump all (computed) values [boolean]
--revision get the named release with revision [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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
helm history
Fetch release history
Usage
Copy
Ask AI
cpln helm history <release> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
helm install
Install a release
Usage
Copy
Ask AI
cpln helm install [release] [chart] [OPTIONS]
Copy
Ask AI
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]
--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]
--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)
--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)
--state-tag Attach tags to the Helm secret (e.g., --state-tag drink=water)
--remove-state-tag Remove tags from the Helm secret (e.g., --remove-state-tag 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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
helm list
List releases
Usage
Copy
Ask AI
cpln helm list [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
helm rollback
Roll back a release to a previous revision
Usage
Copy
Ask AI
cpln helm rollback <release> [revision] [OPTIONS]
Copy
Ask AI
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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
helm template
Generate cpln resources from a template
Usage
Copy
Ask AI
cpln helm template [release] [chart] [OPTIONS]
Copy
Ask AI
Positionals:
release The release name [string]
chart Path to chart [string]
Command options:
--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]
--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)
--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]
--namespace, -n Specify the Kubernetes namespace for exporting in CRD format (applicable only with '--output crd').
--keep, -k Prevent deletion of the corresponding Control Plane resource (only when using '--output crd'). [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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
helm uninstall
Uninstall a release
Usage
Copy
Ask AI
cpln helm uninstall <release> [OPTIONS]
Copy
Ask AI
Positionals:
release The release name [string] [required]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k, -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
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
helm upgrade
Upgrade a release
Usage
Copy
Ask AI
cpln helm upgrade [release] [chart] [OPTIONS]
Copy
Ask AI
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]
--history-limit Maximum number of revisions saved per release. Use 0 for no limit [number] [default: 10]
--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]
--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)
--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)
--state-tag Attach tags to the Helm secret (e.g., --state-tag drink=water)
--remove-state-tag Remove tags from the Helm secret (e.g., --remove-state-tag 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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
identity
Manage identities within a global virtual cloud
For a detailed overview, please visit the identity’s reference page.
Copy
Ask AI
cpln identity [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln identity access-report <ref> Show the access report for the referenced identity
cpln identity create Create a new identity
cpln identity delete <ref...> Delete one or more referenced identities
cpln identity edit <ref> Edit the referenced identity, as YAML, within an editor
cpln identity eventlog <ref> Show the event log of the referenced identity [aliases: log]
cpln identity get [ref...] Retrieve one or more referenced identities
cpln identity patch <ref> Update the referenced identity's metadata using an input file
cpln identity permissions Show the grantable permissions for an identity object type
cpln identity query Find all the identities based on the given query
cpln identity tag <ref...> Manage the tags belonging to one or more referenced identities
cpln identity update <ref> Update properties of the referenced identity
Options:
--help Show help [boolean]
identity Subcommands
identity access-report
Show the access report for the referenced identity
Usage
Copy
Ask AI
cpln identity access-report <ref> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln identity access-report demo-identity --org demo-cpln-organization --gvc demo-gvc-identity
identity create
Create a new identity
Usage
Copy
Ask AI
cpln identity create --name IDENTITY_NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln identity create --name demo-identity --desc demo-identity --tag drink=water --org demo-cpln-organization --gvc demo-gvc-identity
identity delete
Delete one or more referenced identities
Usage
Copy
Ask AI
cpln identity delete <ref...> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln identity delete demo-identity --org demo-cpln-organization --gvc demo-gvc-identity
identity edit
Edit the referenced identity, as YAML, within an editor
Usage
Copy
Ask AI
cpln identity edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln identity edit demo-identity --org demo-cpln-organization --gvc demo-gvc-identity
identity eventlog
Show the event log of the referenced identity
Usage
Copy
Ask AI
cpln identity eventlog <ref> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln identity eventlog demo-identity --org demo-cpln-organization --gvc demo-gvc-identity
identity get
Retrieve one or more referenced identities
Usage
Copy
Ask AI
cpln identity get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Command options:
--all-gvcs Show identities from all gvcs in the org [boolean]
Options:
--help Show help [boolean]
- Get all identities
Copy
Ask AI
cpln identity get --org demo-cpln-organization --gvc demo-gvc-identity
- Get one identity
Copy
Ask AI
cpln identity get demo-identity-get-1 --org demo-cpln-organization --gvc demo-gvc-identity
- Get multiple identities
Copy
Ask AI
cpln identity get demo-identity-get-1 demo-identity-get-2 --org demo-cpln-organization --gvc demo-gvc-identity
identity patch
Update the referenced identity’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln identity patch demo-identity --file update.json --org demo-cpln-organization --gvc demo-gvc-identity
identity permissions
Show the grantable permissions for an identity object type
Usage
Copy
Ask AI
cpln identity permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln identity permissions --org demo-cpln-organization --gvc demo-gvc-identity
identity query
Find all the identities based on the given query
Usage
Copy
Ask AI
cpln identity query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property or tag
- Search for an identity based on the name property
Copy
Ask AI
cpln identity query --match any --prop name=demo-identity --org demo-cpln-organization --gvc demo-gvc-identity
- Search for an identity based on the description property
Copy
Ask AI
cpln identity query --match any --prop description="demo-identity" --org demo-cpln-organization --gvc demo-gvc-identity
- Search for an identity based on a tag
Copy
Ask AI
cpln identity query --match any --tag drink=water --org demo-cpln-organization --gvc demo-gvc-identity
- Search for an identity based on a property and tag
Copy
Ask AI
cpln identity query --match any --prop description="demo-identity" --tag drink=water --org demo-cpln-organization --gvc demo-gvc-identity
identity tag
Manage the tags belonging to one or more referenced identities
Usage
Copy
Ask AI
cpln identity tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a tag
Copy
Ask AI
cpln identity tag demo-identity --tag drink=water --org demo-cpln-organization --gvc demo-gvc-identity
- Update same tag (after running the example above)
Copy
Ask AI
cpln identity tag demo-identity --tag drink=coffee --org demo-cpln-organization --gvc demo-gvc-identity
- Remove tag (after running the example above)
Copy
Ask AI
cpln identity tag demo-identity --remove drink --org demo-cpln-organization --gvc demo-gvc-identity
identity update
Update properties of the referenced identity
Usage
Copy
Ask AI
cpln identity update <ref> --set UPDATE_PROPERTY [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Update Properties:
--set Update the following properties (e.g., --set description="Updated Description"):
description string
tags.<key> string [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- The
--setoption allows the modification of the following identity properties:description- Description of the identity
- Type: string
tags- Tags (key=value) associated with the identity
- Type: string
- For the examples below, the initial identity is configured as:
Copy
Ask AI
+---------------------+---------------------+------------------+-------------------------------+--------------+----------+-----+
|NAME |DESCRIPTION |GVC |LOCAL NAME |CREATED |PROVIDERS |TAGS |
|---------------------|---------------------|------------------|-------------------------------|--------------|----------|-----|
|demo-identity-update |demo-identity-update |demo-gvc-identity |cpln-demo-cpln-organi-bs35s9c8 |0 minutes ago | | |
+---------------------+---------------------+------------------+-------------------------------+--------------+----------+-----+
- Update an identity’s description
Copy
Ask AI
cpln identity update demo-identity-update --set description="new description" --org demo-cpln-organization --gvc demo-gvc-identity
- Update an identity’s tag
Copy
Ask AI
cpln identity update demo-identity-update --set tags.demo-key=demo-value --org demo-cpln-organization --gvc demo-gvc-identity
image
Manage images and configure Docker login
For a detailed overview, please visit the image’s reference page.
Copy
Ask AI
cpln image [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln image access-report <ref> Show the access report for the referenced image
cpln image build Build and containerize an application into an image. If using buildpacks, everything after -- will be passed down to the pack executable.
cpln image copy <ref> Copy an image from one org to another. This will make sure that docker-login has been run against the source and destination org, then will pull, tag and push the image to the destination org.
cpln image delete <ref...> Delete one or more referenced images
cpln image docker-login Perform a Docker login to the organization's private registry
cpln image edit <ref> Edit the referenced image, as YAML, within an editor
cpln image get [ref...] Retrieve one or more referenced images
cpln image patch <ref> Update the referenced image's metadata using an input file
cpln image permissions Show the grantable permissions for an image object type
cpln image query Find all the images based on the given query
cpln image tag <ref...> Manage the tags belonging to one or more referenced images
Options:
--help Show help [boolean]
image Subcommands
image access-report
Show the access report for the referenced image
Usage
Copy
Ask AI
cpln image access-report <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln image access-report demo-image:1 --org demo-cpln-organization
image build
Build and containerize an application into an image. If using buildpacks, everything after — will be passed down to the pack executable.
Usage
Copy
Ask AI
cpln 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.
Docker is required to be installed.
Copy
Ask AI
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: "."]
--no-cache Builds the image without using any cached layers. [boolean] [default: false]
--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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln image build demo-image:1 --push demo-cpln-organization -- --env CPLN_IMAGE_BUILD=true
image copy
Copy an image from one org to another. This will make sure that docker-login has been run against the source and destination org, then will pull, tag and push the image to the destination org.
Usage
Copy
Ask AI
cpln image copy <ref> --to-name IMAGE:TAG --to-org TARGET_ORG --to-profile TARGET_ORG_PROFILE [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Copying image between orgs within the same profile
Copy
Ask AI
cpln image copy SOURCE_IMAGE:TAG --to-name TARGET_IMAGE:NEW_TAG --to-org TARGET_ORG
The profile service principal (user/service account) must have the proper permissions to pull/push images in the current and target org.
- Copying image between orgs using different profiles
Copy
Ask AI
cpln image copy SOURCE_IMAGE:TAG --to-name TARGET_IMAGE:NEW_TAG --to-org TARGET_ORG --to-profile TARGET_ORG_PROFILE
This command will copy an image from the current org to the target org.
The current profile service principal (user/service account) must have the proper permissions to pull images in the current org (default profile).
The referenced —to-profile service principal (user/service account) must have the proper permissions to push images to the target org.
This command allows the copying of images between different orgs using user or service account profiles.
image delete
Delete one or more referenced images
Usage
Copy
Ask AI
cpln image delete <ref...> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln image delete demo-image:1 --org demo-cpln-organization
image docker-login
Perform a Docker login to the organization’s private registry
Usage
Copy
Ask AI
cpln image docker-login [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln image docker-login demo-image:1 --org demo-cpln-organization
image edit
Edit the referenced image, as YAML, within an editor
Usage
Copy
Ask AI
cpln image edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln image edit demo-image:1 --org demo-cpln-organization
image get
Retrieve one or more referenced images
Usage
Copy
Ask AI
cpln image get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Get all images
Copy
Ask AI
cpln image get --org demo-cpln-organization
- Get one image
Copy
Ask AI
cpln image get demo-image:1 --org demo-cpln-organization
- Get multiple images
Copy
Ask AI
cpln image get demo-image:1 demo-image:2 --org demo-cpln-organization
image patch
Update the referenced image’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln image patch demo-image:1 --file update.json --org demo-cpln-organization
image permissions
Show the grantable permissions for an image object type
Usage
Copy
Ask AI
cpln image permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln image permissions --org demo-cpln-organization
image query
Find all the images based on the given query
Usage
Copy
Ask AI
cpln image query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property or tag
- Search for an image based on the name property
Copy
Ask AI
cpln image query --match any --prop name=demo-image:1 --org demo-cpln-organization
- Search for an image based on the description property
Copy
Ask AI
cpln image query --match any --prop tag="2" --org demo-cpln-organization
- Search for an image based on a tag
Copy
Ask AI
cpln image query --match any --tag description="Demo Image #1" --org demo-cpln-organization
- Search for an image based on a property and tag
Copy
Ask AI
cpln image query --match any --prop name="demo-image" --tag description="Demo Image #1" --org demo-cpln-organization
image tag
Manage the tags belonging to one or more referenced images
Usage
Copy
Ask AI
cpln image tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a tag
Copy
Ask AI
cpln image tag demo-image:1 --tag drink=water --org demo-cpln-organization
- Update same tag (after running the example above)
Copy
Ask AI
cpln image tag demo-image:1 --tag drink=coffee --org demo-cpln-organization
- Remove tag (after running the example above)
Copy
Ask AI
cpln image tag demo-image:1 --remove drink --org demo-cpln-organization
location
Manage locations
For a detailed overview, please visit the location’s reference page.
Copy
Ask AI
cpln location [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln location access-report <ref> Show the access report for the referenced location
cpln location create Create a new BYOK location
cpln location delete <ref...> Delete one or more referenced locations
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 install <ref> Get instructions for obtaining the installation script for a BYOK location
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
cpln location uninstall <ref> Get instructions for obtaining the uninstallation script for a BYOK location
Options:
--help Show help [boolean]
location Subcommands
location access-report
Show the access report for the referenced location
Usage
Copy
Ask AI
cpln location access-report <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln location access-report aws-eu-central-1 --org demo-cpln-organization
location create
Create a new BYOK location
Usage
Copy
Ask AI
cpln location create --name NAME [OPTIONS]
Copy
Ask AI
Command options:
--name Name of the new BYOK location [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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Create a new BYOK location.
Copy
Ask AI
cpln location create --name demo-byok-location --org demo-cpln-organization
location delete
Delete one or more referenced locations
Usage
Copy
Ask AI
cpln location delete <ref...> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Delete a BYOK location.
Copy
Ask AI
cpln location delete demo-byok-location-tbd --org demo-cpln-organization
location edit
Edit the referenced location, as YAML, within an editor
Usage
Copy
Ask AI
cpln location edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln location edit aws-eu-central-1 --org demo-cpln-organization
location get
Retrieve one or more referenced locations
Usage
Copy
Ask AI
cpln location get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Get all locations
Copy
Ask AI
cpln location get --org demo-cpln-organization
- Get one location
Copy
Ask AI
cpln location get aws-eu-central-1 --org demo-cpln-organization
- Get multiple locations
Copy
Ask AI
cpln location get gcp-us-east1 --org demo-cpln-organization
location install
Get instructions for obtaining the installation script for a BYOK location
Usage
Copy
Ask AI
cpln location install <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Obtain instructions to install a BYOK location.
Copy
Ask AI
cpln location install demo-byok-location --org demo-cpln-organization
location patch
Update the referenced locations’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln location patch aws-eu-central-1 --file update.json --org demo-cpln-organization
location permissions
Show the grantable permissions for a location object type
Usage
Copy
Ask AI
cpln location permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln location permissions --org demo-cpln-organization
location query
Find all the locations based on the given query
Usage
Copy
Ask AI
cpln location query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property or tag
- Search for a location based on the name property
Copy
Ask AI
cpln location query --match any --prop name=aws-eu-central-1 --org demo-cpln-organization
- Search for a location based on the description property
Copy
Ask AI
cpln location query --match any --prop description="Azure, East US 2" --org demo-cpln-organization
- Search for a location based on a tag
Copy
Ask AI
cpln location query --match any --tag cpln/city="Frankfurt" --org demo-cpln-organization
- Search for a location based on a property and tag
Copy
Ask AI
cpln location query --match any --prop description="Azure, East US 2" --tag cpln/city="Frankfurt" --org demo-cpln-organization
location tag
Manage the tags belonging to one or more referenced locations
Usage
Copy
Ask AI
cpln location tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a tag to a location
Copy
Ask AI
cpln location tag aws-eu-central-1 --tag drink=water --org demo-cpln-organization
- Update same tag (after running the example above)
Copy
Ask AI
cpln location tag aws-eu-central-1 --tag drink=coffee --org demo-cpln-organization
- Remove tag (after running the example above)
Copy
Ask AI
cpln location tag aws-eu-central-1 --remove drink --org demo-cpln-organization
- Add same tag to multiple locations
Copy
Ask AI
cpln location tag aws-eu-central-1 azure-eastus2 --tag multiple-locations=true --org demo-cpln-organization
- Update same tag on multiple locations (after running the example above)
Copy
Ask AI
cpln location tag aws-eu-central-1 azure-eastus2 --tag multiple-locations=demo-location --org demo-cpln-organization
- Remove same tag from multiple locations (after running the example above)
Copy
Ask AI
cpln location tag aws-eu-central-1 azure-eastus2 --remove multiple-locations --org demo-cpln-organization
location uninstall
Get instructions for obtaining the uninstallation script for a BYOK location
Usage
Copy
Ask AI
cpln location uninstall <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Obtain instructions to uninstall a BYOK location.
Copy
Ask AI
cpln location uninstall demo-byok-location --org demo-cpln-organization
login
Create a profile named “default” and launch a browser to begin the interactive login process
Usage
Copy
Ask AI
cpln login [ref] [OPTIONS]
Copy
Ask AI
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]
Copy
Ask AI
cpln login
logs
Show logs
For a detailed overview, please visit the logs’ reference page.
Usage
Copy
Ask AI
cpln 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
Copy
Ask AI
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]
Copy
Ask AI
cpln logs '{gvc="demo-gvc-logs",workload="demo-workload-logs"}'
Copy
Ask AI
cpln logs '{provider="aws"}'
misc
Miscellaneous helper commands
Copy
Ask AI
cpln misc [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln misc install-completion Install shell completion to your local profile
cpln misc uninstall-completion Uninstall shell completion from your local profile
Options:
--help Show help [boolean]
--version Show version number [boolean]
misc Subcommands
misc install-completion
Install shell completion to your local profile
Usage
Copy
Ask AI
cpln misc install-completion [OPTIONS]
Copy
Ask AI
Command options:
--batch Non-interactive (batch) mode [boolean]
Options:
--help Show help [boolean]
--version Show version number [boolean]
Copy
Ask AI
cpln misc install-completion
misc uninstall-completion
Uninstall shell completion from your local profile
Usage
Copy
Ask AI
cpln misc uninstall-completion [OPTIONS]
Copy
Ask AI
Options:
--help Show help [boolean]
--version Show version number [boolean]
Copy
Ask AI
cpln misc uninstall-completion
mk8s
Manage an mk8s cluster
Copy
Ask AI
cpln mk8s [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln mk8s access-report <ref> Show the access report for the referenced mk8s cluster
cpln mk8s clone <ref> Create a clone of the referenced mk8s cluster; this will only duplicate its spec. [aliases: copy]
cpln mk8s dashboard <ref> Open the k8s dashboard for an mk8s cluster
cpln mk8s delete <ref...> Delete one or more referenced mk8s clusters
cpln mk8s edit <ref> Edit the referenced mk8s cluster, as YAML, within an editor
cpln mk8s eventlog <ref> Show the event log of the referenced mk8s cluster [aliases: log]
cpln mk8s get [ref...] Retrieve one or more referenced mk8s cluster
cpln mk8s join <ref> Join compute nodes to a cluster
cpln mk8s kubeconfig <ref> Create a kubeconfig for a cluster.
cpln mk8s patch <ref> Update the referenced mk8s cluster's metadata using an input file
cpln mk8s permissions Show the grantable permissions for an mk8s cluster object type
cpln mk8s query Find all the mk8s clusters based on the given query
cpln mk8s tag <ref...> Manage the tags belonging to one or more referenced mk8s clusters
cpln mk8s update <ref> Update properties of the referenced mk8s cluster
Options:
--help Show help [boolean]
mk8s Subcommands
mk8s access-report
Show the access report for the referenced mk8s cluster
Usage
Copy
Ask AI
cpln mk8s access-report <ref> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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]
mk8s clone
Create a clone of the referenced mk8s cluster; this will only duplicate its spec.
Usage
Copy
Ask AI
cpln mk8s clone <ref> --name CLONE_NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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]
mk8s dashboard
Open the k8s dashboard for an mk8s cluster
Usage
Copy
Ask AI
cpln mk8s dashboard <ref> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
mk8s delete
Delete one or more referenced mk8s clusters
Usage
Copy
Ask AI
cpln mk8s delete <ref...> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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]
mk8s edit
Edit the referenced mk8s cluster, as YAML, within an editor
Usage
Copy
Ask AI
cpln mk8s edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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]
mk8s eventlog
Show the event log of the referenced mk8s cluster
Usage
Copy
Ask AI
cpln mk8s eventlog <ref> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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]
mk8s get
Retrieve one or more referenced mk8s cluster
Usage
Copy
Ask AI
cpln mk8s get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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]
mk8s join
Join compute nodes to a cluster
Usage
Copy
Ask AI
cpln mk8s join <ref> [OPTIONS]
Copy
Ask AI
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:
* 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]
mk8s kubeconfig
Create a kubeconfig for a cluster.
Usage
Copy
Ask AI
cpln mk8s kubeconfig <ref> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
mk8s patch
Update the referenced mk8s cluster’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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]
mk8s permissions
Show the grantable permissions for an mk8s cluster object type
Usage
Copy
Ask AI
cpln mk8s permissions [OPTIONS]
Copy
Ask AI
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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]
mk8s query
Find all the mk8s clusters based on the given query
Usage
Copy
Ask AI
cpln mk8s query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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]
mk8s tag
Manage the tags belonging to one or more referenced mk8s clusters
Usage
Copy
Ask AI
cpln mk8s tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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]
mk8s update
Update properties of the referenced mk8s cluster
Usage
Copy
Ask AI
cpln mk8s update <ref> --set UPDATE_PROPERTY [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Update Properties:
--set Update the following properties (e.g., --set description="Updated Description"):
description string
tags.<key> string
spec.version string [required]
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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]
operator
A Kubernetes operator for Control Plane
Refer to the cpln operator guide for additional details.
Copy
Ask AI
cpln operator [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln operator install Install the Kubernetes operator to your cluster
cpln operator uninstall Uninstall the Kubernetes operator from your cluster
Options:
--help Show help [boolean]
operator Subcommands
operator install
Install the Kubernetes operator to your cluster
Usage
Copy
Ask AI
cpln operator install [OPTIONS]
Copy
Ask AI
Command options:
--serviceaccount, -s The service account name for the operator. If the service account does not exist, a new one will be created [required]
--serviceaccount-group, -g The group to assign to the service account if it will be created. [default: "superusers"]
--export Export the Kubernetes resources to a file instead of applying them to the cluster. [boolean]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
operator uninstall
Uninstall the Kubernetes operator from your cluster
Usage
Copy
Ask AI
cpln operator uninstall [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
org
Manage organizations
For a detailed overview, please visit the org’s reference page.
Copy
Ask AI
cpln org [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln org access-report <ref> Show the access report for the referenced organization
cpln org create Create a new organization
cpln org edit <ref> Edit the referenced organization, as YAML, within an editor
cpln org eventlog <ref> Show the event log of the referenced organization [aliases: log]
cpln org get [ref...] Retrieve one or more referenced organizations
cpln org patch <ref> Update the referenced organization's metadata using an input file
cpln org permissions Show the grantable permissions for an organization object type
cpln org query Find all the organizations based on the given query
cpln org tag <ref...> Manage the tags belonging to one or more referenced organizations
cpln org update <ref> Update properties of the referenced organization
Options:
--help Show help [boolean]
org Subcommands
org access-report
Show the access report for the referenced organization
Usage
Copy
Ask AI
cpln org access-report <ref> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln org access-report demo-cpln-organization
org create
Create a new organization
Usage
Copy
Ask AI
cpln org create --name ORG_NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
name- Minimum Length: 3
- Maximum Length: 64
- Only lowercase characters
- Must begin with a character
- Allowed special characters: -
Copy
Ask AI
cpln org create --name demo-cpln-organization --acountId ACCOUNT_ID --invitee EMAIL
org edit
Edit the referenced organization, as YAML, within an editor
Usage
Copy
Ask AI
cpln org edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln org edit demo-cpln-organization
org eventlog
Show the event log of the referenced organization
Usage
Copy
Ask AI
cpln org eventlog <ref> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln org eventlog demo-cpln-organization
org get
Retrieve one or more referenced organizations
Usage
Copy
Ask AI
cpln org get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Get all organizations
Copy
Ask AI
cpln org get
- Get one organization
Copy
Ask AI
cpln org get demo-cpln-organization
org patch
Update the referenced organization’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln org patch demo-cpln-organization --file update.json
org permissions
Show the grantable permissions for an organization object type
Usage
Copy
Ask AI
cpln org permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile 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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln org permissions
org query
Find all the organizations based on the given query
Usage
Copy
Ask AI
cpln org query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property or tag
- Search for an organization based on the name property
Copy
Ask AI
cpln org query --match any --prop name=demo-cpln-organization
- Search for an organization based on the description property
Copy
Ask AI
cpln org query --match any --prop description="Demo Organization"
- Search for an organization based on a tag
Copy
Ask AI
cpln org query --match any --tag type=demo
- Search for an organization based on a property and tag
Copy
Ask AI
cpln org query --match any --prop description="Demo Organization" --tag type=demo
org tag
Manage the tags belonging to one or more referenced organizations
Usage
Copy
Ask AI
cpln org tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a tag
Copy
Ask AI
cpln org tag demo-cpln-organization --tag drink=water
- Update same tag (after running the example above)
Copy
Ask AI
cpln org tag demo-cpln-organization --tag drink=coffee
- Remove tag (after running the example above)
Copy
Ask AI
cpln org tag demo-cpln-organization --remove drink
org update
Update properties of the referenced organization
Usage
Copy
Ask AI
cpln org update <ref> --set UPDATE_PROPERTY [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Update Properties:
--set Update the following properties (e.g., --set description="Updated Description"):
description string
tags.<key> string [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- The
--setoption allows the modification of the following organization properties:description- Description of the organization
- Type: string
tags- Tags (key=value) associated with the organization
- Type: string
- For the examples below, the initial organization is configured as:
Copy
Ask AI
+-----------------------+------------------+----------------------------+----------------------+
|NAME |DESCRIPTION |LINK |TAGS |
|-----------------------|------------------|----------------------------|----------------------|
|demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
| | | |type="demo" |
+-----------------------+------------------+----------------------------+----------------------+
- Update an organization’s description
Copy
Ask AI
cpln org update demo-cpln-organization --set description="new description"
- Update an organization’s tag
Copy
Ask AI
cpln org update demo-cpln-organization --set tags.demo-key=demo-value
policy
Manage access policies
For a detailed overview, please visit the policy’s reference page.
Copy
Ask AI
cpln policy [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln policy access-report <ref> Show the access report for the referenced policy
cpln policy add-binding <ref> Bind one or more permissions to the referenced policy and associate it with one or more users / service accounts / groups / identities
cpln policy clone <ref> Clone a policy [aliases: copy]
cpln policy create Create a new policy
cpln policy delete <ref...> Delete one or more referenced policies
cpln policy edit <ref> Edit the referenced policy, as YAML, within an editor
cpln policy eventlog <ref> Show the event log of the referenced policy [aliases: log]
cpln policy get [ref...] Retrieve one or more referenced policies
cpln policy patch <ref> Update the referenced policy's metadata using an input file
cpln policy permissions Show the grantable permissions for a policy object type
cpln policy query Find all the policies based on the given query
cpln policy remove-binding <ref> Remove the bindings of one or more permissions from the referenced policy and disassociate it from one or more users / service accounts / groups / identities
cpln policy tag <ref...> Manage the tags belonging to one or more referenced policies
cpln policy update <ref> Update properties of the referenced policy
Options:
--help Show help [boolean]
policy Subcommands
policy access-report
Show the access report for the referenced policy
Usage
Copy
Ask AI
cpln policy access-report <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln policy access-report demo-policy --org demo-cpln-organization
policy add-binding
Bind one or more permissions to the referenced policy and associate it with one or more users / service accounts / groups / identities
Usage
Copy
Ask AI
cpln policy add-binding <ref> --permission PERMISSION_NAME COMMAND_OPTIONS [OPTIONS]
Copy
Ask AI
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 name OR 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
--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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Bind the view permission to the referenced policy named `demo-policy-add-binding` and associate it with the built-in controlplane service account
Copy
Ask AI
cpln policy add-binding demo-policy --permission view --serviceaccount controlplane --org demo-cpln-organization
policy clone
Clone a policy
Usage
Copy
Ask AI
cpln policy clone <ref> --name CLONE_NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln policy clone demo-policy --name demo-policy-clone --org demo-cpln-organization
policy create
Create a new policy
Usage
Copy
Ask AI
cpln policy create --name POLICY_NAME --target-king TARGET [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln policy create --name demo-policy --target-kind org --all --desc demo-policy --tag drink=water --org demo-cpln-organization
policy delete
Delete one or more referenced policies
Usage
Copy
Ask AI
cpln policy delete <ref...> [OPTIONS]
Deleting a policy will remove all associated resources (targets, bindings, etc.)
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln policy delete demo-policy --org demo-cpln-organization
policy edit
Edit the referenced policy, as YAML, within an editor
Usage
Copy
Ask AI
cpln policy edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln policy edit demo-policy --org demo-cpln-organization
policy eventlog
Show the event log of the referenced policy
Usage
Copy
Ask AI
cpln policy eventlog <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln policy eventlog demo-policy --org demo-cpln-organization
policy get
Retrieve one or more referenced policies
Usage
Copy
Ask AI
cpln policy get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Get all policies
Copy
Ask AI
cpln policy get --org demo-cpln-organization
- Get one policy
Copy
Ask AI
cpln policy get demo-policy-get-1 --org demo-cpln-organization
- Get multiple policies
Copy
Ask AI
cpln policy get demo-policy-get-1 demo-policy-get-2 --org demo-cpln-organization
policy patch
Update the referenced policy’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln policy patch demo-policy --file update.json --org demo-cpln-organization
policy permissions
Show the grantable permissions for a policy object type
Usage
Copy
Ask AI
cpln policy permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln policy permissions --org demo-cpln-organization
policy query
Find all the policies based on the given query
Usage
Copy
Ask AI
cpln policy query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property or tag
- Search for a policy based on the name property
Copy
Ask AI
cpln policy query --match any --prop name=demo-policy --org demo-cpln-organization
- Search for a policy based on the description property
Copy
Ask AI
cpln policy query --match any --prop description="demo-policy" --org demo-cpln-organization
- Search for a policy based on a tag
Copy
Ask AI
cpln policy query --match any --tag drink=water --org demo-cpln-organization
- Search for a policy based on a property and tag
Copy
Ask AI
cpln policy query --match any --prop description="demo-policy" --tag drink=water --org demo-cpln-organization
policy remove-binding
Remove the bindings of one or more permissions from the referenced policy and disassociate it from one or more users / service accounts / groups / identities
Usage
Copy
Ask AI
cpln policy remove-binding <ref> --permission PERMISSION_NAME COMMAND_OPTIONS [OPTIONS]
Copy
Ask AI
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 name OR 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
--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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Remove the binding of the view permission from the policy named
demo-policyand disassociate it with the built-in controlplane service account.
Copy
Ask AI
cpln policy remove-binding demo-policy --permission manage --serviceaccount controlplane --org demo-cpln-organization
policy tag
Manage the tags belonging to one or more referenced policies
Usage
Copy
Ask AI
cpln policy tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Add a tag to a policy
Copy
Ask AI
cpln policy tag demo-policy-tag-1 --tag drink=water --org demo-cpln-organization
- Update same tag (after running the example above)
Copy
Ask AI
cpln policy tag demo-policy-tag-1 --tag drink=coffee --org demo-cpln-organization
- Remove tag (after running the example above)
Copy
Ask AI
cpln policy tag demo-policy-tag-1 --remove drink --org demo-cpln-organization
- Add same tag to multiple policies
Copy
Ask AI
cpln policy tag demo-policy-tag-1 demo-policy-tag-2 --tag multiple-policies=true --org demo-cpln-organization
- Update same tag on multiple policies (after running the example above)
Copy
Ask AI
cpln policy tag demo-policy-tag-1 demo-policy-tag-2 --tag multiple-policies=demo-policy --org demo-cpln-organization
- Remove same tag from multiple policies (after running the example above)
Copy
Ask AI
cpln policy tag demo-policy-tag-1 demo-policy-tag-2 --remove multiple-policies --org demo-cpln-organization
policy update
Update properties of the referenced policy
Usage
Copy
Ask AI
cpln policy update <ref> --set UPDATE_PROPERTY [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Update Properties:
--set Update the following properties (e.g., --set description="Updated Description"):
description string
tags.<key> string
targetLinks string[]
target { 'all' }
Arrays can be appended to, replaced, or removed using the `+=`, `=`, or `-=` operators, respectively. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- The
--setoption allows the modification of the following policy properties:description- Description of the policy
- Type: string
tags- Tags (key=value) associated with the policy
- Type: string
targetLinks- Array of target links belonging to the policy
- Type: string
target- The target of the policy
- Type: string
- Allowed values: ‘all’
- For the examples below, the initial policy is configured as:
Copy
Ask AI
+------------+------------+--------------+------------+--------+--------+--------------+
|NAME |DESCRIPTION |CREATED |TARGET KIND |MATCHES |ORIGIN |TAGS |
|------------|------------|--------------|------------|--------|--------|--------------|
|demo-policy |demo-policy |0 minutes ago |org |all |default |drink="water" |
+------------+------------+--------------+------------+--------+--------+--------------+
- Update a policy’s description
Copy
Ask AI
cpln policy update demo-policy --set description="new description" --org demo-cpln-organization
- Update a policy’s tags
Copy
Ask AI
cpln policy update demo-policy --set tags.demo-key=demo-value --org demo-cpln-organization
- Add to a policy’s target links.
Copy
Ask AI
cpln policy update demo-policy --set targetLinks+="/org/demo-cpln-organization/gvc/demo-gvc-policy" --org demo-cpln-organization
- Remove from a policy’s target links.
Copy
Ask AI
cpln policy update demo-policy --set targetLinks-="/org/demo-cpln-organization/gvc/demo-gvc-policy" --org demo-cpln-organization
- Update a policy’s target to all
Copy
Ask AI
cpln policy update demo-policy --set target=all --org demo-cpln-organization
port-forward
Establish secure local access to your workload.
Refer to the cpln port-forward guide for additional details.
Usage
Copy
Ask AI
cpln port-forward <ref> <ports...> [OPTIONS]
Copy
Ask AI
Positionals:
ref The name of the workload to forward traffic to. [string] [required]
ports Port mappings in the format [LOCAL_PORT:]REMOTE_PORT (e.g. 8080:80). [array] [required] [default: []]
Command options:
--location A global virtual cloud location [string]
--address Addresses to listen on (comma separated). Only accepts IP addresses or localhost as a value. When localhost is supplied, cpln will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these addresses are available to bind. [default: "localhost"]
--replica The name of the workload deployment 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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
--version Show version number [boolean]
- Forward a single port from workload to local machine
Copy
Ask AI
cpln port-forward db-workload 5432:5432 --location aws-us-west-1 --org demo-org --gvc demo-gvc
- Forward multiple ports from workload to local machine
Copy
Ask AI
cpln port-forward db-workload 8080:80 8443:443 --location aws-us-west-1 --org demo-org --gvc demo-gvc
- Forward workload ports to multiple addresses
Copy
Ask AI
cpln port-forward db-workload 5432:5432 --address 0.0.0.0,127.0.0.1 --location aws-us-west-1 --org demo-org --gvc demo-gvc
- Assign an ephemeral local port
Copy
Ask AI
cpln port-forward db-workload :80 --location aws-us-west-1 --org demo-org --gvc demo-gvc
- Assign the same local and remote port
Copy
Ask AI
cpln port-forward db-workload 80 --location aws-us-west-1 --org demo-org --gvc demo-gvc
profile
Manage local profiles
For a detailed overview, please visit the manage CLI profiles guide.
Copy
Ask AI
cpln profile [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln profile delete <profiles...> Delete one or more referenced profiles
cpln profile get [profiles...] Retrieve one or more profiles
cpln profile login [ref] Create a profile named "default" and launch a browser to begin the interactive login process
cpln profile set-default <profile> Set the referenced profile as the default
cpln profile token [profile] Show the JWT token of the referenced profile
cpln profile update <profile> Manage the referenced profile [aliases: create]
Options:
--version Show version number [boolean]
--help Show help [boolean]
profile Subcommands
profile delete
Delete one or more referenced profiles
Usage
Copy
Ask AI
cpln profile delete <profiles...> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--version Show version number [boolean]
--help Show help [boolean]
- Delete one profile
Copy
Ask AI
cpln profile delete default
- Delete multiple profiles
Copy
Ask AI
cpln profile delete demo-profile@example.com default
profile get
Retrieve one or more profiles
Usage
Copy
Ask AI
cpln profile get [profiles...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--version Show version number [boolean]
--help Show help [boolean]
Copy
Ask AI
cpln profile get default
profile login
Create a profile named “default” and launch a browser to begin the interactive login process
Usage
Copy
Ask AI
cpln profile login [ref] [OPTIONS]
Copy
Ask AI
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]
Copy
Ask AI
cpln profile login
profile set-default
Set the referenced profile as the default
Usage
Copy
Ask AI
cpln profile set-default <profile> [OPTIONS]
Copy
Ask AI
Positionals:
profile Profile name to be set as the default [required]
Options:
--version Show version number [boolean]
--help Show help [boolean]
Copy
Ask AI
cpln profile set-default demo-profile
profile token
Show the JWT token of the referenced profile
Usage
Copy
Ask AI
cpln profile token [profile] [OPTIONS]
An empty reference will return the token for the default profile
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--version Show version number [boolean]
--help Show help [boolean]
Copy
Ask AI
cpln profile token demo-profile
Token Server Usage
Copy
Ask AI
- 'cpln profile token --serve': Create a server (default port of 43200) instead of outputting the token directly.
This command generates a profile specific token to authenticate against this token server.
- 'cpln profile token --serve --port PORT': Sets the port of the token server.
- 'cpln profile token --jwt': Outputs the token server token for the profile.
- 'cpln profile token --generateToken': Regenerates a token for the profile, for the token server.
An example use case is to integrate the server to a Postman collection. The collection can then make requests to the Control Plane API
without needing to manually copy the token. After the server is running, by executing the 'cpln profile token --serve' command , the user
can utilize the Pre-request script below in Postman:
------------------------
const postRequest = {
url: "http://localhost:" + pm.environment.get("cplnTokenServerPort") + "/" + pm.environment.get("profile") + "/token",
method: 'GET',
header: {
'authorization': "Bearer " + pm.environment.get("cplnTokenServerToken")
},
};
pm.sendRequest(postRequest, (err, response) => {
pm.environment.set("token", response.text());
})
------------------------
profile update
Manage the referenced profile
Usage
Copy
Ask AI
cpln profile update <profile> COMMAND_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--version Show version number [boolean]
--help Show help [boolean]
- Create a new profile
Copy
Ask AI
cpln profile update new-profile
- Perform an interactive login using a custom profile
Copy
Ask AI
cpln profile update new-profile --login
- Set the referenced profile as the default profile
Copy
Ask AI
cpln profile update new-profile --default
- Set a default organization and GVC on the referenced profile
Copy
Ask AI
cpln profile update new-profile --org demo-cpln-organization --gvc demo-gvc
- Remove default organization and GVC on the referenced profile
Copy
Ask AI
cpln profile update new-profile --org "" --gvc ""
quota
Show quotas
For a detailed overview, please visit the quota’s reference page.
Copy
Ask AI
cpln quota [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln quota edit <ref> Edit the referenced quota, as YAML, within an editor
cpln quota get [ref...] Retrieve one or more referenced quotas
cpln quota patch <ref> Update the referenced quota's metadata using an input file
cpln quota permissions Show the grantable permissions for a quota object type
cpln quota query Find all the quotas based on the given query
Options:
--help Show help [boolean]
quota Subcommands
quota edit
Edit the referenced quota, as YAML, within an editor
Usage
Copy
Ask AI
cpln quota edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln quota edit b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --org demo-cpln-organization
quota get
Retrieve one or more referenced quotas
Usage
Copy
Ask AI
cpln quota get [ref...] [OPTIONS]
An empty reference will return all references
Copy
Ask AI
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
- Get all quotas
Copy
Ask AI
cpln quota get --org demo-cpln-organization
- Get one quota
Copy
Ask AI
cpln quota get b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --org demo-cpln-organization
- Get multiple quotas
Copy
Ask AI
cpln quota get b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 --org demo-cpln-organization
quota patch
Update the referenced quota’s metadata using an input file
Usage
Copy
Ask AI
cpln 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).
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln quota patch b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --file update.json --org demo-cpln-organization
quota permissions
Show the grantable permissions for a quota object type
Usage
Copy
Ask AI
cpln quota permissions [OPTIONS]
Copy
Ask AI
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln quota permissions --org demo-cpln-organization
quota query
Find all the quotas based on the given query
Usage
Copy
Ask AI
cpln quota query QUERY_OPTIONS [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Use the --match option to display all, none, or any of the results based on a given property, tag, or relation
- Search for a quota based on a property named
description
Copy
Ask AI
cpln quota query --match any --prop description="Max number of domains" --org demo-cpln-organization
rest
Submit REST requests against the API
Copy
Ask AI
cpln rest [SUBCOMMAND]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
rest Subcommands
rest create
Submit a POST request followed by a GET request against the referenced path
Usage
Copy
Ask AI
cpln 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
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln rest create /org --file create-org.json
rest delete
Submit a DELETE request against the referenced path
Usage
Copy
Ask AI
cpln rest delete <path> [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln rest delete /org/demo-cpln-organization/gvc/demo-gvc
rest edit
Launches the default editor with the contents of the referenced path
Usage
Copy
Ask AI
cpln rest edit <path> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln rest edit /org/demo-cpln-organization
rest get
Submit a GET request against the referenced path
Usage
Copy
Ask AI
cpln rest get <path> [OPTIONS]
An empty reference will return all references
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln rest get /org/demo-cpln-organization
rest patch
Submit a PATCH request against the referenced path
Usage
Copy
Ask AI
cpln 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
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln rest patch /org/demo-cpln-organization --file update-org.json
rest post
Submit a POST request against the referenced path
Usage
Copy
Ask AI
cpln 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
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln rest post /org --file new-org.json
rest put
Submit a PUT request against the referenced path
Usage
Copy
Ask AI
cpln rest put <path> [OPTIONS]
If using the option —file -, press Control-D (or Control-Z if you are using Windows) to submit the request
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln rest put /org/demo-cpln-organization --file update-org.json
secret
Manage secrets
For a detailed overview, please visit the secret’s reference page.
Copy
Ask AI
cpln secret [SUBCOMMAND]
Copy
Ask AI
Commands:
cpln secret access-report <ref> Show the access report for the referenced secret
cpln secret clone <ref> Create a clone of the referenced secret [aliases: copy]
cpln secret create-aws Create a new AWS secret
cpln secret create-azure-connector Create a new Azure Connector secret
cpln secret create-azure-sdk Create a new Azure SDK secret
cpln secret create-dictionary Create a new dictionary secret [aliases: create-dict]
cpln secret create-docker Create a new Docker secret
cpln secret create-ecr Create a new ECR secret
cpln secret create-gcp Create a new GCP secret
cpln secret create-keypair Create a new KeyPair secret
cpln secret create-nats Create a new nats account secret
cpln secret create-opaque Create a new opaque secret
cpln secret create-tls Create a new TLS secret
cpln secret create-userpass Create a new Username/Password secret
cpln secret delete <ref...> Delete one or more referenced secrets
cpln secret edit <ref> Edit the referenced secret, as YAML, within an editor
cpln secret eventlog <ref> Show the event log of the referenced secret [aliases: log]
cpln secret get [ref...] Retrieve one or more referenced secrets
cpln secret patch <ref> Update the referenced secret's metadata using an input file
cpln secret permissions Show the grantable permissions for a secret object type
cpln secret query Find all the secrets based on the given query
cpln secret reveal [ref] Show the secret in plaintext
cpln secret tag <ref...> Manage the tags belonging to one or more referenced secrets
cpln secret update <ref> Update properties of the referenced secret
Options:
--help Show help [boolean]
secret Subcommands
secret access-report
Show the access report for the referenced secret
Usage
Copy
Ask AI
cpln secret access-report <ref> [OPTIONS]
Copy
Ask AI
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln secret access-report demo-secret --org demo-cpln-organization
secret clone
Create a clone of the referenced secret
Usage
Copy
Ask AI
cpln secret clone <ref> --name CLONE_NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Copy
Ask AI
cpln secret clone demo-secret --name demo-secret-clone --org demo-cpln-organization
secret create-aws
Create a new AWS secret
Usage
Copy
Ask AI
cpln secret create-aws --name SECRET_NAME --access-key AWS_ACCESS_KEY --secret-key AWS_SECRET_KEY [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
secret create-azure-connector
Create a new Azure Connector secret
Usage
Copy
Ask AI
cpln secret create-azure-connector --name SECRET_NAME --url DEPLOYMENT_URL --code FUNCTION_APP_CODE [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
secret create-azure-sdk
Create a new Azure SDK secret
Usage
Copy
Ask AI
cpln secret create-azure-sdk --name SECRET_NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
secret create-dictionary
Create a new dictionary secret
Usage
Copy
Ask AI
cpln secret create-dictionary --name SECRET_NAME --entry KEY=VALUE [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
secret create-docker
Create a new Docker secret
Usage
Copy
Ask AI
cpln secret create-docker --name SECRET_NAME --file FILE_NAME
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
secret create-ecr
Create a new ECR secret
Usage
Copy
Ask AI
cpln secret create-ecr --name SECRET_NAME --access-key AWS_ACCESS_KEY --repo ECR_REPO [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
secret create-gcp
Create a new GCP secret
Usage
Copy
Ask AI
cpln secret create-gcp --name FILE_NAME --file FILE_NAME [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
secret create-keypair
Create a new KeyPair secret
Usage
Copy
Ask AI
cpln secret create-keypair --name SECRET_NAME --secret PATH_TO_SECRET_KEY [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
secret create-nats
Create a new nats account secret
Usage
Copy
Ask AI
cpln secret create-nats --name SECRET_NAME --account-id ACCOUNT_ID --private-key PRIVATE_KEY [OPTIONS]
Copy
Ask AI
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", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
secret create-opaque
Create a new opaque secret
Usage
Copy
Ask AI
cpln secret create-opaque --name SECRET_NAME --file FILE_NAME [OPTIONS]
Copy
Ask AI