Page History

...

{input": { "common-header": { "timestamp": "2018-10-10T09:40:04.244Z", "api-ver": "2.00", "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced203", "request-id":"664be3d2-6c12-4f4b-a3e7-c349acced203", "sub-request-id": "4", "flags": { "force":"TRUE","ttl":60000} }, "action": "rollback", "action-identifiers": { "vnf-id":"5gDU0001" },"payload": "{\"pnf-flag\":\"true\", \"pnf-name\": \"5gDU0001\",\"pnfId\": \"5gDU0001\", \"ipaddress-v4-oam\": \"139.159.228.37\",\"oldSwVersion\": \"v1\", \"additionalData\":\"{}\"}"}}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{ usescommon-header; status mandatorytrue; }}

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

Code Block

language	xml
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\",\"oldSwVersion\": \"v1\", \"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  ae8c8773-b181-4392-b3d2-f2322be60369 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

Code Block

language	xml
theme	Emacs
collapse	true

precheck*

/operations/LCM:upgrade-pre-check

Code Block

language	yml
theme	Emacs
collapse	true

;
        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":
{
   
"common-header": {
     
"timestamp": "2018-10-10T09:40:04.244Z"action": "UpgradeSoftware",
    
"apiaction-veridentifiers": "2.00",

"originator{
      "vnf-id": "664be3d2-6c12-4f4b-a3e7-c349acced203",

"request-id":"664be3d2-6c12-4f4b-a3e7-c349acced203",


5gDU0001"
    },
    "common-header": {
      
"subapi-request-idver": "12.00",


      
"flags": {


                   
"force" : "TRUEFALSE",


           "mode": "NORMAL",
        
"ttl" : 60000

65000
      
}
,

       
},


"originator-id": "MSO",
      
"actionrequest-id": "UpgradePreChecka1171d12-2ae9-496b-a2df-99784572914d",


      
"actionsub-request-identifiersid": {

"a1171d12-2ae9-496b-a2df-99784572914d",
      "timestamp": 
"vnf-id":"5gDU0001"


 2019-03-15T09:07:58.255Z"
    
},


     
"payload": "{\"pnf-flag\":\"true\",
 \"pnf-name\": \"5gDU0001\",\"pnfId\":
 \"5gDU0001\", \"ipaddress-v4-oam\":
 \"139192.159168.22835.3783\",\"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":
"664be3d2-6c12-4f4b-a3e7-c349acced203 "MSO",
      "sub-request-id": "1a1171d12-2ae9-496b-a2df-99784572914d",
      "request-id": "664be3d2a1171d12-6c122ae9-4f4b496b-a3e7a2df-c349acced20399784572914d"
    
},
    
"status": {
      
"code": 400,
      
"message": "Ansible Request  
8200a38fdcfd4c87-03d3a0c6-43ac4c35-935eb18b-2c43c94348727d863b29e18d finished with Result = success,
 Message = FINISHED"


    
}


  }


}

postcheck*

/operations/LCM:upgrade-post-check

upgrade-software*

/operations/LCM:upgrade-software

*: These lcm APIs inherit from R3.

...

Space shortcuts

Page tree

Versions Compared

Old Version 28

New Version 29

Key