{"type":"api","title":"Get Restore Status","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":["Host Action Configuration"],"summary":"Get Restore Status","description":"Get the status of system restore including NFVIS configuration and each VM","operationId":"data_hostaction_hostaction_restore_status_get","produces":["application/yang-data+json"],"parameters":[{"name":"content","in":"query","description":"controlling descendant nodes in response","required":false,"type":"string","format":"enumeration","default":"config","enum":["config","nonconfig","all"],"$$ref":"#/parameters/content"}],"responses":{"200":{"description":"This list indicates the status of system restore including NFVIS configuration and each VM","schema":{"type":"object","properties":{"hostaction:restore-status":{"type":"array","description":"This list indicates the status of system restore including NFVIS configuration and each VM (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"start-time":{"description":"System time when restore is initiated (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"source":{"description":"Source of the backup package (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"status":{"description":"Status of restore process (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"VERIFICATION-IN-PROGRESS","enum":["VERIFICATION-IN-PROGRESS","VERIFICATION-ERROR","VERIFICATION-SUCCESS","RESTORE-INIT","RESTORE-IN-PROGRESS","RESTORE-ERROR","RESTORE-SUCCESS","RESTORE-COMPLETED-PARTIALLY"]},"unique-mac-uid":{"description":"This fieldis used for internal purpose.\nIt tracks if the restore VM needs to have unique Mac and UID (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"components":{"type":"array","description":"Shows all components in a restore process (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"component":{"description":"Indicates the name of the restore component (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"status":{"description":"Indicates status of the component in progress (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"VERIFICATION-IN-PROGRESS","enum":["VERIFICATION-IN-PROGRESS","VERIFICATION-ERROR","VERIFICATION-SUCCESS","RESTORE-INIT","RESTORE-IN-PROGRESS","RESTORE-ERROR","RESTORE-SUCCESS","RESTORE-COMPLETED-PARTIALLY"]},"last-update":{"description":"Indicates the time of the last update made to the component (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"details":{"description":"Shows more details related to status of the component (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}}}}},"$$ref":"#/definitions/data_hostaction_hostaction_restore-status"}},"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_hostaction_hostaction_restore_status_get","consumes":["application/yang-data+json"],"method":"get","path":"/data/hostaction:hostaction/restore-status"}}