aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim')
-rw-r--r--plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-create-schema-1.1.yaml107
-rw-r--r--plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-delete-schema-1.1.yaml51
-rw-r--r--plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-list-schema-1.1.yaml92
3 files changed, 250 insertions, 0 deletions
diff --git a/plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-create-schema-1.1.yaml b/plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-create-schema-1.1.yaml
new file mode 100644
index 00000000..d50acfb9
--- /dev/null
+++ b/plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-create-schema-1.1.yaml
@@ -0,0 +1,107 @@
+open_cli_schema_version: 1.0
+name: vim-register
+description: Register a VIM under a given cloud region in Onap
+version: onap-1.1
+service:
+ name: aai
+ version: v11
+ auth: basic
+ mode: direct
+
+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:
+ 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: ''
diff --git a/plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-delete-schema-1.1.yaml b/plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-delete-schema-1.1.yaml
new file mode 100644
index 00000000..ee74ead5
--- /dev/null
+++ b/plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-delete-schema-1.1.yaml
@@ -0,0 +1,51 @@
+open_cli_schema_version: 1.0
+
+name: vim-unregister
+
+description: Un-register a VIM under from cloud region in Onap
+
+version: onap-1.1
+
+service:
+ name: aai
+ version: v11
+ auth: basic
+ mode: direct
+
+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: resource-version
+ description: Onap vim resource version
+ type: string
+ short_option: b
+ long_option: resource-version
+ is_optional: true
+
+http:
+ request:
+ uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}/esr-system-info-list/esr-system-info/${vim-id}?resource-version=${resource-version}
+ method: DELETE
+
+ success_codes:
+ - 204
+ - 404
+
+ sample_response:
+ body: ''
diff --git a/plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-list-schema-1.1.yaml b/plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-list-schema-1.1.yaml
new file mode 100644
index 00000000..2af3474d
--- /dev/null
+++ b/plugins/onap-1.1/features/aai/src/main/resources/open-cli-schema/esr/vim/vim-list-schema-1.1.yaml
@@ -0,0 +1,92 @@
+open_cli_schema_version: 1.0
+
+name: vim-list
+
+description: List the configured vims
+
+version: onap-1.1
+
+service:
+ name: aai
+ version: v11
+ auth: basic
+ mode: direct
+
+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
+
+results:
+ direction: landscape
+ attributes:
+ - name: vim-id
+ description: Onap vim id
+ scope: short
+ type: string
+ - name: name
+ description: Onap vim name
+ scope: short
+ type: string
+ - name: type
+ description: Onap vim type
+ scope: long
+ type: string
+ - name: vendor
+ description: Onap vim vendor
+ scope: short
+ type: string
+ - name: version
+ description: Onap vim version
+ scope: long
+ type: string
+ - name: url
+ description: Onap vim url
+ scope: long
+ type: string
+ - name: username
+ description: Onap vim username
+ scope: long
+ type: string
+ - name: cloud-domain
+ description: Onap vim cloud domain
+ scope: long
+ type: string
+ - name: default-tenant
+ description: Onap vim tenant
+ scope: short
+ type: string
+ - name: resource-version
+ description: Onap vim resource version
+ scope: short
+ type: string
+
+http:
+ request:
+ uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud-name}/${region-name}/esr-system-info-list
+ method: GET
+ success_codes:
+ - 200
+ result_map:
+ vim-id: $b{$.esr-system-info.[*].esr-system-info-id}
+ name: $b{$.esr-system-info.[*].system-name}
+ type: $b{$.esr-system-info.[*].type}
+ vendor: $b{$.esr-system-info.[*].vendor}
+ version: $b{$.esr-system-info.[*].version}
+ url: $b{$.esr-system-info.[*].service-url}
+ username: $b{$.esr-system-info.[*].user-name}
+ cloud-domain: $b{$.esr-system-info.[*].cloud-domain}
+ default-tenant: $b{$.esr-system-info.[*].default-tenant}
+ resource-version: $b{$.esr-system-info.[*].resource-version}
+
+ sample_response:
+ body: '{esr-system-info":[{"esr-system-info-id":"example-esr-system-info-id-val-62966","system-name":"example-system-name-val-76894","type":"example-type-val-32301","vendor":"example-vendor-val-38139","version":"example-version-val-42345","service-url":"example-service-url-val-33729","user-name":"example-user-name-val-32122","password":"example-password-val-56539","system-type":"example-system-type-val-80707","protocal":"example-protocal-val-30105","ssl-cacert":"example-ssl-cacert-val-52110","ssl-insecure":true,"ip-address":"example-ip-address-val-10140","port":"example-port-val-26369","cloud-domain":"example-cloud-domain-val-22303","default-tenant":"example-default-tenant-val-26326"}]}'