gerrit.onap Code Review - cli.git/blob

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