Page Comparison

...

rpc upgrade-pre-check {description"Anoperationtocheckthat the VNF has the correct software version needed for a software upgrade.";input{ uses common-header;

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\", \"ipaddress-v4-oam\": \"192.168.35.83\", \"filter\": \"\\\\'$..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",
            "sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
    },    },
"status": {       "codepayload": 400,
      "message"{\"nEList\": [{\"nEIdentification\": \"Ansible Request  d5062dcd-37dd-4b67-88f2-b705123b4447 finished with Result = success, Message = FINISHED"5gDU0001\", \"swFallbackStatus\": \"fallbackSuccessful\"}], \"result\": \"Success\"}",
        "status": {
        }   }
}

precheck*

/operations/LCM:upgrade-pre-check

Code Block

language	yml
theme	Emacs
collapse	true

 "code": 400,

"message": "Ansible Request  2e0690ed-6b7a-43b1-a061-8e4ac7534609 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 leafto actioncheck {that the VNF has the correct software version needed for a software upgrade.";
type action;   input {
        mandatoryuses truecommon-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",
            "sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
        },
        "payload": "{\"result\": \"Success\"}",
        "status": {
            "code": 400,
            "message": "Ansible Request  a001eff5f0f45105-5a4b1a51-436c4592-bc06a31b-003b81fdf45bf178d5eb4638 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",
            "sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
    },    },
"status": {       "codepayload": "{\"result\": 400\"Success\"}",
        "messagestatus": "Ansible{
 Request  7efab284-518a-43b3-9ea4-8936583eb02e           "code": 400,
            "message": "Ansible Request  c1c14dee-a80d-40b8-800a-9216a27c7d1c 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-flag\":\"true\", \"pnfId\": \"5gDU0001\", \"ipaddress-v4-oam\": \"192.168.35.83\", \"targetSwVersion\": \"\\\\'[\"pnfId\": \"5gDU0001\", \"ipaddress-v4-oam\": \"192.168.35.83\", \"targetSwVersion\": \"\\\\'[{\\\\\\\"swLocation\\\\\\\": \\\\\\\"http://192.168.35.144:10080/ran_du_pkg1-v2.zip\\\\\\\", \\\\\\\"swFileSize\\\\\\\": 353, \\\\\\\"swFileCompression\\\\\\\": \\\\\\\"ZIP\\\\\\\", \\\\\\\"swFileFormat\\\\\\\": \\\\\\\"zip\\\\\\\"}, {\\\\\\\"swLocation\\\\\\\": \\\\\\\"http://192.168.35.144:10080/ran_du_pkg1pkg2-v100v2.zip\\\\\\\", \\\\\\\"swFileSize\\\\\\\": 10000000353, \\\\\\\"swFileCompression\\\\\\\": \\\\\\\"ZIP\\\\\\\", \\\\\\\"swFileFormat\\\\\\\": \\\\\\\"zip\\\\\\\"}]\\\\'\"}"
  }
}

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",
            "sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
        },
        "status": {
            "code": 400,
            "message": "Ansible Request  dcfd4c87a3962a33-a0c686ba-4c354346-b18b8ef2-7d863b29e18de2890d1ba734 finished with Result = success, Message = FINISHED"
        }
    }
}

*: These lcm APIs inherit from R3.

...

Versions Compared

Old Version 30

New Version 31

Key