Initiating reloads and fetching the current reload status
URL: /rest/reload
- GET - gets status of reload
- POST - initiates a synchronous reload. Returns 200 if reload completed. Will return 400 with error messages if reload fails. Will return 409 if a reload already in progress
- PUT - unimplemented
- DELETE - unimplemented
Requires RELOADACCESS.
Parameters:
- asynchronous - if set to 1, an asynchronous reload will be run. Use a GET request to poll to see if the reload has completed. Default 0
- changelog - if a POST request and changelog is enabled, you must set the text to save otherwise an error will occur
Returned data:
- server_status - this is the state of the server
- 0 - server running, with no warnings
- 1 - server reloading
- 2 - server not running
- 3 - configuration error or critical error
- 4 - warnings exist
- configuration_status - this is the state of the configuration
- uptodate - all configuration changes have been applied
- pending - at least one configuration change requires a reload
- average_duration - number of seconds a reload normally takes, rounded up to nearest 10 seconds
- lastupdated - epoch time for last configuration update
- auditlog_entries - number of audit log entries since last backup. This could be undef
- messages - array of messages, where each message is a hash (or dictionary) of strings
If a reload is already in progress then the status code will be set to 409 with returned data of:
- server_status - set to 1
- messages - set to [ “Reload already running” ]
Examples:
Fetch the current status
$ opsview_rest --token-file /path/to/opsview_restapi_token --pretty GET reload
{
"auditlog_entries" : "0",
"average_duration" : "30",
"configuration_status" : "uptodate",
"lastupdated" : "1519680052",
"messages" : [
{
"detail" : "Missing required variable EMAIL for contact admin for notification method Email - ignoring this notification",
"monitoringserver" : "Master Monitoring Server",
"severity" : "warning"
},
{
"detail": "Missing required variable EMAIL for contact user for notification method Email - ignoring this notification",
"severity"; "warning",
"monitoringserver" : "Master Monitoring Server",
}
],
"server_status" : "4"
}
Initiate a reload with changelog
enabled:
changelog
enabled:$ opsview_rest --token-file /path/to/opsview_restapi_token --pretty POST "reload?changelog=Creating new users"
{
"auditlog_entries" : "0",
"average_duration" : "30",
"configuration_status" : "uptodate",
"lastupdated" : "1519680351",
"messages" : [],
"server_status" : "0"
}