From 0725df1d4e811d753190651e02b00df539d8547a Mon Sep 17 00:00:00 2001
From: Erik Reid <erik.reid@geant.org>
Date: Thu, 13 Dec 2018 22:37:17 +0100
Subject: [PATCH] updated readme with juniper routes
---
README.md | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 83 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 4c0efb8a..e011d778 100644
--- a/README.md
+++ b/README.md
@@ -159,6 +159,88 @@ Any non-empty responses are JSON formatted messages.
}
```
+* /jobs/interfaces/*`hostname`*
+
+ The response will be a list of information about
+ the interfaces present on the requested host
+ and will be formatted as follows:
+
+ ```json
+ {
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {"type": "string"},
+ "description": {"type": "string"}
+ },
+ "required": ["name", "description"],
+ "additionalProperties": False
+ }
+ }
+ ```
+
+* /jobs/snmp/*`hostname`*
+
+ The response will be a list of information about
+ the interfaces discovered through snmp
+ queries on the requested host
+ and will be formatted as follows:
+
+ ```json
+ {
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "index": {"type": "string"},
+ "name": {"type": "string"}
+ },
+ "required": ["index", "name"],
+ "additionalProperties": False
+ }
+ }
+ ```
+
+* /jobs/bgp/*`hostname`*
+
+ The response will be a list of information about
+ the bgp peerings configured for the requested host
+ and will be formatted as follows:
+
+ ```json
+ {
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "description": {"type": "string"},
+ "as": {
+ "type": "object",
+ "properties": {
+ "peer": {
+ "type": "string",
+ "pattern": r'^\d+$'
+ },
+ "local": {
+ "type": "string",
+ "pattern": r'^\d+$'
+ },
+ },
+ "required": ["peer", "local"],
+ "additionalProperties": False
+ },
+ },
+ "required": ["description", "as"],
+ "additionalProperties": False
+ }
+ }
+ ```
+
* /jobs/update
- This resource updates the inventory network data.
\ No newline at end of file
+ This resource updates the inventory network data for juniper devices.
+
--
GitLab