yaml update for pnf
[cli.git] / products / onap-beijing / features / aai / src / main / resources / open-cli-schema / pnf / pnf-create-schema.yaml
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: pnf-create\r
17 description: Create a pnf\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: pnf-name\r
26     description: pnf-name\r
27     type: string\r
28     short_option: n\r
29     long_option: name\r
30     is_optional: false\r
31   - name: pnf-id\r
32     description: pnf-id\r
33     type: string\r
34     short_option: i\r
35     long_option: pnf-id\r
36     is_optional: true\r
37   - name: equip-type\r
38     description: equip-type\r
39     type: string\r
40     short_option: t\r
41     long_option: equipType\r
42     is_optional: true\r
43   - name: equip-vendor\r
44     description: equip-vendor\r
45     type: string\r
46     short_option: v\r
47     long_option: equip-vendor\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: i\r
53     long_option: in-maint\r
54     is_optional: true\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: s\r
59     long_option: prov-status\r
60     is_optional: true\r
61   - name: relationship\r
62     description: relationship\r
63     type: json\r
64     short_option: r\r
65     long_option: relationship\r
66     is_optional: true\r
67 http:\r
68   service:\r
69     auth: basic\r
70     mode: direct\r
71   request:\r
72     uri: /aai/v11/network/pnfs/pnf/${pnf-name}\r
73     method: PUT\r
74     context:\r
75       remove_empty_node: true\r
76     body: '{"pnf-name": "${pnf-name}" ,"pnf-id": "${pnf-id}","equip-type": "${equip-type}","equip-vendor": "${equip-vendor}","in-maint": ${in-maint},"prov-status": "${prov-status}","relationship-list": ["${relationship}"]}'\r
77   success_codes:\r
78     - 200\r
79     - 201\r