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 (VNFFG) Management commands

VNF Forwarding Graph (VNFFG) Management commands¶

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¶

python-tackerclient 1.13.1.dev3

Page Contents