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 create
71 Create a new VNF Package
72 openstack vnf package create
74 [-f {json,shell,table,value,yaml}]
75 [-c COLUMN]
76 [--noindent]
77 [--prefix PREFIX]
78 [--max-width <integer>]
79 [--fit-width]
80 [--print-empty]
81 [--user-data <key=value>]
82 -f <FORMATTER>, --format <FORMATTER>
84 the output format, defaults to table
85 -c COLUMN, --column COLUMN
87 specify the column(s) to include, can be repeated to show multi‐
88 ple columns
89 --noindent
91 whether to disable indenting the JSON
92 --prefix <PREFIX>
94 add a prefix to all variable names
95 --max-width <integer>
97 Maximum display width, <1 to disable. You can also use the
98 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
99 takes precedence.
100 --fit-width
102 Fit the table to the display width. Implied if --max-width
103 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
104 to always enable
105 --print-empty
107 Print empty table if there is no data to show.
108 --user-data <key=value>
110 User defined data for the VNF package (repeat option to set mul‐
111 tiple user defined data)
112 This command is provided by the python-tackerclient plugin.
114 vnf package delete
116 Delete VNF Package
117 openstack vnf package delete <vnf-package> [<vnf-package> ...]
119 vnf-package
121 Vnf package(s) ID to delete
122 This command is provided by the python-tackerclient plugin.
124 vnf package download
126 Download VNF package contents or VNFD of an on-boarded VNF package.
127 openstack vnf package download
129 [--file <FILE>]
130 [--vnfd]
131 [--type <type>]
132 <vnf-package>
133 --file <FILE>
135 Local file to save downloaded VNF Package or VNFD data. If this
136 is not specified and there is no redirection then data will not
137 be saved.
138 --vnfd Download VNFD of an on-boarded vnf package.
140 --type <type>
142 Provide text/plain when VNFD is implemented as a single YAML
143 file otherwise use application/zip. If you are not aware
144 whether VNFD is a single or multiple yaml files, then you can
145 specify 'both' option value. Provide this option only when
146 --vnfd is set.
147 vnf-package
149 VNF package ID
150 This command is provided by the python-tackerclient plugin.
152 vnf package list
154 List VNF Packages
155 openstack vnf package list
157 [-f {csv,json,table,value,yaml}]
158 [-c COLUMN]
159 [--quote {all,minimal,none,nonnumeric}]
160 [--noindent]
161 [--max-width <integer>]
162 [--fit-width]
163 [--print-empty]
164 [--sort-column SORT_COLUMN]
165 [--filter <filter>]
166 [--all_fields | --fields fields | --exclude_fields exclude-fields]
167 [--exclude_default]
168 -f <FORMATTER>, --format <FORMATTER>
170 the output format, defaults to table
171 -c COLUMN, --column COLUMN
173 specify the column(s) to include, can be repeated to show multi‐
174 ple columns
175 --quote <QUOTE_MODE>
177 when to include quotes, defaults to nonnumeric
178 --noindent
180 whether to disable indenting the JSON
181 --max-width <integer>
183 Maximum display width, <1 to disable. You can also use the
184 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
185 takes precedence.
186 --fit-width
188 Fit the table to the display width. Implied if --max-width
189 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
190 to always enable
191 --print-empty
193 Print empty table if there is no data to show.
194 --sort-column SORT_COLUMN
196 specify the column(s) to sort the data (columns specified first
197 have a priority, non-existing columns are ignored), can be
198 repeated
199 --filter <filter>
201 Atrribute-based-filtering parameters
202 --all_fields
204 Include all complex attributes in the response
205 --fields fields
207 Complex attributes to be included into the response
208 --exclude_fields exclude-fields
210 Complex attributes to be excluded from the response
211 --exclude_default
213 Indicates to exclude all complex attributes from the response.
214 This argument can be used alone or with --fields and --filter.
215 For all other combinations tacker server will throw bad request
216 error
217 This command is provided by the python-tackerclient plugin.
219 vnf package show
221 Show VNF Package Details
222 openstack vnf package show
224 [-f {json,shell,table,value,yaml}]
225 [-c COLUMN]
226 [--noindent]
227 [--prefix PREFIX]
228 [--max-width <integer>]
229 [--fit-width]
230 [--print-empty]
231 <vnf-package>
232 -f <FORMATTER>, --format <FORMATTER>
234 the output format, defaults to table
235 -c COLUMN, --column COLUMN
237 specify the column(s) to include, can be repeated to show multi‐
238 ple columns
239 --noindent
241 whether to disable indenting the JSON
242 --prefix <PREFIX>
244 add a prefix to all variable names
245 --max-width <integer>
247 Maximum display width, <1 to disable. You can also use the
248 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
249 takes precedence.
250 --fit-width
252 Fit the table to the display width. Implied if --max-width
253 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
254 to always enable
255 --print-empty
257 Print empty table if there is no data to show.
258 vnf-package
260 VNF package ID
261 This command is provided by the python-tackerclient plugin.
263 vnf package update
265 Update information about an individual VNF package
266 openstack vnf package update
268 [-f {json,shell,table,value,yaml}]
269 [-c COLUMN]
270 [--noindent]
271 [--prefix PREFIX]
272 [--max-width <integer>]
273 [--fit-width]
274 [--print-empty]
275 [--operational-state <operational-state>]
276 [--user-data <key=value>]
277 <vnf-package>
278 -f <FORMATTER>, --format <FORMATTER>
280 the output format, defaults to table
281 -c COLUMN, --column COLUMN
283 specify the column(s) to include, can be repeated to show multi‐
284 ple columns
285 --noindent
287 whether to disable indenting the JSON
288 --prefix <PREFIX>
290 add a prefix to all variable names
291 --max-width <integer>
293 Maximum display width, <1 to disable. You can also use the
294 CLIFF_MAX_TERM_WIDTH environment variable, but the parameter
295 takes precedence.
296 --fit-width
298 Fit the table to the display width. Implied if --max-width
299 greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1
300 to always enable
301 --print-empty
303 Print empty table if there is no data to show.
304 --operational-state <operational-state>
306 Change the operational state of VNF Package, Valid values are
307 'ENABLED' or 'DISABLED'.
308 --user-data <key=value>
310 User defined data for the VNF package (repeat option to set mul‐
311 tiple user defined data)
312 vnf-package
314 VNF package ID
315 This command is provided by the python-tackerclient plugin.
317 vnf package upload
319 Upload VNF Package
320 openstack vnf package upload
322 (--path <file> | --url <Uri>)
323 [--user-name <user-name>]
324 [--password <password>]
325 <vnf-package>
326 --path <file>
328 Upload VNF CSAR package from local file
329 --url <Uri>
331 Uri of the VNF package content
332 --user-name <user-name>
334 User name for authentication
335 --password <password>
337 Password for authentication
338 vnf-package
340 VNF package ID
341 This command is provided by the python-tackerclient plugin.
343
345 OpenStack Contributors
346
348 OpenStack Contributors
3491.1.0 Jul 29, 2020 TACKER(1)