The Control Plane CLI (cpln) can be installed by using npm, homebrew or by downloading the specific binary package for the target operating system.
Preferred Installation Method
Execute the following command to install the CLI:
copynpm install -g @controlplane/cli
Execute the following command to update the CLI:
copynpm update -g @controlplane/cli
Follow these instructions to install homebrew, then execute the following command:
copybrew tap controlplane-com/cpln && brew install cpln
Execute the following command to update:
copybrew update && brew upgrade
In cases where Node.js cannot be used, select the package that matches the target operating system:
OS | File | sha256 |
---|---|---|
macOS | cpln-macos.tgz | |
Linux | cpln-linux.tgz | |
Windows 10/11 | cpln-win.zip |
For macOS with M1, please install using npm
or brew
.
After the package has been downloaded, decompress it to a location within the PATH
Decompression helper commands:
OS | Command |
---|---|
macOS | gunzip cpln-macos.tgz && open cpln-macos.tar |
Linux | tar -xvf cpln-linux.tgz |
Windows 10/11 | tar -xvf cpln-win.zip |
The package contains two executables:
cpln
: The Control Plane CLI.docker-credential-cpln
: A tool required by the CLI allowing Docker to authenticate to your org's private image registry.After installing the CLI, enabling autocomplete will help the user quickly iterate through the commands by entering the first few letters of a command and pressing the Tab key.
copycpln misc install-completion
If you wish to enable auto-completion in the zsh
shell, make sure you have the following commands at the beginning of your ~/.zshrc
file:
copyautoload -U compinitcompinit
Autocomplete workaround for users of Cygwin
:
After executing the cpln misc install-completion
command:
cpln.bash
file from C:/Users/<username>/.config/tabtab/cpln.bash
to C:/cygwin64/home/<username>/.config/tabtab/cpln.bash
.bashrc
file at C:/cygwin64/home/<username>/.bashrc
.bashrc
file: . C:/cygwin64/home/<username>/.config/tabtab/cpln.bash
The Control Plane CLI is executed by running:
cpln COMMAND SUBCOMMAND [OPTIONS]
The following commands are available (viewable by running cpln --help
):
cpln <command>
Commands: cpln agent Manage agents cpln apply Create or update a resource using an input file cpln auditctx Manage audit contexts cpln cloudaccount Manage cloud accounts cpln convert Convert k8s files to cpln files cpln delete Delete resources from files cpln domain Manage custom domains cpln group Manage groups cpln gvc Manage global virtual clouds cpln identity Manage identities within a global virtual cloud [aliases: id] cpln image Manage images and configure Docker login cpln location Manage locations [aliases: loc] cpln login Create a profile named "default" and launch a browser to begin the interactive login process cpln logs <query> Show logs cpln misc Miscellaneous helper commands cpln org Manage organizations cpln policy Manage access policies cpln profile Manage local profiles cpln quota Show quotas cpln rest Submit REST requests against the API cpln secret Manage secrets cpln serviceaccount Manage service accounts [aliases: sa] cpln task Manage pending tasks cpln user Manage users cpln workload Manage workloads within a global virtual cloud [aliases: w]
Options: --help Show help [boolean] --version Show version number [boolean]
© 2023 Control Plane Corporation
Each command and associated subcommands are described below.
The referenced objects in the subcommands follow this pattern:
[ref]: Optional object
[ref...]: One or more optional objects
<ref>: Required object
<ref...>: One or more required objects
If the response from a command is truncated, use the following options to view the complete response:
--output json
or -o json
--output yaml
or -o yaml
Most of the commands require that the org and/or the GVC be referred to using the
--org
and/or --gvc
options.
In order to avoid entering these options for each command, the default profile can be updated to refer to a default org and/or GVC using the cpln profile update command.
Example: cpln profile update default --org demo-cpln-organization --gvc demo-cpln-gvc
This command will update the default profile to use the demo-cpln-organization
org and the demo-cpln-gvc
GVC when executing a command that requires an org and/or GVC. The --org
and --gvc
will not longer be required.
Manage agents
For a detailed overview, please visit the agent's reference page.
copycpln agent [SUBCOMMAND]
Commands: cpln agent access-report <ref> Show the access report for the referenced agent cpln agent create Create a new agent cpln agent delete <ref...> Delete one or more referenced agents cpln agent edit <ref> Edit the referenced agent, as YAML, within an editor cpln agent eventlog <ref> Show the event log of the referenced agent [aliases: log] cpln agent get [ref...] Retrieve one or more referenced agents cpln agent info <ref> Get info about an agent cpln agent manifest Generate a manifest for running an agent in K8S cpln agent patch <ref> Update the referenced agent's metadata using an input file cpln agent permissions Show the grantable permissions for an agent object type cpln agent query Find all the agents based on the given query cpln agent tag <ref...> Manage the tags belonging to one or more referenced agents cpln agent up Run an agent within a local Docker instance cpln agent update <ref> Update properties of the referenced agent
Options: --help Show help [boolean]
agent Subcommands
Show the access report for the referenced agent
Usage
copycpln agent access-report <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln agent access-report demo-agent-access-report --org demo-cpln-organization
Create a new agent
Usage
copycpln agent create --name AGENT_NAME [OPTIONS]
Command options:--name Name of the agent [required]--description, --desc Optional description, defaults to the name if not set--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln agent create --name demo-agent-create --org demo-cpln-organization
Delete one or more referenced agents
Usage
copycpln agent delete <ref...> [OPTIONS]
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln agent delete demo-agent --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Edit the referenced agent, as YAML, within an editor
Usage
copycpln agent edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln agent edit demo-agent --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced agent
Usage
copycpln agent eventlog <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln agent eventlog demo-agent --org demo-cpln-organizationThe event log for the referenced agent will be shown.
Retrieve one or more referenced agents
Usage
copycpln agent get [ref...] [OPTIONS]
An empty reference will return all agents
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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln agent get --org demo-cpln-organization
$ cpln agent get demo-agent-get-1 --org demo-cpln-organization
$ cpln agent get demo-agent-get-1 demo-agent-get-2 --org demo-cpln-organization
Get info about an agent
Usage
copycpln agent info <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln agent info demo-agent-aws --org demo-cpln-organization{"env": {"cpuPlatform": "x86_64","image": "ami-0fff5e2863a768052","id": "i-01adfe256a82a2a76","machineType": "t2.micro","zone": "us-west-2c","internalIP": "172.31.13.246","hostname": "ip-172-31-13-246.us-west-2.compute.internal","vpc": "vpc-29e3c451","subnet": "subnet-b11e9dec","accountId": "015716931765","cloudProvider": "aws"},"lastActive": "2021-05-01T00:26:55.945Z","serviceCount": 0,"peerCount": 0}
Generate a manifest for running an agent in K8S
Usage
copycpln agent manifest --bootstrap-file FILE_NAME --namespace NAME_SPACE [OPTIONS]
Command options:--bootstrap-file Path to the bootstrap config file [required]--namespace, -n Namespace where the agent deployment(s) will live [required]--image Advanced use: Use a different agent Docker image--cluster Add metadata to agent's environment, useful to remind you which cluster an agent is running in--replicas Number of agents deployments to create [default: 1]--psp Configure a PodSecurityPolicy [boolean] [default: false]--create-namespace Create the namespace [boolean] [default: true]Options:--help Show help [boolean]
Update the referenced agent's metadata using an input file
Usage
copycpln agent patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln agent patch demo-agent --file agent-update.json --org demo-cpln-organization"copyThe changes within the JSON file will be performed against the referenced agent.
Show the grantable permissions for an agent object type
Usage
copycpln agent permissions [OPTIONS]
Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln agent permissions --org demo-cpln-organization+-------+-----------------------------------------+----------------------------------------+|NAME |DESCRIPTION |IMPLIES ||-------|-----------------------------------------|----------------------------------------||create |Create new agents | ||delete |Delete service agents | ||edit |Modify existing agents |view ||manage |Full access |create, delete, edit, manage, use, view ||use |Use an agent in an identity |view ||view |Read-only access | |+-------+-----------------------------------------+----------------------------------------+
Find all the agents based on the given query
Usage
copycpln agent query QUERY_OPTIONS [OPTIONS]
Query options:--match Query filter type [choices: "all", "none", "any"] [default: "all"]--property, --prop Property to query--tag Tag to query--rel Tag to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ cpln agent query --match any --prop name=demo-agent-query --org demo-cpln-organization
$ cpln agent query --match any --prop description="Sample Agent" --org demo-cpln-organization
$ cpln agent query --match any --tag agent=demo --org demo-cpln-organization
$ cpln agent query --match any --prop description="Sample Agent" --tag agent=demo --org demo-cpln-organization
Manage the tags belonging to one or more referenced agents
Usage
copycpln agent tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options:--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln agent tag demo-agent-tag --tag name="Demo Agent" --org demo-cpln-organization
$ cpln agent tag demo-agent-tag --tag name="Replaced Tag" --org demo-cpln-organization
$ cpln agent tag demo-agent-tag --tag name= --org demo-cpln-organization
Run an agent within a local Docker instance
Usage
copycpln agent up --bootstrap-file FILE_NAME [--background] [OPTIONS]
Command options:--bootstrap-file Path to the bootstrap config file [required]--background, -b If set, run the agent as a background process [boolean]--image Advanced use: Use a different agent Docker image--net Docker network to use [default: "bridge"]Options:--help Show help [boolean]
$ cpln agent up demo-agent --bootstrap-file bootstrap.configThe Control Plane agent will be executed in a local Docker instance using the referenced bootstrap config file
Update properties of the referenced agent
Usage
copycpln agent update [ref] --set UPDATE_PROPERTY [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Update Properties:--set Update the following properties (e.g., --set description="Updated Description"):description stringtags.<key> string [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
--set
option allows the modification of the following agent properties:description
tags
$ cpln agent update demo-agent-update --set description="Agent With An Updated Description" --org demo-cpln-organization
$ cpln agent update demo-agent-update --set tags.agent-name=demo --org demo-cpln-organization
Create or update a resource using an input file
Refer to the cpln apply guide for additional details.
Usage
copycpln apply --file FILE_NAME [OPTIONS]
Command options:
--file, -f File to load and use for the command. Use --file -
to enable input from stdin. [required]
--k8s Set this true if input file is k8s config file [boolean]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the cpln profile update
command
--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the cpln profile update
command
Format options: --output, -o Set the output format [choices: "text", "json", "yaml"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]
Debug options: --verbose, -v Enable verbose output to stderr [boolean][default: false] --debug, -d Show all HTTP communications [boolean][default: false]
Options: --help Show help [boolean] --version Show version number [boolean]
$ cpln apply --file action.jsonThe actions within the JSON file will be performed against the API.
Manage audit contexts
For a detailed overview, please visit the audit context's reference page.
copycpln auditctx [SUBCOMMAND]
Commands: cpln auditctx access-report <ref> Show the access report for the referenced audit context cpln auditctx clone <ref> Create a clone of the referenced audit context [aliases: copy] cpln auditctx create Create a new audit context cpln auditctx edit <ref> Edit the referenced audit context, as YAML, within an editor cpln auditctx eventlog <ref> Show the event log of the referenced audit context [aliases: log] cpln auditctx get [ref...] Retrieve one or more referenced audit contexts cpln auditctx patch <ref> Update the referenced audit context's metadata using an input file cpln auditctx permissions Show the grantable permissions for an audit context object type cpln auditctx query Find all the audit contexts based on the given query cpln auditctx tag <ref...> Manage the tags belonging to one or more referenced audit contexts cpln auditctx update <ref> Update properties of the referenced audit context
Options: --help Show help [boolean]
auditctx Subcommands
Show the access report for the referenced audit context
Usage
copycpln auditctx access-report <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln auditctx access-report demo-audit-context --org demo-cpln-organization
Create a clone of the referenced audit context
Usage
copycpln auditctx clone <ref> --name AUDIT_CONTEXT_CLONE_NAME [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--name Set the name for the clone [required]--description Optional description, defaults to the name if not set--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln auditctx clone demo-audit-context --name demo-audit-context-clone --org demo-cpln-organization┌─────────────────────────┬─────────────────────────────────────────┬────────┬─────┐│NAME │DESCRIPTION │ORIGIN │TAGS │├─────────────────────────┼─────────────────────────────────────────┼────────┼─────┤│demo-audit-context-clone │Clone of demo-audit-context │default │ │└─────────────────────────┴─────────────────────────────────────────┴────────┴─────┘
Create a new audit context
Usage
copycpln auditctx create --name AUDIT_CONTEXT_NAME [OPTIONS]
Command options:--name Name of the new audit context [required]--description, --desc Optional description, defaults to the name if not set--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln auditctx create --name demo-audit-context --org demo-cpln-organization┌───────────────────┬─────────────────────────────────────────┬────────┬─────┐│NAME │DESCRIPTION │ORIGIN │TAGS │├───────────────────┼─────────────────────────────────────────┼────────┼─────┤│demo-audit-context │demo-audit-context │default │ │└───────────────────┴─────────────────────────────────────────┴────────┴─────┘
Edit the referenced audit context, as YAML, within an editor
Usage
copycpln auditctx edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln auditctx edit demo-audit-contxt --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced audit context
Usage
copycpln auditctx eventlog <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln auditctx eventlog demo-auditctx --org demo-cpln-organizationThe event log for the referenced audit context will be shown.
Retrieve one or more referenced audit contexts
Usage
copycpln auditctx get [ref...] [OPTIONS]
An empty reference will return all audit contexts.
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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln auditctx get --org demo-cpln-organization
$ cpln auditctx get demo-audit-context --org demo-cpln-organization
$ cpln auditctx get demo-audit-context cpln --org demo-cpln-organization
Update an audit context's metadata by using an input file
Usage
copycpln auditctx patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln auditctx patch demo-audit-context --file audit-context-update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced audit context.
Show the grantable permissions for an audit context object type
Usage
copycpln auditctx permissions [OPTIONS]
Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln auditctx permissions --org demo-cpln-organization+-----------+-----------------------------------------+--------------------------------------------------+|NAME |DESCRIPTION |IMPLIES ||-----------|-----------------------------------------|--------------------------------------------------||create |Create new contexts | ||edit |Modify existing contexts |view ||manage |Full access |create, edit, manage, readAudit, view, writeAudit ||readAudit |Read from this context |view ||view |Read-only view | ||writeAudit |Write to this context |view |+-----------+-----------------------------------------+--------------------------------------------------+
Find all the audit contexts based on the given query
Usage
copycpln auditctx query QUERY_OPTIONS [OPTIONS]
Query options:--match Query filter type [choices: "all", "none", "any"] [default: "all"]--property, --prop Property to query--tag Tag to query--rel Tag to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ cpln auditctx query --match any --prop name=demo-audit-context --org demo-cpln-organization
$ cpln auditctx query --match any --prop description="Clone of demo-audit-context" --org demo-cpln-organization
$ cpln auditctx query --match any --tag type=demo --org demo-cpln-organization
$ cpln auditctx query --match any --prop description="Audit of your CPLN org" --tag type=demo --org demo-cpln-organization
Manage the tags belonging to one or more referenced audit contexts
Usage
copycpln auditctx tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options:--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln auditctx tag demo-audit-context --tag name="Demo Audit Context" --org demo-cpln-organization
$ cpln auditctx tag demo-audit-context --tag name="Replaced Tag" --org demo-cpln-organization
$ cpln auditctx tag demo-audit-context --tag name= --org demo-cpln-organization
Update properties of the referenced audit context
Usage
copycpln auditctx update [ref] --set UPDATE_PROPERTY [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Update Properties:--set Update the following properties (e.g., --set description="Updated Description"):description stringtags.<key> string [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
--set
option allows the modification of the following audit context properties:description
tags
$ cpln auditctx update demo-audit-context --set description="Audit Text With An Updated Description" --org demo-cpln-organization
$ cpln auditctx update demo-audit-context --set tags.type=updated --org demo-cpln-organization
Manage cloud accounts
For a detailed overview, please visit the cloud account's reference page.
copycpln cloudaccount [SUBCOMMAND]
Commands: cpln cloudaccount access-report <ref> Show the access report for the referenced cloud account cpln cloudaccount create-aws Create an AWS cloud account cpln cloudaccount create-azure Create an Azure cloud account cpln cloudaccount create-gcp Create a GCP cloud account cpln cloudaccount create-ngs Create a NGS cloud account cpln cloudaccount delete <ref...> Delete one or more referenced cloud accounts cpln cloudaccount edit <ref> Edit the referenced cloud account, as YAML, within an editor cpln cloudaccount eventlog <ref> Show the event log of the referenced cloud account [aliases: log] cpln cloudaccount get [ref...] Retrieve one or more referenced cloud accounts cpln cloudaccount patch <ref> Update the referenced cloud account's metadata using an input file cpln cloudaccount permissions Show the grantable permissions for a cloud account object type cpln cloudaccount query Find all the cloud accounts based on the given query cpln cloudaccount tag <ref...> Manage the tags belonging to one or more referenced cloud accounts
Options: --help Show help [boolean]
cloudaccount Subcommands
Show the access report for the referenced cloud account
Usage
copycpln cloudaccount access-report <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln cloudaccount access-report demo-aws-cloud-account-access-report --org demo-cpln-organization
Create an AWS cloud account
Usage
copycpln cloudaccount create-aws --name ACCOUNT_NAME --role-arn ROLE_ARN [OPTIONS]
By defining an AWS cloud account, you enable workloads to consume services from a specific AWS account.
The Control Plane CLI (cpln
) provides account-specific instructions for registering an AWS cloud account
with Control Plane. Simply execute cpln cloudaccount create-aws --how
to obtain step-by-step instructions.
The instructions emitted are specific to the organization for the currently logged-on cpln user.
To override the organization, pass the --org ORG_NAME
option.
Command options:--name Name of the new account--description, --desc Optional description, defaults to the name if not set--role-arn ARN of the role used by Control Plane to manage the account, in format `arn:aws:iam::<account number>:role/<name>`--how Show the steps on how to create and configure your AWS account [boolean]--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln cloudaccount create-aws --name demo-aws-cloud-account --role-arn arn:aws:iam::123412341234:role/cpln-demo-cpln-organization --org demo-cpln-organization
Create an Azure cloud account
Usage
copycpln cloudaccount create-azure --name ACCOUNT_NAME --secret AZURE_SECRET [OPTIONS]
By defining an Azure cloud account, you enable workloads to consume services from a specific Azure account.
The Control Plane CLI (cpln
) provides account-specific instructions for registering an Azure cloud account
with Control Plane. Simply execute cpln cloudaccount create-azure --how
to obtain step-by-step instructions.
The instructions emitted are specific to the organization for the currently logged-on cpln user.
To override the organization, pass the --org ORG_NAME
option.
Command options:--name Name of the new account--description, --desc Optional description, defaults to the name if not set--secret The name of the secret which will be created.--url The URL of the deployed function app.--code The URL of the deployed function app.--how Show the steps on how to create and configure your Azure subscription [boolean]--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln cloudaccount create-azure --name demo-azure-cloud-account --secret azure-secret --url https://function.app.url --code code --org demo-cpln-organization
Create a GCP cloud account
Usage
copycpln cloudaccount create-gcp --name ACCOUNT_NAME --project-id PROJECT_ID [OPTIONS]
By defining a GCP cloud account, you enable workloads to consume services from a specific GCP account.
The Control Plane CLI (cpln
) provides account-specific instructions for registering a GCP cloud account
with Control Plane. Simply execute cpln cloudaccount create-gcp --how
to obtain step-by-step instructions.
The instructions emitted are specific to the organization for the currently logged-on cpln user.
To override the organization, pass the --org ORG_NAME
option.
Command options:--name Name of the new account--description, --desc Optional description, defaults to the name if not set--project-id The ID of the project that Control Plane will manage--how Show the steps on how to create and configure your GCP project [boolean]--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln cloudaccount create-gcp --name demo-gcp-cloud-account --project-id 1234abc --org demo-cpln-organization
Create a NGS cloud account
Usage
copycpln cloudaccount create-ngs --name ACCOUNT_NAME --secret SECRET_REFERENCE [OPTIONS]
Command options:--name Name of the new account [required]--description, --desc Optional description, defaults to the name if not set--secret The secret used to authenticate to NGS [required]--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Delete one or more referenced cloud accounts
Usage
copycpln cloudaccount delete <ref...> [OPTIONS]
Deleting a cloud account will not remove any configuration at the associated cloud provider
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln cloudaccount demo-gcp-cloud-account --org demo-organizationIf the delete was successful, a new command prompt will be shown.
$ cpln cloudaccount demo-gcp-cloud-account demo-azure-cloud-account --org demo-organizationIf the delete was successful, a new command prompt will be shown.
Edit the referenced cloud account, as YAML, within an editor
Usage
copycpln cloudaccount edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln cloudaccount edit demo-gcp-cloud-account --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced cloud account
Usage
copycpln cloudaccount eventlog <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln cloudacccount eventlog demo-azure-cloud-account --org demo-cpln-organizationThe event log for the referenced cloud acccount will be shown.
Retrieve one or more referenced cloud accounts
Usage
copycpln cloudaccount get [ref...] [OPTIONS]
An empty reference will return all cloud accounts
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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln cloudaccount get --org demo-cpln-organization
$ cpln cloudaccount get demo-aws-cloud-account-get --org demo-cpln-organization
$ cpln cloudaccount get demo-azure-cloud-account-get demo-gcp-cloud-account-get --org demo-cpln-organization
Update the referenced cloud account's metadata using an input file
Usage
copycpln cloudaccount patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln cloudaccount patch demo-gcp-cloud-account --file cloud-account-update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced cloud account.
Show the grantable permissions for a cloud account object type
Usage
copycpln cloudaccount permissions [OPTIONS]
Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln account permissions --org demo-cpln-organization+-------+-----------------------------------------+-------------------------------------------+|NAME |DESCRIPTION |IMPLIES ||-------|-----------------------------------------|-------------------------------------------||browse |Browse account contents |view ||create |Create new cloud accounts | ||delete |Delete existing cloud accounts | ||edit |Modify existing cloud accounts |view, browse ||manage |Full access |browse, create, delete, edit, manage, view ||view |Read-only access | |+-------+-----------------------------------------+-------------------------------------------+
Find all the cloud accounts based on the given query
Usage
copycpln cloudaccount query QUERY_OPTIONS [OPTIONS]
Query options:--match Query filter type [choices: "all", "none", "any"] [default: "all"]--property, --prop Property to query--tag Tag to query--rel Tag to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ cpln cloudaccount query --match any --prop name=demo-aws-cloud-account-get --org demo-cpln-organization
$ cpln cloudaccount query --match any --prop description="Azure Cloud Account" --org demo-cpln-organization
$ cpln cloudaccount query --match any --tag account=cloud --org demo-cpln-organization
$ cpln cloudaccount query --match any --prop description="Azure Cloud Account" --tag account=cloud --org demo-cpln-organization
Manage the tags belonging to one or more referenced cloud accounts
Usage
copycpln cloudaccount tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options:--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln cloudaccount tag demo-azure-cloud-account-tag --tag name="Demo Cloud Account" --org demo-cpln-organization
$ cpln cloudaccount tag demo-azure-cloud-account-tag --tag name="Replaced Tag" --org demo-cpln-organization
$ cpln cloudaccount tag demo-azure-cloud-account-tag --tag name= --org demo-cpln-organization
$ cpln cloudaccount tag demo-azure-cloud-account-tag demo-gcp-cloud-account-tag --tag multiple-cloudaccounts=true --org demo-cpln-organization
$ cpln cloudaccount tag demo-azure-cloud-account-tag demo-gcp-cloud-account-tag --tag multiple-cloudaccounts=demo-cloudaccount --org demo-cpln-organization
$ cpln cloudaccount tag demo-azure-cloud-account-tag demo-gcp-cloud-account-tag --tag multiple-cloudaccounts= --org demo-cpln-organization
Convert k8s files to cpln files
Usage
copycpln convert --file FILE_NAME --protocol PROTOCOL [OPTIONS]
Command options:
--file, -f File to load and use for the command. Use --file -
to enable input from stdin. [required]
--protocol Protocol to use for all container ports [choices: "http", "http2", "grpc", "tcp"]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the cpln profile update
command
--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the cpln profile update
command
Format options: --output, -o Set the output format [choices: "text", "json", "yaml"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]
Debug options: --verbose, -v Enable verbose output to stderr [boolean][default: false] --debug, -d Show all HTTP communications [boolean][default: false]
Options: --help Show help [boolean] --version Show version number [boolean]
Delete resources from files
Usage
copycpln delete --file FILE_NAME [OPTIONS]
Command options:
--file, -f File to load and use for the command. Use --file -
to enable input from stdin. [required]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the cpln profile update
command
--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the cpln profile update
command
Format options: --output, -o Set the output format [choices: "text", "json", "yaml"] --color Colorize the output [boolean][default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number][default: 50]
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]
Debug options: --verbose, -v Enable verbose output to stderr [boolean][default: false] --debug, -d Show all HTTP communications [boolean][default: false]
Options: --help Show help [boolean] --version Show version number [boolean]
Manage custom domains
For a detailed overview, please visit the domain's reference page.
copycpln domain [SUBCOMMAND]
Commands: cpln domain access-report <ref> Show the access report for the referenced domain cpln domain create Create a new domain cpln domain delete <ref...> Delete one or more referenced domains cpln domain edit <ref> Edit the referenced domain, as YAML, within an editor cpln domain eventlog <ref> Show the event log of the referenced domain [aliases: log] cpln domain get [ref...] Retrieve one or more referenced domains cpln domain patch <ref> Update the referenced domain's metadata using an input file cpln domain permissions Show the grantable permissions for a domain object type cpln domain query Find all the domains based on the given query cpln domain tag <ref...> Manage the tags belonging to one or more referenced domains
Options: --help Show help [boolean]
domain Subcommands
Show the access report for the referenced domain
Usage
copycpln domain access-report <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
The domain demo.globalvirtualcloud.com
has already been added to the demo-cpln-organization
organization
$ cpln domain access-report demo.globalvirtualcloud.com --org demo-cpln-organization
Create a new domain
Usage
copycpln domain create --name DOMAIN_NAME [OPTIONS]
Ownership of the referenced domain is required by setting a TXT DNS entry.
Please review the instructions here.
Command options:--name Fully qualified domain name (e.g., widgets.example.com) [required]--description, --desc Optional description, defaults to the name if not set--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln domain create --name demo.globalvirtualcloud.com --org demo-cpln-organizationThe ownership of the referenced domain will be validated and if successful, added to the referenced organization.
Delete one or more referenced domains
Usage
copycpln domain delete <ref...> [OPTIONS]
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln domain create --name demo.globalvirtualcloud.com --org demo-cpln-organizationThe referenced domain will be removed from the referenced organization.
The default editor can be set by using the EDITOR environment variable
Usage
copycpln domain edit <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln domain edit demo.globalvirtualcloud.com --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced domain
Usage
copycpln domain eventlog <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln domain eventlog demo.globalvirtualcloud.com --org demo-cpln-organizationThe event log for the referenced domain will be shown.
Retrieve one or more referenced domains
Usage
copycpln domain get [ref...] [OPTIONS]
An empty reference will return all domains
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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln domain get demo.globalvirtualcloud.com --org demo-cpln-organization
$ cpln domain get demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --org demo-cpln-organization
Update the referenced domain's metadata using an input file
Usage
copycpln domain patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln domain patch demo.globalvirtualcloud.com --file domain-update.jsonThe changes within the JSON file will be performed against the referenced domain.
Show the grantable permissions for a domain object type
Usage
copycpln domain permissions [OPTIONS]
Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln domain permissions --org demo-cpln-organization+-------+-----------------------------------------+----------------------------------------+|NAME |DESCRIPTION |IMPLIES ||-------|-----------------------------------------|----------------------------------------||create |Create new domain | ||delete |Delete a domain | ||edit |Modify existing domains (only tags ca... |view, use ||manage |Full access |create, delete, edit, manage, use, view ||use |Allow a principal to use this domain |view ||view |Read-only access | |+-------+-----------------------------------------+----------------------------------------+
Find all the domains based on the given query
Usage
copycpln domain query QUERY_OPTIONS [OPTIONS]
Query options:--match Query filter type [choices: "all", "none", "any"] [default: "all"]--property, --prop Property to query--tag Tag to query--rel Tag to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--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
The domain demo.globalvirtualcloud.com
has already been added to the demo-cpln-organization
organization
$ cpln domain query --match any --prop name="demo.globalvirtualcloud.com" --org demo-cpln-organization
$ cpln domain query --match any --prop description="FQDN: demo.globalvirtualcloud.com" --org demo-cpln-organization
$ cpln domain query --match any --tag demo-domain="true" --org demo-cpln-organization
$ cpln domain query --match any --prop name="demo.globalvirtualcloud.com" --tag demo-domain="true" --org demo-cpln-organization
Manage the tags belonging to one or more referenced domains
Usage
copycpln domain tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options:--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln domain tag demo.globalvirtualcloud.com --tag name="Demo Domain" --org demo-cpln-organization
$ cpln domain tag demo.globalvirtualcloud.com --tag name="Replaced Tag" --org demo-cpln-organization
$ cpln domain tag demo.globalvirtualcloud.com --tag name= --org demo-cpln-organization
$ cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --tag multiple-domains=true --org demo-cpln-organization
$ cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --tag multiple-domains=demo-domain --org demo-cpln-organization
$ cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --tag multiple-domains= --org demo-cpln-organization
Manage groups
For a detailed overview, please visit the group's reference page.
copycpln group [SUBCOMMAND]
Commands: cpln group access-report <ref> Show the access report for the referenced group cpln group add-member <ref> Add members to the referenced group cpln group clone <ref> Create a clone of the referenced group [aliases: copy] cpln group create Create a new group cpln group delete <ref...> Delete one or more referenced groups cpln group edit <ref> Edit the referenced group, as YAML, within an editor cpln group eventlog <ref> Show the event log of the referenced group [aliases: log] cpln group get [ref...] Retrieve one or more referenced groups cpln group patch <ref> Update the referenced group's metadata using an input file cpln group permissions Show the grantable permissions for a group object type cpln group query Find all the groups based on the given query cpln group remove-member <ref> Remove members from the referenced group cpln group tag <ref...> Manage the tags belonging to one or more referenced groups cpln group update <ref> Update properties of the referenced group
Options: --help Show help [boolean]
group Subcommands
Show the access report for the referenced group
Usage
copycpln group access-report <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln group access-report demo-group-ar --org demo-cpln-organization
Add members to the referenced group
Usage
copycpln group add-member <ref> --email USER_EMAIL [OPTIONS]cpln group add-member <ref> --serviceaccount SERVICE_ACCOUNT [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--email Email of user to add--serviceaccount Name of the service account to addContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln group add-member demo-group-add-member --email test-128@example.com --org demo-cpln-organization
$ cpln group add-member demo-group-add-member --serviceaccount controlplane --org demo-cpln-organization
Create a clone of the referenced group
Usage
copycpln group clone <ref> --name CLONE_NAME [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--name Set the name for the clone [required]--description Optional description, defaults to the name if not set--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln group clone demo-group-clone --name demo-group-clone-2 --org demo-cpln-organization
Create a new group
Usage
copycpln group create --name GROUP_NAME [OPTIONS]
After creating a new group, use the subcommand add-member to populate the group with users and/or service accounts.
Command options:--name Name of the new group [required]--description, --desc Optional description, defaults to the name if not set--tag Attach tags (e.g., --tag drink=water)Query spec options:--query-match Query filter type [choices: "all", "none", "any"] [default: "all"]--query-property Property to query--query-tag Tag to query--query-rel Relation to query--query-kind Kind to query [choices: "user"]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln group create --name demo-group-create --org demo-cpln-organization
Delete one or more referenced groups
Usage
copycpln group delete <ref...> [OPTIONS]
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln group delete demo-group-delete --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Edit the referenced group, as YAML, within an editor
Usage
copycpln group edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln group edit demo-group --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced group
Usage
copycpln group eventlog <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln group eventlog demo-group-eventlog --org demo-cpln-organizationThe event log for the referenced group will be shown.
Retrieve one or more referenced groups
Usage
copycpln group get [ref...] [OPTIONS]
An empty reference will return all groups
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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln group get --org demo-cpln-organization
$ cpln group get demo-group-get --org demo-cpln-organization
$ cpln group get demo-group-get demo-group-get-02 --org demo-cpln-organization
Update the referenced group's metadata using an input file
Usage
copycpln group patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln group patch demo-group --file group-update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced group.
Show the grantable permissions for a group object type
Usage
copycpln group permissions [OPTIONS]
Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln group permissions --org demo-cpln-organization+-------+-----------------------------------------+-----------------------------------+|NAME |DESCRIPTION |IMPLIES ||-------|-----------------------------------------|-----------------------------------||create |Create new groups | ||delete |Delete a group | ||edit |Modify existing groups |view ||manage |Full access |create, delete, edit, manage, view ||view |Read-only view | |+-------+-----------------------------------------+-----------------------------------+
Find all the groups based on the given query
Usage
copycpln group query QUERY_OPTIONS [OPTIONS]
Query options:--match Query filter type [choices: "all", "none", "any"] [default: "all"]--property, --prop Property to query--tag Tag to query--rel Tag to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ cpln group query --match any --prop name="demo-group-query" --org demo-cpln-organization
$ cpln group query --match any --prop description="Demo Group" --org demo-cpln-organization
$ cpln group query --match any --tag demo-group="true" --org demo-cpln-organization
$ cpln group query --match any --prop name="demo-group-query" --tag demo-group="true" --org demo-cpln-organization
Remove members from the referenced group
Usage
copycpln group remove-member <ref> --email USER_EMAIL [OPTIONS]cpln group remove-member <ref> --serviceaccount SERVICE_ACCOUNT [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--email Email of user to remove--serviceaccount Name of the service account to removeContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
The user and service account referenced in the examples below were previously added to the group
$ cpln group remove-member demo-group-remove-member --email test-128@example.com --org demo-cpln-organization
$ cpln group remove-member demo-group-remove-member --serviceaccount controlplane --org demo-cpln-organization
Manage the tags belonging to one or more referenced groups
Usage
copycpln group tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options:--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln group tag demo-group-tag --tag name="Demo Organization Group" --org demo-cpln-organization
$ cpln group tag demo-group-tag --tag name="Replaced Tag" --org demo-cpln-organization
$ cpln group tag demo-group-tag --tag name= --org demo-cpln-organization
$ cpln group tag demo-group-tag demo-group-02-tag --tag multiple-groups=true --org demo-cpln-organization
$ cpln group tag demo-group-tag demo-group-02-tag --tag multiple-group=demo-org --org demo-cpln-organization
$ cpln group tag demo-group-tag demo-group-02-tag --tag multiple-groups= --org demo-cpln-organization
Update properties of the referenced group
Usage
copycpln group update <ref> --set UPDATE_PROPERTIES [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Update Properties:--set Update the following properties (e.g., --set description="Updated Description"):description stringtags.<key> stringmemberLinks string[]Arrays can be appended to, replaced, or removed using the `+=`, `=`, or `-=` operators, respectively. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
--set
option allows the modification of the following group properties:description
tags
memberLinks
$ cpln group update demo-group-update --set description="Group With Updated Description" --org demo-cpln-organization
$ cpln group update demo-group-update --set tags.group-name="Demo Group" --org demo-cpln-organization
$ cpln group update demo-group-update --set memberLinks+="/org/demo-cpln-organization/serviceaccount/controlplane" --org demo-cpln-organization
$ cpln group update demo-group-update --set memberLinks-="/org/demo-cpln-organization/serviceaccount/controlplane" --org demo-cpln-organization
Manage global virtual clouds
For a detailed overview, please visit the gvc's reference page.
copycpln gvc [SUBCOMMAND]
Commands: cpln gvc access-report <ref> Show the access report for the referenced global virtual cloud cpln gvc add-location <ref> Add one or more locations to the referenced global virtual cloud cpln gvc clone <ref> Create a clone of the referenced global virtual cloud [aliases: copy] cpln gvc create Create a new global virtual cloud cpln gvc delete <ref...> Delete one or more referenced global virtual clouds cpln gvc delete-all-workloads <ref> Delete all workloads for the referenced global virtual cloud cpln gvc edit <ref> Edit the referenced global virtual cloud, as YAML, within an editor cpln gvc eventlog <ref> Show the event log of the referenced global virtual cloud [aliases: log] cpln gvc get [ref...] Retrieve one or more referenced global virtual clouds cpln gvc patch <ref> Update the referenced global virtual cloud's metadata using an input file cpln gvc permissions Show the grantable permissions for a global virtual cloud object type cpln gvc query Find all the global virtual clouds based on the given query cpln gvc remove-location <ref> Remove one or more locations from the referenced global virtual cloud cpln gvc tag <ref...> Manage the tags belonging to one or more referenced global virtual clouds cpln gvc update <ref> Update properties of the referenced global virtual cloud
Options: --help Show help [boolean]
gvc Subcommands
Show the access report for the referenced global virtual cloud
Usage
copycpln gvc access-report <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln gvc access-report demo-gvc-ar --org demo-cpln-organization
Add one or more locations to the referenced global virtual cloud
Usage
copycpln gvc add-location <ref...> --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--location Location to add [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--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-add', in the examples below was already created with 'aws-eu-central-1' as one of its locations.
$ cpln gvc add-location demo-gvc-add --location aws-us-west-2 --org demo-cpln-organization
$ cpln gvc add-location demo-gvc-add --location aws-us-west-2 --location gcp-us-east1 --org demo-cpln-organization
Create a clone of the referenced global virtual cloud
Usage
copycpln gvc clone <ref> --name GVC_CLONE_NAME [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--name Set the name for the clone [required]--description Optional description, defaults to the name if not set--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln gvc clone demo-gvc-c --name demo-gvc-clone --org demo-cpln-organization
Create a new global virtual cloud
Usage
copycpln gvc create --name GVC_NAME --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]
Command options:--name Name of the new global virtual cloud [required]--description, --desc Optional description, defaults to the name if not set--location One or more locations to associate with this new global virtual cloud [required]--env Environment variables in KEY=VALUE format--tag Attach tags (e.g., --tag drink=water)Query spec options:--query-match Query filter type [choices: "all", "none", "any"] [default: "all"]--query-property Property to query--query-tag Tag to query--query-rel Relation to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
name
$ cpln gvc create --name demo-gvc-create --location aws-eu-central-1 --org demo-cpln-organization
Delete one or more referenced global virtual clouds
Usage
copycpln gvc delete <ref...> [OPTIONS]
Deleting a gvc will remove all associated resources (workloads, etc.)
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln gvc delete demo-gvc-delete --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
$ cpln gvc delete demo-gvc-2-delete demo-gvc-3-delete --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Delete all workloads for the referenced global virtual cloud
Usage
copycpln gvc delete-all-workloads <ref> [OPTIONS]
Deleting all the associated workloads will remove all associated resources (containers, etc.)
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln gvc delete-all-workloads demo-gvc-delete-all --org demo-cpln-organization
Edit the referenced global virtual cloud, as YAML, within an editor
Usage
copycpln gvc edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln gvc edit demo-gvcYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced global virtual cloud
Usage
copycpln gvc eventlog <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln gvc eventlog demo-gvc-eventlog --org demo-cpln-organizationThe event log for the referenced global virtual cloud will be shown.
Retrieve one or more referenced global virtual clouds
Usage
copycpln gvc get [ref...] [OPTIONS]
An empty reference will return all global virtual clouds
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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln gvc get demo-gvc-01-get --org demo-cpln-organization
$ cpln gvc get demo-gvc-01-get demo-gvc-02-get --org demo-cpln-organization
Update the referenced global virtual cloud's metadata using an input file
Usage
copycpln gvc patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln gvc patch demo-gvc --file gvc-update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced gvc.
Show the grantable permissions for a global virtual cloud object type
Usage
copycpln gvc permissions [OPTIONS]
Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln gvc permissions --org demo-cpln-organization+-------+-----------------------------------------+-----------------------------------+|NAME |DESCRIPTION |IMPLIES ||-------|-----------------------------------------|-----------------------------------||create |Create new gvcs | ||delete |Delete existing gvcs | ||edit |Modify existing gvcs |view ||manage |Full access |create, delete, edit, manage, view ||view |Read-only access | |+-------+-----------------------------------------+-----------------------------------+
Find all the global virtual clouds based on the given query
Usage
copycpln gvc query QUERY_OPTIONS [OPTIONS]
Query options:--match Query filter type [choices: "all", "none", "any"] [default: "all"]--property, --prop Property to query--tag Tag to query--rel Tag to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ cpln gvc query --match any --prop name="demo-gvc-query" --org demo-cpln-organization
$ cpln gvc query --match any --prop description="Demo GVC" --org demo-cpln-organization
$ cpln gvc query --match any --tag demo-gvc="true" --org demo-cpln-organization
$ cpln gvc query --match any --prop name="demo-org" --tag demo-gvc="true" --org demo-cpln-organization
Remove one or more locations from the referenced global virtual cloud
Usage
copycpln gvc remove-location <ref...> --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--location Location to remove [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--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-remove', in the examples below was already created with four locations. A gvc must have at least one location.
$ cpln gvc remove-location demo-gvc-remove --location azure-eastus2 --org demo-cpln-organization
$ cpln gvc remove-location demo-gvc-remove --location aws-us-west-2 --location aws-eu-central-1 --org demo-cpln-organization
Manage the tags belonging to one or more referenced global virtual clouds
Usage
copycpln gvc tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options:--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln gvc tag demo-gvc-tag --tag name="Demo Organization GVC" --org demo-cpln-organization
$ cpln gvc tag demo-gvc-tag --tag name="Replaced Tag" --org demo-cpln-organization
$ cpln gvc tag demo-gvc-tag --tag name= --org demo-cpln-organization
$ cpln gvc tag demo-gvc-tag demo-gvc-02-tag --tag multiple-orgs=true --org demo-cpln-organization
$ cpln gvc tag demo-gvc-tag demo-gvc-02-tag --tag multiple-orgs=demo-org --org demo-cpln-organization
$ cpln gvc tag demo-gvc-tag demo-gvc-02-tag --tag multiple-orgs= --org demo-cpln-organization
Update properties of the referenced global virtual cloud
Usage
copycpln gvc update <ref> --set UPDATE_PROPERTY [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Update Properties:--set Update the following properties (e.g., --set description="Updated Description"):description stringtags.<key> stringspec.pullSecretLinks string[]spec.staticPlacement.locationLinks string[]spec.tracing.sampling numberspec.tracing.lightstep.endpoint stringspec.tracing.lightstep.credentials string[]spec.env.<name>.value stringArrays can be appended to, replaced, or removed using the `+=`, `=`, or `-=` operators, respectively. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
--set
option allows the modification of the following global virtual cloud properties:description
tags
spec.pullSecretLinks
spec.domain
spec.staticPlacement.locationLinks
$ cpln gvc update demo-gvc-update --set description="GVC With Updated Description" --org demo-cpln-organization
$ cpln gvc update demo-gvc-update --set tags.org-name="Demo Organization" --org demo-cpln-organization
Manage identities within a global virtual cloud
For a detailed overview, please visit the identity's reference page.
copycpln identity [SUBCOMMAND]
Commands: cpln identity access-report <ref> Show the access report for the referenced identity cpln identity create Create a new identity cpln identity delete <ref...> Delete one or more referenced identities cpln identity edit <ref> Edit the referenced identity, as YAML, within an editor cpln identity eventlog <ref> Show the event log of the referenced identity [aliases: log] cpln identity get [ref...] Retrieve one or more referenced identities cpln identity patch <ref> Update the referenced identity's metadata using an input file cpln identity permissions Show the grantable permissions for an identity object type cpln identity query Find all the identities based on the given query cpln identity tag <ref...> Manage the tags belonging to one or more referenced identities cpln identity update <ref> Update properties of the referenced identity
Options: --help Show help [boolean]
identity Subcommands
Show the access report for the referenced identity
Usage
copycpln identity access-report <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln identity access-report demo-identity --org demo-cpln-organization --gvc demo-cpln-gvc-identity
Create a new identity
Usage
copycpln identity create --name IDENTITY_NAME [OPTIONS]
Command options:--name Name of the new identity [required]--description, --desc Optional description, defaults to the name if not set--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln identity create --name demo-identity --desc "Sample Identity" --org demo-cpln-organization --gvc demo-cpln-gvc-identity
Delete one or more referenced identities
Usage
copycpln identity delete <ref...> [OPTIONS]
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln identity delete demo-identity --org demo-cpln-organization --gvc demo-cpln-gvcIf the delete was successful, a new command prompt will be shown.
Edit the referenced identity, as YAML, within an editor
Usage
copycpln identity edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln identity edit demo-identity --org demo-cpln-organization --gvc demo-cpln-gvcYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced identity
Usage
copycpln identity eventlog <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln identity eventlog demo-identity --org demo-cpln-organization --gvc demo-cpln-gvcThe event log for the referenced identity will be shown.
Retrieve one or more referenced identities
Usage
copycpln identity get [ref...] [OPTIONS]
An empty reference will return all identities
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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Command options:--all-gvcs Show identities from all gvcs in the org [boolean]Options:--help Show help [boolean]
$ cpln identity get --org demo-cpln-organization --gvc demo-cpln-gvc-identity
$ cpln identity get demo-identity --org demo-cpln-organization --gvc demo-cpln-gvc-identity
$ cpln identity get demo-identity demo-identity-2 --org demo-cpln-organization --gvc demo-cpln-gvc-identity
Update the referenced identity's metadata using an input file
Usage
copycpln identity patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln identity patch demo-identity --file identity-update.json --org demo-cpln-organization --gvc demo-cpln-gvcThe changes within the JSON file will be performed against the referenced identity.
Show the grantable permissions for an identity object type
Usage
copycpln identity permissions [OPTIONS]
Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln identity permissions --org demo-cpln-organization+-------+-----------------------------------------+----------------------------------------+|NAME |DESCRIPTION |IMPLIES ||-------|-----------------------------------------|----------------------------------------||create |Create new identities | ||delete |Delete existing identities | ||edit |Modify existing identities |view ||manage |Full access |create, delete, edit, manage, use, view ||use |Refer to this identity from other ent... |view ||view |Read-only access | |+-------+-----------------------------------------+----------------------------------------+
Find all the identities based on the given query
Usage
copycpln identity query QUERY_OPTIONS [OPTIONS]
Query options:--match Query filter type [choices: "all", "none", "any"] [default: "all"]--property, --prop Property to query--tag Tag to query--rel Tag to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ cpln identity query --match any --prop name=demo-identity --org demo-cpln-organization
$ cpln identity query --match any --prop description="Sample Identity" --org demo-cpln-organization
$ cpln identity query --match any --tag identity_number=2 --org demo-cpln-organization
$ cpln identity query --match any --prop description="Sample Identity" --tag identity_number=2 --org demo-cpln-organization
Manage the tags belonging to one or more referenced identities
Usage
copycpln identity tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options:--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the 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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln identity tag demo-identity --tag name="Demo Agent" --org demo-cpln-organization --gvc demo-cpln-gvc-identity
$ cpln identity tag demo-identity --tag name="Replaced Tag" --org demo-cpln-organization --gvc demo-cpln-gvc-identity
$ cpln identity tag demo-identity --tag name= --org demo-cpln-organization --gvc demo-cpln-gvc-identity
Update properties of the referenced identity
Usage
copycpln identity update [ref] --set UPDATE_PROPERTY [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Update Properties:--set Update the following properties (e.g., --set description="Updated Description"):description stringtags.<key> string [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
--set
option allows the modification of the following identity properties:description
tags
$ cpln identity update demo-identity --set description="Identity With An Updated Description" --org demo-cpln-organization --gvc demo-cpln-gvc-identity
$ cpln identity update demo-identity --set tags.identity_number=1 --org demo-cpln-organization --gvc demo-cpln-gvc-identity
Manage images and configure Docker login
For a detailed overview, please visit the image's reference page.
copycpln image [SUBCOMMAND]
Commands: cpln image access-report <ref> Show the access report for the referenced image cpln image build Build and containerize an application into an image. If using buildpacks, everything after -- will be passed down to the pack executable. cpln image copy <ref> Copy an image from one org to another. This will make sure that docker-login has been run against the source and destination org, then will pull, tag and push the image to the destination org. cpln image delete <ref...> Delete one or more referenced images cpln image docker-login Perform a Docker login to the organization's private registry cpln image edit <ref> Edit the referenced image, as YAML, within an editor cpln image get [ref...] Retrieve one or more referenced images cpln image patch <ref> Update the referenced image's metadata using an input file cpln image permissions Show the grantable permissions for an image object type cpln image query Find all the images based on the given query cpln image tag <ref...> Manage the tags belonging to one or more referenced images
Options: --help Show help [boolean]
image Subcommands
Show the access report for the referenced image
Usage
copycpln image access-report <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln image access-report demo-image:1 --org demo-cpln-organization
Build and containerize an application into an image. If using buildpacks, everything after -- will be passed down to the pack executable.
Usage
copycpln image build --name IMAGE_NAME:TAG [OPTIONS]
To push an image using this command, the Registry Credential Helper must be installed if the CLI was not installed using npm.
The option --builder
accepts any trusted buildpacks builder.
The default buildpack is heroku/buildpacks:18
.
Command options:--name, -n Name and tag for the image [required]--dockerfile Path to Dockerfile (e.g.: PATH/Dockerfile). If set, the builder option is not used--builder Buildpack package to use, for example heroku/buildpacks:20, gcr.io/buildpacks/builder:v1, paketobuildpacks/builder:base, etc. [default: "heroku/buildpacks:20"]--dir Directory containing the application [default: "."]--push Push the new image to the org's private registry [boolean] [default: false]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln image build --name demo-image:1 --push --org demo-cpln-organization -- --env CPLN_IMAGE_BUILD=trueIf the build was successful, the newly generated container image will be pushed to the referenced org's private registry.If using buildpacks, every flag after the -- is passed to the pack binary.Below are the available flags from the pack build command.Pack Build uses Cloud Native Buildpacks to create a runnable app image from source code.Pack Build requires an image name, which will be generated from the source code. Build defaults to the current directory, but you can use `--path` to specify another source code directory. Build requires a `builder`, which can either be provided directly to build using `--builder`, or can be set using the `set-default-builder` command. For more on how to use `pack build`, see: https://buildpacks.io/docs/app-developer-guide/build-an-app/.Usage:pack build <image-name> [flags]Examples:pack build test_img --path apps/test-app --builder cnbs/sample-builder:bionicFlags:-B, --builder string Builder image-b, --buildpack strings Buildpack to use. One of:a buildpack by id and version in the form of '<buildpack>@<version>',path to a buildpack directory (not supported on Windows),path/URL to a buildpack .tar or .tgz file, ora packaged buildpack image name in the form of '<hostname>/<repo>[:<tag>]'Repeat for each buildpack in order, or supply once by comma-separated list-r, --buildpack-registry string Buildpack Registry by name--cache-image string Cache build layers in remote registry. Requires --publish--clear-cache Clear image's associated cache before building-D, --default-process string Set the default process type. (default "web")-d, --descriptor string Path to the project descriptor file--docker-host string Address to docker daemon that will be exposed to the build container.If not set (or set to empty string) the standard socket location will be used.Special value 'inherit' may be used in which case DOCKER_HOST environment variable will be used.This option may set DOCKER_HOST environment variable for the build container if needed.-e, --env stringArray Build-time environment variable, in the form 'VAR=VALUE' or 'VAR'.When using latter value-less form, value will be taken from currentenvironment at the time this command is executed.This flag may be specified multiple times and will overrideindividual values defined by --env-file.Repeat for each env in order (comma-separated lists not accepted)NOTE: These are NOT available at image runtime.--env-file stringArray Build-time environment variables fileOne variable per line, of the form 'VAR=VALUE' or 'VAR'When using latter value-less form, value will be taken from currentenvironment at the time this command is executedNOTE: These are NOT available at image runtime."--gid int Override GID of user's group in the stack's build and run images. The provided value must be a positive number-h, --help Help for 'build'--lifecycle-image string Custom lifecycle image to use for analysis, restore, and export when builder is untrusted.--network string Connect detect and build containers to network-p, --path string Path to app dir or zip-formatted file (defaults to current working directory)--previous-image string Set previous image to a particular tag reference, digest reference, or (when performing a daemon build) image ID--publish Publish to registry--pull-policy string Pull policy to use. Accepted values are always, never, and if-not-present. (default "always")--run-image string Run image (defaults to default stack's run image)-t, --tag strings Additional tags to push the output image to.Tags should be in the format 'image:tag' or 'repository/image:tag'.Repeat for each tag in order, or supply once by comma-separated list--trust-builder Trust the provided builderAll lifecycle phases will be run in a single container (if supported by the lifecycle).--volume stringArray Mount host volume into the build container, in the form '<host path>:<target path>[:<options>]'.- 'host path': Name of the volume or absolute directory path to mount.- 'target path': The path where the file or directory is available in the container.- 'options' (default "ro"): An optional comma separated list of mount options.- "ro", volume contents are read-only.- "rw", volume contents are readable and writeable.- "volume-opt=<key>=<value>", can be specified more than once, takes a key-value pair consisting of the option name and its value.Repeat for each volume in order (comma-separated lists not accepted)--workspace string Location at which to mount the app dir in the build imageGlobal Flags:--no-color Disable color output-q, --quiet Show less output--timestamps Enable timestamps in output-v, --verbose Show more output
Copy an image from one org to another. This will make sure that docker-login has been run against the source and destination org, then will pull, tag and push the image to the destination org.
Usage
copycpln image copy <ref> --to-name IMAGE:TAG --to-org TARGET_ORG --to-profile TARGET_ORG_PROFILE [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--to-name Name and tag for the image--to-org Target org to copy the image to--to-profile Profile to use for accessing the "to-org" argument--cleanup Cleans up the pulled and retagged image [boolean] [default: false]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command--gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
copycpln image copy SOURCE_IMAGE:TAG --to-name TARGET_IMAGE:NEW_TAG --to-org TARGET_ORG
The profile serivce principal (user/service account) must have the proper permissions to pull/push images in the current and target org.
copycpln image copy SOURCE_IMAGE:TAG --to-name TARGET_IMAGE:NEW_TAG --to-org TARGET_ORG --to-profile TARGET_ORG_PROFILE
This command will copy an image from the current org to the target org.
The current profile service principal (user/service account) must have the proper permissions to pull images in the current org (default profile).
The referenced --to-profile service principal (user/service account) must have the proper permissions to push images to the target org.
This command allows the copying of images between different orgs using user or service account profiles.
Delete one or more referenced images
Usage
copycpln image delete <ref...> [OPTIONS]
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln image delete demo-image --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Perform a Docker login to the organization's private registry
Usage
copycpln image docker-login [OPTIONS]
Command options:--ignore-output Ignore the output of this command.Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln image docker-login --org demo-cpln-organizationIf the login was successful, the local Docker instance will have the abiltity to login to the referenced organization's private registry.
Edit the referenced image, as YAML, within an editor
Usage
copycpln image edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln image edit demo-image:1 --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Retrieve one or more referenced images
Usage
copycpln image get [ref...] [OPTIONS]
An empty reference will return all images
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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln image get --org demo-cpln-organization
$ cpln image get demo-image:1 --org demo-cpln-organization
$ cpln image get demo-image:1 demo-image:2 --org demo-cpln-organization
Update the referenced image's metadata using an input file
Usage
copycpln image patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln image patch demo-image:1 --file image-update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced image.
Show the grantable permissions for an image object type
Usage
copycpln image permissions [OPTIONS]
Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln image permissions --org demo-cpln-organization+-------+-----------------------------------------+-----------------------------------------+|NAME |DESCRIPTION |IMPLIES ||-------|-----------------------------------------|-----------------------------------------||create |Create new image. You can push if you... |pull ||delete |Delete | ||edit |Modify existing image (only tags can ... |view ||manage |Full access |create, delete, edit, manage, pull, view ||pull |Image can be pulled |view ||view |Read-only access | |+-------+-----------------------------------------+-----------------------------------------+
Find all the images based on the given query
Usage
copycpln image query QUERY_OPTIONS [OPTIONS]
Query options:--match Query filter type [choices: "all", "none", "any"] [default: "all"]--property, --prop Property to query--tag Tag to query--rel Tag to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ cpln image query --match any --prop name=demo-image:1 --org demo-cpln-organization
$ cpln image query --match any --prop tag=2 --org demo-cpln-organization
$ cpln image query --match any --tag description="Demo Image #1" --org demo-cpln-organization
$ cpln image query --match any --prop name=demo-image:1 --tag description="Demo Image #1" --org demo-cpln-organization
Manage the tags belonging to one or more referenced images
Usage
copycpln image tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options:--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln image tag demo-image:1 --tag example="Demo Image" --org demo-cpln-organization
$ cpln image tag demo-image:1 --tag example="Replaced Tag" --org demo-cpln-organization
$ cpln image tag demo-image:1 --tag example= --org demo-cpln-organization
Manage locations
For a detailed overview, please visit the location's reference page.
copycpln location [SUBCOMMAND]
Commands: cpln location access-report <ref> Show the access report for the referenced location cpln location edit <ref> Edit the referenced location, as YAML, within an editor cpln location get [ref...] Retrieve one or more referenced locations cpln location patch <ref> Update the referenced locations's metadata using an input file cpln location permissions Show the grantable permissions for a location object type cpln location query Find all the locations based on the given query cpln location tag <ref...> Manage the tags belonging to one or more referenced locations
Options: --help Show help [boolean]
location Subcommands
Show the access report for the referenced location
Usage
copycpln location access-report <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln location access-report gcp-us-east1 --org demo-cpln-organization
Edit the referenced location, as YAML, within an editor
Usage
copycpln location edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Only the enabled
(boolean) property can be edited.
$ cpln location edit gcp-us-east1 --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Retrieve one or more referenced locations
Usage
copycpln location get [ref...] [OPTIONS]
An empty reference will return all locations
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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln location get --org demo-cpln-organization
$ cpln location get gcp-us-east1 --org demo-cpln-organization
$ cpln location get gcp-us-east1 aws-us-west-2 --org demo-cpln-organization
Update the referenced locations's metadata using an input file
Usage
copycpln location patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln location patch gcp-us-east1 --file location-update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced location.
Show the grantable permissions for a location object type
Usage
copycpln location permissions [OPTIONS]
Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln location permissions --org demo-cpln-organization+-------+-----------------------------------------+--------------------------------+|NAME |DESCRIPTION |IMPLIES ||-------|-----------------------------------------|--------------------------------||create |Create new locations | ||edit |Modify existing locations |view ||manage |Full access |create, edit, manage, use, view ||use |Use this location for workload placement |view ||view |Read-only access | |+-------+-----------------------------------------+--------------------------------+
Find all the locations based on the given query
Usage
copycpln location query QUERY_OPTIONS [OPTIONS]
Query options:--match Query filter type [choices: "all", "none", "any"] [default: "all"]--property, --prop Property to query--tag Tag to query--rel Tag to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ cpln location query --match any --prop name="aws-us-west-2" --org demo-cpln-organization
$ cpln location query --match any --prop description="Azure, East US 2" --org demo-cpln-organization
$ cpln location query --match any --tag cpln/city="Frankfurt" --org demo-cpln-organization
$ cpln location query --match any --prop name="gcp-us-east1" --tag cpln/state="SC" --org demo-cpln-organization
Manage the tags belonging to one or more referenced locations
Usage
copycpln location tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options:--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln location tag aws-eu-central-1 --tag name="Demo Location" --org demo-cpln-organization
$ cpln location tag aws-eu-central-1 --tag name="Replaced Tag" --org demo-cpln-organization
$ cpln location tag aws-eu-central-1 --tag name= --org demo-cpln-organization
$ cpln location tag aws-eu-central-1 azure-eastus2 --tag multiple-locations=true --org demo-cpln-organization
$ cpln location tag aws-eu-central-1 azure-eastus2 --tag multiple-locations=demo-group --org demo-cpln-organization
$ cpln location tag aws-eu-central-1 azure-eastus2g --tag multiple-locations= --org demo-cpln-organization
Create a profile named "default" and launch a browser to begin the interactive login process
Usage
copycpln login [OPTIONS]
Options: --help Show help [boolean] --version Show version number [boolean]
$ cpln loginYour browser will be launched and redirected to the login page. After a successful login, a local profilenamed "default" will be created and the browser window can be closed. Use "Control-C" at the command prompt toexit the login command if an issues occurs.
Show logs
For a detailed overview, please visit the log's reference page.
Usage
copycpln logs <query> [OPTIONS]
The <query>
positional requires a valid LogQL string enclosed within single quotes.
Available query labels: gvc
, workload
, container
, location
, provider
, replica
, stream
Command options: --tail, -t Tail the logs [boolean] --limit Limit on number of entries to show [default: "30"] --delay-for Delay in tailing by number of seconds to accumulate logs for re-ordering [number][default: "0"] --since Lookback window [default: "1h"] --from Start looking for logs at this absolute time (inclusive) --to Stop looking for logs at this absolute time (exclusive) --output, -o Specify output mode. raw suppresses log labels and timestamp [choices: "default", "raw", "jsonl"][default: "default"] --direction Sort order of logs [choices: "forward", "backward"][default: "forward"]
Positionals: query LogQL query [required]
Context options:
--profile Override the profile. The default profile can be set using the cpln profile set-default
command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the cpln profile update
command
Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]
Debug options: --verbose, -v Enable verbose output to stderr [boolean][default: false] --debug, -d Show all HTTP communications [boolean][default: false]
Options: --help Show help [boolean] --version Show version number [boolean]
$ cpln logs '{gvc="demo-gvc-logs",workload="demo-workload-logs"}'2021-02-23T18:45:03.411Z {workload="demo-workload-logs", container="main", gvc="demo-gvc-logs", location="aws-eu-central-1", provider="aws", replica="712438d4-aee8-44aa-b7a9-c9ed62b6ea69", stream="stderr"} 2021/02/23 18:45:03 Hello world sample started.2021-02-23T18:45:06.177Z {workload="demo-workload-logs", container="main", gvc="demo-gvc-logs", location="aws-eu-central-1", provider="aws", replica="712438d4-aee8-44aa-b7a9-c9ed62b6ea69", stream="stderr"} 2021/02/23 18:45:06 Hello world received a request.
$ cpln logs '{provider="aws"}'2021-02-23T18:45:03.411Z {container="main", gvc="demo-gvc-logs", location="aws-eu-central-1", provider="aws", replica="712438d4-aee8-44aa-b7a9-c9ed62b6ea69", stream="stderr", workload="demo-workload-logs"} 2021/02/23 18:45:03 Hello world sample started.2021-02-23T18:45:06.177Z {container="main", gvc="demo-gvc-logs", location="aws-eu-central-1", provider="aws", replica="712438d4-aee8-44aa-b7a9-c9ed62b6ea69", stream="stderr", workload="demo-workload-logs"} 2021/02/23 18:45:06 Hello world received a request.
Miscellaneous helper commands
copycpln misc [SUBCOMMAND]
Commands: cpln misc install-completion Install shell completion to your local profile cpln misc uninstall-completion Uninstall shell completion from your local profile
Options: --help Show help [boolean] --version Show version number [boolean]
misc Subcommands
Install shell completion to your local profile
Usage
copycpln misc install-completion [OPTIONS]
Command options:--batch Non-interactive (batch) mode [boolean]Options:--help Show help [boolean]--version Show version number [boolean]
$ cpln misc install-completionRunning the command will prompt the user with a few questions. Once compelete, the completion functionalitywill be installed. The shell will need to be restarted.
Uninstall shell completion from your local profile
Usage
copycpln misc uninstall-completion [OPTIONS]
Options:--help Show help [boolean]--version Show version number [boolean]
$ cpln misc uninstall-completionThe completion functionality will be removed.
Manage organizations
For a detailed overview, please visit the org's reference page.
copycpln org [SUBCOMMAND]
Commands: cpln org access-report <ref> Show the access report for the referenced organization cpln org create Create a new organization cpln org edit <ref> Edit the referenced organization, as YAML, within an editor cpln org eventlog <ref> Show the event log of the referenced organization [aliases: log] cpln org get [ref...] Retrieve one or more referenced organizations cpln org patch <ref> Update the referenced organization's metadata using an input file cpln org permissions Show the grantable permissions for an organization object type cpln org query Find all the organizations based on the given query cpln org tag <ref...> Manage the tags belonging to one or more referenced organizations cpln org update <ref> Update properties of the referenced organization
Options: --help Show help [boolean]
org Subcommands
Show the access report for the referenced organization
Usage
copycpln org access-report <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variableFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln org access-report demo-cpln-organization
Create a new organization
Usage
copycpln org create --name ORG_NAME [OPTIONS]
Command options:--name Name of the new organization [required]--description, --desc Optional description, defaults to the name if not set--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variableFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
name
$ cpln org create --name demo-cpln-organizationIf successful, the new organization will be created.
Edit the referenced organization, as YAML, within an editor
Usage
copycpln org edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variableFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln org edit demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced organization
Usage
copycpln org eventlog <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variableFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln org eventlog demo-cpln-organizationThe event log for the referenced organization will be shown.
Retrieve one or more referenced organizations
Usage
copycpln org get [ref...] [OPTIONS]
An empty reference will return all organizations
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 variableFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln org get+-------------+-----------------------------------------+------------------+-----+|NAME |DESCRIPTION |LINK |TAGS ||-------------|-----------------------------------------|------------------|-----||observer-org |observer-org |/org/observer-org | |+-------------+-----------------------------------------+------------------+-----+
$ cpln org get demo-cpln-organization
Update the referenced organization's metadata using an input file
Usage
copycpln org patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variableFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln org patch demo-cpln-organization --file org-update.jsonThe changes within the JSON file will be performed against the referenced organization.
Show the grantable permissions for an organization object type
Usage
copycpln org permissions [OPTIONS]
Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variableFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln org permissions+-----------------+-----------------------------------------+-------------------------------------------------------------------------------------+|NAME |DESCRIPTION |IMPLIES ||-----------------|-----------------------------------------|-------------------------------------------------------------------------------------||edit |Modify org |view ||grafanaAdmin |Grantees are made Admin in Grafana, o... | ||manage |Full access |edit, grafanaAdmin, manage, readLogs, readMetrics, readUsage, view, viewAccessReport ||readLogs |Grantees can read logs from all workl... |view ||readMetrics |Grantees can access usage and perform... | ||readUsage |Grantees can access usage and billing... | ||view |Read-only view: every org member can ... | ||viewAccessReport |Grantees can inspect the granted acce... | |+-----------------+-----------------------------------------+-------------------------------------------------------------------------------------+
Find all the organizations based on the given query
Usage
copycpln org query QUERY_OPTIONS [OPTIONS]
Query options:--match Query filter type [choices: "all", "none", "any"] [default: "all"]--property, --prop Property to query--tag Tag to query--rel Tag to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variableFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ cpln org query --match any --prop name=demo-cpln-organization+-----+-----------------------------------------+-----+-----+|NAME |DESCRIPTION |LINK |TAGS |+-----+-----------------------------------------+-----+-----+
$ cpln org query --match any --prop description="Demo Organization"+-----+-----------------------------------------+-----+-----+|NAME |DESCRIPTION |LINK |TAGS |+-----+-----------------------------------------+-----+-----+
$ cpln org query --match any --tag type=demo+-----+-----------------------------------------+-----+-----+|NAME |DESCRIPTION |LINK |TAGS |+-----+-----------------------------------------+-----+-----+
$ cpln org query --match any --prop description="Demo Organization" --tag type=demo+-----+-----------------------------------------+-----+-----+|NAME |DESCRIPTION |LINK |TAGS |+-----+-----------------------------------------+-----+-----+
Manage the tags belonging to one or more referenced organizations
Usage
copycpln org tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options:--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variableFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln org tag demo-cpln-organization --tag name="Demo Org"
$ cpln org tag demo-cpln-organization --tag name="Replaced Tag"
$ cpln org tag demo-cpln-organization --tag name=
Update properties of the referenced organization
Usage
copycpln org update [ref] --set UPDATE_PROPERTY [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Update Properties:--set Update the following properties (e.g., --set description="Updated Description"):description stringtags.<key> string [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variableFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
--set
option allows the modification of the following organization properties:description
tags
$ cpln org update demo-cpln-organization --set description="Agent With An Updated Description"
$ cpln org update demo-cpln-organization --set tags.type="Demo Tag Updated"
Manage access policies
For a detailed overview, please visit the policy's reference page.
copycpln policy [SUBCOMMAND]
Commands: cpln policy access-report <ref> Show the access report for the referenced policy cpln policy add-binding <ref> Bind one or more permissions to the referenced policy and associate it with one or more users / service accounts / groups / identities cpln policy clone <ref> Clone a policy [aliases: copy] cpln policy create Create a new policy cpln policy delete <ref...> Delete one or more referenced policies cpln policy edit <ref> Edit the referenced policy, as YAML, within an editor cpln policy eventlog <ref> Show the event log of the referenced policy [aliases: log] cpln policy get [ref...] Retrieve one or more referenced policies cpln policy patch <ref> Update the referenced policy's metadata using an input file cpln policy permissions Show the grantable permissions for a policy object type cpln policy query Find all the policies based on the given query cpln policy remove-binding <ref> Remove the bindings of one or more permissions from the referenced policy and disassociate it from one or more users / service accounts / groups / identities cpln policy tag <ref...> Manage the tags belonging to one or more referenced policies cpln policy update <ref> Update properties of the referenced policy
Options: --help Show help [boolean]
policy Subcommands
Show the access report for the referenced policy
Usage
copycpln policy access-report <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln policy access-report demo-policy-access-report --org demo-cpln-organization
Bind one or more permissions to the referenced policy and associate it with one or more users / service accounts / groups / identities
Usage
copycpln policy add-binding <ref> --permission PERMISSION_NAME COMMAND_OPTIONS [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--email User email to add permission--serviceaccount Service account name to add permission--group Group name to add permission--identity Identity link to add permission--permission Permission to add [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
demo-policy-add-binding
and associate it with the built-in controlplane service account$ cpln policy add-binding demo-policy-add-binding --permission view --serviceaccount controlplane --org demo-cpln-organization
Clone a policy
Usage
copycpln policy clone <ref> --name NEW_POLICY_NAME [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--name Set the name for the clone [required]--description Optional description, defaults to the name if not set--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln policy clone demo-policy-original --name demo-policy-clone --org demo-cpln-organization
Create a new policy
Usage
copycpln policy create --name POLICY_NAME --target-king TARGET [OPTIONS]
Command options:--name Name of the new policy, type - to generate a valid name [required]--description, --desc Optional description, defaults to the name if not set--target-kind Select a target kind for this policy [required] [choices: "account", "agent", "auditctx", "cloudaccount", "domain", "dbcluster", "group", "gvc", "identity", "image", "location", "memcachecluster", "org", "policy", "quota", "secret", "serviceaccount", "spicedbcluster", "task", "user", "volumeset", "workload"]--all Apply policy to all instances of the kind [boolean]--resource Enumerate resource names to add to the policy--tag Attach tags (e.g., --tag drink=water)Query spec options:--query-match Query filter type [choices: "all", "none", "any"] [default: "all"]--query-property Property to query--query-tag Tag to query--query-rel Relation to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
cpln policy create --name demo-policy-create --target-kind org --all --org demo-cpln-organization
Delete one or more referenced policies
Usage
copycpln policy delete <ref...> [OPTIONS]
Deleting a policy will remove all associated resources (targets, bindings, etc.)
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln policy delete demo-policy --org demo-cpln-organizationIf the delete was successful, a new command prompt will be shown.
Edit the referenced policy, as YAML, within an editor
Usage
copycpln policy edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln profile edit demo-policy --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Show the event log of the referenced policy
Usage
copycpln policy eventlog <ref> [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln policy eventlog demo-policy-eventlog --org demo-cpln-organizationThe event log for the referenced policy will be shown.
Retrieve one or more referenced policies
Usage
copycpln policy get [ref...] [OPTIONS]
An empty reference will return all policies
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` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln policy get --org demo-cpln-organization
$ cpln policy get demo-policy-get --org demo-cpln-organization
$ cpln policy get demo-policy-get viewers-policy --org demo-cpln-organization
Update the referenced policy's metadata using an input file
Usage
copycpln policy patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option --file -
sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"}
or description: My new description
). To complete the update, press Control-D (or Control-Z if you are using Windows).
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln policy patch demo-policy --file policy-update.json --org demo-cpln-organizationThe changes within the JSON file will be performed against the referenced policy.
Show the grantable permissions for a policy object type
Usage
copycpln policy permissions [OPTIONS]
Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln policy permissions --org demo-cpln-organization+-------+-----------------------------------------+-----------------------------------+|NAME |DESCRIPTION |IMPLIES ||-------|-----------------------------------------|-----------------------------------||create |Create new policies | ||delete |Delete existing policies | ||edit |Modify existing policies |view ||manage |Full access |create, delete, edit, manage, view ||view |Read-only view | |+-------+-----------------------------------------+-----------------------------------+
Find all the policies based on the given query
Usage
copycpln policy query QUERY_OPTIONS [OPTIONS]
Query options:--match Query filter type [choices: "all", "none", "any"] [default: "all"]--property, --prop Property to query--tag Tag to query--rel Tag to queryContext options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
Use the --match
option to display all, none, or any of the results based on a given property or tag
$ cpln policy query --match any --prop name="demo-policy-query" --org demo-cpln-organization
$ cpln policy query --match any --prop targetKind="org" --org demo-cpln-organization
$ cpln policy query --match any --tag demo-policy-type="true" --org demo-cpln-organization
$ cpln policy query --match any --prop name="demo-policy-query" --tag demo-policy-type="true" --org demo-cpln-organization
Remove the bindings of one or more permissions from the referenced policy and disassociate it from one or more users / service accounts / groups / identities
Usage
copycpln policy remove-permission <ref> --permission PERMISSION_NAME COMMAND_OPTIONS [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Command options:--email User email to remove permission--serviceaccount Service account name to remove permission--group Group name to remove permission--identity Identity link to remove permission--permission Permission to remove [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
demo-policy-remove-binding
and disassociate it with the built-in controlplane service account$ cpln policy remove-binding demo-policy-remove-binding --permission view --serviceaccount controlplane --org demo-cpln-organization
Manage the tags belonging to one or more referenced policies
Usage
copycpln policy tag <ref...> --tag key=value [OPTIONS]
Built-in tags, which begin with cpln/*, can't be modified.
Positionals:ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options:--tag Attach tags (e.g., --tag drink=water)Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
$ cpln policy tag demo-policy-tag --tag name="Demo Organization Policy" --org demo-cpln-organization
$ cpln policy tag demo-policy-tag --tag name="Replaced Tag" --org demo-cpln-organization
$ cpln policy tag demo-policy-tag --tag name= --org demo-cpln-organization
$ cpln policy tag demo-policy-tag demo-policy-tag-02 --tag multiple-policies=true --org demo-cpln-organization
$ cpln policy tag demo-policy-tag demo-policy-tag-02 --tag multiple-policies=demo-policy --org demo-cpln-organization
$ cpln policy tag demo-policy-tag demo-policy-tag-02 --tag multiple-policies= --org demo-cpln-organization
Update properties of the referenced policy
Usage
copycpln policy update [ref] --set UPDATE_PROPERTY [OPTIONS]
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Update Properties:--set Update the following properties (e.g., --set description="Updated Description"):description stringtags.<key> stringtargetLinks string[]target { 'all' }Arrays can be appended to, replaced, or removed using the `+=`, `=`, or `-=` operators, respectively. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--help Show help [boolean]
--set
option allows the modification of the following policy properties:description
tags
targetLinks
target
$ cpln policy update demo-policy-update --set description="Policy With Updated Description" --org demo-cpln-organization
$ cpln policy update demo-policy-update --set tags.policy-name="Demo Policy" --org demo-cpln-organization
$ cpln policy update demo-policy-update --set targetLinks+="/org/demo-cpln-organization/gvc/demo-gvc-policy" --org demo-cpln-organization
$ cpln policy update demo-policy-update --set targetLinks-="/org/demo-cpln-organization/gvc/demo-gvc-policy" --org demo-cpln-organization
$ cpln policy update demo-policy-update --set target=all --org demo-cpln-organization
Manage local profiles
For a detailed overview, please visit the manage CLI profiles guide.
copycpln profile [SUBCOMMAND]
Commands: cpln profile delete <profiles...> Delete one or more referenced profiles cpln profile get [profiles...] Retrieve one or more profiles cpln profile login Create a profile named "default" and launch a browser to begin the interactive login process cpln profile set-default <profile> Set the referenced profile as the default cpln profile token [profile] Show the JWT token of the referenced profile cpln profile update <profile> Manage the referenced profile [aliases: create]
Options: --version Show version number [boolean] --help Show help [boolean]
profile Subcommands
Delete one or more referenced profiles
Usage
copycpln profile delete <profiles...> [OPTIONS]
Positionals:profile One or more profile names to deleteFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--version Show version number [boolean]--help Show help [boolean]
$ cpln profile delete defaultA table showing the profile details will return if the delete was successful. Otherwise, an empty table will be displayed.
$ cpln profile delete demo-profile@example.com defaultA table showing the profile details will return if the delete was successful. Otherwise, an empty table will be displayed.
Retrieve one or more profiles
Usage
copycpln profile get [profiles...] [OPTIONS]
An empty reference will return all profiles
Positionals:profiles One or more profiles to show [array] [default: []]Format options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--version Show version number [boolean]--help Show help [boolean]
$ cpln profile get default+--------+-----------------------+--------+--------------------+----------------+------------+-------+-----------+|PROFILE |EMAIL |DEFAULT |ENDPOINT |ORG |GVC |OUTPUT |TIMESTAMPS ||--------|-----------------------|--------|--------------------|----------------|------------|-------|-----------||default |majid@controlplane.com | |https://api.cpln.io |majid-abu-rmila |default-gvc |text |age |+--------+-----------------------+--------+--------------------+----------------+------------+-------+-----------+
Create a profile named "default" and launch a browser to begin the interactive login process
Usage
copycpln profile login [OPTIONS]
Options:--version Show version number [boolean]--help Show help [boolean]
$ cpln profile loginA new browser will open displaying the Control Plane login page.If the login was successful, the browser will indicate that it can be closed. The CLI will display the login results. PressControl-C to exit the CLI login.If the login failed, the browser and be closed and the CLI will return to the command prompt. Run `cpln profile login` again torestart the login.
Set the referenced profile as the default
Usage
copycpln profile set-default <profile> [OPTIONS]
Positionals:profile Profile name to be set as the default [required]Options:--version Show version number [boolean]--help Show help [boolean]
$ cpln profile set-default demo-profileThe referenced profile will be set as the default for all future executions of the CLI commands.If the set was successful, the command prompt will return. Otherwise, the error will be shown.
Show the JWT token of the referenced profile
Usage
copycpln profile token [profile] [OPTIONS]
An empty reference will return the token for the default profile
Positionals:profile Profile to retrieve the token forFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--version Show version number [boolean]--help Show help [boolean]
$ cpln profile token demo-profileA valid JWT token for the referenced profile will be shown.
Manage the referenced profile
Usage
copycpln profile update <profile> COMMAND_OPTIONS [OPTIONS]
Positionals:profile Name of the profile to update. If it does not exist, a new profile with that name will be created [required]Command options:--login Launch a browser to begin the interactive login process using the referenced profile--default Set the given profile as the default--org Set the given organization as the default organization of the referenced profile--gvc Set the given GVC as the default GVC of the referenced profileFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--verbose, -v Enable verbose output to stderr [boolean] [default: false]--debug, -d Show all HTTP communications [boolean] [default: false]Options:--version Show version number [boolean]--help Show help [boolean]
$ cpln profile update new-profileIf the referenced profile name doesn't exist, a new one will be created.
$ cpln profile update new-profile --loginA browser will open displaying the Control Plane login page.If the login was successful, a new profile with the given name will be created(if it doesn't already exist) and the browser will indicate that it can be closed.This profile will be marked as the default and used by any future CLI command.The CLI will display the login results. Press Control-C to exit the CLI login.If the login failed, the CLI will return to the command prompt.Run the command again to restart the login flow.
$ cpln profile update new-profile --defaultIf the update was successful, the referenced profile will be set as the default for all future cpln commands.
$ cpln profile update new-profile --org demo-cpln-organization --gvc demo-cpln-gvcThe referenced organization and GVC will be set as the default on the referenced profile.Any future execution of a cpln command will use those values.
Show quotas
For a detailed overview, please visit the quota's reference page.
copycpln quota [SUBCOMMAND]
Commands: cpln quota edit <ref> Edit the referenced quota, as YAML, within an editor cpln quota get [ref...] Retrieve one or more referenced quotas cpln quota patch <ref> Update the referenced quota's metadata using an input file cpln quota permissions Show the grantable permissions for a quota object type cpln quota query Find all the quotas based on the given query
Options: --help Show help [boolean]
quota Subcommands
Edit the referenced quota, as YAML, within an editor
Usage
copycpln quota edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable
Positionals:ref The resource reference. Usually it is the name of the resource. [required]Context options:--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` commandFormat options:--output, -o Set the output format [choices: "text", "json", "yaml"]--color Colorize the output [boolean] [default: true]--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options:--token Override the authorization token--endpoint Override the API URL--insecure, -k Ignore TLS errors [boolean]Debug options:--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 ID GUID of the quota obtained from running cpln quota get
$ cpln quota edit b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --org demo-cpln-organizationYour default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
Retrieve one or more referenced quotas
Usage
copycpln quota get [ref...] [OPTIONS]
An empty reference will return all quotas
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` commandFormat options: