| Table of Contents |
|---|
Introduction
*(Under Review for V2)
Introduction
You can As at 1.12.8 we have removed the old functionality of "Create a Windows Audit Script" and replaced it with the Scripts endpoint. You can now create a script with all the options for any of the existing audit scripts - not just Windows. AIX, ESX, Linux, OSX and Windows are all covered.
...
We initially setup the default list of scripts with the default options. The list of script is viewable at /scripts. These default scripts cannot be deleted. You can create additional scripts for use by you as required. Your script will be based on one of the existing scripts and have custom options applied. The scripts can then be downloaded from the list page at menu: Discover -> Admin -> Audit Scripts -> List Audit Scripts.
Creating a Script
To make another script use the menu and go to menu: Discover -> Admin Audit Scripts -> Scripts -> Create Script> Create Audit Scripts. Provide a name and optionally a description. Choose a type of script to base your custom script upon. Once you do this, the Options section will populate with the available configurable options. At present Windows and Linux scripts will have the "files" details injected. See details about files here - Files.
...
URL - If you leave the URL option as set, Open-AudIT will inject the config value for default_network_address into the URL option. With the default scripts, if left as set, Open-AudIT will inject the default network address when the script is downloaded.
Viewing Script Details
Go to menu -> Admin -> Scripts -> List Scripts.
...
...
...
...
Database Schema
| Code Block | ||||
|---|---|---|---|---|
| ||||
Create Table: CREATE TABLE `scripts` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(200) NOT NULL DEFAULT '',
`org_id` int(10) unsigned NOT NULL DEFAULT '1',
`options` text NOT NULL,
`description` text NOT NULL,
`based_on` varchar(200) NOT NULL DEFAULT '',
`hash` varchar(250) NOT NULL DEFAULT '',
`edited_by` varchar(200) NOT NULL DEFAULT '',
`edited_date` datetime NOT NULL DEFAULT '2000-01-01 00:00:00',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=8 DEFAULT CHARSET=utf8; |
Example Database Entry
...
Scripts are stored in the database in the "scripts" table. A typical entry will look as below. The "hash" column is not used at present.
id: 12...
| Code Block | ||||
|---|---|---|---|---|
| ||||
id: 1 name: |
...
audit_aix.sh |
...
...
|
...
|
...
org_id: 1 options: {"submit_online":"y"," |
...
create_ |
...
file":"n","url":"http:\/\/ |
...
localhost\/open-audit\/index.php\/ |
...
input\/ |
...
description: ...
devices","debugging":1} description: The default audit AIX config. based_on: audit_aix.sh |
...
hash: |
...
edited_by: |
...
system edited_date: |
...
2000- |
...
01- |
...
01 |
...
00: |
...
00: |
...
00 |
API / Web Access?
You can access the /scripts collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.
...