diff --git a/doc/cli-reference/source/magnum.rst b/doc/cli-reference/source/magnum.rst index b3f100e3da..2a02b62319 100644 --- a/doc/cli-reference/source/magnum.rst +++ b/doc/cli-reference/source/magnum.rst @@ -9,7 +9,7 @@ Containers service command-line client The magnum client is the command-line interface (CLI) for the Containers service API and its extensions. -This chapter documents :command:`magnum` version ``2.0.0``. +This chapter documents :command:`magnum` version ``2.1.0``. For help on a specific :command:`magnum` command, enter: @@ -307,10 +307,26 @@ magnum bay-list .. code-block:: console - usage: magnum bay-list + usage: magnum bay-list [--marker ] [--limit ] + [--sort-key ] [--sort-dir ] Print a list of available bays. +**Optional arguments:** + +``--marker `` + The last bay UUID of the previous page; displays list + of bays after "marker". + +``--limit `` + Maximum number of bays to return. + +``--sort-key `` + Column to sort results by. + +``--sort-dir `` + Direction to sort. "asc" or "desc". + .. _magnum_bay-show: magnum bay-show @@ -370,7 +386,7 @@ magnum baymodel-create [--http-proxy ] [--https-proxy ] [--no-proxy ] - [--labels ] + [--labels ] [--tls-disabled] [--public] [--registry-enabled] Create a baymodel. @@ -430,7 +446,7 @@ Create a baymodel. ``--no-proxy `` The no_proxy address to use for nodes in bay. -``--labels `` +``--labels `` Arbitrary labels in the form of key=value pairs to associate with a baymodel. May be used multiple times. @@ -743,12 +759,27 @@ magnum container-list .. code-block:: console - usage: magnum container-list [--bay ] + usage: magnum container-list [--marker ] [--limit ] + [--sort-key ] [--sort-dir ] + [--bay ] Print a list of available containers. **Optional arguments:** +``--marker `` + The last bay UUID of the previous page; displays list + of bays after "marker". + +``--limit `` + Maximum number of containers to return + +``--sort-key `` + Column to sort results by + +``--sort-dir `` + Direction to sort. "asc" or "desc". + ``--bay `` UUID or Name of Bay