open_cli_schema_version: 1.0
name: vim-register
description: Register a VIM under a given cloud region in Onap

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

parameters:
  - name: cloud-name
    description: Onap cloud name
    type: string
    short_option: x
    long_option: cloud-name
    is_optional: false
  - name: region-name
    description: Onap  region name
    type: string
    short_option: y
    long_option:  region-name
    is_optional: false
  - name: vim-id
    description: Onap VIM unique id
    type: uuid
    short_option: z
    long_option:  vim-id
    is_optional: false
  - name: name
    description: Onap VIM name
    type: string
    short_option: b
    long_option:  name
    is_optional: false
  - name: type
    description: Onap VIM type
    type: string
    short_option: c
    long_option:  type
    is_optional: false
  - name: vendor
    description: Onap VIM vendor
    type: string
    short_option: e
    long_option:  vendor
    is_optional: false
  - name: vim-version
    description: Onap VIM version
    type: string
    short_option: q
    long_option:  vim-version
    is_optional: false
  - name: url
    description: Onap VIM URL
    type: string
    short_option: g
    long_option:  url
    is_optional: false
  - name: username
    description: Onap VIM username
    type: string
    short_option: i
    long_option:  username
    is_optional: false
  - name: password
    description: Onap VIM password
    type: string
    short_option: j
    long_option:  password
    is_optional: false
  - name: ssl-cacert
    description: Onap VIM SSL certificate
    type: text
    short_option: k
    long_option:  ssl-cacert
    is_optional: true
  - name: ssl-insecure
    description: Onap VIM insecure
    type: bool
    short_option: l
    long_option:  ssl-insecure
    is_optional: true
    default: false
  - name: cloud-domain
    description: Onap VIM cloud domain
    type: string
    short_option: n
    long_option:  cloud-domain
    is_optional: false
    default: default
  - name: default-tenant
    description: Onap VIM default tenant
    type: string
    short_option: o
    long_option:  default-tenant
    is_optional: false

http:
  service:
    auth: basic
    mode: direct
  request:
    uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}/esr-system-info-list/esr-system-info/${vim-id}
    method: PUT
    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}"}'
  success_codes:
    - 201
  sample_response:
    body: ''