gerrit.onap Code Review - cli.git/blob

   1 open_cli_schema_version: 1.0
   2 name: vnf-upgradesoftware
   3 description: The UpgradeSoftware LCM action upgrades the target VNF to a new version. It is expected that the VNF is in a quiesced status
   4
   5 info:
   6   product: onap-beijing
   7   service: appc
   8   author: ONAP CLI Team onap-discuss@lists.onap.org
   9   state: experimental
  10
  11 parameters:
  12   - name: timestamp
  13     description: The time of the request, in ISO 8601 format, ZULU offset
  14     type: string
  15     short_option: T
  16     long_option: timestamp
  17     is_optional: false
  18   - name: api-ver
  19     description: Identifies the API version
  20     type: string
  21     short_option: X
  22     long_option: api-ver
  23     is_optional: false
  24   - name: originator-id
  25     description: An identifier of the calling system limited to a length of 40 characters
  26     type: string
  27     short_option: O
  28     long_option: originator-id
  29     is_optional: false
  30   - name: request-id
  31     description: The UUID for the request ID, limited to a length of 40 characters
  32     type: string
  33     short_option: R
  34     long_option: request-id
  35     is_optional: false
  36   - name: sub-request-id
  37     description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters
  38     type: string
  39     short_option: W
  40     long_option: sub-request-id
  41     is_optional: true
  42   - name: flags-mode
  43     description: Generic flags-mode that apply to all LCM actions
  44     type: string
  45     short_option: F
  46     is_optional: true
  47   - name: flags-force
  48     description: Generic flags-force that apply to all LCM actions
  49     type: bool
  50     short_option: G
  51     is_optional: true
  52   - name: flags-ttl
  53     description: Generic flags-ttl that apply to all LCM actions
  54     type: string
  55     short_option: H
  56     is_optional: true
  57   - name: action
  58     description: The action to be taken by APPC
  59     type: string
  60     short_option: A
  61     long_option: action
  62     is_optional: false
  63   - name: service-instance-id
  64     description: Identifies a specific service instance that the command refers to
  65     type: string
  66     short_option: S
  67     long_option: service-instance-id
  68     is_optional: true
  69   - name: vnf-id
  70     description: Identifies the VNF instance to which this action is to be applied
  71     type: string
  72     short_option: J
  73     long_option: vnf-id
  74     is_optional: true
  75     is_optional: false
  76   - name: vnfc-name
  77     description: Identifies the VNFC name to which this action is to be applied
  78     type: string
  79     short_option: N
  80     long_option: vnfc-name
  81     is_optional: true
  82   - name: vserver-id
  83     description: Identifies a specific VM instance to which this action is to be applied
  84     type: string
  85     short_option: K
  86     long_option: vserver-id
  87     is_optional: true
  88   - name: vf-module-id
  89     description: Identifies a specific VF module to which this action is to be applied
  90     type: string
  91     short_option: M
  92     long_option: vf-module-id
  93     is_optional: true
  94   - name: payload
  95     description: An action-specific open-format field
  96     type: string
  97     short_option: P
  98     long_option: payload
  99     is_optional: true
 100 results:
 101   direction: portrait
 102   attributes:
 103     - name: action
 104       description: The action to be taken by APPC
 105       scope: short
 106       type: string
 107     - name: api-ver
 108       description: Identifies the API version
 109       scope: short
 110       type: string
 111     - name: flags
 112       description: Identifies the API version
 113       scope: short
 114       type: string
 115     - name: timestamp
 116       description: The time of the request, in ISO 8601 format, ZULU offset
 117       scope: short
 118       type: string
 119     - name: status
 120       description: The status describes the outcome of the command processing
 121       scope: short
 122       type: digit
 123     - name: originator-id
 124       description: An identifier of the calling system limited to a length of 40 characters
 125       scope: short
 126       type: string
 127     - name: request-id
 128       description: The UUID for the request ID, limited to a length of 40 characters
 129       scope: short
 130       type: string
 131     - name: sub-request-id
 132       description: Uniquely identifies a specific LCM or control action
 133       scope: long
 134       type: string
 135     - name: payload
 136       description: An open-format field
 137       scope: long
 138       type: string
 139 http:
 140   service:
 141     auth: basic
 142     mode: direct
 143   request:
 144     uri: /restconf/operations/vnf-provider-lcm:upgrade-software
 145     method: POST
 146     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}"}}'
 147   success_codes:
 148     - 400
 149   result_map:
 150     action: $b{$.action}
 151     api-ver: $b{$.api-ver}
 152     flags: $b{$.flags}
 153     originator-id: $b{$.originator-id}
 154     request-id: $b{$.request-id}
 155     sub-request-id: $b{$.sub-request-id}
 156     payload: $b{$.payload}
 157     status: $b{$.status}
 158     timestamp: $b{$.timestamp}
 159
 160   sample_response:
 161     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}"}}'