Networks (pre v2)
Introduction
As at 1.12.6 we have introduced the concept of Networks. The Blessed Subnets feature uses the data available in Networks.
How Does it Work?
As we run Discoveries and collect device results we populate the list of networks. The blessed Subnets feature uses this list of networks to only accept data from devices on those networks.
Creating a Network
To make another network go to menu -> Admin -> Networks -> Create Network. Provide a name and an optional description.
IMPORTANT - The network name should be a slash subnet address like 192.168.1.0/24. No spaces between the slash and numbers. It should be a valid subnet address. This string is what is tested against when using Blessed Subnets.
View Network Details
Go to menu -> Admin -> Networks -> List Networks.
You will see a list of available networks. You can view a network by clicking on the it's ID (in green). You can also edit or delete the network.
You will also see a list of the devices in that particular network.
Networks are stored in the database in the "networks" table. A typical entry will look as below.
id: 5
name: 192.168.1.0/24
description:
edited_by: auto-generated by process_component
edited_date: 2016-07-29 13:51:03
API / Web Access?
You can access the /networks 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 | URL Example | Notes | Example Response |
---|---|---|---|---|---|---|
GET | n | collection | /networks | Returns a list of networks. | networks_collection.json | |
GET | y | read | /networks/{id} | Returns a network's details. | networks_read.json | |
PATCH | y | update | /networks/{id} | Update an attribute of a networks entry. | networks_patch.json | |
POST | n | create | /networks | Insert a new networks entry. | networks_create.json | |
DELETE | y | delete | /networks/{id} | Delete a networks entry. | networks_delete.json |
Web Application Routes
Request Method | ID | Action | Resulting Function | URL Example | Notes |
---|---|---|---|---|---|
GET | n | create | create_form | /networks/create | Displays a standard web form for submission to POST /networks. |
GET | y | update | update_form | /networks/{id}/update | Show the networks details with the option to update attributes using PATCH to /networks/{id} |