Merge "fixed oclip.sh execption on ubuntu"
[cli.git] / docs / cmd_sample.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017-18 Huawei Technologies Co., Ltd.
4
5 .. _cli_cmd_sample:
6
7
8 open-cli
9 ========
10
11 schema-validate
12 ----------------
13
14 input::
15
16  -l /tmp/hello-world.yaml
17
18 output::
19
20   +--------+--------+
21   |sl-no   |error   |
22   +--------+--------+
23   |        |        |
24   +--------+--------+
25
26
27 schema-refresh
28 ----------------
29
30 output::
31
32   +--------+--------------------------------+------------------+------------------------------------------------+----------+
33   |sl-no   |command                         |product-version   |schema                                          |version   |
34   +--------+--------------------------------+------------------+------------------------------------------------+----------+
35   |1       |vfmodule-create                 |onap-amsterdam    |vfmodule-create-schema-1.1.yaml                 |1.0       |
36   +--------+--------------------------------+------------------+------------------------------------------------+----------+
37   |2       |schema-validate                 |open-cli          |schema-validate.yaml                            |1.0       |
38   +--------+--------------------------------+------------------+------------------------------------------------+----------+
39   |3       |schema-refresh                  |open-cli          |schema-refresh.yaml                             |1.0       |
40   +--------+--------------------------------+------------------+------------------------------------------------+----------+
41   |4       |cloud-list                      |onap-amsterdam    |cloud-list-schema-1.1.yaml                      |1.0       |
42   +--------+--------------------------------+------------------+------------------------------------------------+----------+
43   |5       |sdnc-list                       |onap-amsterdam    |sdnc-list-schema-1.1.yaml                       |1.0       |
44   +--------+--------------------------------+------------------+------------------------------------------------+----------+
45   |6       |sdnc-register                   |onap-amsterdam    |sdnc-create-schema-1.1.yaml                     |1.0       |
46   +--------+--------------------------------+------------------+------------------------------------------------+----------+
47   |7       |sdnc-unregister                 |onap-amsterdam    |sdnc-delete-schema-1.1.yaml                     |1.0       |
48   +--------+--------------------------------+------------------+------------------------------------------------+----------+
49   |8       |vnfm-show                       |onap-amsterdam    |vnfm-show-schema-1.1.yaml                       |1.0       |
50   +--------+--------------------------------+------------------+------------------------------------------------+----------+
51   |9       |vnfm-unregister                 |onap-amsterdam    |vnfm-delete-schema-1.1.yaml                     |1.0       |
52   +--------+--------------------------------+------------------+------------------------------------------------+----------+
53   |10      |vnfm-register                   |onap-amsterdam    |vnfm-create-schema-1.1.yaml                     |1.0       |
54   +--------+--------------------------------+------------------+------------------------------------------------+----------+
55   |11      |vnfm-list                       |onap-amsterdam    |vnfm-list-schema-1.1.yaml                       |1.0       |
56   +--------+--------------------------------+------------------+------------------------------------------------+----------+
57   |12      |vim-register                    |onap-amsterdam    |vim-create-schema-1.1.yaml                      |1.0       |
58   +--------+--------------------------------+------------------+------------------------------------------------+----------+
59   |13      |vim-unregister                  |onap-amsterdam    |vim-delete-schema-1.1.yaml                      |1.0       |
60   +--------+--------------------------------+------------------+------------------------------------------------+----------+
61   |14      |vim-list                        |onap-amsterdam    |vim-list-schema-1.1.yaml                        |1.0       |
62   +--------+--------------------------------+------------------+------------------------------------------------+----------+
63   |15      |ems-list                        |onap-amsterdam    |ems-list-schema-1.1.yaml                        |1.0       |
64   +--------+--------------------------------+------------------+------------------------------------------------+----------+
65   |16      |ems-register                    |onap-amsterdam    |ems-create-schema-1.1.yaml                      |1.0       |
66   +--------+--------------------------------+------------------+------------------------------------------------+----------+
67   |17      |ems-show                        |onap-amsterdam    |ems-show-schema-1.1.yaml                        |1.0       |
68   +--------+--------------------------------+------------------+------------------------------------------------+----------+
69   |18      |cloud-delete                    |onap-amsterdam    |cloud-delete-schema-1.1.yaml                    |1.0       |
70   +--------+--------------------------------+------------------+------------------------------------------------+----------+
71   |19      |ems-unregister                  |onap-amsterdam    |ems-delete-schema-1.1.yaml                      |1.0       |
72   +--------+--------------------------------+------------------+------------------------------------------------+----------+
73   |20      |subscription-list               |openecomp         |subscription-list-schema.yaml                   |1.0       |
74   +--------+--------------------------------+------------------+------------------------------------------------+----------+
75   |21      |subscription-create             |openecomp         |subscription-create-schema.yaml                 |1.0       |
76   +--------+--------------------------------+------------------+------------------------------------------------+----------+
77   |22      |subscription-list               |onap-amsterdam    |subscription-list-schema-1.1.yaml               |1.0       |
78   +--------+--------------------------------+------------------+------------------------------------------------+----------+
79   |23      |subscription-create             |onap-amsterdam    |subscription-create-schema-1.1.yaml             |1.0       |
80   +--------+--------------------------------+------------------+------------------------------------------------+----------+
81   |24      |subscription-delete             |onap-amsterdam    |subscription-delete-schema-1.1.yaml             |1.0       |
82   +--------+--------------------------------+------------------+------------------------------------------------+----------+
83   |25      |customer-show                   |openecomp         |customer-show-schema.yaml                       |1.0       |
84   +--------+--------------------------------+------------------+------------------------------------------------+----------+
85   |26      |customer-show                   |onap-amsterdam    |customer-show-schema-1.1.yaml                   |1.0       |
86   +--------+--------------------------------+------------------+------------------------------------------------+----------+
87   |27      |customer-list                   |openecomp         |customer-list-schema.yaml                       |1.0       |
88   +--------+--------------------------------+------------------+------------------------------------------------+----------+
89   |28      |customer-delete                 |openecomp         |customer-delete-schema.yaml                     |1.0       |
90   +--------+--------------------------------+------------------+------------------------------------------------+----------+
91   |29      |customer-create                 |openecomp         |customer-create-schema.yaml                     |1.0       |
92   +--------+--------------------------------+------------------+------------------------------------------------+----------+
93   |30      |customer-create                 |onap-amsterdam    |customer-create-schema-1.1.yaml                 |1.0       |
94   +--------+--------------------------------+------------------+------------------------------------------------+----------+
95   |31      |customer-delete                 |onap-amsterdam    |customer-delete-schema-1.1.yaml                 |1.0       |
96   +--------+--------------------------------+------------------+------------------------------------------------+----------+
97   |32      |customer-list                   |onap-amsterdam    |customer-list-schema-1.1.yaml                   |1.0       |
98   +--------+--------------------------------+------------------+------------------------------------------------+----------+
99   |33      |vf-list                         |onap-amsterdam    |vf-list-schema-1.1.yaml                         |1.0       |
100   +--------+--------------------------------+------------------+------------------------------------------------+----------+
101   |34      |service-list                    |onap-amsterdam    |service-list-schema-1.1.yaml                    |1.0       |
102   +--------+--------------------------------+------------------+------------------------------------------------+----------+
103   |35      |vf-show                         |onap-amsterdam    |vf-show-schema-1.1.yaml                         |1.0       |
104   +--------+--------------------------------+------------------+------------------------------------------------+----------+
105   |36      |tenant-create                   |onap-amsterdam    |tenant-create-schema-1.1.yaml                   |1.0       |
106   +--------+--------------------------------+------------------+------------------------------------------------+----------+
107   |37      |tenant-list                     |onap-amsterdam    |tenant-list-schema-1.1.yaml                     |1.0       |
108   +--------+--------------------------------+------------------+------------------------------------------------+----------+
109   |38      |tenant-delete                   |onap-amsterdam    |tenant-delete-schema-1.1.yaml                   |1.0       |
110   +--------+--------------------------------+------------------+------------------------------------------------+----------+
111   |39      |service-type-create             |openecomp         |service-type-create-schema.yaml                 |1.0       |
112   +--------+--------------------------------+------------------+------------------------------------------------+----------+
113   |40      |service-type-list               |onap-amsterdam    |service-type-list-schema-1.1.yaml               |1.0       |
114   +--------+--------------------------------+------------------+------------------------------------------------+----------+
115   |41      |service-type-create             |onap-amsterdam    |service-type-create-schema-1.1.yaml             |1.0       |
116   +--------+--------------------------------+------------------+------------------------------------------------+----------+
117   |42      |service-type-delete             |openecomp         |service-type-delete-schema.yaml                 |1.0       |
118   +--------+--------------------------------+------------------+------------------------------------------------+----------+
119   |43      |service-type-list               |openecomp         |service-type-list-schema.yaml                   |1.0       |
120   +--------+--------------------------------+------------------+------------------------------------------------+----------+
121   |44      |service-type-delete             |onap-amsterdam    |service-type-delete-schema-1.1.yaml             |1.0       |
122   +--------+--------------------------------+------------------+------------------------------------------------+----------+
123   |45      |cloud-create                    |onap-amsterdam    |cloud-create-schema-1.1.yaml                    |1.0       |
124   +--------+--------------------------------+------------------+------------------------------------------------+----------+
125   |46      |cloud-list                      |openecomp         |cloud-list-schema.yaml                          |1.0       |
126   +--------+--------------------------------+------------------+------------------------------------------------+----------+
127   |47      |microservice-delete             |onap-amsterdam    |microservice-delete-schema.yaml                 |1.0       |
128   +--------+--------------------------------+------------------+------------------------------------------------+----------+
129   |48      |microservice-list               |onap-amsterdam    |microservice-list-schema.yaml                   |1.0       |
130   +--------+--------------------------------+------------------+------------------------------------------------+----------+
131   |49      |microservice-show               |onap-amsterdam    |microservice-show-schema.yaml                   |1.0       |
132   +--------+--------------------------------+------------------+------------------------------------------------+----------+
133   |50      |microservice-create             |onap-amsterdam    |microservice-create-schema.yaml                 |1.0       |
134   +--------+--------------------------------+------------------+------------------------------------------------+----------+
135   |51      |hello-world                     |sample-1.0        |hello-world.yaml                                |1.0       |
136   +--------+--------------------------------+------------------+------------------------------------------------+----------+
137   |52      |hello-world-http                |sample-1.0        |hello-world-http.yaml                           |1.0       |
138   +--------+--------------------------------+------------------+------------------------------------------------+----------+
139   |53      |vlm-checkin                     |onap-amsterdam    |vlm-checkin-schema-1.1.yaml                     |1.0       |
140   +--------+--------------------------------+------------------+------------------------------------------------+----------+
141   |54      |license-group-create            |openecomp         |license-group-create-schema.yaml                |1.0       |
142   +--------+--------------------------------+------------------+------------------------------------------------+----------+
143   |55      |vlm-key-group-create            |onap-amsterdam    |vlm-key-group-create-schema-1.1.yaml            |1.0       |
144   +--------+--------------------------------+------------------+------------------------------------------------+----------+
145   |56      |vlm-aggreement-list             |onap-amsterdam    |vlm-aggreement-list-schema-1.1.yaml             |1.0       |
146   +--------+--------------------------------+------------------+------------------------------------------------+----------+
147   |57      |vlm-key-group-list              |onap-amsterdam    |vlm-key-group-list-schema-1.1.yaml              |1.0       |
148   +--------+--------------------------------+------------------+------------------------------------------------+----------+
149   |58      |vlm-create                      |onap-amsterdam    |vlm-create-schema-1.1.yaml                      |1.0       |
150   +--------+--------------------------------+------------------+------------------------------------------------+----------+
151   |59      |vlm-entitlement-pool-create     |onap-amsterdam    |vlm-entitlement-pool-create-schema-1.1.yaml     |1.0       |
152   +--------+--------------------------------+------------------+------------------------------------------------+----------+
153   |60      |ep-show                         |openecomp         |license-entitlement-pool-show-schema.yaml       |1.0       |
154   +--------+--------------------------------+------------------+------------------------------------------------+----------+
155   |61      |license-model-create            |openecomp         |license-model-create-schema.yaml                |1.0       |
156   +--------+--------------------------------+------------------+------------------------------------------------+----------+
157   |62      |license-group-show              |openecomp         |license-group-show-schema.yaml                  |1.0       |
158   +--------+--------------------------------+------------------+------------------------------------------------+----------+
159   |63      |vsp-upload                      |openecomp         |vsp-upload-schema.yaml                          |1.0       |
160   +--------+--------------------------------+------------------+------------------------------------------------+----------+
161   |64      |vsp-package                     |onap-amsterdam    |vsp-package-schema-1.1.yaml                     |1.0       |
162   +--------+--------------------------------+------------------+------------------------------------------------+----------+
163   |65      |vsp-submit                      |onap-amsterdam    |vsp-submit-schema-1.1.yaml                      |1.0       |
164   +--------+--------------------------------+------------------+------------------------------------------------+----------+
165   |66      |vsp-checkout                    |onap-amsterdam    |vsp-checkout-schema-1.1.yaml                    |1.0       |
166   +--------+--------------------------------+------------------+------------------------------------------------+----------+
167   |67      |vsp-create                      |openecomp         |vsp-create-schema.yaml                          |1.0       |
168   +--------+--------------------------------+------------------+------------------------------------------------+----------+
169   |68      |vsp-list                        |openecomp         |vsp-list-schema.yaml                            |1.0       |
170   +--------+--------------------------------+------------------+------------------------------------------------+----------+
171   |69      |vsp-show                        |onap-amsterdam    |vsp-show-schema-1.1.yaml                        |1.0       |
172   +--------+--------------------------------+------------------+------------------------------------------------+----------+
173   |70      |vsp-show                        |openecomp         |vsp-show-schema.yaml                            |1.0       |
174   +--------+--------------------------------+------------------+------------------------------------------------+----------+
175   |71      |vsp-submit                      |openecomp         |vsp-submit-schema.yaml                          |1.0       |
176   +--------+--------------------------------+------------------+------------------------------------------------+----------+
177   |72      |vsp-create                      |onap-amsterdam    |vsp-create-schema-1.1.yaml                      |1.0       |
178   +--------+--------------------------------+------------------+------------------------------------------------+----------+
179   |73      |vsp-add-artifact                |onap-amsterdam    |vsp-add-artifact-schema-1.1.yaml                |1.0       |
180   +--------+--------------------------------+------------------+------------------------------------------------+----------+
181   |74      |vsp-revert                      |onap-amsterdam    |vsp-revert-schema-1.1.yaml                      |1.0       |
182   +--------+--------------------------------+------------------+------------------------------------------------+----------+
183   |75      |vsp-checkin                     |openecomp         |vsp-checkin-schema.yaml                         |1.0       |
184   +--------+--------------------------------+------------------+------------------------------------------------+----------+
185   |76      |vsp-checkout                    |onap-amsterdam    |vsp-checkout-schema.yaml                        |1.0       |
186   +--------+--------------------------------+------------------+------------------------------------------------+----------+
187   |77      |vsp-validate                    |onap-amsterdam    |vsp-validate-schema-1.1.yaml                    |1.0       |
188   +--------+--------------------------------+------------------+------------------------------------------------+----------+
189   |78      |vsp-list                        |onap-amsterdam    |vsp-list-schema-1.1.yaml                        |1.0       |
190   +--------+--------------------------------+------------------+------------------------------------------------+----------+
191   |79      |vsp-checkin                     |onap-amsterdam    |vsp-checkin-schema-1.1.yaml                     |1.0       |
192   +--------+--------------------------------+------------------+------------------------------------------------+----------+
193   |80      |service-model-checkin           |onap-amsterdam    |service-model-checkin-schema-1.1.yaml           |1.0       |
194   +--------+--------------------------------+------------------+------------------------------------------------+----------+
195   |81      |service-model-distribute        |onap-amsterdam    |service-model-distribute-schema-1.1.yaml        |1.0       |
196   +--------+--------------------------------+------------------+------------------------------------------------+----------+
197   |82      |service-model-list              |onap-amsterdam    |service-model-list-schema-1.1.yaml              |1.0       |
198   +--------+--------------------------------+------------------+------------------------------------------------+----------+
199   |83      |service-model-certify-start     |onap-amsterdam    |service-model-certify-start-schema-1.1.yaml     |1.0       |
200   +--------+--------------------------------+------------------+------------------------------------------------+----------+
201   |84      |service-model-add-vf            |onap-amsterdam    |service-model-add-vf-schema-1.1.yaml            |1.0       |
202   +--------+--------------------------------+------------------+------------------------------------------------+----------+
203   |85      |service-model-certify-request   |onap-amsterdam    |service-model-certify-request-schema-1.1.yaml   |1.0       |
204   +--------+--------------------------------+------------------+------------------------------------------------+----------+
205   |86      |service-model-revert            |onap-amsterdam    |service-model-checkout-schema-1.1.yaml          |1.0       |
206   +--------+--------------------------------+------------------+------------------------------------------------+----------+
207   |87      |service-model-checkout          |onap-amsterdam    |service-model-revert-schema-1.1.yaml            |1.0       |
208   +--------+--------------------------------+------------------+------------------------------------------------+----------+
209   |88      |service-model-certify-complete  |onap-amsterdam    |service-model-certify-complete-schema-1.1.yaml  |1.0       |
210   +--------+--------------------------------+------------------+------------------------------------------------+----------+
211   |89      |service2vf-model-list           |onap-amsterdam    |service2vf-model-list-schema-1.1.yaml           |1.0       |
212   +--------+--------------------------------+------------------+------------------------------------------------+----------+
213   |90      |service-model-create            |onap-amsterdam    |service-model-create-schema-1.1.yaml            |1.0       |
214   +--------+--------------------------------+------------------+------------------------------------------------+----------+
215   |91      |service-model-approve           |onap-amsterdam    |service-model-approve-schema-1.1.yaml           |1.0       |
216   +--------+--------------------------------+------------------+------------------------------------------------+----------+
217   |92      |vf-model-create                 |onap-amsterdam    |vf-model-create-schema-1.1.yaml                 |1.0       |
218   +--------+--------------------------------+------------------+------------------------------------------------+----------+
219   |93      |vf-model-checkin                |onap-amsterdam    |vf-model-checkin-schema-1.1.yaml                |1.0       |
220   +--------+--------------------------------+------------------+------------------------------------------------+----------+
221   |94      |vlm-revert                      |onap-amsterdam    |vlm-revert-schema-1.1.yaml                      |1.0       |
222   +--------+--------------------------------+------------------+------------------------------------------------+----------+
223   |95      |vlm-feature-group-create        |onap-amsterdam    |vlm-feature-group-create-schema-1.1.yaml        |1.0       |
224   +--------+--------------------------------+------------------+------------------------------------------------+----------+
225   |96      |vlm-submit                      |onap-amsterdam    |vlm-submit-schema-1.1.yaml                      |1.0       |
226   +--------+--------------------------------+------------------+------------------------------------------------+----------+
227   |97      |license-model-show              |openecomp         |license-model-show-schema.yaml                  |1.0       |
228   +--------+--------------------------------+------------------+------------------------------------------------+----------+
229   |98      |vf-model-certify-start          |onap-amsterdam    |vf-model-certify-start-schema-1.1.yaml          |1.0       |
230   +--------+--------------------------------+------------------+------------------------------------------------+----------+
231   |99      |vf-model-list                   |onap-amsterdam    |vf-model-list-schema-1.1.yaml                   |1.0       |
232   +--------+--------------------------------+------------------+------------------------------------------------+----------+
233   |100     |vlm-entitlement-pool-list       |onap-amsterdam    |vlm-entitlement-pool-list-schema-1.1.yaml       |1.0       |
234   +--------+--------------------------------+------------------+------------------------------------------------+----------+
235   |101     |vlm-feature-group-list          |onap-amsterdam    |vlm-feature-group-list-schema-1.1.yaml          |1.0       |
236   +--------+--------------------------------+------------------+------------------------------------------------+----------+
237   |102     |vlm-checkout                    |onap-amsterdam    |vlm-checkout-schema-1.1.yaml                    |1.0       |
238   +--------+--------------------------------+------------------+------------------------------------------------+----------+
239   |103     |vlm-list                        |onap-amsterdam    |vlm-list-schema-1.1.yaml                        |1.0       |
240   +--------+--------------------------------+------------------+------------------------------------------------+----------+
241   |104     |vlm-aggreement-create           |onap-amsterdam    |vlm-aggreement-create-schema-1.1.yaml           |1.0       |
242   +--------+--------------------------------+------------------+------------------------------------------------+----------+
243   |105     |vf-model-certify-request        |onap-amsterdam    |vf-model-certify-request-schema-1.1.yaml        |1.0       |
244   +--------+--------------------------------+------------------+------------------------------------------------+----------+
245   |106     |ep-create                       |openecomp         |license-entitlement-pool-create-schema.yaml     |1.0       |
246   +--------+--------------------------------+------------------+------------------------------------------------+----------+
247   |107     |vf2vfmodule-model-list          |onap-amsterdam    |vf2vfmodule-model-list-schema-1.1.yaml          |1.0       |
248   +--------+--------------------------------+------------------+------------------------------------------------+----------+
249   |108     |vf-model-certify-complete       |onap-amsterdam    |vf-model-certify-complete-schema-1.1.yaml       |1.0       |
250   +--------+--------------------------------+------------------+------------------------------------------------+----------+
251   |109     |service-delete                  |onap-amsterdam    |service-delete-schema-1.1.yaml                  |1.0       |
252   +--------+--------------------------------+------------------+------------------------------------------------+----------+
253   |110     |vfmodule-delete                 |onap-amsterdam    |vf-module-delete-schema-1.1.yaml                |1.0       |
254   +--------+--------------------------------+------------------+------------------------------------------------+----------+
255   |111     |vfmodule-create                 |onap-amsterdam    |vfmodule-create-schema-1.1.yaml                 |1.0       |
256   +--------+--------------------------------+------------------+------------------------------------------------+----------+
257   |112     |service-create                  |onap-amsterdam    |service-create-schema-1.1.yaml                  |1.0       |
258   +--------+--------------------------------+------------------+------------------------------------------------+----------+
259   |113     |vf-delete                       |onap-amsterdam    |vf-delete-schema-1.1.yaml                       |1.0       |
260   +--------+--------------------------------+------------------+------------------------------------------------+----------+
261   |114     |vf-create                       |onap-amsterdam    |vf-create-schema-1.1.yaml                       |1.0       |
262   +--------+--------------------------------+------------------+------------------------------------------------+----------+
263