...
A group can be created using the web interface if a user has a role that contains the group::create permission. Go to menu: Manage -> Groups -> Create Groups. There is also a create button on the collection page. A user must include the filter clause in the where filter, ie - WHERE @filter. This is required so Open-AudIT can return only those devices a user has access rights to. Examples are on the Help -> Default Group List page (see below).
Image Removed
Image Removed
Image Added
Image Added
View Users Details
...
You will see a list of groups. You can view a group by clicking on the blue view icon. You can also edit or delete groups.
.
Image Removed
Image AddedDefault Groups
There are sixteen default groups. They are below. The default group definitions can also be found in the application at menu -> Help -> Default Group ListDefaults -> Groups. You will see a list of the default groups and the attributes used to create them.
| Code Block |
|---|
| language | text |
|---|
| theme | Eclipse | language | text |
|---|
|
mysql> SELECT name FROM groups;
+---------------------------------------+
| name |
+---------------------------------------+
| All Devices |
| Apple Computers |
| Centos Computers |
| Computers |
| Computers |
| Debian Computers |
| Linux Computers |
| Open-AudIT Enterprise Managed Devices |
| Printers |
| Public IP Devices |
| RedHat Computers |
| Routers |
| Switches |
| Windows Computers |
| Windows Servers |
| Windows Workstations |
+---------------------------------------+
16 rows in set (0.00 sec) |
...
The schema for the database is below. It can also be found in the application is the user has database::read permission by going to menu: Manage -> Database -> List Database, then clicking on the "groups" table.
| Code Block |
|---|
| language | text |
|---|
| theme | Eclipse | language | text |
|---|
|
CREATE TABLE `groups` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
`org_id` int(10) unsigned NOT NULL DEFAULT '1',
`name` varchar(100) NOT NULL DEFAULT '',
`description` text NOT NULL,
`sql` text NOT NULL,
`link` text NOT NULL,
`expose` enum('y','n') NOT NULL DEFAULT 'y',
`edited_by` varchar(200) NOT NULL DEFAULT '',
`edited_date` datetime NOT NULL DEFAULT '2000-01-01 00:00:00',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8; |
...
Example Database Entry
| Code Block |
|---|
| language | text |
|---|
| theme | Eclipse | language | text |
|---|
|
id: 15
org_id: 1
name: Windows Servers
description: Devices with type = computer and os_name like Windows Server.
sql: SELECT DISTINCT(system.id) FROM system WHERE @filter AND system.type = 'computer' AND os_name LIKE '%windows%server%'
link:
expose: y
edited_by: system
edited_date: 2016-11-28 04:53:59 |
...
API / Web Access
You can access the /groups collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.
API Routes
| Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes | Example Response |
|---|
| POST | n |
|
| update | groups::update | /groups/{id} | Update an attribute of a groups entry. | groups_update.json |
| DELETE | y |
Web Application Routes
In addition to the above, when accessing Open-AudIT using a web browser.
| Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes |
|---|
|
|
|---|
| GET | n | create | create_form | groups::create | /groups/create | Displays a standard web form for submission to POST /groups. |
|
|
| GET | y | update | update_form | groups::update | /groups/{id}/update | Show the group details with the option to update attributes using PATCH to /groups/{id} |
|
|
| GET | n | import | import_form | groups::create | /groups/import | Displays a standard web form for submission to POST /groups/import. |
|
|
| POST | n | import | import | groups::create | /groups/import | Import multiple groups using a CSV. |