ScanCoreAPI - Revision history

Digimer: /* Agent Exit Codes */

2015-05-04T05:11:11Z

Agent Exit Codes

← Older revision		Revision as of 05:11, 4 May 2015
Line 75:		Line 75:
	\|class="code"\|100 ~ 199		\|class="code"\|100 ~ 199
	\|Reserved for Agent-specific exit codes. ScanCore treats these as "failed to run".		\|Reserved for Agent-specific exit codes. ScanCore treats these as "failed to run".
			\|-
			\|class="code"\|255
			\|The scan agent failed to run at all. This is usually caused by an agent written in an interpreted language failing to compile.
	\|}		\|}


	{{footer}}		{{footer}}

Digimer: /* Agent File Name */

2015-05-03T23:49:43Z

Agent File Name

← Older revision		Revision as of 23:49, 3 May 2015
Line 34:		Line 34:
	\|-		\|-
	\|class="code"\|ScanCore/scan-foo/scan-foo		\|class="code"\|ScanCore/scan-foo/scan-foo
	\|File (script)		\|style="white-space: nowrap;"\|File (script)
	\|The <span class="code">scan-foo</span> agent itself.		\|The <span class="code">scan-foo</span> agent itself.
	\|'''Must be executable!'''		\|style="white-space: nowrap;"\|'''Must be executable!'''
	\|-		\|-
	\|class="code"\|ScanCore/scan-foo/scan-foo.xml		\|class="code" style="white-space: nowrap;"\|ScanCore/scan-foo/scan-foo.xml
	\|File (XML)		\|File (XML)
	\|The [[strings]] specific to the <span class="code">scan-foo</span> agent.		\|The [[strings]] specific to the <span class="code">scan-foo</span> agent.

Digimer: /* Agent Exit Codes */

2015-05-03T21:05:52Z

Agent Exit Codes

← Older revision		Revision as of 21:05, 3 May 2015
Line 62:		Line 62:
	\|-		\|-
	\|class="code"\|2		\|class="code"\|2
	\|Agent failed to make a required system call.		\|Agent failed to make a required system call. See log file for details.
			\|-
			\|class="code"\|3
			\|Agent failed to read a critical file. See log file for details.
			\|-
			\|class="code"\|4
			\|Agent failed to write to a critical file. See log file for details.
	\|-		\|-
	\|class="code"\|99		\|class="code"\|99

Digimer: /* Agent Exit Codes */

2015-05-03T21:04:31Z

Agent Exit Codes

← Older revision		Revision as of 21:04, 3 May 2015
Line 60:		Line 60:
	\|class="code"\|1		\|class="code"\|1
	\|Agent did not find anything to scan (hardware not found or application not installed/found).		\|Agent did not find anything to scan (hardware not found or application not installed/found).
			\|-
			\|class="code"\|2
			\|Agent failed to make a required system call.
	\|-		\|-
	\|class="code"\|99		\|class="code"\|99

Digimer: /* Agent File Name */

2015-05-03T19:09:22Z

Agent File Name

← Older revision		Revision as of 19:09, 3 May 2015
Line 21:		Line 21:
	!Type		!Type
	!Purpose		!Purpose
			!Note
	\|-		\|-
	\|class="code"\|ScanCore/		\|class="code"\|ScanCore/
	\|Directory		\|Directory
	\|The directory where <span class="code">ScanCore</span> is installed.		\|The directory where <span class="code">ScanCore</span> is installed.
			\|
	\|-		\|-
	\|class="code"\|ScanCore/scan-foo/		\|class="code"\|ScanCore/scan-foo/
	\|Directory		\|Directory
	\|The directory where the <span class="code">scan-foo</span> agent is installed.		\|The directory where the <span class="code">scan-foo</span> agent is installed.
			\|
	\|-		\|-
	\|class="code"\|ScanCore/scan-foo/scan-foo		\|class="code"\|ScanCore/scan-foo/scan-foo
	\|File (script)		\|File (script)
	\|The <span class="code">scan-foo</span> agent itself.		\|The <span class="code">scan-foo</span> agent itself.
			\|'''Must be executable!'''
	\|-		\|-
	\|class="code"\|ScanCore/scan-foo/scan-foo.xml		\|class="code"\|ScanCore/scan-foo/scan-foo.xml
	\|File (XML)		\|File (XML)
	\|The [[strings]] specific to the <span class="code">scan-foo</span> agent.		\|The [[strings]] specific to the <span class="code">scan-foo</span> agent.
			\|
	\|-		\|-
	\|class="code"\|ScanCore/scan-foo/scan-foo.sql		\|class="code"\|ScanCore/scan-foo/scan-foo.sql
	\|File (SQL)		\|File (SQL)
	\|The SQL [[schema]] that will be loaded into the ScanCore databases and then used by the <span class="code">scan-foo</span> agent to record information about 'foo' system it monitors.		\|The SQL [[schema]] that will be loaded into the ScanCore databases and then used by the <span class="code">scan-foo</span> agent to record information about 'foo' system it monitors.
			\|
	\|}		\|}

Digimer at 19:02, 3 May 2015

2015-05-03T19:02:15Z

← Older revision		Revision as of 19:02, 3 May 2015
Line 4:		Line 4:

	This is the API for writing "Scan Agents" for the [[ScanCore]] alert system.		This is the API for writing "Scan Agents" for the [[ScanCore]] alert system.

			= Conventions =

			The term "'''should'''" indicates a recommended but optional implementation scheme.

			The term "'''must'''" indicates a required implementation scheme.

			= Agent File Name =

			All agents must be stored under the directory '<span class="code">ScanCore/agents/</span>. Each agent '''should''' be in it's own subdirectory, named after the agent itself. The agent's name '''must''' start with "<span class="code">scan-</span> followed by a descriptive name that would allow a reader to determine the purpose of the agent. Additional data, like an [[XML]] "[[strings]]" file and [[SQL]] "[[schema]]" file '''should''' have the file names <span class="code">scan-foo.xml</span> and <span class="code">scan-foo.sql</span>, respectively.

			Example:

			{\|class="wikitable"
			!File
			!Type
			!Purpose
			\|-
			\|class="code"\|ScanCore/
			\|Directory
			\|The directory where <span class="code">ScanCore</span> is installed.
			\|-
			\|class="code"\|ScanCore/scan-foo/
			\|Directory
			\|The directory where the <span class="code">scan-foo</span> agent is installed.
			\|-
			\|class="code"\|ScanCore/scan-foo/scan-foo
			\|File (script)
			\|The <span class="code">scan-foo</span> agent itself.
			\|-
			\|class="code"\|ScanCore/scan-foo/scan-foo.xml
			\|File (XML)
			\|The [[strings]] specific to the <span class="code">scan-foo</span> agent.
			\|-
			\|class="code"\|ScanCore/scan-foo/scan-foo.sql
			\|File (SQL)
			\|The SQL [[schema]] that will be loaded into the ScanCore databases and then used by the <span class="code">scan-foo</span> agent to record information about 'foo' system it monitors.
			\|}

	= Agent Exit Codes =		= Agent Exit Codes =

Digimer: /* Agent Exit Codes */

2015-05-03T18:04:15Z

Agent Exit Codes

← Older revision		Revision as of 18:04, 3 May 2015
Line 16:		Line 16:
	\|class="code"\|1		\|class="code"\|1
	\|Agent did not find anything to scan (hardware not found or application not installed/found).		\|Agent did not find anything to scan (hardware not found or application not installed/found).
			\|-
			\|class="code"\|99
			\|Agent exited with an undefined exit code. This is interpreted as a broken agent.
	\|-		\|-
	\|class="code"\|100 ~ 199		\|class="code"\|100 ~ 199

Digimer: /* Agent Exit Codes */

2015-05-03T15:51:45Z

Agent Exit Codes

← Older revision		Revision as of 15:51, 3 May 2015
Line 16:		Line 16:
	\|class="code"\|1		\|class="code"\|1
	\|Agent did not find anything to scan (hardware not found or application not installed/found).		\|Agent did not find anything to scan (hardware not found or application not installed/found).
			\|-
			\|class="code"\|100 ~ 199
			\|Reserved for Agent-specific exit codes. ScanCore treats these as "failed to run".
	\|}		\|}


	{{footer}}		{{footer}}

Digimer: Created page with "{{header}} {{warning|1=This is very much a work in progress and not at all stable or finalized.}} This is the API for writing "Scan Agents" for the ScanCore alert syst..."

2015-05-03T15:46:36Z

Created page with "{{header}} {{warning|1=This is *very* much a work in progress and not at all stable or finalized.}} This is the API for writing "Scan Agents" for the ScanCore alert syst..."

Páàjì titun

{{header}}

{{warning|1=This is *very* much a work in progress and not at all stable or finalized.}}

This is the API for writing "Scan Agents" for the [[ScanCore]] alert system.

= Agent Exit Codes =

{|class="wikitable"
!Return Code
!Reason
|-
|class="code"|0
|Agent successfully scanned one or more devices.
|-
|class="code"|1
|Agent did not find anything to scan (hardware not found or application not installed/found).
|}

{{footer}}

ScanCoreAPI - Revision history

Digimer: /* Agent Exit Codes */

Digimer: /* Agent File Name */

Digimer: /* Agent Exit Codes */

Digimer: /* Agent Exit Codes */

Digimer: /* Agent File Name */

Digimer at 19:02, 3 May 2015

Digimer: /* Agent Exit Codes */

Digimer: /* Agent Exit Codes */

Digimer: Created page with "{{header}} {{warning|1=This is *very* much a work in progress and not at all stable or finalized.}} This is the API for writing "Scan Agents" for the ScanCore alert syst..."

Digimer: Created page with "{{header}} {{warning|1=This is very much a work in progress and not at all stable or finalized.}} This is the API for writing "Scan Agents" for the ScanCore alert syst..."