VNF Management commands¶

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

VNF Management commands¶

vnf chain list¶

vnf chain show¶

vnf classifier list¶

vnf classifier show¶

vnf create¶

vnf delete¶

vnf descriptor create¶

vnf descriptor delete¶

vnf descriptor list¶

vnf descriptor show¶

vnf descriptor template show¶

vnf graph create¶

vnf graph delete¶

vnf graph descriptor create¶

vnf graph descriptor delete¶

vnf graph descriptor list¶

vnf graph descriptor show¶

vnf graph descriptor template show¶

vnf graph list¶

vnf graph set¶

vnf graph show¶

vnf list¶

vnf network forwarding path list¶

vnf network forwarding path show¶

vnf package artifact download¶

vnf package create¶

vnf package delete¶

vnf package download¶

vnf package list¶

vnf package show¶

vnf package update¶

vnf package upload¶

vnf resource list¶

vnf scale¶

vnf set¶

vnf show¶

python-tackerclient 1.12.1.dev3

Page Contents