gerrit.onap Code Review - cli.git/blob

   1 open_cli_schema_version: 1.0
   2 name: vim-register
   3 description: Register a VIM under a given cloud region in Onap
   4
   5 info:
   6   product: onap-amsterdam
   7   service: aai
   8   author: ONAP CLI Team onap-discuss@lists.onap.org
   9
  10 parameters:
  11   - name: cloud-name
  12     description: Onap cloud name
  13     type: string
  14     short_option: x
  15     long_option: cloud-name
  16     is_optional: false
  17   - name: region-name
  18     description: Onap  region name
  19     type: string
  20     short_option: y
  21     long_option:  region-name
  22     is_optional: false
  23   - name: vim-id
  24     description: Onap VIM unique id
  25     type: uuid
  26     short_option: z
  27     long_option:  vim-id
  28     is_optional: false
  29   - name: name
  30     description: Onap VIM name
  31     type: string
  32     short_option: b
  33     long_option:  name
  34     is_optional: false
  35   - name: type
  36     description: Onap VIM type
  37     type: string
  38     short_option: c
  39     long_option:  type
  40     is_optional: false
  41   - name: vendor
  42     description: Onap VIM vendor
  43     type: string
  44     short_option: e
  45     long_option:  vendor
  46     is_optional: false
  47   - name: vim-version
  48     description: Onap VIM version
  49     type: string
  50     short_option: q
  51     long_option:  vim-version
  52     is_optional: false
  53   - name: url
  54     description: Onap VIM URL
  55     type: string
  56     short_option: g
  57     long_option:  url
  58     is_optional: false
  59   - name: username
  60     description: Onap VIM username
  61     type: string
  62     short_option: i
  63     long_option:  username
  64     is_optional: false
  65   - name: password
  66     description: Onap VIM password
  67     type: string
  68     short_option: j
  69     long_option:  password
  70     is_optional: false
  71   - name: ssl-cacert
  72     description: Onap VIM SSL certificate
  73     type: text
  74     short_option: k
  75     long_option:  ssl-cacert
  76     is_optional: true
  77   - name: ssl-insecure
  78     description: Onap VIM insecure
  79     type: bool
  80     short_option: l
  81     long_option:  ssl-insecure
  82     is_optional: true
  83     default: false
  84   - name: cloud-domain
  85     description: Onap VIM cloud domain
  86     type: string
  87     short_option: n
  88     long_option:  cloud-domain
  89     is_optional: false
  90     default: default
  91   - name: default-tenant
  92     description: Onap VIM default tenant
  93     type: string
  94     short_option: o
  95     long_option:  default-tenant
  96     is_optional: false
  97
  98 http:
  99   service:
 100     auth: basic
 101     mode: direct
 102   request:
 103     uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}/esr-system-info-list/esr-system-info/${vim-id}
 104     method: PUT
 105     body: '{"esr-system-info-id":"${vim-id}","system-name":"${name}","type":"${type}","vendor":"${vendor}","version":"${vim-version}","service-url":"${url}","user-name":"${username}","password":"${password}","system-type":"vim","protocal":"","ssl-cacert":"${ssl-cacert}","ssl-insecure":"${ssl-insecure}","ip-address":"","port":"","cloud-domain":"${cloud-domain}","default-tenant":"${default-tenant}"}'
 106   success_codes:
 107     - 201
 108   sample_response:
 109     body: ''