VNF LCM commands are CLI interface of VNF Lifecycle Management Interface in ETSI NFV-SOL 002 and ETSI NFV-SOL 003.
Note
Commands call version 1 vnflcm APIs by default. You can call the specific version of vnflcm APIs by using the option --os-tacker-api-version. Commands with --os-tacker-api-version 2 call version 2 vnflcm APIs. vnflcm op cancel is included in only version 1 vnflcm APIs and change-vnfpkg is included in only version 2 vnflcm APIs.
Change External VNF Connectivity
openstack vnflcm change-ext-conn <vnf-instance> <param-file>
VNF instance ID to Change External VNF Connectivity
Specify change-ext-conn request parameters in a json file.
This command is provided by the python-tackerclient plugin.
Create a new VNF Instance
openstack vnflcm create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--name <vnf-instance-name>]
[--description <vnf-instance-description>]
[--I <param-file>]
<vnfd-id>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Name of the VNF instance to be created.
Description of the VNF instance to be created.
Instantiate VNF subsequently after it’s creation. Specify instantiate request parameters in a json file.
Identifier that identifies the VNFD which defines the VNF instance to be created.
This command is provided by the python-tackerclient plugin.
Delete VNF Instance(s)
openstack vnflcm delete <vnf-instance> [<vnf-instance> ...]
VNF instance ID(s) to delete
This command is provided by the python-tackerclient plugin.
Heal VNF Instance
openstack vnflcm heal
[--cause CAUSE]
[--vnfc-instance <vnfc-instance-id> [<vnfc-instance-id> ...]]
[--additional-param-file <additional-param-file>]
<vnf-instance>
Specify the reason why a healing procedure is required.
List of VNFC instances requiring a healing action.
Additional parameters passed by the NFVO as input to the healing process.
VNF instance ID to heal
This command is provided by the python-tackerclient plugin.
Instantiate a VNF Instance
openstack vnflcm instantiate <vnf-instance> <param-file>
VNF instance ID to instantiate
Specify instantiate request parameters in a json file.
This command is provided by the python-tackerclient plugin.
List VNF Instance
openstack vnflcm list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
This command is provided by the python-tackerclient plugin.
Cancel VNF Instance
openstack vnflcm op cancel
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--cancel-mode <cancel-mode>]
<vnf-lcm-op-occ-id>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Cancel mode can be ‘GRACEFUL’ or ‘FORCEFUL’. Default is ‘GRACEFUL’
VNF lifecycle management operation occurrence ID.
This command is provided by the python-tackerclient plugin.
Fail VNF Instance
openstack vnflcm op fail
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<vnf-lcm-op-occ-id>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
VNF lifecycle management operation occurrence ID.
This command is provided by the python-tackerclient plugin.
List LCM Operation Occurrences
openstack vnflcm op list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--filter <filter>]
[--fields <fields> | --exclude-fields <exclude-fields>]
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Attribute-based-filtering parameters
Complex attributes to be included into the response
Complex attributes to be excluded from the response
This command is provided by the python-tackerclient plugin.
Retry VNF Instance
openstack vnflcm op retry <vnf-lcm-op-occ-id>
VNF lifecycle management operation occurrence ID.
This command is provided by the python-tackerclient plugin.
openstack vnflcm op rollback <vnf-lcm-op-occ-id>
VNF lifecycle management operation occurrence ID.
This command is provided by the python-tackerclient plugin.
Display Operation Occurrence details
openstack vnflcm op show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<vnf-lcm-op-occ-id>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
VNF lifecycle management operation occurrence ID.
This command is provided by the python-tackerclient plugin.
Scale a VNF Instance
openstack vnflcm scale
[--number-of-steps <number-of-steps>]
[--additional-param-file <additional-param-file>]
--type <type>
--aspect-id <aspect-id>
<vnf-instance>
Number of scaling steps to be executed as part of this Scale VNF operation.
Additional parameters passed by the NFVO as input to the scaling process.
SCALE_OUT or SCALE_IN for type of scale operation.
Identifier of the scaling aspect.
VNF instance ID to scale
This command is provided by the python-tackerclient plugin.
Display VNF instance details
openstack vnflcm show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<vnf-instance>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
VNF instance ID to display
This command is provided by the python-tackerclient plugin.
Create a new Lccn Subscription
openstack vnflcm subsc create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<param-file>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Specify create request parameters in a json file.
This command is provided by the python-tackerclient plugin.
Delete Lccn Subscription(s)
openstack vnflcm subsc delete <subscription-id> [<subscription-id> ...]
Lccn Subscription ID(s) to delete
This command is provided by the python-tackerclient plugin.
List Lccn Subscriptions
openstack vnflcm subsc list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--filter <filter>]
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Attribute-based-filtering parameters
This command is provided by the python-tackerclient plugin.
Display Lccn Subscription details
openstack vnflcm subsc show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<subscription-id>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Lccn Subscription ID to display
This command is provided by the python-tackerclient plugin.
Terminate a VNF instance
openstack vnflcm terminate
[--termination-type <termination-type>]
[--graceful-termination-timeout <graceful-termination-timeout>]
[--D]
<vnf-instance>
Termination type can be ‘GRACEFUL’ or ‘FORCEFUL’. Default is ‘GRACEFUL’
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.
Delete VNF Instance subsequently after it’s termination
VNF instance ID to terminate
This command is provided by the python-tackerclient plugin.
Update VNF Instance
openstack vnflcm update [--I <param-file>] <vnf-instance>
Specify update request parameters in a json file.
VNF instance ID to update.
This command is provided by the python-tackerclient plugin.
Show VnfLcm Api versions
openstack vnflcm versions
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--major-version <major-version>]
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Show only specify major version.
This command is provided by the python-tackerclient plugin.
Change Current VNF Package
openstack vnflcm change-vnfpkg <vnf-instance> <param-file>
VNF instance ID to Change Current VNF Package
Specify change-vnfpkg request parameters in a json file.
This command is provided by the python-tackerclient plugin.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.