tacker - Man Page

The following list covers the extended commands for Tacker services available in openstack command.

These commands can be referenced by doing openstack help and the detail of individual command can be referred by openstack help <command-name>.

[legacy]
 openstack vim list                              List VIM(s) that belong to a given tenant.
 openstack vim register                          Create a VIM.
 openstack vim show                              Show information of a given VIM.
 openstack vim set                               Update a given VIM.
 openstack vim delete                            Delete given VIM(s).

[v1] --os-tacker-api-version 1
 openstack vnf package create                    Create a new individual VNF package resource.
 openstack vnf package delete                    Delete given VNF package(s).
 openstack vnf package list                      List all VNF packages.
 openstack vnf package show                      Show package details.
 openstack vnf package upload                    Upload a VNF package.
 openstack vnf package download                  Download a VNF package.
 openstack vnf package artifact download         Download a VNF package artifact.
 openstack vnf package update                    Update a state of a VNF package.
 openstack vnflcm create                         Create a new VNF instance resource.
 openstack vnflcm instantiate                    Instantiate a VNF instance.
 openstack vnflcm list                           List VNF instance.
 openstack vnflcm show                           Show VNF instance.
 openstack vnflcm terminate                      Terminate a VNF instance.
 openstack vnflcm delete                         Delete a VNF instance resource.
 openstack vnflcm heal                           Heal a VNF instance.
 openstack vnflcm update                         Update information of a VNF instance.
 openstack vnflcm scale                          Scale a VNF instance.
 openstack vnflcm change-ext-conn                Change external VNF connectivity.
 openstack vnflcm op rollback                    Rollback a VNF LCM operation occurrence.
 openstack vnflcm op retry                       Retry a VNF LCM operation occurrence.
 openstack vnflcm op fail                        Fail a VNF LCM operation occurrence.
 openstack vnflcm op list                        List VNF LCM operation occurrence.
 openstack vnflcm op show                        Show VNF LCM operation occurrence.
 openstack vnflcm op cancel                      Cancel a VNF LCM operation occurrence.
 openstack vnflcm versions                       Show VNF LCM API versions.
 openstack vnflcm subsc create                   Create new subscription.
 openstack vnflcm subsc delete                   Delete subscription.
 openstack vnflcm subsc list                     List subscription.
 openstack vnflcm subsc show                     Show subscription.

[v2] --os-tacker-api-version 2
 openstack vnflcm create                         Create a new VNF instance resource.
 openstack vnflcm instantiate                    Instantiate a VNF instance.
 openstack vnflcm list                           List VNF instance.
 openstack vnflcm show                           Show VNF instance.
 openstack vnflcm terminate                      Terminate a VNF instance.
 openstack vnflcm delete                         Delete a VNF instance resource.
 openstack vnflcm heal                           Heal a VNF instance.
 openstack vnflcm update                         Update information of a VNF instance.
 openstack vnflcm scale                          Scale a VNF instance.
 openstack vnflcm change-ext-conn                Change external VNF connectivity.
 openstack vnflcm change-vnfpkg                  Change current VNF package.
 openstack vnflcm op rollback                    Rollback a VNF LCM operation occurrence.
 openstack vnflcm op retry                       Retry a VNF LCM operation occurrence.
 openstack vnflcm op fail                        Fail a VNF LCM operation occurrence.
 openstack vnflcm op list                        List VNF LCM operation occurrence.
 openstack vnflcm op show                        Show VNF LCM operation occurrence.
 openstack vnflcm versions                       Show VNF LCM API versions.
 openstack vnflcm subsc create                   Create new subscription.
 openstack vnflcm subsc delete                   Delete subscription.
 openstack vnflcm subsc list                     List subscription.
 openstack vnflcm subsc show                     Show subscription.
 openstack vnffm alarm list                      List alarm.
 openstack vnffm alarm show                      Show alarm.
 openstack vnffm alarm update                    Update alarm.
 openstack vnffm sub create                      Create FM subscription.
 openstack vnffm sub list                        List FM subscription.
 openstack vnffm sub show                        Show FM subscription.
 openstack vnffm sub delete                      Delete FM subscription.
 openstack vnfpm job create                      Create PM job.
 openstack vnfpm job list                        List PM job.
 openstack vnfpm job show                        Show PM job.
 openstack vnfpm job update                      Update PM job.
 openstack vnfpm job delete                      Delete PM job.
 openstack vnfpm report show                     Show PM report.
 openstack vnfpm threshold create                Create PM threshold.
 openstack vnfpm threshold list                  List PM threshold.
 openstack vnfpm threshold show                  Show PM threshold.
 openstack vnfpm threshold update                Update PM threshold.
 openstack vnfpm threshold delete                Delete PM threshold.

VNF Package commands are CLI interface of VNF Package Management Interface in ETSI NFV-SOL 005.

Download VNF package artifact of an on-boarded VNF package.

openstack vnf package artifact download
    [--file <FILE>]
    <vnf-package>
    <artifact-path>

--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.

vnf-package

VNF package ID

artifact-path

The artifact file's path

This command is provided by the python-tackerclient plugin.

Create a new VNF Package

openstack vnf package create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--user-data <key=value>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

--user-data <key=value>

User defined data for the VNF package (repeat option to set multiple user defined data)

This command is provided by the python-tackerclient plugin.

Delete VNF Package

openstack vnf package delete <vnf-package> [<vnf-package> ...]

vnf-package

Vnf package(s) ID to delete

This command is provided by the python-tackerclient plugin.

Download VNF package contents or VNFD of an on-boarded VNF package.

openstack vnf package download
    [--file <FILE>]
    [--vnfd]
    [--type <type>]
    <vnf-package>

--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.

--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.

vnf-package

VNF package ID

This command is provided by the python-tackerclient plugin.

List VNF Packages

openstack vnf package list
    [-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]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>

when to include quotes, defaults to nonnumeric

--noindent

whether to disable indenting the JSON

--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.

--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--filter <filter>

Atrribute-based-filtering parameters

--all_fields

Include all complex attributes in the response

--fields fields

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

This command is provided by the python-tackerclient plugin.

Show VNF Package Details

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

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

vnf-package

VNF package ID

This command is provided by the python-tackerclient plugin.

Update information about an individual VNF package

openstack vnf package update
    [-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>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

--operational-state <operational-state>

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)

vnf-package

VNF package ID

This command is provided by the python-tackerclient plugin.

Upload VNF Package

openstack vnf package upload
    (--path <file> | --url <Uri>)
    [--user-name <user-name>]
    [--password <password>]
    <vnf-package>

--path <file>

Upload VNF CSAR package from local file

--url <Uri>

Uri of the VNF package content

--user-name <user-name>

User name for authentication

--password <password>

Password for authentication

vnf-package

VNF package ID

This command is provided by the python-tackerclient plugin.

VNF LCM commands are CLI interface of VNF Lifecycle Management Interface in ETSI NFV-SOL 002 and ETSI NFV-SOL 003.

NOTE:

Commands call version 1 vnflcm APIs by default. You can call the specific version of vnflcm APIs by using the option --os-tacker-api-version. Commands with --os-tacker-api-version 2 call version 2 vnflcm APIs. vnflcm op cancel is included in only version 1 vnflcm APIs and change-vnfpkg is included in only version 2 vnflcm APIs.

Change External VNF Connectivity

openstack vnflcm change-ext-conn <vnf-instance> <param-file>

vnf-instance

VNF instance ID to Change External VNF Connectivity

param-file

Specify change-ext-conn request parameters in a json file.

This command is provided by the python-tackerclient plugin.

Create a new VNF Instance

openstack vnflcm create
    [-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>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

--name <vnf-instance-name>

Name of the VNF instance to be created.

--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.

vnfd-id

Identifier that identifies the VNFD which defines the VNF instance to be created.

This command is provided by the python-tackerclient plugin.

Delete VNF Instance(s)

openstack vnflcm delete <vnf-instance> [<vnf-instance> ...]

vnf-instance

VNF instance ID(s) to delete

This command is provided by the python-tackerclient plugin.

Heal VNF Instance

openstack vnflcm heal
    [--cause CAUSE]
    [--vnfc-instance <vnfc-instance-id> [<vnfc-instance-id> ...]]
    [--additional-param-file <additional-param-file>]
    <vnf-instance>

--cause <CAUSE>

Specify the reason why a healing procedure is required.

--vnfc-instance <vnfc-instance-id>

List of VNFC instances requiring a healing action.

--additional-param-file <additional-param-file>

Additional parameters passed by the NFVO as input to the healing process.

vnf-instance

VNF instance ID to heal

This command is provided by the python-tackerclient plugin.

Instantiate a VNF Instance

openstack vnflcm instantiate <vnf-instance> <param-file>

vnf-instance

VNF instance ID to instantiate

param-file

Specify instantiate request parameters in a json file.

This command is provided by the python-tackerclient plugin.

List VNF Instance

openstack vnflcm list
    [-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]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>

when to include quotes, defaults to nonnumeric

--noindent

whether to disable indenting the JSON

--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.

--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

This command is provided by the python-tackerclient plugin.

Cancel VNF Instance

openstack vnflcm op cancel
    [-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>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

--cancel-mode <cancel-mode>

Cancel mode can be 'GRACEFUL' or 'FORCEFUL'. Default is 'GRACEFUL'

vnf-lcm-op-occ-id

VNF lifecycle management operation occurrence ID.

This command is provided by the python-tackerclient plugin.

Fail VNF Instance

openstack vnflcm op fail
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-lcm-op-occ-id>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

vnf-lcm-op-occ-id

VNF lifecycle management operation occurrence ID.

This command is provided by the python-tackerclient plugin.

List LCM Operation Occurrences

openstack vnflcm op list
    [-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>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>

when to include quotes, defaults to nonnumeric

--noindent

whether to disable indenting the JSON

--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.

--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--filter <filter>

Attribute-based-filtering parameters

--fields <fields>

Complex attributes to be included into the response

--exclude-fields <exclude-fields>

Complex attributes to be excluded from the response

This command is provided by the python-tackerclient plugin.

Retry VNF Instance

openstack vnflcm op retry <vnf-lcm-op-occ-id>

vnf-lcm-op-occ-id

VNF lifecycle management operation occurrence ID.

This command is provided by the python-tackerclient plugin.

openstack vnflcm op rollback <vnf-lcm-op-occ-id>

vnf-lcm-op-occ-id

VNF lifecycle management operation occurrence ID.

This command is provided by the python-tackerclient plugin.

Display Operation Occurrence details

openstack vnflcm op show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-lcm-op-occ-id>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

vnf-lcm-op-occ-id

VNF lifecycle management operation occurrence ID.

This command is provided by the python-tackerclient plugin.

Scale a VNF Instance

openstack vnflcm scale
    [--number-of-steps <number-of-steps>]
    [--additional-param-file <additional-param-file>]
    --type <type>
    --aspect-id <aspect-id>
    <vnf-instance>

--number-of-steps <number-of-steps>

Number of scaling steps to be executed as part of this Scale VNF operation.

--additional-param-file <additional-param-file>

Additional parameters passed by the NFVO as input to the scaling process.

--type <type>

SCALE_OUT or SCALE_IN for type of scale operation.

--aspect-id <aspect-id>

Identifier of the scaling aspect.

vnf-instance

VNF instance ID to scale

This command is provided by the python-tackerclient plugin.

Display VNF instance details

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

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

vnf-instance

VNF instance ID to display

This command is provided by the python-tackerclient plugin.

Create a new Lccn Subscription

openstack vnflcm subsc create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <param-file>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

param-file

Specify create request parameters in a json file.

This command is provided by the python-tackerclient plugin.

Delete Lccn Subscription(s)

openstack vnflcm subsc delete <subscription-id> [<subscription-id> ...]

subscription-id

Lccn Subscription ID(s) to delete

This command is provided by the python-tackerclient plugin.

List Lccn Subscriptions

openstack vnflcm subsc list
    [-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>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>

when to include quotes, defaults to nonnumeric

--noindent

whether to disable indenting the JSON

--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.

--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--filter <filter>

Attribute-based-filtering parameters

This command is provided by the python-tackerclient plugin.

Display Lccn Subscription details

openstack vnflcm subsc show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <subscription-id>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

subscription-id

Lccn Subscription ID to display

This command is provided by the python-tackerclient plugin.

Terminate a VNF instance

openstack vnflcm terminate
    [--termination-type <termination-type>]
    [--graceful-termination-timeout <graceful-termination-timeout>]
    [--D]
    <vnf-instance>

--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.

--D

Delete VNF Instance subsequently after it's termination

vnf-instance

VNF instance ID to terminate

This command is provided by the python-tackerclient plugin.

Update VNF Instance

openstack vnflcm update [--I <param-file>] <vnf-instance>

--I <param-file>

Specify update request parameters in a json file.

vnf-instance

VNF instance ID to update.

This command is provided by the python-tackerclient plugin.

Show VnfLcm Api versions

openstack vnflcm versions
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--major-version <major-version>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

--major-version <major-version>

Show only specify major version.

This command is provided by the python-tackerclient plugin.

Change Current VNF Package

openstack vnflcm change-vnfpkg <vnf-instance> <param-file>

vnf-instance

VNF instance ID to Change Current VNF Package

param-file

Specify change-vnfpkg request parameters in a json file.

This command is provided by the python-tackerclient plugin.

VNF FM commands are CLI interface of VNF Fault Management interface in ETSI NFV-SOL 002 and ETSI NFV-SOL 003.

NOTE:

Commands only support calling version 2 vnffm APIs. You can use the commands with --os-tacker-api-version 2 to call version 2 vnffm APIs.

List VNF FM alarms

openstack vnffm alarm list
    [-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>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>

when to include quotes, defaults to nonnumeric

--noindent

whether to disable indenting the JSON

--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.

--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--filter <filter>

Attribute-based-filtering parameters

This command is provided by the python-tackerclient plugin.

Display VNF FM alarm details

openstack vnffm alarm show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-fm-alarm-id>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

vnf-fm-alarm-id

VNF FM alarm ID to display

This command is provided by the python-tackerclient plugin.

Update information about an individual VNF FM alarm

openstack vnffm alarm update
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--ack-state <ack-state>]
    <vnf-fm-alarm-id>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

--ack-state <ack-state>

Ask state can be 'ACKNOWLEDGED' or 'UNACKNOWLEDGED'.

vnf-fm-alarm-id

VNF FM alarm ID to update.

This command is provided by the python-tackerclient plugin.

Create a new VNF FM subscription

openstack vnffm sub create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <param-file>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

param-file

Specify create VNF FM subscription request parameters in a json file.

This command is provided by the python-tackerclient plugin.

Delete VNF FM subscription(s)

openstack vnffm sub delete <vnf-fm-sub-id> [<vnf-fm-sub-id> ...]

vnf-fm-sub-id

VNF FM subscription ID(s) to delete

This command is provided by the python-tackerclient plugin.

List VNF FM subs

openstack vnffm sub list
    [-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>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>

when to include quotes, defaults to nonnumeric

--noindent

whether to disable indenting the JSON

--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.

--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--filter <filter>

Attribute-based-filtering parameters

This command is provided by the python-tackerclient plugin.

Display VNF FM subscription details

openstack vnffm sub show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-fm-sub-id>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

vnf-fm-sub-id

VNF FM subscription ID to display

This command is provided by the python-tackerclient plugin.

VNF PM commands are CLI interface of VNF Performance Management interface in ETSI NFV-SOL 002 and ETSI NFV-SOL 003.

NOTE:

Commands only support calling version 2 vnfpm APIs. You can use the commands with --os-tacker-api-version 2 to call version 2 vnfpm APIs.

Create a new VNF PM job

openstack vnfpm job create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <param-file>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

param-file

Specify create VNF PM job request parameters in a json file.

This command is provided by the python-tackerclient plugin.

Delete VNF PM job

openstack vnfpm job delete <vnf-pm-job-id> [<vnf-pm-job-id> ...]

vnf-pm-job-id

VNF PM job ID(s) to delete

This command is provided by the python-tackerclient plugin.

List VNF PM jobs

openstack vnfpm job list
    [-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]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>

when to include quotes, defaults to nonnumeric

--noindent

whether to disable indenting the JSON

--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.

--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--filter <filter>

Attribute-based-filtering parameters

--all_fields

Include all complex attributes in the response

--fields fields

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

This command is provided by the python-tackerclient plugin.

Display VNF PM job details

openstack vnfpm job show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-pm-job-id>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

vnf-pm-job-id

VNF PM job ID to display

This command is provided by the python-tackerclient plugin.

Update information about an individual VNF PM job

openstack vnfpm job update
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-pm-job-id>
    <param-file>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

vnf-pm-job-id

VNF PM job ID to update.

param-file

Specify update PM job request parameters in a json file.

This command is provided by the python-tackerclient plugin.

Display VNF PM report details

openstack vnfpm report show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-pm-job-id>
    <vnf-pm-report-id>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

vnf-pm-job-id

VNF PM job id where the VNF PM report is located

vnf-pm-report-id

VNF PM report ID to display

This command is provided by the python-tackerclient plugin.

Create a new VNF PM threshold

openstack vnfpm threshold create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <param-file>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

param-file

Specify create VNF PM threshold request parameters in a json file.

This command is provided by the python-tackerclient plugin.

Delete VNF PM threshold

openstack vnfpm threshold delete
    <vnf-pm-threshold-id>
    [<vnf-pm-threshold-id> ...]

vnf-pm-threshold-id

VNF PM threshold ID(s) to delete

This command is provided by the python-tackerclient plugin.

List VNF PM thresholds

openstack vnfpm threshold list
    [-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>]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>

when to include quotes, defaults to nonnumeric

--noindent

whether to disable indenting the JSON

--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.

--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--filter <filter>

Attribute-based-filtering parameters

This command is provided by the python-tackerclient plugin.

Display VNF PM threshold details

openstack vnfpm threshold show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-pm-threshold-id>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

vnf-pm-threshold-id

VNF PM threshold ID to display

This command is provided by the python-tackerclient plugin.

Update information about an individual VNF PM threshold

openstack vnfpm threshold update
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <vnf-pm-threshold-id>
    <param-file>

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

vnf-pm-threshold-id

VNF PM threshold ID to update.

param-file

Specify update PM threshold request parameters in a json file.

This command is provided by the python-tackerclient plugin.

Delete VIM(s).

openstack vim delete <VIM> [<VIM> ...]

VIM

VIM(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

List VIMs that belong to a given tenant.

openstack vim list
    [-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]

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>

when to include quotes, defaults to nonnumeric

--noindent

whether to disable indenting the JSON

--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.

--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--long

List additional fields in output

This command is provided by the python-tackerclient plugin.

Register a new VIM

openstack vim register
    [-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

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

--tenant-id TENANT_ID

The owner tenant ID or project ID

--config-file <CONFIG_FILE>

YAML file with VIM configuration parameters

--description <DESCRIPTION>

Set a description for the VIM

--is-default

Set as default VIM

NAME

Set a name for the VIM

This command is provided by the python-tackerclient plugin.

Update VIM.

openstack vim set
    [-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

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

--config-file <CONFIG_FILE>

YAML file with VIM configuration parameters

--name <NAME>

New name for the VIM

--description <DESCRIPTION>

New description for the VIM

--is-default {True,False}

Indicate whether the VIM is used as default

VIM

ID or name of vim to update

This command is provided by the python-tackerclient plugin.

Display VIM details

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

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--noindent

whether to disable indenting the JSON

--prefix <PREFIX>

add a prefix to all variable names

--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.

VIM

VIM to display (name or ID)

This command is provided by the python-tackerclient plugin.