cpln location [SUBCOMMAND]
Commands:
cpln location access-report <ref> Show the access report for the referenced location
cpln location audit [ref] Retrieve audit trail events for the referenced location
cpln location create Create a new BYOK location
cpln location delete <ref...> Delete one or more referenced locations
cpln location edit <ref> Edit the referenced location, as YAML, within an editor
cpln location get [ref...] Retrieve one or more referenced locations
cpln location install <ref> Get instructions for obtaining the installation script for a BYOK location
cpln location patch <ref> Update the referenced location's metadata using an input file
cpln location permissions Show the grantable permissions for a location object type
cpln location query Find all the locations based on the given query
cpln location tag <ref...> Manage the tags belonging to one or more referenced locations
cpln location uninstall <ref> Get instructions for obtaining the uninstallation script for a BYOK location
Options:
--help Show help [boolean]
location access-report
Show the access report for the referenced location Usagecpln location access-report <ref> [OPTIONS]
Reference
Reference
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
cpln location access-report aws-eu-central-1 --org demo-cpln-organization
+-----------+--------------------------------------------------------+--------+
|PERMISSION |PRINCIPAL |GRANTED |
|-----------|--------------------------------------------------------|--------|
|create |/org/demo-cpln-organization/group/superusers |manage |
|create |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|delete |/org/demo-cpln-organization/group/superusers |manage |
|delete |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|edit |/org/demo-cpln-organization/group/superusers |manage |
|edit |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|manage |/org/demo-cpln-organization/group/superusers |manage |
|manage |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|use |/org/demo-cpln-organization/group/superusers |manage |
|use |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
|view |/org/demo-cpln-organization/group/viewers |view |
|view |/org/demo-cpln-organization/group/superusers |manage |
|view |/org/demo-cpln-organization/serviceaccount/controlplane |manage |
+-----------+--------------------------------------------------------+--------+
location audit
Retrieve audit trail events for the referenced location Usagecpln location audit [ref] [OPTIONS]
Reference
Reference
Positionals:
ref The resource reference. Usually it is the name of the resource.
Command options:
--subject Filter by subject (serviceaccount name or user email) [string]
--context Audit context name (the 'cpln' context displays Control Plane actions) [string] [default: "cpln"]
--since Relative lookback window from now (e.g., 1h, 24h, 7d). Mutually exclusive with --from/--to [string] [default: "7d"]
--from Start time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 7d, 1h). Cannot be used with --since [string]
--to End time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 1d, 30m) [string]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
location create
Create a new BYOK location Usagecpln location create --name NAME [OPTIONS]
Reference
Reference
Command options:
--name Name of the new BYOK location [required]
--description, --desc Optional description, defaults to the name if not set
--tag Attach tags (e.g., --tag drink=water)
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
- Create a new BYOK location.
cpln location create --name demo-byok-location --org demo-cpln-organization
+-------------------+-------------------+---------+--------+-------------------+-------+-----+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-------------------|-------------------|---------|--------|-------------------|-------|-----|
|demo-byok-location |demo-byok-location |byok |true |demo-byok-location |custom | |
+-------------------+-------------------+---------+--------+-------------------+-------+-----+
location delete
Delete one or more referenced locations Usagecpln location delete <ref...> [OPTIONS]
Reference
Reference
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
- Delete a BYOK location.
cpln location delete demo-byok-location-tbd --org demo-cpln-organization
If the delete was successful, a new command prompt will be shown.
location edit
Edit the referenced location, as YAML, within an editor Usagecpln location edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Reference
Reference
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Command options:
--replace, -r Replace instead of patch/merge [boolean] [default: false]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
cpln location edit aws-eu-central-1 --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.
location get
Retrieve one or more referenced locations Usagecpln location get [ref...] [OPTIONS]
An empty reference will return all references
Reference
Reference
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [default: []]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
- Get all locations
cpln location get --org demo-cpln-organization
+----------------------------+----------------------------------------+---------+--------+------------------------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|----------------------------|----------------------------------------|---------|--------|------------------------|--------|-------------------------------|
|aws-ap-northeast-1 |AWS, Asia Pacific (Tokyo) |aws |true |ap-northeast-1 |builtin |cpln/city="Tokyo" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="Japan" |
|aws-ap-northeast-2 |AWS, Asia Pacific (Seoul) |aws |true |ap-northeast-2 |builtin |cpln/city="Seoul" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="South Korea" |
|aws-ap-northeast-3 |AWS, Asia Pacific (Osaka) |aws |true |ap-northeast-3 |builtin |cpln/city="Osaka" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="Japan" |
|aws-ap-south-1 |AWS, Asia Pacific (Mumbai) |aws |true |ap-south-1 |builtin |cpln/city="Mumbai" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="India" |
|aws-ap-southeast-1 |AWS, Asia Pacific (Singapore) |aws |true |ap-southeast-1 |builtin |cpln/city="Singapore" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="Singapore" |
|aws-ap-southeast-2 |AWS, Asia Pacific (Sydney) |aws |true |ap-southeast-2 |builtin |cpln/city="Sydney" |
| | | | | | |cpln/continent="Australia" |
| | | | | | |cpln/country="Australia" |
|aws-ca-central-1 |AWS, Canada (Central) |aws |true |ca-central-1 |builtin |cpln/city="Montréal" |
| | | | | | |cpln/continent="North America" |
| | | | | | |cpln/country="Canada" |
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
|aws-eu-north-1 |AWS, Europe (Stockholm) |aws |true |eu-north-1 |builtin |cpln/city="Stockholm" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Sweden" |
|aws-eu-west-1 |AWS, Europe (Ireland) |aws |true |eu-west-1 |builtin |cpln/continent="Europe" |
| | | | | | |cpln/country="Ireland" |
|aws-eu-west-2 |AWS, Europe (London) |aws |true |eu-west-2 |builtin |cpln/city="London" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="United Kingdom" |
|aws-eu-west-3 |AWS, Europe (Paris) |aws |true |eu-west-3 |builtin |cpln/city="Paris" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="France" |
|aws-il-central-1 |AWS, Israel (Tel Aviv) |aws |true |il-central-1 |builtin |cpln/city="Tel Aviv" |
| | | | | | |cpln/continent="Middle East" |
| | | | | | |cpln/country="Israel" |
|aws-sa-east-1 |AWS, South America (São Paulo) |aws |true |sa-east-1 |builtin |cpln/city="São Paulo" |
| | | | | | |cpln/continent="South America" |
| | | | | | |cpln/country="Brazil" |
|aws-us-east-1 |AWS, US East (N. Virginia) |aws |true |us-east-1 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
|aws-us-east-2 |AWS, US East (Ohio) |aws |true |us-east-2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="OH" |
|aws-us-west-1 |AWS, US West (N. California) |aws |true |us-west-1 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="CA" |
|aws-us-west-2 |AWS, US West (Oregon) |aws |true |us-west-2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="OR" |
|azure-eastus |Azure, East US |azure |true |eastus |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
|azure-southcentralus |Azure, South Central US |azure |true |southcentralus |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="TX" |
|demo-byok-location |demo-byok-location |byok |true |demo-byok-location |custom | |
|gcp-asia-east1 |GCP, Changhua County, Taiwan |gcp |true |asia-east1 |builtin |cpln/continent="Asia" |
| | | | | | |cpln/country="Taiwan" |
|gcp-asia-east2 |GCP, Hong Kong, China |gcp |true |asia-east2 |builtin |cpln/city="Hong Kong" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="China" |
|gcp-asia-northeast1 |GCP, Tokyo, Japan |gcp |true |asia-northeast1 |builtin |cpln/city="Tokyo" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="Japan" |
|gcp-asia-northeast2 |GCP, Osaka, Japan |gcp |true |asia-northeast2 |builtin |cpln/city="Osaka" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="Japan" |
|gcp-asia-northeast3 |GCP, Seoul, South Korea |gcp |true |asia-northeast3 |builtin |cpln/city="Seoul" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="South Korea" |
|gcp-asia-south1 |GCP, Mumbai, India |gcp |true |asia-south1 |builtin |cpln/city="Mumbai" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="India" |
|gcp-asia-south2 |GCP, Delhi, India |gcp |true |asia-south2 |builtin |cpln/city="Delhi" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="India" |
|gcp-asia-southeast1 |GCP, Jurong West, Singapore |gcp |true |asia-southeast1 |builtin |cpln/city="Jurong West" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="Singapore" |
|gcp-asia-southeast2 |GCP, Jakarta, Indonesia |gcp |true |asia-southeast2 |builtin |cpln/city="Jakarta" |
| | | | | | |cpln/continent="Asia" |
| | | | | | |cpln/country="Indonesia" |
|gcp-australia-southeast1 |GCP, Sydney, Australia |gcp |true |australia-southeast1 |builtin |cpln/city="Sydney" |
| | | | | | |cpln/continent="Australia" |
| | | | | | |cpln/country="Australia" |
|gcp-australia-southeast2 |GCP, Melbourne, Australia |gcp |true |australia-southeast2 |builtin |cpln/city="Melbourne" |
| | | | | | |cpln/continent="Australia" |
| | | | | | |cpln/country="Australia" |
|gcp-europe-central2 |GCP, Warsaw, Poland, Europe |gcp |true |europe-central2 |builtin |cpln/city="Warsaw" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Poland" |
|gcp-europe-north1 |GCP, Hamina, Finland, Europe |gcp |true |europe-north1 |builtin |cpln/city="Hamina" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Finland" |
|gcp-europe-west1 |GCP, St. Ghislain, Belgium, Europe |gcp |true |europe-west1 |builtin |cpln/city="St. Ghislain" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Belgium" |
|gcp-europe-west2 |GCP, London, England, Europe |gcp |true |europe-west2 |builtin |cpln/city="London" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="England" |
|gcp-europe-west3 |GCP, Frankfurt, Germany, Europe |gcp |true |europe-west3 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
|gcp-europe-west4 |GCP, Eemshaven, Netherlands, Europe |gcp |true |europe-west4 |builtin |cpln/city="Eemshaven" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Netherlands" |
|gcp-europe-west6 |GCP, Zurich, Switzerland, Europe |gcp |true |europe-west6 |builtin |cpln/city="Zurich" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Switzerland" |
|gcp-me-west1 |GCP, Tel Aviv, Israel, Middle East |gcp |true |me-west1 |builtin |cpln/city="Tel Aviv" |
| | | | | | |cpln/continent="Middle East" |
| | | | | | |cpln/country="Israel" |
|gcp-northamerica-northeast1 |GCP, Montréal, Québec, Canada |gcp |true |northamerica-northeast1 |builtin |cpln/city="Montréal" |
| | | | | | |cpln/continent="North America" |
| | | | | | |cpln/country="Canada" |
|gcp-northamerica-northeast2 |GCP, Toronto, Ontario, Canada |gcp |true |northamerica-northeast2 |builtin |cpln/city="Toronto" |
| | | | | | |cpln/continent="North America" |
| | | | | | |cpln/country="Canada" |
|gcp-southamerica-east1 |GCP, Osasco, São Paulo, Brazil |gcp |true |southamerica-east1 |builtin |cpln/city="Osasco" |
| | | | | | |cpln/continent="South America" |
| | | | | | |cpln/country="Brazil" |
|gcp-us-central1 |GCP, Council Bluffs, Iowa, USA |gcp |true |us-central1 |builtin |cpln/city="Council Bluffs" |
| | | | | | |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="IA" |
|gcp-us-east1 |GCP, Moncks Corner, South Carolina, USA |gcp |true |us-east1 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="SC" |
|gcp-us-east4 |GCP, Ashburn, Northern Virginia, USA |gcp |true |us-east4 |builtin |cpln/city="Ashburn" |
| | | | | | |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
|gcp-us-west1 |GCP, The Dalles, Oregon, USA |gcp |true |us-west1 |builtin |cpln/city="The Dalles" |
| | | | | | |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="OR" |
|gcp-us-west2 |GCP, Los Angeles, California, USA |gcp |true |us-west2 |builtin |cpln/city="Los Angeles" |
| | | | | | |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="CA" |
|gcp-us-west3 |GCP, Salt Lake City, Utah, USA |gcp |true |us-west3 |builtin |cpln/city="Salt Lake City" |
| | | | | | |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="UT" |
+----------------------------+----------------------------------------+---------+--------+------------------------+--------+-------------------------------+
- Get one location
cpln location get aws-eu-central-1 --org demo-cpln-organization
+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|------------------------|---------|--------|-------------|--------|------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
- Get multiple locations
cpln location get gcp-us-east1 --org demo-cpln-organization
+-------------+----------------------------------------+---------+--------+---------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-------------|----------------------------------------|---------|--------|---------|--------|-------------------------------|
|gcp-us-east1 |GCP, Moncks Corner, South Carolina, USA |gcp |true |us-east1 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="SC" |
+-------------+----------------------------------------+---------+--------+---------+--------+-------------------------------+
location install
Get instructions for obtaining the installation script for a BYOK location Usagecpln location install <ref> [OPTIONS]
Reference
Reference
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
- Obtain instructions to install a BYOK location.
cpln location install demo-byok-location --org demo-cpln-organization
# this commmand must be performed before 2024-7-16 22:42:00
kubectl apply -f 'https://byok-api.cpln.io/install/download/xxxxxxxxxx/byok-agent.k8s.yaml'
location patch
Update the referenced location’s metadata using an input file Usagecpln location patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option
--file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).Reference
Reference
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Command options:
--file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
cpln location patch aws-eu-central-1 --file update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced location.
location permissions
Show the grantable permissions for a location object type Usagecpln location permissions [OPTIONS]
Reference
Reference
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
cpln location permissions --org demo-cpln-organization
+-------+-----------------------------------------+----------------------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------------------------|----------------------------------------|
|create |Create new locations | |
|delete |Delete byok locations | |
|edit |Modify existing locations |view |
|manage |Full access |create, delete, edit, manage, use, view |
|use |Use this location for workload placement |view |
|view |Read-only access | |
+-------+-----------------------------------------+----------------------------------------+
location query
Find all the locations based on the given query Usagecpln location query QUERY_OPTIONS [OPTIONS]
Reference
Reference
Query options:
--match Query filter type [choices: "all", "none", "any"] [default: "all"]
--property, --prop Property to query
--tag Tag to query
--rel Relation to query
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
Use the
--match option to display all, none, or any of the results based on a given property or tag- Search for a location based on the name property
cpln location query --match any --prop name=aws-eu-central-1 --org demo-cpln-organization
+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|------------------------|---------|--------|-------------|--------|------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
- Search for a location based on the description property
cpln location query --match any --prop description="Azure, East US 2" --org demo-cpln-organization
+--------------+-----------------+---------+--------+--------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|--------------|-----------------|---------|--------|--------|--------|-------------------------------|
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
+--------------+-----------------+---------+--------+--------+--------+-------------------------------+
- Search for a location based on a tag
cpln location query --match any --tag cpln/city="Frankfurt" --org demo-cpln-organization
+-----------------+--------------------------------+---------+--------+-------------+--------+------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|--------------------------------|---------|--------|-------------|--------|------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
|gcp-europe-west3 |GCP, Frankfurt, Germany, Europe |gcp |true |europe-west3 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
+-----------------+--------------------------------+---------+--------+-------------+--------+------------------------+
- Search for a location based on a property and tag
cpln location query --match any --prop description="Azure, East US 2" --tag cpln/city="Frankfurt" --org demo-cpln-organization
+-----------------+--------------------------------+---------+--------+-------------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|--------------------------------|---------|--------|-------------|--------|-------------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
|gcp-europe-west3 |GCP, Frankfurt, Germany, Europe |gcp |true |europe-west3 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
+-----------------+--------------------------------+---------+--------+-------------+--------+-------------------------------+
location tag
Manage the tags belonging to one or more referenced locations Usagecpln location tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Reference
Reference
Positionals:
ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]
Command options:
--tag Attach tags (e.g., --tag drink=water)
--remove-tag Remove tags (e.g., --remove-tag tagname)
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
- Add a tag to a location
cpln location tag aws-eu-central-1 --tag drink=water --org demo-cpln-organization
+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|------------------------|---------|--------|-------------|--------|------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
| | | | | | |drink="water" |
+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
- Update same tag (after running the example above)
cpln location tag aws-eu-central-1 --tag drink=coffee --org demo-cpln-organization
+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|------------------------|---------|--------|-------------|--------|------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
| | | | | | |drink="coffee" |
+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
- Remove tag (after running the example above)
cpln location tag aws-eu-central-1 --remove drink --org demo-cpln-organization
+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|------------------------|---------|--------|-------------|--------|------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
+-----------------+------------------------+---------+--------+-------------+--------+------------------------+
- Add same tag to multiple locations
cpln location tag aws-eu-central-1 azure-eastus2 --tag multiple-locations=true --org demo-cpln-organization
+-----------------+------------------------+---------+--------+-------------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|------------------------|---------|--------|-------------|--------|-------------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
| | | | | | |multiple-locations="true" |
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
| | | | | | |multiple-locations="true" |
+-----------------+------------------------+---------+--------+-------------+--------+-------------------------------+
- Update same tag on multiple locations (after running the example above)
cpln location tag aws-eu-central-1 azure-eastus2 --tag multiple-locations=demo-location --org demo-cpln-organization
+-----------------+------------------------+---------+--------+-------------+--------+-----------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|------------------------|---------|--------|-------------|--------|-----------------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
| | | | | | |multiple-locations="demo-location" |
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
| | | | | | |multiple-locations="demo-location" |
+-----------------+------------------------+---------+--------+-------------+--------+-----------------------------------+
- Remove same tag from multiple locations (after running the example above)
cpln location tag aws-eu-central-1 azure-eastus2 --remove multiple-locations --org demo-cpln-organization
+-----------------+------------------------+---------+--------+-------------+--------+-------------------------------+
|NAME |DESCRIPTION |PROVIDER |ENABLED |REGION |ORIGIN |TAGS |
|-----------------|------------------------|---------|--------|-------------|--------|-------------------------------|
|aws-eu-central-1 |AWS, Europe (Frankfurt) |aws |true |eu-central-1 |builtin |cpln/city="Frankfurt" |
| | | | | | |cpln/continent="Europe" |
| | | | | | |cpln/country="Germany" |
|azure-eastus2 |Azure, East US 2 |azure |true |eastus2 |builtin |cpln/continent="North America" |
| | | | | | |cpln/country="USA" |
| | | | | | |cpln/state="VA" |
+-----------------+------------------------+---------+--------+-------------+--------+-------------------------------+
location uninstall
Get instructions for obtaining the uninstallation script for a BYOK location Usagecpln location uninstall <ref> [OPTIONS]
Reference
Reference
Positionals:
ref The resource reference. Usually it is the name of the resource. [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
- Obtain instructions to uninstall a BYOK location.
cpln location uninstall demo-byok-location --org demo-cpln-organization
# this commmand must be performed before 2024-7-16 22:41:00
kubectl apply -f 'https://byok-api.cpln.io/install/download/xxxxxxxxxx/byok-agent-uninstall.k8s.yaml'