| LCM API Abbre. | HTTP Method | URI | Yang Model Section | Request Example | Response Example |
|---|
| rollback | Post | /operations/LCM:rollback |
| Code Block |
|---|
| language | yml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| rpc rollback {
description "An operation to rollback to particular snapshot of a virtual network function (or VM)";
input {
uses common-header;
leaf action {
type action;
mandatory true;
}
uses action-identifiers;
leaf payload {
type payload;
mandatory false;
}
leaf identity-url {
type string;
mandatory false;
}
leaf snapshot-id {
type string;
mandatory false;
}
}
output {
uses common-header;
uses status;
leaf payload {
type payload;
mandatory false;
}
}
} |
|
| Code Block |
|---|
| language | xml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| {
"input": {
"action": "Rollback",
"action-identifiers": {
"vnf-id": "5gDU0001"
},
"common-header": {
"api-ver": "2.00",
"flags": {
"force": "FALSE",
"mode": "NORMAL",
"ttl": 65000
},
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"timestamp": "2019-03-15T09:07:58.255Z"
},
"payload": "{\"pnf-flag\":\"true\", \"pnf-name\": \"5gDU0001\",\"pnfId\": \"5gDU0001\", \"ipaddress-v4-oam\": \"192.168.35.83\", \"oldSwVersionfilter\": \"v1\", \"Id\": \"10\", \"additionalData\":\"{}\"}"\\\\'$..nE[?(@.nEIdentification == \\\\\\\"5gDU0001\\\\\\\")]\\\\'\"}"
}
}
|
| 400: Success | Code Block |
|---|
| language | xml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| {
"output": {
"common-header": {
"api-ver": "2.00",
"originator-id": "MSO",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
},
"status": {
"code": 400,
"message": "Ansible Request ae8c8773d5062dcd-b18137dd-43924b67-b3d288f2-f2322be60369b705123b4447 finished with Result = success, Message = FINISHED"
}
}
} |
|
| precheck* | /operations/LCM:upgrade-pre-check |
| Code Block |
|---|
| language | yml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| rpc upgrade-pre-check {
description "An operation to check that the VNF has the correct software version needed for a software upgrade.";
input {
uses common-header;
leaf action {
type action;
mandatory true;
}
uses action-identifiers;
leaf payload {
type payload;
mandatory true;
}
}
output {
uses common-header;
uses status;
leaf payload {
type payload;
mandatory true;
}
}
} |
|
| Code Block |
|---|
| language | xml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| {
"input": {
"action": "UpgradePreCheck",
"action-identifiers": {
"vnf-id": "5gDU0001"
},
"common-header": {
"api-ver": "2.00",
"flags": {
"force": "FALSE",
"mode": "NORMAL",
"ttl": 65000
},
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"timestamp": "2019-03-15T09:07:58.255Z"
},
"payload": "{\"pnf-flag\":\"true\", \"pnf-name\": \"5gDU0001\",\"pnfId\": \"5gDU0001\", \"ipaddress-v4-oam\": \"192.168.35.83\",\"oldSwVersion\": \"v1\", \"targetSwVersion\": \"v2\", \"ruleName\": \"r001\", \"Id\": \"10\", \"additionalData\":\"{}\"}"
}
}
|
| 400: Success | Code Block |
|---|
| language | xml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| {
"output": {
"common-header": {
"api-ver": "2.00",
"originator-id": "MSO",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
},
"status": {
"code": 400,
"message": "Ansible Request a001eff5-5a4b-436c-bc06-003b81fdf45b finished with Result = success, Message = FINISHED"
}
}
} |
|
| postcheck* | /operations/LCM:upgrade-post-check |
| Code Block |
|---|
| language | yml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| rpc upgrade-post-check {
description "An operation to check the VNF upgrade has been successful completed and all processes are running properly.";
input {
uses common-header;
leaf action {
type action;
mandatory true;
}
uses action-identifiers;
leaf payload {
type payload;
mandatory true;
}
}
output {
uses common-header;
uses status;
leaf payload {
type payload;
mandatory true;
}
}
} |
|
| Code Block |
|---|
| language | xml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| {
"input": {
"action": "UpgradePostCheck",
"action-identifiers": {
"vnf-id": "5gDU0001"
},
"common-header": {
"api-ver": "2.00",
"flags": {
"force": "FALSE",
"mode": "NORMAL",
"ttl": 65000
},
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"timestamp": "2019-02-23T09:07:58.255Z"
},
"payload": "{\"pnf-flag\":\"true\", \"pnf-name\": \"5gDU0001\",\"pnfId\": \"5gDU0001\", \"ipaddress-v4-oam\": \"192.168.35.83\",\"oldSwVersion\": \"v1\", \"targetSwVersion\": \"v2\", \"ruleName\": \"r102\", \"Id\": \"10\", \"additionalData\":\"{}\"}"}}
}
}
|
| 400: Success | Code Block |
|---|
| language | xml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| {
"output": {
"common-header": {
"api-ver": "2.00",
"originator-id": "MSO",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
},
"status": {
"code": 400,
"message": "Ansible Request 7efab284-518a-43b3-9ea4-8936583eb02e finished with Result = success, Message = FINISHED"
}
}
} |
|
| upgrade-software* | /operations/LCM:upgrade-software |
| Code Block |
|---|
| language | yml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| rpc upgrade-software {
description "An operation to upgrade the target VNF to a new version and expected that the VNF is in a quiesced status .";
input {
uses common-header;
leaf action {
type action;
mandatory true;
}
uses action-identifiers;
leaf payload {
type payload;
mandatory true;
}
}
output {
uses common-header;
uses status;
}
} |
|
| Code Block |
|---|
| language | xml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| {
"input": {
"action": "UpgradeSoftware",
"action-identifiers": {
"vnf-id": "5gDU0001"
},
"common-header": {
"api-ver": "2.00",
"flags": {
"force": "FALSE",
"mode": "NORMAL",
"ttl": 65000
},
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"timestamp": "2019-03-15T09:07:58.255Z"
},
"payload": "{\"pnf-flag\":\"true\", \"pnf-namepnfId\": \"5gDU0001\", \"pnfIdipaddress-v4-oam\": \"5gDU0001192.168.35.83\", \"ipaddress-v4-oamtargetSwVersion\": \"\\\\'[{\\\\\\\"swLocation\\\\\\\": \\\\\\\"http://192.168.35.144:10080/ran_du_pkg1-v100.zip\\\\\\\", \\\\\\\"swFileSize\\\\\\\": 10000000, \\\\\\\"swFileCompression\\\\\\\": \\\\\\"192.168.35.83\",\"oldSwVersion\": \"v1\"ZIP\\\\\\\", \\\\"targetSwVersion\\\"swFileFormat\\\\\\\": \"v2\\\\\\\", zip\"Id\": \"10\", \"additionalData\":\"{}]\\\\'\"}"}}
}
}
|
| 400: Success | Code Block |
|---|
| language | xml |
|---|
| theme | Emacs |
|---|
| collapse | true |
|---|
| {
"output": {
"common-header": {
"api-ver": "2.00",
"originator-id": "MSO",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
},
"status": {
"code": 400,
"message": "Ansible Request dcfd4c87-a0c6-4c35-b18b-7d863b29e18d finished with Result = success, Message = FINISHED"
}
}
} |
|