openstack/tacker
Code Issues Proposed changes

Change line length of Help command's output

Browse Source 
This patch enhances readability of "HELP" codeblock of "VNF Package
Management", "VNF Lifecycle Management", "VIM Management" CLI documents.

Change-Id: If0d37b931cf0e5c304a17b947f377329f6d72009
This commit is contained in:
Kyaw Myo Thant 2024-09-04 19:13:49 +09:00
parent 7ba267aaf7
commit 6e679e7b94
4 changed files with 294 additions and 175 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
doc/source/cli/cli-etsi-vnflcm.rst
View File

@ -83,8 +83,9 @@ Help:
.. code-block:: console
$ openstack vnflcm create --help
usage: openstack vnflcm create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width] [--print-empty] [--name <vnf-instance-name>]
usage: openstack vnflcm create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty] [--name <vnf-instance-name>]
[--description <vnf-instance-description>] [--I <param-file>]
<vnfd-id>
@ -100,7 +101,8 @@ Help:
--description <vnf-instance-description>
Description of the VNF instance to be created.
--I <param-file>
Instantiate VNF subsequently after it's creation. Specify instantiate request parameters in a json file.
Instantiate VNF subsequently after it's creation. Specify instantiate request
parameters in a json file.
output formatters:
output formatter options
@ -121,10 +123,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -195,8 +197,9 @@ Help:
$ openstack vnflcm list --help
usage: openstack vnflcm 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] [--sort-ascending | --sort-descending]
[--quote {all,minimal,none,nonnumeric}] [--noindent]
[--max-width <integer>] [--fit-width] [--print-empty]
[--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending]
List VNF Instance
@ -211,8 +214,8 @@ Help:
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated to show multiple columns
--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
specify the column(s) to sort the data (columns specified first have a priority,
non-existing columns are ignored), can be repeated
--sort-ascending sort the column(s) in ascending order
--sort-descending sort the column(s) in descending order
@ -225,10 +228,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -358,8 +361,9 @@ Help:
.. code-block:: console
$ openstack vnflcm show --help
usage: openstack vnflcm show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width] [--print-empty]
usage: openstack vnflcm show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<vnf-instance>
Display VNF instance details
@ -390,10 +394,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -422,7 +426,8 @@ Help:
$ openstack vnflcm terminate --help
usage: openstack vnflcm terminate [-h] [--termination-type <termination-type>]
[--graceful-termination-timeout <graceful-termination-timeout>] [--D]
[--graceful-termination-timeout <graceful-termination-timeout>]
[--D]
<vnf-instance>
Terminate a VNF instance
@ -436,8 +441,9 @@ Help:
--termination-type <termination-type>
Termination type can be 'GRACEFUL' or 'FORCEFUL'. Default is 'GRACEFUL'
--graceful-termination-timeout <graceful-termination-timeout>
This attribute is only applicable in case of graceful termination. It defines the time to wait for the VNF to be
taken out of service before shutting down the VNF and releasing the resources. The unit is seconds.
This attribute is only applicable in case of graceful termination. It defines the
time to wait for the VNF to be taken out of service before shutting down the VNF and
releasing the resources. The unit is seconds.
--D Delete VNF Instance subsequently after it's termination
This command is provided by the python-tackerclient plugin.
@ -596,7 +602,10 @@ Help:
.. code-block:: console
$ openstack vnflcm scale --help
usage: openstack vnflcm scale [-h] [--number-of-steps <number-of-steps>] [--additional-param-file <additional-param-file>] --type <type> --aspect-id <aspect-id> <vnf-instance>
usage: openstack vnflcm scale [-h] [--number-of-steps <number-of-steps>]
[--additional-param-file <additional-param-file>] --type
<type> --aspect-id <aspect-id>
<vnf-instance>
Scale a VNF Instance
@ -723,8 +732,10 @@ Help:
.. code-block:: console
usage: openstack vnflcm op cancel [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
[--cancel-mode <cancel-mode>]
$ openstack vnflcm op cancel --help
usage: openstack vnflcm op cancel [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty] [--cancel-mode <cancel-mode>]
<vnf-lcm-op-occ-id>
Cancel VNF Instance
@ -757,8 +768,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -880,7 +893,10 @@ Help:
.. code-block:: console
$ openstack vnflcm op fail --help
usage: openstack vnflcm op fail [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <vnf-lcm-op-occ-id>
usage: openstack vnflcm op fail [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<vnf-lcm-op-occ-id>
Fail VNF Instance
@ -910,8 +926,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -941,8 +959,12 @@ Help:
.. code-block:: console
$ openstack vnflcm op list --help
usage: openstack vnflcm op 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] [--sort-ascending | --sort-descending] [--filter <filter>] [--fields <fields> | --exclude-fields <exclude-fields>]
usage: openstack vnflcm op 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] [--sort-ascending | --sort-descending]
[--filter <filter>]
[--fields <fields> | --exclude-fields <exclude-fields>]
List LCM Operation Occurrences
@ -963,7 +985,8 @@ Help:
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated to show multiple columns
--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
specify the column(s) to sort the data (columns specified first have a priority,
non-existing columns are ignored), can be repeated
--sort-ascending sort the column(s) in ascending order
--sort-descending sort the column(s) in descending order
@ -976,8 +999,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -1065,7 +1090,10 @@ Help:
.. code-block:: console
$ openstack vnflcm op show --help
usage: openstack vnflcm op show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <vnf-lcm-op-occ-id>
usage: openstack vnflcm op show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<vnf-lcm-op-occ-id>
Display Operation Occurrence details
@ -1095,8 +1123,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -1173,7 +1203,10 @@ Help:
.. code-block:: console
$ openstack vnflcm subsc create --help
usage: openstack vnflcm subsc create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <param-file>
usage: openstack vnflcm subsc create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<param-file>
Create a new Lccn Subscription
@ -1202,8 +1235,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -1233,8 +1268,11 @@ Help:
.. code-block:: console
$ openstack vnflcm subsc list --help
usage: openstack vnflcm subsc 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] [--sort-ascending | --sort-descending] [--filter <filter>]
usage: openstack vnflcm subsc 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]
[--sort-ascending | --sort-descending] [--filter <filter>]
List Lccn Subscriptions
@ -1251,7 +1289,8 @@ Help:
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated to show multiple columns
--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
specify the column(s) to sort the data (columns specified first have a priority,
non-existing columns are ignored), can be repeated
--sort-ascending sort the column(s) in ascending order
--sort-descending sort the column(s) in descending order
@ -1264,8 +1303,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -1341,7 +1382,10 @@ Help:
.. code-block:: console
$ openstack vnflcm subsc show --help
usage: openstack vnflcm subsc show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <subscription-id>
usage: openstack vnflcm subsc show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<subscription-id>
Display Lccn Subscription details
@ -1371,8 +1415,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -1456,7 +1502,9 @@ Help:
.. code-block:: console
$ openstack vnflcm versions --help
usage: openstack vnflcm versions [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--major-version <major-version>]
usage: openstack vnflcm versions [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty] [--major-version <major-version>]
Show VnfLcm Api versions
@ -1484,8 +1532,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.

94
doc/source/cli/cli-etsi-vnfpkgm.rst
View File

@ -9,7 +9,7 @@ This document describes how to manage VNF Package with CLI in Tacker.
The content of this document has been confirmed to work
using the following VNF package.
* `vnfpkgm1 for 2024.1 Cracal`_
* `vnfpkgm1 for 2024.1 Caracal`_
Prerequisites
@ -59,15 +59,17 @@ Help:
.. code-block:: console
$ openstack vnf package create --help
usage: openstack vnf package create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width]
[--print-empty] [--user-data <key=value>]
usage: openstack vnf package create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty] [--user-data <key=value>]
Create a new VNF Package
options:
-h, --help show this help message and exit
--user-data <key=value>
User defined data for the VNF package (repeat option to set multiple user defined data)
User defined data for the VNF package (repeat option to set multiple user defined
data)
output formatters:
output formatter options
@ -88,8 +90,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -119,7 +123,9 @@ Help:
.. code-block:: console
$ openstack vnf package upload --help
usage: openstack vnf package upload [-h] (--path <file> | --url <Uri>) [--user-name <user-name>] [--password <password>] <vnf-package>
usage: openstack vnf package upload [-h] (--path <file> | --url <Uri>)
[--user-name <user-name>] [--password <password>]
<vnf-package>
Upload VNF Package
@ -158,7 +164,8 @@ Help:
.. code-block:: console
$ openstack vnf package download --help
usage: openstack vnf package download [-h] [--file <FILE>] [--vnfd] [--type <type>] <vnf-package>
usage: openstack vnf package download [-h] [--file <FILE>] [--vnfd] [--type <type>]
<vnf-package>
Download VNF package contents or VNFD of an on-boarded VNF package.
@ -169,11 +176,14 @@ Help:
options:
-h, --help show this help message and exit
--file <FILE>
Local file to save downloaded VNF Package or VNFD data. If this is not specified and there is no redirection then data will not be saved.
Local file to save downloaded VNF Package or VNFD data. If this is not specified and
there is no redirection then data will not be saved.
--vnfd Download VNFD of an on-boarded vnf package.
--type <type>
Provide text/plain when VNFD is implemented as a single YAML file otherwise use application/zip. If you are not aware whether VNFD is a single or multiple yaml
files, then you can specify 'both' option value. Provide this option only when --vnfd is set.
Provide text/plain when VNFD is implemented as a single YAML file otherwise use
application/zip. If you are not aware whether VNFD is a single or multiple yaml
files, then you can specify 'both' option value. Provide this option only when
--vnfd is set.
This command is provided by the python-tackerclient plugin.
@ -196,7 +206,8 @@ Help:
.. code-block:: console
$ openstack vnf package artifact download --help
usage: openstack vnf package artifact download [-h] [--file <FILE>] <vnf-package> <artifact-path>
usage: openstack vnf package artifact download [-h] [--file <FILE>]
<vnf-package> <artifact-path>
Download VNF package artifact of an on-boarded VNF package.
@ -209,7 +220,8 @@ Help:
options:
-h, --help show this help message and exit
--file <FILE>
Local file to save downloaded VNF Package artifact file data. If this is not specified and there is no redirection then data will not be saved.
Local file to save downloaded VNF Package artifact file data. If this is not
specified and there is no redirection then data will not be saved.
This command is provided by the python-tackerclient plugin.
@ -245,9 +257,13 @@ Help:
.. code-block:: console
$ openstack vnf package list --help
usage: openstack vnf package 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] [--sort-ascending | --sort-descending]
[--filter <filter>] [--all_fields | --fields fields | --exclude_fields exclude-fields] [--exclude_default]
usage: openstack vnf package 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] [--sort-ascending | --sort-descending]
[--filter <filter>]
[--all_fields | --fields fields | --exclude_fields exclude-fields]
[--exclude_default]
List VNF Packages
@ -260,8 +276,9 @@ Help:
Complex attributes to be included into the response
--exclude_fields exclude-fields
Complex attributes to be excluded from the response
--exclude_default Indicates to exclude all complex attributes from the response. This argument can be used alone or with --fields and --filter. For all other combinations tacker
server will throw bad request error
--exclude_default Indicates to exclude all complex attributes from the response. This argument can be
used alone or with --fields and --filter. For all other combinations tacker server
will throw bad request error
output formatters:
output formatter options
@ -271,7 +288,8 @@ Help:
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated to show multiple columns
--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
specify the column(s) to sort the data (columns specified first have a priority,
non-existing columns are ignored), can be repeated
--sort-ascending sort the column(s) in ascending order
--sort-descending sort the column(s) in descending order
@ -284,8 +302,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -394,8 +414,9 @@ Help:
.. code-block:: console
$ openstack vnf package show --help
usage: openstack vnf package show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width]
[--print-empty]
usage: openstack vnf package show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<vnf-package>
Show VNF Package Details
@ -426,8 +447,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -459,8 +482,11 @@ Help:
.. code-block:: console
$ openstack vnf package update --help
usage: openstack vnf package update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width]
[--print-empty] [--operational-state <operational-state>] [--user-data <key=value>]
usage: openstack vnf package update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
[--operational-state <operational-state>]
[--user-data <key=value>]
<vnf-package>
Update information about an individual VNF package
@ -472,9 +498,11 @@ Help:
options:
-h, --help show this help message and exit
--operational-state <operational-state>
Change the operational state of VNF Package, Valid values are 'ENABLED' or 'DISABLED'.
Change the operational state of VNF Package, Valid values are 'ENABLED' or
'DISABLED'.
--user-data <key=value>
User defined data for the VNF package (repeat option to set multiple user defined data)
User defined data for the VNF package (repeat option to set multiple user defined
data)
output formatters:
output formatter options
@ -495,8 +523,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -538,5 +568,5 @@ Help:
This command is provided by the python-tackerclient plugin.
.. _vnfpkgm1 for 2024.1 Cracal:
.. _vnfpkgm1 for 2024.1 Caracal:
https://opendev.org/openstack/tacker/src/branch/stable/2024.1/samples/tests/etc/samples/etsi/nfv/vnfpkgm1

61
doc/source/cli/cli-legacy-vim.rst
View File

@ -310,8 +310,9 @@ Help:
.. code-block:: console
$ openstack vim register --help
usage: openstack vim register [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width] [--print-empty] [--tenant-id TENANT_ID] --config-file
usage: openstack vim register [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty] [--tenant-id TENANT_ID] --config-file
CONFIG_FILE [--description DESCRIPTION] [--is-default]
NAME
@ -349,10 +350,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -383,9 +384,11 @@ Help:
.. code-block:: console
$ openstack vim list --help
usage: openstack vim 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]
[--sort-ascending | --sort-descending] [--long]
usage: openstack vim 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] [--sort-ascending | --sort-descending]
[--long]
List VIMs that belong to a given tenant.
@ -401,8 +404,8 @@ Help:
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated to show multiple columns
--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
specify the column(s) to sort the data (columns specified first have a priority,
non-existing columns are ignored), can be repeated
--sort-ascending sort the column(s) in ascending order
--sort-descending sort the column(s) in descending order
@ -415,10 +418,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -481,8 +484,9 @@ Help:
.. code-block:: console
$ openstack vim show --help
usage: openstack vim show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width] [--print-empty]
usage: openstack vim show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent]
[--prefix PREFIX] [--max-width <integer>] [--fit-width]
[--print-empty]
<VIM>
Display VIM details
@ -512,10 +516,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -579,8 +583,9 @@ Help:
.. code-block:: console
$ openstack vim set --help
usage: openstack vim set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width] [--print-empty] [--config-file CONFIG_FILE] [--name NAME]
usage: openstack vim set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent]
[--prefix PREFIX] [--max-width <integer>] [--fit-width]
[--print-empty] [--config-file CONFIG_FILE] [--name NAME]
[--description DESCRIPTION] [--is-default {True,False}]
VIM
@ -618,10 +623,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -660,5 +665,3 @@ Help:
-h, --help show this help message and exit
This command is provided by the python-tackerclient plugin.

156
doc/source/cli/v2/vnflcm.rst
View File

@ -78,8 +78,9 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 create --help
usage: openstack vnflcm create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width] [--print-empty] [--name <vnf-instance-name>]
usage: openstack vnflcm create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty] [--name <vnf-instance-name>]
[--description <vnf-instance-description>] [--I <param-file>]
<vnfd-id>
@ -95,7 +96,8 @@ Help:
--description <vnf-instance-description>
Description of the VNF instance to be created.
--I <param-file>
Instantiate VNF subsequently after it's creation. Specify instantiate request parameters in a json file.
Instantiate VNF subsequently after it's creation. Specify instantiate request
parameters in a json file.
output formatters:
output formatter options
@ -116,10 +118,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -189,7 +191,9 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 list --help
usage: openstack vnflcm list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty]
usage: openstack vnflcm 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] [--sort-ascending | --sort-descending]
List VNF Instance
@ -205,7 +209,8 @@ Help:
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated to show multiple columns
--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
specify the column(s) to sort the data (columns specified first have a priority,
non-existing columns are ignored), can be repeated
--sort-ascending sort the column(s) in ascending order
--sort-descending sort the column(s) in descending order
@ -218,8 +223,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -367,7 +374,9 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 show --help
usage: openstack vnflcm show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
usage: openstack vnflcm show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<vnf-instance>
Display VNF instance details
@ -398,8 +407,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -427,7 +438,10 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 terminate --help
usage: openstack vnflcm terminate [-h] [--termination-type <termination-type>] [--graceful-termination-timeout <graceful-termination-timeout>] [--D] <vnf-instance>
usage: openstack vnflcm terminate [-h] [--termination-type <termination-type>]
[--graceful-termination-timeout <graceful-termination-timeout>]
[--D]
<vnf-instance>
Terminate a VNF instance
@ -440,8 +454,9 @@ Help:
--termination-type <termination-type>
Termination type can be 'GRACEFUL' or 'FORCEFUL'. Default is 'GRACEFUL'
--graceful-termination-timeout <graceful-termination-timeout>
This attribute is only applicable in case of graceful termination. It defines the time to wait for the VNF to be taken out of service before shutting down the VNF
and releasing the resources. The unit is seconds.
This attribute is only applicable in case of graceful termination. It defines the
time to wait for the VNF to be taken out of service before shutting down the VNF and
releasing the resources. The unit is seconds.
--D Delete VNF Instance subsequently after it's termination
This command is provided by the python-tackerclient plugin.
@ -600,8 +615,9 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 scale --help
usage: openstack vnflcm scale [-h] [--number-of-steps <number-of-steps>] [--additional-param-file <additional-param-file>] --type <type> --aspect-id
<aspect-id>
usage: openstack vnflcm scale [-h] [--number-of-steps <number-of-steps>]
[--additional-param-file <additional-param-file>] --type
<type> --aspect-id <aspect-id>
<vnf-instance>
Scale a VNF Instance
@ -657,17 +673,14 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 change-ext-conn --help
usage: openstack vnflcm change-ext-conn [-h]
<vnf-instance>
<param-file>
usage: openstack vnflcm change-ext-conn [-h] <vnf-instance> <param-file>
Change External VNF Connectivity
positional arguments:
<vnf-instance>
VNF instance ID to Change External VNF Connectivity
<param-file> Specify change-ext-conn request parameters in a json
file.
<param-file> Specify change-ext-conn request parameters in a json file.
options:
-h, --help show this help message and exit
@ -706,17 +719,14 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 change-vnfpkg --help
usage: openstack vnflcm change-vnfpkg [-h]
<vnf-instance>
<param-file>
usage: openstack vnflcm change-vnfpkg [-h] <vnf-instance> <param-file>
Change Current VNF Package
positional arguments:
<vnf-instance>
VNF instance ID to Change Current VNF Package
<param-file> Specify change-vnfpkg request parameters in a json
file.
<param-file> Specify change-vnfpkg request parameters in a json file.
options:
-h, --help show this help message and exit
@ -856,8 +866,9 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op fail --help
usage: openstack vnflcm op fail [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width]
[--print-empty]
usage: openstack vnflcm op fail [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<vnf-lcm-op-occ-id>
Fail VNF Instance
@ -888,8 +899,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -919,9 +932,12 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op list --help
usage: openstack vnflcm op 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] [--sort-ascending | --sort-descending]
[--filter <filter>] [--fields <fields> | --exclude-fields <exclude-fields>]
usage: openstack vnflcm op 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] [--sort-ascending | --sort-descending]
[--filter <filter>]
[--fields <fields> | --exclude-fields <exclude-fields>]
List LCM Operation Occurrences
@ -942,7 +958,8 @@ Help:
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated to show multiple columns
--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
specify the column(s) to sort the data (columns specified first have a priority,
non-existing columns are ignored), can be repeated
--sort-ascending sort the column(s) in ascending order
--sort-descending sort the column(s) in descending order
@ -955,8 +972,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -1057,8 +1076,9 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 op show --help
usage: openstack vnflcm op show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width]
[--print-empty]
usage: openstack vnflcm op show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<vnf-lcm-op-occ-id>
Display Operation Occurrence details
@ -1089,8 +1109,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -1256,7 +1278,8 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 subsc create --help
usage: openstack vnflcm subsc create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>]
usage: openstack vnflcm subsc create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<param-file>
@ -1287,8 +1310,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -1318,9 +1343,11 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 subsc list --help
usage: openstack vnflcm subsc 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] [--sort-ascending | --sort-descending]
[--filter <filter>]
usage: openstack vnflcm subsc 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]
[--sort-ascending | --sort-descending] [--filter <filter>]
List Lccn Subscriptions
@ -1337,7 +1364,8 @@ Help:
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated to show multiple columns
--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
specify the column(s) to sort the data (columns specified first have a priority,
non-existing columns are ignored), can be repeated
--sort-ascending sort the column(s) in ascending order
--sort-descending sort the column(s) in descending order
@ -1350,8 +1378,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -1516,8 +1546,9 @@ Help:
.. code-block:: console
$ openstack vnflcm --os-tacker-api-version 2 subsc show --help
usage: openstack vnflcm subsc show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width]
[--print-empty]
usage: openstack vnflcm subsc show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<subscription-id>
Display Lccn Subscription details
@ -1548,8 +1579,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.
@ -1633,8 +1666,9 @@ Help:
.. code-block:: console
$ openstack vnflcm versions --help
usage: openstack vnflcm versions [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width]
[--print-empty] [--major-version <major-version>]
usage: openstack vnflcm versions [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--noindent] [--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty] [--major-version <major-version>]
Show VnfLcm Api versions
@ -1662,8 +1696,10 @@ Help:
table formatter:
--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
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.
This command is provided by the python-tackerclient plugin.