Striker Agent API - Revision history

Digimer: /* */

2014-10-05T19:36:34Z

← Older revision		Revision as of 19:36, 5 October 2014
Line 295:		Line 295:
	</syntaxhighlight>		</syntaxhighlight>

	Where '<span class="code">x</span>' is the name of the foreign key, '<span class="code">y</span>' is the <span class="code"><table name="..."></span> containing the '<span class="code"><primary_key ... /></span>' and '<span class="code">z</span>' is the <span class="code"><column name="..."></span> that the foreign key references.		Where '<span class="code">x</span>' is the name of the foreign key, '<span class="code">y</span>' is the <span class="code"><table name="..."></span> containing the '<span class="code"><primary_key ... /></span>' and '<span class="code">z</span>' is the <span class="code"><column name="..."></span> that the foreign key references.

	== -v, --version ==		== -v, --version ==

Digimer: /* -c, --check */

2014-09-29T00:36:21Z

-c, --check

← Older revision		Revision as of 00:36, 29 September 2014
Line 145:		Line 145:

	All events that generate alerts should return the alert message in XML format. Alerts should be returned in XML format (described below [not yet complete]) with the alert message available in all supported languages.		All events that generate alerts should return the alert message in XML format. Alerts should be returned in XML format (described below [not yet complete]) with the alert message available in all supported languages.

			== -i, --info ==

			Display information about the agent in XML format.

	== -s, --sql ==		== -s, --sql ==

Digimer at 23:44, 28 September 2014

2014-09-28T23:44:09Z

← Older revision		Revision as of 23:44, 28 September 2014
Line 1:		Line 1:
	{{header}}		{{header}}

			{{warning\|1=This API is '''not''' complete!}}

	This is the [[Striker]] Agent API definition.		This is the [[Striker]] Agent API definition.

Digimer: /* v, version */

2014-09-28T23:34:21Z

v, version

← Older revision		Revision as of 23:34, 28 September 2014
Line 291:		Line 291:
	Where '<span class="code">x</span>' is the name of the foreign key, '<span class="code">y</span>' is the <span class="code"><table name="..."></span> containing the '<span class="code"><primary_key ... /></span>' and '<span class="code">z</span>' is the <span class="code"><column name="..."></span> that the foreign key references.		Where '<span class="code">x</span>' is the name of the foreign key, '<span class="code">y</span>' is the <span class="code"><table name="..."></span> containing the '<span class="code"><primary_key ... /></span>' and '<span class="code">z</span>' is the <span class="code"><column name="..."></span> that the foreign key references.

	== v, version ==		== -v, --version ==

	<span class="code">-v</span>, <span class="code">--version</span>		<span class="code">-v</span>, <span class="code">--version</span>

Digimer: /* s, sql */

2014-09-28T23:34:06Z

s, sql

← Older revision		Revision as of 23:34, 28 September 2014
Line 144:		Line 144:
	All events that generate alerts should return the alert message in XML format. Alerts should be returned in XML format (described below [not yet complete]) with the alert message available in all supported languages.		All events that generate alerts should return the alert message in XML format. Alerts should be returned in XML format (described below [not yet complete]) with the alert message available in all supported languages.

	== s, sql ==		== -s, --sql ==

	<span class="code">-s</span>, <span class="code">--sql</span>		<span class="code">-s</span>, <span class="code">--sql</span>

Digimer: /* c, check */

2014-09-28T23:33:55Z

c, check

← Older revision		Revision as of 23:33, 28 September 2014
Line 115:		Line 115:
	Striker Agents must exit with return code '0' on success. Unless specified, any non-0 return code will be treated as a failure, regardless of textual output.		Striker Agents must exit with return code '0' on success. Unless specified, any non-0 return code will be treated as a failure, regardless of textual output.

	== c, check ==		== -c, --check ==

	Run a check. Exit it with one of the following exit codes;		Run a check. Exit it with one of the following exit codes;

Digimer: /* Command Line Switches */

2014-09-28T22:30:18Z

Command Line Switches

@@ Line 115: / Line 115: @@
 Striker Agents must exit with return code '0' on success. Unless specified, any non-0 return code will be treated as a failure, regardless of textual output.
-== v, version ==
+== c, check ==
-<span class="code">-v</span>, <span class="code">--version</span>
+Run a check. Exit it with one of the following exit codes;
-Agents must return the numerical Striker-Agent_API version they conform to. Output must be a single XML element named '<span class="code">striker-scanner</span>' with variable name of 'SA API' and a value in the format '<span class="code">x.y</span>', where '<span class="code">x</span>' and '<span class="code">y</span>' are integers representing the API major and minor versions supported by the agent, respectively.
+{|class="wikitable"
-Example output:
+All events that generate alerts should return the alert message in XML format. Alerts should be returned in XML format (described below [not yet complete]) with the alert message available in all supported languages.
 == s, sql ==
@@ Line 273: / Line 290: @@
 Where '<span class="code">x</span>' is the name of the foreign key, '<span class="code">y</span>' is the <span class="code"><table name="..."></span> containing the '<span class="code"><primary_key ... /></span>' and '<span class="code">z</span>' is the <span class="code"><column name="..."></span> that the foreign key references.

Digimer: /* */

2014-09-28T20:38:03Z

← Older revision		Revision as of 20:38, 28 September 2014
Line 200:		Line 200:
	\|Table is a sequence. New sequences will always start at '<span class="code">0</span>'.		\|Table is a sequence. New sequences will always start at '<span class="code">0</span>'.
	\|}		\|}

			===== Type 'sequence' =====

			Sequence tables are used by most tables for automatically generating unique sequence numbers for '<span class="code">data</span>' type table entries. These help ensure uniqueness among entries when all other attributes might change. It's not required, but it is recommended, that a sequence is created for all '<span class="code">data</span>' type tables.

			===== Type 'data' =====

			These are the main tables used to store data.

	==== <column type="..."> ====		==== <column type="..."> ====

Digimer: /* Element Descriptions */

2014-09-28T20:33:49Z

Element Descriptions

← Older revision		Revision as of 20:33, 28 September 2014
Line 186:		Line 186:
	=== Element Descriptions ===		=== Element Descriptions ===

	==== <table ...> ====		==== <nowiki><table ...></nowiki> ====

	Valid '<span class="code">value</span>' attribute values;		Valid '<span class="code">value</span>' attribute values;

Digimer: /* s, sql */

2014-09-28T18:50:06Z

s, sql

← Older revision		Revision as of 18:50, 28 September 2014
Line 131:		Line 131:
	<span class="code">-s</span>, <span class="code">--sql</span>		<span class="code">-s</span>, <span class="code">--sql</span>

	Agents must return the SQL schema the agent will require in XML format defined below. The Striker Scanner will create or modify tables as needed before calling the agent to run.		Agents must return the SQL schema the agent will require in XML format defined below. The Striker Scanner will create or modify tables as needed before calling the agent to run. Each table will have a corresponding table created in the '<span class="code">history</span>' schema which can later be used by the agent to query historical values, generate reports, etc.

	{{note\|1=New tables, and new columns for existing tables, may be added, but existing columns may not be modified. If an agent provides a schema that would cause an existing table's column to be changed, and error alert email will be generated and the agent will not be run. An administrator will need to manually adjust the table's columns to conform to the schema returned by this call for the agent to be used again. The scanner will examine the schema compatibility on every pass, though only one alert email will be sent. If the schema is later found to be compatible, a follow up alert will be dispatched and any future compatibility issue will again trigger an alert.}}		{{note\|1=New tables, and new columns for existing tables, may be added, but existing columns may not be modified. If an agent provides a schema that would cause an existing table's column to be changed, and error alert email will be generated and the agent will not be run. An administrator will need to manually adjust the table's columns to conform to the schema returned by this call for the agent to be used again. The scanner will examine the schema compatibility on every pass, though only one alert email will be sent. If the schema is later found to be compatible, a follow up alert will be dispatched and any future compatibility issue will again trigger an alert.}}