729cd91a69bbb6cf1f7623b1279936858bcf2327
[cli.git] /
1 # Copyright 2018 Huawei Technologies Co., Ltd.\r
2 #\r
3 # Licensed under the Apache License, Version 2.0 (the "License");\r
4 # you may not use this file except in compliance with the License.\r
5 # You may obtain a copy of the License at\r
6 #\r
7 #     http://www.apache.org/licenses/LICENSE-2.0\r
8 #\r
9 # Unless required by applicable law or agreed to in writing, software\r
10 # distributed under the License is distributed on an "AS IS" BASIS,\r
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
12 # See the License for the specific language governing permissions and\r
13 # limitations under the License.\r
14 \r
15 open_cli_schema_version: 1.0\r
16 name: logic-link-create\r
17 description: Create a logic-link\r
18 \r
19 info:\r
20   product: onap-beijing\r
21   service: aai\r
22   author: ONAP CLI Team onap-discuss@lists.onap.org\r
23 \r
24 parameters:\r
25   - name: link-name\r
26     description: logic-link-name\r
27     type: string\r
28     short_option: n\r
29     long_option: name\r
30     is_optional: false\r
31   - name: link-type\r
32     description: link-type\r
33     type: string\r
34     short_option: i\r
35     long_option: link-type\r
36     is_optional: true\r
37   - name: speed-value\r
38     description: speed-value\r
39     type: string\r
40     short_option: q\r
41     long_option: speed-value\r
42     is_optional: true\r
43   - name: speed-units\r
44     description: speed-units\r
45     type: string\r
46     short_option: x\r
47     long_option: speed-units\r
48     is_optional: true\r
49   - name: in-maint\r
50     description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true)\r
51     type: bool\r
52     short_option: w\r
53     long_option: in-maint\r
54     is_optional: false\r
55   - name: prov-status\r
56     description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]\r
57     type: string\r
58     short_option: g\r
59     long_option: prov-status\r
60     is_optional: true\r
61   - name: link-role\r
62     description: link-role\r
63     type: string\r
64     short_option: j\r
65     long_option: link-role\r
66     is_optional: true\r
67   - name: link-id\r
68     description: link-id\r
69     type: string\r
70     short_option: z\r
71     long_option: link-id\r
72     is_optional: true\r
73   - name: relationship\r
74     description: relationship\r
75     type: json\r
76     short_option: r\r
77     long_option: relationship\r
78     is_optional: true\r
79 http:\r
80   service:\r
81     auth: basic\r
82     mode: direct\r
83   request:\r
84     uri: /aai/v11/network/logic-links/logic-link/${link-name}\r
85     method: PUT\r
86     context:\r
87       remove_empty_node: true\r
88     body: '{"link-name": "${link-name}" ,"link-type": "${link-type}","speed-value": "${speed-value}","speed-units": "${speed-units}","in-maint": "${in-maint}","prov-status": "${prov-status}","link-role": "${link-role}","link-id": "${link-id}","relationship-list": ["${relationship}"]}'\r
89   success_codes:\r
90     - 200\r
91     - 201\r