cpln quota [SUBCOMMAND]
Commands:
cpln quota edit <ref> Edit the referenced quota, as YAML, within an editor
cpln quota get [ref...] Retrieve one or more referenced quotas
cpln quota patch <ref> Update the referenced quota's metadata using an input file
cpln quota permissions Show the grantable permissions for a quota object type
cpln quota query Find all the quotas based on the given query
cpln quota request Manage quota increase requests
Options:
--help Show help [boolean]
quota edit
Edit the referenced quota, as YAML, within an editor Usagecpln quota 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]
--dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
cpln quota edit b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --org demo-cpln-organization
Your default editor will be launched.
Once any modifications are saved, the updates will be sent to the API.
quota get
Retrieve one or more referenced quotas Usagecpln quota 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 quotas
cpln quota get --org demo-cpln-organization
+-------------------------------------+----------------------+-----------------------------------------+--------+--------+-----+----------+----------------------------------+
|ID |NAME |DESCRIPTION |ORIGIN |CURRENT |MAX |UNIT |DIMENSIONS |
|-------------------------------------|----------------------|-----------------------------------------|--------|--------|-----|----------|----------------------------------|
|189a7ef1-d6b5-4496-9bbc-eb933a64cb81 |agents |Max number of agents |builtin |4 |10 |count | |
|27acde85-acee-4e4a-a8d7-a00cba61b9a4 |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |5 |count |gvcLink="demo-cpln-gvc" |
|3319b55b-c307-4240-ba79-f1892c76f70e |memory-per-workload |Max memory per container |builtin |0 |1024 |MiB | |
|3dd4d521-6c5f-44a9-90bd-ae7f25fe2fca |replicas-per-workload |Max replicas per workload |builtin |0 |5 |count | |
|54d6b3a1-6776-4edf-9ccb-4a820488326a |workloads-per-gvc |Max number of workloads in a gvc |builtin |1 |20 |count |gvcLink="demo-gvc-workload" |
|605d0bd8-1263-447c-a925-b5712bd7c5ae |cpu-per-workload |Max CPU per container |builtin |0 |1000 |millicore | |
|6ce0a22a-bd60-4bc5-b492-c206a936946a |identities-per-gvc |Max number of workload identities in ... |builtin |4 |20 |count |gvcLink="demo-gvc-identity" |
|6d68c00c-7019-4b68-81cd-990ce092ead3 |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |5 |count |gvcLink="test-gvc" |
|96b373be-d7e1-4e5a-b2dd-db4de190c59d |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |5 |count |gvcLink="demo-gvc-get-streams" |
|b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a |gvcs |Max number of gvc's |builtin |10 |20 |count | |
|b4e49406-5671-480e-919c-4ec313949698 |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |3 |count |gvcLink="quick-start-4" |
|ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 |domains |Max number of domains |builtin |3 |20 |count | |
|d2e6bffd-f479-4824-976e-d5037a43a27f |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |5 |count |gvcLink="demo-gvc-logs" |
|e31e22c9-3a7e-4548-bb2c-9467ca820381 |cloudaccounts |Max number of cloudaccounts |builtin |5 |10 |count | |
|fcb91a0d-0263-451f-bc0f-9dc16c3b9e13 |workloads-per-gvc |Max number of workloads in a gvc |builtin |0 |20 |count |gvcLink="demo-gvc-with-workloads" |
+-------------------------------------+----------------------+-----------------------------------------+--------+--------+-----+----------+----------------------------------+
- Get one quota
cpln quota get b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --org demo-cpln-organization
+-------------------------------------+-----+--------------------+--------+--------+----+------+-----------+
|ID |NAME |DESCRIPTION |ORIGIN |CURRENT |MAX |UNIT |DIMENSIONS |
|-------------------------------------|-----|--------------------|--------|--------|----|------|-----------|
|b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a |gvcs |Max number of gvc's |builtin |10 |20 |count | |
+-------------------------------------+-----+--------------------+--------+--------+----+------+-----------+
- Get multiple quotas
cpln quota get b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 --org demo-cpln-organization
+-------------------------------------+--------+----------------------+--------+--------+----+------+-----------+
|ID |NAME |DESCRIPTION |ORIGIN |CURRENT |MAX |UNIT |DIMENSIONS |
|-------------------------------------|--------|----------------------|--------|--------|----|------|-----------|
|b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a |gvcs |Max number of gvc's |builtin |10 |20 |count | |
|ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 |domains |Max number of domains |builtin |3 |20 |count | |
+-------------------------------------+--------+----------------------+--------+--------+----+------+-----------+
quota patch
Update the referenced quota’s metadata using an input file Usagecpln quota patch <ref> --file FILE_NAME [OPTIONS]
Running this command with the option
--file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).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]
--dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
Example
Example
cpln quota patch b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --file update.json --org demo-cpln-organization
The changes within the JSON file will be performed against the referenced quota.
quota permissions
Show the grantable permissions for a quota object type Usagecpln quota 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 quota permissions --org demo-cpln-organization
+-------+-----------------------+---------------------------+
|NAME |DESCRIPTION |IMPLIES |
|-------|-----------------------|---------------------------|
|create |Create new quotas | |
|edit |Modify existing quotas |view |
|manage |Full access |create, edit, manage, view |
|view |Read-only access | |
+-------+-----------------------+---------------------------+
quota query
Find all the quotas based on the given query Usagecpln quota 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, tag, or relation- Search for a quota based on a property named
description
cpln quota query --match any --prop description="Max number of domains" --org demo-cpln-organization
+-------------------------------------+--------+----------------------+--------+--------+----+------+-----------+
|ID |NAME |DESCRIPTION |ORIGIN |CURRENT |MAX |UNIT |DIMENSIONS |
|-------------------------------------|--------|----------------------|--------|--------|----|------|-----------|
|ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 |domains |Max number of domains |builtin |3 |20 |count | |
+-------------------------------------+--------+----------------------+--------+--------+----+------+-----------+
quota request
Manage quota increase requestscpln quota request [SUBCOMMAND]
Commands:
cpln quota request create <name> Submit a quota increase request
cpln quota request get <id> Get a quota increase request and its status
cpln quota request list List the org's quota increase requests, optionally filtered by status
Options:
--help Show help [boolean]
quota request create
Submit a quota increase request Usagecpln quota request create <name> [OPTIONS]
Reference
Reference
Positionals:
name The name of the quota to request an increase for (e.g., gvcs). [string] [required]
Command options:
--requested-max The new maximum value being requested for the quota. [number] [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
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]
quota request get
Get a quota increase request and its status Usagecpln quota request get <id> [OPTIONS]
Reference
Reference
Positionals:
id The ID of the quota increase request to retrieve (as returned by `cpln quota request create`). [string] [required]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
Format options:
--output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
--color Colorize the output [boolean] [default: true]
--ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"]
--max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]
Request options:
--token Override the authorization token
--endpoint Override the API URL
--insecure, -k Ignore TLS errors [boolean]
Debug options:
--verbose, -v Enable verbose output to stderr [boolean] [default: false]
--debug, -d Show all HTTP communications [boolean] [default: false]
Options:
--help Show help [boolean]
quota request list
List the org’s quota increase requests, optionally filtered by status Usagecpln quota request list [OPTIONS]
Reference
Reference
Command options:
--status Only list requests with this status. [choices: "pending", "approved", "denied"]
Context options:
--profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
--org Override the organization. The default organization can be set in your profile 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]