1TACKER(1) python-tackerclient TACKER(1)
2
6 tacker - Client for Tacker API
7
9 The following list covers the extended commands for Tacker services
10 available in openstack command.
11 These commands can be referenced by doing openstack help and the detail
13 of individual command can be referred by openstack help <command-name>.
14 openstack vnf create Create a VNF.
16 openstack vnf delete Delete given VNF(s).
17 openstack vnf list List VNF(s) that belong to a given tenant.
18 openstack vnf resource list List resources of a VNF like VDU, CP, etc.
19 openstack vnf scale Scale a VNF.
20 openstack vnf show Show information of a given VNF.
21 openstack vnf set Update a given VNF.
22 openstack vnf descriptor create Create a VNFD.
23 openstack vnf descriptor delete Delete given VNFD(s).
24 openstack vnf descriptor list List VNFD(s) that belong to a given tenant.
25 openstack vnf descriptor show Show information of a given VNFD.
26 openstack vnf descriptor template show Show template of a given VNFD.
27 openstack vim list List VIM(s) that belong to a given tenant.
28 openstack vim register Create a VIM.
29 openstack vim show Show information of a given VIM.
30 openstack vim set Update a given VIM.
31 openstack vim delete Delete given VIM(s).
32 openstack ns create Create a NS.
33 openstack ns delete Delete given NS(s).
34 openstack ns list List NS that belong to a given tenant.
35 openstack ns show Show information of a given NS.
36 openstack ns descriptor create Create a NSD.
37 openstack ns descriptor delete Delete a given NSD.
38 openstack ns descriptor list List NSD(s) that belong to a given tenant.
39 openstack ns descriptor show Show information of a given NSD.
40 openstack ns descriptor template show Show template of a given NSD.
41 openstack vnf graph create Create a VNFFG.
42 openstack vnf graph delete Delete a given VNFFG.
43 openstack vnf graph list List VNFFG(s) that belong to a given tenant.
44 openstack vnf graph show Show information of a given VNFFG.
45 openstack vnf graph set Update a given VNFFG.
46 openstack vnf graph descriptor create Create a VNFFGD.
47 openstack vnf graph descriptor delete Delete a given VNFFGD.
48 openstack vnf graph descriptor list List VNFFGD(s) that belong to a given tenant.
49 openstack vnf graph descriptor show Show information of a given VNFFGD.
50 openstack vnf graph descriptor template show Show template of a given VNFFGD.
51 openstack vnf chain list List SFC(s) that belong to a given tenant.
52 openstack vnf chain show Show information of a given SFC.
53 openstack vnf classifier list List FC(s) that belong to a given tenant.
54 openstack vnf classifier show Show information of a given FC.
55 openstack vnf network forwarding path list List NFP(s) that belong to a given tenant.
56 openstack vnf network forwarding path show Show information of a given NFP.
57 openstack nfv event show Show event given the event id.
58 openstack nfv event list List events of resources.
59 openstack vnf package create Create a new individual VNF package resource.
60 openstack vnf package list List all VNF packages.
61 openstack vnf package show Show package details.
62 openstack vnf package upload Upload a VNF package by providing the address information
63 of the VNF package.
64 openstack vnf package delete Delete given VNF package(s).
65
67 VNF Package commands are CLI interface of VNF Package Management Inter‐
68 face in ETSI NFV-SOL 005.
69 vnf package artifact download
71 Download VNF package artifact of an on-boarded VNF package.
72 openstack vnf package artifact download
74 [--file <FILE>]
75 <vnf-package>
76 <artifact-path>
77 --file <FILE>
79 Local file to save downloaded VNF Package artifact file data. If
80 this is not specified and there is no redirection then data will
81 not be saved.
82 vnf-package
84 VNF package ID
85 artifact-path
87 The artifact file's path
88 This command is provided by the python-tackerclient plugin.
90 vnf package create
92 Create a new VNF Package
93 openstack vnf package create
95 [-f {json,shell,table,value,yaml}]
96 [-c COLUMN]
97 [--noindent]
98 [--prefix PREFIX]
99 [--max-width <integer>]
100 [--fit-width]
101 [--print-empty]
102 [--user-data <key=value>]
103 -f <FORMATTER>, --format <FORMATTER>
105 the output format, defaults to table
106 -c COLUMN, --column COLUMN
108 specify the column(s) to include, can be repeated to show multi‐
109 ple columns
110 --noindent
112 whether to disable indenting the JSON
113 --prefix <PREFIX>
115 add a prefix to all variable names
116 --max-width <integer>
118 Maximum display width, <1 to disable. You can also use the
119 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
120 takes precedence.
121 --fit-width
123 Fit the table to the display width. Implied if --max-width
124 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
125 to always enable
126 --print-empty
128 Print empty table if there is no data to show.
129 --user-data <key=value>
131 User defined data for the VNF package (repeat option to set mul‐
132 tiple user defined data)
133 This command is provided by the python-tackerclient plugin.
135 vnf package delete
137 Delete VNF Package
138 openstack vnf package delete <vnf-package> [<vnf-package> ...]
140 vnf-package
142 Vnf package(s) ID to delete
143 This command is provided by the python-tackerclient plugin.
145 vnf package download
147 Download VNF package contents or VNFD of an on-boarded VNF package.
148 openstack vnf package download
150 [--file <FILE>]
151 [--vnfd]
152 [--type <type>]
153 <vnf-package>
154 --file <FILE>
156 Local file to save downloaded VNF Package or VNFD data. If this
157 is not specified and there is no redirection then data will not
158 be saved.
159 --vnfd Download VNFD of an on-boarded vnf package.
161 --type <type>
163 Provide text/plain when VNFD is implemented as a single YAML
164 file otherwise use application/zip. If you are not aware
165 whether VNFD is a single or multiple yaml files, then you can
166 specify 'both' option value. Provide this option only when
167 --vnfd is set.
168 vnf-package
170 VNF package ID
171 This command is provided by the python-tackerclient plugin.
173 vnf package list
175 List VNF Packages
176 openstack vnf package list
178 [-f {csv,json,table,value,yaml}]
179 [-c COLUMN]
180 [--quote {all,minimal,none,nonnumeric}]
181 [--noindent]
182 [--max-width <integer>]
183 [--fit-width]
184 [--print-empty]
185 [--sort-column SORT_COLUMN]
186 [--sort-ascending | --sort-descending]
187 [--filter <filter>]
188 [--all_fields | --fields fields | --exclude_fields exclude-fields]
189 [--exclude_default]
190 -f <FORMATTER>, --format <FORMATTER>
192 the output format, defaults to table
193 -c COLUMN, --column COLUMN
195 specify the column(s) to include, can be repeated to show multi‐
196 ple columns
197 --quote <QUOTE_MODE>
199 when to include quotes, defaults to nonnumeric
200 --noindent
202 whether to disable indenting the JSON
203 --max-width <integer>
205 Maximum display width, <1 to disable. You can also use the
206 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
207 takes precedence.
208 --fit-width
210 Fit the table to the display width. Implied if --max-width
211 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
212 to always enable
213 --print-empty
215 Print empty table if there is no data to show.
216 --sort-column SORT_COLUMN
218 specify the column(s) to sort the data (columns specified first
219 have a priority, non-existing columns are ignored), can be re‐
220 peated
221 --sort-ascending
223 sort the column(s) in ascending order
224 --sort-descending
226 sort the column(s) in descending order
227 --filter <filter>
229 Atrribute-based-filtering parameters
230 --all_fields
232 Include all complex attributes in the response
233 --fields fields
235 Complex attributes to be included into the response
236 --exclude_fields exclude-fields
238 Complex attributes to be excluded from the response
239 --exclude_default
241 Indicates to exclude all complex attributes from the response.
242 This argument can be used alone or with --fields and --filter.
243 For all other combinations tacker server will throw bad request
244 error
245 This command is provided by the python-tackerclient plugin.
247 vnf package show
249 Show VNF Package Details
250 openstack vnf package show
252 [-f {json,shell,table,value,yaml}]
253 [-c COLUMN]
254 [--noindent]
255 [--prefix PREFIX]
256 [--max-width <integer>]
257 [--fit-width]
258 [--print-empty]
259 <vnf-package>
260 -f <FORMATTER>, --format <FORMATTER>
262 the output format, defaults to table
263 -c COLUMN, --column COLUMN
265 specify the column(s) to include, can be repeated to show multi‐
266 ple columns
267 --noindent
269 whether to disable indenting the JSON
270 --prefix <PREFIX>
272 add a prefix to all variable names
273 --max-width <integer>
275 Maximum display width, <1 to disable. You can also use the
276 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
277 takes precedence.
278 --fit-width
280 Fit the table to the display width. Implied if --max-width
281 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
282 to always enable
283 --print-empty
285 Print empty table if there is no data to show.
286 vnf-package
288 VNF package ID
289 This command is provided by the python-tackerclient plugin.
291 vnf package update
293 Update information about an individual VNF package
294 openstack vnf package update
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 [--operational-state <operational-state>]
304 [--user-data <key=value>]
305 <vnf-package>
306 -f <FORMATTER>, --format <FORMATTER>
308 the output format, defaults to table
309 -c COLUMN, --column COLUMN
311 specify the column(s) to include, can be repeated to show multi‐
312 ple columns
313 --noindent
315 whether to disable indenting the JSON
316 --prefix <PREFIX>
318 add a prefix to all variable names
319 --max-width <integer>
321 Maximum display width, <1 to disable. You can also use the
322 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
323 takes precedence.
324 --fit-width
326 Fit the table to the display width. Implied if --max-width
327 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
328 to always enable
329 --print-empty
331 Print empty table if there is no data to show.
332 --operational-state <operational-state>
334 Change the operational state of VNF Package, Valid values are
335 'ENABLED' or 'DISABLED'.
336 --user-data <key=value>
338 User defined data for the VNF package (repeat option to set mul‐
339 tiple user defined data)
340 vnf-package
342 VNF package ID
343 This command is provided by the python-tackerclient plugin.
345 vnf package upload
347 Upload VNF Package
348 openstack vnf package upload
350 (--path <file> | --url <Uri>)
351 [--user-name <user-name>]
352 [--password <password>]
353 <vnf-package>
354 --path <file>
356 Upload VNF CSAR package from local file
357 --url <Uri>
359 Uri of the VNF package content
360 --user-name <user-name>
362 User name for authentication
363 --password <password>
365 Password for authentication
366 vnf-package
368 VNF package ID
369 This command is provided by the python-tackerclient plugin.
371
373 OpenStack Contributors
374
376 OpenStack Contributors
3771.6.0 Jun 04, 2021 TACKER(1)