update part of cli command guide about vfc test
[vfc/nfvo/lcm.git] / docs / platform / cli-userguide / create_csar_sdc / index.rst
1 Cli Create Csar Command Guide
2 ===============================
3
4 1. create-vlm
5 ---------------
6
7 ::
8
9     usage: oclip vlm-create
10     Create License Model
11     Options:
12     [-m | --host-url] [-C | --no-catalog] [-f | --format]
13     [-h | --help] [-V | --verify] [-t | --no-title]
14     [-d | --debug] [-v | --version] [-y | --description]
15     [-s | --long] [-D | --context] [-x | --vendor-name]
16     [-u | --host-username] [-a | --no-auth] [-p | --host-password]
17     Error:
18     On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
19     For example:
20     "oclip vlm-create -x {} -u {} -p {} -m {}".format(parameters["vendor-name"], \
21       parameters["sdc_creator"], parameters["sdc_password"], parameters["sdc_onboarding_url"])
22
23 2. create-vsp
24 ---------------
25
26 ::
27
28     usage: oclip vsp-create
29     Create Vendor Software Product
30     Options:
31     [-m | --host-url] [-j | --vlm-feature-group-id] [-C | --no-catalog]
32     [-f | --format] [-h | --help] [-V | --verify]
33     [-t | --no-title] [-d | --debug] [-v | --version]
34     [-o | --onboarding-method] [-e | --vlm-vendor] [-x | --vsp-name]
35     [-y | --vsp-description] [-s | --long] [-D | --context]
36     [-i | --vlm-agreement-id] [-c | --vlm-version] [-u | --host-username]
37     [-a | --no-auth] [-g | --vlm-id] [-p | --host-password]
38     Error:
39     On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
40     For example:
41     "oclip vsp-create -j {} -o {} -e {} -x {} -y {} -i {} -c {} -g {} -u {} -p {} -m {}".format( in_list[0], \
42           parameters["onboarding-method"], parameters["vendor-name" ], value.get("vsp-name"), value.get("vsp-desc"), in_list[1], \
43           in_list[2], in_list[3], parameters["sdc_creator"], parameters["sdc_password"], parameters["sdc_onboarding_url"] )
44
45
46 3. create-vf-model
47 ------------------
48
49 ::
50
51     usage: oclip vf-model-create
52     Create Virtual function from Vendor Software Product
53     Options:
54     [-m | --host-url] [-C | --no-catalog] [-f | --format]
55     [-h | --help] [-V | --verify] [-t | --no-title]
56     [-d | --debug] [-v | --version] [-y | --description]
57     [-g | --vsp-version] [-x | --name] [-s | --long]
58     [-D | --context] [-z | --vendor-name] [-u | --host-username]
59     [-a | --no-auth] [-b | --vsp-id] [-p | --host-password]
60     Error:
61     On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
62     For example:
63     "oclip vf-model-create -y {} -g {} -x {} -z {} -b {} -u {} -p {} -m {}".format(value.get("vf-description"), \
64           value.get("vsp-version"), value.get("vf-name"), parameters["vendor-name"], vsp_dict[name], \
65           parameters["sdc_creator"], parameters["sdc_password"], parameters["sdc_catalog_url"])
66
67 4. create-service-model
68 -----------------------
69
70 ::
71
72     usage: oclip service-model-create
73     Create Service model in SDC
74     Options:
75     [-m | --host-url] [-C | --no-catalog] [-f | --format]
76     [-h | --help] [-V | --verify] [-t | --no-title]
77     [-d | --debug] [-v | --version] [-z | --project-code]
78     [-y | --description] [-e | --icon-id] [-c | --category-display-name]
79     [-s | --long] [-D | --context] [-x | --service-name]
80     [-u | --host-username] [-a | --no-auth] [-b | --category]
81     [-p | --host-password]
82     Error:
83     On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
84     For example:
85     "oclip service-model-create -z {} -y {} -e {} -x {} -c {} -b {} -u {} -p {} -m {} |grep ID".format(parameters["project-code"], \
86     parameters["service-model-desc"], parameters["icon-id"], parameters["service-model-name"], parameters["category-display"], \
87     parameters["category"],parameters["sdc_creator"], parameters["sdc_password"], parameters["sdc_catalog_url"])
88
89 5. vfc-catalog-onboard-vnf
90 --------------------------
91
92 ::
93
94     usage: oclip vfc-catalog-onboard-vnf
95     vfc onboard vnf to catalog of vfc
96     Options:
97     [-m | --host-url] [-C | --no-catalog] [-f | --format]
98     [-h | --help] [-V | --verify] [-t | --no-title]
99     [-d | --debug] [-v | --version] [-s | --long]
100     [-D | --context] [-c | --vnf-csar-uuid]
101     Error:
102     On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
103     For example:
104     oclip vfc-catalog-onboard-vnf - -c {}'.format(value.get("csar-id"))
105
106
107 6. vfc-catalog-onboard-ns
108 --------------------------
109
110 ::
111
112     usage: oclip vfc-catalog-onboard-ns
113     vfc onboard ns to catalog of vfc
114     Options:
115     [-m | --host-url] [-c | --ns-csar-uuid] [-C | --no-catalog]
116     [-f | --format] [-h | --help] [-V | --verify]
117     [-t | --no-title] [-d | --debug] [-v | --version]
118     [-s | --long] [-D | --context]
119     Error:
120     On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
121     For example:
122     'oclip vfc-catalog-onboard-ns -c {}'.format(parameters["ns"]["csar-id"])
123
124