3f08e44c9788108e442d04b61844fad3b6cdc44b
[cli.git] /
1 open_cli_schema_version: 1.0
2 name: vf-module-create
3 description: Create a VF Module
4
5 info:
6   product: onap-amsterdam
7   service: so
8   author: ONAP CLI Team onap-discuss@lists.onap.org
9
10 parameters:
11   - name: lcp-cloudregion-id
12     description: AIC LCP node location identifier
13     type: string
14     short_option: l
15     long_option: lcp-cloudregion-id
16     is_optional: false
17   - name: tenant-id
18     description: openstack tenant id (uuid)
19     type: string
20     short_option: w
21     long_option: tenant-id
22     is_optional: false
23   - name: vnf-instance-id
24     description: vnf instance id
25     type: string
26     short_option: y
27     long_option: vnf-instace-id
28     is_optional: false
29   - name: service-instance-id
30     description: unique id for service instance
31     type: string
32     short_option: x
33     long_option: service-instace-id
34     is_optional: false
35   - name: parenet-service-model
36     description: parent service model name
37     type: string
38     short_option: z
39     long_option: parenet-service-model
40     is_optional: false
41   - name: supress-rollback
42     description: rollback changes if instantiation fails.
43     type: bool
44     short_option: r
45     long_option: supress-rollback
46     is_optional: true
47   - name: instance-name
48     description: service instance name
49     type: string
50     short_option: i
51     long_option: instance-name
52     is_optional: false
53
54 results:
55   direction: portrait
56   attribute:
57     - name: vf-instance-id
58       description: id for the created vf
59       type: string
60       scope: short
61
62 http:
63   service:
64     name: so
65     version: v3
66     auth: basic
67     mode: direct
68   request:
69     uri: ecomp/mso/infra/serviceInstances/v2/${service-instance-id}/vnfs/${vnf-instance-id}/vfModules
70     method: PUT
71     body: '{"requestDetails":{"modelInfo":{"modelType":"vfModule","modelInvariantId":"ff5256d2-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6478e5-ea33-3346-ac12-ab121484a3fe","modelName":"vSAMP12..base..module-0","modelVersion":"1"},"cloudConfiguration":{"lcpCloudRegionId":"${lcp-cloudregion-id}","tenantId":"${tenant-id}"},"requestInfo":{"instanceName":"${instance-name}","source":"VID","suppressRollback":"${supress-rollback}"},"relatedInstanceList":[{"relatedInstance":{"instanceId":"${service-instance-id}","modelInfo":{"modelType":"service","modelInvariantId":"ff3514e3-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6985cd-ea33-3346-ac12-ab121484a3fe","modelName":"${parenet-service-model}","modelVersion":"1.0"}}},{"relatedInstance":{"instanceId":"${vnf-instance-id}","modelInfo":{"modelType":"vnf","modelInvariantId":"ff5256d1-5a33-55df-13ab-12abad84e7ff","modelNameVersionId":"fe6478e4-ea33-3346-ac12-ab121484a3fe","modelName":"vSAMP12","modelVersion":"1.0","modelCustomizationName":"vSAMP12 1"}}}],"requestParameters":{"userParams":[]}}}'
72
73   success_codes:
74     - 202
75   result_mpa:
76     vf-instance-id: $b{$.vfInstanceId}
77   sample_response:
78     body: '{"vfInstanceId":"234567AB"}'