Stip off whitespace char 45/46345/1
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Mon, 7 May 2018 04:11:07 +0000 (09:41 +0530)
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Mon, 7 May 2018 04:11:07 +0000 (09:41 +0530)
Issue-ID: CLI-78

Change-Id: I31bb7a68d430e3e0ee20814d536411d317173dce
Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
30 files changed:
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-actionstatus-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-attachhvolume-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-audit-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-checklock-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configure-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurebackup-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configuremodify-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurerestore-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-configurescaleout-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-detachvolume-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-evacuate-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-healthcheck-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-lock-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-migrate-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-quiescetraffic-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-rebuild-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-restart-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-resumetraffic-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-snapshot-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-start-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-startapplication-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stop-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-stopapplication-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-sync-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-unlock-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackout-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradebackup-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradepostcheck-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradeprecheck-schema.yaml
products/onap-beijing/features/appc/src/main/resources/open-cli-schema/appc-upgradesoftware-schema.yaml

index 7b2ddc6..def1e51 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-actionstatus\r
-description: The ActionStatus command returns that state of any action request that has been previously submitted to an APPC instance for a specified VNF \r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:action-status\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 587b453..d6d2502 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-attachvolume\r
-description: Attach a cinder volume from a VM via an Openstack command\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:attach-volume\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index fdf2c1d..2ec2358 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-audit\r
-description: Audit VNF\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:audit\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index ba7283e..113ff67 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-checklock\r
-description: The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:check-lock\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index a7ffc8b..8cd1976 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-configure\r
-description: Configure a VNF or a VNFC on the VNF after instantiation\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:configure\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index b2a3f76..ff176c5 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-configurebackup\r
-description: Backup the current VNF configuration on a local file system - not in APPC. This is limited to Ansible and Chef.\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:configure-backup\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index b6aec12..52c3ff1 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-configuremodify\r
-description: Modifies the configuration on a VNF or VNFC in service.\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:configure-modify\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 6f8d521..d67a8ef 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-configurerestore\r
-description: Applies a previously saved configuration to the active VNF configuration.  This is limited to Ansible and Chef\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:configure-restore\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index d202633..6deaf5a 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-configurerescaleout\r
-description: The ConfigScaleOut command is used to apply any actions on a VNF as part of a ScaleOut flow. Actions could include updating the VNF configuration or running a set of other tasks.\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:configure-scale-out\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index a035550..da16f1a 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-detachvolume\r
-description: Detaches a cinder volume from a VM via an Openstack command\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:detach-volume\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index fb50673..8b8f6cd 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-evacuate\r
-description: Evacuates a specified VM from its current host to another\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:evacuate\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 254b21b..cd0270f 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-healthcheck\r
-description: runs a VNF health check and returns the result\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:health-check\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 200\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index c4ff213..67479b9 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-lock\r
-description: Use the Lock command to ensure exclusive access during a series of critical LCM commands\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:lock\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index ea550b2..2e74b8d 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-migrate\r
-description: Migrates a running target VM from its current host to another.\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:migrate\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index c658ffe..885ea6d 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-quiescetraffic \r
-description: The QuiesceTraffic LCM action gracefully stops the traffic on the VNF. All application processes are assumed to be running but no traffic is being processed.\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:quiesce-traffic\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index dc03207..519229f 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-rebuild\r
-description: Rebuild VNF\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:rebuild\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 2ac9541..1a1a3f4 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-restart\r
-description: Restart VNF\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:restart\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-\r
-  sample_response:\r
+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
index 158821d..935c28f 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-resumetraffic \r
-description: The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced.\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:resume-traffic\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 6e4367e..29951e1 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-snapshot\r
-description: reates a snapshot of a VM\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: t\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: v\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: o\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: r\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: s \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags that apply to all LCM actions\r
-    type: string\r
-    short_option: r\r
-    long_option: flags-mode     \r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags that apply to all LCM actions\r
-    type: bool\r
-    short_option: f\r
-    long_option: flags-force     \r
-    is_optional: true  \r
-  - name: flags-ttl\r
-    description: Generic flags that apply to all LCM actions\r
-    type: digit\r
-    short_option: l\r
-    long_option: flags-ttl     \r
-    is_optional: true  \r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: a\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: i\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: j\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: n\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: k\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: q\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: p\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: timpestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: timpestamp\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:snapshot\r
-    method: POST\r
-    body: '{"input": {"common-header":{"timestamp": "${timestamp}","api-ver": "${api-version}","originator-id": "${orininator-id}","request-id": "$(request-id}","sub-request-id": "${sub-request-id}","flags":{"mode": "${flags-mode}","force": "${flags-force}","ttl": ${flags-ttl}"}}, "action": "${action}","action-identifiers": {"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-\r
-  sample_response:\r
-    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'\r
+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}"}}'
index e2b6511..25c593e 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-start\r
-description: Start VNF\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:start\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 447a252..6d28ba7 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-startapplication\r
-description: Starts the VNF application, if needed, after a VM is instantiated/configured or after VM start or restart. Supported using Chef cookbook or Ansible playbook only\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:startapplication\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 5acc6f3..e5b0645 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-stop\r
-description: Stop VNF\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:stop\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 1b45062..9d14842 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-stopapplication\r
-description: Stops the VNF application gracefully if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only.\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:stopapplication\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 96681bc..58bdd35 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-sync\r
-description: The Sync action updates the current configuration in the APPC store with the running configuration from the device\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:sync\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 63e03e9..026da14 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-unlock\r
-description: Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that VNF\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:unlock\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 100\r
-       - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 026e6ad..a1c0379 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-upgradebackout\r
-description: The UpgradeBackout LCM action does a backout after an UpgradeSoftware is completed. This command is executed using an Ansible playbook or Chef cookbook.\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:upgrade-backout\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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": "<RESULT_MESSAGE>"}}}'
\ No newline at end of file
index 9836c54..067ae16 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-upgradebackup\r
-description: The UpgradeBackup LCM action does a full backup of the VNF data prior to an upgrade. The backup is done on the Ansible or Chef server in a location that is specified in the playbook or cookbook. If there is an existing backup, it is overwritten by the new backup.\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:upgrade-backup\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 717a949..a8ebb93 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-upgradepostcheck\r
-description: The UpgradePostCheck LCM action checks that the VNF upgrade has been successful completed and all processes are running properly.\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:upgrade-post-check\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index 5433a18..e1b5b90 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-upgradeprecheck\r
-description: The UpgradePreCheck LCM action checks that the VNF has the correct software version needed for a software upgrade. This command can be executed on a running VNF.\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:upgrade-pre-check\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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
index dc46a56..cb63c99 100644 (file)
-open_cli_schema_version: 1.0\r
-name: vnf-upgradesoftware\r
-description: The UpgradeSoftware LCM action upgrades the target VNF to a new version. It is expected that the VNF is in a quiesced status\r
-\r
-info:\r
-  product: onap-beijing\r
-  service: appc\r
-  author: ONAP CLI Team onap-discuss@lists.onap.org\r
-  state: experimental\r
-\r
-parameters:\r
-  - name: timestamp\r
-    description: The time of the request, in ISO 8601 format, ZULU offset \r
-    type: string\r
-    short_option: T\r
-    long_option: timestamp  \r
-    is_optional: false\r
-  - name: api-ver\r
-    description: Identifies the API version\r
-    type: string\r
-    short_option: X\r
-    long_option: api-ver   \r
-    is_optional: false\r
-  - name: originator-id\r
-    description: An identifier of the calling system limited to a length of 40 characters\r
-    type: string\r
-    short_option: O\r
-    long_option: originator-id    \r
-    is_optional: false\r
-  - name: request-id\r
-    description: The UUID for the request ID, limited to a length of 40 characters\r
-    type: string\r
-    short_option: R\r
-    long_option: request-id      \r
-    is_optional: false\r
-  - name: sub-request-id\r
-    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters\r
-    type: string\r
-    short_option: W \r
-    long_option: sub-request-id      \r
-    is_optional: true\r
-  - name: flags-mode\r
-    description: Generic flags-mode that apply to all LCM actions\r
-    type: string\r
-    short_option: F\r
-    is_optional: true\r
-  - name: flags-force\r
-    description: Generic flags-force that apply to all LCM actions\r
-    type: bool\r
-    short_option: G\r
-    is_optional: true\r
-  - name: flags-ttl\r
-    description: Generic flags-ttl that apply to all LCM actions\r
-    type: string\r
-    short_option: H\r
-    is_optional: true\r
-  - name: action\r
-    description: The action to be taken by APPC\r
-    type: string\r
-    short_option: A\r
-    long_option: action  \r
-    is_optional: false \r
-  - name: service-instance-id \r
-    description: Identifies a specific service instance that the command refers to\r
-    type: string\r
-    short_option: S\r
-    long_option: service-instance-id      \r
-    is_optional: true  \r
-  - name: vnf-id\r
-    description: Identifies the VNF instance to which this action is to be applied\r
-    type: string\r
-    short_option: J\r
-    long_option: vnf-id      \r
-    is_optional: true      \r
-    is_optional: false         \r
-  - name: vnfc-name\r
-    description: Identifies the VNFC name to which this action is to be applied\r
-    type: string\r
-    short_option: N\r
-    long_option: vnfc-name  \r
-    is_optional: true                  \r
-  - name: vserver-id\r
-    description: Identifies a specific VM instance to which this action is to be applied\r
-    type: string\r
-    short_option: K\r
-    long_option: vserver-id\r
-    is_optional: true                  \r
-  - name: vf-module-id\r
-    description: Identifies a specific VF module to which this action is to be applied\r
-    type: string\r
-    short_option: M\r
-    long_option: vf-module-id \r
-    is_optional: true          \r
-  - name: payload\r
-    description: An action-specific open-format field\r
-    type: string\r
-    short_option: P\r
-    long_option: payload     \r
-    is_optional: true          \r
-results:\r
-  direction: portrait\r
-  attributes:\r
-    - name: action\r
-      description: The action to be taken by APPC\r
-      scope: short\r
-      type: string\r
-    - name: api-ver\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string\r
-    - name: flags\r
-      description: Identifies the API version\r
-      scope: short\r
-      type: string       \r
-    - name: timestamp\r
-      description: The time of the request, in ISO 8601 format, ZULU offset \r
-      scope: short\r
-      type: string\r
-    - name: status\r
-      description: The status describes the outcome of the command processing\r
-      scope: short\r
-      type: digit\r
-    - name: originator-id\r
-      description: An identifier of the calling system limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: request-id\r
-      description: The UUID for the request ID, limited to a length of 40 characters\r
-      scope: short\r
-      type: string\r
-    - name: sub-request-id\r
-      description: Uniquely identifies a specific LCM or control action\r
-      scope: long\r
-      type: string\r
-    - name: payload\r
-      description: An open-format field\r
-      scope: long\r
-      type: string\r
-http:\r
-  service:\r
-    auth: basic\r
-    mode: direct\r
-  request:\r
-    uri: /restconf/operations/vnf-provider-lcm:upgrade-software\r
-    method: POST\r
-    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'\r
-  success_codes:\r
-    - 400\r
-  result_map:\r
-    action: $b{$.action}\r
-    api-ver: $b{$.api-ver}\r
-    flags: $b{$.flags}   \r
-    originator-id: $b{$.originator-id}\r
-    request-id: $b{$.request-id}\r
-    sub-request-id: $b{$.sub-request-id}\r
-    payload: $b{$.payload}\r
-    status: $b{$.status}\r
-    timestamp: $b{$.timestamp}\r
-\r
-  sample_response:\r
+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