diff options
author | 2018-05-04 11:03:15 -0400 | |
---|---|---|
committer | 2018-05-04 11:03:15 -0400 | |
commit | c7b441adb1931e3e3d0bac6da395e9b726800268 (patch) | |
tree | c8c25ad33986c3e98dc6c66f0ee978b923be726c /products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-actionstatus-schema.yaml | |
parent | 7c71103d22f5572aa90f75ee55f72384a208fe53 (diff) |
Appc CLI OCS
Issue-ID: CLI-78
Change-Id: I019826d64ee40646f820f44336f3524bcac1f21e
Signed-off-by: Toan Nguyen <tn2126@att.com>
Diffstat (limited to 'products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-actionstatus-schema.yaml')
-rw-r--r-- | products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-actionstatus-schema.yaml | 161 |
1 files changed, 161 insertions, 0 deletions
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 index 00000000..7b2ddc6b --- /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
+name: vnf-actionstatus
+description: The ActionStatus command returns that state of any action request that has been previously submitted to an APPC instance for a specified VNF
+
+info:
+ product: onap-beijing
+ service: appc
+ author: ONAP CLI Team onap-discuss@lists.onap.org
+ state: experimental
+
+parameters:
+ - name: timestamp
+ description: The time of the request, in ISO 8601 format, ZULU offset
+ type: string
+ short_option: T
+ long_option: timestamp
+ is_optional: false
+ - name: api-ver
+ description: Identifies the API version
+ type: string
+ short_option: X
+ long_option: api-ver
+ is_optional: false
+ - name: originator-id
+ description: An identifier of the calling system limited to a length of 40 characters
+ type: string
+ short_option: O
+ long_option: originator-id
+ is_optional: false
+ - name: request-id
+ description: The UUID for the request ID, limited to a length of 40 characters
+ type: string
+ short_option: R
+ long_option: request-id
+ is_optional: false
+ - name: sub-request-id
+ description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters
+ type: string
+ short_option: W
+ long_option: sub-request-id
+ is_optional: true
+ - name: flags-mode
+ description: Generic flags-mode that apply to all LCM actions
+ type: string
+ short_option: F
+ is_optional: true
+ - name: flags-force
+ description: Generic flags-force that apply to all LCM actions
+ type: bool
+ short_option: G
+ is_optional: true
+ - name: flags-ttl
+ description: Generic flags-ttl that apply to all LCM actions
+ type: string
+ short_option: H
+ is_optional: true
+ - name: action
+ description: The action to be taken by APPC
+ type: string
+ short_option: A
+ long_option: action
+ is_optional: false
+ - name: service-instance-id
+ description: Identifies a specific service instance that the command refers to
+ type: string
+ short_option: S
+ long_option: service-instance-id
+ is_optional: true
+ - name: vnf-id
+ description: Identifies the VNF instance to which this action is to be applied
+ type: string
+ short_option: J
+ long_option: vnf-id
+ is_optional: true
+ is_optional: false
+ - name: vnfc-name
+ description: Identifies the VNFC name to which this action is to be applied
+ type: string
+ short_option: N
+ long_option: vnfc-name
+ is_optional: true
+ - name: vserver-id
+ description: Identifies a specific VM instance to which this action is to be applied
+ type: string
+ short_option: K
+ long_option: vserver-id
+ is_optional: true
+ - name: vf-module-id
+ description: Identifies a specific VF module to which this action is to be applied
+ type: string
+ short_option: M
+ long_option: vf-module-id
+ is_optional: true
+ - name: payload
+ description: An action-specific open-format field
+ type: string
+ short_option: P
+ long_option: payload
+ is_optional: true
+results:
+ direction: portrait
+ attributes:
+ - name: action
+ description: The action to be taken by APPC
+ scope: short
+ type: string
+ - name: api-ver
+ description: Identifies the API version
+ scope: short
+ type: string
+ - name: flags
+ description: Identifies the API version
+ scope: short
+ type: string
+ - name: timestamp
+ description: The time of the request, in ISO 8601 format, ZULU offset
+ scope: short
+ type: string
+ - name: status
+ description: The status describes the outcome of the command processing
+ scope: short
+ type: digit
+ - name: originator-id
+ description: An identifier of the calling system limited to a length of 40 characters
+ scope: short
+ type: string
+ - name: request-id
+ description: The UUID for the request ID, limited to a length of 40 characters
+ scope: short
+ type: string
+ - name: sub-request-id
+ description: Uniquely identifies a specific LCM or control action
+ scope: long
+ type: string
+ - name: payload
+ description: An open-format field
+ scope: long
+ type: string
+http:
+ service:
+ auth: basic
+ mode: direct
+ request:
+ uri: /restconf/operations/vnf-provider-lcm:action-status
+ method: POST
+ 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}"}}'
+ success_codes:
+ - 400
+ result_map:
+ action: $b{$.action}
+ api-ver: $b{$.api-ver}
+ flags: $b{$.flags}
+ originator-id: $b{$.originator-id}
+ request-id: $b{$.request-id}
+ sub-request-id: $b{$.sub-request-id}
+ payload: $b{$.payload}
+ status: $b{$.status}
+ timestamp: $b{$.timestamp}
+
+ sample_response:
+ 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 |