Chapter 16. coe

This chapter describes the commands under the coe command.

16.1. coe ca rotate

Rotate the CA certificate for cluster to revoke access.

Usage:

openstack coe ca rotate [-h] <cluster>

Table 16.1. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster

Table 16.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.2. coe ca show

Show details about the CA certificate for a cluster.

Usage:

openstack coe ca show [-h] <cluster>

Table 16.3. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster

Table 16.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.3. coe ca sign

Generate the CA certificate for a cluster.

Usage:

openstack coe ca sign [-h] <cluster> <csr>

Table 16.5. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster

<csr>

File path of csr file to send to magnum to get signed.

Table 16.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.4. coe cluster config

Get Configuration for a Cluster

Usage:

openstack coe cluster config [-h] [--dir <dir>] [--force]
                                    [--output-certs] [--use-certificate]
                                    [--use-keystone]
                                    <cluster>

Table 16.7. Positional Arguments

ValueSummary

<cluster>

The name or uuid of cluster to update

Table 16.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--dir <dir>

Directory to save the certificate and config files.

--force

Overwrite files if existing.

--output-certs

Output certificates in separate files.

--use-certificate

Use certificate in config files.

--use-keystone

Use keystone token in config files.

16.5. coe cluster create

Create a cluster

Usage:

openstack coe cluster create [-h] --cluster-template <cluster-template>
                                    [--discovery-url <discovery-url>]
                                    [--docker-volume-size <docker-volume-size>]
                                    [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                    [--keypair <keypair>]
                                    [--master-count <master-count>]
                                    [--node-count <node-count>]
                                    [--timeout <timeout>]
                                    [--master-flavor <master-flavor>]
                                    [--flavor <flavor>]
                                    [--fixed-network <fixed-network>]
                                    [--fixed-subnet <fixed-subnet>]
                                    [--floating-ip-enabled]
                                    [--floating-ip-disabled]
                                    <name>

Table 16.9. Positional Arguments

ValueSummary

<name>

Name of the cluster to create.

Table 16.10. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--cluster-template <cluster-template>

Id or name of the cluster template.

--discovery-url <discovery-url>

Specifies custom delivery url for node discovery.

--docker-volume-size <docker-volume-size>

The size in gb for the docker volume to use.

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

Arbitrary labels in the form of key=valuepairs to associate with a cluster template. May be used multiple times.

--keypair <keypair>

Uuid or name of the keypair to use.

--master-count <master-count>

The number of master nodes for the cluster.

--node-count <node-count>

The cluster node count.

--timeout <timeout>

The timeout for cluster creation time. the default is 60 minutes.

--master-flavor <master-flavor>

The nova flavor name or uuid to use when launching the master node of the Cluster.

--flavor <flavor>

The nova flavor name or uuid to use when launching the Cluster.

--fixed-network <fixed-network>

The private neutron network name to connect to this Cluster template.

--fixed-subnet <fixed-subnet>

The private neutron subnet name to connect to cluster.

--floating-ip-enabled

Indicates whether created clusters should have a floating ip.

--floating-ip-disabled

Disables floating ip creation on the new cluster

16.6. coe cluster delete

Delete a cluster

Usage:

openstack coe cluster delete [-h] <cluster> [<cluster> ...]

Table 16.11. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster(s) to delete.

Table 16.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.7. coe cluster list

List clusters

Usage:

openstack coe cluster list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]
                                  [--limit <limit>] [--sort-key <sort-key>]
                                  [--sort-dir <sort-dir>]

Table 16.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Maximum number of clusters to return

--sort-key <sort-key>

Column to sort results by

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

Table 16.14. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 16.15. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 16.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.17. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

16.8. coe cluster resize

Resize a Cluster

Usage:

openstack coe cluster resize [-h] [--nodes-to-remove <Server UUID>]
                                    [--nodegroup <nodegroup>]
                                    <cluster> node_count

Table 16.18. Positional Arguments

ValueSummary

<cluster>

The name or uuid of cluster to update

node_count

Desired node count of the cluser.

Table 16.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--nodes-to-remove <Server UUID>

Server id of the nodes to be removed. repeat to addmore server ID

--nodegroup <nodegroup>

The name or uuid of the nodegroup of current cluster.

16.9. coe cluster show

Show a Cluster

Usage:

openstack coe cluster show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <cluster>

Table 16.20. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster to show.

Table 16.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 16.22. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 16.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.24. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 16.25. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

16.10. coe cluster template create

Create a Cluster Template.

Usage:

openstack coe cluster template create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             --coe <coe> --image <image>
                                             --external-network
                                             <external-network>
                                             [--keypair <keypair>]
                                             [--fixed-network <fixed-network>]
                                             [--fixed-subnet <fixed-subnet>]
                                             [--network-driver <network-driver>]
                                             [--volume-driver <volume-driver>]
                                             [--dns-nameserver <dns-nameserver>]
                                             [--flavor <flavor>]
                                             [--master-flavor <master-flavor>]
                                             [--docker-volume-size <docker-volume-size>]
                                             [--docker-storage-driver <docker-storage-driver>]
                                             [--http-proxy <http-proxy>]
                                             [--https-proxy <https-proxy>]
                                             [--no-proxy <no-proxy>]
                                             [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                             [--tls-disabled] [--public]
                                             [--registry-enabled]
                                             [--server-type <server-type>]
                                             [--master-lb-enabled]
                                             [--floating-ip-enabled]
                                             [--floating-ip-disabled]
                                             [--hidden] [--visible]
                                             <name>

Table 16.26. Positional Arguments

ValueSummary

<name>

Name of the cluster template to create.

Table 16.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--coe <coe>

Specify the container orchestration engine to use.

--image <image>

The name or uuid of the base image to customize for the Cluster.

--external-network <external-network>

The external neutron network name or uuid to connect to this Cluster Template.

--keypair <keypair>

The name or uuid of the ssh keypair to load into the Cluster nodes.

--fixed-network <fixed-network>

The private neutron network name to connect to this Cluster model.

--fixed-subnet <fixed-subnet>

The private neutron subnet name to connect to cluster.

--network-driver <network-driver>

The network driver name for instantiating container networks.

--volume-driver <volume-driver>

The volume driver name for instantiating container volume.

--dns-nameserver <dns-nameserver>

The dns nameserver to use for this cluster template.

--flavor <flavor>

The nova flavor name or uuid to use when launching the Cluster.

--master-flavor <master-flavor>

The nova flavor name or uuid to use when launching the master node of the Cluster.

--docker-volume-size <docker-volume-size>

Specify the number of size in gb for the docker volume to use.

--docker-storage-driver <docker-storage-driver>

Select a docker storage driver. supported: devicemapper, overlay. Default: devicemapper

--http-proxy <http-proxy>

The http_proxy address to use for nodes in cluster.

--https-proxy <https-proxy>

The https_proxy address to use for nodes in cluster.

--no-proxy <no-proxy>

The no_proxy address to use for nodes in cluster.

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

Arbitrary labels in the form of key=value pairs to associate with a cluster template. May be used multiple times.

--tls-disabled

Disable tls in the cluster.

--public

Make cluster template public.

--registry-enabled

Enable docker registry in the cluster

--server-type <server-type>

Specify the server type to be used for example vm. for this release default server type will be vm.

--master-lb-enabled

Indicates whether created clusters should have a load balancer for master nodes or not.

--floating-ip-enabled

Indicates whether created clusters should have a floating ip.

--floating-ip-disabled

Disables floating ip creation on the new cluster

--hidden

Indicates the cluster template should be hidden.

--visible

Indicates the cluster template should be visible.

Table 16.28. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 16.29. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.30. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 16.31. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

16.11. coe cluster template delete

Delete a Cluster Template.

Usage:

openstack coe cluster template delete [-h]
                                             <cluster-templates>
                                             [<cluster-templates> ...]

Table 16.32. Positional Arguments

ValueSummary

<cluster-templates>

Id or name of the (cluster template)s to delete.

Table 16.33. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.12. coe cluster template list

List Cluster Templates.

Usage:

openstack coe cluster template list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--noindent]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--sort-key <sort-key>]
                                           [--sort-dir <sort-dir>]
                                           [--fields <fields>]

Table 16.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Maximum number of cluster templates to return

--sort-key <sort-key>

Column to sort results by

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

--fields <fields>

Comma-separated list of fields to display. available fields: uuid, name, coe, image_id, public, link, apiserver_port, server_type, tls_disabled, registry_enabled

Table 16.35. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 16.36. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 16.37. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.38. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

16.13. coe cluster template show

Show a Cluster Template.

Usage:

openstack coe cluster template show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           <cluster-template>

Table 16.39. Positional Arguments

ValueSummary

<cluster-template>

Id or name of the cluster template to show.

Table 16.40. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 16.41. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 16.42. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.43. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 16.44. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

16.14. coe cluster template update

Update a Cluster Template.

Usage:

openstack coe cluster template update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <cluster-template> <op>
                                             <path=value> [<path=value> ...]

Table 16.45. Positional Arguments

ValueSummary

<cluster-template>

The name or uuid of cluster template to update

<op>

Operations: one of add, replace or remove

<path=value>

Attributes to add/replace or remove (only path is necessary on remove)

Table 16.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 16.47. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 16.48. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.49. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 16.50. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

16.15. coe cluster update

Update a Cluster

Usage:

openstack coe cluster update [-h] [--rollback]
                                    <cluster> <op> <path=value>
                                    [<path=value> ...]

Table 16.51. Positional Arguments

ValueSummary

<cluster>

The name or uuid of cluster to update

<op>

Operations: one of add, replace or remove

<path=value>

Attributes to add/replace or remove (only path is necessary on remove)

Table 16.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--rollback

Rollback cluster on update failure.

16.16. coe cluster upgrade

Upgrade a Cluster

Usage:

openstack coe cluster upgrade [-h] [--max-batch-size <max_batch_size>]
                                     [--nodegroup <nodegroup>]
                                     <cluster> cluster_template

Table 16.53. Positional Arguments

ValueSummary

<cluster>

The name or uuid of cluster to update

cluster_template

The new cluster template id will be upgraded to.

Table 16.54. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--max-batch-size <max_batch_size>

The max batch size for upgrading each time.

--nodegroup <nodegroup>

The name or uuid of the nodegroup of current cluster.

16.17. coe nodegroup create

Create a nodegroup

Usage:

openstack coe nodegroup create [-h]
                                      [--docker-volume-size <docker-volume-size>]
                                      [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                      [--node-count <node-count>]
                                      [--min-nodes <min-nodes>]
                                      [--max-nodes <max-nodes>]
                                      [--role <role>] [--image <image>]
                                      [--flavor <flavor>]
                                      <cluster> <name>

Table 16.55. Positional Arguments

ValueSummary

<cluster>

Name of the nodegroup to create.

<name>

Name of the nodegroup to create.

Table 16.56. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--docker-volume-size <docker-volume-size>

The size in gb for the docker volume to use.

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

Arbitrary labels in the form of key=valuepairs to associate with a nodegroup. May be used multiple times.

--node-count <node-count>

The nodegroup node count.

--min-nodes <min-nodes>

The nodegroup minimum node count.

--max-nodes <max-nodes>

The nodegroup maximum node count.

--role <role>

The role of the nodegroup

--image <image>

The name or uuid of the base image to customize for the NodeGroup.

--flavor <flavor>

The nova flavor name or uuid to use when launching the nodes in this NodeGroup.

16.18. coe nodegroup delete

Delete a nodegroup

Usage:

openstack coe nodegroup delete [-h]
                                      <cluster> <nodegroup> [<nodegroup> ...]

Table 16.57. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster where the nodegroup(s) belong(s).

<nodegroup>

Id or name of the nodegroup(s) to delete.

Table 16.58. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.19. coe nodegroup list

List nodegroups

Usage:

openstack coe nodegroup list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--noindent] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--sort-column SORT_COLUMN]
                                    [--limit <limit>] [--sort-key <sort-key>]
                                    [--sort-dir <sort-dir>] [--role <role>]
                                    <cluster>

Table 16.59. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster where the nodegroup belongs.

Table 16.60. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Maximum number of nodegroups to return

--sort-key <sort-key>

Column to sort results by

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

--role <role>

List the nodegroups in the cluster with this role

Table 16.61. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 16.62. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 16.63. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.64. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

16.20. coe nodegroup show

Show a nodegroup

Usage:

openstack coe nodegroup show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty]
                                    <cluster> <nodegroup>

Table 16.65. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster where the nodegroup belongs.

<nodegroup>

Id or name of the nodegroup to show.

Table 16.66. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 16.67. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 16.68. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.69. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 16.70. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

16.21. coe nodegroup update

Update a Nodegroup

Usage:

openstack coe nodegroup update [-h]
                                      <cluster> <nodegroup> <op> <path=value>
                                      [<path=value> ...]

Table 16.71. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster where the nodegroup belongs.

<nodegroup>

The name or uuid of cluster to update

<op>

Operations: one of add, replace or remove

<path=value>

Attributes to add/replace or remove (only path is necessary on remove)

Table 16.72. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

16.22. coe quotas create

Create a quota.

Usage:

openstack coe quotas create [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

Table 16.73. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

--hard-limit <hard-limit>

Max resource limit (default: hard-limit=1)

16.23. coe quotas delete

Delete specified resource quota.

Usage:

openstack coe quotas delete [-h] --project-id <project-id> --resource
                                   <resource>

Table 16.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

16.24. coe quotas list

Print a list of available quotas.

Usage:

openstack coe quotas list [-h] [--marker <marker>] [--limit <limit>]
                                 [--sort-key <sort-key>]
                                 [--sort-dir <sort-dir>] [--all-tenants]

Table 16.75. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker <marker>

The last quota uuid of the previous page; displays list of quotas after "marker".

--limit <limit>

Maximum number of quotas to return.

--sort-key <sort-key>

Column to sort results by.

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

--all-tenants

Flag to indicate list all tenant quotas.

16.25. coe quotas show

Show details about the given project resource quota.

Usage:

openstack coe quotas show [-h] --project-id <project-id> --resource
                                 <resource>

Table 16.76. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

16.26. coe quotas update

Update information about the given project resource quota.

Usage:

openstack coe quotas update [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

Table 16.77. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

--hard-limit <hard-limit>

Max resource limit (default: hard-limit=1)

16.27. coe service list

Print a list of Magnum services.

Usage:

openstack coe service list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--noindent] [--max-width <integer>]
                                  [--fit-width] [--print-empty]
                                  [--sort-column SORT_COLUMN]

Table 16.78. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 16.79. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 16.80. CSV Formatter

ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 16.81. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 16.82. Table Formatter

ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

16.28. coe stats list

Show stats for the given project_id

Usage:

openstack coe stats list [-h] <project>

Table 16.83. Positional Arguments

ValueSummary

<project>

Project id

Table 16.84. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit