REST Cookbook

All the recipes on this page have been created using Nrcq as shown in the REST Tutorial.

Before trying a recipe install nrcq.


  • How to remove things.

    1. Disable a host.

      Often disabling a host is preferable to deleting it. For example, hosts might be brought up and taken down based on system load, in which case any custom changes, made directly to the host or services, will be lost if they are deleted then later added again.

      A host and its services can be easily disabled in the nagrestconf web interface, but to disable a host using the REST interface the services must be disabled before the host can be disabled.

      The 'disable' property accepts 0, 1 or 2, which means enabled, disabled, or testing mode, respectively. Wildcards can not be used for modifying properties so the 'filter' option is used to show all of the services for a host.

      The following snippet shows how to disable a host, 'server1', and all of its services:

      nrcq $URL show/services -f name:server1 \
          | grep svcdesc \
          | while IFS=":" read a b; do \
              nrcq $URL modify/services -d name:server1 -d "svcdesc:$b" -d disable:1
      nrcq $URL modify/hosts -d name:server1 -d disable:1

      Enabling the host and all of its services needs to be done the other way round and the disable property should be changed from a '1' to a '0':

      nrcq $URL modify/hosts -d name:server1 -d disable:0
      nrcq $URL show/services -f name:server1 \
          | grep svcdesc \
          | while IFS=":" read a b; do \
              nrcq $URL modify/services -d name:server1 -d "svcdesc:$b" -d disable:0
    2. Delete a host.

      A host and its services can be easily deleted in the nagrestconf web interface, but to delete a host using the REST interface the services must be deleted before the host can be deleted.

      The following snippet shows how to delete a host, 'server1', and all of its services:

      nrcq http://localhost/rest delete/services -d name:server1 -d "svcdesc:.*"
      nrcq http://localhost/rest delete/hosts -d name:server1

      That's all that is required to delete a host and its services.

    3. Delete the entire configuration.

      There is no way to quickly delete the entire configuration using the Web interface. The following snippet will completely delete the nagrestconf configuration.

      Or with nrcq:
      for i in services hosts servicesets hosttemplates \
               servicetemplates contactgroups contacts  \
               hostgroups servicegroups timeperiods commands
         nrcq delete/$i -d "name:.*" -d "svcdesc:.*"

      NOTE: This will probably not work if the ' Less used and deprecated tables' have been used as they will need to be deleted first.

    4. Delete an entire table.

      A bunch of hosts or services can be deleted from the hosts or services tables by using the Web interface, but bulk deletion is not possible on the other tables.

      Use the following snippet to delete the hosts table.

      nrcq http://localhost/rest delete/hosts -d "name:.*" -d "svcdesc:.*"

      Change 'hosts' in 'delete/hosts' for another table name to delete that instead.

      You may have noticed that the 'svcdesc' property is used for 'delete/hosts' when that property does not exist in the hosts table. When a property is used, but does not exist, then the REST interface silently ignores it, so the previous delete command will work for tables that requires the 'svcdesc' property and for those that don't.

  • How to rename things.

    1. Rename a hostgroup.

      It is not possible to rename key fields once they have been created. In general the user must copy/clone the item to a different name, then delete the original item.

      To change the name of a hostgroup, say from 'app' to 'legapp' using the GUI, the following steps would need to be followed:

      1. In the Groups Tab - Create a new 'legapp' hostgroup.
      2. In the Hosts Tab - Filter by 'app' hostgroup.
      3. Click Bulk Tools to open it. Bulk Tools will operate on all items shown.
      4. 'Field to change' - choose 'hostgroup'
      5. 'Change action' - choose 'replace'
      6. 'Text' - type 'legapp', then Apply Changes

      The 'app' hostgroup can now be deleted. If any items are still left in the app group then nagrestconf won't allow it to be deleted.

      The above procedure can be completed using a shell script and nrcq, which will allow for much finer control. So, for example, below is a script named '' that will change any hostgroup name. The text 'NAGIOSHOST' should be changed to the name of your Nagios host, where nagrestconf `lives'.

      [[ -z $1 || -z $2 || -z $3 ]] && {
        echo "Change a hostgroup name."
        echo "Usage: `basename $0` old_name new_name description"
        exit 1
      # Make sure orig_hgname exists
      h=`nrcq $URL show/hostgroups -f "name:\b$orig_hgname\b"`
      [[ -z $h ]] && {
        echo "Hostgroup, '$orig_hgname', does not exist."
        exit 1
      # Make sure new_hgname does not exist
      h=`nrcq $URL show/hostgroups -f "name:\b$new_hgname\b"`
      [[ -n $h ]] && {
        echo "Hostgroup, '$new_hgname', exists!"
        exit 1
      # Add the host group
      nrcq $URL add/hostgroups -d "name:$new_hgname" -d "alias:$description"
      # Change existing hosts that have old_name in the hostgroup
      hosts=`nrcq $URL show/hosts -f hostgroup:legapp | sed -n 's/^ *name://p'`
      for host in $hosts; do
        echo nrcq $URL modify/hosts -d "name:$host" -d "hostgroup:$new_hgname"
        nrcq $URL modify/hosts -d "name:$host" -d "hostgroup:$new_hgname"
      # Delete the old hostgroup
      nrcq $URL delete/hostgroups -d "name:$orig_hgname"

      The script could be used to change 'app' to 'legapp', by typing:

      bash app legapp "Legacy App Servers"