tacker - Man Page

Client for Tacker API

Command List

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

openstack vnf create                            Create a VNF.
openstack vnf delete                            Delete given VNF(s).
openstack vnf list                              List VNF(s) that belong to a given tenant.
openstack vnf resource list                     List resources of a VNF like VDU, CP, etc.
openstack vnf scale                             Scale a VNF.
openstack vnf show                              Show information of a given VNF.
openstack vnf set                               Update a given VNF.
openstack vnf descriptor create                 Create a VNFD.
openstack vnf descriptor delete                 Delete given VNFD(s).
openstack vnf descriptor list                   List VNFD(s) that belong to a given tenant.
openstack vnf descriptor show                   Show information of a given VNFD.
openstack vnf descriptor template show          Show template of a given VNFD.
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).
openstack ns create                             Create a NS.
openstack ns delete                             Delete given NS(s).
openstack ns list                               List NS that belong to a given tenant.
openstack ns show                               Show information of a given NS.
openstack ns descriptor create                  Create a NSD.
openstack ns descriptor delete                  Delete a given NSD.
openstack ns descriptor list                    List NSD(s) that belong to a given tenant.
openstack ns descriptor show                    Show information of a given NSD.
openstack ns descriptor template show           Show template of a given NSD.
openstack vnf graph create                      Create a VNFFG.
openstack vnf graph delete                      Delete a given VNFFG.
openstack vnf graph list                        List VNFFG(s) that belong to a given tenant.
openstack vnf graph show                        Show information of a given VNFFG.
openstack vnf graph set                         Update a given VNFFG.
openstack vnf graph descriptor create           Create a VNFFGD.
openstack vnf graph descriptor delete           Delete a given VNFFGD.
openstack vnf graph descriptor list             List VNFFGD(s) that belong to a given tenant.
openstack vnf graph descriptor show             Show information of a given VNFFGD.
openstack vnf graph descriptor template show    Show template of a given VNFFGD.
openstack vnf chain list                        List SFC(s) that belong to a given tenant.
openstack vnf chain show                        Show information of a given SFC.
openstack vnf classifier list                   List FC(s) that belong to a given tenant.
openstack vnf classifier show                   Show information of a given FC.
openstack vnf network forwarding path list      List NFP(s) that belong to a given tenant.
openstack vnf network forwarding path show      Show information of a given NFP.
openstack nfv event show                        Show event given the event id.
openstack nfv event list                        List events of resources.
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 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 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.
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.

Operations for Etsi Nfv-Sol Implementation

VNF Package commands

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

vnf package artifact download

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.

vnf package create

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.

vnf package delete

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.

vnf package download

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.

vnf package list

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.

vnf package show

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.

vnf package update

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.

vnf package upload

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

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.

vnflcm change-ext-conn

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.

vnflcm create

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.

vnflcm delete

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.

vnflcm heal

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.

vnflcm instantiate

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.

vnflcm list

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.

vnflcm op cancel

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.

vnflcm op fail

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.

vnflcm op list

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.

vnflcm op retry

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.

vnflcm op rollback

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.

vnflcm op show

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.

vnflcm scale

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.

vnflcm show

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.

vnflcm subsc create

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.

vnflcm subsc delete

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.

vnflcm subsc list

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.

vnflcm subsc show

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.

vnflcm terminate

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.

vnflcm update

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.

vnflcm versions

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.

vnflcm change-vnfpkg

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

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.

vnffm alarm list

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.

vnffm alarm show

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.

vnffm alarm update

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.

vnffm sub create

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.

vnffm sub delete

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.

vnffm sub list

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.

vnffm sub show

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

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.

vnfpm job create

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.

vnfpm job delete

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.

vnfpm job list

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.

vnfpm job show

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.

vnfpm job update

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.

vnfpm report show

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.

vnfpm threshold create

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.

vnfpm threshold delete

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.

vnfpm threshold list

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.

vnfpm threshold show

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.

vnfpm threshold update

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.

Operations for Legacy Implementation

VNF Management commands

WARNING:: VNF Management commands are deprecated and will be removed in the first major release after the Tacker server version 9.0.0 (2023.1 Antelope release).

vnf chain list

List SFC(s) that belong to a given tenant.

openstack vnf chain 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]
    [--nfp-id NFP_ID]
    [--tenant-id TENANT_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
--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
--nfp-id <NFP_ID>: List SFC(s) with specific nfp id
--tenant-id TENANT_ID: The owner tenant ID or project ID

This command is provided by the python-tackerclient plugin.

vnf chain show

Display SFC details

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

-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.
SFC: SFC to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf classifier list

List flow classifier(s) that belong to a given tenant.

openstack vnf classifier 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]
    [--nfp-id NFP_ID]
    [--tenant-id TENANT_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
--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
--nfp-id <NFP_ID>: List flow classifier(s) with specific nfp id
--tenant-id TENANT_ID: The owner tenant ID or project ID

This command is provided by the python-tackerclient plugin.

vnf classifier show

Display flow classifier details

openstack vnf classifier show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <Classifier
    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.
Classifier ID: Flow Classifier to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf create

Create a new VNF

openstack vnf create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    (--vnfd-id VNFD_ID | --vnfd-name VNFD_NAME | --vnfd-template VNFD_TEMPLATE)
    [--vim-id VIM_ID | --vim-name VIM_NAME]
    [--vim-region-name VIM_REGION_NAME]
    [--config-file CONFIG_FILE]
    [--param-file PARAM_FILE]
    [--description DESCRIPTION]
    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
--vnfd-id <VNFD_ID>: VNFD ID to use as template to create VNF
--vnfd-name <VNFD_NAME>: VNFD Name to use as template to create VNF
--vnfd-template <VNFD_TEMPLATE>: VNFD file to create VNF
--vim-id <VIM_ID>: VIM ID to deploy VNF on specified VIM
--vim-name <VIM_NAME>: VIM name to deploy VNF on specified VIM
--vim-region-name <VIM_REGION_NAME>: VIM Region to deploy VNF on specified VIM
--config-file <CONFIG_FILE>: YAML file with VNF configuration
--param-file <PARAM_FILE>: Specify parameter yaml file
--description <DESCRIPTION>: Set description for the VNF
NAME: Set a name for the VNF

This command is provided by the python-tackerclient plugin.

vnf delete

Delete VNF(s).

openstack vnf delete [--force] <VNF> [<VNF> ...]

--force: Force delete VNF instance
VNF: VNF(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

vnf descriptor create

Create a new VNFD

openstack vnf descriptor create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    --vnfd-file VNFD_FILE
    [--description DESCRIPTION]
    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
--vnfd-file <VNFD_FILE>: YAML file with VNFD parameters
--description <DESCRIPTION>: Set a description for the VNFD
NAME: Name for VNFD

This command is provided by the python-tackerclient plugin.

vnf descriptor delete

Delete VNFD(s).

openstack vnf descriptor delete <VNFD> [<VNFD> ...]

VNFD: VNFD(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

vnf descriptor list

List (VNFD)s that belong to a given tenant.

openstack vnf descriptor 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]
    [--template-source TEMPLATE_SOURCE]

-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
--template-source <TEMPLATE_SOURCE>: List VNFD with specified template source. Available options are 'onboarded' (default), 'inline' or 'all'

This command is provided by the python-tackerclient plugin.

vnf descriptor show

Display VNFD details

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

-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.
VNFD: VNFD to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf descriptor template show

Display VNFD Template details

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

-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.
VNFD: VNFD to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph create

Create a new VNFFG.

openstack vnf graph create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    (--vnffgd-id VNFFGD_ID | --vnffgd-name VNFFGD_NAME | --vnffgd-template VNFFGD_TEMPLATE)
    [--vnf-mapping VNF_MAPPING]
    [--symmetrical]
    [--param-file PARAM_FILE]
    [--description DESCRIPTION]
    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
--vnffgd-id <VNFFGD_ID>: VNFFGD ID to use as template to create VNFFG
--vnffgd-name <VNFFGD_NAME>: VNFFGD Name to use as template to create VNFFG
--vnffgd-template <VNFFGD_TEMPLATE>: VNFFGD file to create VNFFG
--vnf-mapping <VNF_MAPPING>: List of logical VNFD name to VNF instance name mapping. Example: VNF1:my_vnf1,VNF2:my_vnf2
--symmetrical: Should a reverse path be created for the NFP (True or False)
--param-file <PARAM_FILE>: YAML file with specific VNFFG parameters
--description <DESCRIPTION>: Set a description for the VNFFG
NAME: Set a name for the VNFFG

This command is provided by the python-tackerclient plugin.

vnf graph delete

Delete VNFFG(s).

openstack vnf graph delete [--force] <VNFFG> [<VNFFG> ...]

--force: Force delete VNFFG
VNFFG: VNFFG(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph descriptor create

Create a new VNFFGD

openstack vnf graph descriptor create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    --vnffgd-file VNFFGD_FILE
    [--description DESCRIPTION]
    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
--vnffgd-file <VNFFGD_FILE>: YAML file with VNFFGD parameters
--description <DESCRIPTION>: Set a description for the VNFFGD
NAME: Name for VNFFGD

This command is provided by the python-tackerclient plugin.

vnf graph descriptor delete

Delete VNFFGD(s).

openstack vnf graph descriptor delete <VNFFGD> [<VNFFGD> ...]

VNFFGD: VNFFGD(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph descriptor list

List (VNFFGD)s that belong to a given tenant.

openstack vnf graph descriptor 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]
    [--template-source TEMPLATE_SOURCE]

-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
--template-source <TEMPLATE_SOURCE>: List VNFFGD with specified template source. Available options are 'onboarded' (default), 'inline' or 'all'

This command is provided by the python-tackerclient plugin.

vnf graph descriptor show

Display VNFFGD details

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

-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.
VNFFGD: VNFFGD to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph descriptor template show

Display VNFFGD Template details

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

-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.
VNFFGD: VNFFGD to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph list

List VNFFG(s) that belong to a given tenant.

openstack vnf graph 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.

vnf graph set

Update VNFFG.

openstack vnf graph set
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--vnffgd-template VNFFGD_TEMPLATE]
    [--vnf-mapping VNF_MAPPING]
    [--symmetrical]
    [--description DESCRIPTION]
    [--param-file PARAM_FILE]
    <VNFFG>

-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.
--vnffgd-template <VNFFGD_TEMPLATE>: VNFFGD file to update VNFFG
--vnf-mapping <VNF_MAPPING>: List of logical VNFD name to VNF instance name mapping. Example: VNF1:my_vnf1,VNF2:my_vnf2
--symmetrical: Should a reverse path be created for the NFP
--description <DESCRIPTION>: Set a description for the VNFFG
--param-file <PARAM_FILE>: YAML file with specific VNFFG parameters
VNFFG: VNFFG to update (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph show

Display VNFFG details

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

-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.
VNFFG: VNFFG to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf list

List VNF(s) that belong to a given tenant.

openstack vnf 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]
    [--template-source TEMPLATE_SOURCE]
    [--vim-id VIM_ID | --vim-name VIM_NAME]
    [--vnfd-id VNFD_ID | --vnfd-name VNFD_NAME]
    [--tenant-id TENANT_ID]
    [--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
--template-source <TEMPLATE_SOURCE>: List VNF with specified template source. Available options are 'onboarded' (default), 'inline' or 'all'
--vim-id <VIM_ID>: List VNF(s) that belong to a given VIM ID
--vim-name <VIM_NAME>: List VNF(s) that belong to a given VIM Name
--vnfd-id <VNFD_ID>: List VNF(s) that belong to a given VNFD ID
--vnfd-name <VNFD_NAME>: List VNF(s) that belong to a given VNFD Name
--tenant-id TENANT_ID: The owner tenant ID or project ID
--long: List additional fields in output

This command is provided by the python-tackerclient plugin.

vnf network forwarding path list

List NFP(s) that belong to a given tenant.

openstack vnf network forwarding path 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]
    [--vnffg-id VNFFG_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
--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
--vnffg-id <VNFFG_ID>: List NFP(s) with specific VNFFG ID

This command is provided by the python-tackerclient plugin.

vnf network forwarding path show

Display NFP details

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

-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.
NFP: NFP to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf package artifact download

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.

vnf package create

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.

vnf package delete

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.

vnf package download

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.

vnf package list

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.

vnf package show

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.

vnf package update

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.

vnf package upload

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

List resources of a VNF like VDU, CP, etc.

openstack vnf resource 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]
    <VNF>

-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
VNF: VNF to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf scale

Scale a VNF.

openstack vnf scale
    [--scaling-policy-name SCALING_POLICY_NAME]
    [--scaling-type SCALING_TYPE]
    <VNF>

--scaling-policy-name <SCALING_POLICY_NAME>: VNF policy name used to scale
--scaling-type <SCALING_TYPE>: VNF scaling type, it could be either "out" or "in"
VNF: VNF to scale (name or ID)

This command is provided by the python-tackerclient plugin.

vnf set

Update a given VNF.

openstack vnf set
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    (--config-file CONFIG_FILE | --config CONFIG | --param-file PARAM_FILE)
    <VNF>

-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 VNF configuration
--config <CONFIG>: YAML data with VNF configuration
--param-file <PARAM_FILE>: YAML file with VNF parameter
VNF: VNF to update (name or ID)

This command is provided by the python-tackerclient plugin.

vnf show

Display VNF details

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

-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: VNF to display (name or ID)

This command is provided by the python-tackerclient plugin.

VNF Descriptor (VNFD) Management commands

WARNING:: VNF Descriptor (VNFD) Management commands are deprecated and will be removed in the first major release after the Tacker server version 9.0.0 (2023.1 Antelope release).

vnf descriptor create

Create a new VNFD

openstack vnf descriptor create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    --vnfd-file VNFD_FILE
    [--description DESCRIPTION]
    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
--vnfd-file <VNFD_FILE>: YAML file with VNFD parameters
--description <DESCRIPTION>: Set a description for the VNFD
NAME: Name for VNFD

This command is provided by the python-tackerclient plugin.

vnf descriptor delete

Delete VNFD(s).

openstack vnf descriptor delete <VNFD> [<VNFD> ...]

VNFD: VNFD(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

vnf descriptor list

List (VNFD)s that belong to a given tenant.

openstack vnf descriptor 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]
    [--template-source TEMPLATE_SOURCE]

-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
--template-source <TEMPLATE_SOURCE>: List VNFD with specified template source. Available options are 'onboarded' (default), 'inline' or 'all'

This command is provided by the python-tackerclient plugin.

vnf descriptor show

Display VNFD details

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

-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.
VNFD: VNFD to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf descriptor template show

Display VNFD Template details

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

-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.
VNFD: VNFD to display (name or ID)

This command is provided by the python-tackerclient plugin.

VIM Management commands

vim delete

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.

vim list

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.

vim register

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.

vim set

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.

vim show

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.

Network Service Management commands

WARNING:: Network Service Management commands are deprecated and will be removed in the first major release after the Tacker server version 9.0.0 (2023.1 Antelope release).

ns create

Create a new NS

openstack ns create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--description DESCRIPTION]
    (--nsd-id NSD_ID | --nsd-template NSD_TEMPLATE | --nsd-name NSD_NAME)
    [--vim-id VIM_ID | --vim-name VIM_NAME]
    [--vim-region-name VIM_REGION_NAME]
    [--param-file PARAM_FILE]
    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
--description <DESCRIPTION>: Set description for the NS
--nsd-id <NSD_ID>: NSD ID to use as template to create NS
--nsd-template <NSD_TEMPLATE>: NSD file to create NS
--nsd-name <NSD_NAME>: NSD name to use as template to create NS
--vim-id <VIM_ID>: VIM ID to use to create NS on the specified VIM
--vim-name <VIM_NAME>: VIM name to use to create NS on the specified VIM
--vim-region-name <VIM_REGION_NAME>: VIM Region to use to create NS on the specified VIM
--param-file <PARAM_FILE>: Specify parameter YAML file
NAME: Name for NS

This command is provided by the python-tackerclient plugin.

ns delete

Delete NS(s).

openstack ns delete [--force] <NS> [<NS> ...]

--force: Force delete Network Service
NS: NS(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

ns descriptor create

Create a new NSD.

openstack ns descriptor create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    --nsd-file NSD_FILE
    [--description DESCRIPTION]
    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
--nsd-file <NSD_FILE>: YAML file with NSD parameters
--description <DESCRIPTION>: Set a description for the NSD
NAME: Name for NSD

This command is provided by the python-tackerclient plugin.

ns descriptor delete

Delete NSD(s).

openstack ns descriptor delete <NSD> [<NSD> ...]

NSD: NSD(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

ns descriptor list

List (NSD)s that belong to a given tenant.

openstack ns descriptor 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]
    [--template-source TEMPLATE_SOURCE]

-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
--template-source <TEMPLATE_SOURCE>: List NSD with specified template source. Available options are 'onboared' (default), 'inline' or 'all'

This command is provided by the python-tackerclient plugin.

ns descriptor show

Display NSD details

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

-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.
NSD: NSD to display (name or ID)

This command is provided by the python-tackerclient plugin.

ns descriptor template show

Display NSD Template details

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

-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.
NSD: NSD to display (name or ID)

This command is provided by the python-tackerclient plugin.

ns list

List (NS)s that belong to a given tenant.

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

ns show

Display NS details

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

-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.
NS: NS to display (name or ID)

This command is provided by the python-tackerclient plugin.

Network Service Descriptor Management commands

WARNING:: Network Service Descriptor Management commands are deprecated and will be removed in the first major release after the Tacker server version 9.0.0 (2023.1 Antelope release).

ns descriptor create

Create a new NSD.

openstack ns descriptor create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    --nsd-file NSD_FILE
    [--description DESCRIPTION]
    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
--nsd-file <NSD_FILE>: YAML file with NSD parameters
--description <DESCRIPTION>: Set a description for the NSD
NAME: Name for NSD

This command is provided by the python-tackerclient plugin.

ns descriptor delete

Delete NSD(s).

openstack ns descriptor delete <NSD> [<NSD> ...]

NSD: NSD(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

ns descriptor list

List (NSD)s that belong to a given tenant.

openstack ns descriptor 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]
    [--template-source TEMPLATE_SOURCE]

-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
--template-source <TEMPLATE_SOURCE>: List NSD with specified template source. Available options are 'onboared' (default), 'inline' or 'all'

This command is provided by the python-tackerclient plugin.

ns descriptor show

Display NSD details

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

-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.
NSD: NSD to display (name or ID)

This command is provided by the python-tackerclient plugin.

ns descriptor template show

Display NSD Template details

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

-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.
NSD: NSD to display (name or ID)

This command is provided by the python-tackerclient plugin.

VNF Forwarding Graph (VNFFG) Management commands

WARNING:: VNF Forwarding Graph (VNFFG) Management commands are deprecated and will be removed in the first major release after the Tacker server version 9.0.0 (2023.1 Antelope release).

vnf graph create

Create a new VNFFG.

openstack vnf graph create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    (--vnffgd-id VNFFGD_ID | --vnffgd-name VNFFGD_NAME | --vnffgd-template VNFFGD_TEMPLATE)
    [--vnf-mapping VNF_MAPPING]
    [--symmetrical]
    [--param-file PARAM_FILE]
    [--description DESCRIPTION]
    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
--vnffgd-id <VNFFGD_ID>: VNFFGD ID to use as template to create VNFFG
--vnffgd-name <VNFFGD_NAME>: VNFFGD Name to use as template to create VNFFG
--vnffgd-template <VNFFGD_TEMPLATE>: VNFFGD file to create VNFFG
--vnf-mapping <VNF_MAPPING>: List of logical VNFD name to VNF instance name mapping. Example: VNF1:my_vnf1,VNF2:my_vnf2
--symmetrical: Should a reverse path be created for the NFP (True or False)
--param-file <PARAM_FILE>: YAML file with specific VNFFG parameters
--description <DESCRIPTION>: Set a description for the VNFFG
NAME: Set a name for the VNFFG

This command is provided by the python-tackerclient plugin.

vnf graph delete

Delete VNFFG(s).

openstack vnf graph delete [--force] <VNFFG> [<VNFFG> ...]

--force: Force delete VNFFG
VNFFG: VNFFG(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph descriptor create

Create a new VNFFGD

openstack vnf graph descriptor create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    --vnffgd-file VNFFGD_FILE
    [--description DESCRIPTION]
    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
--vnffgd-file <VNFFGD_FILE>: YAML file with VNFFGD parameters
--description <DESCRIPTION>: Set a description for the VNFFGD
NAME: Name for VNFFGD

This command is provided by the python-tackerclient plugin.

vnf graph descriptor delete

Delete VNFFGD(s).

openstack vnf graph descriptor delete <VNFFGD> [<VNFFGD> ...]

VNFFGD: VNFFGD(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph descriptor list

List (VNFFGD)s that belong to a given tenant.

openstack vnf graph descriptor 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]
    [--template-source TEMPLATE_SOURCE]

-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
--template-source <TEMPLATE_SOURCE>: List VNFFGD with specified template source. Available options are 'onboarded' (default), 'inline' or 'all'

This command is provided by the python-tackerclient plugin.

vnf graph descriptor show

Display VNFFGD details

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

-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.
VNFFGD: VNFFGD to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph descriptor template show

Display VNFFGD Template details

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

-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.
VNFFGD: VNFFGD to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph list

List VNFFG(s) that belong to a given tenant.

openstack vnf graph 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.

vnf graph set

Update VNFFG.

openstack vnf graph set
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--vnffgd-template VNFFGD_TEMPLATE]
    [--vnf-mapping VNF_MAPPING]
    [--symmetrical]
    [--description DESCRIPTION]
    [--param-file PARAM_FILE]
    <VNFFG>

-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.
--vnffgd-template <VNFFGD_TEMPLATE>: VNFFGD file to update VNFFG
--vnf-mapping <VNF_MAPPING>: List of logical VNFD name to VNF instance name mapping. Example: VNF1:my_vnf1,VNF2:my_vnf2
--symmetrical: Should a reverse path be created for the NFP
--description <DESCRIPTION>: Set a description for the VNFFG
--param-file <PARAM_FILE>: YAML file with specific VNFFG parameters
VNFFG: VNFFG to update (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph show

Display VNFFG details

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

-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.
VNFFG: VNFFG to display (name or ID)

This command is provided by the python-tackerclient plugin.

VNF Forwarding Graph Descriptor (VNFFGD) Management commands

WARNING:: VNF Forwarding Graph Descriptor (VNFFGD) Management commands are deprecated and will be removed in the first major release after the Tacker server version 9.0.0 (2023.1 Antelope release).

vnf graph descriptor create

Create a new VNFFGD

openstack vnf graph descriptor create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    --vnffgd-file VNFFGD_FILE
    [--description DESCRIPTION]
    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
--vnffgd-file <VNFFGD_FILE>: YAML file with VNFFGD parameters
--description <DESCRIPTION>: Set a description for the VNFFGD
NAME: Name for VNFFGD

This command is provided by the python-tackerclient plugin.

vnf graph descriptor delete

Delete VNFFGD(s).

openstack vnf graph descriptor delete <VNFFGD> [<VNFFGD> ...]

VNFFGD: VNFFGD(s) to delete (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph descriptor list

List (VNFFGD)s that belong to a given tenant.

openstack vnf graph descriptor 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]
    [--template-source TEMPLATE_SOURCE]

-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
--template-source <TEMPLATE_SOURCE>: List VNFFGD with specified template source. Available options are 'onboarded' (default), 'inline' or 'all'

This command is provided by the python-tackerclient plugin.

vnf graph descriptor show

Display VNFFGD details

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

-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.
VNFFGD: VNFFGD to display (name or ID)

This command is provided by the python-tackerclient plugin.

vnf graph descriptor template show

Display VNFFGD Template details

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

-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.
VNFFGD: VNFFGD to display (name or ID)

This command is provided by the python-tackerclient plugin.

Service Function Chain (SFC) Management commands

WARNING:: Service Function Chain (SFC) Management commands are deprecated and will be removed in the first major release after the Tacker server version 9.0.0 (2023.1 Antelope release).

vnf chain list

List SFC(s) that belong to a given tenant.

openstack vnf chain 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]
    [--nfp-id NFP_ID]
    [--tenant-id TENANT_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
--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
--nfp-id <NFP_ID>: List SFC(s) with specific nfp id
--tenant-id TENANT_ID: The owner tenant ID or project ID

This command is provided by the python-tackerclient plugin.

vnf chain show

Display SFC details

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

-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.
SFC: SFC to display (name or ID)

This command is provided by the python-tackerclient plugin.

Flow Classifier Management commands

WARNING:: Flow Classifier Management commands are deprecated and will be removed in the first major release after the Tacker server version 9.0.0 (2023.1 Antelope release).

vnf classifier list

List flow classifier(s) that belong to a given tenant.

openstack vnf classifier 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]
    [--nfp-id NFP_ID]
    [--tenant-id TENANT_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
--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
--nfp-id <NFP_ID>: List flow classifier(s) with specific nfp id
--tenant-id TENANT_ID: The owner tenant ID or project ID

This command is provided by the python-tackerclient plugin.

vnf classifier show

Display flow classifier details

openstack vnf classifier show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    <Classifier
    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.
Classifier ID: Flow Classifier to display (name or ID)

This command is provided by the python-tackerclient plugin.

Network Forwarding Path Management commands

WARNING:: Network Forwarding Path Management commands are deprecated and will be removed in the first major release after the Tacker server version 9.0.0 (2023.1 Antelope release).

vnf network forwarding path list

List NFP(s) that belong to a given tenant.

openstack vnf network forwarding path 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]
    [--vnffg-id VNFFG_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
--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
--vnffg-id <VNFFG_ID>: List NFP(s) with specific VNFFG ID

This command is provided by the python-tackerclient plugin.

vnf network forwarding path show

Display NFP details

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

-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.
NFP: NFP to display (name or ID)

This command is provided by the python-tackerclient plugin.

Event Management commands

WARNING:: Event Management commands are deprecated and will be removed in the first major release after the Tacker server version 9.0.0 (2023.1 Antelope release).

nfv event list

List events of resources.

openstack nfv event 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]
    [--id ID]
    [--resource-type RESOURCE_TYPE]
    [--resource-id RESOURCE_ID]
    [--resource-state RESOURCE_STATE]
    [--event-type EVENT_TYPE]
    [--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
--id <ID>: id of the event to look up.
--resource-type <RESOURCE_TYPE>: resource type of the events to look up.
--resource-id <RESOURCE_ID>: resource id of the events to look up.
--resource-state <RESOURCE_STATE>: resource state of the events to look up.
--event-type <EVENT_TYPE>: event type of the events to look up.
--long: List additional fields in output

This command is provided by the python-tackerclient plugin.

nfv event show

Show event given the event id.

openstack nfv event show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    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.
ID: ID of event to display

This command is provided by the python-tackerclient plugin.

Author

OpenStack Contributors

Copyright

OpenStack Contributors

Info

Oct 26, 2023 1.14.0 python-tackerclient