gerrit.onap Code Review - cli.git/blob

   1 open_cli_schema_version: 1.0
   2 name: vf-create
   3 description: Create a VF
   4 info:
   5   product: onap-amsterdam
   6   service: so
   7   author: ONAP CLI Team onap-discuss@lists.onap.org
   8
   9
  10 parameters:
  11   - name: cloud-region
  12     description: cloud region identifier
  13     type: string
  14     short_option: l
  15     long_option: cloud-region
  16     is_optional: false
  17   - name: tenant-id
  18     description: openstack tenant id
  19     type: string
  20     short_option: z
  21     long_option: tenant-id
  22     is_optional: false
  23   - name: product-family
  24     description: service type for serivce (e.g. vLB)
  25     type: string
  26     short_option: w
  27     long_option: product-family
  28     is_optional: false
  29   - name: instance-name
  30     description: service instance name
  31     type: string
  32     short_option: o
  33     long_option: instance-name
  34     is_optional: false
  35   - name: service-instance-id
  36     description: unique id for service instance
  37     type: string
  38     short_option: y
  39     long_option: service-instance-id
  40     is_optional: false
  41   - name: vf-model-invariant-id
  42     description: vf model invariant id
  43     type: string
  44     short_option: b
  45     long_option: vf-model-invariant-id
  46     is_optional: false
  47   - name: vf-model-uuid
  48     description: model uuid for vf
  49     type: string
  50     short_option: c
  51     long_option: vf-model-uuid
  52     is_optional: false
  53   - name: vf-model-name
  54     description: vf model name
  55     type: string
  56     short_option: e
  57     long_option: vf-model-name
  58     is_optional: false
  59   - name: vf-model-version
  60     description: vf model version
  61     type: string
  62     short_option: g
  63     long_option: vf-model-version
  64     is_optional: false
  65   - name: vf-model-customization-id
  66     description: vf model customization id
  67     type: string
  68     short_option: i
  69     long_option: vf-model-customization-id
  70     is_optional: false
  71   - name: service-model-invariant-id
  72     description: model invariant id
  73     type: string
  74     short_option: j
  75     long_option: service-model-invariant-id
  76     is_optional: false
  77   - name: service-model-uuid
  78     description: model name version id
  79     type: string
  80     short_option: k
  81     long_option: service-model-uuid
  82     is_optional: false
  83   - name: service-model-name
  84     description: service model name
  85     type: string
  86     short_option: q
  87     long_option: service-model-name
  88     is_optional: false
  89   - name: service-model-version
  90     description: service model version
  91     type: string
  92     short_option: n
  93     long_option: service-model-version
  94     is_optional: false
  95
  96
  97 results:
  98   direction: portrait
  99   attributes:
 100     - name: vf-id
 101       description: id for the created vnf
 102       type: string
 103       scope: short
 104
 105 http:
 106   service:
 107     name: so
 108     version: v3
 109     auth: basic
 110     mode: direct
 111   request:
 112     uri: /ecomp/mso/infra/serviceInstances/v3/${service-instance-id}/vnfs
 113     method: POST
 114     body: '{"requestDetails": {"modelInfo": {"modelType": "vnf","modelInvariantId": "${vf-model-invariant-id}","modelVersionId": "${vf-model-uuid}","modelName": "${vf-model-name}","modelVersion": "${vf-model-version}","modelCustomizationId": "${vf-model-customization-id}"},"cloudConfiguration": {"lcpCloudRegionId": "${cloud-region}","tenantId": "${tenant-id}"},"requestInfo": {"instanceName": "${instance-name}","source": "VID","productFamilyId": "${product-family}" },"relatedInstanceList": [{"relatedInstance": {"instanceId": "${service-instance-id}","modelInfo": {"modelType": "service","modelInvariantId": "${service-model-invariant-id}","modelVersionId": "${service-model-uuid}","modelName": "${service-model-name}","modelVersion": "${service-model-version}"}}}],"requestParameters": {}}}'
 115
 116   success_codes:
 117     - 202
 118   result_map:
 119     vf-id: $b{$.requestReferences.instanceId}
 120   sample_response:
 121     body: '{"requestReferences": {"instanceId": "2a152730-f6eb-4dc6-9b81-7a6f6f263d71","requestId": "6402628f-7f67-4605-9e60-0d8632616d02"}}'