summaryrefslogtreecommitdiffstats
path: root/products/onap-beijing/features/aai/src/main/resources/open-cli-schema/logical-link/logic-link-create-schema.yaml
blob: 729cd91a69bbb6cf1f7623b1279936858bcf2327 (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
# Copyright 2018 Huawei Technologies Co., Ltd.
#
# 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: logic-link-create
description: Create a logic-link

info:
  product: onap-beijing
  service: aai
  author: ONAP CLI Team onap-discuss@lists.onap.org

parameters:
  - name: link-name
    description: logic-link-name
    type: string
    short_option: n
    long_option: name
    is_optional: false
  - name: link-type
    description: link-type
    type: string
    short_option: i
    long_option: link-type
    is_optional: true
  - name: speed-value
    description: speed-value
    type: string
    short_option: q
    long_option: speed-value
    is_optional: true
  - name: speed-units
    description: speed-units
    type: string
    short_option: x
    long_option: speed-units
    is_optional: true
  - name: in-maint
    description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
    type: bool
    short_option: w
    long_option: in-maint
    is_optional: false
  - name: prov-status
    description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
    type: string
    short_option: g
    long_option: prov-status
    is_optional: true
  - name: link-role
    description: link-role
    type: string
    short_option: j
    long_option: link-role
    is_optional: true
  - name: link-id
    description: link-id
    type: string
    short_option: z
    long_option: link-id
    is_optional: true
  - name: relationship
    description: relationship
    type: json
    short_option: r
    long_option: relationship
    is_optional: true
http:
  service:
    auth: basic
    mode: direct
  request:
    uri: /aai/v11/network/logic-links/logic-link/${link-name}
    method: PUT
    context:
      remove_empty_node: true
    body: '{"link-name": "${link-name}" ,"link-type": "${link-type}","speed-value": "${speed-value}","speed-units": "${speed-units}","in-maint": "${in-maint}","prov-status": "${prov-status}","link-role": "${link-role}","link-id": "${link-id}","relationship-list": ["${relationship}"]}'
  success_codes:
    - 200
    - 201