VNFM schemas for onap-dublin CLI 13/79813/1
authorItohan Ukponmwan <itohan.ukponmwan@intel.com>
Wed, 6 Mar 2019 19:55:16 +0000 (19:55 +0000)
committerItohan Ukponmwan <itohan.ukponmwan@intel.com>
Wed, 6 Mar 2019 19:56:08 +0000 (19:56 +0000)
Change-Id: Iaba1d696fe063c469477eb092f84af2a07166a74
Issue-ID: CLI-130
Signed-off-by: Itohan Ukponmwan <itohan.ukponmwan@intel.com>
products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-create-schema-dublin.yaml [new file with mode: 0644]
products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-delete-schema-dublin.yaml [new file with mode: 0644]
products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-list-schema-dublin.yaml [new file with mode: 0644]
products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-show-schema-dublin.yaml [new file with mode: 0644]

diff --git a/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-create-schema-dublin.yaml b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-create-schema-dublin.yaml
new file mode 100644 (file)
index 0000000..772062e
--- /dev/null
@@ -0,0 +1,98 @@
+# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+
+name: vnfm-create
+
+description: Register a VNFM in Onap
+
+
+info:
+  product: onap-dublin
+  service: aai
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: vim-id
+    description: Onap VIM unique id
+    type: uuid
+    short_option: x
+    long_option:  vim-id
+    is_optional: false
+  - name: vnfm-id
+    description: Onap VNFM unique id
+    type: uuid
+    short_option: y
+    long_option:  vnfm-id
+    is_optional: false
+  - name: name
+    description: Onap VNFM name
+    type: string
+    short_option: b
+    long_option:  name
+    is_optional: false
+  - name: type
+    description: Onap VNFM type
+    type: string
+    short_option: c
+    long_option:  type
+    is_optional: false
+  - name: vendor
+    description: Onap VNFM vendor
+    type: string
+    short_option: e
+    long_option:  vendor
+    is_optional: false
+  - name: vnfm-version
+    description: Onap VNFM version
+    type: string
+    short_option: q
+    long_option:  vnfm-version
+    is_optional: false
+  - name: url
+    description: Onap VNFM URL
+    type: string
+    short_option: g
+    long_option:  url
+    is_optional: false
+  - name: username
+    description: Onap VNFM username
+    type: string
+    short_option: i
+    long_option:  username
+    is_optional: false
+  - name: password
+    description: Onap VNFM password
+    type: string
+    short_option: j
+    long_option:  password
+    is_optional: false
+  - name: certificate-url
+    description: Onap VNFM certificate-url
+    type: string
+    short_option: z
+    long_option: certificate-url
+    is_optional: true
+
+http:
+  service:
+    auth: basic
+    mode: direct
+  request:
+    uri: /aai/v13/external-system/esr-vnfm-list/esr-vnfm/${vnfm-id}
+    method: PUT
+    body: '{"vnfm-id":"${vnfm-id}","vim-id":"${vim-id}","certificate-url":"${certificate-url}","esr-system-info-list":{"esr-system-info":[{"esr-system-info-id":"${vnfm-id}","system-name":"${name}","type":"${type}","vendor":"${vendor}","version":"${vnfm-version}","service-url":"${url}","user-name":"${username}","password":"${password}","system-type":"vnfm","protocal":"","ssl-cacert":"","ssl-insecure":"","ip-address":"","port":"","cloud-domain":"","default-tenant":""}]}}'
+  success_codes:
+    - 201
diff --git a/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-delete-schema-dublin.yaml b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-delete-schema-dublin.yaml
new file mode 100644 (file)
index 0000000..8e9e2af
--- /dev/null
@@ -0,0 +1,50 @@
+# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+
+name: vnfm-delete
+
+description: Un-register a VNFM in Onap
+
+
+info:
+  product: onap-dublin
+  service: aai
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: vnfm-id
+    description: Onap VNFM unique id
+    type: uuid
+    short_option: x
+    long_option:  vnfm-id
+    is_optional: false
+  - name: resource-version
+    description: Onap vim resource version
+    type: string
+    short_option: y
+    long_option: resource-version
+    is_optional: true
+http:
+  service:
+    auth: basic
+    mode: direct
+  request:
+    uri: /aai/v13/external-system/esr-vnfm-list/esr-vnfm/${vnfm-id}?resource-version=${resource-version}
+    method: DELETE
+
+  success_codes:
+    - 204
+    - 404
diff --git a/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-list-schema-dublin.yaml b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-list-schema-dublin.yaml
new file mode 100644 (file)
index 0000000..05cd3b2
--- /dev/null
@@ -0,0 +1,60 @@
+# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+
+name: vnfm-list
+
+description: List the configured vnfm
+
+
+info:
+  product: onap-dublin
+  service: aai
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+results:
+  direction: landscape
+  attributes:
+    - name: vnfm-id
+      description: Onap vnfm id
+      scope: short
+      type: string
+    - name: vim-id
+      description: Onap vnfm id
+      scope: short
+      type: string
+    - name: certificate-url
+      description: Onap vnfm certificate-url
+      scope: short
+      type: string
+    - name: resource-version
+      description: Onap vnfm resource version
+      scope: short
+      type: string
+
+http:
+  service:
+    auth: basic
+    mode: direct
+  request:
+    uri: /aai/v13/external-system/esr-vnfm-list
+    method: GET
+  success_codes:
+    - 200
+  result_map:
+    vnfm-id: $b{$.esr-vnfm.[*].vnfm-id}
+    vim-id: $b{$.esr-vnfm.[*].vim-id}
+    certificate-url: $b{$.esr-vnfm.[*].certificate-url}
+    resource-version: $b{$.esr-vnfm.[*].resource-version}
diff --git a/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-show-schema-dublin.yaml b/products/onap-dublin/features/aai/src/main/resources/open-cli-schema/esr/vnfm/vnfm-show-schema-dublin.yaml
new file mode 100644 (file)
index 0000000..0ae7a94
--- /dev/null
@@ -0,0 +1,79 @@
+# Copyright © Intel Corporation 2019
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+open_cli_schema_version: 1.0
+
+name: vnfm-show
+
+description: Show the VNFM in Onap
+
+
+info:
+  product: onap-dublin
+  service: aai
+  author: ONAP CLI Team onap-discuss@lists.onap.org
+
+parameters:
+  - name: vnfm-id
+    description: Onap VNFM unique id
+    type: uuid
+    short_option: x
+    long_option:  vnfm-id
+    is_optional: false
+
+results:
+  direction: portrait
+  attributes:
+    - name: name
+      description: Onap vnfm name
+      scope: short
+      type: string
+    - name: type
+      description: Onap vnfm type
+      scope: short
+      type: string
+    - name: vendor
+      description: Onap vnfm vendor
+      scope: short
+      type: string
+    - name: version
+      description: Onap vnfm version
+      scope: short
+      type: string
+    - name: url
+      description: Onap vnfm url
+      scope: short
+      type: string
+    - name: username
+      description: Onap vnfm username
+      scope: long
+      type: string
+
+http:
+  service:
+    auth: basic
+    mode: direct
+  request:
+    uri: /aai/v13/external-system/esr-vnfm-list/esr-vnfm/${vnfm-id}/esr-system-info-list/esr-system-info/${vnfm-id}
+    method: GET
+
+  success_codes:
+    - 200
+  result_map:
+    name: $b{$.system-name}
+    type: $b{$.type}
+    vendor: $b{$.vendor}
+    version: $b{$.version}
+    url: $b{$.service-url}
+    username: $b{$.user-name}