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 or VNFD data. If this
80 is not specified and there is no redirection then data will not
81 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 [--filter <filter>]
187 [--all_fields | --fields fields | --exclude_fields exclude-fields]
188 [--exclude_default]
189 -f <FORMATTER>, --format <FORMATTER>
191 the output format, defaults to table
192 -c COLUMN, --column COLUMN
194 specify the column(s) to include, can be repeated to show multi‐
195 ple columns
196 --quote <QUOTE_MODE>
198 when to include quotes, defaults to nonnumeric
199 --noindent
201 whether to disable indenting the JSON
202 --max-width <integer>
204 Maximum display width, <1 to disable. You can also use the
205 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
206 takes precedence.
207 --fit-width
209 Fit the table to the display width. Implied if --max-width
210 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
211 to always enable
212 --print-empty
214 Print empty table if there is no data to show.
215 --sort-column SORT_COLUMN
217 specify the column(s) to sort the data (columns specified first
218 have a priority, non-existing columns are ignored), can be re‐
219 peated
220 --filter <filter>
222 Atrribute-based-filtering parameters
223 --all_fields
225 Include all complex attributes in the response
226 --fields fields
228 Complex attributes to be included into the response
229 --exclude_fields exclude-fields
231 Complex attributes to be excluded from the response
232 --exclude_default
234 Indicates to exclude all complex attributes from the response.
235 This argument can be used alone or with --fields and --filter.
236 For all other combinations tacker server will throw bad request
237 error
238 This command is provided by the python-tackerclient plugin.
240 vnf package show
242 Show VNF Package Details
243 openstack vnf package show
245 [-f {json,shell,table,value,yaml}]
246 [-c COLUMN]
247 [--noindent]
248 [--prefix PREFIX]
249 [--max-width <integer>]
250 [--fit-width]
251 [--print-empty]
252 <vnf-package>
253 -f <FORMATTER>, --format <FORMATTER>
255 the output format, defaults to table
256 -c COLUMN, --column COLUMN
258 specify the column(s) to include, can be repeated to show multi‐
259 ple columns
260 --noindent
262 whether to disable indenting the JSON
263 --prefix <PREFIX>
265 add a prefix to all variable names
266 --max-width <integer>
268 Maximum display width, <1 to disable. You can also use the
269 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
270 takes precedence.
271 --fit-width
273 Fit the table to the display width. Implied if --max-width
274 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
275 to always enable
276 --print-empty
278 Print empty table if there is no data to show.
279 vnf-package
281 VNF package ID
282 This command is provided by the python-tackerclient plugin.
284 vnf package update
286 Update information about an individual VNF package
287 openstack vnf package update
289 [-f {json,shell,table,value,yaml}]
290 [-c COLUMN]
291 [--noindent]
292 [--prefix PREFIX]
293 [--max-width <integer>]
294 [--fit-width]
295 [--print-empty]
296 [--operational-state <operational-state>]
297 [--user-data <key=value>]
298 <vnf-package>
299 -f <FORMATTER>, --format <FORMATTER>
301 the output format, defaults to table
302 -c COLUMN, --column COLUMN
304 specify the column(s) to include, can be repeated to show multi‐
305 ple columns
306 --noindent
308 whether to disable indenting the JSON
309 --prefix <PREFIX>
311 add a prefix to all variable names
312 --max-width <integer>
314 Maximum display width, <1 to disable. You can also use the
315 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
316 takes precedence.
317 --fit-width
319 Fit the table to the display width. Implied if --max-width
320 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
321 to always enable
322 --print-empty
324 Print empty table if there is no data to show.
325 --operational-state <operational-state>
327 Change the operational state of VNF Package, Valid values are
328 'ENABLED' or 'DISABLED'.
329 --user-data <key=value>
331 User defined data for the VNF package (repeat option to set mul‐
332 tiple user defined data)
333 vnf-package
335 VNF package ID
336 This command is provided by the python-tackerclient plugin.
338 vnf package upload
340 Upload VNF Package
341 openstack vnf package upload
343 (--path <file> | --url <Uri>)
344 [--user-name <user-name>]
345 [--password <password>]
346 <vnf-package>
347 --path <file>
349 Upload VNF CSAR package from local file
350 --url <Uri>
352 Uri of the VNF package content
353 --user-name <user-name>
355 User name for authentication
356 --password <password>
358 Password for authentication
359 vnf-package
361 VNF package ID
362 This command is provided by the python-tackerclient plugin.
364
366 OpenStack Contributors
367
369 OpenStack Contributors
3701.3.0 Jan 27, 2021 TACKER(1)