Appc CLI OCS

author Toan Nguyen <tn2126@att.com>

Fri, 4 May 2018 15:03:15 +0000 (11:03 -0400)

committer Toan Nguyen <tn2126@att.com>

Fri, 4 May 2018 15:03:15 +0000 (11:03 -0400)
author Toan Nguyen <tn2126@att.com>
Fri, 4 May 2018 15:03:15 +0000 (11:03 -0400)
committer Toan Nguyen <tn2126@att.com>
Fri, 4 May 2018 15:03:15 +0000 (11:03 -0400)
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-actionstatus-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-actionstatus-schema.yaml

new file mode 100644 (file)

index 0000000..7b2ddc6
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-actionstatus-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-actionstatus\r
+description: The ActionStatus command returns that state of any action request that has been previously submitted to an APPC instance for a specified VNF \r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:action-status\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-attachhvolume-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-attachhvolume-schema.yaml

new file mode 100644 (file)

index 0000000..587b453
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-attachhvolume-schema.yaml
@@ -0,0 +1,162 @@
+open_cli_schema_version: 1.0\r
+name: vnf-attachvolume\r
+description: Attach a cinder volume from a VM via an Openstack command\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:attach-volume\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-audit-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-audit-schema.yaml

new file mode 100644 (file)

index 0000000..fdf2c1d
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-audit-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-audit\r
+description: Audit VNF\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:audit\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-checklock-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-checklock-schema.yaml

new file mode 100644 (file)

index 0000000..ba7283e
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-checklock-schema.yaml
@@ -0,0 +1,162 @@
+open_cli_schema_version: 1.0\r
+name: vnf-checklock\r
+description: The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:check-lock\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configure-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configure-schema.yaml

new file mode 100644 (file)

index 0000000..a7ffc8b
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configure-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-configure\r
+description: Configure a VNF or a VNFC on the VNF after instantiation\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:configure\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurebackup-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurebackup-schema.yaml

new file mode 100644 (file)

index 0000000..b2a3f76
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurebackup-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-configurebackup\r
+description: Backup the current VNF configuration on a local file system - not in APPC. This is limited to Ansible and Chef.\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:configure-backup\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configuremodify-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configuremodify-schema.yaml

new file mode 100644 (file)

index 0000000..b6aec12
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configuremodify-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-configuremodify\r
+description: Modifies the configuration on a VNF or VNFC in service.\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:configure-modify\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurerestore-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurerestore-schema.yaml

new file mode 100644 (file)

index 0000000..6f8d521
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurerestore-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-configurerestore\r
+description: Applies a previously saved configuration to the active VNF configuration.  This is limited to Ansible and Chef\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:configure-restore\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurescaleout-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurescaleout-schema.yaml

new file mode 100644 (file)

index 0000000..d202633
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurescaleout-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-configurerescaleout\r
+description: The ConfigScaleOut command is used to apply any actions on a VNF as part of a ScaleOut flow. Actions could include updating the VNF configuration or running a set of other tasks.\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:configure-scale-out\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-detachvolume-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-detachvolume-schema.yaml

new file mode 100644 (file)

index 0000000..a035550
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-detachvolume-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-detachvolume\r
+description: Detaches a cinder volume from a VM via an Openstack command\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:detach-volume\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-evacuate-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-evacuate-schema.yaml

new file mode 100644 (file)

index 0000000..fb50673
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-evacuate-schema.yaml
@@ -0,0 +1,162 @@
+open_cli_schema_version: 1.0\r
+name: vnf-evacuate\r
+description: Evacuates a specified VM from its current host to another\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:evacuate\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-healthcheck-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-healthcheck-schema.yaml

new file mode 100644 (file)

index 0000000..254b21b
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-healthcheck-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-healthcheck\r
+description: runs a VNF health check and returns the result\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:health-check\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 200\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-lock-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-lock-schema.yaml

new file mode 100644 (file)

index 0000000..c4ff213
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-lock-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-lock\r
+description: Use the Lock command to ensure exclusive access during a series of critical LCM commands\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:lock\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-migrate-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-migrate-schema.yaml

new file mode 100644 (file)

index 0000000..ea550b2
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-migrate-schema.yaml
@@ -0,0 +1,162 @@
+open_cli_schema_version: 1.0\r
+name: vnf-migrate\r
+description: Migrates a running target VM from its current host to another.\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:migrate\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-quiescetraffic-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-quiescetraffic-schema.yaml

new file mode 100644 (file)

index 0000000..c658ffe
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-quiescetraffic-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-quiescetraffic \r
+description: The QuiesceTraffic LCM action gracefully stops the traffic on the VNF. All application processes are assumed to be running but no traffic is being processed.\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:quiesce-traffic\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-rebuild-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-rebuild-schema.yaml

new file mode 100644 (file)

index 0000000..dc03207
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-rebuild-schema.yaml
@@ -0,0 +1,162 @@
+open_cli_schema_version: 1.0\r
+name: vnf-rebuild\r
+description: Rebuild VNF\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:rebuild\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-restart-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-restart-schema.yaml

new file mode 100644 (file)

index 0000000..2ac9541
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-restart-schema.yaml
@@ -0,0 +1,163 @@
+open_cli_schema_version: 1.0\r
+name: vnf-restart\r
+description: Restart VNF\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:restart\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-resumetraffic-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-resumetraffic-schema.yaml

new file mode 100644 (file)

index 0000000..158821d
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-resumetraffic-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-resumetraffic \r
+description: The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced.\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:resume-traffic\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-snapshot-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-snapshot-schema.yaml

new file mode 100644 (file)

index 0000000..6e4367e
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-snapshot-schema.yaml
@@ -0,0 +1,160 @@
+open_cli_schema_version: 1.0\r
+name: vnf-snapshot\r
+description: reates a snapshot of a VM\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: t\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: v\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: o\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: r\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: s \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags that apply to all LCM actions\r
+    type: string\r
+    short_option: r\r
+    long_option: flags-mode     \r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags that apply to all LCM actions\r
+    type: bool\r
+    short_option: f\r
+    long_option: flags-force     \r
+    is_optional: true  \r
+  - name: flags-ttl\r
+    description: Generic flags that apply to all LCM actions\r
+    type: digit\r
+    short_option: l\r
+    long_option: flags-ttl     \r
+    is_optional: true  \r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: a\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: i\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: j\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: n\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: k\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: q\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: p\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: timpestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: timpestamp\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:snapshot\r
+    method: POST\r
+    body: '{"input": {"common-header":{"timestamp": "${timestamp}","api-ver": "${api-version}","originator-id": "${orininator-id}","request-id": "$(request-id}","sub-request-id": "${sub-request-id}","flags":{"mode": "${flags-mode}","force": "${flags-force}","ttl": ${flags-ttl}"}}, "action": "${action}","action-identifiers": {"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'\r
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-start-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-start-schema.yaml

new file mode 100644 (file)

index 0000000..e2b6511
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-start-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-start\r
+description: Start VNF\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:start\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-startapplication-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-startapplication-schema.yaml

new file mode 100644 (file)

index 0000000..447a252
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-startapplication-schema.yaml
@@ -0,0 +1,162 @@
+open_cli_schema_version: 1.0\r
+name: vnf-startapplication\r
+description: Starts the VNF application, if needed, after a VM is instantiated/configured or after VM start or restart. Supported using Chef cookbook or Ansible playbook only\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:startapplication\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stop-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stop-schema.yaml

new file mode 100644 (file)

index 0000000..5acc6f3
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stop-schema.yaml
@@ -0,0 +1,162 @@
+open_cli_schema_version: 1.0\r
+name: vnf-stop\r
+description: Stop VNF\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:stop\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stopapplication-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stopapplication-schema.yaml

new file mode 100644 (file)

index 0000000..1b45062
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stopapplication-schema.yaml
@@ -0,0 +1,162 @@
+open_cli_schema_version: 1.0\r
+name: vnf-stopapplication\r
+description: Stops the VNF application gracefully if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only.\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:stopapplication\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-sync-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-sync-schema.yaml

new file mode 100644 (file)

index 0000000..96681bc
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-sync-schema.yaml
@@ -0,0 +1,162 @@
+open_cli_schema_version: 1.0\r
+name: vnf-sync\r
+description: The Sync action updates the current configuration in the APPC store with the running configuration from the device\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:sync\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-unlock-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-unlock-schema.yaml

new file mode 100644 (file)

index 0000000..63e03e9
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-unlock-schema.yaml
@@ -0,0 +1,162 @@
+open_cli_schema_version: 1.0\r
+name: vnf-unlock\r
+description: Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that VNF\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:unlock\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 100\r
+       - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackout-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackout-schema.yaml

new file mode 100644 (file)

index 0000000..026e6ad
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackout-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-upgradebackout\r
+description: The UpgradeBackout LCM action does a backout after an UpgradeSoftware is completed. This command is executed using an Ansible playbook or Chef cookbook.\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:upgrade-backout\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status":{"code": "${status}","message": "<RESULT_MESSAGE>"}}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackup-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackup-schema.yaml

new file mode 100644 (file)

index 0000000..9836c54
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackup-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-upgradebackup\r
+description: The UpgradeBackup LCM action does a full backup of the VNF data prior to an upgrade. The backup is done on the Ansible or Chef server in a location that is specified in the playbook or cookbook. If there is an existing backup, it is overwritten by the new backup.\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:upgrade-backup\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradepostcheck-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradepostcheck-schema.yaml

new file mode 100644 (file)

index 0000000..717a949
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradepostcheck-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-upgradepostcheck\r
+description: The UpgradePostCheck LCM action checks that the VNF upgrade has been successful completed and all processes are running properly.\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:upgrade-post-check\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradeprecheck-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradeprecheck-schema.yaml

new file mode 100644 (file)

index 0000000..5433a18
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradeprecheck-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-upgradeprecheck\r
+description: The UpgradePreCheck LCM action checks that the VNF has the correct software version needed for a software upgrade. This command can be executed on a running VNF.\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:upgrade-pre-check\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
diff --git a/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradesoftware-schema.yaml b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradesoftware-schema.yaml

new file mode 100644 (file)

index 0000000..dc46a56
--- /dev/null
+++ b/products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradesoftware-schema.yaml
@@ -0,0 +1,161 @@
+open_cli_schema_version: 1.0\r
+name: vnf-upgradesoftware\r
+description: The UpgradeSoftware LCM action upgrades the target VNF to a new version. It is expected that the VNF is in a quiesced status\r
+\r
+info:\r
+  product: onap-beijing\r
+  service: appc\r
+  author: ONAP CLI Team onap-discuss@lists.onap.org\r
+  state: experimental\r
+\r
+parameters:\r
+  - name: timestamp\r
+    description: The time of the request, in ISO 8601 format, ZULU offset \r
+    type: string\r
+    short_option: T\r
+    long_option: timestamp  \r
+    is_optional: false\r
+  - name: api-ver\r
+    description: Identifies the API version\r
+    type: string\r
+    short_option: X\r
+    long_option: api-ver   \r
+    is_optional: false\r
+  - name: originator-id\r
+    description: An identifier of the calling system limited to a length of 40 characters\r
+    type: string\r
+    short_option: O\r
+    long_option: originator-id    \r
+    is_optional: false\r
+  - name: request-id\r
+    description: The UUID for the request ID, limited to a length of 40 characters\r
+    type: string\r
+    short_option: R\r
+    long_option: request-id      \r
+    is_optional: false\r
+  - name: sub-request-id\r
+    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
+    type: string\r
+    short_option: W \r
+    long_option: sub-request-id      \r
+    is_optional: true\r
+  - name: flags-mode\r
+    description: Generic flags-mode that apply to all LCM actions\r
+    type: string\r
+    short_option: F\r
+    is_optional: true\r
+  - name: flags-force\r
+    description: Generic flags-force that apply to all LCM actions\r
+    type: bool\r
+    short_option: G\r
+    is_optional: true\r
+  - name: flags-ttl\r
+    description: Generic flags-ttl that apply to all LCM actions\r
+    type: string\r
+    short_option: H\r
+    is_optional: true\r
+  - name: action\r
+    description: The action to be taken by APPC\r
+    type: string\r
+    short_option: A\r
+    long_option: action  \r
+    is_optional: false \r
+  - name: service-instance-id \r
+    description: Identifies a specific service instance that the command refers to\r
+    type: string\r
+    short_option: S\r
+    long_option: service-instance-id      \r
+    is_optional: true  \r
+  - name: vnf-id\r
+    description: Identifies the VNF instance to which this action is to be applied\r
+    type: string\r
+    short_option: J\r
+    long_option: vnf-id      \r
+    is_optional: true      \r
+    is_optional: false         \r
+  - name: vnfc-name\r
+    description: Identifies the VNFC name to which this action is to be applied\r
+    type: string\r
+    short_option: N\r
+    long_option: vnfc-name  \r
+    is_optional: true                  \r
+  - name: vserver-id\r
+    description: Identifies a specific VM instance to which this action is to be applied\r
+    type: string\r
+    short_option: K\r
+    long_option: vserver-id\r
+    is_optional: true                  \r
+  - name: vf-module-id\r
+    description: Identifies a specific VF module to which this action is to be applied\r
+    type: string\r
+    short_option: M\r
+    long_option: vf-module-id \r
+    is_optional: true          \r
+  - name: payload\r
+    description: An action-specific open-format field\r
+    type: string\r
+    short_option: P\r
+    long_option: payload     \r
+    is_optional: true          \r
+results:\r
+  direction: portrait\r
+  attributes:\r
+    - name: action\r
+      description: The action to be taken by APPC\r
+      scope: short\r
+      type: string\r
+    - name: api-ver\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string\r
+    - name: flags\r
+      description: Identifies the API version\r
+      scope: short\r
+      type: string       \r
+    - name: timestamp\r
+      description: The time of the request, in ISO 8601 format, ZULU offset \r
+      scope: short\r
+      type: string\r
+    - name: status\r
+      description: The status describes the outcome of the command processing\r
+      scope: short\r
+      type: digit\r
+    - name: originator-id\r
+      description: An identifier of the calling system limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: request-id\r
+      description: The UUID for the request ID, limited to a length of 40 characters\r
+      scope: short\r
+      type: string\r
+    - name: sub-request-id\r
+      description: Uniquely identifies a specific LCM or control action\r
+      scope: long\r
+      type: string\r
+    - name: payload\r
+      description: An open-format field\r
+      scope: long\r
+      type: string\r
+http:\r
+  service:\r
+    auth: basic\r
+    mode: direct\r
+  request:\r
+    uri: /restconf/operations/vnf-provider-lcm:upgrade-software\r
+    method: POST\r
+    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
+  success_codes:\r
+    - 400\r
+  result_map:\r
+    action: $b{$.action}\r
+    api-ver: $b{$.api-ver}\r
+    flags: $b{$.flags}   \r
+    originator-id: $b{$.originator-id}\r
+    request-id: $b{$.request-id}\r
+    sub-request-id: $b{$.sub-request-id}\r
+    payload: $b{$.payload}\r
+    status: $b{$.status}\r
+    timestamp: $b{$.timestamp}\r
+\r
+  sample_response:\r
+    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'
+\ No newline at end of file
author	Toan Nguyen <tn2126@att.com>
	Fri, 4 May 2018 15:03:15 +0000 (11:03 -0400)
committer	Toan Nguyen <tn2126@att.com>
	Fri, 4 May 2018 15:03:15 +0000 (11:03 -0400)
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-actionstatus-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-attachhvolume-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-audit-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-checklock-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configure-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurebackup-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configuremodify-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurerestore-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurescaleout-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-detachvolume-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-evacuate-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-healthcheck-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-lock-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-migrate-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-quiescetraffic-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-rebuild-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-restart-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-resumetraffic-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-snapshot-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-start-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-startapplication-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stop-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stopapplication-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-sync-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-unlock-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackout-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackup-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradepostcheck-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradeprecheck-schema.yaml	[new file with mode: 0644]	patch \| blob
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradesoftware-schema.yaml	[new file with mode: 0644]	patch \| blob