update part of cli command guide about vfc test
[vfc/nfvo/lcm.git] / docs / platform / cli-userguide / VFC_part / index.rst
1 Cli VFC part Command Guide
2 ===============================
3
4 1. VFC nslcm create
5 -------------------
6
7 ::
8
9     usage: oclip vfc-nslcm-create
10     vfc nslcm create ns
11     Options:
12     [-n | --ns-csar-name] [-m | --host-url] [-c | --ns-csar-uuid]
13     [-C | --no-catalog] [-f | --format] [-h | --help]
14     [-V | --verify] [-t | --no-title] [-d | --debug]
15     [-v | --version] [-s | --long] [-D | --context]
16     Error:
17     On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
18     For example:
19     'oclip vfc-nslcm-create -m {} -c {} -n {} -q {} -S {}'.format(parameters["vfc-url"], \
20       csar_id, ns.get("name"), parameters["customer_name"], parameters["service_name"])
21
22
23 2. VFC nslcm instance
24 ---------------------
25
26 ::
27
28     usage: oclip vfc-nslcm-instance
29     vfc nslcm instance ns
30     Options:
31     [[-m | --host-url] [-C | --no-catalog] [-f | --format]
32     [-h | --help] [-V | --verify] [-t | --no-title]
33     [-d | --debug] [-v | --version] [-c | --location-constraints]
34     [-s | --long] [-D | --context] [-i | --ns-instance-id]
35     [-n | --sdn-controller-id]
36     Error:
37     On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
38     For example:
39     'oclip vfc-nslcm-instantiate -m {} -i {} -c {} -n {}'.format(parameters["vfc-url"], \
40         ns_instance_id, parameters["location"], parameters["sdc-controller-id"])
41
42
43 3. VFC nslcm terminate
44 ----------------------
45
46 ::
47
48     usage: oclip vfc-nslcm-terminate
49     vfc nslcm terminate ns
50     Options:
51     [[-m | --host-url] [-C | --no-catalog] [-f | --format]
52     [-h | --help] [-V | --verify] [-t | --no-title]
53     [-d | --debug] [-v | --version] [-c | --location-constraints]
54     [-s | --long] [-D | --context] [-i | --ns-instance-id]
55     Error:
56     On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
57     For example:
58     'oclip vfc-nslcm-terminate -m {} -i {}'.format(parameters["vfc-url"], ns_instance_id)
59
60 4. VFC nslcm delete
61 ----------------------
62
63 ::
64
65     usage: oclip vfc-nslcm-delete
66     vfc nslcm terminate ns
67     Options:
68     [[-m | --host-url] [-C | --no-catalog] [-f | --format]
69     [-h | --help] [-V | --verify] [-t | --no-title]
70     [-d | --debug] [-v | --version] [-c | --location-constraints]
71     [-s | --long] [-D | --context] [-c | --ns-instance-id]
72     Error:
73     On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
74     For example:
75     'oclip vfc-nslcm-delete -m {} -c {}'.format(parameters["vfc-url"], ns_instance_id)