1TACKER(1) python-tackerclient TACKER(1)
2
6 tacker - Client for Tacker API
7
9 Command List
10 The following list covers the extended commands for Tacker services
11 available in openstack command.
12 These commands can be referenced by doing openstack help and the detail
14 of individual command can be referred by openstack help <command-name>.
15 openstack vnf create Create a VNF.
17 openstack vnf delete Delete given VNF(s).
18 openstack vnf list List VNF(s) that belong to a given tenant.
19 openstack vnf resource list List resources of a VNF like VDU, CP, etc.
20 openstack vnf scale Scale a VNF.
21 openstack vnf show Show information of a given VNF.
22 openstack vnf set Update a given VNF.
23 openstack vnf descriptor create Create a VNFD.
24 openstack vnf descriptor delete Delete given VNFD(s).
25 openstack vnf descriptor list List VNFD(s) that belong to a given tenant.
26 openstack vnf descriptor show Show information of a given VNFD.
27 openstack vnf descriptor template show Show template of a given VNFD.
28 openstack vim list List VIM(s) that belong to a given tenant.
29 openstack vim register Create a VIM.
30 openstack vim show Show information of a given VIM.
31 openstack vim set Update a given VIM.
32 openstack vim delete Delete given VIM(s).
33 openstack ns create Create a NS.
34 openstack ns delete Delete given NS(s).
35 openstack ns list List NS that belong to a given tenant.
36 openstack ns show Show information of a given NS.
37 openstack ns descriptor create Create a NSD.
38 openstack ns descriptor delete Delete a given NSD.
39 openstack ns descriptor list List NSD(s) that belong to a given tenant.
40 openstack ns descriptor show Show information of a given NSD.
41 openstack ns descriptor template show Show template of a given NSD.
42 openstack vnf graph create Create a VNFFG.
43 openstack vnf graph delete Delete a given VNFFG.
44 openstack vnf graph list List VNFFG(s) that belong to a given tenant.
45 openstack vnf graph show Show information of a given VNFFG.
46 openstack vnf graph set Update a given VNFFG.
47 openstack vnf graph descriptor create Create a VNFFGD.
48 openstack vnf graph descriptor delete Delete a given VNFFGD.
49 openstack vnf graph descriptor list List VNFFGD(s) that belong to a given tenant.
50 openstack vnf graph descriptor show Show information of a given VNFFGD.
51 openstack vnf graph descriptor template show Show template of a given VNFFGD.
52 openstack vnf chain list List SFC(s) that belong to a given tenant.
53 openstack vnf chain show Show information of a given SFC.
54 openstack vnf classifier list List FC(s) that belong to a given tenant.
55 openstack vnf classifier show Show information of a given FC.
56 openstack vnf network forwarding path list List NFP(s) that belong to a given tenant.
57 openstack vnf network forwarding path show Show information of a given NFP.
58 openstack nfv event show Show event given the event id.
59 openstack nfv event list List events of resources.
60 openstack vnf package create Create a new individual VNF package resource.
61 openstack vnf package delete Delete given VNF package(s).
62 openstack vnf package list List all VNF packages.
63 openstack vnf package show Show package details.
64 openstack vnf package upload Upload a VNF package.
65 openstack vnf package download Download a VNF package.
66 openstack vnf package artifact download Download a VNF package artifact.
67 openstack vnf package update Update a state of a VNF package.
68 openstack vnflcm create Create a new VNF instance resource.
69 openstack vnflcm instantiate Instantiate a VNF instance.
70 openstack vnflcm list List VNF instance.
71 openstack vnflcm show Show VNF instance.
72 openstack vnflcm terminate Terminate a VNF instance.
73 openstack vnflcm delete Delete a VNF instance resource.
74 openstack vnflcm heal Heal a VNF instance.
75 openstack vnflcm update Update information of a VNF instance.
76 openstack vnflcm scale Scale a VNF instance.
77 openstack vnflcm change-ext-conn Change external VNF connectivity.
78 openstack vnflcm change-vnfpkg Change current VNF package.
79 openstack vnflcm op rollback Rollback a VNF LCM operation occurrence.
80 openstack vnflcm op retry Retry a VNF LCM operation occurrence.
81 openstack vnflcm op fail Fail a VNF LCM operation occurrence.
82 openstack vnflcm op list List VNF LCM operation occurrence.
83 openstack vnflcm op show Show VNF LCM operation occurrence.
84 openstack vnflcm op cancel Cancel a VNF LCM operation occurrence.
85 openstack vnflcm versions Show VNF LCM API versions.
86 openstack vnflcm subsc create Create new subscription.
87 openstack vnflcm subsc delete Delete subscription.
88 openstack vnflcm subsc list List subscription.
89 openstack vnflcm subsc show Show subscription.
90 openstack vnffm alarm list List alarm.
91 openstack vnffm alarm show Show alarm.
92 openstack vnffm alarm update Update alarm.
93 openstack vnffm sub create Create FM subscription.
94 openstack vnffm sub list List FM subscription.
95 openstack vnffm sub show Show FM subscription.
96 openstack vnffm sub delete Delete FM subscription.
97 openstack vnfpm job create Create PM job.
98 openstack vnfpm job list List PM job.
99 openstack vnfpm job show Show PM job.
100 openstack vnfpm job update Update PM job.
101 openstack vnfpm job delete Delete PM job.
102 openstack vnfpm report show Show PM report.
103 openstack vnfpm threshold create Create PM threshold.
104 openstack vnfpm threshold list List PM threshold.
105 openstack vnfpm threshold show Show PM threshold.
106 openstack vnfpm threshold update Update PM threshold.
107 openstack vnfpm threshold delete Delete PM threshold.
108
110 VNF Package commands
111 VNF Package commands are CLI interface of VNF Package Management Inter‐
112 face in ETSI NFV-SOL 005.
113 vnf package artifact download
115 Download VNF package artifact of an on-boarded VNF package.
116 openstack vnf package artifact download
118 [--file <FILE>]
119 <vnf-package>
120 <artifact-path>
121 --file <FILE>
123 Local file to save downloaded VNF Package artifact file data. If
124 this is not specified and there is no redirection then data will
125 not be saved.
126 vnf-package
128 VNF package ID
129 artifact-path
131 The artifact file's path
132 This command is provided by the python-tackerclient plugin.
134 vnf package create
136 Create a new VNF Package
137 openstack vnf package create
139 [-f {json,shell,table,value,yaml}]
140 [-c COLUMN]
141 [--noindent]
142 [--prefix PREFIX]
143 [--max-width <integer>]
144 [--fit-width]
145 [--print-empty]
146 [--user-data <key=value>]
147 -f <FORMATTER>, --format <FORMATTER>
149 the output format, defaults to table
150 -c COLUMN, --column COLUMN
152 specify the column(s) to include, can be repeated to show multi‐
153 ple columns
154 --noindent
156 whether to disable indenting the JSON
157 --prefix <PREFIX>
159 add a prefix to all variable names
160 --max-width <integer>
162 Maximum display width, <1 to disable. You can also use the
163 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
164 takes precedence.
165 --fit-width
167 Fit the table to the display width. Implied if --max-width
168 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
169 to always enable
170 --print-empty
172 Print empty table if there is no data to show.
173 --user-data <key=value>
175 User defined data for the VNF package (repeat option to set mul‐
176 tiple user defined data)
177 This command is provided by the python-tackerclient plugin.
179 vnf package delete
181 Delete VNF Package
182 openstack vnf package delete <vnf-package> [<vnf-package> ...]
184 vnf-package
186 Vnf package(s) ID to delete
187 This command is provided by the python-tackerclient plugin.
189 vnf package download
191 Download VNF package contents or VNFD of an on-boarded VNF package.
192 openstack vnf package download
194 [--file <FILE>]
195 [--vnfd]
196 [--type <type>]
197 <vnf-package>
198 --file <FILE>
200 Local file to save downloaded VNF Package or VNFD data. If this
201 is not specified and there is no redirection then data will not
202 be saved.
203 --vnfd Download VNFD of an on-boarded vnf package.
205 --type <type>
207 Provide text/plain when VNFD is implemented as a single YAML
208 file otherwise use application/zip. If you are not aware
209 whether VNFD is a single or multiple yaml files, then you can
210 specify 'both' option value. Provide this option only when
211 --vnfd is set.
212 vnf-package
214 VNF package ID
215 This command is provided by the python-tackerclient plugin.
217 vnf package list
219 List VNF Packages
220 openstack vnf package list
222 [-f {csv,json,table,value,yaml}]
223 [-c COLUMN]
224 [--quote {all,minimal,none,nonnumeric}]
225 [--noindent]
226 [--max-width <integer>]
227 [--fit-width]
228 [--print-empty]
229 [--sort-column SORT_COLUMN]
230 [--sort-ascending | --sort-descending]
231 [--filter <filter>]
232 [--all_fields | --fields fields | --exclude_fields exclude-fields]
233 [--exclude_default]
234 -f <FORMATTER>, --format <FORMATTER>
236 the output format, defaults to table
237 -c COLUMN, --column COLUMN
239 specify the column(s) to include, can be repeated to show multi‐
240 ple columns
241 --quote <QUOTE_MODE>
243 when to include quotes, defaults to nonnumeric
244 --noindent
246 whether to disable indenting the JSON
247 --max-width <integer>
249 Maximum display width, <1 to disable. You can also use the
250 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
251 takes precedence.
252 --fit-width
254 Fit the table to the display width. Implied if --max-width
255 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
256 to always enable
257 --print-empty
259 Print empty table if there is no data to show.
260 --sort-column SORT_COLUMN
262 specify the column(s) to sort the data (columns specified first
263 have a priority, non-existing columns are ignored), can be re‐
264 peated
265 --sort-ascending
267 sort the column(s) in ascending order
268 --sort-descending
270 sort the column(s) in descending order
271 --filter <filter>
273 Atrribute-based-filtering parameters
274 --all_fields
276 Include all complex attributes in the response
277 --fields fields
279 Complex attributes to be included into the response
280 --exclude_fields exclude-fields
282 Complex attributes to be excluded from the response
283 --exclude_default
285 Indicates to exclude all complex attributes from the response.
286 This argument can be used alone or with --fields and --filter.
287 For all other combinations tacker server will throw bad request
288 error
289 This command is provided by the python-tackerclient plugin.
291 vnf package show
293 Show VNF Package Details
294 openstack vnf package show
296 [-f {json,shell,table,value,yaml}]
297 [-c COLUMN]
298 [--noindent]
299 [--prefix PREFIX]
300 [--max-width <integer>]
301 [--fit-width]
302 [--print-empty]
303 <vnf-package>
304 -f <FORMATTER>, --format <FORMATTER>
306 the output format, defaults to table
307 -c COLUMN, --column COLUMN
309 specify the column(s) to include, can be repeated to show multi‐
310 ple columns
311 --noindent
313 whether to disable indenting the JSON
314 --prefix <PREFIX>
316 add a prefix to all variable names
317 --max-width <integer>
319 Maximum display width, <1 to disable. You can also use the
320 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
321 takes precedence.
322 --fit-width
324 Fit the table to the display width. Implied if --max-width
325 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
326 to always enable
327 --print-empty
329 Print empty table if there is no data to show.
330 vnf-package
332 VNF package ID
333 This command is provided by the python-tackerclient plugin.
335 vnf package update
337 Update information about an individual VNF package
338 openstack vnf package update
340 [-f {json,shell,table,value,yaml}]
341 [-c COLUMN]
342 [--noindent]
343 [--prefix PREFIX]
344 [--max-width <integer>]
345 [--fit-width]
346 [--print-empty]
347 [--operational-state <operational-state>]
348 [--user-data <key=value>]
349 <vnf-package>
350 -f <FORMATTER>, --format <FORMATTER>
352 the output format, defaults to table
353 -c COLUMN, --column COLUMN
355 specify the column(s) to include, can be repeated to show multi‐
356 ple columns
357 --noindent
359 whether to disable indenting the JSON
360 --prefix <PREFIX>
362 add a prefix to all variable names
363 --max-width <integer>
365 Maximum display width, <1 to disable. You can also use the
366 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
367 takes precedence.
368 --fit-width
370 Fit the table to the display width. Implied if --max-width
371 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
372 to always enable
373 --print-empty
375 Print empty table if there is no data to show.
376 --operational-state <operational-state>
378 Change the operational state of VNF Package, Valid values are
379 'ENABLED' or 'DISABLED'.
380 --user-data <key=value>
382 User defined data for the VNF package (repeat option to set mul‐
383 tiple user defined data)
384 vnf-package
386 VNF package ID
387 This command is provided by the python-tackerclient plugin.
389 vnf package upload
391 Upload VNF Package
392 openstack vnf package upload
394 (--path <file> | --url <Uri>)
395 [--user-name <user-name>]
396 [--password <password>]
397 <vnf-package>
398 --path <file>
400 Upload VNF CSAR package from local file
401 --url <Uri>
403 Uri of the VNF package content
404 --user-name <user-name>
406 User name for authentication
407 --password <password>
409 Password for authentication
410 vnf-package
412 VNF package ID
413 This command is provided by the python-tackerclient plugin.
415 VNF Lcm commands
417 VNF LCM commands are CLI interface of VNF Lifecycle Management Inter‐
418 face in ETSI NFV-SOL 002 and ETSI NFV-SOL 003.
419 NOTE:
421 Commands call version 1 vnflcm APIs by default. You can call the
422 specific version of vnflcm APIs by using the option
423 --os-tacker-api-version. Commands with --os-tacker-api-version 2
424 call version 2 vnflcm APIs. vnflcm op cancel is included in only
425 version 1 vnflcm APIs and change-vnfpkg is included in only version
426 2 vnflcm APIs.
427 vnflcm change-ext-conn
429 Change External VNF Connectivity
430 openstack vnflcm change-ext-conn <vnf-instance> <param-file>
432 vnf-instance
434 VNF instance ID to Change External VNF Connectivity
435 param-file
437 Specify change-ext-conn request parameters in a json file.
438 This command is provided by the python-tackerclient plugin.
440 vnflcm create
442 Create a new VNF Instance
443 openstack vnflcm create
445 [-f {json,shell,table,value,yaml}]
446 [-c COLUMN]
447 [--noindent]
448 [--prefix PREFIX]
449 [--max-width <integer>]
450 [--fit-width]
451 [--print-empty]
452 [--name <vnf-instance-name>]
453 [--description <vnf-instance-description>]
454 [--I <param-file>]
455 <vnfd-id>
456 -f <FORMATTER>, --format <FORMATTER>
458 the output format, defaults to table
459 -c COLUMN, --column COLUMN
461 specify the column(s) to include, can be repeated to show multi‐
462 ple columns
463 --noindent
465 whether to disable indenting the JSON
466 --prefix <PREFIX>
468 add a prefix to all variable names
469 --max-width <integer>
471 Maximum display width, <1 to disable. You can also use the
472 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
473 takes precedence.
474 --fit-width
476 Fit the table to the display width. Implied if --max-width
477 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
478 to always enable
479 --print-empty
481 Print empty table if there is no data to show.
482 --name <vnf-instance-name>
484 Name of the VNF instance to be created.
485 --description <vnf-instance-description>
487 Description of the VNF instance to be created.
488 --I <param-file>
490 Instantiate VNF subsequently after it's creation. Specify in‐
491 stantiate request parameters in a json file.
492 vnfd-id
494 Identifier that identifies the VNFD which defines the VNF in‐
495 stance to be created.
496 This command is provided by the python-tackerclient plugin.
498 vnflcm delete
500 Delete VNF Instance(s)
501 openstack vnflcm delete <vnf-instance> [<vnf-instance> ...]
503 vnf-instance
505 VNF instance ID(s) to delete
506 This command is provided by the python-tackerclient plugin.
508 vnflcm heal
510 Heal VNF Instance
511 openstack vnflcm heal
513 [--cause CAUSE]
514 [--vnfc-instance <vnfc-instance-id> [<vnfc-instance-id> ...]]
515 [--additional-param-file <additional-param-file>]
516 <vnf-instance>
517 --cause <CAUSE>
519 Specify the reason why a healing procedure is required.
520 --vnfc-instance <vnfc-instance-id>
522 List of VNFC instances requiring a healing action.
523 --additional-param-file <additional-param-file>
525 Additional parameters passed by the NFVO as input to the healing
526 process.
527 vnf-instance
529 VNF instance ID to heal
530 This command is provided by the python-tackerclient plugin.
532 vnflcm instantiate
534 Instantiate a VNF Instance
535 openstack vnflcm instantiate <vnf-instance> <param-file>
537 vnf-instance
539 VNF instance ID to instantiate
540 param-file
542 Specify instantiate request parameters in a json file.
543 This command is provided by the python-tackerclient plugin.
545 vnflcm list
547 List VNF Instance
548 openstack vnflcm list
550 [-f {csv,json,table,value,yaml}]
551 [-c COLUMN]
552 [--quote {all,minimal,none,nonnumeric}]
553 [--noindent]
554 [--max-width <integer>]
555 [--fit-width]
556 [--print-empty]
557 [--sort-column SORT_COLUMN]
558 [--sort-ascending | --sort-descending]
559 -f <FORMATTER>, --format <FORMATTER>
561 the output format, defaults to table
562 -c COLUMN, --column COLUMN
564 specify the column(s) to include, can be repeated to show multi‐
565 ple columns
566 --quote <QUOTE_MODE>
568 when to include quotes, defaults to nonnumeric
569 --noindent
571 whether to disable indenting the JSON
572 --max-width <integer>
574 Maximum display width, <1 to disable. You can also use the
575 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
576 takes precedence.
577 --fit-width
579 Fit the table to the display width. Implied if --max-width
580 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
581 to always enable
582 --print-empty
584 Print empty table if there is no data to show.
585 --sort-column SORT_COLUMN
587 specify the column(s) to sort the data (columns specified first
588 have a priority, non-existing columns are ignored), can be re‐
589 peated
590 --sort-ascending
592 sort the column(s) in ascending order
593 --sort-descending
595 sort the column(s) in descending order
596 This command is provided by the python-tackerclient plugin.
598 vnflcm op cancel
600 Cancel VNF Instance
601 openstack vnflcm op cancel
603 [-f {json,shell,table,value,yaml}]
604 [-c COLUMN]
605 [--noindent]
606 [--prefix PREFIX]
607 [--max-width <integer>]
608 [--fit-width]
609 [--print-empty]
610 [--cancel-mode <cancel-mode>]
611 <vnf-lcm-op-occ-id>
612 -f <FORMATTER>, --format <FORMATTER>
614 the output format, defaults to table
615 -c COLUMN, --column COLUMN
617 specify the column(s) to include, can be repeated to show multi‐
618 ple columns
619 --noindent
621 whether to disable indenting the JSON
622 --prefix <PREFIX>
624 add a prefix to all variable names
625 --max-width <integer>
627 Maximum display width, <1 to disable. You can also use the
628 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
629 takes precedence.
630 --fit-width
632 Fit the table to the display width. Implied if --max-width
633 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
634 to always enable
635 --print-empty
637 Print empty table if there is no data to show.
638 --cancel-mode <cancel-mode>
640 Cancel mode can be 'GRACEFUL' or 'FORCEFUL'. Default is 'GRACE‐
641 FUL'
642 vnf-lcm-op-occ-id
644 VNF lifecycle management operation occurrence ID.
645 This command is provided by the python-tackerclient plugin.
647 vnflcm op fail
649 Fail VNF Instance
650 openstack vnflcm op fail
652 [-f {json,shell,table,value,yaml}]
653 [-c COLUMN]
654 [--noindent]
655 [--prefix PREFIX]
656 [--max-width <integer>]
657 [--fit-width]
658 [--print-empty]
659 <vnf-lcm-op-occ-id>
660 -f <FORMATTER>, --format <FORMATTER>
662 the output format, defaults to table
663 -c COLUMN, --column COLUMN
665 specify the column(s) to include, can be repeated to show multi‐
666 ple columns
667 --noindent
669 whether to disable indenting the JSON
670 --prefix <PREFIX>
672 add a prefix to all variable names
673 --max-width <integer>
675 Maximum display width, <1 to disable. You can also use the
676 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
677 takes precedence.
678 --fit-width
680 Fit the table to the display width. Implied if --max-width
681 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
682 to always enable
683 --print-empty
685 Print empty table if there is no data to show.
686 vnf-lcm-op-occ-id
688 VNF lifecycle management operation occurrence ID.
689 This command is provided by the python-tackerclient plugin.
691 vnflcm op list
693 List LCM Operation Occurrences
694 openstack vnflcm op list
696 [-f {csv,json,table,value,yaml}]
697 [-c COLUMN]
698 [--quote {all,minimal,none,nonnumeric}]
699 [--noindent]
700 [--max-width <integer>]
701 [--fit-width]
702 [--print-empty]
703 [--sort-column SORT_COLUMN]
704 [--sort-ascending | --sort-descending]
705 [--filter <filter>]
706 [--fields <fields> | --exclude-fields <exclude-fields>]
707 -f <FORMATTER>, --format <FORMATTER>
709 the output format, defaults to table
710 -c COLUMN, --column COLUMN
712 specify the column(s) to include, can be repeated to show multi‐
713 ple columns
714 --quote <QUOTE_MODE>
716 when to include quotes, defaults to nonnumeric
717 --noindent
719 whether to disable indenting the JSON
720 --max-width <integer>
722 Maximum display width, <1 to disable. You can also use the
723 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
724 takes precedence.
725 --fit-width
727 Fit the table to the display width. Implied if --max-width
728 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
729 to always enable
730 --print-empty
732 Print empty table if there is no data to show.
733 --sort-column SORT_COLUMN
735 specify the column(s) to sort the data (columns specified first
736 have a priority, non-existing columns are ignored), can be re‐
737 peated
738 --sort-ascending
740 sort the column(s) in ascending order
741 --sort-descending
743 sort the column(s) in descending order
744 --filter <filter>
746 Attribute-based-filtering parameters
747 --fields <fields>
749 Complex attributes to be included into the response
750 --exclude-fields <exclude-fields>
752 Complex attributes to be excluded from the response
753 This command is provided by the python-tackerclient plugin.
755 vnflcm op retry
757 Retry VNF Instance
758 openstack vnflcm op retry <vnf-lcm-op-occ-id>
760 vnf-lcm-op-occ-id
762 VNF lifecycle management operation occurrence ID.
763 This command is provided by the python-tackerclient plugin.
765 vnflcm op rollback
767 openstack vnflcm op rollback <vnf-lcm-op-occ-id>
768 vnf-lcm-op-occ-id
770 VNF lifecycle management operation occurrence ID.
771 This command is provided by the python-tackerclient plugin.
773 vnflcm op show
775 Display Operation Occurrence details
776 openstack vnflcm op show
778 [-f {json,shell,table,value,yaml}]
779 [-c COLUMN]
780 [--noindent]
781 [--prefix PREFIX]
782 [--max-width <integer>]
783 [--fit-width]
784 [--print-empty]
785 <vnf-lcm-op-occ-id>
786 -f <FORMATTER>, --format <FORMATTER>
788 the output format, defaults to table
789 -c COLUMN, --column COLUMN
791 specify the column(s) to include, can be repeated to show multi‐
792 ple columns
793 --noindent
795 whether to disable indenting the JSON
796 --prefix <PREFIX>
798 add a prefix to all variable names
799 --max-width <integer>
801 Maximum display width, <1 to disable. You can also use the
802 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
803 takes precedence.
804 --fit-width
806 Fit the table to the display width. Implied if --max-width
807 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
808 to always enable
809 --print-empty
811 Print empty table if there is no data to show.
812 vnf-lcm-op-occ-id
814 VNF lifecycle management operation occurrence ID.
815 This command is provided by the python-tackerclient plugin.
817 vnflcm scale
819 Scale a VNF Instance
820 openstack vnflcm scale
822 [--number-of-steps <number-of-steps>]
823 [--additional-param-file <additional-param-file>]
824 --type <type>
825 --aspect-id <aspect-id>
826 <vnf-instance>
827 --number-of-steps <number-of-steps>
829 Number of scaling steps to be executed as part of this Scale VNF
830 operation.
831 --additional-param-file <additional-param-file>
833 Additional parameters passed by the NFVO as input to the scaling
834 process.
835 --type <type>
837 SCALE_OUT or SCALE_IN for type of scale operation.
838 --aspect-id <aspect-id>
840 Identifier of the scaling aspect.
841 vnf-instance
843 VNF instance ID to scale
844 This command is provided by the python-tackerclient plugin.
846 vnflcm show
848 Display VNF instance details
849 openstack vnflcm show
851 [-f {json,shell,table,value,yaml}]
852 [-c COLUMN]
853 [--noindent]
854 [--prefix PREFIX]
855 [--max-width <integer>]
856 [--fit-width]
857 [--print-empty]
858 <vnf-instance>
859 -f <FORMATTER>, --format <FORMATTER>
861 the output format, defaults to table
862 -c COLUMN, --column COLUMN
864 specify the column(s) to include, can be repeated to show multi‐
865 ple columns
866 --noindent
868 whether to disable indenting the JSON
869 --prefix <PREFIX>
871 add a prefix to all variable names
872 --max-width <integer>
874 Maximum display width, <1 to disable. You can also use the
875 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
876 takes precedence.
877 --fit-width
879 Fit the table to the display width. Implied if --max-width
880 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
881 to always enable
882 --print-empty
884 Print empty table if there is no data to show.
885 vnf-instance
887 VNF instance ID to display
888 This command is provided by the python-tackerclient plugin.
890 vnflcm subsc create
892 Create a new Lccn Subscription
893 openstack vnflcm subsc create
895 [-f {json,shell,table,value,yaml}]
896 [-c COLUMN]
897 [--noindent]
898 [--prefix PREFIX]
899 [--max-width <integer>]
900 [--fit-width]
901 [--print-empty]
902 <param-file>
903 -f <FORMATTER>, --format <FORMATTER>
905 the output format, defaults to table
906 -c COLUMN, --column COLUMN
908 specify the column(s) to include, can be repeated to show multi‐
909 ple columns
910 --noindent
912 whether to disable indenting the JSON
913 --prefix <PREFIX>
915 add a prefix to all variable names
916 --max-width <integer>
918 Maximum display width, <1 to disable. You can also use the
919 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
920 takes precedence.
921 --fit-width
923 Fit the table to the display width. Implied if --max-width
924 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
925 to always enable
926 --print-empty
928 Print empty table if there is no data to show.
929 param-file
931 Specify create request parameters in a json file.
932 This command is provided by the python-tackerclient plugin.
934 vnflcm subsc delete
936 Delete Lccn Subscription(s)
937 openstack vnflcm subsc delete <subscription-id> [<subscription-id> ...]
939 subscription-id
941 Lccn Subscription ID(s) to delete
942 This command is provided by the python-tackerclient plugin.
944 vnflcm subsc list
946 List Lccn Subscriptions
947 openstack vnflcm subsc list
949 [-f {csv,json,table,value,yaml}]
950 [-c COLUMN]
951 [--quote {all,minimal,none,nonnumeric}]
952 [--noindent]
953 [--max-width <integer>]
954 [--fit-width]
955 [--print-empty]
956 [--sort-column SORT_COLUMN]
957 [--sort-ascending | --sort-descending]
958 [--filter <filter>]
959 -f <FORMATTER>, --format <FORMATTER>
961 the output format, defaults to table
962 -c COLUMN, --column COLUMN
964 specify the column(s) to include, can be repeated to show multi‐
965 ple columns
966 --quote <QUOTE_MODE>
968 when to include quotes, defaults to nonnumeric
969 --noindent
971 whether to disable indenting the JSON
972 --max-width <integer>
974 Maximum display width, <1 to disable. You can also use the
975 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
976 takes precedence.
977 --fit-width
979 Fit the table to the display width. Implied if --max-width
980 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
981 to always enable
982 --print-empty
984 Print empty table if there is no data to show.
985 --sort-column SORT_COLUMN
987 specify the column(s) to sort the data (columns specified first
988 have a priority, non-existing columns are ignored), can be re‐
989 peated
990 --sort-ascending
992 sort the column(s) in ascending order
993 --sort-descending
995 sort the column(s) in descending order
996 --filter <filter>
998 Attribute-based-filtering parameters
999 This command is provided by the python-tackerclient plugin.
1001 vnflcm subsc show
1003 Display Lccn Subscription details
1004 openstack vnflcm subsc show
1006 [-f {json,shell,table,value,yaml}]
1007 [-c COLUMN]
1008 [--noindent]
1009 [--prefix PREFIX]
1010 [--max-width <integer>]
1011 [--fit-width]
1012 [--print-empty]
1013 <subscription-id>
1014 -f <FORMATTER>, --format <FORMATTER>
1016 the output format, defaults to table
1017 -c COLUMN, --column COLUMN
1019 specify the column(s) to include, can be repeated to show multi‐
1020 ple columns
1021 --noindent
1023 whether to disable indenting the JSON
1024 --prefix <PREFIX>
1026 add a prefix to all variable names
1027 --max-width <integer>
1029 Maximum display width, <1 to disable. You can also use the
1030 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1031 takes precedence.
1032 --fit-width
1034 Fit the table to the display width. Implied if --max-width
1035 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1036 to always enable
1037 --print-empty
1039 Print empty table if there is no data to show.
1040 subscription-id
1042 Lccn Subscription ID to display
1043 This command is provided by the python-tackerclient plugin.
1045 vnflcm terminate
1047 Terminate a VNF instance
1048 openstack vnflcm terminate
1050 [--termination-type <termination-type>]
1051 [--graceful-termination-timeout <graceful-termination-timeout>]
1052 [--D]
1053 <vnf-instance>
1054 --termination-type <termination-type>
1056 Termination type can be 'GRACEFUL' or 'FORCEFUL'. Default is
1057 'GRACEFUL'
1058 --graceful-termination-timeout <graceful-termination-timeout>
1060 This attribute is only applicable in case of graceful termina‐
1061 tion. It defines the time to wait for the VNF to be taken out of
1062 service before shutting down the VNF and releasing the re‐
1063 sources. The unit is seconds.
1064 --D Delete VNF Instance subsequently after it's termination
1066 vnf-instance
1068 VNF instance ID to terminate
1069 This command is provided by the python-tackerclient plugin.
1071 vnflcm update
1073 Update VNF Instance
1074 openstack vnflcm update [--I <param-file>] <vnf-instance>
1076 --I <param-file>
1078 Specify update request parameters in a json file.
1079 vnf-instance
1081 VNF instance ID to update.
1082 This command is provided by the python-tackerclient plugin.
1084 vnflcm versions
1086 Show VnfLcm Api versions
1087 openstack vnflcm versions
1089 [-f {json,shell,table,value,yaml}]
1090 [-c COLUMN]
1091 [--noindent]
1092 [--prefix PREFIX]
1093 [--max-width <integer>]
1094 [--fit-width]
1095 [--print-empty]
1096 [--major-version <major-version>]
1097 -f <FORMATTER>, --format <FORMATTER>
1099 the output format, defaults to table
1100 -c COLUMN, --column COLUMN
1102 specify the column(s) to include, can be repeated to show multi‐
1103 ple columns
1104 --noindent
1106 whether to disable indenting the JSON
1107 --prefix <PREFIX>
1109 add a prefix to all variable names
1110 --max-width <integer>
1112 Maximum display width, <1 to disable. You can also use the
1113 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1114 takes precedence.
1115 --fit-width
1117 Fit the table to the display width. Implied if --max-width
1118 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1119 to always enable
1120 --print-empty
1122 Print empty table if there is no data to show.
1123 --major-version <major-version>
1125 Show only specify major version.
1126 This command is provided by the python-tackerclient plugin.
1128 vnflcm change-vnfpkg
1130 Change Current VNF Package
1131 openstack vnflcm change-vnfpkg <vnf-instance> <param-file>
1133 vnf-instance
1135 VNF instance ID to Change Current VNF Package
1136 param-file
1138 Specify change-vnfpkg request parameters in a json file.
1139 This command is provided by the python-tackerclient plugin.
1141 VNF FM commands
1143 VNF FM commands are CLI interface of VNF Fault Management interface in
1144 ETSI NFV-SOL 002 and ETSI NFV-SOL 003.
1145 NOTE:
1147 Commands only support calling version 2 vnffm APIs. You can use the
1148 commands with --os-tacker-api-version 2 to call version 2 vnffm
1149 APIs.
1150 vnffm alarm list
1152 List VNF FM alarms
1153 openstack vnffm alarm list
1155 [-f {csv,json,table,value,yaml}]
1156 [-c COLUMN]
1157 [--quote {all,minimal,none,nonnumeric}]
1158 [--noindent]
1159 [--max-width <integer>]
1160 [--fit-width]
1161 [--print-empty]
1162 [--sort-column SORT_COLUMN]
1163 [--sort-ascending | --sort-descending]
1164 [--filter <filter>]
1165 -f <FORMATTER>, --format <FORMATTER>
1167 the output format, defaults to table
1168 -c COLUMN, --column COLUMN
1170 specify the column(s) to include, can be repeated to show multi‐
1171 ple columns
1172 --quote <QUOTE_MODE>
1174 when to include quotes, defaults to nonnumeric
1175 --noindent
1177 whether to disable indenting the JSON
1178 --max-width <integer>
1180 Maximum display width, <1 to disable. You can also use the
1181 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1182 takes precedence.
1183 --fit-width
1185 Fit the table to the display width. Implied if --max-width
1186 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1187 to always enable
1188 --print-empty
1190 Print empty table if there is no data to show.
1191 --sort-column SORT_COLUMN
1193 specify the column(s) to sort the data (columns specified first
1194 have a priority, non-existing columns are ignored), can be re‐
1195 peated
1196 --sort-ascending
1198 sort the column(s) in ascending order
1199 --sort-descending
1201 sort the column(s) in descending order
1202 --filter <filter>
1204 Attribute-based-filtering parameters
1205 This command is provided by the python-tackerclient plugin.
1207 vnffm alarm show
1209 Display VNF FM alarm details
1210 openstack vnffm alarm show
1212 [-f {json,shell,table,value,yaml}]
1213 [-c COLUMN]
1214 [--noindent]
1215 [--prefix PREFIX]
1216 [--max-width <integer>]
1217 [--fit-width]
1218 [--print-empty]
1219 <vnf-fm-alarm-id>
1220 -f <FORMATTER>, --format <FORMATTER>
1222 the output format, defaults to table
1223 -c COLUMN, --column COLUMN
1225 specify the column(s) to include, can be repeated to show multi‐
1226 ple columns
1227 --noindent
1229 whether to disable indenting the JSON
1230 --prefix <PREFIX>
1232 add a prefix to all variable names
1233 --max-width <integer>
1235 Maximum display width, <1 to disable. You can also use the
1236 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1237 takes precedence.
1238 --fit-width
1240 Fit the table to the display width. Implied if --max-width
1241 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1242 to always enable
1243 --print-empty
1245 Print empty table if there is no data to show.
1246 vnf-fm-alarm-id
1248 VNF FM alarm ID to display
1249 This command is provided by the python-tackerclient plugin.
1251 vnffm alarm update
1253 Update information about an individual VNF FM alarm
1254 openstack vnffm alarm update
1256 [-f {json,shell,table,value,yaml}]
1257 [-c COLUMN]
1258 [--noindent]
1259 [--prefix PREFIX]
1260 [--max-width <integer>]
1261 [--fit-width]
1262 [--print-empty]
1263 [--ack-state <ack-state>]
1264 <vnf-fm-alarm-id>
1265 -f <FORMATTER>, --format <FORMATTER>
1267 the output format, defaults to table
1268 -c COLUMN, --column COLUMN
1270 specify the column(s) to include, can be repeated to show multi‐
1271 ple columns
1272 --noindent
1274 whether to disable indenting the JSON
1275 --prefix <PREFIX>
1277 add a prefix to all variable names
1278 --max-width <integer>
1280 Maximum display width, <1 to disable. You can also use the
1281 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1282 takes precedence.
1283 --fit-width
1285 Fit the table to the display width. Implied if --max-width
1286 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1287 to always enable
1288 --print-empty
1290 Print empty table if there is no data to show.
1291 --ack-state <ack-state>
1293 Ask state can be 'ACKNOWLEDGED' or 'UNACKNOWLEDGED'.
1294 vnf-fm-alarm-id
1296 VNF FM alarm ID to update.
1297 This command is provided by the python-tackerclient plugin.
1299 vnffm sub create
1301 Create a new VNF FM subscription
1302 openstack vnffm sub create
1304 [-f {json,shell,table,value,yaml}]
1305 [-c COLUMN]
1306 [--noindent]
1307 [--prefix PREFIX]
1308 [--max-width <integer>]
1309 [--fit-width]
1310 [--print-empty]
1311 <param-file>
1312 -f <FORMATTER>, --format <FORMATTER>
1314 the output format, defaults to table
1315 -c COLUMN, --column COLUMN
1317 specify the column(s) to include, can be repeated to show multi‐
1318 ple columns
1319 --noindent
1321 whether to disable indenting the JSON
1322 --prefix <PREFIX>
1324 add a prefix to all variable names
1325 --max-width <integer>
1327 Maximum display width, <1 to disable. You can also use the
1328 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1329 takes precedence.
1330 --fit-width
1332 Fit the table to the display width. Implied if --max-width
1333 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1334 to always enable
1335 --print-empty
1337 Print empty table if there is no data to show.
1338 param-file
1340 Specify create VNF FM subscription request parameters in a json
1341 file.
1342 This command is provided by the python-tackerclient plugin.
1344 vnffm sub delete
1346 Delete VNF FM subscription(s)
1347 openstack vnffm sub delete <vnf-fm-sub-id> [<vnf-fm-sub-id> ...]
1349 vnf-fm-sub-id
1351 VNF FM subscription ID(s) to delete
1352 This command is provided by the python-tackerclient plugin.
1354 vnffm sub list
1356 List VNF FM subs
1357 openstack vnffm sub list
1359 [-f {csv,json,table,value,yaml}]
1360 [-c COLUMN]
1361 [--quote {all,minimal,none,nonnumeric}]
1362 [--noindent]
1363 [--max-width <integer>]
1364 [--fit-width]
1365 [--print-empty]
1366 [--sort-column SORT_COLUMN]
1367 [--sort-ascending | --sort-descending]
1368 [--filter <filter>]
1369 -f <FORMATTER>, --format <FORMATTER>
1371 the output format, defaults to table
1372 -c COLUMN, --column COLUMN
1374 specify the column(s) to include, can be repeated to show multi‐
1375 ple columns
1376 --quote <QUOTE_MODE>
1378 when to include quotes, defaults to nonnumeric
1379 --noindent
1381 whether to disable indenting the JSON
1382 --max-width <integer>
1384 Maximum display width, <1 to disable. You can also use the
1385 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1386 takes precedence.
1387 --fit-width
1389 Fit the table to the display width. Implied if --max-width
1390 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1391 to always enable
1392 --print-empty
1394 Print empty table if there is no data to show.
1395 --sort-column SORT_COLUMN
1397 specify the column(s) to sort the data (columns specified first
1398 have a priority, non-existing columns are ignored), can be re‐
1399 peated
1400 --sort-ascending
1402 sort the column(s) in ascending order
1403 --sort-descending
1405 sort the column(s) in descending order
1406 --filter <filter>
1408 Attribute-based-filtering parameters
1409 This command is provided by the python-tackerclient plugin.
1411 vnffm sub show
1413 Display VNF FM subscription details
1414 openstack vnffm sub show
1416 [-f {json,shell,table,value,yaml}]
1417 [-c COLUMN]
1418 [--noindent]
1419 [--prefix PREFIX]
1420 [--max-width <integer>]
1421 [--fit-width]
1422 [--print-empty]
1423 <vnf-fm-sub-id>
1424 -f <FORMATTER>, --format <FORMATTER>
1426 the output format, defaults to table
1427 -c COLUMN, --column COLUMN
1429 specify the column(s) to include, can be repeated to show multi‐
1430 ple columns
1431 --noindent
1433 whether to disable indenting the JSON
1434 --prefix <PREFIX>
1436 add a prefix to all variable names
1437 --max-width <integer>
1439 Maximum display width, <1 to disable. You can also use the
1440 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1441 takes precedence.
1442 --fit-width
1444 Fit the table to the display width. Implied if --max-width
1445 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1446 to always enable
1447 --print-empty
1449 Print empty table if there is no data to show.
1450 vnf-fm-sub-id
1452 VNF FM subscription ID to display
1453 This command is provided by the python-tackerclient plugin.
1455 VNF PM commands
1457 VNF PM commands are CLI interface of VNF Performance Management inter‐
1458 face in ETSI NFV-SOL 002 and ETSI NFV-SOL 003.
1459 NOTE:
1461 Commands only support calling version 2 vnfpm APIs. You can use the
1462 commands with --os-tacker-api-version 2 to call version 2 vnfpm
1463 APIs.
1464 vnfpm job create
1466 Create a new VNF PM job
1467 openstack vnfpm job create
1469 [-f {json,shell,table,value,yaml}]
1470 [-c COLUMN]
1471 [--noindent]
1472 [--prefix PREFIX]
1473 [--max-width <integer>]
1474 [--fit-width]
1475 [--print-empty]
1476 <param-file>
1477 -f <FORMATTER>, --format <FORMATTER>
1479 the output format, defaults to table
1480 -c COLUMN, --column COLUMN
1482 specify the column(s) to include, can be repeated to show multi‐
1483 ple columns
1484 --noindent
1486 whether to disable indenting the JSON
1487 --prefix <PREFIX>
1489 add a prefix to all variable names
1490 --max-width <integer>
1492 Maximum display width, <1 to disable. You can also use the
1493 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1494 takes precedence.
1495 --fit-width
1497 Fit the table to the display width. Implied if --max-width
1498 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1499 to always enable
1500 --print-empty
1502 Print empty table if there is no data to show.
1503 param-file
1505 Specify create VNF PM job request parameters in a json file.
1506 This command is provided by the python-tackerclient plugin.
1508 vnfpm job delete
1510 Delete VNF PM job
1511 openstack vnfpm job delete <vnf-pm-job-id> [<vnf-pm-job-id> ...]
1513 vnf-pm-job-id
1515 VNF PM job ID(s) to delete
1516 This command is provided by the python-tackerclient plugin.
1518 vnfpm job list
1520 List VNF PM jobs
1521 openstack vnfpm job list
1523 [-f {csv,json,table,value,yaml}]
1524 [-c COLUMN]
1525 [--quote {all,minimal,none,nonnumeric}]
1526 [--noindent]
1527 [--max-width <integer>]
1528 [--fit-width]
1529 [--print-empty]
1530 [--sort-column SORT_COLUMN]
1531 [--sort-ascending | --sort-descending]
1532 [--filter <filter>]
1533 [--all_fields | --fields fields | --exclude_fields exclude-fields]
1534 [--exclude_default]
1535 -f <FORMATTER>, --format <FORMATTER>
1537 the output format, defaults to table
1538 -c COLUMN, --column COLUMN
1540 specify the column(s) to include, can be repeated to show multi‐
1541 ple columns
1542 --quote <QUOTE_MODE>
1544 when to include quotes, defaults to nonnumeric
1545 --noindent
1547 whether to disable indenting the JSON
1548 --max-width <integer>
1550 Maximum display width, <1 to disable. You can also use the
1551 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1552 takes precedence.
1553 --fit-width
1555 Fit the table to the display width. Implied if --max-width
1556 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1557 to always enable
1558 --print-empty
1560 Print empty table if there is no data to show.
1561 --sort-column SORT_COLUMN
1563 specify the column(s) to sort the data (columns specified first
1564 have a priority, non-existing columns are ignored), can be re‐
1565 peated
1566 --sort-ascending
1568 sort the column(s) in ascending order
1569 --sort-descending
1571 sort the column(s) in descending order
1572 --filter <filter>
1574 Attribute-based-filtering parameters
1575 --all_fields
1577 Include all complex attributes in the response
1578 --fields fields
1580 Complex attributes to be included into the response
1581 --exclude_fields exclude-fields
1583 Complex attributes to be excluded from the response
1584 --exclude_default
1586 Indicates to exclude all complex attributes from the response.
1587 This argument can be used alone or with --fields and --filter.
1588 For all other combinations tacker server will throw bad request
1589 error
1590 This command is provided by the python-tackerclient plugin.
1592 vnfpm job show
1594 Display VNF PM job details
1595 openstack vnfpm job show
1597 [-f {json,shell,table,value,yaml}]
1598 [-c COLUMN]
1599 [--noindent]
1600 [--prefix PREFIX]
1601 [--max-width <integer>]
1602 [--fit-width]
1603 [--print-empty]
1604 <vnf-pm-job-id>
1605 -f <FORMATTER>, --format <FORMATTER>
1607 the output format, defaults to table
1608 -c COLUMN, --column COLUMN
1610 specify the column(s) to include, can be repeated to show multi‐
1611 ple columns
1612 --noindent
1614 whether to disable indenting the JSON
1615 --prefix <PREFIX>
1617 add a prefix to all variable names
1618 --max-width <integer>
1620 Maximum display width, <1 to disable. You can also use the
1621 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1622 takes precedence.
1623 --fit-width
1625 Fit the table to the display width. Implied if --max-width
1626 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1627 to always enable
1628 --print-empty
1630 Print empty table if there is no data to show.
1631 vnf-pm-job-id
1633 VNF PM job ID to display
1634 This command is provided by the python-tackerclient plugin.
1636 vnfpm job update
1638 Update information about an individual VNF PM job
1639 openstack vnfpm job update
1641 [-f {json,shell,table,value,yaml}]
1642 [-c COLUMN]
1643 [--noindent]
1644 [--prefix PREFIX]
1645 [--max-width <integer>]
1646 [--fit-width]
1647 [--print-empty]
1648 <vnf-pm-job-id>
1649 <param-file>
1650 -f <FORMATTER>, --format <FORMATTER>
1652 the output format, defaults to table
1653 -c COLUMN, --column COLUMN
1655 specify the column(s) to include, can be repeated to show multi‐
1656 ple columns
1657 --noindent
1659 whether to disable indenting the JSON
1660 --prefix <PREFIX>
1662 add a prefix to all variable names
1663 --max-width <integer>
1665 Maximum display width, <1 to disable. You can also use the
1666 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1667 takes precedence.
1668 --fit-width
1670 Fit the table to the display width. Implied if --max-width
1671 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1672 to always enable
1673 --print-empty
1675 Print empty table if there is no data to show.
1676 vnf-pm-job-id
1678 VNF PM job ID to update.
1679 param-file
1681 Specify update PM job request parameters in a json file.
1682 This command is provided by the python-tackerclient plugin.
1684 vnfpm report show
1686 Display VNF PM report details
1687 openstack vnfpm report show
1689 [-f {json,shell,table,value,yaml}]
1690 [-c COLUMN]
1691 [--noindent]
1692 [--prefix PREFIX]
1693 [--max-width <integer>]
1694 [--fit-width]
1695 [--print-empty]
1696 <vnf-pm-job-id>
1697 <vnf-pm-report-id>
1698 -f <FORMATTER>, --format <FORMATTER>
1700 the output format, defaults to table
1701 -c COLUMN, --column COLUMN
1703 specify the column(s) to include, can be repeated to show multi‐
1704 ple columns
1705 --noindent
1707 whether to disable indenting the JSON
1708 --prefix <PREFIX>
1710 add a prefix to all variable names
1711 --max-width <integer>
1713 Maximum display width, <1 to disable. You can also use the
1714 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1715 takes precedence.
1716 --fit-width
1718 Fit the table to the display width. Implied if --max-width
1719 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1720 to always enable
1721 --print-empty
1723 Print empty table if there is no data to show.
1724 vnf-pm-job-id
1726 VNF PM job id where the VNF PM report is located
1727 vnf-pm-report-id
1729 VNF PM report ID to display
1730 This command is provided by the python-tackerclient plugin.
1732 vnfpm threshold create
1734 Create a new VNF PM threshold
1735 openstack vnfpm threshold create
1737 [-f {json,shell,table,value,yaml}]
1738 [-c COLUMN]
1739 [--noindent]
1740 [--prefix PREFIX]
1741 [--max-width <integer>]
1742 [--fit-width]
1743 [--print-empty]
1744 <param-file>
1745 -f <FORMATTER>, --format <FORMATTER>
1747 the output format, defaults to table
1748 -c COLUMN, --column COLUMN
1750 specify the column(s) to include, can be repeated to show multi‐
1751 ple columns
1752 --noindent
1754 whether to disable indenting the JSON
1755 --prefix <PREFIX>
1757 add a prefix to all variable names
1758 --max-width <integer>
1760 Maximum display width, <1 to disable. You can also use the
1761 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1762 takes precedence.
1763 --fit-width
1765 Fit the table to the display width. Implied if --max-width
1766 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1767 to always enable
1768 --print-empty
1770 Print empty table if there is no data to show.
1771 param-file
1773 Specify create VNF PM threshold request parameters in a json
1774 file.
1775 This command is provided by the python-tackerclient plugin.
1777 vnfpm threshold delete
1779 Delete VNF PM threshold
1780 openstack vnfpm threshold delete
1782 <vnf-pm-threshold-id>
1783 [<vnf-pm-threshold-id> ...]
1784 vnf-pm-threshold-id
1786 VNF PM threshold ID(s) to delete
1787 This command is provided by the python-tackerclient plugin.
1789 vnfpm threshold list
1791 List VNF PM thresholds
1792 openstack vnfpm threshold list
1794 [-f {csv,json,table,value,yaml}]
1795 [-c COLUMN]
1796 [--quote {all,minimal,none,nonnumeric}]
1797 [--noindent]
1798 [--max-width <integer>]
1799 [--fit-width]
1800 [--print-empty]
1801 [--sort-column SORT_COLUMN]
1802 [--sort-ascending | --sort-descending]
1803 [--filter <filter>]
1804 -f <FORMATTER>, --format <FORMATTER>
1806 the output format, defaults to table
1807 -c COLUMN, --column COLUMN
1809 specify the column(s) to include, can be repeated to show multi‐
1810 ple columns
1811 --quote <QUOTE_MODE>
1813 when to include quotes, defaults to nonnumeric
1814 --noindent
1816 whether to disable indenting the JSON
1817 --max-width <integer>
1819 Maximum display width, <1 to disable. You can also use the
1820 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1821 takes precedence.
1822 --fit-width
1824 Fit the table to the display width. Implied if --max-width
1825 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1826 to always enable
1827 --print-empty
1829 Print empty table if there is no data to show.
1830 --sort-column SORT_COLUMN
1832 specify the column(s) to sort the data (columns specified first
1833 have a priority, non-existing columns are ignored), can be re‐
1834 peated
1835 --sort-ascending
1837 sort the column(s) in ascending order
1838 --sort-descending
1840 sort the column(s) in descending order
1841 --filter <filter>
1843 Attribute-based-filtering parameters
1844 This command is provided by the python-tackerclient plugin.
1846 vnfpm threshold show
1848 Display VNF PM threshold details
1849 openstack vnfpm threshold show
1851 [-f {json,shell,table,value,yaml}]
1852 [-c COLUMN]
1853 [--noindent]
1854 [--prefix PREFIX]
1855 [--max-width <integer>]
1856 [--fit-width]
1857 [--print-empty]
1858 <vnf-pm-threshold-id>
1859 -f <FORMATTER>, --format <FORMATTER>
1861 the output format, defaults to table
1862 -c COLUMN, --column COLUMN
1864 specify the column(s) to include, can be repeated to show multi‐
1865 ple columns
1866 --noindent
1868 whether to disable indenting the JSON
1869 --prefix <PREFIX>
1871 add a prefix to all variable names
1872 --max-width <integer>
1874 Maximum display width, <1 to disable. You can also use the
1875 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1876 takes precedence.
1877 --fit-width
1879 Fit the table to the display width. Implied if --max-width
1880 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1881 to always enable
1882 --print-empty
1884 Print empty table if there is no data to show.
1885 vnf-pm-threshold-id
1887 VNF PM threshold ID to display
1888 This command is provided by the python-tackerclient plugin.
1890 vnfpm threshold update
1892 Update information about an individual VNF PM threshold
1893 openstack vnfpm threshold update
1895 [-f {json,shell,table,value,yaml}]
1896 [-c COLUMN]
1897 [--noindent]
1898 [--prefix PREFIX]
1899 [--max-width <integer>]
1900 [--fit-width]
1901 [--print-empty]
1902 <vnf-pm-threshold-id>
1903 <param-file>
1904 -f <FORMATTER>, --format <FORMATTER>
1906 the output format, defaults to table
1907 -c COLUMN, --column COLUMN
1909 specify the column(s) to include, can be repeated to show multi‐
1910 ple columns
1911 --noindent
1913 whether to disable indenting the JSON
1914 --prefix <PREFIX>
1916 add a prefix to all variable names
1917 --max-width <integer>
1919 Maximum display width, <1 to disable. You can also use the
1920 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1921 takes precedence.
1922 --fit-width
1924 Fit the table to the display width. Implied if --max-width
1925 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1926 to always enable
1927 --print-empty
1929 Print empty table if there is no data to show.
1930 vnf-pm-threshold-id
1932 VNF PM threshold ID to update.
1933 param-file
1935 Specify update PM threshold request parameters in a json file.
1936 This command is provided by the python-tackerclient plugin.
1938
1940 VNF Management commands
1941 WARNING:
1942 VNF Management commands are deprecated and will be removed in the
1943 first major release after the Tacker server version 9.0.0 (2023.1
1944 Antelope release).
1945 vnf chain list
1947 List SFC(s) that belong to a given tenant.
1948 openstack vnf chain list
1950 [-f {csv,json,table,value,yaml}]
1951 [-c COLUMN]
1952 [--quote {all,minimal,none,nonnumeric}]
1953 [--noindent]
1954 [--max-width <integer>]
1955 [--fit-width]
1956 [--print-empty]
1957 [--sort-column SORT_COLUMN]
1958 [--sort-ascending | --sort-descending]
1959 [--nfp-id NFP_ID]
1960 [--tenant-id TENANT_ID]
1961 -f <FORMATTER>, --format <FORMATTER>
1963 the output format, defaults to table
1964 -c COLUMN, --column COLUMN
1966 specify the column(s) to include, can be repeated to show multi‐
1967 ple columns
1968 --quote <QUOTE_MODE>
1970 when to include quotes, defaults to nonnumeric
1971 --noindent
1973 whether to disable indenting the JSON
1974 --max-width <integer>
1976 Maximum display width, <1 to disable. You can also use the
1977 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
1978 takes precedence.
1979 --fit-width
1981 Fit the table to the display width. Implied if --max-width
1982 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
1983 to always enable
1984 --print-empty
1986 Print empty table if there is no data to show.
1987 --sort-column SORT_COLUMN
1989 specify the column(s) to sort the data (columns specified first
1990 have a priority, non-existing columns are ignored), can be re‐
1991 peated
1992 --sort-ascending
1994 sort the column(s) in ascending order
1995 --sort-descending
1997 sort the column(s) in descending order
1998 --nfp-id <NFP_ID>
2000 List SFC(s) with specific nfp id
2001 --tenant-id TENANT_ID
2003 The owner tenant ID or project ID
2004 This command is provided by the python-tackerclient plugin.
2006 vnf chain show
2008 Display SFC details
2009 openstack vnf chain show
2011 [-f {json,shell,table,value,yaml}]
2012 [-c COLUMN]
2013 [--noindent]
2014 [--prefix PREFIX]
2015 [--max-width <integer>]
2016 [--fit-width]
2017 [--print-empty]
2018 <SFC>
2019 -f <FORMATTER>, --format <FORMATTER>
2021 the output format, defaults to table
2022 -c COLUMN, --column COLUMN
2024 specify the column(s) to include, can be repeated to show multi‐
2025 ple columns
2026 --noindent
2028 whether to disable indenting the JSON
2029 --prefix <PREFIX>
2031 add a prefix to all variable names
2032 --max-width <integer>
2034 Maximum display width, <1 to disable. You can also use the
2035 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2036 takes precedence.
2037 --fit-width
2039 Fit the table to the display width. Implied if --max-width
2040 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2041 to always enable
2042 --print-empty
2044 Print empty table if there is no data to show.
2045 SFC SFC to display (name or ID)
2047 This command is provided by the python-tackerclient plugin.
2049 vnf classifier list
2051 List flow classifier(s) that belong to a given tenant.
2052 openstack vnf classifier list
2054 [-f {csv,json,table,value,yaml}]
2055 [-c COLUMN]
2056 [--quote {all,minimal,none,nonnumeric}]
2057 [--noindent]
2058 [--max-width <integer>]
2059 [--fit-width]
2060 [--print-empty]
2061 [--sort-column SORT_COLUMN]
2062 [--sort-ascending | --sort-descending]
2063 [--nfp-id NFP_ID]
2064 [--tenant-id TENANT_ID]
2065 -f <FORMATTER>, --format <FORMATTER>
2067 the output format, defaults to table
2068 -c COLUMN, --column COLUMN
2070 specify the column(s) to include, can be repeated to show multi‐
2071 ple columns
2072 --quote <QUOTE_MODE>
2074 when to include quotes, defaults to nonnumeric
2075 --noindent
2077 whether to disable indenting the JSON
2078 --max-width <integer>
2080 Maximum display width, <1 to disable. You can also use the
2081 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2082 takes precedence.
2083 --fit-width
2085 Fit the table to the display width. Implied if --max-width
2086 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2087 to always enable
2088 --print-empty
2090 Print empty table if there is no data to show.
2091 --sort-column SORT_COLUMN
2093 specify the column(s) to sort the data (columns specified first
2094 have a priority, non-existing columns are ignored), can be re‐
2095 peated
2096 --sort-ascending
2098 sort the column(s) in ascending order
2099 --sort-descending
2101 sort the column(s) in descending order
2102 --nfp-id <NFP_ID>
2104 List flow classifier(s) with specific nfp id
2105 --tenant-id TENANT_ID
2107 The owner tenant ID or project ID
2108 This command is provided by the python-tackerclient plugin.
2110 vnf classifier show
2112 Display flow classifier details
2113 openstack vnf classifier show
2115 [-f {json,shell,table,value,yaml}]
2116 [-c COLUMN]
2117 [--noindent]
2118 [--prefix PREFIX]
2119 [--max-width <integer>]
2120 [--fit-width]
2121 [--print-empty]
2122 <Classifier
2123 ID>
2124 -f <FORMATTER>, --format <FORMATTER>
2126 the output format, defaults to table
2127 -c COLUMN, --column COLUMN
2129 specify the column(s) to include, can be repeated to show multi‐
2130 ple columns
2131 --noindent
2133 whether to disable indenting the JSON
2134 --prefix <PREFIX>
2136 add a prefix to all variable names
2137 --max-width <integer>
2139 Maximum display width, <1 to disable. You can also use the
2140 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2141 takes precedence.
2142 --fit-width
2144 Fit the table to the display width. Implied if --max-width
2145 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2146 to always enable
2147 --print-empty
2149 Print empty table if there is no data to show.
2150 Classifier ID
2152 Flow Classifier to display (name or ID)
2153 This command is provided by the python-tackerclient plugin.
2155 vnf create
2157 Create a new VNF
2158 openstack vnf create
2160 [-f {json,shell,table,value,yaml}]
2161 [-c COLUMN]
2162 [--noindent]
2163 [--prefix PREFIX]
2164 [--max-width <integer>]
2165 [--fit-width]
2166 [--print-empty]
2167 [--tenant-id TENANT_ID]
2168 (--vnfd-id VNFD_ID | --vnfd-name VNFD_NAME | --vnfd-template VNFD_TEMPLATE)
2169 [--vim-id VIM_ID | --vim-name VIM_NAME]
2170 [--vim-region-name VIM_REGION_NAME]
2171 [--config-file CONFIG_FILE]
2172 [--param-file PARAM_FILE]
2173 [--description DESCRIPTION]
2174 NAME
2175 -f <FORMATTER>, --format <FORMATTER>
2177 the output format, defaults to table
2178 -c COLUMN, --column COLUMN
2180 specify the column(s) to include, can be repeated to show multi‐
2181 ple columns
2182 --noindent
2184 whether to disable indenting the JSON
2185 --prefix <PREFIX>
2187 add a prefix to all variable names
2188 --max-width <integer>
2190 Maximum display width, <1 to disable. You can also use the
2191 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2192 takes precedence.
2193 --fit-width
2195 Fit the table to the display width. Implied if --max-width
2196 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2197 to always enable
2198 --print-empty
2200 Print empty table if there is no data to show.
2201 --tenant-id TENANT_ID
2203 The owner tenant ID or project ID
2204 --vnfd-id <VNFD_ID>
2206 VNFD ID to use as template to create VNF
2207 --vnfd-name <VNFD_NAME>
2209 VNFD Name to use as template to create VNF
2210 --vnfd-template <VNFD_TEMPLATE>
2212 VNFD file to create VNF
2213 --vim-id <VIM_ID>
2215 VIM ID to deploy VNF on specified VIM
2216 --vim-name <VIM_NAME>
2218 VIM name to deploy VNF on specified VIM
2219 --vim-region-name <VIM_REGION_NAME>
2221 VIM Region to deploy VNF on specified VIM
2222 --config-file <CONFIG_FILE>
2224 YAML file with VNF configuration
2225 --param-file <PARAM_FILE>
2227 Specify parameter yaml file
2228 --description <DESCRIPTION>
2230 Set description for the VNF
2231 NAME Set a name for the VNF
2233 This command is provided by the python-tackerclient plugin.
2235 vnf delete
2237 Delete VNF(s).
2238 openstack vnf delete [--force] <VNF> [<VNF> ...]
2240 --force
2242 Force delete VNF instance
2243 VNF VNF(s) to delete (name or ID)
2245 This command is provided by the python-tackerclient plugin.
2247 vnf descriptor create
2249 Create a new VNFD
2250 openstack vnf descriptor create
2252 [-f {json,shell,table,value,yaml}]
2253 [-c COLUMN]
2254 [--noindent]
2255 [--prefix PREFIX]
2256 [--max-width <integer>]
2257 [--fit-width]
2258 [--print-empty]
2259 [--tenant-id TENANT_ID]
2260 --vnfd-file VNFD_FILE
2261 [--description DESCRIPTION]
2262 NAME
2263 -f <FORMATTER>, --format <FORMATTER>
2265 the output format, defaults to table
2266 -c COLUMN, --column COLUMN
2268 specify the column(s) to include, can be repeated to show multi‐
2269 ple columns
2270 --noindent
2272 whether to disable indenting the JSON
2273 --prefix <PREFIX>
2275 add a prefix to all variable names
2276 --max-width <integer>
2278 Maximum display width, <1 to disable. You can also use the
2279 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2280 takes precedence.
2281 --fit-width
2283 Fit the table to the display width. Implied if --max-width
2284 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2285 to always enable
2286 --print-empty
2288 Print empty table if there is no data to show.
2289 --tenant-id TENANT_ID
2291 The owner tenant ID or project ID
2292 --vnfd-file <VNFD_FILE>
2294 YAML file with VNFD parameters
2295 --description <DESCRIPTION>
2297 Set a description for the VNFD
2298 NAME Name for VNFD
2300 This command is provided by the python-tackerclient plugin.
2302 vnf descriptor delete
2304 Delete VNFD(s).
2305 openstack vnf descriptor delete <VNFD> [<VNFD> ...]
2307 VNFD VNFD(s) to delete (name or ID)
2309 This command is provided by the python-tackerclient plugin.
2311 vnf descriptor list
2313 List (VNFD)s that belong to a given tenant.
2314 openstack vnf descriptor list
2316 [-f {csv,json,table,value,yaml}]
2317 [-c COLUMN]
2318 [--quote {all,minimal,none,nonnumeric}]
2319 [--noindent]
2320 [--max-width <integer>]
2321 [--fit-width]
2322 [--print-empty]
2323 [--sort-column SORT_COLUMN]
2324 [--sort-ascending | --sort-descending]
2325 [--template-source TEMPLATE_SOURCE]
2326 -f <FORMATTER>, --format <FORMATTER>
2328 the output format, defaults to table
2329 -c COLUMN, --column COLUMN
2331 specify the column(s) to include, can be repeated to show multi‐
2332 ple columns
2333 --quote <QUOTE_MODE>
2335 when to include quotes, defaults to nonnumeric
2336 --noindent
2338 whether to disable indenting the JSON
2339 --max-width <integer>
2341 Maximum display width, <1 to disable. You can also use the
2342 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2343 takes precedence.
2344 --fit-width
2346 Fit the table to the display width. Implied if --max-width
2347 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2348 to always enable
2349 --print-empty
2351 Print empty table if there is no data to show.
2352 --sort-column SORT_COLUMN
2354 specify the column(s) to sort the data (columns specified first
2355 have a priority, non-existing columns are ignored), can be re‐
2356 peated
2357 --sort-ascending
2359 sort the column(s) in ascending order
2360 --sort-descending
2362 sort the column(s) in descending order
2363 --template-source <TEMPLATE_SOURCE>
2365 List VNFD with specified template source. Available
2366 options are 'onboarded' (default), 'inline' or 'all'
2367 This command is provided by the python-tackerclient plugin.
2369 vnf descriptor show
2371 Display VNFD details
2372 openstack vnf descriptor show
2374 [-f {json,shell,table,value,yaml}]
2375 [-c COLUMN]
2376 [--noindent]
2377 [--prefix PREFIX]
2378 [--max-width <integer>]
2379 [--fit-width]
2380 [--print-empty]
2381 <VNFD>
2382 -f <FORMATTER>, --format <FORMATTER>
2384 the output format, defaults to table
2385 -c COLUMN, --column COLUMN
2387 specify the column(s) to include, can be repeated to show multi‐
2388 ple columns
2389 --noindent
2391 whether to disable indenting the JSON
2392 --prefix <PREFIX>
2394 add a prefix to all variable names
2395 --max-width <integer>
2397 Maximum display width, <1 to disable. You can also use the
2398 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2399 takes precedence.
2400 --fit-width
2402 Fit the table to the display width. Implied if --max-width
2403 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2404 to always enable
2405 --print-empty
2407 Print empty table if there is no data to show.
2408 VNFD VNFD to display (name or ID)
2410 This command is provided by the python-tackerclient plugin.
2412 vnf descriptor template show
2414 Display VNFD Template details
2415 openstack vnf descriptor template show
2417 [-f {json,shell,table,value,yaml}]
2418 [-c COLUMN]
2419 [--noindent]
2420 [--prefix PREFIX]
2421 [--max-width <integer>]
2422 [--fit-width]
2423 [--print-empty]
2424 <VNFD>
2425 -f <FORMATTER>, --format <FORMATTER>
2427 the output format, defaults to table
2428 -c COLUMN, --column COLUMN
2430 specify the column(s) to include, can be repeated to show multi‐
2431 ple columns
2432 --noindent
2434 whether to disable indenting the JSON
2435 --prefix <PREFIX>
2437 add a prefix to all variable names
2438 --max-width <integer>
2440 Maximum display width, <1 to disable. You can also use the
2441 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2442 takes precedence.
2443 --fit-width
2445 Fit the table to the display width. Implied if --max-width
2446 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2447 to always enable
2448 --print-empty
2450 Print empty table if there is no data to show.
2451 VNFD VNFD to display (name or ID)
2453 This command is provided by the python-tackerclient plugin.
2455 vnf graph create
2457 Create a new VNFFG.
2458 openstack vnf graph create
2460 [-f {json,shell,table,value,yaml}]
2461 [-c COLUMN]
2462 [--noindent]
2463 [--prefix PREFIX]
2464 [--max-width <integer>]
2465 [--fit-width]
2466 [--print-empty]
2467 [--tenant-id TENANT_ID]
2468 (--vnffgd-id VNFFGD_ID | --vnffgd-name VNFFGD_NAME | --vnffgd-template VNFFGD_TEMPLATE)
2469 [--vnf-mapping VNF_MAPPING]
2470 [--symmetrical]
2471 [--param-file PARAM_FILE]
2472 [--description DESCRIPTION]
2473 NAME
2474 -f <FORMATTER>, --format <FORMATTER>
2476 the output format, defaults to table
2477 -c COLUMN, --column COLUMN
2479 specify the column(s) to include, can be repeated to show multi‐
2480 ple columns
2481 --noindent
2483 whether to disable indenting the JSON
2484 --prefix <PREFIX>
2486 add a prefix to all variable names
2487 --max-width <integer>
2489 Maximum display width, <1 to disable. You can also use the
2490 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2491 takes precedence.
2492 --fit-width
2494 Fit the table to the display width. Implied if --max-width
2495 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2496 to always enable
2497 --print-empty
2499 Print empty table if there is no data to show.
2500 --tenant-id TENANT_ID
2502 The owner tenant ID
2503 --vnffgd-id <VNFFGD_ID>
2505 VNFFGD ID to use as template to create VNFFG
2506 --vnffgd-name <VNFFGD_NAME>
2508 VNFFGD Name to use as template to create VNFFG
2509 --vnffgd-template <VNFFGD_TEMPLATE>
2511 VNFFGD file to create VNFFG
2512 --vnf-mapping <VNF_MAPPING>
2514 List of logical VNFD name to VNF instance name mapping. Example:
2515 VNF1:my_vnf1,VNF2:my_vnf2
2516 --symmetrical
2518 Should a reverse path be created for the NFP (True or False)
2519 --param-file <PARAM_FILE>
2521 YAML file with specific VNFFG parameters
2522 --description <DESCRIPTION>
2524 Set a description for the VNFFG
2525 NAME Set a name for the VNFFG
2527 This command is provided by the python-tackerclient plugin.
2529 vnf graph delete
2531 Delete VNFFG(s).
2532 openstack vnf graph delete [--force] <VNFFG> [<VNFFG> ...]
2534 --force
2536 Force delete VNFFG
2537 VNFFG VNFFG(s) to delete (name or ID)
2539 This command is provided by the python-tackerclient plugin.
2541 vnf graph descriptor create
2543 Create a new VNFFGD
2544 openstack vnf graph descriptor create
2546 [-f {json,shell,table,value,yaml}]
2547 [-c COLUMN]
2548 [--noindent]
2549 [--prefix PREFIX]
2550 [--max-width <integer>]
2551 [--fit-width]
2552 [--print-empty]
2553 [--tenant-id TENANT_ID]
2554 --vnffgd-file VNFFGD_FILE
2555 [--description DESCRIPTION]
2556 NAME
2557 -f <FORMATTER>, --format <FORMATTER>
2559 the output format, defaults to table
2560 -c COLUMN, --column COLUMN
2562 specify the column(s) to include, can be repeated to show multi‐
2563 ple columns
2564 --noindent
2566 whether to disable indenting the JSON
2567 --prefix <PREFIX>
2569 add a prefix to all variable names
2570 --max-width <integer>
2572 Maximum display width, <1 to disable. You can also use the
2573 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2574 takes precedence.
2575 --fit-width
2577 Fit the table to the display width. Implied if --max-width
2578 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2579 to always enable
2580 --print-empty
2582 Print empty table if there is no data to show.
2583 --tenant-id TENANT_ID
2585 The owner tenant ID or project ID
2586 --vnffgd-file <VNFFGD_FILE>
2588 YAML file with VNFFGD parameters
2589 --description <DESCRIPTION>
2591 Set a description for the VNFFGD
2592 NAME Name for VNFFGD
2594 This command is provided by the python-tackerclient plugin.
2596 vnf graph descriptor delete
2598 Delete VNFFGD(s).
2599 openstack vnf graph descriptor delete <VNFFGD> [<VNFFGD> ...]
2601 VNFFGD VNFFGD(s) to delete (name or ID)
2603 This command is provided by the python-tackerclient plugin.
2605 vnf graph descriptor list
2607 List (VNFFGD)s that belong to a given tenant.
2608 openstack vnf graph descriptor list
2610 [-f {csv,json,table,value,yaml}]
2611 [-c COLUMN]
2612 [--quote {all,minimal,none,nonnumeric}]
2613 [--noindent]
2614 [--max-width <integer>]
2615 [--fit-width]
2616 [--print-empty]
2617 [--sort-column SORT_COLUMN]
2618 [--sort-ascending | --sort-descending]
2619 [--template-source TEMPLATE_SOURCE]
2620 -f <FORMATTER>, --format <FORMATTER>
2622 the output format, defaults to table
2623 -c COLUMN, --column COLUMN
2625 specify the column(s) to include, can be repeated to show multi‐
2626 ple columns
2627 --quote <QUOTE_MODE>
2629 when to include quotes, defaults to nonnumeric
2630 --noindent
2632 whether to disable indenting the JSON
2633 --max-width <integer>
2635 Maximum display width, <1 to disable. You can also use the
2636 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2637 takes precedence.
2638 --fit-width
2640 Fit the table to the display width. Implied if --max-width
2641 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2642 to always enable
2643 --print-empty
2645 Print empty table if there is no data to show.
2646 --sort-column SORT_COLUMN
2648 specify the column(s) to sort the data (columns specified first
2649 have a priority, non-existing columns are ignored), can be re‐
2650 peated
2651 --sort-ascending
2653 sort the column(s) in ascending order
2654 --sort-descending
2656 sort the column(s) in descending order
2657 --template-source <TEMPLATE_SOURCE>
2659 List VNFFGD with specified template source. Available
2660 options are 'onboarded' (default), 'inline' or 'all'
2661 This command is provided by the python-tackerclient plugin.
2663 vnf graph descriptor show
2665 Display VNFFGD details
2666 openstack vnf graph descriptor show
2668 [-f {json,shell,table,value,yaml}]
2669 [-c COLUMN]
2670 [--noindent]
2671 [--prefix PREFIX]
2672 [--max-width <integer>]
2673 [--fit-width]
2674 [--print-empty]
2675 <VNFFGD>
2676 -f <FORMATTER>, --format <FORMATTER>
2678 the output format, defaults to table
2679 -c COLUMN, --column COLUMN
2681 specify the column(s) to include, can be repeated to show multi‐
2682 ple columns
2683 --noindent
2685 whether to disable indenting the JSON
2686 --prefix <PREFIX>
2688 add a prefix to all variable names
2689 --max-width <integer>
2691 Maximum display width, <1 to disable. You can also use the
2692 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2693 takes precedence.
2694 --fit-width
2696 Fit the table to the display width. Implied if --max-width
2697 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2698 to always enable
2699 --print-empty
2701 Print empty table if there is no data to show.
2702 VNFFGD VNFFGD to display (name or ID)
2704 This command is provided by the python-tackerclient plugin.
2706 vnf graph descriptor template show
2708 Display VNFFGD Template details
2709 openstack vnf graph descriptor template show
2711 [-f {json,shell,table,value,yaml}]
2712 [-c COLUMN]
2713 [--noindent]
2714 [--prefix PREFIX]
2715 [--max-width <integer>]
2716 [--fit-width]
2717 [--print-empty]
2718 <VNFFGD>
2719 -f <FORMATTER>, --format <FORMATTER>
2721 the output format, defaults to table
2722 -c COLUMN, --column COLUMN
2724 specify the column(s) to include, can be repeated to show multi‐
2725 ple columns
2726 --noindent
2728 whether to disable indenting the JSON
2729 --prefix <PREFIX>
2731 add a prefix to all variable names
2732 --max-width <integer>
2734 Maximum display width, <1 to disable. You can also use the
2735 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2736 takes precedence.
2737 --fit-width
2739 Fit the table to the display width. Implied if --max-width
2740 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2741 to always enable
2742 --print-empty
2744 Print empty table if there is no data to show.
2745 VNFFGD VNFFGD to display (name or ID)
2747 This command is provided by the python-tackerclient plugin.
2749 vnf graph list
2751 List VNFFG(s) that belong to a given tenant.
2752 openstack vnf graph list
2754 [-f {csv,json,table,value,yaml}]
2755 [-c COLUMN]
2756 [--quote {all,minimal,none,nonnumeric}]
2757 [--noindent]
2758 [--max-width <integer>]
2759 [--fit-width]
2760 [--print-empty]
2761 [--sort-column SORT_COLUMN]
2762 [--sort-ascending | --sort-descending]
2763 [--long]
2764 -f <FORMATTER>, --format <FORMATTER>
2766 the output format, defaults to table
2767 -c COLUMN, --column COLUMN
2769 specify the column(s) to include, can be repeated to show multi‐
2770 ple columns
2771 --quote <QUOTE_MODE>
2773 when to include quotes, defaults to nonnumeric
2774 --noindent
2776 whether to disable indenting the JSON
2777 --max-width <integer>
2779 Maximum display width, <1 to disable. You can also use the
2780 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2781 takes precedence.
2782 --fit-width
2784 Fit the table to the display width. Implied if --max-width
2785 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2786 to always enable
2787 --print-empty
2789 Print empty table if there is no data to show.
2790 --sort-column SORT_COLUMN
2792 specify the column(s) to sort the data (columns specified first
2793 have a priority, non-existing columns are ignored), can be re‐
2794 peated
2795 --sort-ascending
2797 sort the column(s) in ascending order
2798 --sort-descending
2800 sort the column(s) in descending order
2801 --long List additional fields in output
2803 This command is provided by the python-tackerclient plugin.
2805 vnf graph set
2807 Update VNFFG.
2808 openstack vnf graph set
2810 [-f {json,shell,table,value,yaml}]
2811 [-c COLUMN]
2812 [--noindent]
2813 [--prefix PREFIX]
2814 [--max-width <integer>]
2815 [--fit-width]
2816 [--print-empty]
2817 [--vnffgd-template VNFFGD_TEMPLATE]
2818 [--vnf-mapping VNF_MAPPING]
2819 [--symmetrical]
2820 [--description DESCRIPTION]
2821 [--param-file PARAM_FILE]
2822 <VNFFG>
2823 -f <FORMATTER>, --format <FORMATTER>
2825 the output format, defaults to table
2826 -c COLUMN, --column COLUMN
2828 specify the column(s) to include, can be repeated to show multi‐
2829 ple columns
2830 --noindent
2832 whether to disable indenting the JSON
2833 --prefix <PREFIX>
2835 add a prefix to all variable names
2836 --max-width <integer>
2838 Maximum display width, <1 to disable. You can also use the
2839 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2840 takes precedence.
2841 --fit-width
2843 Fit the table to the display width. Implied if --max-width
2844 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2845 to always enable
2846 --print-empty
2848 Print empty table if there is no data to show.
2849 --vnffgd-template <VNFFGD_TEMPLATE>
2851 VNFFGD file to update VNFFG
2852 --vnf-mapping <VNF_MAPPING>
2854 List of logical VNFD name to VNF instance name mapping. Exam‐
2855 ple: VNF1:my_vnf1,VNF2:my_vnf2
2856 --symmetrical
2858 Should a reverse path be created for the NFP
2859 --description <DESCRIPTION>
2861 Set a description for the VNFFG
2862 --param-file <PARAM_FILE>
2864 YAML file with specific VNFFG parameters
2865 VNFFG VNFFG to update (name or ID)
2867 This command is provided by the python-tackerclient plugin.
2869 vnf graph show
2871 Display VNFFG details
2872 openstack vnf graph show
2874 [-f {json,shell,table,value,yaml}]
2875 [-c COLUMN]
2876 [--noindent]
2877 [--prefix PREFIX]
2878 [--max-width <integer>]
2879 [--fit-width]
2880 [--print-empty]
2881 <VNFFG>
2882 -f <FORMATTER>, --format <FORMATTER>
2884 the output format, defaults to table
2885 -c COLUMN, --column COLUMN
2887 specify the column(s) to include, can be repeated to show multi‐
2888 ple columns
2889 --noindent
2891 whether to disable indenting the JSON
2892 --prefix <PREFIX>
2894 add a prefix to all variable names
2895 --max-width <integer>
2897 Maximum display width, <1 to disable. You can also use the
2898 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2899 takes precedence.
2900 --fit-width
2902 Fit the table to the display width. Implied if --max-width
2903 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2904 to always enable
2905 --print-empty
2907 Print empty table if there is no data to show.
2908 VNFFG VNFFG to display (name or ID)
2910 This command is provided by the python-tackerclient plugin.
2912 vnf list
2914 List VNF(s) that belong to a given tenant.
2915 openstack vnf list
2917 [-f {csv,json,table,value,yaml}]
2918 [-c COLUMN]
2919 [--quote {all,minimal,none,nonnumeric}]
2920 [--noindent]
2921 [--max-width <integer>]
2922 [--fit-width]
2923 [--print-empty]
2924 [--sort-column SORT_COLUMN]
2925 [--sort-ascending | --sort-descending]
2926 [--template-source TEMPLATE_SOURCE]
2927 [--vim-id VIM_ID | --vim-name VIM_NAME]
2928 [--vnfd-id VNFD_ID | --vnfd-name VNFD_NAME]
2929 [--tenant-id TENANT_ID]
2930 [--long]
2931 -f <FORMATTER>, --format <FORMATTER>
2933 the output format, defaults to table
2934 -c COLUMN, --column COLUMN
2936 specify the column(s) to include, can be repeated to show multi‐
2937 ple columns
2938 --quote <QUOTE_MODE>
2940 when to include quotes, defaults to nonnumeric
2941 --noindent
2943 whether to disable indenting the JSON
2944 --max-width <integer>
2946 Maximum display width, <1 to disable. You can also use the
2947 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
2948 takes precedence.
2949 --fit-width
2951 Fit the table to the display width. Implied if --max-width
2952 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
2953 to always enable
2954 --print-empty
2956 Print empty table if there is no data to show.
2957 --sort-column SORT_COLUMN
2959 specify the column(s) to sort the data (columns specified first
2960 have a priority, non-existing columns are ignored), can be re‐
2961 peated
2962 --sort-ascending
2964 sort the column(s) in ascending order
2965 --sort-descending
2967 sort the column(s) in descending order
2968 --template-source <TEMPLATE_SOURCE>
2970 List VNF with specified template source. Available
2971 options are 'onboarded' (default), 'inline' or 'all'
2972 --vim-id <VIM_ID>
2974 List VNF(s) that belong to a given VIM ID
2975 --vim-name <VIM_NAME>
2977 List VNF(s) that belong to a given VIM Name
2978 --vnfd-id <VNFD_ID>
2980 List VNF(s) that belong to a given VNFD ID
2981 --vnfd-name <VNFD_NAME>
2983 List VNF(s) that belong to a given VNFD Name
2984 --tenant-id TENANT_ID
2986 The owner tenant ID or project ID
2987 --long List additional fields in output
2989 This command is provided by the python-tackerclient plugin.
2991 vnf network forwarding path list
2993 List NFP(s) that belong to a given tenant.
2994 openstack vnf network forwarding path list
2996 [-f {csv,json,table,value,yaml}]
2997 [-c COLUMN]
2998 [--quote {all,minimal,none,nonnumeric}]
2999 [--noindent]
3000 [--max-width <integer>]
3001 [--fit-width]
3002 [--print-empty]
3003 [--sort-column SORT_COLUMN]
3004 [--sort-ascending | --sort-descending]
3005 [--vnffg-id VNFFG_ID]
3006 -f <FORMATTER>, --format <FORMATTER>
3008 the output format, defaults to table
3009 -c COLUMN, --column COLUMN
3011 specify the column(s) to include, can be repeated to show multi‐
3012 ple columns
3013 --quote <QUOTE_MODE>
3015 when to include quotes, defaults to nonnumeric
3016 --noindent
3018 whether to disable indenting the JSON
3019 --max-width <integer>
3021 Maximum display width, <1 to disable. You can also use the
3022 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3023 takes precedence.
3024 --fit-width
3026 Fit the table to the display width. Implied if --max-width
3027 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3028 to always enable
3029 --print-empty
3031 Print empty table if there is no data to show.
3032 --sort-column SORT_COLUMN
3034 specify the column(s) to sort the data (columns specified first
3035 have a priority, non-existing columns are ignored), can be re‐
3036 peated
3037 --sort-ascending
3039 sort the column(s) in ascending order
3040 --sort-descending
3042 sort the column(s) in descending order
3043 --vnffg-id <VNFFG_ID>
3045 List NFP(s) with specific VNFFG ID
3046 This command is provided by the python-tackerclient plugin.
3048 vnf network forwarding path show
3050 Display NFP details
3051 openstack vnf network forwarding path show
3053 [-f {json,shell,table,value,yaml}]
3054 [-c COLUMN]
3055 [--noindent]
3056 [--prefix PREFIX]
3057 [--max-width <integer>]
3058 [--fit-width]
3059 [--print-empty]
3060 <NFP>
3061 -f <FORMATTER>, --format <FORMATTER>
3063 the output format, defaults to table
3064 -c COLUMN, --column COLUMN
3066 specify the column(s) to include, can be repeated to show multi‐
3067 ple columns
3068 --noindent
3070 whether to disable indenting the JSON
3071 --prefix <PREFIX>
3073 add a prefix to all variable names
3074 --max-width <integer>
3076 Maximum display width, <1 to disable. You can also use the
3077 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3078 takes precedence.
3079 --fit-width
3081 Fit the table to the display width. Implied if --max-width
3082 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3083 to always enable
3084 --print-empty
3086 Print empty table if there is no data to show.
3087 NFP NFP to display (name or ID)
3089 This command is provided by the python-tackerclient plugin.
3091 vnf package artifact download
3093 Download VNF package artifact of an on-boarded VNF package.
3094 openstack vnf package artifact download
3096 [--file <FILE>]
3097 <vnf-package>
3098 <artifact-path>
3099 --file <FILE>
3101 Local file to save downloaded VNF Package artifact file data. If
3102 this is not specified and there is no redirection then data will
3103 not be saved.
3104 vnf-package
3106 VNF package ID
3107 artifact-path
3109 The artifact file's path
3110 This command is provided by the python-tackerclient plugin.
3112 vnf package create
3114 Create a new VNF Package
3115 openstack vnf package create
3117 [-f {json,shell,table,value,yaml}]
3118 [-c COLUMN]
3119 [--noindent]
3120 [--prefix PREFIX]
3121 [--max-width <integer>]
3122 [--fit-width]
3123 [--print-empty]
3124 [--user-data <key=value>]
3125 -f <FORMATTER>, --format <FORMATTER>
3127 the output format, defaults to table
3128 -c COLUMN, --column COLUMN
3130 specify the column(s) to include, can be repeated to show multi‐
3131 ple columns
3132 --noindent
3134 whether to disable indenting the JSON
3135 --prefix <PREFIX>
3137 add a prefix to all variable names
3138 --max-width <integer>
3140 Maximum display width, <1 to disable. You can also use the
3141 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3142 takes precedence.
3143 --fit-width
3145 Fit the table to the display width. Implied if --max-width
3146 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3147 to always enable
3148 --print-empty
3150 Print empty table if there is no data to show.
3151 --user-data <key=value>
3153 User defined data for the VNF package (repeat option to set mul‐
3154 tiple user defined data)
3155 This command is provided by the python-tackerclient plugin.
3157 vnf package delete
3159 Delete VNF Package
3160 openstack vnf package delete <vnf-package> [<vnf-package> ...]
3162 vnf-package
3164 Vnf package(s) ID to delete
3165 This command is provided by the python-tackerclient plugin.
3167 vnf package download
3169 Download VNF package contents or VNFD of an on-boarded VNF package.
3170 openstack vnf package download
3172 [--file <FILE>]
3173 [--vnfd]
3174 [--type <type>]
3175 <vnf-package>
3176 --file <FILE>
3178 Local file to save downloaded VNF Package or VNFD data. If this
3179 is not specified and there is no redirection then data will not
3180 be saved.
3181 --vnfd Download VNFD of an on-boarded vnf package.
3183 --type <type>
3185 Provide text/plain when VNFD is implemented as a single YAML
3186 file otherwise use application/zip. If you are not aware
3187 whether VNFD is a single or multiple yaml files, then you can
3188 specify 'both' option value. Provide this option only when
3189 --vnfd is set.
3190 vnf-package
3192 VNF package ID
3193 This command is provided by the python-tackerclient plugin.
3195 vnf package list
3197 List VNF Packages
3198 openstack vnf package list
3200 [-f {csv,json,table,value,yaml}]
3201 [-c COLUMN]
3202 [--quote {all,minimal,none,nonnumeric}]
3203 [--noindent]
3204 [--max-width <integer>]
3205 [--fit-width]
3206 [--print-empty]
3207 [--sort-column SORT_COLUMN]
3208 [--sort-ascending | --sort-descending]
3209 [--filter <filter>]
3210 [--all_fields | --fields fields | --exclude_fields exclude-fields]
3211 [--exclude_default]
3212 -f <FORMATTER>, --format <FORMATTER>
3214 the output format, defaults to table
3215 -c COLUMN, --column COLUMN
3217 specify the column(s) to include, can be repeated to show multi‐
3218 ple columns
3219 --quote <QUOTE_MODE>
3221 when to include quotes, defaults to nonnumeric
3222 --noindent
3224 whether to disable indenting the JSON
3225 --max-width <integer>
3227 Maximum display width, <1 to disable. You can also use the
3228 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3229 takes precedence.
3230 --fit-width
3232 Fit the table to the display width. Implied if --max-width
3233 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3234 to always enable
3235 --print-empty
3237 Print empty table if there is no data to show.
3238 --sort-column SORT_COLUMN
3240 specify the column(s) to sort the data (columns specified first
3241 have a priority, non-existing columns are ignored), can be re‐
3242 peated
3243 --sort-ascending
3245 sort the column(s) in ascending order
3246 --sort-descending
3248 sort the column(s) in descending order
3249 --filter <filter>
3251 Atrribute-based-filtering parameters
3252 --all_fields
3254 Include all complex attributes in the response
3255 --fields fields
3257 Complex attributes to be included into the response
3258 --exclude_fields exclude-fields
3260 Complex attributes to be excluded from the response
3261 --exclude_default
3263 Indicates to exclude all complex attributes from the response.
3264 This argument can be used alone or with --fields and --filter.
3265 For all other combinations tacker server will throw bad request
3266 error
3267 This command is provided by the python-tackerclient plugin.
3269 vnf package show
3271 Show VNF Package Details
3272 openstack vnf package show
3274 [-f {json,shell,table,value,yaml}]
3275 [-c COLUMN]
3276 [--noindent]
3277 [--prefix PREFIX]
3278 [--max-width <integer>]
3279 [--fit-width]
3280 [--print-empty]
3281 <vnf-package>
3282 -f <FORMATTER>, --format <FORMATTER>
3284 the output format, defaults to table
3285 -c COLUMN, --column COLUMN
3287 specify the column(s) to include, can be repeated to show multi‐
3288 ple columns
3289 --noindent
3291 whether to disable indenting the JSON
3292 --prefix <PREFIX>
3294 add a prefix to all variable names
3295 --max-width <integer>
3297 Maximum display width, <1 to disable. You can also use the
3298 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3299 takes precedence.
3300 --fit-width
3302 Fit the table to the display width. Implied if --max-width
3303 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3304 to always enable
3305 --print-empty
3307 Print empty table if there is no data to show.
3308 vnf-package
3310 VNF package ID
3311 This command is provided by the python-tackerclient plugin.
3313 vnf package update
3315 Update information about an individual VNF package
3316 openstack vnf package update
3318 [-f {json,shell,table,value,yaml}]
3319 [-c COLUMN]
3320 [--noindent]
3321 [--prefix PREFIX]
3322 [--max-width <integer>]
3323 [--fit-width]
3324 [--print-empty]
3325 [--operational-state <operational-state>]
3326 [--user-data <key=value>]
3327 <vnf-package>
3328 -f <FORMATTER>, --format <FORMATTER>
3330 the output format, defaults to table
3331 -c COLUMN, --column COLUMN
3333 specify the column(s) to include, can be repeated to show multi‐
3334 ple columns
3335 --noindent
3337 whether to disable indenting the JSON
3338 --prefix <PREFIX>
3340 add a prefix to all variable names
3341 --max-width <integer>
3343 Maximum display width, <1 to disable. You can also use the
3344 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3345 takes precedence.
3346 --fit-width
3348 Fit the table to the display width. Implied if --max-width
3349 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3350 to always enable
3351 --print-empty
3353 Print empty table if there is no data to show.
3354 --operational-state <operational-state>
3356 Change the operational state of VNF Package, Valid values are
3357 'ENABLED' or 'DISABLED'.
3358 --user-data <key=value>
3360 User defined data for the VNF package (repeat option to set mul‐
3361 tiple user defined data)
3362 vnf-package
3364 VNF package ID
3365 This command is provided by the python-tackerclient plugin.
3367 vnf package upload
3369 Upload VNF Package
3370 openstack vnf package upload
3372 (--path <file> | --url <Uri>)
3373 [--user-name <user-name>]
3374 [--password <password>]
3375 <vnf-package>
3376 --path <file>
3378 Upload VNF CSAR package from local file
3379 --url <Uri>
3381 Uri of the VNF package content
3382 --user-name <user-name>
3384 User name for authentication
3385 --password <password>
3387 Password for authentication
3388 vnf-package
3390 VNF package ID
3391 This command is provided by the python-tackerclient plugin.
3393 vnf resource list
3395 List resources of a VNF like VDU, CP, etc.
3396 openstack vnf resource list
3398 [-f {csv,json,table,value,yaml}]
3399 [-c COLUMN]
3400 [--quote {all,minimal,none,nonnumeric}]
3401 [--noindent]
3402 [--max-width <integer>]
3403 [--fit-width]
3404 [--print-empty]
3405 [--sort-column SORT_COLUMN]
3406 [--sort-ascending | --sort-descending]
3407 <VNF>
3408 -f <FORMATTER>, --format <FORMATTER>
3410 the output format, defaults to table
3411 -c COLUMN, --column COLUMN
3413 specify the column(s) to include, can be repeated to show multi‐
3414 ple columns
3415 --quote <QUOTE_MODE>
3417 when to include quotes, defaults to nonnumeric
3418 --noindent
3420 whether to disable indenting the JSON
3421 --max-width <integer>
3423 Maximum display width, <1 to disable. You can also use the
3424 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3425 takes precedence.
3426 --fit-width
3428 Fit the table to the display width. Implied if --max-width
3429 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3430 to always enable
3431 --print-empty
3433 Print empty table if there is no data to show.
3434 --sort-column SORT_COLUMN
3436 specify the column(s) to sort the data (columns specified first
3437 have a priority, non-existing columns are ignored), can be re‐
3438 peated
3439 --sort-ascending
3441 sort the column(s) in ascending order
3442 --sort-descending
3444 sort the column(s) in descending order
3445 VNF VNF to display (name or ID)
3447 This command is provided by the python-tackerclient plugin.
3449 vnf scale
3451 Scale a VNF.
3452 openstack vnf scale
3454 [--scaling-policy-name SCALING_POLICY_NAME]
3455 [--scaling-type SCALING_TYPE]
3456 <VNF>
3457 --scaling-policy-name <SCALING_POLICY_NAME>
3459 VNF policy name used to scale
3460 --scaling-type <SCALING_TYPE>
3462 VNF scaling type, it could be either "out" or "in"
3463 VNF VNF to scale (name or ID)
3465 This command is provided by the python-tackerclient plugin.
3467 vnf set
3469 Update a given VNF.
3470 openstack vnf set
3472 [-f {json,shell,table,value,yaml}]
3473 [-c COLUMN]
3474 [--noindent]
3475 [--prefix PREFIX]
3476 [--max-width <integer>]
3477 [--fit-width]
3478 [--print-empty]
3479 (--config-file CONFIG_FILE | --config CONFIG | --param-file PARAM_FILE)
3480 <VNF>
3481 -f <FORMATTER>, --format <FORMATTER>
3483 the output format, defaults to table
3484 -c COLUMN, --column COLUMN
3486 specify the column(s) to include, can be repeated to show multi‐
3487 ple columns
3488 --noindent
3490 whether to disable indenting the JSON
3491 --prefix <PREFIX>
3493 add a prefix to all variable names
3494 --max-width <integer>
3496 Maximum display width, <1 to disable. You can also use the
3497 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3498 takes precedence.
3499 --fit-width
3501 Fit the table to the display width. Implied if --max-width
3502 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3503 to always enable
3504 --print-empty
3506 Print empty table if there is no data to show.
3507 --config-file <CONFIG_FILE>
3509 YAML file with VNF configuration
3510 --config <CONFIG>
3512 YAML data with VNF configuration
3513 --param-file <PARAM_FILE>
3515 YAML file with VNF parameter
3516 VNF VNF to update (name or ID)
3518 This command is provided by the python-tackerclient plugin.
3520 vnf show
3522 Display VNF details
3523 openstack vnf show
3525 [-f {json,shell,table,value,yaml}]
3526 [-c COLUMN]
3527 [--noindent]
3528 [--prefix PREFIX]
3529 [--max-width <integer>]
3530 [--fit-width]
3531 [--print-empty]
3532 <VNF>
3533 -f <FORMATTER>, --format <FORMATTER>
3535 the output format, defaults to table
3536 -c COLUMN, --column COLUMN
3538 specify the column(s) to include, can be repeated to show multi‐
3539 ple columns
3540 --noindent
3542 whether to disable indenting the JSON
3543 --prefix <PREFIX>
3545 add a prefix to all variable names
3546 --max-width <integer>
3548 Maximum display width, <1 to disable. You can also use the
3549 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3550 takes precedence.
3551 --fit-width
3553 Fit the table to the display width. Implied if --max-width
3554 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3555 to always enable
3556 --print-empty
3558 Print empty table if there is no data to show.
3559 VNF VNF to display (name or ID)
3561 This command is provided by the python-tackerclient plugin.
3563 VNF Descriptor (VNFD) Management commands
3565 WARNING:
3566 VNF Descriptor (VNFD) Management commands are deprecated and will be
3567 removed in the first major release after the Tacker server version
3568 9.0.0 (2023.1 Antelope release).
3569 vnf descriptor create
3571 Create a new VNFD
3572 openstack vnf descriptor create
3574 [-f {json,shell,table,value,yaml}]
3575 [-c COLUMN]
3576 [--noindent]
3577 [--prefix PREFIX]
3578 [--max-width <integer>]
3579 [--fit-width]
3580 [--print-empty]
3581 [--tenant-id TENANT_ID]
3582 --vnfd-file VNFD_FILE
3583 [--description DESCRIPTION]
3584 NAME
3585 -f <FORMATTER>, --format <FORMATTER>
3587 the output format, defaults to table
3588 -c COLUMN, --column COLUMN
3590 specify the column(s) to include, can be repeated to show multi‐
3591 ple columns
3592 --noindent
3594 whether to disable indenting the JSON
3595 --prefix <PREFIX>
3597 add a prefix to all variable names
3598 --max-width <integer>
3600 Maximum display width, <1 to disable. You can also use the
3601 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3602 takes precedence.
3603 --fit-width
3605 Fit the table to the display width. Implied if --max-width
3606 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3607 to always enable
3608 --print-empty
3610 Print empty table if there is no data to show.
3611 --tenant-id TENANT_ID
3613 The owner tenant ID or project ID
3614 --vnfd-file <VNFD_FILE>
3616 YAML file with VNFD parameters
3617 --description <DESCRIPTION>
3619 Set a description for the VNFD
3620 NAME Name for VNFD
3622 This command is provided by the python-tackerclient plugin.
3624 vnf descriptor delete
3626 Delete VNFD(s).
3627 openstack vnf descriptor delete <VNFD> [<VNFD> ...]
3629 VNFD VNFD(s) to delete (name or ID)
3631 This command is provided by the python-tackerclient plugin.
3633 vnf descriptor list
3635 List (VNFD)s that belong to a given tenant.
3636 openstack vnf descriptor list
3638 [-f {csv,json,table,value,yaml}]
3639 [-c COLUMN]
3640 [--quote {all,minimal,none,nonnumeric}]
3641 [--noindent]
3642 [--max-width <integer>]
3643 [--fit-width]
3644 [--print-empty]
3645 [--sort-column SORT_COLUMN]
3646 [--sort-ascending | --sort-descending]
3647 [--template-source TEMPLATE_SOURCE]
3648 -f <FORMATTER>, --format <FORMATTER>
3650 the output format, defaults to table
3651 -c COLUMN, --column COLUMN
3653 specify the column(s) to include, can be repeated to show multi‐
3654 ple columns
3655 --quote <QUOTE_MODE>
3657 when to include quotes, defaults to nonnumeric
3658 --noindent
3660 whether to disable indenting the JSON
3661 --max-width <integer>
3663 Maximum display width, <1 to disable. You can also use the
3664 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3665 takes precedence.
3666 --fit-width
3668 Fit the table to the display width. Implied if --max-width
3669 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3670 to always enable
3671 --print-empty
3673 Print empty table if there is no data to show.
3674 --sort-column SORT_COLUMN
3676 specify the column(s) to sort the data (columns specified first
3677 have a priority, non-existing columns are ignored), can be re‐
3678 peated
3679 --sort-ascending
3681 sort the column(s) in ascending order
3682 --sort-descending
3684 sort the column(s) in descending order
3685 --template-source <TEMPLATE_SOURCE>
3687 List VNFD with specified template source. Available
3688 options are 'onboarded' (default), 'inline' or 'all'
3689 This command is provided by the python-tackerclient plugin.
3691 vnf descriptor show
3693 Display VNFD details
3694 openstack vnf descriptor show
3696 [-f {json,shell,table,value,yaml}]
3697 [-c COLUMN]
3698 [--noindent]
3699 [--prefix PREFIX]
3700 [--max-width <integer>]
3701 [--fit-width]
3702 [--print-empty]
3703 <VNFD>
3704 -f <FORMATTER>, --format <FORMATTER>
3706 the output format, defaults to table
3707 -c COLUMN, --column COLUMN
3709 specify the column(s) to include, can be repeated to show multi‐
3710 ple columns
3711 --noindent
3713 whether to disable indenting the JSON
3714 --prefix <PREFIX>
3716 add a prefix to all variable names
3717 --max-width <integer>
3719 Maximum display width, <1 to disable. You can also use the
3720 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3721 takes precedence.
3722 --fit-width
3724 Fit the table to the display width. Implied if --max-width
3725 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3726 to always enable
3727 --print-empty
3729 Print empty table if there is no data to show.
3730 VNFD VNFD to display (name or ID)
3732 This command is provided by the python-tackerclient plugin.
3734 vnf descriptor template show
3736 Display VNFD Template details
3737 openstack vnf descriptor template show
3739 [-f {json,shell,table,value,yaml}]
3740 [-c COLUMN]
3741 [--noindent]
3742 [--prefix PREFIX]
3743 [--max-width <integer>]
3744 [--fit-width]
3745 [--print-empty]
3746 <VNFD>
3747 -f <FORMATTER>, --format <FORMATTER>
3749 the output format, defaults to table
3750 -c COLUMN, --column COLUMN
3752 specify the column(s) to include, can be repeated to show multi‐
3753 ple columns
3754 --noindent
3756 whether to disable indenting the JSON
3757 --prefix <PREFIX>
3759 add a prefix to all variable names
3760 --max-width <integer>
3762 Maximum display width, <1 to disable. You can also use the
3763 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3764 takes precedence.
3765 --fit-width
3767 Fit the table to the display width. Implied if --max-width
3768 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3769 to always enable
3770 --print-empty
3772 Print empty table if there is no data to show.
3773 VNFD VNFD to display (name or ID)
3775 This command is provided by the python-tackerclient plugin.
3777 VIM Management commands
3779 vim delete
3780 Delete VIM(s).
3781 openstack vim delete <VIM> [<VIM> ...]
3783 VIM VIM(s) to delete (name or ID)
3785 This command is provided by the python-tackerclient plugin.
3787 vim list
3789 List VIMs that belong to a given tenant.
3790 openstack vim list
3792 [-f {csv,json,table,value,yaml}]
3793 [-c COLUMN]
3794 [--quote {all,minimal,none,nonnumeric}]
3795 [--noindent]
3796 [--max-width <integer>]
3797 [--fit-width]
3798 [--print-empty]
3799 [--sort-column SORT_COLUMN]
3800 [--sort-ascending | --sort-descending]
3801 [--long]
3802 -f <FORMATTER>, --format <FORMATTER>
3804 the output format, defaults to table
3805 -c COLUMN, --column COLUMN
3807 specify the column(s) to include, can be repeated to show multi‐
3808 ple columns
3809 --quote <QUOTE_MODE>
3811 when to include quotes, defaults to nonnumeric
3812 --noindent
3814 whether to disable indenting the JSON
3815 --max-width <integer>
3817 Maximum display width, <1 to disable. You can also use the
3818 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3819 takes precedence.
3820 --fit-width
3822 Fit the table to the display width. Implied if --max-width
3823 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3824 to always enable
3825 --print-empty
3827 Print empty table if there is no data to show.
3828 --sort-column SORT_COLUMN
3830 specify the column(s) to sort the data (columns specified first
3831 have a priority, non-existing columns are ignored), can be re‐
3832 peated
3833 --sort-ascending
3835 sort the column(s) in ascending order
3836 --sort-descending
3838 sort the column(s) in descending order
3839 --long List additional fields in output
3841 This command is provided by the python-tackerclient plugin.
3843 vim register
3845 Register a new VIM
3846 openstack vim register
3848 [-f {json,shell,table,value,yaml}]
3849 [-c COLUMN]
3850 [--noindent]
3851 [--prefix PREFIX]
3852 [--max-width <integer>]
3853 [--fit-width]
3854 [--print-empty]
3855 [--tenant-id TENANT_ID]
3856 --config-file CONFIG_FILE
3857 [--description DESCRIPTION]
3858 [--is-default]
3859 NAME
3860 -f <FORMATTER>, --format <FORMATTER>
3862 the output format, defaults to table
3863 -c COLUMN, --column COLUMN
3865 specify the column(s) to include, can be repeated to show multi‐
3866 ple columns
3867 --noindent
3869 whether to disable indenting the JSON
3870 --prefix <PREFIX>
3872 add a prefix to all variable names
3873 --max-width <integer>
3875 Maximum display width, <1 to disable. You can also use the
3876 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3877 takes precedence.
3878 --fit-width
3880 Fit the table to the display width. Implied if --max-width
3881 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3882 to always enable
3883 --print-empty
3885 Print empty table if there is no data to show.
3886 --tenant-id TENANT_ID
3888 The owner tenant ID or project ID
3889 --config-file <CONFIG_FILE>
3891 YAML file with VIM configuration parameters
3892 --description <DESCRIPTION>
3894 Set a description for the VIM
3895 --is-default
3897 Set as default VIM
3898 NAME Set a name for the VIM
3900 This command is provided by the python-tackerclient plugin.
3902 vim set
3904 Update VIM.
3905 openstack vim set
3907 [-f {json,shell,table,value,yaml}]
3908 [-c COLUMN]
3909 [--noindent]
3910 [--prefix PREFIX]
3911 [--max-width <integer>]
3912 [--fit-width]
3913 [--print-empty]
3914 [--config-file CONFIG_FILE]
3915 [--name NAME]
3916 [--description DESCRIPTION]
3917 [--is-default {True,False}]
3918 VIM
3919 -f <FORMATTER>, --format <FORMATTER>
3921 the output format, defaults to table
3922 -c COLUMN, --column COLUMN
3924 specify the column(s) to include, can be repeated to show multi‐
3925 ple columns
3926 --noindent
3928 whether to disable indenting the JSON
3929 --prefix <PREFIX>
3931 add a prefix to all variable names
3932 --max-width <integer>
3934 Maximum display width, <1 to disable. You can also use the
3935 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3936 takes precedence.
3937 --fit-width
3939 Fit the table to the display width. Implied if --max-width
3940 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3941 to always enable
3942 --print-empty
3944 Print empty table if there is no data to show.
3945 --config-file <CONFIG_FILE>
3947 YAML file with VIM configuration parameters
3948 --name <NAME>
3950 New name for the VIM
3951 --description <DESCRIPTION>
3953 New description for the VIM
3954 --is-default {True,False}
3956 Indicate whether the VIM is used as default
3957 VIM ID or name of vim to update
3959 This command is provided by the python-tackerclient plugin.
3961 vim show
3963 Display VIM details
3964 openstack vim show
3966 [-f {json,shell,table,value,yaml}]
3967 [-c COLUMN]
3968 [--noindent]
3969 [--prefix PREFIX]
3970 [--max-width <integer>]
3971 [--fit-width]
3972 [--print-empty]
3973 <VIM>
3974 -f <FORMATTER>, --format <FORMATTER>
3976 the output format, defaults to table
3977 -c COLUMN, --column COLUMN
3979 specify the column(s) to include, can be repeated to show multi‐
3980 ple columns
3981 --noindent
3983 whether to disable indenting the JSON
3984 --prefix <PREFIX>
3986 add a prefix to all variable names
3987 --max-width <integer>
3989 Maximum display width, <1 to disable. You can also use the
3990 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
3991 takes precedence.
3992 --fit-width
3994 Fit the table to the display width. Implied if --max-width
3995 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
3996 to always enable
3997 --print-empty
3999 Print empty table if there is no data to show.
4000 VIM VIM to display (name or ID)
4002 This command is provided by the python-tackerclient plugin.
4004 Network Service Management commands
4006 WARNING:
4007 Network Service Management commands are deprecated and will be re‐
4008 moved in the first major release after the Tacker server version
4009 9.0.0 (2023.1 Antelope release).
4010 ns create
4012 Create a new NS
4013 openstack ns create
4015 [-f {json,shell,table,value,yaml}]
4016 [-c COLUMN]
4017 [--noindent]
4018 [--prefix PREFIX]
4019 [--max-width <integer>]
4020 [--fit-width]
4021 [--print-empty]
4022 [--tenant-id TENANT_ID]
4023 [--description DESCRIPTION]
4024 (--nsd-id NSD_ID | --nsd-template NSD_TEMPLATE | --nsd-name NSD_NAME)
4025 [--vim-id VIM_ID | --vim-name VIM_NAME]
4026 [--vim-region-name VIM_REGION_NAME]
4027 [--param-file PARAM_FILE]
4028 NAME
4029 -f <FORMATTER>, --format <FORMATTER>
4031 the output format, defaults to table
4032 -c COLUMN, --column COLUMN
4034 specify the column(s) to include, can be repeated to show multi‐
4035 ple columns
4036 --noindent
4038 whether to disable indenting the JSON
4039 --prefix <PREFIX>
4041 add a prefix to all variable names
4042 --max-width <integer>
4044 Maximum display width, <1 to disable. You can also use the
4045 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4046 takes precedence.
4047 --fit-width
4049 Fit the table to the display width. Implied if --max-width
4050 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4051 to always enable
4052 --print-empty
4054 Print empty table if there is no data to show.
4055 --tenant-id TENANT_ID
4057 The owner tenant ID
4058 --description <DESCRIPTION>
4060 Set description for the NS
4061 --nsd-id <NSD_ID>
4063 NSD ID to use as template to create NS
4064 --nsd-template <NSD_TEMPLATE>
4066 NSD file to create NS
4067 --nsd-name <NSD_NAME>
4069 NSD name to use as template to create NS
4070 --vim-id <VIM_ID>
4072 VIM ID to use to create NS on the specified VIM
4073 --vim-name <VIM_NAME>
4075 VIM name to use to create NS on the specified VIM
4076 --vim-region-name <VIM_REGION_NAME>
4078 VIM Region to use to create NS on the specified VIM
4079 --param-file <PARAM_FILE>
4081 Specify parameter YAML file
4082 NAME Name for NS
4084 This command is provided by the python-tackerclient plugin.
4086 ns delete
4088 Delete NS(s).
4089 openstack ns delete [--force] <NS> [<NS> ...]
4091 --force
4093 Force delete Network Service
4094 NS NS(s) to delete (name or ID)
4096 This command is provided by the python-tackerclient plugin.
4098 ns descriptor create
4100 Create a new NSD.
4101 openstack ns descriptor create
4103 [-f {json,shell,table,value,yaml}]
4104 [-c COLUMN]
4105 [--noindent]
4106 [--prefix PREFIX]
4107 [--max-width <integer>]
4108 [--fit-width]
4109 [--print-empty]
4110 [--tenant-id TENANT_ID]
4111 --nsd-file NSD_FILE
4112 [--description DESCRIPTION]
4113 NAME
4114 -f <FORMATTER>, --format <FORMATTER>
4116 the output format, defaults to table
4117 -c COLUMN, --column COLUMN
4119 specify the column(s) to include, can be repeated to show multi‐
4120 ple columns
4121 --noindent
4123 whether to disable indenting the JSON
4124 --prefix <PREFIX>
4126 add a prefix to all variable names
4127 --max-width <integer>
4129 Maximum display width, <1 to disable. You can also use the
4130 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4131 takes precedence.
4132 --fit-width
4134 Fit the table to the display width. Implied if --max-width
4135 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4136 to always enable
4137 --print-empty
4139 Print empty table if there is no data to show.
4140 --tenant-id TENANT_ID
4142 The owner tenant ID or project ID
4143 --nsd-file <NSD_FILE>
4145 YAML file with NSD parameters
4146 --description <DESCRIPTION>
4148 Set a description for the NSD
4149 NAME Name for NSD
4151 This command is provided by the python-tackerclient plugin.
4153 ns descriptor delete
4155 Delete NSD(s).
4156 openstack ns descriptor delete <NSD> [<NSD> ...]
4158 NSD NSD(s) to delete (name or ID)
4160 This command is provided by the python-tackerclient plugin.
4162 ns descriptor list
4164 List (NSD)s that belong to a given tenant.
4165 openstack ns descriptor list
4167 [-f {csv,json,table,value,yaml}]
4168 [-c COLUMN]
4169 [--quote {all,minimal,none,nonnumeric}]
4170 [--noindent]
4171 [--max-width <integer>]
4172 [--fit-width]
4173 [--print-empty]
4174 [--sort-column SORT_COLUMN]
4175 [--sort-ascending | --sort-descending]
4176 [--template-source TEMPLATE_SOURCE]
4177 -f <FORMATTER>, --format <FORMATTER>
4179 the output format, defaults to table
4180 -c COLUMN, --column COLUMN
4182 specify the column(s) to include, can be repeated to show multi‐
4183 ple columns
4184 --quote <QUOTE_MODE>
4186 when to include quotes, defaults to nonnumeric
4187 --noindent
4189 whether to disable indenting the JSON
4190 --max-width <integer>
4192 Maximum display width, <1 to disable. You can also use the
4193 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4194 takes precedence.
4195 --fit-width
4197 Fit the table to the display width. Implied if --max-width
4198 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4199 to always enable
4200 --print-empty
4202 Print empty table if there is no data to show.
4203 --sort-column SORT_COLUMN
4205 specify the column(s) to sort the data (columns specified first
4206 have a priority, non-existing columns are ignored), can be re‐
4207 peated
4208 --sort-ascending
4210 sort the column(s) in ascending order
4211 --sort-descending
4213 sort the column(s) in descending order
4214 --template-source <TEMPLATE_SOURCE>
4216 List NSD with specified template source. Available
4217 options are 'onboared' (default), 'inline' or 'all'
4218 This command is provided by the python-tackerclient plugin.
4220 ns descriptor show
4222 Display NSD details
4223 openstack ns descriptor show
4225 [-f {json,shell,table,value,yaml}]
4226 [-c COLUMN]
4227 [--noindent]
4228 [--prefix PREFIX]
4229 [--max-width <integer>]
4230 [--fit-width]
4231 [--print-empty]
4232 <NSD>
4233 -f <FORMATTER>, --format <FORMATTER>
4235 the output format, defaults to table
4236 -c COLUMN, --column COLUMN
4238 specify the column(s) to include, can be repeated to show multi‐
4239 ple columns
4240 --noindent
4242 whether to disable indenting the JSON
4243 --prefix <PREFIX>
4245 add a prefix to all variable names
4246 --max-width <integer>
4248 Maximum display width, <1 to disable. You can also use the
4249 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4250 takes precedence.
4251 --fit-width
4253 Fit the table to the display width. Implied if --max-width
4254 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4255 to always enable
4256 --print-empty
4258 Print empty table if there is no data to show.
4259 NSD NSD to display (name or ID)
4261 This command is provided by the python-tackerclient plugin.
4263 ns descriptor template show
4265 Display NSD Template details
4266 openstack ns descriptor template show
4268 [-f {json,shell,table,value,yaml}]
4269 [-c COLUMN]
4270 [--noindent]
4271 [--prefix PREFIX]
4272 [--max-width <integer>]
4273 [--fit-width]
4274 [--print-empty]
4275 <NSD>
4276 -f <FORMATTER>, --format <FORMATTER>
4278 the output format, defaults to table
4279 -c COLUMN, --column COLUMN
4281 specify the column(s) to include, can be repeated to show multi‐
4282 ple columns
4283 --noindent
4285 whether to disable indenting the JSON
4286 --prefix <PREFIX>
4288 add a prefix to all variable names
4289 --max-width <integer>
4291 Maximum display width, <1 to disable. You can also use the
4292 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4293 takes precedence.
4294 --fit-width
4296 Fit the table to the display width. Implied if --max-width
4297 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4298 to always enable
4299 --print-empty
4301 Print empty table if there is no data to show.
4302 NSD NSD to display (name or ID)
4304 This command is provided by the python-tackerclient plugin.
4306 ns list
4308 List (NS)s that belong to a given tenant.
4309 openstack ns list
4311 [-f {csv,json,table,value,yaml}]
4312 [-c COLUMN]
4313 [--quote {all,minimal,none,nonnumeric}]
4314 [--noindent]
4315 [--max-width <integer>]
4316 [--fit-width]
4317 [--print-empty]
4318 [--sort-column SORT_COLUMN]
4319 [--sort-ascending | --sort-descending]
4320 -f <FORMATTER>, --format <FORMATTER>
4322 the output format, defaults to table
4323 -c COLUMN, --column COLUMN
4325 specify the column(s) to include, can be repeated to show multi‐
4326 ple columns
4327 --quote <QUOTE_MODE>
4329 when to include quotes, defaults to nonnumeric
4330 --noindent
4332 whether to disable indenting the JSON
4333 --max-width <integer>
4335 Maximum display width, <1 to disable. You can also use the
4336 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4337 takes precedence.
4338 --fit-width
4340 Fit the table to the display width. Implied if --max-width
4341 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4342 to always enable
4343 --print-empty
4345 Print empty table if there is no data to show.
4346 --sort-column SORT_COLUMN
4348 specify the column(s) to sort the data (columns specified first
4349 have a priority, non-existing columns are ignored), can be re‐
4350 peated
4351 --sort-ascending
4353 sort the column(s) in ascending order
4354 --sort-descending
4356 sort the column(s) in descending order
4357 This command is provided by the python-tackerclient plugin.
4359 ns show
4361 Display NS details
4362 openstack ns show
4364 [-f {json,shell,table,value,yaml}]
4365 [-c COLUMN]
4366 [--noindent]
4367 [--prefix PREFIX]
4368 [--max-width <integer>]
4369 [--fit-width]
4370 [--print-empty]
4371 <NS>
4372 -f <FORMATTER>, --format <FORMATTER>
4374 the output format, defaults to table
4375 -c COLUMN, --column COLUMN
4377 specify the column(s) to include, can be repeated to show multi‐
4378 ple columns
4379 --noindent
4381 whether to disable indenting the JSON
4382 --prefix <PREFIX>
4384 add a prefix to all variable names
4385 --max-width <integer>
4387 Maximum display width, <1 to disable. You can also use the
4388 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4389 takes precedence.
4390 --fit-width
4392 Fit the table to the display width. Implied if --max-width
4393 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4394 to always enable
4395 --print-empty
4397 Print empty table if there is no data to show.
4398 NS NS to display (name or ID)
4400 This command is provided by the python-tackerclient plugin.
4402 Network Service Descriptor Management commands
4404 WARNING:
4405 Network Service Descriptor Management commands are deprecated and
4406 will be removed in the first major release after the Tacker server
4407 version 9.0.0 (2023.1 Antelope release).
4408 ns descriptor create
4410 Create a new NSD.
4411 openstack ns descriptor create
4413 [-f {json,shell,table,value,yaml}]
4414 [-c COLUMN]
4415 [--noindent]
4416 [--prefix PREFIX]
4417 [--max-width <integer>]
4418 [--fit-width]
4419 [--print-empty]
4420 [--tenant-id TENANT_ID]
4421 --nsd-file NSD_FILE
4422 [--description DESCRIPTION]
4423 NAME
4424 -f <FORMATTER>, --format <FORMATTER>
4426 the output format, defaults to table
4427 -c COLUMN, --column COLUMN
4429 specify the column(s) to include, can be repeated to show multi‐
4430 ple columns
4431 --noindent
4433 whether to disable indenting the JSON
4434 --prefix <PREFIX>
4436 add a prefix to all variable names
4437 --max-width <integer>
4439 Maximum display width, <1 to disable. You can also use the
4440 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4441 takes precedence.
4442 --fit-width
4444 Fit the table to the display width. Implied if --max-width
4445 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4446 to always enable
4447 --print-empty
4449 Print empty table if there is no data to show.
4450 --tenant-id TENANT_ID
4452 The owner tenant ID or project ID
4453 --nsd-file <NSD_FILE>
4455 YAML file with NSD parameters
4456 --description <DESCRIPTION>
4458 Set a description for the NSD
4459 NAME Name for NSD
4461 This command is provided by the python-tackerclient plugin.
4463 ns descriptor delete
4465 Delete NSD(s).
4466 openstack ns descriptor delete <NSD> [<NSD> ...]
4468 NSD NSD(s) to delete (name or ID)
4470 This command is provided by the python-tackerclient plugin.
4472 ns descriptor list
4474 List (NSD)s that belong to a given tenant.
4475 openstack ns descriptor list
4477 [-f {csv,json,table,value,yaml}]
4478 [-c COLUMN]
4479 [--quote {all,minimal,none,nonnumeric}]
4480 [--noindent]
4481 [--max-width <integer>]
4482 [--fit-width]
4483 [--print-empty]
4484 [--sort-column SORT_COLUMN]
4485 [--sort-ascending | --sort-descending]
4486 [--template-source TEMPLATE_SOURCE]
4487 -f <FORMATTER>, --format <FORMATTER>
4489 the output format, defaults to table
4490 -c COLUMN, --column COLUMN
4492 specify the column(s) to include, can be repeated to show multi‐
4493 ple columns
4494 --quote <QUOTE_MODE>
4496 when to include quotes, defaults to nonnumeric
4497 --noindent
4499 whether to disable indenting the JSON
4500 --max-width <integer>
4502 Maximum display width, <1 to disable. You can also use the
4503 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4504 takes precedence.
4505 --fit-width
4507 Fit the table to the display width. Implied if --max-width
4508 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4509 to always enable
4510 --print-empty
4512 Print empty table if there is no data to show.
4513 --sort-column SORT_COLUMN
4515 specify the column(s) to sort the data (columns specified first
4516 have a priority, non-existing columns are ignored), can be re‐
4517 peated
4518 --sort-ascending
4520 sort the column(s) in ascending order
4521 --sort-descending
4523 sort the column(s) in descending order
4524 --template-source <TEMPLATE_SOURCE>
4526 List NSD with specified template source. Available
4527 options are 'onboared' (default), 'inline' or 'all'
4528 This command is provided by the python-tackerclient plugin.
4530 ns descriptor show
4532 Display NSD details
4533 openstack ns descriptor show
4535 [-f {json,shell,table,value,yaml}]
4536 [-c COLUMN]
4537 [--noindent]
4538 [--prefix PREFIX]
4539 [--max-width <integer>]
4540 [--fit-width]
4541 [--print-empty]
4542 <NSD>
4543 -f <FORMATTER>, --format <FORMATTER>
4545 the output format, defaults to table
4546 -c COLUMN, --column COLUMN
4548 specify the column(s) to include, can be repeated to show multi‐
4549 ple columns
4550 --noindent
4552 whether to disable indenting the JSON
4553 --prefix <PREFIX>
4555 add a prefix to all variable names
4556 --max-width <integer>
4558 Maximum display width, <1 to disable. You can also use the
4559 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4560 takes precedence.
4561 --fit-width
4563 Fit the table to the display width. Implied if --max-width
4564 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4565 to always enable
4566 --print-empty
4568 Print empty table if there is no data to show.
4569 NSD NSD to display (name or ID)
4571 This command is provided by the python-tackerclient plugin.
4573 ns descriptor template show
4575 Display NSD Template details
4576 openstack ns descriptor template show
4578 [-f {json,shell,table,value,yaml}]
4579 [-c COLUMN]
4580 [--noindent]
4581 [--prefix PREFIX]
4582 [--max-width <integer>]
4583 [--fit-width]
4584 [--print-empty]
4585 <NSD>
4586 -f <FORMATTER>, --format <FORMATTER>
4588 the output format, defaults to table
4589 -c COLUMN, --column COLUMN
4591 specify the column(s) to include, can be repeated to show multi‐
4592 ple columns
4593 --noindent
4595 whether to disable indenting the JSON
4596 --prefix <PREFIX>
4598 add a prefix to all variable names
4599 --max-width <integer>
4601 Maximum display width, <1 to disable. You can also use the
4602 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4603 takes precedence.
4604 --fit-width
4606 Fit the table to the display width. Implied if --max-width
4607 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4608 to always enable
4609 --print-empty
4611 Print empty table if there is no data to show.
4612 NSD NSD to display (name or ID)
4614 This command is provided by the python-tackerclient plugin.
4616 VNF Forwarding Graph (VNFFG) Management commands
4618 WARNING:
4619 VNF Forwarding Graph (VNFFG) Management commands are deprecated and
4620 will be removed in the first major release after the Tacker server
4621 version 9.0.0 (2023.1 Antelope release).
4622 vnf graph create
4624 Create a new VNFFG.
4625 openstack vnf graph create
4627 [-f {json,shell,table,value,yaml}]
4628 [-c COLUMN]
4629 [--noindent]
4630 [--prefix PREFIX]
4631 [--max-width <integer>]
4632 [--fit-width]
4633 [--print-empty]
4634 [--tenant-id TENANT_ID]
4635 (--vnffgd-id VNFFGD_ID | --vnffgd-name VNFFGD_NAME | --vnffgd-template VNFFGD_TEMPLATE)
4636 [--vnf-mapping VNF_MAPPING]
4637 [--symmetrical]
4638 [--param-file PARAM_FILE]
4639 [--description DESCRIPTION]
4640 NAME
4641 -f <FORMATTER>, --format <FORMATTER>
4643 the output format, defaults to table
4644 -c COLUMN, --column COLUMN
4646 specify the column(s) to include, can be repeated to show multi‐
4647 ple columns
4648 --noindent
4650 whether to disable indenting the JSON
4651 --prefix <PREFIX>
4653 add a prefix to all variable names
4654 --max-width <integer>
4656 Maximum display width, <1 to disable. You can also use the
4657 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4658 takes precedence.
4659 --fit-width
4661 Fit the table to the display width. Implied if --max-width
4662 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4663 to always enable
4664 --print-empty
4666 Print empty table if there is no data to show.
4667 --tenant-id TENANT_ID
4669 The owner tenant ID
4670 --vnffgd-id <VNFFGD_ID>
4672 VNFFGD ID to use as template to create VNFFG
4673 --vnffgd-name <VNFFGD_NAME>
4675 VNFFGD Name to use as template to create VNFFG
4676 --vnffgd-template <VNFFGD_TEMPLATE>
4678 VNFFGD file to create VNFFG
4679 --vnf-mapping <VNF_MAPPING>
4681 List of logical VNFD name to VNF instance name mapping. Example:
4682 VNF1:my_vnf1,VNF2:my_vnf2
4683 --symmetrical
4685 Should a reverse path be created for the NFP (True or False)
4686 --param-file <PARAM_FILE>
4688 YAML file with specific VNFFG parameters
4689 --description <DESCRIPTION>
4691 Set a description for the VNFFG
4692 NAME Set a name for the VNFFG
4694 This command is provided by the python-tackerclient plugin.
4696 vnf graph delete
4698 Delete VNFFG(s).
4699 openstack vnf graph delete [--force] <VNFFG> [<VNFFG> ...]
4701 --force
4703 Force delete VNFFG
4704 VNFFG VNFFG(s) to delete (name or ID)
4706 This command is provided by the python-tackerclient plugin.
4708 vnf graph descriptor create
4710 Create a new VNFFGD
4711 openstack vnf graph descriptor create
4713 [-f {json,shell,table,value,yaml}]
4714 [-c COLUMN]
4715 [--noindent]
4716 [--prefix PREFIX]
4717 [--max-width <integer>]
4718 [--fit-width]
4719 [--print-empty]
4720 [--tenant-id TENANT_ID]
4721 --vnffgd-file VNFFGD_FILE
4722 [--description DESCRIPTION]
4723 NAME
4724 -f <FORMATTER>, --format <FORMATTER>
4726 the output format, defaults to table
4727 -c COLUMN, --column COLUMN
4729 specify the column(s) to include, can be repeated to show multi‐
4730 ple columns
4731 --noindent
4733 whether to disable indenting the JSON
4734 --prefix <PREFIX>
4736 add a prefix to all variable names
4737 --max-width <integer>
4739 Maximum display width, <1 to disable. You can also use the
4740 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4741 takes precedence.
4742 --fit-width
4744 Fit the table to the display width. Implied if --max-width
4745 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4746 to always enable
4747 --print-empty
4749 Print empty table if there is no data to show.
4750 --tenant-id TENANT_ID
4752 The owner tenant ID or project ID
4753 --vnffgd-file <VNFFGD_FILE>
4755 YAML file with VNFFGD parameters
4756 --description <DESCRIPTION>
4758 Set a description for the VNFFGD
4759 NAME Name for VNFFGD
4761 This command is provided by the python-tackerclient plugin.
4763 vnf graph descriptor delete
4765 Delete VNFFGD(s).
4766 openstack vnf graph descriptor delete <VNFFGD> [<VNFFGD> ...]
4768 VNFFGD VNFFGD(s) to delete (name or ID)
4770 This command is provided by the python-tackerclient plugin.
4772 vnf graph descriptor list
4774 List (VNFFGD)s that belong to a given tenant.
4775 openstack vnf graph descriptor list
4777 [-f {csv,json,table,value,yaml}]
4778 [-c COLUMN]
4779 [--quote {all,minimal,none,nonnumeric}]
4780 [--noindent]
4781 [--max-width <integer>]
4782 [--fit-width]
4783 [--print-empty]
4784 [--sort-column SORT_COLUMN]
4785 [--sort-ascending | --sort-descending]
4786 [--template-source TEMPLATE_SOURCE]
4787 -f <FORMATTER>, --format <FORMATTER>
4789 the output format, defaults to table
4790 -c COLUMN, --column COLUMN
4792 specify the column(s) to include, can be repeated to show multi‐
4793 ple columns
4794 --quote <QUOTE_MODE>
4796 when to include quotes, defaults to nonnumeric
4797 --noindent
4799 whether to disable indenting the JSON
4800 --max-width <integer>
4802 Maximum display width, <1 to disable. You can also use the
4803 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4804 takes precedence.
4805 --fit-width
4807 Fit the table to the display width. Implied if --max-width
4808 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4809 to always enable
4810 --print-empty
4812 Print empty table if there is no data to show.
4813 --sort-column SORT_COLUMN
4815 specify the column(s) to sort the data (columns specified first
4816 have a priority, non-existing columns are ignored), can be re‐
4817 peated
4818 --sort-ascending
4820 sort the column(s) in ascending order
4821 --sort-descending
4823 sort the column(s) in descending order
4824 --template-source <TEMPLATE_SOURCE>
4826 List VNFFGD with specified template source. Available
4827 options are 'onboarded' (default), 'inline' or 'all'
4828 This command is provided by the python-tackerclient plugin.
4830 vnf graph descriptor show
4832 Display VNFFGD details
4833 openstack vnf graph descriptor show
4835 [-f {json,shell,table,value,yaml}]
4836 [-c COLUMN]
4837 [--noindent]
4838 [--prefix PREFIX]
4839 [--max-width <integer>]
4840 [--fit-width]
4841 [--print-empty]
4842 <VNFFGD>
4843 -f <FORMATTER>, --format <FORMATTER>
4845 the output format, defaults to table
4846 -c COLUMN, --column COLUMN
4848 specify the column(s) to include, can be repeated to show multi‐
4849 ple columns
4850 --noindent
4852 whether to disable indenting the JSON
4853 --prefix <PREFIX>
4855 add a prefix to all variable names
4856 --max-width <integer>
4858 Maximum display width, <1 to disable. You can also use the
4859 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4860 takes precedence.
4861 --fit-width
4863 Fit the table to the display width. Implied if --max-width
4864 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4865 to always enable
4866 --print-empty
4868 Print empty table if there is no data to show.
4869 VNFFGD VNFFGD to display (name or ID)
4871 This command is provided by the python-tackerclient plugin.
4873 vnf graph descriptor template show
4875 Display VNFFGD Template details
4876 openstack vnf graph descriptor template show
4878 [-f {json,shell,table,value,yaml}]
4879 [-c COLUMN]
4880 [--noindent]
4881 [--prefix PREFIX]
4882 [--max-width <integer>]
4883 [--fit-width]
4884 [--print-empty]
4885 <VNFFGD>
4886 -f <FORMATTER>, --format <FORMATTER>
4888 the output format, defaults to table
4889 -c COLUMN, --column COLUMN
4891 specify the column(s) to include, can be repeated to show multi‐
4892 ple columns
4893 --noindent
4895 whether to disable indenting the JSON
4896 --prefix <PREFIX>
4898 add a prefix to all variable names
4899 --max-width <integer>
4901 Maximum display width, <1 to disable. You can also use the
4902 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4903 takes precedence.
4904 --fit-width
4906 Fit the table to the display width. Implied if --max-width
4907 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4908 to always enable
4909 --print-empty
4911 Print empty table if there is no data to show.
4912 VNFFGD VNFFGD to display (name or ID)
4914 This command is provided by the python-tackerclient plugin.
4916 vnf graph list
4918 List VNFFG(s) that belong to a given tenant.
4919 openstack vnf graph list
4921 [-f {csv,json,table,value,yaml}]
4922 [-c COLUMN]
4923 [--quote {all,minimal,none,nonnumeric}]
4924 [--noindent]
4925 [--max-width <integer>]
4926 [--fit-width]
4927 [--print-empty]
4928 [--sort-column SORT_COLUMN]
4929 [--sort-ascending | --sort-descending]
4930 [--long]
4931 -f <FORMATTER>, --format <FORMATTER>
4933 the output format, defaults to table
4934 -c COLUMN, --column COLUMN
4936 specify the column(s) to include, can be repeated to show multi‐
4937 ple columns
4938 --quote <QUOTE_MODE>
4940 when to include quotes, defaults to nonnumeric
4941 --noindent
4943 whether to disable indenting the JSON
4944 --max-width <integer>
4946 Maximum display width, <1 to disable. You can also use the
4947 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
4948 takes precedence.
4949 --fit-width
4951 Fit the table to the display width. Implied if --max-width
4952 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
4953 to always enable
4954 --print-empty
4956 Print empty table if there is no data to show.
4957 --sort-column SORT_COLUMN
4959 specify the column(s) to sort the data (columns specified first
4960 have a priority, non-existing columns are ignored), can be re‐
4961 peated
4962 --sort-ascending
4964 sort the column(s) in ascending order
4965 --sort-descending
4967 sort the column(s) in descending order
4968 --long List additional fields in output
4970 This command is provided by the python-tackerclient plugin.
4972 vnf graph set
4974 Update VNFFG.
4975 openstack vnf graph set
4977 [-f {json,shell,table,value,yaml}]
4978 [-c COLUMN]
4979 [--noindent]
4980 [--prefix PREFIX]
4981 [--max-width <integer>]
4982 [--fit-width]
4983 [--print-empty]
4984 [--vnffgd-template VNFFGD_TEMPLATE]
4985 [--vnf-mapping VNF_MAPPING]
4986 [--symmetrical]
4987 [--description DESCRIPTION]
4988 [--param-file PARAM_FILE]
4989 <VNFFG>
4990 -f <FORMATTER>, --format <FORMATTER>
4992 the output format, defaults to table
4993 -c COLUMN, --column COLUMN
4995 specify the column(s) to include, can be repeated to show multi‐
4996 ple columns
4997 --noindent
4999 whether to disable indenting the JSON
5000 --prefix <PREFIX>
5002 add a prefix to all variable names
5003 --max-width <integer>
5005 Maximum display width, <1 to disable. You can also use the
5006 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5007 takes precedence.
5008 --fit-width
5010 Fit the table to the display width. Implied if --max-width
5011 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5012 to always enable
5013 --print-empty
5015 Print empty table if there is no data to show.
5016 --vnffgd-template <VNFFGD_TEMPLATE>
5018 VNFFGD file to update VNFFG
5019 --vnf-mapping <VNF_MAPPING>
5021 List of logical VNFD name to VNF instance name mapping. Exam‐
5022 ple: VNF1:my_vnf1,VNF2:my_vnf2
5023 --symmetrical
5025 Should a reverse path be created for the NFP
5026 --description <DESCRIPTION>
5028 Set a description for the VNFFG
5029 --param-file <PARAM_FILE>
5031 YAML file with specific VNFFG parameters
5032 VNFFG VNFFG to update (name or ID)
5034 This command is provided by the python-tackerclient plugin.
5036 vnf graph show
5038 Display VNFFG details
5039 openstack vnf graph show
5041 [-f {json,shell,table,value,yaml}]
5042 [-c COLUMN]
5043 [--noindent]
5044 [--prefix PREFIX]
5045 [--max-width <integer>]
5046 [--fit-width]
5047 [--print-empty]
5048 <VNFFG>
5049 -f <FORMATTER>, --format <FORMATTER>
5051 the output format, defaults to table
5052 -c COLUMN, --column COLUMN
5054 specify the column(s) to include, can be repeated to show multi‐
5055 ple columns
5056 --noindent
5058 whether to disable indenting the JSON
5059 --prefix <PREFIX>
5061 add a prefix to all variable names
5062 --max-width <integer>
5064 Maximum display width, <1 to disable. You can also use the
5065 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5066 takes precedence.
5067 --fit-width
5069 Fit the table to the display width. Implied if --max-width
5070 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5071 to always enable
5072 --print-empty
5074 Print empty table if there is no data to show.
5075 VNFFG VNFFG to display (name or ID)
5077 This command is provided by the python-tackerclient plugin.
5079 VNF Forwarding Graph Descriptor (VNFFGD) Management commands
5081 WARNING:
5082 VNF Forwarding Graph Descriptor (VNFFGD) Management commands are
5083 deprecated and will be removed in the first major release after the
5084 Tacker server version 9.0.0 (2023.1 Antelope release).
5085 vnf graph descriptor create
5087 Create a new VNFFGD
5088 openstack vnf graph descriptor create
5090 [-f {json,shell,table,value,yaml}]
5091 [-c COLUMN]
5092 [--noindent]
5093 [--prefix PREFIX]
5094 [--max-width <integer>]
5095 [--fit-width]
5096 [--print-empty]
5097 [--tenant-id TENANT_ID]
5098 --vnffgd-file VNFFGD_FILE
5099 [--description DESCRIPTION]
5100 NAME
5101 -f <FORMATTER>, --format <FORMATTER>
5103 the output format, defaults to table
5104 -c COLUMN, --column COLUMN
5106 specify the column(s) to include, can be repeated to show multi‐
5107 ple columns
5108 --noindent
5110 whether to disable indenting the JSON
5111 --prefix <PREFIX>
5113 add a prefix to all variable names
5114 --max-width <integer>
5116 Maximum display width, <1 to disable. You can also use the
5117 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5118 takes precedence.
5119 --fit-width
5121 Fit the table to the display width. Implied if --max-width
5122 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5123 to always enable
5124 --print-empty
5126 Print empty table if there is no data to show.
5127 --tenant-id TENANT_ID
5129 The owner tenant ID or project ID
5130 --vnffgd-file <VNFFGD_FILE>
5132 YAML file with VNFFGD parameters
5133 --description <DESCRIPTION>
5135 Set a description for the VNFFGD
5136 NAME Name for VNFFGD
5138 This command is provided by the python-tackerclient plugin.
5140 vnf graph descriptor delete
5142 Delete VNFFGD(s).
5143 openstack vnf graph descriptor delete <VNFFGD> [<VNFFGD> ...]
5145 VNFFGD VNFFGD(s) to delete (name or ID)
5147 This command is provided by the python-tackerclient plugin.
5149 vnf graph descriptor list
5151 List (VNFFGD)s that belong to a given tenant.
5152 openstack vnf graph descriptor list
5154 [-f {csv,json,table,value,yaml}]
5155 [-c COLUMN]
5156 [--quote {all,minimal,none,nonnumeric}]
5157 [--noindent]
5158 [--max-width <integer>]
5159 [--fit-width]
5160 [--print-empty]
5161 [--sort-column SORT_COLUMN]
5162 [--sort-ascending | --sort-descending]
5163 [--template-source TEMPLATE_SOURCE]
5164 -f <FORMATTER>, --format <FORMATTER>
5166 the output format, defaults to table
5167 -c COLUMN, --column COLUMN
5169 specify the column(s) to include, can be repeated to show multi‐
5170 ple columns
5171 --quote <QUOTE_MODE>
5173 when to include quotes, defaults to nonnumeric
5174 --noindent
5176 whether to disable indenting the JSON
5177 --max-width <integer>
5179 Maximum display width, <1 to disable. You can also use the
5180 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5181 takes precedence.
5182 --fit-width
5184 Fit the table to the display width. Implied if --max-width
5185 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5186 to always enable
5187 --print-empty
5189 Print empty table if there is no data to show.
5190 --sort-column SORT_COLUMN
5192 specify the column(s) to sort the data (columns specified first
5193 have a priority, non-existing columns are ignored), can be re‐
5194 peated
5195 --sort-ascending
5197 sort the column(s) in ascending order
5198 --sort-descending
5200 sort the column(s) in descending order
5201 --template-source <TEMPLATE_SOURCE>
5203 List VNFFGD with specified template source. Available
5204 options are 'onboarded' (default), 'inline' or 'all'
5205 This command is provided by the python-tackerclient plugin.
5207 vnf graph descriptor show
5209 Display VNFFGD details
5210 openstack vnf graph descriptor show
5212 [-f {json,shell,table,value,yaml}]
5213 [-c COLUMN]
5214 [--noindent]
5215 [--prefix PREFIX]
5216 [--max-width <integer>]
5217 [--fit-width]
5218 [--print-empty]
5219 <VNFFGD>
5220 -f <FORMATTER>, --format <FORMATTER>
5222 the output format, defaults to table
5223 -c COLUMN, --column COLUMN
5225 specify the column(s) to include, can be repeated to show multi‐
5226 ple columns
5227 --noindent
5229 whether to disable indenting the JSON
5230 --prefix <PREFIX>
5232 add a prefix to all variable names
5233 --max-width <integer>
5235 Maximum display width, <1 to disable. You can also use the
5236 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5237 takes precedence.
5238 --fit-width
5240 Fit the table to the display width. Implied if --max-width
5241 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5242 to always enable
5243 --print-empty
5245 Print empty table if there is no data to show.
5246 VNFFGD VNFFGD to display (name or ID)
5248 This command is provided by the python-tackerclient plugin.
5250 vnf graph descriptor template show
5252 Display VNFFGD Template details
5253 openstack vnf graph descriptor template show
5255 [-f {json,shell,table,value,yaml}]
5256 [-c COLUMN]
5257 [--noindent]
5258 [--prefix PREFIX]
5259 [--max-width <integer>]
5260 [--fit-width]
5261 [--print-empty]
5262 <VNFFGD>
5263 -f <FORMATTER>, --format <FORMATTER>
5265 the output format, defaults to table
5266 -c COLUMN, --column COLUMN
5268 specify the column(s) to include, can be repeated to show multi‐
5269 ple columns
5270 --noindent
5272 whether to disable indenting the JSON
5273 --prefix <PREFIX>
5275 add a prefix to all variable names
5276 --max-width <integer>
5278 Maximum display width, <1 to disable. You can also use the
5279 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5280 takes precedence.
5281 --fit-width
5283 Fit the table to the display width. Implied if --max-width
5284 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5285 to always enable
5286 --print-empty
5288 Print empty table if there is no data to show.
5289 VNFFGD VNFFGD to display (name or ID)
5291 This command is provided by the python-tackerclient plugin.
5293 Service Function Chain (SFC) Management commands
5295 WARNING:
5296 Service Function Chain (SFC) Management commands are deprecated and
5297 will be removed in the first major release after the Tacker server
5298 version 9.0.0 (2023.1 Antelope release).
5299 vnf chain list
5301 List SFC(s) that belong to a given tenant.
5302 openstack vnf chain list
5304 [-f {csv,json,table,value,yaml}]
5305 [-c COLUMN]
5306 [--quote {all,minimal,none,nonnumeric}]
5307 [--noindent]
5308 [--max-width <integer>]
5309 [--fit-width]
5310 [--print-empty]
5311 [--sort-column SORT_COLUMN]
5312 [--sort-ascending | --sort-descending]
5313 [--nfp-id NFP_ID]
5314 [--tenant-id TENANT_ID]
5315 -f <FORMATTER>, --format <FORMATTER>
5317 the output format, defaults to table
5318 -c COLUMN, --column COLUMN
5320 specify the column(s) to include, can be repeated to show multi‐
5321 ple columns
5322 --quote <QUOTE_MODE>
5324 when to include quotes, defaults to nonnumeric
5325 --noindent
5327 whether to disable indenting the JSON
5328 --max-width <integer>
5330 Maximum display width, <1 to disable. You can also use the
5331 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5332 takes precedence.
5333 --fit-width
5335 Fit the table to the display width. Implied if --max-width
5336 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5337 to always enable
5338 --print-empty
5340 Print empty table if there is no data to show.
5341 --sort-column SORT_COLUMN
5343 specify the column(s) to sort the data (columns specified first
5344 have a priority, non-existing columns are ignored), can be re‐
5345 peated
5346 --sort-ascending
5348 sort the column(s) in ascending order
5349 --sort-descending
5351 sort the column(s) in descending order
5352 --nfp-id <NFP_ID>
5354 List SFC(s) with specific nfp id
5355 --tenant-id TENANT_ID
5357 The owner tenant ID or project ID
5358 This command is provided by the python-tackerclient plugin.
5360 vnf chain show
5362 Display SFC details
5363 openstack vnf chain show
5365 [-f {json,shell,table,value,yaml}]
5366 [-c COLUMN]
5367 [--noindent]
5368 [--prefix PREFIX]
5369 [--max-width <integer>]
5370 [--fit-width]
5371 [--print-empty]
5372 <SFC>
5373 -f <FORMATTER>, --format <FORMATTER>
5375 the output format, defaults to table
5376 -c COLUMN, --column COLUMN
5378 specify the column(s) to include, can be repeated to show multi‐
5379 ple columns
5380 --noindent
5382 whether to disable indenting the JSON
5383 --prefix <PREFIX>
5385 add a prefix to all variable names
5386 --max-width <integer>
5388 Maximum display width, <1 to disable. You can also use the
5389 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5390 takes precedence.
5391 --fit-width
5393 Fit the table to the display width. Implied if --max-width
5394 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5395 to always enable
5396 --print-empty
5398 Print empty table if there is no data to show.
5399 SFC SFC to display (name or ID)
5401 This command is provided by the python-tackerclient plugin.
5403 Flow Classifier Management commands
5405 WARNING:
5406 Flow Classifier Management commands are deprecated and will be re‐
5407 moved in the first major release after the Tacker server version
5408 9.0.0 (2023.1 Antelope release).
5409 vnf classifier list
5411 List flow classifier(s) that belong to a given tenant.
5412 openstack vnf classifier list
5414 [-f {csv,json,table,value,yaml}]
5415 [-c COLUMN]
5416 [--quote {all,minimal,none,nonnumeric}]
5417 [--noindent]
5418 [--max-width <integer>]
5419 [--fit-width]
5420 [--print-empty]
5421 [--sort-column SORT_COLUMN]
5422 [--sort-ascending | --sort-descending]
5423 [--nfp-id NFP_ID]
5424 [--tenant-id TENANT_ID]
5425 -f <FORMATTER>, --format <FORMATTER>
5427 the output format, defaults to table
5428 -c COLUMN, --column COLUMN
5430 specify the column(s) to include, can be repeated to show multi‐
5431 ple columns
5432 --quote <QUOTE_MODE>
5434 when to include quotes, defaults to nonnumeric
5435 --noindent
5437 whether to disable indenting the JSON
5438 --max-width <integer>
5440 Maximum display width, <1 to disable. You can also use the
5441 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5442 takes precedence.
5443 --fit-width
5445 Fit the table to the display width. Implied if --max-width
5446 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5447 to always enable
5448 --print-empty
5450 Print empty table if there is no data to show.
5451 --sort-column SORT_COLUMN
5453 specify the column(s) to sort the data (columns specified first
5454 have a priority, non-existing columns are ignored), can be re‐
5455 peated
5456 --sort-ascending
5458 sort the column(s) in ascending order
5459 --sort-descending
5461 sort the column(s) in descending order
5462 --nfp-id <NFP_ID>
5464 List flow classifier(s) with specific nfp id
5465 --tenant-id TENANT_ID
5467 The owner tenant ID or project ID
5468 This command is provided by the python-tackerclient plugin.
5470 vnf classifier show
5472 Display flow classifier details
5473 openstack vnf classifier show
5475 [-f {json,shell,table,value,yaml}]
5476 [-c COLUMN]
5477 [--noindent]
5478 [--prefix PREFIX]
5479 [--max-width <integer>]
5480 [--fit-width]
5481 [--print-empty]
5482 <Classifier
5483 ID>
5484 -f <FORMATTER>, --format <FORMATTER>
5486 the output format, defaults to table
5487 -c COLUMN, --column COLUMN
5489 specify the column(s) to include, can be repeated to show multi‐
5490 ple columns
5491 --noindent
5493 whether to disable indenting the JSON
5494 --prefix <PREFIX>
5496 add a prefix to all variable names
5497 --max-width <integer>
5499 Maximum display width, <1 to disable. You can also use the
5500 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5501 takes precedence.
5502 --fit-width
5504 Fit the table to the display width. Implied if --max-width
5505 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5506 to always enable
5507 --print-empty
5509 Print empty table if there is no data to show.
5510 Classifier ID
5512 Flow Classifier to display (name or ID)
5513 This command is provided by the python-tackerclient plugin.
5515 Network Forwarding Path Management commands
5517 WARNING:
5518 Network Forwarding Path Management commands are deprecated and will
5519 be removed in the first major release after the Tacker server ver‐
5520 sion 9.0.0 (2023.1 Antelope release).
5521 vnf network forwarding path list
5523 List NFP(s) that belong to a given tenant.
5524 openstack vnf network forwarding path list
5526 [-f {csv,json,table,value,yaml}]
5527 [-c COLUMN]
5528 [--quote {all,minimal,none,nonnumeric}]
5529 [--noindent]
5530 [--max-width <integer>]
5531 [--fit-width]
5532 [--print-empty]
5533 [--sort-column SORT_COLUMN]
5534 [--sort-ascending | --sort-descending]
5535 [--vnffg-id VNFFG_ID]
5536 -f <FORMATTER>, --format <FORMATTER>
5538 the output format, defaults to table
5539 -c COLUMN, --column COLUMN
5541 specify the column(s) to include, can be repeated to show multi‐
5542 ple columns
5543 --quote <QUOTE_MODE>
5545 when to include quotes, defaults to nonnumeric
5546 --noindent
5548 whether to disable indenting the JSON
5549 --max-width <integer>
5551 Maximum display width, <1 to disable. You can also use the
5552 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5553 takes precedence.
5554 --fit-width
5556 Fit the table to the display width. Implied if --max-width
5557 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5558 to always enable
5559 --print-empty
5561 Print empty table if there is no data to show.
5562 --sort-column SORT_COLUMN
5564 specify the column(s) to sort the data (columns specified first
5565 have a priority, non-existing columns are ignored), can be re‐
5566 peated
5567 --sort-ascending
5569 sort the column(s) in ascending order
5570 --sort-descending
5572 sort the column(s) in descending order
5573 --vnffg-id <VNFFG_ID>
5575 List NFP(s) with specific VNFFG ID
5576 This command is provided by the python-tackerclient plugin.
5578 vnf network forwarding path show
5580 Display NFP details
5581 openstack vnf network forwarding path show
5583 [-f {json,shell,table,value,yaml}]
5584 [-c COLUMN]
5585 [--noindent]
5586 [--prefix PREFIX]
5587 [--max-width <integer>]
5588 [--fit-width]
5589 [--print-empty]
5590 <NFP>
5591 -f <FORMATTER>, --format <FORMATTER>
5593 the output format, defaults to table
5594 -c COLUMN, --column COLUMN
5596 specify the column(s) to include, can be repeated to show multi‐
5597 ple columns
5598 --noindent
5600 whether to disable indenting the JSON
5601 --prefix <PREFIX>
5603 add a prefix to all variable names
5604 --max-width <integer>
5606 Maximum display width, <1 to disable. You can also use the
5607 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5608 takes precedence.
5609 --fit-width
5611 Fit the table to the display width. Implied if --max-width
5612 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5613 to always enable
5614 --print-empty
5616 Print empty table if there is no data to show.
5617 NFP NFP to display (name or ID)
5619 This command is provided by the python-tackerclient plugin.
5621 Event Management commands
5623 WARNING:
5624 Event Management commands are deprecated and will be removed in the
5625 first major release after the Tacker server version 9.0.0 (2023.1
5626 Antelope release).
5627 nfv event list
5629 List events of resources.
5630 openstack nfv event list
5632 [-f {csv,json,table,value,yaml}]
5633 [-c COLUMN]
5634 [--quote {all,minimal,none,nonnumeric}]
5635 [--noindent]
5636 [--max-width <integer>]
5637 [--fit-width]
5638 [--print-empty]
5639 [--sort-column SORT_COLUMN]
5640 [--sort-ascending | --sort-descending]
5641 [--id ID]
5642 [--resource-type RESOURCE_TYPE]
5643 [--resource-id RESOURCE_ID]
5644 [--resource-state RESOURCE_STATE]
5645 [--event-type EVENT_TYPE]
5646 [--long]
5647 -f <FORMATTER>, --format <FORMATTER>
5649 the output format, defaults to table
5650 -c COLUMN, --column COLUMN
5652 specify the column(s) to include, can be repeated to show multi‐
5653 ple columns
5654 --quote <QUOTE_MODE>
5656 when to include quotes, defaults to nonnumeric
5657 --noindent
5659 whether to disable indenting the JSON
5660 --max-width <integer>
5662 Maximum display width, <1 to disable. You can also use the
5663 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5664 takes precedence.
5665 --fit-width
5667 Fit the table to the display width. Implied if --max-width
5668 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5669 to always enable
5670 --print-empty
5672 Print empty table if there is no data to show.
5673 --sort-column SORT_COLUMN
5675 specify the column(s) to sort the data (columns specified first
5676 have a priority, non-existing columns are ignored), can be re‐
5677 peated
5678 --sort-ascending
5680 sort the column(s) in ascending order
5681 --sort-descending
5683 sort the column(s) in descending order
5684 --id <ID>
5686 id of the event to look up.
5687 --resource-type <RESOURCE_TYPE>
5689 resource type of the events to look up.
5690 --resource-id <RESOURCE_ID>
5692 resource id of the events to look up.
5693 --resource-state <RESOURCE_STATE>
5695 resource state of the events to look up.
5696 --event-type <EVENT_TYPE>
5698 event type of the events to look up.
5699 --long List additional fields in output
5701 This command is provided by the python-tackerclient plugin.
5703 nfv event show
5705 Show event given the event id.
5706 openstack nfv event show
5708 [-f {json,shell,table,value,yaml}]
5709 [-c COLUMN]
5710 [--noindent]
5711 [--prefix PREFIX]
5712 [--max-width <integer>]
5713 [--fit-width]
5714 [--print-empty]
5715 ID
5716 -f <FORMATTER>, --format <FORMATTER>
5718 the output format, defaults to table
5719 -c COLUMN, --column COLUMN
5721 specify the column(s) to include, can be repeated to show multi‐
5722 ple columns
5723 --noindent
5725 whether to disable indenting the JSON
5726 --prefix <PREFIX>
5728 add a prefix to all variable names
5729 --max-width <integer>
5731 Maximum display width, <1 to disable. You can also use the
5732 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
5733 takes precedence.
5734 --fit-width
5736 Fit the table to the display width. Implied if --max-width
5737 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
5738 to always enable
5739 --print-empty
5741 Print empty table if there is no data to show.
5742 ID ID of event to display
5744 This command is provided by the python-tackerclient plugin.
5746
5748 OpenStack Contributors
5749
5751 OpenStack Contributors
57521.13.0 Jul 21, 2023 TACKER(1)