Command Line Interface

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln agent access-report demo-agent-access-report --org demo-cpln-organization

Command options:
  --name                 Name of the agent  [required]
  --description, --desc  Optional description, defaults to the name if not set
  --tag                  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln agent create --name demo-agent-create --org demo-cpln-organization

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [default: []]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Get all agents

$ cpln agent get --org demo-cpln-organization

• Get one agent

$ cpln agent get demo-agent-get-1 --org demo-cpln-organization

• Get multiple agents

$ cpln agent get demo-agent-get-1 demo-agent-get-2 --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Return the details of a deployed agent. The example below was for an agent deployed at AWS.

$ cpln agent info demo-agent-aws --org demo-cpln-organization
{
  "env": {
    "cpuPlatform": "x86_64",
    "image": "ami-0fff5e2863a768052",
    "id": "i-01adfe256a82a2a76",
    "machineType": "t2.micro",
    "zone": "us-west-2c",
    "internalIP": "172.31.13.246",
    "hostname": "ip-172-31-13-246.us-west-2.compute.internal",
    "vpc": "vpc-29e3c451",
    "subnet": "subnet-b11e9dec",
    "accountId": "015716931765",
    "cloudProvider": "aws"
  },
  "lastActive": "2021-05-01T00:26:55.945Z",
  "serviceCount": 0,
  "peerCount": 0
}

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]

Common Options Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Command options:
  --file, -f  File to load the patch from. Use `--file -` to enable input from stdin.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

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

Common Options Reference

$ 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                         |                                        |
+-------+-----------------------------------------+----------------------------------------+

Query options:
  --match             Query filter type  [choices: "all", "none", "any"] [default: "all"]
  --property, --prop  Property to query
  --tag               Tag to query
  --rel               Tag to query
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Search for an agent based on the name property

$ cpln agent query --match any --prop name=demo-agent-query --org demo-cpln-organization

• Search for an agent based on the description property

$ cpln agent query --match any --prop description="Sample Agent" --org demo-cpln-organization

• Search for a agent based on a tag

$ cpln agent query --match any --tag agent=demo --org demo-cpln-organization

• Search for a agent based on a property and tag

$ cpln agent query --match any --prop description="Sample Agent" --tag agent=demo --org demo-cpln-organization

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]
Command options:
  --tag  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Add a tag to a agent

$ cpln agent tag demo-agent-tag --tag name="Demo Agent" --org demo-cpln-organization

• Update same tag (after running the example above)

$ cpln agent tag demo-agent-tag --tag name="Replaced Tag" --org demo-cpln-organization

• Remove tag (after running the example above)

$ cpln agent tag demo-agent-tag --tag name= --org demo-cpln-organization

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

Common Options Reference

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

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Update Properties:
  --set  Update the following properties (e.g., --set description="Updated Description"):
         description    string
         tags.<key>     string  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• The --set option allows the modification of the following agent properties:
  • description
    • Description of the agent
    • Type: string
  • tags
    • Tags (key=value) associated with the agent
    • Type: string

• For the examples below, the initial agent is configured as:

• Update an agent's description

$ cpln agent update demo-agent-update --set description="Agent With An Updated Description" --org demo-cpln-organization

• Update an agent's tag

$ cpln agent update demo-agent-update --set tags.agent-name=demo --org demo-cpln-organization

Common Options Reference

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

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln auditctx access-report demo-audit-context --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Command options:
  --name         Set the name for the clone  [required]
  --description  Optional description, defaults to the name if not set
  --tag          Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ 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 │     │
└─────────────────────────┴─────────────────────────────────────────┴────────┴─────┘

Command options:
  --name                 Name of the new audit context  [required]
  --description, --desc  Optional description, defaults to the name if not set
  --tag                  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln auditctx create --name demo-audit-context --org demo-cpln-organization
┌───────────────────┬─────────────────────────────────────────┬────────┬─────┐
│NAME               │DESCRIPTION                              │ORIGIN  │TAGS │
├───────────────────┼─────────────────────────────────────────┼────────┼─────┤
│demo-audit-context │demo-audit-context                       │default │     │
└───────────────────┴─────────────────────────────────────────┴────────┴─────┘

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln auditctx eventlog demo-auditctx --org demo-cpln-organization
The event log for the referenced audit context will be shown.

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [default: []]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Get all audit contexts

$ cpln auditctx get --org demo-cpln-organization

• Get one audit context

$ cpln auditctx get demo-audit-context --org demo-cpln-organization

• Get multiple audit contexts

$ cpln auditctx get demo-audit-context cpln --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Command options:
  --file, -f  File to load the patch from. Use `--file -` to enable input from stdin.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

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

Common Options Reference

$ 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                                              |
+-----------+-----------------------------------------+--------------------------------------------------+

Query options:
  --match             Query filter type  [choices: "all", "none", "any"] [default: "all"]
  --property, --prop  Property to query
  --tag               Tag to query
  --rel               Tag to query
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Search for an audit context based on the name property

$ cpln auditctx query --match any --prop name=demo-audit-context --org demo-cpln-organization

• Search for audit contexts based on the description property

$ cpln auditctx query --match any --prop description="Clone of demo-audit-context" --org demo-cpln-organization

• Search for audit contexts based on a tag

$ cpln auditctx query --match any --tag type=demo --org demo-cpln-organization

• Search for audit contexts based on a property and tag

$ cpln auditctx query --match any --prop description="Audit of your CPLN org" --tag type=demo --org demo-cpln-organization

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]
Command options:
  --tag  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Add a tag to a audit context

$ cpln auditctx tag demo-audit-context --tag name="Demo Audit Context" --org demo-cpln-organization

• Update same tag (after running the example above)

$ cpln auditctx tag demo-audit-context --tag name="Replaced Tag" --org demo-cpln-organization

• Remove tag (after running the example above)

$ cpln auditctx tag demo-audit-context --tag name= --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Update Properties:
  --set  Update the following properties (e.g., --set description="Updated Description"):
         description    string
         tags.<key>     string  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• The --set option allows the modification of the following audit context properties:
  • description
    • Description of the audit context
    • Type: string
  • tags
    • Tags (key=value) associated with the audit context
    • Type: string

• For the examples below, the initial audit context is configured as:

• Update an audit context's description

$ cpln auditctx update demo-audit-context --set description="Audit Text With An Updated Description" --org demo-cpln-organization

• Update an audit context's tag

$ cpln auditctx update demo-audit-context --set tags.type=updated --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln cloudaccount access-report demo-aws-cloud-account-access-report --org demo-cpln-organization

Command options:
  --name                 Name of the new account
  --description, --desc  Optional description, defaults to the name if not set
  --role-arn             ARN of the role used by Control Plane to manage the account, in format `arn:aws:iam::<account number>:role/<name>`
  --how                  Show the steps on how to create and configure your AWS account  [boolean]
  --tag                  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln cloudaccount create-aws --name demo-aws-cloud-account --role-arn arn:aws:iam::123412341234:role/cpln-demo-cpln-organization --org demo-cpln-organization

Command options:
  --name                 Name of the new account
  --description, --desc  Optional description, defaults to the name if not set
  --secret               The name of the secret which will be created.
  --url                  The URL of the deployed function app.
  --code                 The URL of the deployed function app.
  --how                  Show the steps on how to create and configure your Azure subscription  [boolean]
  --tag                  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln cloudaccount create-azure --name demo-azure-cloud-account --secret azure-secret --url https://function.app.url --code code --org demo-cpln-organization

Command options:
  --name                 Name of the new account
  --description, --desc  Optional description, defaults to the name if not set
  --project-id           The ID of the project that Control Plane will manage
  --how                  Show the steps on how to create and configure your GCP project  [boolean]
  --tag                  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln cloudaccount create-gcp --name demo-gcp-cloud-account --project-id 1234abc --org demo-cpln-organization

Command options:
  --name                 Name of the new account  [required]
  --description, --desc  Optional description, defaults to the name if not set
  --secret               The secret used to authenticate to NGS  [required]
  --tag                  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Delete a cloud account

$ cpln cloudaccount demo-gcp-cloud-account --org demo-organization
If the delete was successful, a new command prompt will be shown.

• Delete multiple cloud accounts

$ cpln cloudaccount demo-gcp-cloud-account demo-azure-cloud-account --org demo-organization
If the delete was successful, a new command prompt will be shown.

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln cloudacccount eventlog demo-azure-cloud-account --org demo-cpln-organization
The event log for the referenced cloud acccount will be shown.

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [default: []]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Get all cloud accounts

$ cpln cloudaccount get --org demo-cpln-organization

• Get one cloud account

$ cpln cloudaccount get demo-aws-cloud-account-get --org demo-cpln-organization

• Get multiple cloud accounts

$ cpln cloudaccount get demo-azure-cloud-account-get demo-gcp-cloud-account-get --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Command options:
  --file, -f  File to load the patch from. Use `--file -` to enable input from stdin.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln cloudaccount patch demo-gcp-cloud-account --file cloud-account-update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced cloud account.

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

Common Options Reference

$ 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                         |                                           |
+-------+-----------------------------------------+-------------------------------------------+

Query options:
  --match             Query filter type  [choices: "all", "none", "any"] [default: "all"]
  --property, --prop  Property to query
  --tag               Tag to query
  --rel               Tag to query
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Search for an cloud account based on the name property

$ cpln cloudaccount query --match any --prop name=demo-aws-cloud-account-get --org demo-cpln-organization

• Search for an cloud account based on the description property

$ cpln cloudaccount query --match any --prop description="Azure Cloud Account" --org demo-cpln-organization

• Search for a cloud account based on a tag

$ cpln cloudaccount query --match any --tag account=cloud --org demo-cpln-organization

• Search for a cloud account based on a property and tag

$ cpln cloudaccount query --match any --prop description="Azure Cloud Account" --tag account=cloud --org demo-cpln-organization

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]
Command options:
  --tag  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Add a tag to a cloud account

$ cpln cloudaccount tag demo-azure-cloud-account-tag --tag name="Demo Cloud Account" --org demo-cpln-organization

• Update same tag (after running the example above)

$ cpln cloudaccount tag demo-azure-cloud-account-tag --tag name="Replaced Tag" --org demo-cpln-organization

• Remove tag (after running the example above)

$ cpln cloudaccount tag demo-azure-cloud-account-tag --tag name= --org demo-cpln-organization

• Add same tag to multiple cloud accounts

$ cpln cloudaccount tag demo-azure-cloud-account-tag demo-gcp-cloud-account-tag --tag multiple-cloudaccounts=true --org demo-cpln-organization

• Update same tag on multiple cloud accounts (after running the example above)

$ cpln cloudaccount tag demo-azure-cloud-account-tag demo-gcp-cloud-account-tag --tag multiple-cloudaccounts=demo-cloudaccount --org demo-cpln-organization

• Remove same tag from multiple cloud accounts (after running the example above)

$ cpln cloudaccount tag demo-azure-cloud-account-tag demo-gcp-cloud-account-tag --tag multiple-cloudaccounts= --org demo-cpln-organization

Common Options Reference

Common Options Reference

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln domain access-report demo.globalvirtualcloud.com --org demo-cpln-organization

Command options:
  --name                 Fully qualified domain name (e.g., widgets.example.com)  [required]
  --description, --desc  Optional description, defaults to the name if not set
  --tag                  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln domain create --name demo.globalvirtualcloud.com --org demo-cpln-organization
The ownership of the referenced domain will be validated and if successful, added to the referenced organization.

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln domain eventlog demo.globalvirtualcloud.com --org demo-cpln-organization
The event log for the referenced domain will be shown.

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [default: []]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Show a domain

$ cpln domain get demo.globalvirtualcloud.com --org demo-cpln-organization

• Show multiple domains

$ cpln domain get demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Command options:
  --file, -f  File to load the patch from. Use `--file -` to enable input from stdin.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln domain patch demo.globalvirtualcloud.com --file domain-update.json
The changes within the JSON file will be performed against the referenced domain.

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

Common Options Reference

$ 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                         |                                        |
+-------+-----------------------------------------+----------------------------------------+

Query options:
  --match             Query filter type  [choices: "all", "none", "any"] [default: "all"]
  --property, --prop  Property to query
  --tag               Tag to query
  --rel               Tag to query
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Search for an domain based on the name property

$ cpln domain query --match any --prop name="demo.globalvirtualcloud.com" --org demo-cpln-organization

• Search for an domain based on the description property

$ cpln domain query --match any --prop description="FQDN: demo.globalvirtualcloud.com" --org demo-cpln-organization

• Search for an domain based on a tag

$ cpln domain query --match any --tag demo-domain="true" --org demo-cpln-organization

• Search for an domain based on a property and tag

$ cpln domain query --match any --prop name="demo.globalvirtualcloud.com" --tag demo-domain="true" --org demo-cpln-organization

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]
Command options:
  --tag  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Add a tag to a domain

$ cpln domain tag demo.globalvirtualcloud.com --tag name="Demo Domain" --org demo-cpln-organization

• Update same tag (after running the example above)

$ cpln domain tag demo.globalvirtualcloud.com --tag name="Replaced Tag" --org demo-cpln-organization

• Remove tag (after running the example above)

$ cpln domain tag demo.globalvirtualcloud.com --tag name= --org demo-cpln-organization

• Add same tag to multiple domain

$ cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --tag multiple-domains=true --org demo-cpln-organization

• Update same tag on multiple domain (after running the example above)

$ cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --tag multiple-domains=demo-domain --org demo-cpln-organization

• Remove same tag from multiple domain (after running the example above)

$ cpln domain tag demo.globalvirtualcloud.com demo2.globalvirtualcloud.com --tag multiple-domains= --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln group access-report demo-group-ar --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Command options:
  --email           Email of user to add
  --serviceaccount  Name of the service account to add
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Add a user to a group

$ cpln group add-member demo-group-add-member --email test-128@example.com --org demo-cpln-organization

• Add a service account to a group using email

$ cpln group add-member demo-group-add-member --serviceaccount controlplane --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Command options:
  --name         Set the name for the clone  [required]
  --description  Optional description, defaults to the name if not set
  --tag          Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln group clone demo-group-clone --name demo-group-clone-2 --org demo-cpln-organization

Command options:
  --name                 Name of the new group  [required]
  --description, --desc  Optional description, defaults to the name if not set
  --tag                  Attach tags (e.g., --tag drink=water)
Query spec options:
  --query-match     Query filter type  [choices: "all", "none", "any"] [default: "all"]
  --query-property  Property to query
  --query-tag       Tag to query
  --query-rel       Relation to query
  --query-kind      Kind to query  [choices: "user"]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

$ cpln group create --name demo-group-create --org demo-cpln-organization

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [default: []]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Get all groups

$ cpln group get --org demo-cpln-organization

• Get one group

$ cpln group get demo-group-get --org demo-cpln-organization

• Get multiple groups

$ cpln group get demo-group-get demo-group-get-02 --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Command options:
  --file, -f  File to load the patch from. Use `--file -` to enable input from stdin.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

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

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

Common Options Reference

$ 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                           |                                   |
+-------+-----------------------------------------+-----------------------------------+

Query options:
  --match             Query filter type  [choices: "all", "none", "any"] [default: "all"]
  --property, --prop  Property to query
  --tag               Tag to query
  --rel               Tag to query
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Search for a group based on a name

$ cpln group query --match any --prop name="demo-group-query" --org demo-cpln-organization

• Search for a group based on a description

$ cpln group query --match any --prop description="Demo Group" --org demo-cpln-organization

• Search for a group based on a tag

$ cpln group query --match any --tag demo-group="true" --org demo-cpln-organization

• Search for a group based on a property and tag

$ cpln group query --match any --prop name="demo-group-query" --tag demo-group="true" --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Command options:
  --email           Email of user to remove
  --serviceaccount  Name of the service account to remove
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Remove a user to a group

$ cpln group remove-member demo-group-remove-member --email test-128@example.com --org demo-cpln-organization

• Remove a service account to a group using email

$ cpln group remove-member demo-group-remove-member --serviceaccount controlplane --org demo-cpln-organization

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]
Command options:
  --tag  Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Add a tag to a group

$ cpln group tag demo-group-tag --tag name="Demo Organization Group" --org demo-cpln-organization

• Update same tag (after running the example above)

$ cpln group tag demo-group-tag --tag name="Replaced Tag" --org demo-cpln-organization

• Remove tag (after running the example above)

$ cpln group tag demo-group-tag --tag name= --org demo-cpln-organization

• Add same tag to multiple groups

$ cpln group tag demo-group-tag demo-group-02-tag --tag multiple-groups=true --org demo-cpln-organization

• Update same tag on multiple groups (after running the example above)

$ cpln group tag demo-group-tag demo-group-02-tag --tag multiple-group=demo-org --org demo-cpln-organization

• Remove same tag from multiple groups (after running the example above)

$ cpln group tag demo-group-tag demo-group-02-tag --tag multiple-groups= --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Update Properties:
  --set  Update the following properties (e.g., --set description="Updated Description"):
         description    string
         tags.<key>     string
         memberLinks    string[]
         Arrays can be appended to, replaced, or removed using the `+=`, `=`, or `-=` operators, respectively.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• The --set option allows the modification of the following group properties:
  • description
    • Description of the group
    • Type: string
  • tags
    • Tags (key=value) associated with the group
    • Type: string
  • memberLinks
    • Array of links belonging to members of the group
    • Type: string[]

• For the examples below, the initial group is configured as:

• Update an group's description

$ cpln group update demo-group-update --set description="Group With Updated Description" --org demo-cpln-organization

• Update an group's tags

$ cpln group update demo-group-update --set tags.group-name="Demo Group" --org demo-cpln-organization

• Add to a group's member links. This examples adds the built-in controlplane service account

$ cpln group update demo-group-update --set memberLinks+="/org/demo-cpln-organization/serviceaccount/controlplane" --org demo-cpln-organization

• Remove from a group's member links. This examples removes the built-in controlplane service account

$ cpln group update demo-group-update --set memberLinks-="/org/demo-cpln-organization/serviceaccount/controlplane" --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Display the user / service account / group permissions for the 'demo-gvc-ar' global virtual cloud within the 'demo-cpln-organization' organization

$ cpln gvc access-report demo-gvc-ar --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Command options:
  --location  Location to add  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Add one location to a global virtual cloud

$ cpln gvc add-location demo-gvc-add --location aws-us-west-2 --org demo-cpln-organization

• Add multiple locations to a global virtual cloud

$ cpln gvc add-location demo-gvc-add --location aws-us-west-2 --location gcp-us-east1 --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Command options:
  --name         Set the name for the clone  [required]
  --description  Optional description, defaults to the name if not set
  --tag          Attach tags (e.g., --tag drink=water)
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Create a clone of an existing gvc

$ cpln gvc clone demo-gvc-c --name demo-gvc-clone --org demo-cpln-organization

Command options:
  --name                 Name of the new global virtual cloud  [required]
  --description, --desc  Optional description, defaults to the name if not set
  --location             One or more locations to associate with this new global virtual cloud  [required]
  --env                  Environment variables in KEY=VALUE format
  --tag                  Attach tags (e.g., --tag drink=water)
Query spec options:
  --query-match     Query filter type  [choices: "all", "none", "any"] [default: "all"]
  --query-property  Property to query
  --query-tag       Tag to query
  --query-rel       Relation to query
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• name
  • Minimum Length: 3
  • Maximum Length: 64
  • Only lowercase characters
  • Must begin with a character
  • Allowed special characters: -

• Create an new GVC with a single location

$ cpln gvc create --name demo-gvc-create --location aws-eu-central-1 --org demo-cpln-organization

Positionals:
  ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Delete a gvc

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

• Delete multiple gvcs

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

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]

Common Options Reference

• Delete all workloads

$ cpln gvc delete-all-workloads demo-gvc-delete-all --org demo-cpln-organization

Positionals:
  ref  The resource reference. Usually it is the name of the resource.  [required]
Context options:
  --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
  --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]
Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]
Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]
Options:
  --help  Show help  [boolean]