{"type":"api","title":"Register Upgrade Package","meta":{"id":"/apps/pubhub/media/nfvis-api/e3678dda6abe6c2a26c7698d553a4574e3f45071/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"title":"NFVIS API","description":"NFVIS RESTCONF API Documentation","version":"4.14.1"},"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"swagger":"2.0","basePath":"/{nfvis_ip}/restconf","schemes":["https"],"securityDefinitions":{"basicAuth":{"type":"basic"}}},"spec":{"tags":["System Upgrade"],"summary":"Register Upgrade Package","description":"Register a package for upgrade","operationId":"data_system_system_upgrade_post","produces":["application/yang-data+json"],"parameters":[{"name":"upgrade","in":"body","description":"Upgrade NFVIS","required":true,"schema":{"type":"object","properties":{"system:apply-image":{"type":"array","description":"Upgrade NFVIS with image given (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"name":{"description":"upgrade to an image configured from upgrade/image-name (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"leafref"},"scheduled-time":{"description":"Hours from now to schedule upgrade from 0-24 hrs (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"},"sys-backup":{"description":"Backup ConfD Database - optional (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"vm-backup":{"description":"Backup VM vol - optional (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"auto-restore":{"description":"Restore previous image upon upgrade failure - optional (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"status":{"description":"Upgrade image status (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"upgrade-from":{"description":"Upgraded from image version (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"upgrade-to":{"description":"Upgraded to image version (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}},"system:image-name":{"type":"array","description":"This container is used to save config data related to upgrade registration. (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"name":{"description":"Unique name provided by user for upgrade (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"location":{"description":"Location of the image in local disk (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"image-checksum":{"description":"Checksum of the image from CCO (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}},"system:reg-info":{"description":"This container is used for operational data related to upgrade registration. (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"name":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"name":{"description":"Unique upgrade name proveided by user (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"location":{"description":"Location of the image in local disk (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"package-version":{"description":"Version of image (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"status":{"description":"Image Registration status (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"Valid","enum":["Valid","Invalid","Unknown"]},"upload-date":{"description":"Date and time of registration. Format YYYY-MM-DDTHH:MM:SS (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}}}},"$$ref":"#/definitions/data_system_system_upgrade-post"},"$$ref":"#/parameters/data_system_system_upgrade-post"}],"responses":{"201":{"description":"container upgrade created"},"204":{"description":"No Content","$$ref":"#/responses/204"},"400":{"description":"Bad Request","$$ref":"#/responses/400"},"401":{"description":"Unauthorized","$$ref":"#/responses/401"},"404":{"description":"Not Found","$$ref":"#/responses/404"},"405":{"description":"Method Not Allowed","$$ref":"#/responses/405"},"409":{"description":"Conflict","$$ref":"#/responses/409"}},"security":[{"basicAuth":[]}],"__originalOperationId":"data_system_system_upgrade_post","consumes":["application/yang-data+json"],"method":"post","path":"/data/system:system/upgrade"}}