aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/onap-1.1/features/so/src/main/resources/open-cli-schema/services/vfmodule-create-schema-1.1.yaml
blob: c2537aea2e39c1076b4902ee488e37e391ff267f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
open_cli_schema_version: 1.0
name: vfmodule-create
description: Create a VF module

info:
  product: onap-1.1
  service: so
  author: ONAP CLI Team onap-discuss@lists.onap.org

parameters:
  - name: cloud-region
    description: cloud region identifier
    type: string
    short_option: l
    long_option: cloud-region
    is_optional: false
  - name: tenant-id
    description: openstack tenant id
    type: string
    short_option: B
    long_option: tenant-id
    is_optional: false
  - name: vfmodule-invariant-id
    description: vfmodule model invariant id
    type: string
    short_option: b
    long_option: vfmodule-invariant-id
    is_optional: false
  - name: vfmodule-uuid
    description: model uuid for vfmodule
    type: string
    short_option: c
    long_option: vfmodule-uuid
    is_optional: false
  - name: vfmodule-name
    description: vfmodule model name
    type: string
    short_option: e
    long_option: vfmodule-name
    is_optional: false
  - name: vfmodule-version
    description: vf module version
    type: string
    short_option: g
    long_option: vfmodule-version
    is_optional: false
  - name: module-name
    description: vfmodule name
    type: string
    short_option: i
    long_option: module-name
    is_optional: false
  - name: service-id
    description: unique id for service
    type: string
    short_option: j
    long_option: service-id
    is_optional: false
  - name: vf-id
    description: unique id for related VF
    type: string
    short_option: y
    long_option: vf-id
    is_optional: false
  - name: vf-model-invariant-id
    description: vf model invariant id
    type: string
    short_option: k
    long_option: vf-model-invariant-id
    is_optional: false
  - name: vf-model-uuid
    description: model uuid for vf
    type: string
    short_option: A
    long_option: vf-model-uuid
    is_optional: false
  - name: vf-model-name
    description: vf model name
    type: string
    short_option: n
    long_option: vf-model-name
    is_optional: false
  - name: vf-model-version
    description: vf model version
    type: string
    short_option: o
    long_option: vf-model-version
    is_optional: false
  - name: vf-model-customization-id
    description: vf model customization id. This can be obtained using SDC portal (Home -> service:xxx -> Composition -> click on VF for customization id).
    type: string
    short_option: q
    long_option: vf-model-customization-id
    is_optional: false
  - name: service-model-invariant-id
    description: model invariant id
    type: string
    short_option: r
    long_option: service-model-invariant-id
    is_optional: false
  - name: service-model-uuid
    description: model name version id
    type: string
    short_option: w
    long_option: service-model-uuid
    is_optional: false
  - name: service-model-name
    description: service model name
    type: string
    short_option: x
    long_option: service-model-name
    is_optional: false
  - name: service-model-version
    description: service model version
    type: string
    short_option: z
    long_option: service-model-version
    is_optional: false


results:
  direction: portrait
  attributes:
    - name: vfmodule-id
      description: id for the created vnf
      type: string
      scope: short

http:
  service:
    name: so
    version: v3
    auth: basic
    mode: direct
  request:
    uri: /ecomp/mso/infra/serviceInstances/v3/${service-id}/vnfs/${vf-id}/vfModules
    method: POST
    body: '{"requestDetails": {"modelInfo": {"modelType": "vfModule","modelInvariantId": "${vfmodule-invariant-id}","modelNameVersionId": "${vfmodule-uuid}","modelName": "${vfmodule-name}","modelVersion": "${vfmodule-version}"},"cloudConfiguration": {"lcpCloudRegionId": "${cloud-region}","tenantId": "${tenant-id}"},"requestInfo": {"instanceName": "${module-name}","source": "VID"},"relatedInstanceList": [{"relatedInstance": {"instanceId": "${service-id}","modelInfo": {"modelType": "service","modelInvariantId": "${service-model-invariant-id}","modelNameVersionId": "${service-model-uuid}","modelName": "${service-model-name}","modelVersion": "${service-model-version}"}}},{"relatedInstance": {"instanceId": "${vf-id}","modelInfo": {"modelType": "vnf","modelInvariantId": "${vf-model-invariant-id}","modelNameVersionId": "${vf-model-uuid}","modelName": "${vf-model-name}","modelVersion": "${vf-model-version}","modelCustomizationName": "${vf-model-customization-id}"}}}],"requestParameters": {"userParams": []}}}'

  success_codes:
    - 202
  result_map:
    vfmodule-id: $b{$.requestReferences.instanceId}