README 2012-05-20 for NRDS_win

Usage:

The following settings can be found in Config.ini of the NRDS_Win installation directory.

[Settings]
	- CONFIG_VERSION: *required*
		This version number is compared with the config on the NRDS server.  If the NRDS
		server has a newer version number, Config.ini will be overwritten with the
		newest version.
	
	- CONFIG_OS: *required*
		This is read by the NRDP server in order to display the config version
		properly in the NRDS config manager

	- CONFIG_NAME: *required*
		Will match the configuration name on the NRDS server. used to fetch the .cfg file
		and save it locally as Config.ini

	- URL: *Required*
		In most cases, this will be the ip address of Nagios followed by /nrdp.
		Example: NRDP = http://<Nagios IP>/nrdp
		
	- Token number: *Required*
		Token number of NRDP server.  If you're using NagiosXI, this can be 
		found by navigating to Admin > Inbound Transfer> NRDP Tab
		
	- Hostname:
		This is the computer name of the machine running the checks, and is how
		it will appear in Nagios.  If the defatult "Hostname = localhost" is left,
		NRDS_win will resolve the localhost name for you.

	- PLUGIN_DIR: *required*
		This defines the directory where plugins are stored and accessed by NRDS_win.

	- SEND_NRDP: Used in by NRDS Linux agent.  Not yet employed by NRDS_win

	- TMPDIR: Used in by NRDS Linux agent.  Not yet employed by NRDS_win

	- COMMAND_PREFIX: Used in by NRDS Linux agent.  Not yet employed by NRDS_win

	- LOG_NAME:
		log name and location for debugging and troubleshooting purpose.  This dumps
		the XML response from the NRDP

	- UPDATE_CONFIG:
		Used to control the ability of the NRDS agent to fetch new config files defined
		in NRDS config manager. 
			1 = download new configs when available.
			0 = don't check for new configs

	- UPDATE_PLUGINS:
		Used to control the ability of the NRDS agent to fetch new plugins that are defined
		in Config.ini
			1 = download new configs when available.
			0 = don't check for new configs
		
	- LogLocation:
		Location of debugging information.  The XML checks sent to Nagios
		as well as return information from Apache.  This file is overwritten
		each time NRDS_win runs.

		
[Services]
	- Here is where any number of checks can be defined. by default, we have
	  added some checks as an example.  The checks should be formatted
	  as follows:
		<check_name> = <path location\file name> <check arguments>
		
	  For Example:
	    nrpe_diskspace = .\plugins\diskspace_nrpe_nt.exe c: 77 90
		

Troubleshooting:
	- Scheduled Task:
	  Once installed, a scheduled task is created.  Check to validate task
	  has been scheduled and is running successfully.
	 
	- Log File:
	  NRDS_win.vbs will log check results as XML data as well as return information.
	  For example, successful results will contain the following:
	  
		<result>
			<status>0</status>
			<message>OK</message>
				<meta>
					<output>7 checks processed.</output>
				</meta>
		</result>



Happy Checking.
	  
Yancy Ribbens (yribbens@nagios.com)
