- name: equip-type\r
description: equip-type\r
type: string\r
- short_option: t\r
+ short_option: q\r
long_option: equipType\r
is_optional: true\r
- name: equip-vendor\r
description: equip-vendor\r
type: string\r
- short_option: v\r
+ short_option: x\r
long_option: equip-vendor\r
is_optional: true\r
- name: in-maint\r
description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true)\r
type: bool\r
- short_option: i\r
+ short_option: w\r
long_option: in-maint\r
is_optional: true\r
- name: prov-status\r
description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]\r
type: string\r
- short_option: s\r
+ short_option: g\r
long_option: prov-status\r
is_optional: true\r
- name: relationship\r
method: PUT\r
context:\r
remove_empty_node: true\r
- 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
+ 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
success_codes:\r
- 200\r
- 201\r
- name: resource-version\r
description: Onap pnf resource version\r
type: uuid\r
- short_option: v\r
+ short_option: b\r
long_option: resource-version\r
is_optional: false\r
http:\r
description: Onap pnf id\r
scope: short\r
type: string\r
+ - name: resource-version\r
+ description: Onap resource-version\r
+ scope: short\r
+ type: string\r
http:\r
service:\r
auth: basic\r
--- /dev/null
+# Copyright 2018 Huawei Technologies Co., Ltd.\r
+#\r
+# Licensed under the Apache License, Version 2.0 (the "License");\r
+# you may not use this file except in compliance with the License.\r
+# You may obtain a copy of the License at\r
+#\r
+# http://www.apache.org/licenses/LICENSE-2.0\r
+#\r
+# Unless required by applicable law or agreed to in writing, software\r
+# distributed under the License is distributed on an "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+# See the License for the specific language governing permissions and\r
+# limitations under the License.\r
+\r
+open_cli_schema_version: 1.0\r
+name: generic-search\r
+description: generic-search \r
+#sample: https://172.19.44.123:8443/aai/v11/search/generic-query?key=customer.global-customer-id:Orange&include=all&start-node-type=customer&depth=6 \r
+\r
+info:\r
+ product: onap-beijing\r
+ service: aai\r
+ author: ONAP CLI Team onap-discuss@lists.onap.org\r
+\r
+parameters:\r
+ - name: key\r
+ description: key\r
+ type: string\r
+ short_option: k\r
+ long_option: key\r
+ is_optional: false\r
+ - name: value\r
+ description: value\r
+ type: string\r
+ short_option: z\r
+ long_option: value\r
+ is_optional: false\r
+ - name: start-node-type\r
+ description: start-node-type\r
+ type: string\r
+ short_option: r\r
+ long_option: start-node-type\r
+ is_optional: false\r
+ - name: depth\r
+ description: search depth\r
+ type: digit\r
+ short_option: e\r
+ long_option: depth\r
+ is_optional: false\r
+results:\r
+ direction: landscape\r
+ attributes:\r
+ - name: resource-type\r
+ description: Onap result-type\r
+ scope: short\r
+ type: string\r
+ - name: resource-link\r
+ description: Onap resource-link\r
+ scope: short\r
+ type: string\r
+ \r
+http:\r
+ service:\r
+ auth: basic\r
+ mode: direct\r
+ request:\r
+ uri: /aai/v11/search/generic-query?key=${key}:${value}&include=all&start-node-type=${start-node-type}&depth=${depth}\r
+ method: GET\r
+ success_codes:\r
+ - 200\r
+ - 201\r
+ result_map:\r
+ resource-type: $b{result-data.[*].resource-type}\r
+ resource-link: $b{result-data.[*].resource-link}\r
+ \r
--- /dev/null
+# Copyright 2018 Huawei Technologies Co., Ltd.\r
+#\r
+# Licensed under the Apache License, Version 2.0 (the "License");\r
+# you may not use this file except in compliance with the License.\r
+# You may obtain a copy of the License at\r
+#\r
+# http://www.apache.org/licenses/LICENSE-2.0\r
+#\r
+# Unless required by applicable law or agreed to in writing, software\r
+# distributed under the License is distributed on an "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+# See the License for the specific language governing permissions and\r
+# limitations under the License.\r
+\r
+open_cli_schema_version: 1.0\r
+name: type-search\r
+description: type-search \r
+#sample: https://172.19.44.123:8443/aai/v11/search/nodes-query?search-node-type=customer&filter=global-customer-id:EQUALS:Orange \r
+\r
+info:\r
+ product: onap-beijing\r
+ service: aai\r
+ author: ONAP CLI Team onap-discuss@lists.onap.org\r
+\r
+parameters:\r
+ - name: node-type-name\r
+ description: node type name\r
+ type: string\r
+ short_option: n\r
+ long_option: node-type-name\r
+ is_optional: false\r
+ - name: filter\r
+ description: filter for earch, like ,global-customer-id:EQUALS:Orange\r
+ type: string\r
+ short_option: c\r
+ long_option: filter\r
+ is_optional: false\r
+results:\r
+ direction: landscape\r
+ attributes:\r
+ - name: resource-type\r
+ description: Onap resource-type\r
+ scope: short\r
+ type: string\r
+ - name: resource-link\r
+ description: Onap resource-link\r
+ scope: short\r
+ type: string\r
+ \r
+http:\r
+ service:\r
+ auth: basic\r
+ mode: direct\r
+ request:\r
+ uri: /aai/v11/search/nodes-query?search-node-type=${node-type-name}&filter=${filter}\r
+ method: GET\r
+ success_codes:\r
+ - 200\r
+ - 201\r
+ result_map:\r
+ resource-type: $b{result-data.[*].resource-type}\r
+ resource-link: $b{result-data.[*].resource-link}\r
+ \r
--- /dev/null
+# Copyright 2018 Huawei Technologies Co., Ltd.\r
+#\r
+# Licensed under the Apache License, Version 2.0 (the "License");\r
+# you may not use this file except in compliance with the License.\r
+# You may obtain a copy of the License at\r
+#\r
+# http://www.apache.org/licenses/LICENSE-2.0\r
+#\r
+# Unless required by applicable law or agreed to in writing, software\r
+# distributed under the License is distributed on an "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+# See the License for the specific language governing permissions and\r
+# limitations under the License.\r
+\r
+open_cli_schema_version: 1.0\r
+name: service-instance-relationship-create\r
+description: Create a service instance relationship for vnf/pnf\r
+\r
+info:\r
+ product: onap-beijing\r
+ service: aai\r
+ author: ONAP CLI Team onap-discuss@lists.onap.org\r
+\r
+parameters:\r
+ - name: global-customer-id\r
+ description: global-customer-id\r
+ type: string\r
+ short_option: g\r
+ long_option: global-customer-id\r
+ is_optional: false\r
+ - name: service-type\r
+ description: service-type \r
+ type: string\r
+ short_option: z\r
+ long_option: service-type\r
+ is_optional: false\r
+ - name: service-instance-id\r
+ description: service-instance-id\r
+ type: string\r
+ short_option: i\r
+ long_option: service-instance-id\r
+ is_optional: false\r
+ - name: relationship\r
+ description: relationship\r
+ type: json\r
+ short_option: r\r
+ long_option: relationship\r
+ is_optional: false\r
+# sample json of relationship\r
+# {\r
+# "related-to": "logical-link",\r
+# "related-link": "/aai/v11/network/logical-links/logical-link/S11-00001",\r
+# "relationship-data": [\r
+# {\r
+# "relationship-key": "logical-link.link-name",\r
+# "relationship-value": "S11-00001"\r
+# }\r
+# ]\r
+# }\r
+ \r
+http:\r
+ service:\r
+ auth: basic\r
+ mode: direct\r
+ request:\r
+ uri: /business/customers/customer/${global-customer-id}/service-subscriptions/service-subscription/${service-type}/service-instances/service-instance/${service-instance-id}/relationship-list/relationship \r
+ method: PUT\r
+ context:\r
+ remove_empty_node: true\r
+ body: '"${relationship}"'\r
+ success_codes:\r
+ - 200\r
+ - 201\r
--- /dev/null
+# Copyright 2018 Huawei Technologies Co., Ltd.\r
+#\r
+# Licensed under the Apache License, Version 2.0 (the "License");\r
+# you may not use this file except in compliance with the License.\r
+# You may obtain a copy of the License at\r
+#\r
+# http://www.apache.org/licenses/LICENSE-2.0\r
+#\r
+# Unless required by applicable law or agreed to in writing, software\r
+# distributed under the License is distributed on an "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+# See the License for the specific language governing permissions and\r
+# limitations under the License.\r
+\r
+\r
+open_cli_schema_version: 1.0\r
+name: service-instance-relationship-delete\r
+description: delete a service instance relationship for vnf/pnf\r
+\r
+info:\r
+ product: onap-beijing\r
+ service: aai\r
+ author: ONAP CLI Team onap-discuss@lists.onap.org\r
+\r
+parameters:\r
+ - name: global-customer-id\r
+ description: global-customer-id\r
+ type: string\r
+ short_option: g\r
+ long_option: global-customer-id\r
+ is_optional: false\r
+ - name: service-type\r
+ description: service-type \r
+ type: string\r
+ short_option: z\r
+ long_option: service-type\r
+ is_optional: false\r
+ - name: service-instance-id\r
+ description: service-instance-id\r
+ type: string\r
+ short_option: i\r
+ long_option: service-instance-id\r
+ is_optional: false\r
+ - name: relationship\r
+ description: relationship\r
+ type: json\r
+ short_option: r\r
+ long_option: relationship\r
+ is_optional: false\r
+# sample json of relationship\r
+# {\r
+# "related-to": "logical-link",\r
+# "related-link": "/aai/v11/network/logical-links/logical-link/S11-00001",\r
+# "relationship-data": [\r
+# {\r
+# "relationship-key": "logical-link.link-name",\r
+# "relationship-value": "S11-00001"\r
+# }\r
+# ]\r
+# }\r
+ \r
+http:\r
+ service:\r
+ auth: basic\r
+ mode: direct\r
+ request:\r
+ uri: /business/customers/customer/${global-customer-id}/service-subscriptions/service-subscription/${service-type}/service-instances/service-instance/${service-instance-id}/relationship-list/relationship \r
+ method: DELETE\r
+ context:\r
+ remove_empty_node: true\r
+ body: '"${relationship}"'\r
+ success_codes:\r
+ - 200\r
+ - 201\r
--- /dev/null
+# Copyright 2018 Huawei Technologies Co., Ltd.\r
+#\r
+# Licensed under the Apache License, Version 2.0 (the "License");\r
+# you may not use this file except in compliance with the License.\r
+# You may obtain a copy of the License at\r
+#\r
+# http://www.apache.org/licenses/LICENSE-2.0\r
+#\r
+# Unless required by applicable law or agreed to in writing, software\r
+# distributed under the License is distributed on an "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+# See the License for the specific language governing permissions and\r
+# limitations under the License.\r
+\r
+open_cli_schema_version: 1.0\r
+name: service-list\r
+description: List created service instance\r
+\r
+info:\r
+ product: onap-beijing\r
+ service: aai\r
+ author: ONAP CLI Team onap-discuss@lists.onap.org\r
+\r
+parameters:\r
+ - name: customer-name\r
+ description: customer name\r
+ type: string\r
+ short_option: x\r
+ long_option: customer-name\r
+ is_optional: false\r
+ - name: service-type\r
+ description: service subscription type\r
+ type: string\r
+ short_option: y\r
+ long_option: service-type\r
+ is_optional: false\r
+\r
+results:\r
+ direction: landscape\r
+ attributes:\r
+ - name: service-id\r
+ description: instance id of service\r
+ scope: short\r
+ type: string\r
+ - name: service-name\r
+ description: Service name\r
+ scope: short\r
+ type: string\r
+ - name: model-invariant-id\r
+ description: Model invariant id of service model\r
+ scope: long\r
+ type: string\r
+ - name: model-uuid\r
+ description: Model uuid for service model\r
+ scope: long\r
+ type: string\r
+ - name: description\r
+ description: service description\r
+ scope: long\r
+ type: string\r
+\r
+http:\r
+ service:\r
+ name: aai\r
+ version: v11\r
+ auth: basic\r
+ mode: direct\r
+\r
+ request:\r
+ uri: /aai/v11/business/customers/customer/${customer-name}/service-subscriptions/service-subscription/${service-type}/service-instances\r
+ method: GET\r
+ success_codes:\r
+ - 200\r
+ result_map:\r
+ service-id: $b{service-instance.[*].service-instance-id}\r
+ service-name: $b{service-instance.[*].service-instance-name}\r
+ model-invariant-id: $b{service-instance.[*].model-invariant-id}\r
+ model-uuid: $b{service-instance.[*].model-version-id}\r
+ description: $b{service-instance.[*].description}\r
+ sample_response:\r
+ body: '{"service-instance": [{"service-instance-id": "${service-id}","service-instance-name": "${service-name}","description": "${description}","model-invariant-id": "${model-invariant-id}","model-version-id": "${model-uuid}"}]}'\r
--- /dev/null
+# Copyright 2018 Huawei Technologies Co., Ltd.\r
+#\r
+# Licensed under the Apache License, Version 2.0 (the "License");\r
+# you may not use this file except in compliance with the License.\r
+# You may obtain a copy of the License at\r
+#\r
+# http://www.apache.org/licenses/LICENSE-2.0\r
+#\r
+# Unless required by applicable law or agreed to in writing, software\r
+# distributed under the License is distributed on an "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+# See the License for the specific language governing permissions and\r
+# limitations under the License.\r
+\r
+open_cli_schema_version: 1.0\r
+name: vnf-create\r
+description: Create a vnf\r
+\r
+info:\r
+ product: onap-beijing\r
+ service: aai\r
+ author: ONAP CLI Team onap-discuss@lists.onap.org\r
+\r
+parameters:\r
+ - name: vnf-name\r
+ description: vnf-name\r
+ type: string\r
+ short_option: n\r
+ long_option: name\r
+ is_optional: true\r
+ - name: vnf-id\r
+ description: vnf-id\r
+ type: string\r
+ short_option: i\r
+ long_option: vnf-id\r
+ is_optional: false\r
+ - name: vnf-type\r
+ description: vnf-type\r
+ type: string\r
+ short_option: z\r
+ long_option: vnf-type\r
+ is_optional: true\r
+ - name: in-maint\r
+ description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true)\r
+ type: bool\r
+ short_option: w\r
+ long_option: in-maint\r
+ is_optional: true\r
+ - name: relationship\r
+ description: relationship\r
+ type: json\r
+ short_option: r\r
+ long_option: relationship\r
+ is_optional: true\r
+http:\r
+ service:\r
+ auth: basic\r
+ mode: direct\r
+ request:\r
+ uri: /aai/v11/network/generic-vnfs/generic-vnf/${vnf-id}\r
+ method: PUT\r
+ context:\r
+ remove_empty_node: true\r
+ body: '{"vnf-id": "${vnf-id}","vnf-name": "${vnf-name}" ,"vnf-type": "${vnf-type}","in-maint": "${in-maint}","relationship-list": ["${relationship}"]}'\r
+ success_codes:\r
+ - 200\r
+ - 201\r
--- /dev/null
+# Copyright 2018 Huawei Technologies Co., Ltd.\r
+#\r
+# Licensed under the Apache License, Version 2.0 (the "License");\r
+# you may not use this file except in compliance with the License.\r
+# You may obtain a copy of the License at\r
+#\r
+# http://www.apache.org/licenses/LICENSE-2.0\r
+#\r
+# Unless required by applicable law or agreed to in writing, software\r
+# distributed under the License is distributed on an "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+# See the License for the specific language governing permissions and\r
+# limitations under the License.\r
+\r
+open_cli_schema_version: 1.0\r
+name: vnf-delete\r
+description: Delete vnf from Onap\r
+\r
+info:\r
+ product: onap-beijing\r
+ service: aai\r
+ author: ONAP CLI Team onap-discuss@lists.onap.org\r
+\r
+\r
+parameters:\r
+ - name: vnf-id\r
+ description: Onap vnf id\r
+ type: string\r
+ short_option: i\r
+ long_option: vnf-id\r
+ is_optional: false\r
+ - name: resource-version\r
+ description: Onap vnf resource version\r
+ type: uuid\r
+ short_option: b\r
+ long_option: resource-version\r
+ is_optional: false\r
+http:\r
+ service:\r
+ auth: basic\r
+ mode: direct\r
+ request:\r
+ uri: /aai/v11/network/generic-vnfs/generic-vnf/${vnf-id}?resource-version=${resource-version}\r
+ method: DELETE\r
+ success_codes:\r
+ - 204\r
+ - 404\r
--- /dev/null
+# Copyright 2018 Huawei Technologies Co., Ltd.\r
+#\r
+# Licensed under the Apache License, Version 2.0 (the "License");\r
+# you may not use this file except in compliance with the License.\r
+# You may obtain a copy of the License at\r
+#\r
+# http://www.apache.org/licenses/LICENSE-2.0\r
+#\r
+# Unless required by applicable law or agreed to in writing, software\r
+# distributed under the License is distributed on an "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+# See the License for the specific language governing permissions and\r
+# limitations under the License.\r
+\r
+open_cli_schema_version: 1.0\r
+name: vnf-list\r
+description: Lists the vnfs\r
+\r
+info:\r
+ product: onap-beijing\r
+ service: aai\r
+ author: ONAP CLI Team onap-discuss@lists.onap.org\r
+\r
+results:\r
+ direction: landscape\r
+ attributes:\r
+ - name: vnf-name\r
+ description: Onap vnf name\r
+ scope: short\r
+ type: string\r
+ - name: vnf-id\r
+ description: Onap vnf id\r
+ scope: short\r
+ type: string\r
+ - name: vnf-type\r
+ description: Onap vnf-type\r
+ scope: short\r
+ type: string\r
+ - name: in-maint\r
+ description: Onap in-maint\r
+ scope: short\r
+ type: string\r
+ - name: resource-version\r
+ description: Onap resource-version\r
+ scope: short\r
+ type: string\r
+http:\r
+ service:\r
+ auth: basic\r
+ mode: direct\r
+ request:\r
+ uri: /aai/v11/network/generic-vnfs\r
+ method: GET\r
+ success_codes:\r
+ - 200\r
+ result_map:\r
+ vnf-name: $b{generic-vnf.[*].vnf-name}\r
+ vnf-id: $b{generic-vnf.[*].vnf-id}\r
+ vnf-type: $b{generic-vnf.[*].vnf-type}\r
+ in-maint: $b{generic-vnf.[*].in-maint}\r
+ resource-version: $b{generic-vnf.[*].resource-version}\r
Code Review / cli.git / commitdiff