diff --git a/doc/command.md b/doc/command.md deleted file mode 100644 index f442432a4..000000000 --- a/doc/command.md +++ /dev/null @@ -1,184 +0,0 @@ -# Commands - -## Abstract - -Commands are one important intersection between the monitoring core and the -frontend. This is the writable interface where you can control the core how -checks will be processed. Usually you can interact by buttons in the frontend. - -This document describes the URL interface and what commands can be used. - -## Configuration - -**To be done.** - -## URL Interface - -The interface offers to options how to deal with commands: - -1. Show html forms to enter information about the commands (GET requests) -2. Send commands when providing post data - -### Endpoint - -Endpoint of commands is specified as follow: - -``` -http://localhost:8080/icinga2-web/monitoring/command/ -``` - -### List of commands - -To see which commands are support you can supply the **list** argument: - -``` -http://localhost:8080/icinga2-web/monitoring/command/list -``` - -### Examples of command urls: - -``` -# Schedule downtime for an object -http://localhost:8080/icinga2-web/monitoring/command/scheduledowntime - -# Provide a new commend for an object -http://localhost:8080/icinga2-web/monitoring/command/addcomment -``` - -# Provide a global command for host or service checks - -http://localhost:8080/icinga2-web/monitoring/command/disableactivechecks?global=host -http://localhost:8080/icinga2-web/monitoring/command/disableactivechecks?global=service - -# Provide a object command globally - -http://localhost:8080/icinga2-web/monitoring/command/disablenotifications?global=1 - -## List of commands - -*Please note that the list is not complete yet, more commands will follow* - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CommandDescription
disableactivechecksDisable active checks for an object
enableactivechecksEnable active checks for an object
reschedulenextcheckReschedule next active check
submitpassivecheckresultSubmit a passive result set for this check
stopobsessingStop obsessing over object
startobsessingStart obsessing over object
stopacceptingpassivechecksStop accepting passive results for this object
startacceptingpassivechecksStart accepting passive results for this object
disablenotificationsDisable sending messages for problems
enablenotificationsEnable sending messages for problems
sendcustomnotificationSend a custom notification for this object
scheduledowntimeSchedule a downtime for this object
scheduledowntimeswithchildrenSchedule a downtime for host and all services
removedowntimeswithchildrenRemove all downtimes from this host and its services
disablenotificationswithchildrenDisable all notification from this host and its services
enablenotificationswithchildrenEnable all notification from this host and its services
reschedulenextcheckwithchildrenReschedule next check of host ans its services
disableactivecheckswithchildrenDisable all checks of this host and its services
enableactivecheckswithchildrenDisable all checks of this host and its services
disableeventhandlerDisable event handler for this object
enableeventhandlerDisable event handler for this object
disableflapdetectionDisable flap detection
enableflapdetectionEnable flap detection
addcommentAdd a new comment to this object
resetattributesReset all changed attributes
acknowledgeproblemAcknowledge problem of this object
removeacknowledgementRemove problem acknowledgement
delaynotificationDelay next object notification
removedowntimeRemove a specific downtime
\ No newline at end of file