products/onap-dublin/features/aai/src/main/resources/open-cli-schema/so-components/vf-module-list-schema-dublin.yaml

   1 # Copyright © Intel Corporation 2019
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 open_cli_schema_version: 1.0
  16 name: vf-module-list
  17 description: List the VF module in a VNF instance
  18
  19 info:
  20   product: onap-dublin
  21   service: aai
  22   author: ONAP CLI Team onap-discuss@lists.onap.org
  23
  24 parameters:
  25    - name: vnf-id
  26      description: id of vnf instance
  27      type: string
  28      short_option: x
  29      long_option: vnf-id
  30      is_optional: false
  31
  32 results:
  33   direction: landscape
  34   attributes:
  35     - name: vf-module-name
  36       description: Name of the vf-module
  37       scope: short
  38       type: string
  39     - name: vf-module-id
  40       description: Id of the vf-module
  41       scope: short
  42       type: string
  43     - name: resource-version
  44       description: resource version of the vf module
  45       scope: short
  46       type: string
  47
  48 http:
  49   service:
  50     auth: basic
  51     mode: direct
  52   request:
  53     uri: /aai/v14/network/generic-vnfs/generic-vnf/${vnf-id}/vf-modules
  54     method: GET
  55   success_codes:
  56     - 200
  57   result_map:
  58     vf-module-name: $b{vf-module.[*].vf-module-name}
  59     vf-module-id: $b{vf-module.[*].vf-module-id}
  60     resource-version: $b{vf-module.[*].resource-version}