From ade24264e58b0f58cf954dc2956a2947fe443d0c Mon Sep 17 00:00:00 2001 From: Kanagaraj Manickam k00365106 Date: Mon, 7 May 2018 09:41:07 +0530 Subject: Stip off whitespace char Issue-ID: CLI-78 Change-Id: I31bb7a68d430e3e0ee20814d536411d317173dce Signed-off-by: Kanagaraj Manickam k00365106 --- .../open-cli-schema/appc-actionstatus-schema.yaml | 320 ++++++++++---------- .../open-cli-schema/appc-attachhvolume-schema.yaml | 322 ++++++++++---------- .../open-cli-schema/appc-audit-schema.yaml | 320 ++++++++++---------- .../open-cli-schema/appc-checklock-schema.yaml | 322 ++++++++++---------- .../open-cli-schema/appc-configure-schema.yaml | 320 ++++++++++---------- .../appc-configurebackup-schema.yaml | 320 ++++++++++---------- .../appc-configuremodify-schema.yaml | 320 ++++++++++---------- .../appc-configurerestore-schema.yaml | 320 ++++++++++---------- .../appc-configurescaleout-schema.yaml | 320 ++++++++++---------- .../open-cli-schema/appc-detachvolume-schema.yaml | 320 ++++++++++---------- .../open-cli-schema/appc-evacuate-schema.yaml | 322 ++++++++++---------- .../open-cli-schema/appc-healthcheck-schema.yaml | 320 ++++++++++---------- .../open-cli-schema/appc-lock-schema.yaml | 320 ++++++++++---------- .../open-cli-schema/appc-migrate-schema.yaml | 322 ++++++++++---------- .../appc-quiescetraffic-schema.yaml | 320 ++++++++++---------- .../open-cli-schema/appc-rebuild-schema.yaml | 322 ++++++++++---------- .../open-cli-schema/appc-restart-schema.yaml | 324 ++++++++++----------- .../open-cli-schema/appc-resumetraffic-schema.yaml | 320 ++++++++++---------- .../open-cli-schema/appc-snapshot-schema.yaml | 320 ++++++++++---------- .../open-cli-schema/appc-start-schema.yaml | 320 ++++++++++---------- .../appc-startapplication-schema.yaml | 322 ++++++++++---------- .../open-cli-schema/appc-stop-schema.yaml | 322 ++++++++++---------- .../appc-stopapplication-schema.yaml | 322 ++++++++++---------- .../open-cli-schema/appc-sync-schema.yaml | 322 ++++++++++---------- .../open-cli-schema/appc-unlock-schema.yaml | 322 ++++++++++---------- .../appc-upgradebackout-schema.yaml | 320 ++++++++++---------- .../open-cli-schema/appc-upgradebackup-schema.yaml | 320 ++++++++++---------- .../appc-upgradepostcheck-schema.yaml | 320 ++++++++++---------- .../appc-upgradeprecheck-schema.yaml | 320 ++++++++++---------- .../appc-upgradesoftware-schema.yaml | 320 ++++++++++---------- 30 files changed, 4812 insertions(+), 4812 deletions(-) (limited to 'products/onap-beijing') 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 index 7b2ddc6b..def1e514 100644 --- 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 @@ -1,161 +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: +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 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 index 587b4538..d6d2502c 100644 --- 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 @@ -1,162 +1,162 @@ -open_cli_schema_version: 1.0 -name: vnf-attachvolume -description: Attach a cinder volume from a VM via an Openstack command - -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:attach-volume - 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: - - 100 - - 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: +open_cli_schema_version: 1.0 +name: vnf-attachvolume +description: Attach a cinder volume from a VM via an Openstack command + +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:attach-volume + 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: + - 100 + - 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 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 index fdf2c1df..2ec23586 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-audit -description: Audit 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:audit - 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: +open_cli_schema_version: 1.0 +name: vnf-audit +description: Audit 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:audit + 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 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 index ba7283e2..113ff67e 100644 --- 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 @@ -1,162 +1,162 @@ -open_cli_schema_version: 1.0 -name: vnf-checklock -description: The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned - -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:check-lock - 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: - - 100 - - 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: +open_cli_schema_version: 1.0 +name: vnf-checklock +description: The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned + +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:check-lock + 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: + - 100 + - 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 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 index a7ffc8b6..8cd19769 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-configure -description: Configure a VNF or a VNFC on the VNF after instantiation - -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:configure - 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: +open_cli_schema_version: 1.0 +name: vnf-configure +description: Configure a VNF or a VNFC on the VNF after instantiation + +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:configure + 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 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 index b2a3f764..ff176c5e 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-configurebackup -description: Backup the current VNF configuration on a local file system - not in APPC. This is limited to Ansible and Chef. - -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:configure-backup - 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: +open_cli_schema_version: 1.0 +name: vnf-configurebackup +description: Backup the current VNF configuration on a local file system - not in APPC. This is limited to Ansible and Chef. + +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:configure-backup + 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 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 index b6aec122..52c3ff1e 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-configuremodify -description: Modifies the configuration on a VNF or VNFC in service. - -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:configure-modify - 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: +open_cli_schema_version: 1.0 +name: vnf-configuremodify +description: Modifies the configuration on a VNF or VNFC in service. + +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:configure-modify + 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 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 index 6f8d5215..d67a8ef8 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-configurerestore -description: Applies a previously saved configuration to the active VNF configuration. This is limited to Ansible and Chef - -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:configure-restore - 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: +open_cli_schema_version: 1.0 +name: vnf-configurerestore +description: Applies a previously saved configuration to the active VNF configuration. This is limited to Ansible and Chef + +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:configure-restore + 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 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 index d202633e..6deaf5ab 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-configurerescaleout -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. - -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:configure-scale-out - 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: +open_cli_schema_version: 1.0 +name: vnf-configurerescaleout +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. + +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:configure-scale-out + 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 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 index a035550b..da16f1a0 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-detachvolume -description: Detaches a cinder volume from a VM via an Openstack command - -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:detach-volume - 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: +open_cli_schema_version: 1.0 +name: vnf-detachvolume +description: Detaches a cinder volume from a VM via an Openstack command + +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:detach-volume + 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 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 index fb506737..8b8f6cdb 100644 --- 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 @@ -1,162 +1,162 @@ -open_cli_schema_version: 1.0 -name: vnf-evacuate -description: Evacuates a specified VM from its current host to another - -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:evacuate - 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: - - 100 - - 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: +open_cli_schema_version: 1.0 +name: vnf-evacuate +description: Evacuates a specified VM from its current host to another + +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:evacuate + 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: + - 100 + - 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 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 index 254b21bf..cd0270ff 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-healthcheck -description: runs a VNF health check and returns the result - -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:health-check - 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: - - 200 - 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: +open_cli_schema_version: 1.0 +name: vnf-healthcheck +description: runs a VNF health check and returns the result + +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:health-check + 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: + - 200 + 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 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 index c4ff2138..67479b97 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-lock -description: Use the Lock command to ensure exclusive access during a series of critical LCM commands - -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:lock - 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: +open_cli_schema_version: 1.0 +name: vnf-lock +description: Use the Lock command to ensure exclusive access during a series of critical LCM commands + +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:lock + 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 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 index ea550b20..2e74b8d2 100644 --- 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 @@ -1,162 +1,162 @@ -open_cli_schema_version: 1.0 -name: vnf-migrate -description: Migrates a running target VM from its current host to another. - -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:migrate - 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: - - 100 - - 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: +open_cli_schema_version: 1.0 +name: vnf-migrate +description: Migrates a running target VM from its current host to another. + +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:migrate + 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: + - 100 + - 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 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 index c658ffe4..885ea6d9 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-quiescetraffic -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. - -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:quiesce-traffic - 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: +open_cli_schema_version: 1.0 +name: vnf-quiescetraffic +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. + +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:quiesce-traffic + 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 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 index dc03207b..519229fe 100644 --- 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 @@ -1,162 +1,162 @@ -open_cli_schema_version: 1.0 -name: vnf-rebuild -description: Rebuild 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:rebuild - 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: - - 100 - - 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: +open_cli_schema_version: 1.0 +name: vnf-rebuild +description: Rebuild 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:rebuild + 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: + - 100 + - 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 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 index 2ac95414..1a1a3f4d 100644 --- 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 @@ -1,163 +1,163 @@ -open_cli_schema_version: 1.0 -name: vnf-restart -description: Restart 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:restart - 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: - - 100 - - 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: +open_cli_schema_version: 1.0 +name: vnf-restart +description: Restart 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:restart + 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: + - 100 + - 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 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 index 158821d6..935c28f6 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-resumetraffic -description: The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced. - -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:resume-traffic - 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: +open_cli_schema_version: 1.0 +name: vnf-resumetraffic +description: The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced. + +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:resume-traffic + 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 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 index 6e4367e2..29951e13 100644 --- 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 @@ -1,160 +1,160 @@ -open_cli_schema_version: 1.0 -name: vnf-snapshot -description: reates a snapshot of a VM - -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: v - 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: s - long_option: sub-request-id - is_optional: true - - name: flags-mode - description: Generic flags that apply to all LCM actions - type: string - short_option: r - long_option: flags-mode - is_optional: true - - name: flags-force - description: Generic flags that apply to all LCM actions - type: bool - short_option: f - long_option: flags-force - is_optional: true - - name: flags-ttl - description: Generic flags that apply to all LCM actions - type: digit - short_option: l - long_option: flags-ttl - 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: i - 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: q - 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: timpestamp - description: The time of the request, in ISO 8601 format, ZULU offset - scope: short - type: timpestamp - - 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:snapshot - method: POST - 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}"}' - success_codes: - - 100 - - 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} - - 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}"}}' +open_cli_schema_version: 1.0 +name: vnf-snapshot +description: reates a snapshot of a VM + +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: v + 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: s + long_option: sub-request-id + is_optional: true + - name: flags-mode + description: Generic flags that apply to all LCM actions + type: string + short_option: r + long_option: flags-mode + is_optional: true + - name: flags-force + description: Generic flags that apply to all LCM actions + type: bool + short_option: f + long_option: flags-force + is_optional: true + - name: flags-ttl + description: Generic flags that apply to all LCM actions + type: digit + short_option: l + long_option: flags-ttl + 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: i + 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: q + 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: timpestamp + description: The time of the request, in ISO 8601 format, ZULU offset + scope: short + type: timpestamp + - 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:snapshot + method: POST + 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}"}' + success_codes: + - 100 + - 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} + + 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}"}}' 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 index e2b6511f..25c593eb 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-start -description: Start 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:start - 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: - - 100 - 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: +open_cli_schema_version: 1.0 +name: vnf-start +description: Start 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:start + 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: + - 100 + 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 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 index 447a2529..6d28ba79 100644 --- 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 @@ -1,162 +1,162 @@ -open_cli_schema_version: 1.0 -name: vnf-startapplication -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 - -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:startapplication - 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: - - 100 - - 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: +open_cli_schema_version: 1.0 +name: vnf-startapplication +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 + +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:startapplication + 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: + - 100 + - 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 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 index 5acc6f33..e5b06458 100644 --- 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 @@ -1,162 +1,162 @@ -open_cli_schema_version: 1.0 -name: vnf-stop -description: Stop 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:stop - 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: - - 100 - - 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: +open_cli_schema_version: 1.0 +name: vnf-stop +description: Stop 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:stop + 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: + - 100 + - 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 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 index 1b45062e..9d148428 100644 --- 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 @@ -1,162 +1,162 @@ -open_cli_schema_version: 1.0 -name: vnf-stopapplication -description: Stops the VNF application gracefully if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only. - -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:stopapplication - 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: - - 100 - - 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: +open_cli_schema_version: 1.0 +name: vnf-stopapplication +description: Stops the VNF application gracefully if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only. + +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:stopapplication + 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: + - 100 + - 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 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 index 96681bc7..58bdd352 100644 --- 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 @@ -1,162 +1,162 @@ -open_cli_schema_version: 1.0 -name: vnf-sync -description: The Sync action updates the current configuration in the APPC store with the running configuration from the device - -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:sync - 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: - - 100 - - 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: +open_cli_schema_version: 1.0 +name: vnf-sync +description: The Sync action updates the current configuration in the APPC store with the running configuration from the device + +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:sync + 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: + - 100 + - 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 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 index 63e03e98..026da14c 100644 --- 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 @@ -1,162 +1,162 @@ -open_cli_schema_version: 1.0 -name: vnf-unlock -description: Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that 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:unlock - 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: - - 100 - - 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: +open_cli_schema_version: 1.0 +name: vnf-unlock +description: Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that 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:unlock + 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: + - 100 + - 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 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 index 026e6ad4..a1c03792 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-upgradebackout -description: The UpgradeBackout LCM action does a backout after an UpgradeSoftware is completed. This command is executed using an Ansible playbook or Chef cookbook. - -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:upgrade-backout - 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: +open_cli_schema_version: 1.0 +name: vnf-upgradebackout +description: The UpgradeBackout LCM action does a backout after an UpgradeSoftware is completed. This command is executed using an Ansible playbook or Chef cookbook. + +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:upgrade-backout + 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}"}}' 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": ""}}}' \ 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 index 9836c544..067ae16b 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-upgradebackup -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. - -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:upgrade-backup - 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: +open_cli_schema_version: 1.0 +name: vnf-upgradebackup +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. + +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:upgrade-backup + 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 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 index 717a949f..a8ebb93f 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-upgradepostcheck -description: The UpgradePostCheck LCM action checks that the VNF upgrade has been successful completed and all processes are running properly. - -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:upgrade-post-check - 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: +open_cli_schema_version: 1.0 +name: vnf-upgradepostcheck +description: The UpgradePostCheck LCM action checks that the VNF upgrade has been successful completed and all processes are running properly. + +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:upgrade-post-check + 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 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 index 5433a189..e1b5b902 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-upgradeprecheck -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. - -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:upgrade-pre-check - 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: +open_cli_schema_version: 1.0 +name: vnf-upgradeprecheck +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. + +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:upgrade-pre-check + 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 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 index dc46a560..cb63c993 100644 --- 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 @@ -1,161 +1,161 @@ -open_cli_schema_version: 1.0 -name: vnf-upgradesoftware -description: The UpgradeSoftware LCM action upgrades the target VNF to a new version. It is expected that the VNF is in a quiesced status - -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:upgrade-software - 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: +open_cli_schema_version: 1.0 +name: vnf-upgradesoftware +description: The UpgradeSoftware LCM action upgrades the target VNF to a new version. It is expected that the VNF is in a quiesced status + +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:upgrade-software + 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 -- cgit 1.2.3-korg