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 list                      List all VNF packages.
openstack vnf package show                      Show package details.
openstack vnf package upload                    Upload a VNF package by providing the address information
                                                of the VNF package.
openstack vnf package delete                    Delete given VNF package(s).

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.

Author

OpenStack Contributors

Info

Mar 22, 2021 1.6.0 python-tackerclient