NetOps Console Server REST API version v2
https://{appliancehost}/api/v2
- appliancehost: required(string)
NetOps Console Server REST API
This API allows control and inspection of an Opengear NetOps Console Server appliance.
/sessions
The sessions endpoint is used to authenticate the user and create a session token for accessing all other NetOps Console Server endpoints.
Create a new authenticated session.
post /sessions
Create a new authenticated session.
Body
Media type: application/json
Type: object
Properties- username: required(string)
- password: required(string)
- new_password: (string)
- confirm_password: (string)
Examples:
example1:
{
"username": "root",
"password": "OGTest1"
}
example2:
{
"username": "root",
"password": "OGTest1",
"new_password": "abcdefg",
"confirm_password": "abcdefg"
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- state: required(string)
- session: required(string)
- user: (string)
- last_challenge: (string)
Example:
{
"state": "authenticated",
"session": "71dcba707b6c177644ede1b224f69096",
"user": "root"
}
HTTP status code 303
Redirect to new authentication session
Body
Media type: application/json
Type: object
Example:
{
"sid": "71dcba707b6c177644ede1b224f69096",
"message": "Redirecting to new session at {redirect-url}"
}
HTTP status code 400
Failed to initiate session creation due to error in post body.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'username' was not provided in the request",
"args": {
"param": "username"
},
"level": 1
},
{
"type": 4,
"code": 40,
"text": "Required field 'password' was not provided in the request",
"args": {
"param": "password"
},
"level": 1
}
]
}
HTTP status code 401
Body
Media type: application/json
Type: object
Examples:
example1:
Authentication failed due to invalid credentials or session.
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid login credentials",
"args": {},
"level": 1
}
]
}
example2:
Authentication failed due to expired credentials.
{
"error": [
{
"type": 7,
"code": 113,
"text": "You are required to change your password immediately",
"args": {},
"level": 1
}
]
}
example3:
Warning that you have HTTPS protection enabled for Brute Force Protection and you may be banned.
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid login credentials",
"args": {},
"level": 1
},
{
"type": 7,
"code": 333,
"text": "3 incorrect login attempts in 1 minute(s) will result in a ban of 60 seconds",
"args": {},
"level": 1
}
]
}
Retrieve the state of an authentication session.
Apply a challenge response to a session
Log out of and delete a session
get /sessions/self
Retrieve the state of an authentication session.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Session exists
Body
Media type: application/json
Type: object
Properties- state: required(string)
- session: required(string)
- user: (string)
- last_challenge: (string)
Example:
{
"state": "authenticated",
"session": "71dcba707b6c177644ede1b224f69096",
"user": "root"
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 404
Session does not exist
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /sessions/self
Apply a challenge response to a session
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- session: required(string)
- state: required(object)
- challenge: required(string)
Next challenge (if any)
HTTP status code 200
Response applied. Next challenge in {challenge} if required.
Body
Media type: application/json
Type: object
Properties- session: required(string)
- state: required(object)
- challenge: required(string)
Next challenge (if any)
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 403
Authentication failed. No more attempts allowed.
HTTP status code 404
Authentication failed.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /sessions/self
Log out of and delete a session
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Session deleted
Body
Media type: application/json
Type: object
Properties- session: required(string)
- success: required(string)
- state: required(string)
- user: required(string)
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Session did not exist
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/ports
Configuring and viewing ports information [no_sorting_required]
Gets ports attached to the NetOps Console Server appliance.
Update properties for all ports attached to the NetOps Console Server appliance.
get /ports
Gets ports attached to the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The array of ports, either a full array or as requested by parameters
Body
Media type: application/json
Type: object
Properties- ports: required(array of object)
Items: items
- parity: required(one of none, odd, even)
The format of the parity byte.
- label: required(string)
The label for the serial port.
- stopbits: required(one of 1, 2)
The number of stop bits between characters.
- portnum: (integer)
The numeric port index (starting from 1) displayed in portmanager. (read-only)
- pinout: required(one of X1, X2, USB)
The physical pinout of the port connector. [enum:available_pinouts]
- ip_alias: (array of object)
An IP address for dedicated access to a specific serial or USB console port. [consoleServer mode only]
Items: items
- ipaddress: required(string)
The IP address to use for the port alias. Supports both IPv4 and IPv6.
- interface: required(string)
The network interface to add the IP alias to. [reference:physif:device]
- ipaddress: required(string)
- baudrate: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The communication rate of the port. [no_sorting_required,enum:available_baudrates]
- logging_level: required(one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
Indicates the logging level for the port. [consoleServer mode only]
- databits: required(one of 7, 8)
The number of data bits in a character.
- escape_char: required(string)
The escape character for pmshell. [consoleServer mode only]
- control_code: (object)
The control characters for pmshell (CTRL + key). These are additional controls (key sequences) that can be added to the built in set of key sequences (escape_char + key) to access pmshell control commands. Example: setting control_code.pmhelp="h" will open the help menu in pmshell when CTRL + h is pressed. [consoleServer mode only]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Generate BREAK (~b) - send a break to the console. [regexerr:Lowercase letters except "i" and "m"]
- portlog: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
View history (~h) - see the traffic logs for the port, must have port logging enabled. [regexerr:Lowercase letters except "i" and "m"]
- power: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Power menu (~p) - open the power menu for the port, port must be associated with a PDU outlet. [regexerr:Lowercase letters except "i" and "m"]
- chooser: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Connect to port menu (~m) - go back to the serial port selection menu. [regexerr:Lowercase letters except "i" and "m"]
- quit: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Exit pmshell (~.) - exit pmshell completely. [regexerr:Lowercase letters except "i" and "m"]
- pmhelp: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Show help message (~?) - shows the help message. [regexerr:Lowercase letters except "i" and "m"]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
- single_session: (boolean)
Limit the port to a single concurrent connection. [consoleServer mode only]
- terminal_emulation: (one of vt100, vt102, vt220, linux, ansi)
The terminal emulation type. [localConsole mode only]
- kernel_debug: (boolean)
Emits kernel debug messages on this serial port. This can only be enabled for serial port 1 on OM12xx. Enabling for any other serial port on an OM12xx, or for any serial port on any other SKU, is an error. [localConsole mode only]
- raw_tcp: (boolean)
Enable or disable raw tcp serial access on this port. Raw tcp access will bypass user authentication and must only be used in a secure environment. [consoleServer mode only]
- mode: required(one of disabled, consoleServer, localConsole, pduDevice)
The mode that the port is in.
- id: required(string)
The ID of the serial port. This ID can be used to fetch individual ports using the /ports/
endpoint. - status: required(one of ok, disconnected)
The external hardware connection status on USB serial ports. If the serial port type is RJ45, then this will always return 'ok'.
- available_pinouts: required(array of string)
Valid values for the "pinout" property of this port. Pinout settings are not applicable for USB ports and must always be set to "USB". In addition, some units do not support pinout switching on all ports and in those cases the pinout must always be set to "X2".
- available_baudrates: required(array of string)
Valid values for the "baudrate" property of this port. The valid baud rates for a port are hardware-dependent.
- sessions: required(array of object)
Items: items
- username: required(string)
The user that opened this port session.
- client_pid: required(integer)
The client process ID of this port session.
- username: required(string)
- device: required(string)
- name: required(string)
- pdu_outlets: (array of object)
A list of PDU outlets associated with this port. [consoleServer mode only]
Items: items
- id: required(string)
The unique identifier for a port to reference an associated outlet.
- outlet_name: required(string)
The name of the outlet on the associated PDU.
- outlet_number: required(integer)
The number of the outlet on the associated PDU.
- outlet_on: required(boolean)
When the 'status' of the outlet is 'on'.
- pdu_id: required(string)
The id of the PDU that is associated with the outlet. [reference:pdu:id]
- pdu_name: required(string)
The name of the PDU that is associated with the outlet. [reference:pdu:name]
- pdu_location: required(string)
The port on the NetOps Console Server that is connected to the PDU associated with the outlet.
- status: required(one of unreachable, on, off)
The power status of the outlet.
- id: required(string)
- parity: required(one of none, odd, even)
Example:
{
"ports": [
{
"parity": "none",
"label": "Port-1",
"id": "ports-1",
"escape_char": "~",
"control_code": null,
"stopbits": "1",
"status": "ok",
"portnum": 1,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": null,
"pdu_outlets": null,
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "localConsole",
"logging_level": "disabled",
"databits": "8",
"single_session": false,
"raw_tcp": false,
"terminal_emulation": "linux",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port01",
"name": "port01"
},
{
"parity": "none",
"label": "Port-2",
"id": "ports-2",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 2,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"single_session": false,
"raw_tcp": false,
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port02",
"name": "port02"
},
{
"parity": "none",
"label": "Port-3",
"id": "ports-3",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 3,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [
{
"id": "ipalias-1",
"port": "serial/by-opengear-id/port03",
"ipaddress": "192.168.33.11/24",
"interface": "net1"
}
],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"single_session": false,
"raw_tcp": false,
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port03",
"name": "port03"
},
{
"parity": "none",
"label": "Port-4",
"id": "ports-4",
"escape_char": "~",
"control_code": null,
"stopbits": "1",
"status": "ok",
"portnum": 4,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": null,
"pdu_outlets": null,
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "localConsole",
"logging_level": "disabled",
"databits": "8",
"single_session": false,
"raw_tcp": false,
"terminal_emulation": "vt220",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port04",
"name": "port04"
},
{
"parity": "none",
"label": "Port-5",
"id": "ports-5",
"escape_char": "~",
"control_code": null,
"stopbits": "1",
"status": "ok",
"portnum": 5,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": null,
"pdu_outlets": null,
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "disabled",
"logging_level": "disabled",
"databits": "8",
"single_session": false,
"raw_tcp": false,
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port05",
"name": "port05"
},
{
"parity": "none",
"label": "Port-6",
"id": "ports-6",
"escape_char": "~",
"control_code": null,
"stopbits": "1",
"status": "ok",
"portnum": 6,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": null,
"pdu_outlets": null,
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "pduDevice",
"logging_level": "disabled",
"databits": "8",
"single_session": false,
"raw_tcp": false,
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port06",
"name": "por06"
},
{
"parity": "none",
"label": "Port-7",
"id": "ports-7",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 7,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"pdu_outlets": [
{
"id": "ports-7_pdus_outlets-1",
"outlet_name": "Test-PDU-Outlet-1",
"outlet_number": 1,
"outlet_on": false,
"pdu_id": "pdus-1",
"pdu_location": "Port 6",
"pdu_name": "Test-PDU",
"status": "unreachable"
},
{
"id": "ports-7_pdus_outlets-2",
"outlet_name": "Test-PDU-Outlet-2",
"outlet_number": 2,
"outlet_on": true,
"pdu_id": "pdus-1",
"pdu_location": "Port 6",
"pdu_name": "Test-PDU",
"status": "on"
}
],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"single_session": false,
"raw_tcp": false,
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port07",
"name": "port07"
},
{
"parity": "none",
"label": "Port-8",
"id": "ports-8",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 8,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"single_session": false,
"raw_tcp": false,
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port08",
"name": "port08"
},
{
"parity": "none",
"label": "Port-9",
"id": "ports-9",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 9,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"single_session": false,
"raw_tcp": false,
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port09",
"name": "port09"
},
{
"parity": "none",
"label": "USB A",
"id": "USB-A",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "disconnected",
"portnum": 10,
"pinout": "USB",
"available_pinouts": [
"USB"
],
"ip_alias": [],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"single_session": false,
"raw_tcp": false,
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/USB-A",
"name": "USB-A"
}
]
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 404
Invalid request, Incomplete data, Port not found, Failure during retrieval of ports
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Failed to read ports.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /ports
Update properties for all ports attached to the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- ports: required(array of object)
Items: items
- parity: required(one of none, odd, even)
The format of the parity byte.
- label: required(string)
The label for the serial port.
- stopbits: required(one of 1, 2)
The number of stop bits between characters.
- portnum: (integer)
The numeric port index (starting from 1) displayed in portmanager. (read-only)
- pinout: required(one of X1, X2, USB)
The physical pinout of the port connector. [enum:available_pinouts]
- ip_alias: (array of object)
An IP address for dedicated access to a specific serial or USB console port. [consoleServer mode only]
Items: items
- ipaddress: required(string)
The IP address to use for the port alias. Supports both IPv4 and IPv6.
- interface: required(string)
The network interface to add the IP alias to. [reference:physif:device]
- ipaddress: required(string)
- baudrate: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The communication rate of the port. [no_sorting_required,enum:available_baudrates]
- logging_level: required(one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
Indicates the logging level for the port. [consoleServer mode only]
- databits: required(one of 7, 8)
The number of data bits in a character.
- escape_char: required(string)
The escape character for pmshell. [consoleServer mode only]
- control_code: (object)
The control characters for pmshell (CTRL + key). These are additional controls (key sequences) that can be added to the built in set of key sequences (escape_char + key) to access pmshell control commands. Example: setting control_code.pmhelp="h" will open the help menu in pmshell when CTRL + h is pressed. [consoleServer mode only]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Generate BREAK (~b) - send a break to the console. [regexerr:Lowercase letters except "i" and "m"]
- portlog: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
View history (~h) - see the traffic logs for the port, must have port logging enabled. [regexerr:Lowercase letters except "i" and "m"]
- power: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Power menu (~p) - open the power menu for the port, port must be associated with a PDU outlet. [regexerr:Lowercase letters except "i" and "m"]
- chooser: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Connect to port menu (~m) - go back to the serial port selection menu. [regexerr:Lowercase letters except "i" and "m"]
- quit: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Exit pmshell (~.) - exit pmshell completely. [regexerr:Lowercase letters except "i" and "m"]
- pmhelp: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Show help message (~?) - shows the help message. [regexerr:Lowercase letters except "i" and "m"]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
- single_session: (boolean)
Limit the port to a single concurrent connection. [consoleServer mode only]
- terminal_emulation: (one of vt100, vt102, vt220, linux, ansi)
The terminal emulation type. [localConsole mode only]
- kernel_debug: (boolean)
Emits kernel debug messages on this serial port. This can only be enabled for serial port 1 on OM12xx. Enabling for any other serial port on an OM12xx, or for any serial port on any other SKU, is an error. [localConsole mode only]
- raw_tcp: (boolean)
Enable or disable raw tcp serial access on this port. Raw tcp access will bypass user authentication and must only be used in a secure environment. [consoleServer mode only]
- mode: required(string)
The mode that the port is in. [computed_options:port_modes]
- parity: required(one of none, odd, even)
Example:
{
"ports": [
{
"parity": "none",
"label": "Port-1",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"pinout": "X2",
"ip_alias": [
{
"ipaddress": "192.168.33.201/24",
"interface": "net1"
}
],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8"
},
{
"parity": "none",
"label": "Port-2",
"escape_char": "~",
"stopbits": "1",
"pinout": "X2",
"baudrate": "9600",
"mode": "localConsole",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "linux",
"kernel_debug": true
},
{
"parity": "none",
"label": "Port-3",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"pinout": "X2",
"ip_alias": [
{
"ipaddress": "192.168.33.11/24",
"interface": "net1"
}
],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8"
},
{
"parity": "none",
"label": "Port-4",
"escape_char": "~",
"stopbits": "1",
"pinout": "X2",
"baudrate": "9600",
"mode": "localConsole",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "vt220",
"kernel_debug": false
},
{
"parity": "none",
"label": "Port-5",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"pinout": "X2",
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8"
},
{
"parity": "none",
"label": "Port-6",
"escape_char": "~",
"stopbits": "1",
"pinout": "X2",
"baudrate": "9600",
"mode": "disabled",
"logging_level": "disabled",
"databits": "8"
},
{
"parity": "none",
"label": "Port-7",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"pinout": "X2",
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8"
},
{
"parity": "none",
"label": "Port-8",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"pinout": "X2",
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8"
},
{
"parity": "none",
"label": "Port-9",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"pinout": "X2",
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8"
},
{
"parity": "none",
"label": "USB A",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"pinout": "USB",
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8"
}
]
}
HTTP status code 200
The array of ports, either a full array or as requested by parameters
Body
Media type: application/json
Type: object
Properties- ports: required(array of object)
Items: items
- parity: required(one of none, odd, even)
The format of the parity byte.
- label: required(string)
The label for the serial port.
- stopbits: required(one of 1, 2)
The number of stop bits between characters.
- portnum: (integer)
The numeric port index (starting from 1) displayed in portmanager. (read-only)
- pinout: required(one of X1, X2, USB)
The physical pinout of the port connector. [enum:available_pinouts]
- ip_alias: (array of object)
An IP address for dedicated access to a specific serial or USB console port. [consoleServer mode only]
Items: items
- ipaddress: required(string)
The IP address to use for the port alias. Supports both IPv4 and IPv6.
- interface: required(string)
The network interface to add the IP alias to. [reference:physif:device]
- ipaddress: required(string)
- baudrate: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The communication rate of the port. [no_sorting_required,enum:available_baudrates]
- logging_level: required(one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
Indicates the logging level for the port. [consoleServer mode only]
- databits: required(one of 7, 8)
The number of data bits in a character.
- escape_char: required(string)
The escape character for pmshell. [consoleServer mode only]
- control_code: (object)
The control characters for pmshell (CTRL + key). These are additional controls (key sequences) that can be added to the built in set of key sequences (escape_char + key) to access pmshell control commands. Example: setting control_code.pmhelp="h" will open the help menu in pmshell when CTRL + h is pressed. [consoleServer mode only]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Generate BREAK (~b) - send a break to the console. [regexerr:Lowercase letters except "i" and "m"]
- portlog: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
View history (~h) - see the traffic logs for the port, must have port logging enabled. [regexerr:Lowercase letters except "i" and "m"]
- power: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Power menu (~p) - open the power menu for the port, port must be associated with a PDU outlet. [regexerr:Lowercase letters except "i" and "m"]
- chooser: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Connect to port menu (~m) - go back to the serial port selection menu. [regexerr:Lowercase letters except "i" and "m"]
- quit: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Exit pmshell (~.) - exit pmshell completely. [regexerr:Lowercase letters except "i" and "m"]
- pmhelp: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Show help message (~?) - shows the help message. [regexerr:Lowercase letters except "i" and "m"]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
- single_session: (boolean)
Limit the port to a single concurrent connection. [consoleServer mode only]
- terminal_emulation: (one of vt100, vt102, vt220, linux, ansi)
The terminal emulation type. [localConsole mode only]
- kernel_debug: (boolean)
Emits kernel debug messages on this serial port. This can only be enabled for serial port 1 on OM12xx. Enabling for any other serial port on an OM12xx, or for any serial port on any other SKU, is an error. [localConsole mode only]
- raw_tcp: (boolean)
Enable or disable raw tcp serial access on this port. Raw tcp access will bypass user authentication and must only be used in a secure environment. [consoleServer mode only]
- mode: required(one of disabled, consoleServer, localConsole, pduDevice)
The mode that the port is in.
- id: required(string)
The ID of the serial port. This ID can be used to fetch individual ports using the /ports/
endpoint. - status: required(one of ok, disconnected)
The external hardware connection status on USB serial ports. If the serial port type is RJ45, then this will always return 'ok'.
- available_pinouts: required(array of string)
Valid values for the "pinout" property of this port. Pinout settings are not applicable for USB ports and must always be set to "USB". In addition, some units do not support pinout switching on all ports and in those cases the pinout must always be set to "X2".
- available_baudrates: required(array of string)
Valid values for the "baudrate" property of this port. The valid baud rates for a port are hardware-dependent.
- sessions: required(array of object)
Items: items
- username: required(string)
The user that opened this port session.
- client_pid: required(integer)
The client process ID of this port session.
- username: required(string)
- device: required(string)
- name: required(string)
- pdu_outlets: (array of object)
A list of PDU outlets associated with this port. [consoleServer mode only]
Items: items
- id: required(string)
The unique identifier for a port to reference an associated outlet.
- outlet_name: required(string)
The name of the outlet on the associated PDU.
- outlet_number: required(integer)
The number of the outlet on the associated PDU.
- outlet_on: required(boolean)
When the 'status' of the outlet is 'on'.
- pdu_id: required(string)
The id of the PDU that is associated with the outlet. [reference:pdu:id]
- pdu_name: required(string)
The name of the PDU that is associated with the outlet. [reference:pdu:name]
- pdu_location: required(string)
The port on the NetOps Console Server that is connected to the PDU associated with the outlet.
- status: required(one of unreachable, on, off)
The power status of the outlet.
- id: required(string)
- parity: required(one of none, odd, even)
Example:
{
"ports": [
{
"parity": "none",
"label": "Port-1",
"id": "ports-1",
"escape_char": "",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 1,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [
{
"id": "ipalias-1",
"port": "serial/by-opengear-id/port01",
"ipaddress": "192.168.33.201/24",
"interface": "net1"
}
],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port01",
"name": "port01"
},
{
"parity": "none",
"label": "Port-2",
"id": "ports-2",
"escape_char": "~",
"control_code": null,
"stopbits": "1",
"status": "ok",
"portnum": 2,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": null,
"pdu_outlets": null,
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "localConsole",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "linux",
"kernel_debug": true,
"sessions": [],
"device": "serial/by-opengear-id/port02",
"name": "port02"
},
{
"parity": "none",
"label": "Port-3",
"id": "ports-3",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 3,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [
{
"id": "ipalias-1",
"port": "serial/by-opengear-id/port03",
"ipaddress": "192.168.33.11/24",
"interface": "net1"
}
],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port03",
"name": "port03"
},
{
"parity": "none",
"label": "Port-4",
"id": "ports-4",
"escape_char": "~",
"control_code": null,
"stopbits": "1",
"status": "ok",
"portnum": 4,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": null,
"pdu_outlets": null,
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "localConsole",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "vt220",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port04",
"name": "port04"
},
{
"parity": "none",
"label": "Port-5",
"id": "ports-5",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 5,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port05",
"name": "port05"
},
{
"parity": "none",
"label": "Port-6",
"id": "ports-6",
"escape_char": "~",
"control_code": null,
"stopbits": "1",
"status": "ok",
"portnum": 6,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": null,
"pdu_outlets": null,
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "disabled",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port06",
"name": "port06"
},
{
"parity": "none",
"label": "Port-7",
"id": "ports-7",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 7,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port07",
"name": "port07"
},
{
"parity": "none",
"label": "Port-8",
"id": "ports-8",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 8,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port08",
"name": "port08"
},
{
"parity": "none",
"label": "Port-9",
"id": "ports-9",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 9,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port09",
"name": "port09"
},
{
"parity": "none",
"label": "USB A",
"id": "USB-A",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "disconnected",
"portnum": 10,
"pinout": "USB",
"available_pinouts": [
"USB"
],
"ip_alias": [],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/USB-A",
"name": "USB-A"
}
]
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Invalid request, Incomplete data, Port not found, Failure during retrieval of ports
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Failed to read ports.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Viewing and deleting of any active session on a specific port.
Retrieve a single port by ID.
Set the properties for a single port.
get /ports/{id}
Retrieve a single port by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Port has been updated.
Body
Media type: application/json
Type: object
Properties- port: required(object)
- parity: required(one of none, odd, even)
The format of the parity byte.
- label: required(string)
The label for the serial port.
- stopbits: required(one of 1, 2)
The number of stop bits between characters.
- portnum: (integer)
The numeric port index (starting from 1) displayed in portmanager. (read-only)
- pinout: required(one of X1, X2, USB)
The physical pinout of the port connector. [enum:available_pinouts]
- ip_alias: (array of object)
An IP address for dedicated access to a specific serial or USB console port. [consoleServer mode only]
Items: items
- ipaddress: required(string)
The IP address to use for the port alias. Supports both IPv4 and IPv6.
- interface: required(string)
The network interface to add the IP alias to. [reference:physif:device]
- ipaddress: required(string)
- baudrate: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The communication rate of the port. [no_sorting_required,enum:available_baudrates]
- logging_level: required(one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
Indicates the logging level for the port. [consoleServer mode only]
- databits: required(one of 7, 8)
The number of data bits in a character.
- escape_char: required(string)
The escape character for pmshell. [consoleServer mode only]
- control_code: (object)
The control characters for pmshell (CTRL + key). These are additional controls (key sequences) that can be added to the built in set of key sequences (escape_char + key) to access pmshell control commands. Example: setting control_code.pmhelp="h" will open the help menu in pmshell when CTRL + h is pressed. [consoleServer mode only]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Generate BREAK (~b) - send a break to the console. [regexerr:Lowercase letters except "i" and "m"]
- portlog: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
View history (~h) - see the traffic logs for the port, must have port logging enabled. [regexerr:Lowercase letters except "i" and "m"]
- power: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Power menu (~p) - open the power menu for the port, port must be associated with a PDU outlet. [regexerr:Lowercase letters except "i" and "m"]
- chooser: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Connect to port menu (~m) - go back to the serial port selection menu. [regexerr:Lowercase letters except "i" and "m"]
- quit: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Exit pmshell (~.) - exit pmshell completely. [regexerr:Lowercase letters except "i" and "m"]
- pmhelp: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Show help message (~?) - shows the help message. [regexerr:Lowercase letters except "i" and "m"]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
- single_session: (boolean)
Limit the port to a single concurrent connection. [consoleServer mode only]
- terminal_emulation: (one of vt100, vt102, vt220, linux, ansi)
The terminal emulation type. [localConsole mode only]
- kernel_debug: (boolean)
Emits kernel debug messages on this serial port. This can only be enabled for serial port 1 on OM12xx. Enabling for any other serial port on an OM12xx, or for any serial port on any other SKU, is an error. [localConsole mode only]
- raw_tcp: (boolean)
Enable or disable raw tcp serial access on this port. Raw tcp access will bypass user authentication and must only be used in a secure environment. [consoleServer mode only]
- mode: required(one of disabled, consoleServer, localConsole, pduDevice)
The mode that the port is in.
- id: required(string)
The ID of the serial port. This ID can be used to fetch individual ports using the /ports/
endpoint. - status: required(one of ok, disconnected)
The external hardware connection status on USB serial ports. If the serial port type is RJ45, then this will always return 'ok'.
- available_pinouts: required(array of string)
Valid values for the "pinout" property of this port. Pinout settings are not applicable for USB ports and must always be set to "USB". In addition, some units do not support pinout switching on all ports and in those cases the pinout must always be set to "X2".
- available_baudrates: required(array of string)
Valid values for the "baudrate" property of this port. The valid baud rates for a port are hardware-dependent.
- sessions: required(array of object)
Items: items
- username: required(string)
The user that opened this port session.
- client_pid: required(integer)
The client process ID of this port session.
- username: required(string)
- device: required(string)
- name: required(string)
- pdu_outlets: (array of object)
A list of PDU outlets associated with this port. [consoleServer mode only]
Items: items
- id: required(string)
The unique identifier for a port to reference an associated outlet.
- outlet_name: required(string)
The name of the outlet on the associated PDU.
- outlet_number: required(integer)
The number of the outlet on the associated PDU.
- outlet_on: required(boolean)
When the 'status' of the outlet is 'on'.
- pdu_id: required(string)
The id of the PDU that is associated with the outlet. [reference:pdu:id]
- pdu_name: required(string)
The name of the PDU that is associated with the outlet. [reference:pdu:name]
- pdu_location: required(string)
The port on the NetOps Console Server that is connected to the PDU associated with the outlet.
- status: required(one of unreachable, on, off)
The power status of the outlet.
- id: required(string)
- parity: required(one of none, odd, even)
Example:
{
"port": {
"parity": "none",
"label": "Port-1",
"id": "ports-1",
"escape_char": "~",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 1,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [
{
"id": "ipalias-1",
"port": "serial/by-opengear-id/port01",
"ipaddress": "192.168.33.201/24",
"interface": "net1"
},
{
"id": "ipalias-2",
"port": "serial/by-opengear-id/port01",
"ipaddress": "192.168.33.9/24",
"interface": "net1"
}
],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port01",
"name": "port01"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /ports/{id}
Set the properties for a single port.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- port: required(object)
- parity: required(one of none, odd, even)
The format of the parity byte.
- label: required(string)
The label for the serial port.
- stopbits: required(one of 1, 2)
The number of stop bits between characters.
- portnum: (integer)
The numeric port index (starting from 1) displayed in portmanager. (read-only)
- pinout: required(one of X1, X2, USB)
The physical pinout of the port connector. [enum:available_pinouts]
- ip_alias: (array of object)
An IP address for dedicated access to a specific serial or USB console port. [consoleServer mode only]
Items: items
- ipaddress: required(string)
The IP address to use for the port alias. Supports both IPv4 and IPv6.
- interface: required(string)
The network interface to add the IP alias to. [reference:physif:device]
- ipaddress: required(string)
- baudrate: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The communication rate of the port. [no_sorting_required,enum:available_baudrates]
- logging_level: required(one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
Indicates the logging level for the port. [consoleServer mode only]
- databits: required(one of 7, 8)
The number of data bits in a character.
- escape_char: required(string)
The escape character for pmshell. [consoleServer mode only]
- control_code: (object)
The control characters for pmshell (CTRL + key). These are additional controls (key sequences) that can be added to the built in set of key sequences (escape_char + key) to access pmshell control commands. Example: setting control_code.pmhelp="h" will open the help menu in pmshell when CTRL + h is pressed. [consoleServer mode only]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Generate BREAK (~b) - send a break to the console. [regexerr:Lowercase letters except "i" and "m"]
- portlog: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
View history (~h) - see the traffic logs for the port, must have port logging enabled. [regexerr:Lowercase letters except "i" and "m"]
- power: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Power menu (~p) - open the power menu for the port, port must be associated with a PDU outlet. [regexerr:Lowercase letters except "i" and "m"]
- chooser: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Connect to port menu (~m) - go back to the serial port selection menu. [regexerr:Lowercase letters except "i" and "m"]
- quit: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Exit pmshell (~.) - exit pmshell completely. [regexerr:Lowercase letters except "i" and "m"]
- pmhelp: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Show help message (~?) - shows the help message. [regexerr:Lowercase letters except "i" and "m"]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
- single_session: (boolean)
Limit the port to a single concurrent connection. [consoleServer mode only]
- terminal_emulation: (one of vt100, vt102, vt220, linux, ansi)
The terminal emulation type. [localConsole mode only]
- kernel_debug: (boolean)
Emits kernel debug messages on this serial port. This can only be enabled for serial port 1 on OM12xx. Enabling for any other serial port on an OM12xx, or for any serial port on any other SKU, is an error. [localConsole mode only]
- raw_tcp: (boolean)
Enable or disable raw tcp serial access on this port. Raw tcp access will bypass user authentication and must only be used in a secure environment. [consoleServer mode only]
- mode: required(string)
The mode that the port is in. [computed_options:port_modes]
- parity: required(one of none, odd, even)
Example:
{
"port": {
"parity": "none",
"label": "Port-1",
"stopbits": "1",
"pinout": "X2",
"ip_alias": [
{
"ipaddress": "192.168.33.201/24",
"interface": "net1"
},
{
"ipaddress": "192.168.33.9/24",
"interface": "net1"
}
],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"escape_char": "!",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
}
}
}
HTTP status code 200
Port has been updated.
Body
Media type: application/json
Type: object
Properties- port: required(object)
- parity: required(one of none, odd, even)
The format of the parity byte.
- label: required(string)
The label for the serial port.
- stopbits: required(one of 1, 2)
The number of stop bits between characters.
- portnum: (integer)
The numeric port index (starting from 1) displayed in portmanager. (read-only)
- pinout: required(one of X1, X2, USB)
The physical pinout of the port connector. [enum:available_pinouts]
- ip_alias: (array of object)
An IP address for dedicated access to a specific serial or USB console port. [consoleServer mode only]
Items: items
- ipaddress: required(string)
The IP address to use for the port alias. Supports both IPv4 and IPv6.
- interface: required(string)
The network interface to add the IP alias to. [reference:physif:device]
- ipaddress: required(string)
- baudrate: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The communication rate of the port. [no_sorting_required,enum:available_baudrates]
- logging_level: required(one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
Indicates the logging level for the port. [consoleServer mode only]
- databits: required(one of 7, 8)
The number of data bits in a character.
- escape_char: required(string)
The escape character for pmshell. [consoleServer mode only]
- control_code: (object)
The control characters for pmshell (CTRL + key). These are additional controls (key sequences) that can be added to the built in set of key sequences (escape_char + key) to access pmshell control commands. Example: setting control_code.pmhelp="h" will open the help menu in pmshell when CTRL + h is pressed. [consoleServer mode only]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Generate BREAK (~b) - send a break to the console. [regexerr:Lowercase letters except "i" and "m"]
- portlog: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
View history (~h) - see the traffic logs for the port, must have port logging enabled. [regexerr:Lowercase letters except "i" and "m"]
- power: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Power menu (~p) - open the power menu for the port, port must be associated with a PDU outlet. [regexerr:Lowercase letters except "i" and "m"]
- chooser: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Connect to port menu (~m) - go back to the serial port selection menu. [regexerr:Lowercase letters except "i" and "m"]
- quit: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Exit pmshell (~.) - exit pmshell completely. [regexerr:Lowercase letters except "i" and "m"]
- pmhelp: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
Show help message (~?) - shows the help message. [regexerr:Lowercase letters except "i" and "m"]
- break: (string - maxLength: 1 - pattern: ^[a-h,j-l,n-z]*$)
- single_session: (boolean)
Limit the port to a single concurrent connection. [consoleServer mode only]
- terminal_emulation: (one of vt100, vt102, vt220, linux, ansi)
The terminal emulation type. [localConsole mode only]
- kernel_debug: (boolean)
Emits kernel debug messages on this serial port. This can only be enabled for serial port 1 on OM12xx. Enabling for any other serial port on an OM12xx, or for any serial port on any other SKU, is an error. [localConsole mode only]
- raw_tcp: (boolean)
Enable or disable raw tcp serial access on this port. Raw tcp access will bypass user authentication and must only be used in a secure environment. [consoleServer mode only]
- mode: required(one of disabled, consoleServer, localConsole, pduDevice)
The mode that the port is in.
- id: required(string)
The ID of the serial port. This ID can be used to fetch individual ports using the /ports/
endpoint. - status: required(one of ok, disconnected)
The external hardware connection status on USB serial ports. If the serial port type is RJ45, then this will always return 'ok'.
- available_pinouts: required(array of string)
Valid values for the "pinout" property of this port. Pinout settings are not applicable for USB ports and must always be set to "USB". In addition, some units do not support pinout switching on all ports and in those cases the pinout must always be set to "X2".
- available_baudrates: required(array of string)
Valid values for the "baudrate" property of this port. The valid baud rates for a port are hardware-dependent.
- sessions: required(array of object)
Items: items
- username: required(string)
The user that opened this port session.
- client_pid: required(integer)
The client process ID of this port session.
- username: required(string)
- device: required(string)
- name: required(string)
- pdu_outlets: (array of object)
A list of PDU outlets associated with this port. [consoleServer mode only]
Items: items
- id: required(string)
The unique identifier for a port to reference an associated outlet.
- outlet_name: required(string)
The name of the outlet on the associated PDU.
- outlet_number: required(integer)
The number of the outlet on the associated PDU.
- outlet_on: required(boolean)
When the 'status' of the outlet is 'on'.
- pdu_id: required(string)
The id of the PDU that is associated with the outlet. [reference:pdu:id]
- pdu_name: required(string)
The name of the PDU that is associated with the outlet. [reference:pdu:name]
- pdu_location: required(string)
The port on the NetOps Console Server that is connected to the PDU associated with the outlet.
- status: required(one of unreachable, on, off)
The power status of the outlet.
- id: required(string)
- parity: required(one of none, odd, even)
Example:
{
"port": {
"parity": "none",
"label": "Port-1",
"id": "ports-1",
"escape_char": "!",
"control_code": {
"break": "b",
"portlog": "l",
"power": "p",
"chooser": "c",
"quit": "q",
"pmhelp": "h"
},
"stopbits": "1",
"status": "ok",
"portnum": 1,
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [
{
"id": "ipalias-1",
"port": "serial/by-opengear-id/port01",
"ipaddress": "192.168.33.201/24",
"interface": "net1"
},
{
"id": "ipalias-2",
"port": "serial/by-opengear-id/port01",
"ipaddress": "192.168.33.9/24",
"interface": "net1"
}
],
"pdu_outlets": [],
"baudrate": "9600",
"available_baudrates": [
"9600",
"115200"
],
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": null,
"kernel_debug": null,
"sessions": [],
"device": "serial/by-opengear-id/port01",
"name": "port01"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve all active sessions on this port.
Disconnect active sessions on this port. Use query parameters to select a subset of sessions for disconnection. If no query parameters are given, all sessions on this port will be disconnected.
get /ports/{id}/sessions
Retrieve all active sessions on this port.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- port_sessions: required(array of object)
Items: items
- username: required(string)
The user that opened this port session.
- client_pid: required(integer)
The client process ID of this port session.
- username: required(string)
Example:
{
"port_sessions": [
{
"username": "alice",
"client_pid": 123
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 404
Port does not exist.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /ports/{id}/sessions
Disconnect active sessions on this port. Use query parameters to select a subset of sessions for disconnection. If no query parameters are given, all sessions on this port will be disconnected.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- username: (string)
Only disconnect active sessions belonging to this user.
HTTP status code 200
Request succeeded. Note that if there were no active sessions to be disconnected, the request is nevertheless successful. Check the 'disconnected_session_count' field of the response body to determine how many sessions were disconnected.
Body
Media type: application/json
Type: object
Properties- disconnected_session_count: required(integer)
Example:
{
"disconnected_session_count": 1
}
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Port does not exist.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve an active session on this port.
Disconnect the session.
get /ports/{id}/sessions/{pid}
Retrieve an active session on this port.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
- pid: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- port_session: required(object)
- username: required(string)
The user that opened this port session.
- client_pid: required(integer)
The client process ID of this port session.
- username: required(string)
Example:
{
"port_session": {
"username": "alice",
"client_pid": 123
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 404
Port does not exist, or active session with the given pid does not exist.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /ports/{id}/sessions/{pid}
Disconnect the session.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
- pid: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Request succeeded.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Port does not exist, or active session with the given pid does not exist.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Control power for a console device.
put /ports/{id}/power
Control power for a console device.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- cmd: required(object)
- action: required(one of on, off, cycle, status)
Example:
{
"cmd": {
"action": "cycle"
}
}
HTTP status code 200
Power command executed.
Body
Media type: application/json
Type: object
Properties- cmd: required(string)
Example:
{
"cmd": "/usr/bin/ogpowergroup 'port16' cycle"
}
HTTP status code 400
Power command failed.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 307,
"level": 1,
"text": "ogpower failed running command '/usr/bin/ogpowergroup 'port02' cycle'",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Reset the tx/rx counters for a particular serial port.
post /ports/{id}/reset_counters
Reset the tx/rx counters for a particular serial port.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The counter reset was successfully performed.
Body
Media type: application/json
Type: object
Properties- reset_port: required(object)
- port_id: required(string)
port ID for the port which the tx/rx counters were reset
- tx: required(integer)
Newly reset TX data count for this port
- rx: required(integer)
Newly reset RX data count for this port
- port_id: required(string)
Example:
{
"reset_port": {
"port_id": "ports-1",
"tx": 0,
"rx": 0
}
}
HTTP status code 400
Resetting tx/rx data counters for serial port failed.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 307,
"level": 1,
"text": "The device encountered an issue while attempting to reset TX/RX data counters on port 16",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Manage Port Auto-Discovery
Trigger the port Auto-Discovery process
Cancel an Auto-Discovery job
Get Port Auto-Discovery state
post /ports/auto_discover
Trigger the port Auto-Discovery process
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Possible types:
portAutoDiscoveryParameters
- auto_discover: required(object)
The Port Auto-Discovery root object
- ports: required(array of integer)
The list of ports (as integers) to discover. Setting this value to null will result in all ports being set for Auto-Discovery.
- username: (string)
The username that port discovery will use when attempting to login
- password: (string)
The password that port discovery will use when attempting to login [sensitive]
- apply_config: (boolean - default: true)
Port discovery will store the discovered settings when this flag is true
- auth_timeout: (integer - default: 0 - minimum: 0 - maximum: 600)
Authentication Timeout in seconds. When the value is 0, port discovery will use it's default timeout settings
- hostname_pattern: (string - default: )
Regex Pattern to match on a hostname label. When empty, port_discovery will use it's default hostname pattern settings (".+")
Example:
.+
- ports: required(array of integer)
- auto_discover: required(object)
portAutoDiscoveryParameters
- auto_discover: required(object)
The Port Auto-Discovery root object
- ports: required(nil)
The list of ports (as integers) to discover. Setting this value to null will result in all ports being set for Auto-Discovery.
- username: (string)
The username that port discovery will use when attempting to login
- password: (string)
The password that port discovery will use when attempting to login [sensitive]
- apply_config: (boolean - default: true)
Port discovery will store the discovered settings when this flag is true
- auth_timeout: (integer - default: 0 - minimum: 0 - maximum: 600)
Authentication Timeout in seconds. When the value is 0, port discovery will use it's default timeout settings
- hostname_pattern: (string - default: )
Regex Pattern to match on a hostname label. When empty, port_discovery will use it's default hostname pattern settings (".+")
Example:
.+
- ports: required(nil)
- auto_discover: required(object)
Examples:
example1:
Run Port Auto-Discover on all available ports
{
"auto_discover": {
"ports": null
}
}
example2:
Run Port Auto-Discover on all available ports
{
"auto_discover": {
"ports": []
}
}
example3:
Run Auto-Disover on ports 1, 10, 33, and 42
{
"auto_discover": {
"ports": [
1,
10,
33,
42
]
}
}
HTTP status code 200
Port Auto-Discovery was triggered
Body
Media type: application/json
Possible types:
portAutoDiscoveryParameters
- auto_discover: required(object)
The Port Auto-Discovery root object
- ports: required(array of integer)
The list of ports (as integers) to discover. Setting this value to null will result in all ports being set for Auto-Discovery.
- username: (string)
The username that port discovery will use when attempting to login
- password: (string)
The password that port discovery will use when attempting to login [sensitive]
- apply_config: (boolean - default: true)
Port discovery will store the discovered settings when this flag is true
- auth_timeout: (integer - default: 0 - minimum: 0 - maximum: 600)
Authentication Timeout in seconds. When the value is 0, port discovery will use it's default timeout settings
- hostname_pattern: (string - default: )
Regex Pattern to match on a hostname label. When empty, port_discovery will use it's default hostname pattern settings (".+")
Example:
.+
- ports: required(array of integer)
- auto_discover: required(object)
portAutoDiscoveryParameters
- auto_discover: required(object)
The Port Auto-Discovery root object
- ports: required(nil)
The list of ports (as integers) to discover. Setting this value to null will result in all ports being set for Auto-Discovery.
- username: (string)
The username that port discovery will use when attempting to login
- password: (string)
The password that port discovery will use when attempting to login [sensitive]
- apply_config: (boolean - default: true)
Port discovery will store the discovered settings when this flag is true
- auth_timeout: (integer - default: 0 - minimum: 0 - maximum: 600)
Authentication Timeout in seconds. When the value is 0, port discovery will use it's default timeout settings
- hostname_pattern: (string - default: )
Regex Pattern to match on a hostname label. When empty, port_discovery will use it's default hostname pattern settings (".+")
Example:
.+
- ports: required(nil)
- auto_discover: required(object)
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /ports/auto_discover
Cancel an Auto-Discovery job
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 202
Accepted. Request sent for the job to stop.
HTTP status code 204
No Content. Auto-Discovery job is stopped.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
get /ports/auto_discover
Get Port Auto-Discovery state
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The Port Auto-Discovery script state
Body
Media type: application/json
Type: object
Properties- auto_discover: required(object)
The Port Auto-Discovery root object
- status: required(string)
The status, as returned by the Port Auto-Discover process
- status: required(string)
Example:
{
"auto_discover": {
"status": "running"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Manage Port Auto-Discovery Scheduling
Schedule the Port Auto-Discovery process
Get the Port Auto-Discovery schedule
put /ports/auto_discover/schedule
Schedule the Port Auto-Discovery process
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Possible types:
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
Controls if periodic port auto-discovery is active.
- username: (string)
The username that port discovery will use when attempting to login
- password: (string)
The password that port discovery will use when attempting to login [sensitive]
- apply_config: (boolean - default: true)
Port discovery will store the discovered settings when this flag is true
- auth_timeout: (integer - default: 0 - minimum: 0 - maximum: 600)
Authentication Timeout in seconds. When the value is 0, port discovery will use it's default timeout settings
- hostname_pattern: (string - default: )
Regex Pattern to match on a hostname label. When empty, port_discovery will use it's default hostname pattern settings (".+")
Example:
.+
- period: required(one of daily, weekly, monthly)
Specify the frequency type for the schedule.
- day_of_month: (integer - minimum: 1 - maximum: 31)
The day of the month to perform discovery on. Valid values are 1 to 31. Be aware that values over 28 means discovery will not run on some months. [visible:period:=:monthly,required:period:=:monthly]
- day_of_week: (integer - minimum: 0 - maximum: 6)
The day of the week to perform discovery on. Valid values are 0 (Sunday) to 6 (Saturday). [visible:period:=:weekly,required:period:=:weekly]
- hour: required(integer - minimum: 0 - maximum: 23)
The hour of the day to perform discovery on. Valid values are 0 to 23.
- minute: required(integer - minimum: 0 - maximum: 59)
The minute of the hour to perform discovery on. Valid values are 0 to 59.
- ports: (array of array)
The list of ports (as devices) to discover. [computed_options:port_consoleservers_all]
- enabled: required(boolean - default: false)
- auto_discover_schedule: required(object)
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
Controls if periodic port auto-discovery is active.
- username: (string)
The username that port discovery will use when attempting to login
- password: (string)
The password that port discovery will use when attempting to login [sensitive]
- apply_config: (boolean - default: true)
Port discovery will store the discovered settings when this flag is true
- auth_timeout: (integer - default: 0 - minimum: 0 - maximum: 600)
Authentication Timeout in seconds. When the value is 0, port discovery will use it's default timeout settings
- hostname_pattern: (string - default: )
Regex Pattern to match on a hostname label. When empty, port_discovery will use it's default hostname pattern settings (".+")
Example:
.+
- period: required(one of daily, weekly, monthly)
Specify the frequency type for the schedule.
- day_of_month: (integer - minimum: 1 - maximum: 31)
The day of the month to perform discovery on. Valid values are 1 to 31. Be aware that values over 28 means discovery will not run on some months. [visible:period:=:monthly,required:period:=:monthly]
- day_of_week: (integer - minimum: 0 - maximum: 6)
The day of the week to perform discovery on. Valid values are 0 (Sunday) to 6 (Saturday). [visible:period:=:weekly,required:period:=:weekly]
- hour: required(integer - minimum: 0 - maximum: 23)
The hour of the day to perform discovery on. Valid values are 0 to 23.
- minute: required(integer - minimum: 0 - maximum: 59)
The minute of the hour to perform discovery on. Valid values are 0 to 59.
- ports: (array of number)
The list of ports (as devices) to discover. [computed_options:port_consoleservers_all]
- enabled: required(boolean - default: false)
- auto_discover_schedule: required(object)
Examples:
example1:
Schedule Port Auto-Discover for selected ports on daily basis
{
"auto_discover_schedule": {
"enabled": true,
"period": "daily",
"hour": 2,
"minute": 30,
"ports": [
11,
33,
4,
20
]
}
}
example2:
Schedule Port Auto-Discover for selected ports on weekly basis
{
"auto_discover_schedule": {
"enabled": true,
"period": "weekly",
"day_of_week": 4,
"hour": 2,
"minute": 30,
"ports": [
11,
33,
4,
20
]
}
}
HTTP status code 200
Port Auto-Discovery was scheduled
Body
Media type: application/json
Possible types:
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
Controls if periodic port auto-discovery is active.
- username: (string)
The username that port discovery will use when attempting to login
- password: (string)
The password that port discovery will use when attempting to login [sensitive]
- apply_config: (boolean - default: true)
Port discovery will store the discovered settings when this flag is true
- auth_timeout: (integer - default: 0 - minimum: 0 - maximum: 600)
Authentication Timeout in seconds. When the value is 0, port discovery will use it's default timeout settings
- hostname_pattern: (string - default: )
Regex Pattern to match on a hostname label. When empty, port_discovery will use it's default hostname pattern settings (".+")
Example:
.+
- period: required(one of daily, weekly, monthly)
Specify the frequency type for the schedule.
- day_of_month: (integer - minimum: 1 - maximum: 31)
The day of the month to perform discovery on. Valid values are 1 to 31. Be aware that values over 28 means discovery will not run on some months. [visible:period:=:monthly,required:period:=:monthly]
- day_of_week: (integer - minimum: 0 - maximum: 6)
The day of the week to perform discovery on. Valid values are 0 (Sunday) to 6 (Saturday). [visible:period:=:weekly,required:period:=:weekly]
- hour: required(integer - minimum: 0 - maximum: 23)
The hour of the day to perform discovery on. Valid values are 0 to 23.
- minute: required(integer - minimum: 0 - maximum: 59)
The minute of the hour to perform discovery on. Valid values are 0 to 59.
- ports: (array of array)
The list of ports (as devices) to discover. [computed_options:port_consoleservers_all]
- enabled: required(boolean - default: false)
- auto_discover_schedule: required(object)
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
Controls if periodic port auto-discovery is active.
- username: (string)
The username that port discovery will use when attempting to login
- password: (string)
The password that port discovery will use when attempting to login [sensitive]
- apply_config: (boolean - default: true)
Port discovery will store the discovered settings when this flag is true
- auth_timeout: (integer - default: 0 - minimum: 0 - maximum: 600)
Authentication Timeout in seconds. When the value is 0, port discovery will use it's default timeout settings
- hostname_pattern: (string - default: )
Regex Pattern to match on a hostname label. When empty, port_discovery will use it's default hostname pattern settings (".+")
Example:
.+
- period: required(one of daily, weekly, monthly)
Specify the frequency type for the schedule.
- day_of_month: (integer - minimum: 1 - maximum: 31)
The day of the month to perform discovery on. Valid values are 1 to 31. Be aware that values over 28 means discovery will not run on some months. [visible:period:=:monthly,required:period:=:monthly]
- day_of_week: (integer - minimum: 0 - maximum: 6)
The day of the week to perform discovery on. Valid values are 0 (Sunday) to 6 (Saturday). [visible:period:=:weekly,required:period:=:weekly]
- hour: required(integer - minimum: 0 - maximum: 23)
The hour of the day to perform discovery on. Valid values are 0 to 23.
- minute: required(integer - minimum: 0 - maximum: 59)
The minute of the hour to perform discovery on. Valid values are 0 to 59.
- ports: (array of number)
The list of ports (as devices) to discover. [computed_options:port_consoleservers_all]
- enabled: required(boolean - default: false)
- auto_discover_schedule: required(object)
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
get /ports/auto_discover/schedule
Get the Port Auto-Discovery schedule
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The Port Auto-Discovery scheduling information
Body
Media type: application/json
Possible types:
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
Controls if periodic port auto-discovery is active.
- username: (string)
The username that port discovery will use when attempting to login
- password: (string)
The password that port discovery will use when attempting to login [sensitive]
- apply_config: (boolean - default: true)
Port discovery will store the discovered settings when this flag is true
- auth_timeout: (integer - default: 0 - minimum: 0 - maximum: 600)
Authentication Timeout in seconds. When the value is 0, port discovery will use it's default timeout settings
- hostname_pattern: (string - default: )
Regex Pattern to match on a hostname label. When empty, port_discovery will use it's default hostname pattern settings (".+")
Example:
.+
- period: required(one of daily, weekly, monthly)
Specify the frequency type for the schedule.
- day_of_month: (integer - minimum: 1 - maximum: 31)
The day of the month to perform discovery on. Valid values are 1 to 31. Be aware that values over 28 means discovery will not run on some months. [visible:period:=:monthly,required:period:=:monthly]
- day_of_week: (integer - minimum: 0 - maximum: 6)
The day of the week to perform discovery on. Valid values are 0 (Sunday) to 6 (Saturday). [visible:period:=:weekly,required:period:=:weekly]
- hour: required(integer - minimum: 0 - maximum: 23)
The hour of the day to perform discovery on. Valid values are 0 to 23.
- minute: required(integer - minimum: 0 - maximum: 59)
The minute of the hour to perform discovery on. Valid values are 0 to 59.
- ports: (array of array)
The list of ports (as devices) to discover. [computed_options:port_consoleservers_all]
- enabled: required(boolean - default: false)
- auto_discover_schedule: required(object)
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
Controls if periodic port auto-discovery is active.
- username: (string)
The username that port discovery will use when attempting to login
- password: (string)
The password that port discovery will use when attempting to login [sensitive]
- apply_config: (boolean - default: true)
Port discovery will store the discovered settings when this flag is true
- auth_timeout: (integer - default: 0 - minimum: 0 - maximum: 600)
Authentication Timeout in seconds. When the value is 0, port discovery will use it's default timeout settings
- hostname_pattern: (string - default: )
Regex Pattern to match on a hostname label. When empty, port_discovery will use it's default hostname pattern settings (".+")
Example:
.+
- period: required(one of daily, weekly, monthly)
Specify the frequency type for the schedule.
- day_of_month: (integer - minimum: 1 - maximum: 31)
The day of the month to perform discovery on. Valid values are 1 to 31. Be aware that values over 28 means discovery will not run on some months. [visible:period:=:monthly,required:period:=:monthly]
- day_of_week: (integer - minimum: 0 - maximum: 6)
The day of the week to perform discovery on. Valid values are 0 (Sunday) to 6 (Saturday). [visible:period:=:weekly,required:period:=:weekly]
- hour: required(integer - minimum: 0 - maximum: 23)
The hour of the day to perform discovery on. Valid values are 0 to 23.
- minute: required(integer - minimum: 0 - maximum: 59)
The minute of the hour to perform discovery on. Valid values are 0 to 59.
- ports: (array of number)
The list of ports (as devices) to discover. [computed_options:port_consoleservers_all]
- enabled: required(boolean - default: false)
- auto_discover_schedule: required(object)
Example:
{
"auto_discover_schedule": {
"enabled": true,
"period": "daily",
"hour": 2,
"minute": 30,
"ports": [
1,
10,
33,
42
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get auto_discovery logs.
Get auto_discovery logs.
get /ports/auto_discover/current_log
Get auto_discovery logs.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- auto_discover_log: required(object)
- no_of_log_lines: required(integer)
- log_lines: required(array of string)
Example:
{
"auto_discover_log": {
"no_of_log_lines": 35,
"log_lines": [
"2022-09-24T16:46:49.406058+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-24T16:46:49.406058+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-24T16:47:35.582573+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-24T16:47:35.585981+00:00 localhost port_discovery[main] Starting discovery with 19200 baud and X2 pinout",
"2022-09-24T16:47:39.517707+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-24T16:47:39.518306+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-24T16:48:25.682977+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-24T16:48:25.685997+00:00 localhost port_discovery[main] Starting discovery with 57600 baud and X2 pinout",
"2022-09-24T16:48:29.433400+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-24T16:48:29.434052+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-24T16:49:15.608420+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-24T16:49:18.500765+00:00 localhost port_discovery[main] Done",
"2022-09-25T16:45:08.168877+00:00 localhost port_discovery[main] Starting discovery with 9600 baud and X2 pinout on preconfigured port 3",
"2022-09-25T16:45:09.634127+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-25T16:45:09.634750+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-25T16:45:55.817628+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-25T16:45:55.818848+00:00 localhost port_discovery[main] Starting discovery with 9600 baud and X2 pinout",
"2022-09-25T16:45:57.399608+00:00 localhost port_discovery[main] Skipping duplicate test: port 3, baud 9600, pinout X2",
"2022-09-25T16:45:57.400335+00:00 localhost port_discovery[main] Starting discovery with 115200 baud and X2 pinout",
"2022-09-25T16:46:01.288232+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-25T16:46:01.289081+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-25T16:46:47.465976+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-25T16:46:47.469899+00:00 localhost port_discovery[main] Starting discovery with 38400 baud and X2 pinout",
"2022-09-25T16:46:51.276526+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-25T16:46:51.276526+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-25T16:47:37.443170+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-25T16:47:37.446873+00:00 localhost port_discovery[main] Starting discovery with 19200 baud and X2 pinout",
"2022-09-25T16:47:41.255224+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-25T16:47:41.255845+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-25T16:48:27.426588+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-25T16:48:27.429800+00:00 localhost port_discovery[main] Starting discovery with 57600 baud and X2 pinout",
"2022-09-25T16:48:31.242395+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-25T16:48:31.242826+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-25T16:49:17.413508+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-25T16:49:20.253166+00:00 localhost port_discovery[main] Done"
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 49,
"level": 1,
"args": {
"param": "logLines"
},
"text": "Invalid parameter 'logLines' was provided"
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get logs for the last auto_discovery run.
Get logs for the last auto_discovery run.
get /ports/auto_discover/last_run_log
Get logs for the last auto_discovery run.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- auto_discover_last_run_log: required(object)
- no_of_log_lines: required(integer)
- log_lines: required(array of string)
Example:
{
"auto_discover_last_run_log": {
"no_of_log_lines": 35,
"log_lines": [
"2022-09-24T16:46:49.406058+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-24T16:46:49.406058+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-24T16:47:35.582573+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-24T16:47:35.585981+00:00 localhost port_discovery[main] Starting discovery with 19200 baud and X2 pinout",
"2022-09-24T16:47:39.517707+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-24T16:47:39.518306+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-24T16:48:25.682977+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-24T16:48:25.685997+00:00 localhost port_discovery[main] Starting discovery with 57600 baud and X2 pinout",
"2022-09-24T16:48:29.433400+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-24T16:48:29.434052+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-24T16:49:15.608420+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-24T16:49:18.500765+00:00 localhost port_discovery[main] Done",
"2022-09-25T16:45:08.168877+00:00 localhost port_discovery[main] Starting discovery with 9600 baud and X2 pinout on preconfigured port 3",
"2022-09-25T16:45:09.634127+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-25T16:45:09.634750+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-25T16:45:55.817628+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-25T16:45:55.818848+00:00 localhost port_discovery[main] Starting discovery with 9600 baud and X2 pinout",
"2022-09-25T16:45:57.399608+00:00 localhost port_discovery[main] Skipping duplicate test: port 3, baud 9600, pinout X2",
"2022-09-25T16:45:57.400335+00:00 localhost port_discovery[main] Starting discovery with 115200 baud and X2 pinout",
"2022-09-25T16:46:01.288232+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-25T16:46:01.289081+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-25T16:46:47.465976+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-25T16:46:47.469899+00:00 localhost port_discovery[main] Starting discovery with 38400 baud and X2 pinout",
"2022-09-25T16:46:51.276526+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-25T16:46:51.276526+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-25T16:47:37.443170+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-25T16:47:37.446873+00:00 localhost port_discovery[main] Starting discovery with 19200 baud and X2 pinout",
"2022-09-25T16:47:41.255224+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-25T16:47:41.255845+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-25T16:48:27.426588+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-25T16:48:27.429800+00:00 localhost port_discovery[main] Starting discovery with 57600 baud and X2 pinout",
"2022-09-25T16:48:31.242395+00:00 localhost port_discovery[port3] Discovery starting",
"2022-09-25T16:48:31.242826+00:00 localhost port_discovery[port3] Checking port readiness",
"2022-09-25T16:49:17.413508+00:00 localhost port_discovery[port3] No device discovered",
"2022-09-25T16:49:20.253166+00:00 localhost port_discovery[main] Done"
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 49,
"level": 1,
"args": {
"param": "logLines"
},
"text": "Invalid parameter 'logLines' was provided"
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Provides information about the serial pin status and Tx & Rx counters for each of this device's serial ports [no_sorting_required]
Gets the list of active pin status for all serial port signals and the Tx and RX byte counters.
get /ports/ports_status
Gets the list of active pin status for all serial port signals and the Tx and RX byte counters.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
An object containing an array of ports with their corresponding signal values
Body
Media type: application/json
Type: object
Properties- port_status: required(array of object)
Items: items
- id: required(string)
A unique identifier for this serial port
- label: required(string)
label for serial port
- status: required(one of ok, disconnected)
The external hardware connection status on USB serial ports. If the serial port type is RJ45, then this will always return 'ok'.
- rts: required(boolean)
Current status of the RTS pin on this serial port.
- cts: required(boolean)
Current status of the CTS pin on this serial port.
- dsr: required(boolean)
Current status of the DSR pin on this serial port.
- dtr: required(boolean)
Current status of the DTR pin on this serial port.
- dcd: required(boolean)
Current status of the DCD pin on this serial port.
- tx: required(integer)
Number of bytes transmitted on this port since the last reset.
- rx: required(integer)
Number of bytes received on this port since the last reset.
- id: required(string)
Example:
{
"port_status": [
{
"id": "ports-1",
"label": "port01",
"status": "ok",
"rts": true,
"cts": true,
"dtr": true,
"dsr": true,
"dcd": true,
"tx": 0,
"rx": 0
},
{
"id": "ports-2",
"label": "port02",
"status": "disconnected",
"rts": true,
"cts": false,
"dtr": true,
"dsr": false,
"dcd": false,
"tx": 0,
"rx": 0
}
]
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 500
Error encountered while attempting to obtain ports status
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Provides information about the serial pin status and Tx & Rx counters for each of this device's serial ports
Gets the list of active pin status for all serial port signals and the Tx and RX byte counters.
get /ports/ports_status/{id}
Gets the list of active pin status for all serial port signals and the Tx and RX byte counters.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
An object containing an array of ports with their corresponding signal values
Body
Media type: application/json
Type: object
Properties- port_status: required(object)
- id: required(string)
A unique identifier for this serial port
- label: required(string)
label for serial port
- status: required(one of ok, disconnected)
The external hardware connection status on USB serial ports. If the serial port type is RJ45, then this will always return 'ok'.
- rts: required(boolean)
Current status of the RTS pin on this serial port.
- cts: required(boolean)
Current status of the CTS pin on this serial port.
- dsr: required(boolean)
Current status of the DSR pin on this serial port.
- dtr: required(boolean)
Current status of the DTR pin on this serial port.
- dcd: required(boolean)
Current status of the DCD pin on this serial port.
- tx: required(integer)
Number of bytes transmitted on this port since the last reset.
- rx: required(integer)
Number of bytes received on this port since the last reset.
- id: required(string)
Example:
{
"port_status": {
"id": "ports-1",
"label": "port01",
"status": "ok",
"rts": true,
"cts": true,
"dtr": true,
"dsr": true,
"dcd": true,
"tx": 0,
"rx": 0
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 500
Error encountered while attempting to obtain ports status
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/managementports
Used for working with local management console information.
Gets the local management console ports attached to the NetOps Console Server appliance.
Set the properties for local management console ports.
get /managementports
Gets the local management console ports attached to the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The array of management ports, either a full array or as requested by parameters
Body
Media type: application/json
Type: object
Properties- managementports: required(array of object)
Items: items
- enabled: required(boolean)
If the management console is currently enabled
- kerneldebug: required(boolean)
If kernel debug messages are currently enabled [visible:enabled:=:true]
- termemulation: required(one of vt100, vt102, vt220, linux, ansi)
Terminal emulation for management console
- baud: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The serial port speed [no_sorting_required,enum:available_bauds]
- databits: required(one of 7, 8)
The number of data bits to use
- parity: required(one of none, odd, even)
The serial port's parity.
- stopbits: required(one of 1, 2)
The number of stop bits to use
- id: required(string)
A unique identifier for this management port.
- device: required(string)
The tty device that this management port uses.
- available_bauds: required(array of string)
Valid values for the "baud" property of this port. The valid baud rates for a port are hardware-dependent.
- enabled: required(boolean)
- meta: required(object)
- total_pages: (string)
Example:
{
"managementports": [
{
"id": "mgmtPorts-1",
"device": "ttyS0",
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"available_bauds": [
"9600",
"115200"
],
"databits": "8",
"parity": "none",
"stopbits": "1"
},
{
"id": "mgmtPorts-2",
"device": "ttyS1",
"enabled": true,
"kerneldebug": true,
"termemulation": "vt100",
"baud": "115200",
"available_bauds": [
"9600",
"115200"
],
"databits": "8",
"parity": "none",
"stopbits": "1"
}
],
"meta": {}
}
HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 404
Invalid request, Incomplete data, management port not found, Failure during retrieval of management ports
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Failed to read management ports.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /managementports
Set the properties for local management console ports.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- managementports: required(array of object)
Items: items
- enabled: required(boolean)
If the management console is currently enabled
- kerneldebug: required(boolean)
If kernel debug messages are currently enabled [visible:enabled:=:true]
- termemulation: required(one of vt100, vt102, vt220, linux, ansi)
Terminal emulation for management console
- baud: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The serial port speed [no_sorting_required,enum:available_bauds]
- databits: required(one of 7, 8)
The number of data bits to use
- parity: required(one of none, odd, even)
The serial port's parity.
- stopbits: required(one of 1, 2)
The number of stop bits to use
- enabled: required(boolean)
Example:
{
"managementports": [
{
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"databits": "8",
"parity": "none",
"stopbits": "1"
},
{
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"databits": "8",
"parity": "none",
"stopbits": "1"
}
]
}
HTTP status code 200
Management Ports have been updated.
Body
Media type: application/json
Type: object
Properties- managementports: required(array of object)
Items: items
- enabled: required(boolean)
If the management console is currently enabled
- kerneldebug: required(boolean)
If kernel debug messages are currently enabled [visible:enabled:=:true]
- termemulation: required(one of vt100, vt102, vt220, linux, ansi)
Terminal emulation for management console
- baud: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The serial port speed [no_sorting_required,enum:available_bauds]
- databits: required(one of 7, 8)
The number of data bits to use
- parity: required(one of none, odd, even)
The serial port's parity.
- stopbits: required(one of 1, 2)
The number of stop bits to use
- id: required(string)
A unique identifier for this management port.
- device: required(string)
The tty device that this management port uses.
- available_bauds: required(array of string)
Valid values for the "baud" property of this port. The valid baud rates for a port are hardware-dependent.
- enabled: required(boolean)
- meta: required(object)
- total_pages: (string)
Example:
{
"managementports": [
{
"id": "mgmtPorts-1",
"device": "ttyS0",
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"available_bauds": [
"9600",
"115200"
],
"databits": "8",
"parity": "none",
"stopbits": "1"
},
{
"id": "mgmtPorts-2",
"device": "ttyS1",
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"available_bauds": [
"9600",
"115200"
],
"databits": "8",
"parity": "none",
"stopbits": "1"
}
],
"meta": {}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Used for working with a specific management port.
Retrieve a single local management console port by ID.
Set properties for a single local management console port.
get /managementports/{id}
Retrieve a single local management console port by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
management port has been updated.
Body
Media type: application/json
Type: object
Properties- managementport: required(object)
- enabled: required(boolean)
If the management console is currently enabled
- kerneldebug: required(boolean)
If kernel debug messages are currently enabled [visible:enabled:=:true]
- termemulation: required(one of vt100, vt102, vt220, linux, ansi)
Terminal emulation for management console
- baud: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The serial port speed [no_sorting_required,enum:available_bauds]
- databits: required(one of 7, 8)
The number of data bits to use
- parity: required(one of none, odd, even)
The serial port's parity.
- stopbits: required(one of 1, 2)
The number of stop bits to use
- id: required(string)
A unique identifier for this management port.
- device: required(string)
The tty device that this management port uses.
- available_bauds: required(array of string)
Valid values for the "baud" property of this port. The valid baud rates for a port are hardware-dependent.
- enabled: required(boolean)
Example:
{
"managementport": {
"id": "mgmtPorts-1",
"device": "ttyS0",
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"available_bauds": [
"9600",
"115200"
],
"databits": "8",
"parity": "none",
"stopbits": "1"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /managementports/{id}
Set properties for a single local management console port.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- managementport: required(object)
- enabled: required(boolean)
If the management console is currently enabled
- kerneldebug: required(boolean)
If kernel debug messages are currently enabled [visible:enabled:=:true]
- termemulation: required(one of vt100, vt102, vt220, linux, ansi)
Terminal emulation for management console
- baud: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The serial port speed [no_sorting_required,enum:available_bauds]
- databits: required(one of 7, 8)
The number of data bits to use
- parity: required(one of none, odd, even)
The serial port's parity.
- stopbits: required(one of 1, 2)
The number of stop bits to use
- enabled: required(boolean)
Example:
{
"managementport": {
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"databits": "8",
"parity": "none",
"stopbits": "1"
}
}
HTTP status code 200
Management Port has been updated.
Body
Media type: application/json
Type: object
Properties- managementport: required(object)
- enabled: required(boolean)
If the management console is currently enabled
- kerneldebug: required(boolean)
If kernel debug messages are currently enabled [visible:enabled:=:true]
- termemulation: required(one of vt100, vt102, vt220, linux, ansi)
Terminal emulation for management console
- baud: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The serial port speed [no_sorting_required,enum:available_bauds]
- databits: required(one of 7, 8)
The number of data bits to use
- parity: required(one of none, odd, even)
The serial port's parity.
- stopbits: required(one of 1, 2)
The number of stop bits to use
- id: required(string)
A unique identifier for this management port.
- device: required(string)
The tty device that this management port uses.
- available_bauds: required(array of string)
Valid values for the "baud" property of this port. The valid baud rates for a port are hardware-dependent.
- enabled: required(boolean)
Example:
{
"managementport": {
"id": "mgmtPorts-1",
"device": "ttyS0",
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"available_bauds": [
"9600",
"115200"
],
"databits": "8",
"parity": "none",
"stopbits": "1"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/logs
Used for working with the logs on the system.
Fetch last n log lines in syslog.
get /logs/syslog
Fetch last n log lines in syslog.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- logLines: (integer - default: 100)
The number of lines to fetch - max 1000, min 10.
HTTP status code 200
Returns the last n lines in the syslog
Body
Media type: application/json
Type: object
Properties- syslog: required(object)
- id: required(string)
- no_of_log_lines: required(integer)
- log_lines: (array of string)
Example:
{
"syslog": {
"id": "3fe0c4281c994a34225db3224b0cf4b4",
"log_lines": [
"2018-04-23T16:49:35.285554+00:00 qemux86-64 sshd[20111]: Disconnected from 192.168.33.101",
"2018-04-23T16:49:35.285625+00:00 qemux86-64 sshd[20111]: pam_unix(sshd:session): session closed for user root",
"2018-04-23T16:49:35.379184+00:00 qemux86-64 sshd[20139]: pam_unix(sshd:auth): authentication failure; logname= uid=0 euid=0 tty=ssh ruser= rhost=192.168.33.101 user=root",
"2018-04-23T16:49:37.937315+00:00 qemux86-64 sshd[20139]: Accepted publickey for root from 192.168.33.101 port 57058 ssh2: RSA SHA256:6ED9MiX/6QXhSLN5g25V4T0okuO9o0aQl0ONT9BCxKE",
"2018-04-23T16:49:37.938147+00:00 qemux86-64 sshd[20139]: pam_unix(sshd:session): session opened for user root by (uid=0)",
"2018-04-23T16:49:43.308764+00:00 qemux86-64 sshd[20139]: Received disconnect from 192.168.33.101: 11: disconnected by user",
"2018-04-23T16:49:43.308798+00:00 qemux86-64 sshd[20139]: Disconnected from 192.168.33.101",
"2018-04-23T16:49:43.308887+00:00 qemux86-64 sshd[20139]: pam_unix(sshd:session): session closed for user root",
"2018-04-23T17:20:51.938418+00:00 qemux86-64 udhcpc[1660]: Sending renew...",
"2018-04-23T17:20:51.941182+00:00 qemux86-64 udhcpc[1660]: Lease of 192.168.33.207 obtained, lease time 7200"
],
"no_of_log_lines": 10
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Fetch last n log lines in portlog.
get /logs/portlog/{id}
Fetch last n log lines in portlog.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- logLines: (integer - default: 100 - minimum: 10 - maximum: 1000)
The number of lines to fetch - max 1000, min 10.
HTTP status code 200
Returns the last n lines in the portlog
Body
Media type: application/json
Type: object
Properties- portlog: required(object)
- id: required(string)
- no_of_log_lines: required(integer)
- log_lines: (array of string)
Example:
{
"portlog": {
"id": "portlogports-1771bed6129488a69764d064ed7e6086d",
"log_lines": [
"2018-04-19T21:59:42.475157+00:00 TXDATA ",
"2018-04-19T21:59:43.720286+00:00 TXDATA ^C",
"2018-04-19T21:59:44.004623+00:00 TXDATA ^C",
"2018-04-19T21:59:49.053138+00:00 TXDATA ^C",
"2018-04-19T21:59:49.739765+00:00 TXDATA ^C",
"2018-04-19T21:59:50.349753+00:00 LOGOUT root",
"2018-04-19T21:59:50.373627+00:00 RXDATA ",
"2018-04-19T21:59:50.402295+00:00 RXDATA asdfasdf",
"2018-04-19T22:00:18.216623+00:00 LOGIN root",
"2018-04-19T22:00:21.386050+00:00 TXDATA rootrootakjdfaksjdf",
"2018-04-19T22:00:25.145561+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf",
"2018-04-19T22:00:26.473879+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ",
"2018-04-19T22:00:42.660939+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C",
"2018-04-19T22:00:45.472921+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C~",
"2018-04-19T22:00:46.456493+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C~.",
"2018-04-19T22:00:46.887685+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C~.",
"2018-04-19T22:00:47.057797+00:00 TXDATA ",
"2018-04-19T22:00:47.236891+00:00 TXDATA ",
"2018-04-19T22:00:47.413115+00:00 TXDATA ",
"2018-04-19T22:00:48.328447+00:00 LOGOUT root"
],
"no_of_log_lines": 20
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
logs/portlog_settings endpoint is to check and update port log settings.
Retrieve the current settings.
Set the port log settings.
get /logs/portlog_settings
Retrieve the current settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current failover settings.
Body
Media type: application/json
Type: object
Properties- portlog_settings: required(object)
- facility: required(one of daemon, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, syslog, user, uucp, local0, local1, local2, local3, local4, local5, local6, local7)
The syslog facility to use for port logs.
- severity: required(one of info, alert, critical, debug, emergency, error, info, notice, warning)
The syslog severity to use for port logs.
- facility: required(one of daemon, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, syslog, user, uucp, local0, local1, local2, local3, local4, local5, local6, local7)
Example:
{
"portlog_settings": {
"facility": "daemon",
"severity": "info"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /logs/portlog_settings
Set the port log settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- portlog_settings: required(object)
- facility: required(one of daemon, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, syslog, user, uucp, local0, local1, local2, local3, local4, local5, local6, local7)
The syslog facility to use for port logs.
- severity: required(one of info, alert, critical, debug, emergency, error, info, notice, warning)
The syslog severity to use for port logs.
- facility: required(one of daemon, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, syslog, user, uucp, local0, local1, local2, local3, local4, local5, local6, local7)
Example:
{
"portlog_settings": {
"facility": "cron",
"severity": "critical"
}
}
HTTP status code 200
Returns the current failover settings.
Body
Media type: application/json
Type: object
Properties- portlog_settings: required(object)
- facility: required(one of daemon, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, syslog, user, uucp, local0, local1, local2, local3, local4, local5, local6, local7)
The syslog facility to use for port logs.
- severity: required(one of info, alert, critical, debug, emergency, error, info, notice, warning)
The syslog severity to use for port logs.
- facility: required(one of daemon, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, syslog, user, uucp, local0, local1, local2, local3, local4, local5, local6, local7)
Example:
{
"portlog_settings": {
"facility": "cron",
"severity": "critical"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/pots_modems
Query the configuration of POTS modems available on the system
Configure the POTS modems available on the system
get /pots_modems
Query the configuration of POTS modems available on the system
HTTP status code 200
The configuration of the POTS modems on this system
Body
Media type: application/json
Type: object
Properties- pots_modems: required(array of object)
Items: items
- id: required(string)
A unique identifier for the POTS modem.
- device: required(string)
This is the device name (read-only) assigned to the POTS modem device by the kernel.
- mode: required(one of disabled, dialin)
The operational mode of the POTS modem can be either 'disabled' or 'dialin'.
- baud: required(one of 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The data rate assigned to the POTS modem.
- command_sequence: (string)
An AT command that runs when the modem is initialized. Multiple commands can be entered, separated by semicolons.
- runtime_status: (object)
- status: required(one of listening, connected, disabled, unknown)
The current status of the modem.
- status: required(one of listening, connected, disabled, unknown)
- id: required(string)
Example:
{
"pots_modems": [
{
"id": "pots-modems-1",
"device": "ttyUSB0",
"baud": "115200",
"mode": "disabled",
"command_sequence": "",
"runtime_status": {
"status": "connected"
}
}
]
}
put /pots_modems
Configure the POTS modems available on the system
Body
Media type: application/json
Type: object
Properties- pots_modems: required(array of object)
Items: items
- device: required(string)
This is the device name (read-only) assigned to the POTS modem device by the kernel.
- mode: required(one of disabled, dialin)
The operational mode of the POTS modem can be either 'disabled' or 'dialin'.
- baud: required(one of 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The data rate assigned to the POTS modem.
- command_sequence: (string - pattern: ^\S*$)
An AT command that runs when the modem is initialized. Multiple commands can be entered, separated by semicolons. [regexerr: 'command sequence' cannot contain spaces.]
- device: required(string)
Example:
{
"pots_modems": [
{
"device": "ttyUSB0",
"baud": "115200",
"mode": "disabled"
}
]
}
HTTP status code 200
The configuration of the POTS modems on this system
Body
Media type: application/json
Type: object
Properties- pots_modems: required(array of object)
Items: items
- id: required(string)
A unique identifier for the POTS modem.
- device: required(string)
This is the device name (read-only) assigned to the POTS modem device by the kernel.
- mode: required(one of disabled, dialin)
The operational mode of the POTS modem can be either 'disabled' or 'dialin'.
- baud: required(one of 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The data rate assigned to the POTS modem.
- command_sequence: (string)
An AT command that runs when the modem is initialized. Multiple commands can be entered, separated by semicolons.
- runtime_status: (object)
- status: required(one of listening, connected, disabled, unknown)
The current status of the modem.
- status: required(one of listening, connected, disabled, unknown)
- id: required(string)
Example:
{
"pots_modems": [
{
"id": "pots-modems-1",
"device": "ttyUSB0",
"baud": "115200",
"mode": "disabled",
"command_sequence": "",
"runtime_status": {
"status": "listening"
}
}
]
}
request POTS modem settings
Defines POTS modem settings
get /pots_modems/{id}
request POTS modem settings
URI Parameters
- id: required(string)
HTTP status code 200
Return a specific pots modem configuration
Body
Media type: application/json
Type: object
Properties- pots_modem: required(object)
- id: required(string)
A unique identifier for the POTS modem.
- device: required(string)
This is the device name (read-only) assigned to the POTS modem device by the kernel.
- mode: required(one of disabled, dialin)
The operational mode of the POTS modem can be either 'disabled' or 'dialin'.
- baud: required(one of 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The data rate assigned to the POTS modem.
- command_sequence: (string)
An AT command that runs when the modem is initialized. Multiple commands can be entered, separated by semicolons.
- runtime_status: (object)
- status: required(one of listening, connected, disabled, unknown)
The current status of the modem.
- status: required(one of listening, connected, disabled, unknown)
- id: required(string)
Example:
{
"pots_modem": {
"id": "pots-modems-1",
"device": "ttyUSB0",
"baud": "115200",
"mode": "dialin",
"command_sequence": "AT!GSTATUS?",
"runtime_status": {
"status": "listening"
}
}
}
put /pots_modems/{id}
Defines POTS modem settings
URI Parameters
- id: required(string)
Body
Media type: application/json
Type: object
Properties- pots_modem: required(object)
- device: required(string)
This is the device name (read-only) assigned to the POTS modem device by the kernel.
- mode: required(one of disabled, dialin)
The operational mode of the POTS modem can be either 'disabled' or 'dialin'.
- baud: required(one of 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The data rate assigned to the POTS modem.
- command_sequence: (string - pattern: ^\S*$)
An AT command that runs when the modem is initialized. Multiple commands can be entered, separated by semicolons. [regexerr: 'command sequence' cannot contain spaces.]
- device: required(string)
Example:
{
"pots_modem": {
"device": "ttyUSB0",
"baud": "115200",
"mode": "dialin",
"command_sequence": "AT!GSTATUS?"
}
}
HTTP status code 200
POTS modem configuration data
Body
Media type: application/json
Type: object
Properties- pots_modem: required(object)
- id: required(string)
A unique identifier for the POTS modem.
- device: required(string)
This is the device name (read-only) assigned to the POTS modem device by the kernel.
- mode: required(one of disabled, dialin)
The operational mode of the POTS modem can be either 'disabled' or 'dialin'.
- baud: required(one of 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)
The data rate assigned to the POTS modem.
- command_sequence: (string)
An AT command that runs when the modem is initialized. Multiple commands can be entered, separated by semicolons.
- runtime_status: (object)
- status: required(one of listening, connected, disabled, unknown)
The current status of the modem.
- status: required(one of listening, connected, disabled, unknown)
- id: required(string)
Example:
{
"pots_modem": {
"id": "pots-modems-1",
"device": "ttyUSB0",
"baud": "115200",
"mode": "dialin",
"command_sequence": "AT!GSTATUS?",
"runtime_status": {
"status": "listening"
}
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'pots_modem.mode' was not provided in the request",
"args": {
"param": "pots_modem.mode"
},
"level": 1
}
]
}
HTTP status code 404
Pots modem does not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'pots-modems-2'",
"args": {
"uuid": "pots-modems-2"
},
"level": 1
}
]
}
Disconnect all active sessions on POTS modem
/monitor
Used for monitoring the state of the various services running on the system.
Used for monitoring the state of the various network discovery (LLDP/CDP) protocols running on the system.
Get the current status of the network discovery (LLDP/CDP) protocols on this device.
Get the current status of the network discovery (LLDP/CDP) protocols on this device.
get /monitor/lldp/chassis
Get the current status of the network discovery (LLDP/CDP) protocols on this device.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current status of the network discovery (LLDP/CDP) protocols on this device.
Body
Media type: application/json
Type: object
Properties- lldpstat: required(object)
- name: required(string)
- mac: required(string)
- Bridge: required(boolean)
- Router: required(boolean)
- Station: required(boolean)
- Wlan: required(boolean)
- descr: required(string)
- mgmt_ip: required(array of string)
Example:
{
"lldpstat": {
"mac": "00:13:c6:08:07:ab",
"Wlan": false,
"name": "platypus",
"Router": true,
"Station": false,
"Bridge": true,
"mgmt_ip": [
"10.250.242.110",
"fdcd:41a4:5559:faf2:213:c6ff:fe08:7ab"
],
"descr": "description 1"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get the list of neighboring devices (peers) that have been discovered by the LLDP protocol.
Get the list of neighboring devices (peers) that have been discovered by the LLDP protocol.
get /monitor/lldp/neighbor
Get the list of neighboring devices (peers) that have been discovered by the LLDP protocol.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the list of LLDP neighbors.
Body
Media type: application/json
Type: object
Properties- lldp-status-neighbor: required(array of object)
Items: items
- name: required(string)
- remote_name: required(string)
- remote_mac: required(string)
- mgmt_ip: required(array of string)
- port_name: required(string)
- port: required(string)
- id: required(integer)
Example:
{
"lldp-status-neighbor": [
{
"remote_name": "NGCS-Switch",
"port_name": "Port #1",
"name": "enp3s0f1",
"id": 1,
"port": "1",
"mgmt_ip": [
"192.168.1.13"
],
"remote_mac": "ec:9a:74:bc:57:e0"
},
{
"remote_name": "foobar.hostname",
"port_name": "net1",
"name": "tap1",
"id": 2,
"port": "52:54:00:76:27:fc",
"mgmt_ip": [
"192.168.0.1",
"fe80::5054:ff:fe76:27fc"
],
"remote_mac": "52:54:00:76:27:fc"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve a single LLDP neighbor status by ID. Used for working with a specific LLDP neighbor status item.
Retrieve a single LLDP neighbor status by ID.
get /monitor/lldp/neighbor/{id}
Retrieve a single LLDP neighbor status by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
LLDP neighbor status item
Body
Media type: application/json
Type: object
Properties- lldp-status-neighbor: required(object)
- name: required(string)
- remote_name: required(string)
- remote_mac: required(string)
- mgmt_ip: required(array of string)
- port_name: required(string)
- port: required(string)
- id: required(integer)
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Used for monitoring addresses banned by Brute Force Protection.
Retrieves information about IP addresses banned by Brute Force Protection
get /monitor/brute_force_protection/bans
Retrieves information about IP addresses banned by Brute Force Protection
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns information about currently banned IP addresses
Body
Media type: application/json
Type: object
Properties- brute_force_protection_bans: required(array of object)
Items: items
- jail: required(string)
Name of the jail responsible for banning the IP
- address: required(string)
IP address banned by Brute Force Protection
- time_of_ban: required(integer)
Timestamp of when the IP address was banned
- ban_time: required(integer)
Length of ban in seconds
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this brute force protection ban item.
- jail: required(string)
Example:
{
"brute_force_protection_bans": [
{
"jail": "sshd",
"address": "1.1.1.1",
"time_of_ban": 1628630619,
"ban_time": 60,
"multi_field_identifier": "sshd|1.1.1.1"
},
{
"jail": "nginx-login",
"address": "2.2.2.2",
"time_of_ban": 1628630618,
"ban_time": 60,
"multi_field_identifier": "nginx-login|2.2.2.2"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Used for working with a specific ban.
Retrieve a single ban by ID.
get /monitor/brute_force_protection/bans/{id}
Retrieve a single ban by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
ban item
Body
Media type: application/json
Type: object
Properties- brute_force_protection_ban: required(object)
- jail: required(string)
Name of the jail responsible for banning the IP
- address: required(string)
IP address banned by Brute Force Protection
- time_of_ban: required(integer)
Timestamp of when the IP address was banned
- ban_time: required(integer)
Length of ban in seconds
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this brute force protection ban item.
- jail: required(string)
Example:
{
"brute_force_protection_ban": {
"jail": "sshd",
"address": "1.1.1.1",
"time_of_ban": 1628630619,
"ban_time": 60,
"multi_field_identifier": "sshd|1.1.1.1"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Used for monitoring the status of static routes. Only IPv4 static routes are supported.
Retrieves information about the status of static routes.
get /monitor/static_routes/status
Retrieves information about the status of static routes.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns information about the status of static routes.
Body
Media type: application/json
Type: object
Properties- static_routes_status: required(array of object)
Items: items
- route: required(string)
The id of the route this status is for
- status: required(one of waiting, installed, error, not_installed, physif_disabled, physif_disconnected, no_connections)
A value indicating the status of the static route.
- error: (string)
If the status is 'error', this is the output from the 'ip route' command.
- route: required(string)
Example:
{
"static_routes_status": [
{
"route": "system_net_static_routes-1",
"status": "installed",
"error": ""
},
{
"route": "system_net_static_routes-2",
"status": "error",
"error": "Error: Nexthop has invalid gateway."
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Used for working with a specific static route status.
Retrieve a single static route status by ID.
get /monitor/static_routes/status/{id}
Retrieve a single static route status by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
ban item
Body
Media type: application/json
Type: object
Properties- static_routes_status: required(object)
- route: required(string)
The id of the route this status is for
- status: required(one of waiting, installed, error, not_installed, physif_disabled, physif_disconnected, no_connections)
A value indicating the status of the static route.
- error: (string)
If the status is 'error', this is the output from the 'ip route' command.
- route: required(string)
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/services
Used for working with the properties of the various services running on the system.
Provides access to the Brute Force Protection configuration on the system. When this service is enabled, the system watches for multiple failed login attempts and temporarily bans the offending IP Address for the configured amount of time.
Retrieves the Brute Force Protection configuration
Set the Brute Force Protection configuration
get /services/brute_force_protection
Retrieves the Brute Force Protection configuration
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current Brute Force Protection configuration
Body
Media type: application/json
Type: object
Properties- brute_force_protection: required(object)
- ssh_enabled: required(boolean)
enable or disable watching failed SSH login attempts
- https_enabled: required(boolean)
enable or disable watching failed HTTPS login attempts
- max_retry: required(integer - minimum: 3)
number of failures that have to occur in the last
find_time
minutes to ban then IP - ban_time: required(integer - minimum: 60)
effective ban duration (in seconds)
- find_time: required(integer - minimum: 1)
time interval (in minutes) before the current time where failures will count towards a ban
- ssh_enabled: required(boolean)
Example:
{
"brute_force_protection": {
"ssh_enabled": true,
"https_enabled": true,
"max_retry": 5,
"ban_time": 600,
"find_time": 10
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/brute_force_protection
Set the Brute Force Protection configuration
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- brute_force_protection: required(object)
- ssh_enabled: required(boolean)
enable or disable watching failed SSH login attempts
- https_enabled: required(boolean)
enable or disable watching failed HTTPS login attempts
- max_retry: required(integer - minimum: 3)
number of failures that have to occur in the last
find_time
minutes to ban then IP - ban_time: required(integer - minimum: 60)
effective ban duration (in seconds)
- find_time: required(integer - minimum: 1)
time interval (in minutes) before the current time where failures will count towards a ban
- ssh_enabled: required(boolean)
Example:
{
"brute_force_protection": {
"ssh_enabled": true,
"https_enabled": true,
"max_retry": 5,
"ban_time": 600,
"find_time": 10
}
}
HTTP status code 200
Returns the current Brute Force Protection configuration
Body
Media type: application/json
Type: object
Properties- brute_force_protection: required(object)
- ssh_enabled: required(boolean)
enable or disable watching failed SSH login attempts
- https_enabled: required(boolean)
enable or disable watching failed HTTPS login attempts
- max_retry: required(integer - minimum: 3)
number of failures that have to occur in the last
find_time
minutes to ban then IP - ban_time: required(integer - minimum: 60)
effective ban duration (in seconds)
- find_time: required(integer - minimum: 1)
time interval (in minutes) before the current time where failures will count towards a ban
- ssh_enabled: required(boolean)
Example:
{
"brute_force_protection": {
"ssh_enabled": true,
"https_enabled": true,
"max_retry": 5,
"ban_time": 600,
"find_time": 10
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'brute_force_protection.ssh_enabled' was not provided in the request",
"args": {
"param": "brute_force_protection.ssh_enabled"
},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Provides access to the SSL certificate used by web services on the device.
Returns the current HTTPS certificate, CSR details and indicate if a pending CSR exists.
Create a new CSR, delete the pending CSR or upload the certificate for the pending CSR.
get /services/https
Returns the current HTTPS certificate, CSR details and indicate if a pending CSR exists.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
HTTP status code 200
Returns the current HTTPS certificate, CSR details and indicate if a pending CSR exists.
Body
Media type: application/json
Type: object
Properties- https: required(object)
Properties relating to the current HTTPS certificate
- common_name: required(string)
Common Name (e.g. server FQDN or YOUR name)
- org_unit: required(string)
Organizational Unit (eg, division)
- organization: required(string)
Organization Name (eg, company)
- locality: required(string)
Locality Name (eg, city)
- state: required(string)
State or Province Name (full name)
- country: required(string)
Country Name (2 letter code)
- email: required(string)
Email Address
- valid_from: required(string)
The date from which the current HTTPS certificate became valid
- valid_to: required(string)
The date at which the current HTTPS certificate expires
- cert: required(string)
The current HTTPS certificate
- key_length: required(integer)
The length of the current HTTPS private key
- key: required(string)
The current HTTPS private key [sensitive]
- csr: required(object)
CSR details
- common_name: (string)
Common Name (e.g. server FQDN or YOUR name)
- org_unit: (string)
Organizational Unit (eg, division)
- organization: (string)
Organization Name (eg, company)
- locality: (string)
Locality Name (eg, city)
- state: (string)
State or Province Name (full name)
- country: (string)
Country Name (2 letter code)
- email: (string)
Email Address
- key_length: (integer)
The length of the private key that will be generated (unless a private key was uploaded)
- csr: (string)
This will only be set if there is a pending CSR. Contains the path part of a link to the pending CSR, needs to be combined with the hostname. eg. "https://localhost" (hostname) + "/link" (csr)
- common_name: (string)
- common_name: required(string)
Examples:
example1:
Default certificate, no CSR details.
{
"https": {
"common_name": "default",
"org_unit": "",
"organization": "",
"locality": "",
"state": "",
"country": "US",
"email": "",
"key_length": 2048,
"valid_from": "Oct 26 22:09:02 2022 GMT",
"valid_to": "Oct 27 22:09:02 2023 GMT",
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"csr": {}
}
}
example2:
Default certificate, pending CSR.
{
"https": {
"common_name": "default",
"org_unit": "",
"organization": "",
"locality": "",
"state": "",
"country": "US",
"email": "",
"key_length": 2048,
"valid_from": "Oct 26 22:09:02 2022 GMT",
"valid_to": "Oct 27 22:09:02 2023 GMT",
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"csr": {
"common_name": "common",
"org_unit": "unit",
"organization": "org",
"locality": "bne",
"state": "qld",
"country": "AT",
"email": "me@example.com",
"key_length": 2048,
"csr": "/api/v2.2/..."
}
}
}
example3:
Default certificate, CSR details but no pending CSR (ie. after pending CSR is deleted).
{
"https": {
"common_name": "default",
"org_unit": "",
"organization": "",
"locality": "",
"state": "",
"country": "US",
"email": "",
"key_length": 2048,
"valid_from": "Oct 26 22:09:02 2022 GMT",
"valid_to": "Oct 27 22:09:02 2023 GMT",
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"csr": {
"common_name": "common",
"org_unit": "unit",
"organization": "org",
"locality": "bne",
"state": "qld",
"country": "AT",
"email": "me@example.com",
"key_length": 2048
}
}
}
example4:
After a new certificate has been uploaded.
{
"https": {
"common_name": "common",
"org_unit": "unit",
"organization": "org",
"locality": "bne",
"state": "qld",
"country": "AT",
"email": "me@example.com",
"key_length": 2048,
"valid_from": "Oct 27 23:39:34 2022 GMT",
"valid_to": "Oct 27 23:39:34 2023 GMT",
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"csr": {
"common_name": "common",
"org_unit": "unit",
"organization": "org",
"locality": "bne",
"state": "qld",
"country": "AT",
"email": "me@example.com",
"key_length": 2048
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/https
Create a new CSR, delete the pending CSR or upload the certificate for the pending CSR.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Possible types:
httpsPut
- https: required(object)
- cert: (string)
Set this to apply the CA-signed certificate. Removes the pending CSR. NOTE that csr.csr must also be set to null. [multi-line-string]
- key: (string)
Setting both cert and key allows replacing the current HTTPS cert. This is useful if a CSR was manually generated, or for config export/import purposes. Does nothing if the certificate matches the current certificate. NOTE that csr.csr must also be set to null. NOTE that this does not work if a CSR has never been generated. [sensitive,multi-line-string]
- csr: (object)
- csr: required(string)
Set this to 'new' to create a new CSR. The CSR will need to be fetched separately (URL provided in csr.csr field in the response). Set this to null (or 'delete') to remove the pending CSR. No other values are accepted.
- common_name: (string)
Common Name (e.g. server FQDN or YOUR name) Required if csr is set to 'new'. [required:csr:=:new]
- org_unit: (string)
Organizational Unit (eg, division) Required if csr is set to 'new'. [required:csr:=:new]
- organization: (string)
Organization Name (eg, company) Required if csr is set to 'new'. [required:csr:=:new]
- locality: (string)
Locality Name (eg, city) Required if csr is set to 'new'. [required:csr:=:new]
- state: (string)
State or Province Name (full name) Required if csr is set to 'new'. [required:csr:=:new]
- country: (one of AE, AL, AM, AR, AT, AU, AW, AZ, BA, BB, BD, BE, BG, BH, BL, BN, BO, BR, BY, BZ, CA, CH, CL, CN, CO, CR, CY, CZ, DE, DK, DO, DZ, EC, EE, EG, ES, FI, FR, GB, GD, GE, GL, GR, GT, GU, HK, HN, HR, HT, HU, ID, IE, IL, IN, IR, IS, IT, JM, JO, JP, KE, KH, KP, KR, KW, KZ, LB, LI, LK, LT, LU, LV, MA, MC, MK, MO, MT, MX, MY, NL, NO, NP, NZ, OM, PA, PE, PG, PH, PK, PL, PR, PT, QA, RO, RU, SA, SE, SG, SI, SK, SV, SY, TH, TN, TR, TT, TW, UA, US, UY, UZ, VE, VN, YE, ZA, ZW)
Country Name (2 letter code) Required if csr is set to 'new'. [required:csr:=:new]
- email: (string)
Email Address Required if csr is set to 'new'. [required:csr:=:new]
- key_length: (integer - minimum: 512 - maximum: 16384)
The length of the generated private key (ignored if private_key is set). This argument is passed to OpenSSL which creates a new RSA key pair. It is recommended to set the key length to at least 2048 bits. Required if csr is set to 'new'. [required:csr:=:new]
- challenge_password: (string)
The CA may require a challenge password to be set.
- private_key: (string)
A private key can be provided rather than letting the system generate one. [multi-line-string]
- csr: required(string)
- cert: (string)
- https: required(object)
httpsPut
- https: required(object)
- cert: (string)
Set this to apply the CA-signed certificate. Removes the pending CSR. NOTE that csr.csr must also be set to null. [multi-line-string]
- key: (string)
Setting both cert and key allows replacing the current HTTPS cert. This is useful if a CSR was manually generated, or for config export/import purposes. Does nothing if the certificate matches the current certificate. NOTE that csr.csr must also be set to null. NOTE that this does not work if a CSR has never been generated. [sensitive,multi-line-string]
- csr: (object)
- csr: required(nil)
Set this to 'new' to create a new CSR. The CSR will need to be fetched separately (URL provided in csr.csr field in the response). Set this to null (or 'delete') to remove the pending CSR. No other values are accepted.
- common_name: (string)
Common Name (e.g. server FQDN or YOUR name) Required if csr is set to 'new'. [required:csr:=:new]
- org_unit: (string)
Organizational Unit (eg, division) Required if csr is set to 'new'. [required:csr:=:new]
- organization: (string)
Organization Name (eg, company) Required if csr is set to 'new'. [required:csr:=:new]
- locality: (string)
Locality Name (eg, city) Required if csr is set to 'new'. [required:csr:=:new]
- state: (string)
State or Province Name (full name) Required if csr is set to 'new'. [required:csr:=:new]
- country: (one of AE, AL, AM, AR, AT, AU, AW, AZ, BA, BB, BD, BE, BG, BH, BL, BN, BO, BR, BY, BZ, CA, CH, CL, CN, CO, CR, CY, CZ, DE, DK, DO, DZ, EC, EE, EG, ES, FI, FR, GB, GD, GE, GL, GR, GT, GU, HK, HN, HR, HT, HU, ID, IE, IL, IN, IR, IS, IT, JM, JO, JP, KE, KH, KP, KR, KW, KZ, LB, LI, LK, LT, LU, LV, MA, MC, MK, MO, MT, MX, MY, NL, NO, NP, NZ, OM, PA, PE, PG, PH, PK, PL, PR, PT, QA, RO, RU, SA, SE, SG, SI, SK, SV, SY, TH, TN, TR, TT, TW, UA, US, UY, UZ, VE, VN, YE, ZA, ZW)
Country Name (2 letter code) Required if csr is set to 'new'. [required:csr:=:new]
- email: (string)
Email Address Required if csr is set to 'new'. [required:csr:=:new]
- key_length: (integer - minimum: 512 - maximum: 16384)
The length of the generated private key (ignored if private_key is set). This argument is passed to OpenSSL which creates a new RSA key pair. It is recommended to set the key length to at least 2048 bits. Required if csr is set to 'new'. [required:csr:=:new]
- challenge_password: (string)
The CA may require a challenge password to be set.
- private_key: (string)
A private key can be provided rather than letting the system generate one. [multi-line-string]
- csr: required(nil)
- cert: (string)
- https: required(object)
Examples:
example1:
Create a new CSR (generating a new private key)
{
"https": {
"csr": {
"csr": "new",
"common_name": "common",
"org_unit": "unit",
"organization": "org",
"locality": "bne",
"state": "qld",
"country": "AT",
"email": "me@example.com",
"key_length": 2048
}
}
}
example2:
Create a new CSR (specifying a private key and CA-required challenge password)
{
"https": {
"csr": {
"csr": "new",
"common_name": "common",
"org_unit": "unit",
"organization": "org",
"locality": "bne",
"state": "qld",
"country": "AT",
"email": "me@example.com",
"key_length": 2048,
"private_key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"challenge_password": "password"
}
}
}
example3:
Delete the pending CSR
{
"https": {
"csr": {
"csr": null
}
}
}
example4:
Upload the certificate for the pending CSR.
{
"https": {
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"csr": {
"csr": null
}
}
}
example5:
Upload a new certificate and private key pair. NOTE that this does not work if a CSR has never been generated.
{
"https": {
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"csr": {
"csr": null
}
}
}
HTTP status code 200
Returns the current HTTPS certificate, CSR details and indicate if a pending CSR exists.
Body
Media type: application/json
Type: object
Properties- https: required(object)
Properties relating to the current HTTPS certificate
- common_name: required(string)
Common Name (e.g. server FQDN or YOUR name)
- org_unit: required(string)
Organizational Unit (eg, division)
- organization: required(string)
Organization Name (eg, company)
- locality: required(string)
Locality Name (eg, city)
- state: required(string)
State or Province Name (full name)
- country: required(string)
Country Name (2 letter code)
- email: required(string)
Email Address
- valid_from: required(string)
The date from which the current HTTPS certificate became valid
- valid_to: required(string)
The date at which the current HTTPS certificate expires
- cert: required(string)
The current HTTPS certificate
- key_length: required(integer)
The length of the current HTTPS private key
- key: required(string)
The current HTTPS private key [sensitive]
- csr: required(object)
CSR details
- common_name: (string)
Common Name (e.g. server FQDN or YOUR name)
- org_unit: (string)
Organizational Unit (eg, division)
- organization: (string)
Organization Name (eg, company)
- locality: (string)
Locality Name (eg, city)
- state: (string)
State or Province Name (full name)
- country: (string)
Country Name (2 letter code)
- email: (string)
Email Address
- key_length: (integer)
The length of the private key that will be generated (unless a private key was uploaded)
- csr: (string)
This will only be set if there is a pending CSR. Contains the path part of a link to the pending CSR, needs to be combined with the hostname. eg. "https://localhost" (hostname) + "/link" (csr)
- common_name: (string)
- common_name: required(string)
Examples:
example1:
Default certificate, no CSR details.
{
"https": {
"common_name": "default",
"org_unit": "",
"organization": "",
"locality": "",
"state": "",
"country": "US",
"email": "",
"key_length": 2048,
"valid_from": "Oct 26 22:09:02 2022 GMT",
"valid_to": "Oct 27 22:09:02 2023 GMT",
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"csr": {}
}
}
example2:
Default certificate, pending CSR.
{
"https": {
"common_name": "default",
"org_unit": "",
"organization": "",
"locality": "",
"state": "",
"country": "US",
"email": "",
"key_length": 2048,
"valid_from": "Oct 26 22:09:02 2022 GMT",
"valid_to": "Oct 27 22:09:02 2023 GMT",
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"csr": {
"common_name": "common",
"org_unit": "unit",
"organization": "org",
"locality": "bne",
"state": "qld",
"country": "AT",
"email": "me@example.com",
"key_length": 2048,
"csr": "/api/v2.2/..."
}
}
}
example3:
Default certificate, CSR details but no pending CSR (ie. after pending CSR is deleted).
{
"https": {
"common_name": "default",
"org_unit": "",
"organization": "",
"locality": "",
"state": "",
"country": "US",
"email": "",
"key_length": 2048,
"valid_from": "Oct 26 22:09:02 2022 GMT",
"valid_to": "Oct 27 22:09:02 2023 GMT",
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"csr": {
"common_name": "common",
"org_unit": "unit",
"organization": "org",
"locality": "bne",
"state": "qld",
"country": "AT",
"email": "me@example.com",
"key_length": 2048
}
}
}
example4:
After a new certificate has been uploaded.
{
"https": {
"common_name": "common",
"org_unit": "unit",
"organization": "org",
"locality": "bne",
"state": "qld",
"country": "AT",
"email": "me@example.com",
"key_length": 2048,
"valid_from": "Oct 27 23:39:34 2022 GMT",
"valid_to": "Oct 27 23:39:34 2023 GMT",
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"csr": {
"common_name": "common",
"org_unit": "unit",
"organization": "org",
"locality": "bne",
"state": "qld",
"country": "AT",
"email": "me@example.com",
"key_length": 2048
}
}
}
HTTP status code 400
Returns an error after the operation failed due to invalid user input.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 14,
"text": " String did not conform to the expected format.",
"args": {
"uuid": "root-1-services_https_csr_email"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Returns an error after the operation failed.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 14,
"text": " String did not conform to the expected format.",
"args": {
"uuid": "root-1-services_https_csr_email"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
This entity is used to download the CSR object.
get /services/https/csr/download
This entity is used to download the CSR object.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- csr: required(object)
- csr: required(string)
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Trivial File Transfer Protocol (TFTP) is a service that allows files to be transferred to or from the NetOps Console Server appliance. This entity provides access to the TFTP server configuration on the system.
Retrieves the TFTP server configuration.
Set the TFTP server configuration.
get /services/tftp
Retrieves the TFTP server configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current TFTP configuration.
Body
Media type: application/json
Type: object
Properties- tftp: required(object)
- enabled: required(boolean)
Enable the TFTP service.
- path: required(string - pattern: ^\/([A-Za-z0-9]){1}(.)*$)
The storage location of the TFTP server on disk. The default location is
/mnt/nvram/srv
. [regexerr:A '/' at the beginning of the filepath followed by at least one alphanumeric character]
- enabled: required(boolean)
Example:
{
"tftp": {
"enabled": true,
"path": "/mnt/nvram/srv"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/tftp
Set the TFTP server configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- tftp: required(object)
- enabled: required(boolean)
Enable the TFTP service.
- path: required(string - pattern: ^\/([A-Za-z0-9]){1}(.)*$)
The storage location of the TFTP server on disk. The default location is
/mnt/nvram/srv
. [regexerr:A '/' at the beginning of the filepath followed by at least one alphanumeric character]
- enabled: required(boolean)
Example:
{
"tftp": {
"enabled": true,
"path": "/mnt/nvram/srv"
}
}
HTTP status code 200
Returns the current TFTP configuration.
Body
Media type: application/json
Type: object
Properties- tftp: required(object)
- enabled: required(boolean)
Enable the TFTP service.
- path: required(string - pattern: ^\/([A-Za-z0-9]){1}(.)*$)
The storage location of the TFTP server on disk. The default location is
/mnt/nvram/srv
. [regexerr:A '/' at the beginning of the filepath followed by at least one alphanumeric character]
- enabled: required(boolean)
Example:
{
"tftp": {
"enabled": true,
"path": "/mnt/nvram/srv"
}
}
HTTP status code 400
Returns an error after the operation failed due to invalid request.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'enabled' was not provided in the request",
"args": {
"param": "services_tftp_enabled-1"
},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Provides access to the NTP client configuration on the system.
Fetch NTP client configuration.
Set the NTP client configuration, including enabling/disabling the NTP service.
get /services/ntp
Fetch NTP client configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current NTP configuration.
Body
Media type: application/json
Type: object
Properties- ntp: required(object)
- enabled: required(boolean)
Enables or disables the NTP daemon.
- servers: (array of object)
List of NTP servers. [required:enabled:=:true]
Items: items
- value: required(string)
The IPv4/IPv6 address or hostname of an NTP server
- key: (object)
The authentication key used to securely access this NTP server.
- value: (string)
The key value [optional:always,sensitive]
- index: (integer - minimum: 1)
The key ID [optional:always]
- format: (one of ASCII, HEX)
The key value can be specified as a string of ASCII characters or as a hexadecimal number [optional:always]
- algorithm: (one of MD5, SHA1, SHA256, SHA384, SHA512, SHA3-224, SHA3-256, SHA3-384, SHA3-512, AES128, AES256)
The algorithm is a name of a cryptographic hash function or cipher which is used to generate and verify the MAC [optional:always]
- value: (string)
- value: required(string)
- id: required(string)
The unique identifier for this NTP server.
- enabled: required(boolean)
Example:
{
"ntp": {
"enabled": true,
"servers": [
{
"value": "0.pool.ntp.org"
},
{
"value": "1.pool.ntp.org"
},
{
"value": "10.10.10.10"
},
{
"value": "10.10.10.11",
"key": {
"value": "7EA62AE64D190114D46D5A082F948EC1",
"index": 30,
"format": "HEX",
"algorithm": "AES128"
}
}
],
"id": "root-1-services_ntp"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/ntp
Set the NTP client configuration, including enabling/disabling the NTP service.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- ntp: required(object)
- enabled: required(boolean)
Enables or disables the NTP daemon.
- servers: (array of object)
List of NTP servers. [required:enabled:=:true]
Items: items
- value: required(string)
The IPv4/IPv6 address or hostname of an NTP server
- key: (object)
The authentication key used to securely access this NTP server.
- value: (string)
The key value [optional:always,sensitive]
- index: (integer - minimum: 1)
The key ID [optional:always]
- format: (one of ASCII, HEX)
The key value can be specified as a string of ASCII characters or as a hexadecimal number [optional:always]
- algorithm: (one of MD5, SHA1, SHA256, SHA384, SHA512, SHA3-224, SHA3-256, SHA3-384, SHA3-512, AES128, AES256)
The algorithm is a name of a cryptographic hash function or cipher which is used to generate and verify the MAC [optional:always]
- value: (string)
- value: required(string)
- enabled: required(boolean)
Example:
{
"ntp": {
"enabled": true,
"servers": [
{
"value": "0.pool.ntp.org"
},
{
"value": "1.pool.ntp.org"
},
{
"value": "2.pool.ntp.org"
},
{
"value": "3.pool.ntp.org"
},
{
"value": "10.20.30.40",
"key": {
"value": "crocus",
"index": 20,
"format": "ASCII",
"algorithm": "MD5"
}
},
{
"value": "10.20.30.41",
"key": {
"value": "933F62BE1D604E68A81B557F18CFA200483F5B70",
"index": 25,
"format": "HEX",
"algorithm": "SHA1"
}
},
{
"value": "ntp.example.com",
"key": {
"value": "37DDCBC67BB902BCB8E995977FAB4D2B5642F5B32EBCEEE421921D97E5CBFE39",
"index": 31,
"format": "HEX",
"algorithm": "AES256"
}
}
]
}
}
HTTP status code 200
Returns the updated NTP configuration.
Body
Media type: application/json
Type: object
Properties- ntp: required(object)
- enabled: required(boolean)
Enables or disables the NTP daemon.
- servers: (array of object)
List of NTP servers. [required:enabled:=:true]
Items: items
- value: required(string)
The IPv4/IPv6 address or hostname of an NTP server
- key: (object)
The authentication key used to securely access this NTP server.
- value: (string)
The key value [optional:always,sensitive]
- index: (integer - minimum: 1)
The key ID [optional:always]
- format: (one of ASCII, HEX)
The key value can be specified as a string of ASCII characters or as a hexadecimal number [optional:always]
- algorithm: (one of MD5, SHA1, SHA256, SHA384, SHA512, SHA3-224, SHA3-256, SHA3-384, SHA3-512, AES128, AES256)
The algorithm is a name of a cryptographic hash function or cipher which is used to generate and verify the MAC [optional:always]
- value: (string)
- value: required(string)
- id: required(string)
The unique identifier for this NTP server.
- enabled: required(boolean)
Example:
{
"ntp": {
"enabled": true,
"servers": [
{
"value": "0.pool.ntp.org"
},
{
"value": "1.pool.ntp.org"
},
{
"value": "2.pool.ntp.org"
},
{
"value": "3.pool.ntp.org"
},
{
"value": "10.20.30.40",
"key": {
"value": "crocus",
"index": 20,
"format": "ASCII",
"algorithm": "MD5"
}
},
{
"value": "10.20.30.41",
"key": {
"value": "933F62BE1D604E68A81B557F18CFA200483F5B70",
"index": 25,
"format": "HEX",
"algorithm": "SHA1"
}
},
{
"value": "ntp.example.com",
"key": {
"value": "37DDCBC67BB902BCB8E995977FAB4D2B5642F5B32EBCEEE421921D97E5CBFE39",
"index": 31,
"format": "HEX",
"algorithm": "AES256"
}
}
],
"id": "root-1-services_ntp"
}
}
HTTP status code 400
Returns an error after the operation failed due to invalid request.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'services_syslog_servers-1' was not provided in the request",
"args": {
"param": "services_syslog_servers-1"
},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Error saving NTP configuration.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 25,
"text": "'' is not a valid hostname",
"args": {
"address": "",
"uuid": "services_ntp_servers-0"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Provides information the current synchronization state of NTP
Gets the current sync status for NTP
get /services/ntp/status
Gets the current sync status for NTP
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
An object containing an array of ports with their corresponding signal values
Body
Media type: application/json
Type: object
Properties- ntp_status: required(object)
- status: required(string)
General status string about the current NTP synchronization state
- last_sync_utc: required(string)
UTC time at which we last synchronized with NTP
- sync_server: required(string)
Identifier of the server we last synchronized to
- status: required(string)
Example:
{
"ntp_status": {
"status": "attempting-to-sync",
"last_sync_utc": "Fri Feb 3 15:00:29 2012 UTC",
"sync_server": "1.2.3.4 (a.b.c)"
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 500
Error encountered while attempting to obtain ntp status
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Provides access to the Network Discovery Protocols (LLDP/CDP) configuration.
Fetch the Network Discovery Protocols configuration.
Modify Network Discovery Protocols configuration.
get /services/lldp
Fetch the Network Discovery Protocols configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current Network Discovery Protocols configuration.
Body
Media type: application/json
Type: object
Properties- lldp: required(object)
- enabled: required(boolean)
This setting enables the Link Layer Discovery Protocol (LLDP) and Cisco Discovery Protocol (CDP) services.
- description: (string)
This setting overrides the default system description sent by the network discovery protocol daemon. The default description is the kernel name, the node name, the kernel version, the build date and the architecture.
- platform: (string)
This setting overrides the CDP platform name. The default name is the kernel name (Linux).
- physifs: required(array of string)
The set of physical interfaces to perform LLDP/CDP monitoring on. If this is empty, then all physical interfaces will be used.
- enabled: required(boolean)
Example:
{
"lldp": {
"enabled": true,
"platform": "platform 1",
"description": "description 1",
"physifs": [
"net1",
"net2"
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/lldp
Modify Network Discovery Protocols configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- lldp: required(object)
- enabled: required(boolean)
This setting enables the Link Layer Discovery Protocol (LLDP) and Cisco Discovery Protocol (CDP) services.
- description: (string)
This setting overrides the default system description sent by the network discovery protocol daemon. The default description is the kernel name, the node name, the kernel version, the build date and the architecture.
- platform: (string)
This setting overrides the CDP platform name. The default name is the kernel name (Linux).
- physifs: required(array of string)
The set of physical interfaces to perform LLDP/CDP monitoring on. If this is empty, then all physical interfaces will be used.
- enabled: required(boolean)
Example:
{
"lldp": {
"enabled": true,
"platform": "platform 1",
"description": "description 1",
"physifs": [
"net1",
"net2"
]
}
}
HTTP status code 200
Created the Network Discovery Protocols configuration.
Body
Media type: application/json
Type: object
Properties- lldp: required(object)
- enabled: required(boolean)
This setting enables the Link Layer Discovery Protocol (LLDP) and Cisco Discovery Protocol (CDP) services.
- description: (string)
This setting overrides the default system description sent by the network discovery protocol daemon. The default description is the kernel name, the node name, the kernel version, the build date and the architecture.
- platform: (string)
This setting overrides the CDP platform name. The default name is the kernel name (Linux).
- physifs: required(array of string)
The set of physical interfaces to perform LLDP/CDP monitoring on. If this is empty, then all physical interfaces will be used.
- enabled: required(boolean)
Example:
{
"lldp": {
"enabled": true,
"platform": "platform 1",
"description": "description 1",
"physifs": [
"net1",
"net2"
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Provides access to the remote syslog server configuration.
Fetch remote syslog server configuration list.
Create a new syslog server data in the configuration.
get /services/syslog
Fetch remote syslog server configuration list.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current syslog server configuration.
Body
Media type: application/json
Type: object
Properties- syslogServers: required(array of object)
Items: items
- id: required(string)
Unique ID assigned to the syslog server configuration. This value is used to query the '/services/syslog/:id:' endpoint. This value is automatically assigned.
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this syslog server in command line tools. It cannot be used to identify a specific instance when querying the '/services/syslog/:id:' endpoint, the 'id' value must be used. This value is automatically assigned.
- port: required(integer)
Port number on which the syslog server is listening. The default port is 514 for UDP and 601 for TCP.
- protocol: required(one of TCP, UDP - default: UDP)
Protocol used to communicate with the syslog server.
- address: required(string)
IP address of the syslog server.
- description: required(string)
A description of the syslog server for informational purposes only. This field is not used to uniquely identify the server.
- port_logging_enabled: required(boolean)
Enable sending of serial port data logs to this remote syslog server. Logging must be separately enabled for each port for there to be any events, and only those ports that have logging explicitly enabled will have port data logged.
- min_severity: required(one of emergency, alert, critical, error, warning, notice, info, debug)
Messages with a severity level equal to or greater than this severity are sent to the remote syslog server. 'debug' is the least severe, 'emergency' is the most severe. [no_sorting_required]
- id: required(string)
Example:
{
"syslogServers": [
{
"id": "services_syslog_servers-31",
"multi_field_identifier": "0.au.pool.rsyslog.org:601/UDP",
"port": 601,
"protocol": "UDP",
"address": "0.au.pool.rsyslog.org",
"description": "Remote logging server",
"port_logging_enabled": true,
"min_severity": "info"
},
{
"id": "services_syslog_servers-32",
"multi_field_identifier": "2001:b:c:d::8329:602/UDP",
"port": 602,
"protocol": "UDP",
"address": "2001:b:c:d::8329",
"description": "Remote port logging server",
"port_logging_enabled": false,
"min_severity": "alert"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /services/syslog
Create a new syslog server data in the configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- syslogServer: required(object)
- port: (integer - minimum: 1 - maximum: 65535)
Port number on which the syslog server is listening. The default port is 514 for UDP and 601 for TCP.
- protocol: (one of TCP, UDP - default: UDP)
Protocol used to communicate with the syslog server.
- address: required(string)
IP address of the syslog server.
- description: (string)
A description of the syslog server (optional) for informational purposes only. This field is not used to uniquely identify the server.
- port_logging_enabled: (boolean)
Enable sending of serial port data logs to this remote syslog server. Logging must be separately enabled for each port for there to be any events, and only those ports that have logging explicitly enabled will have port data logged.
- min_severity: (one of emergency, alert, critical, error, warning, notice, info, debug)
Messages with a severity level equal to or greater than this severity are sent to the remote syslog server. 'debug' is the least severe, 'emergency' is the most severe. [no_sorting_required]
- port: (integer - minimum: 1 - maximum: 65535)
Example:
{
"syslogServer": {
"port": 1000,
"protocol": "UDP",
"address": "192.168.33.199",
"description": "Remote logging server",
"port_logging_enabled": true,
"min_severity": "info"
}
}
HTTP status code 200
Created syslog server configuration
Body
Media type: application/json
Type: object
Properties- syslogServer: required(object)
- id: required(string)
Unique ID assigned to the syslog server configuration. This value is used to query the '/services/syslog/:id:' endpoint. This value is automatically assigned.
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this syslog server in command line tools. It cannot be used to identify a specific instance when querying the '/services/syslog/:id:' endpoint, the 'id' value must be used. This value acts as a secondary unique key and is automatically assigned and is made up of the combination of several fields (address, port, protocol).
- port: required(integer)
Port number on which the syslog server is listening. The default port is 514 for UDP and 601 for TCP.
- protocol: required(one of TCP, UDP - default: UDP)
Protocol used to communicate with the syslog server.
- address: required(string)
IP address of the syslog server.
- description: required(string)
A description of the syslog server for informational purposes only. This field is not used to uniquely identify the server.
- port_logging_enabled: required(boolean)
Enable sending of serial port data logs to this remote syslog server. Logging must be separately enabled for each port for there to be any events, and only those ports that have logging explicitly enabled will have port data logged.
- min_severity: required(one of emergency, alert, critical, error, warning, notice, info, debug)
Messages with a severity level equal to or greater than this severity are sent to the remote syslog server. 'debug' is the least severe, 'emergency' is the most severe. [no_sorting_required]
- id: required(string)
Example:
{
"syslogServer": {
"id": "services_syslog_servers-2",
"multi_field_identifier": "192.168.33.199:1000/UDP",
"port": 1000,
"protocol": "UDP",
"address": "192.168.33.199",
"description": "Remote logging server",
"port_logging_enabled": true,
"min_severity": "info"
}
}
HTTP status code 400
Failed to initiate syslog server creation due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 22,
"text": "Element [protocol] is of the wrong type",
"args": {
"uuid": "protocol"
},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Fetch a configured syslog server by id.
Set the syslog server configuration
Delete a syslog server.
get /services/syslog/{syslog_server_id}
Fetch a configured syslog server by id.
NetOps Console Server base authentication scheme.
URI Parameters
- syslog_server_id: required(string)
unique identifier for syslog servers
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the requested syslog server configuration.
Body
Media type: application/json
Type: object
Properties- syslogServer: required(object)
- id: required(string)
Unique ID assigned to the syslog server configuration. This value is used to query the '/services/syslog/:id:' endpoint. This value is automatically assigned.
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this syslog server in command line tools. It cannot be used to identify a specific instance when querying the '/services/syslog/:id:' endpoint, the 'id' value must be used. This value acts as a secondary unique key and is automatically assigned and is made up of the combination of several fields (address, port, protocol).
- port: required(integer)
Port number on which the syslog server is listening. The default port is 514 for UDP and 601 for TCP.
- protocol: required(one of TCP, UDP - default: UDP)
Protocol used to communicate with the syslog server.
- address: required(string)
IP address of the syslog server.
- description: required(string)
A description of the syslog server for informational purposes only. This field is not used to uniquely identify the server.
- port_logging_enabled: required(boolean)
Enable sending of serial port data logs to this remote syslog server. Logging must be separately enabled for each port for there to be any events, and only those ports that have logging explicitly enabled will have port data logged.
- min_severity: required(one of emergency, alert, critical, error, warning, notice, info, debug)
Messages with a severity level equal to or greater than this severity are sent to the remote syslog server. 'debug' is the least severe, 'emergency' is the most severe. [no_sorting_required]
- id: required(string)
Example:
{
"syslogServer": {
"id": "services_syslog_servers-1",
"multi_field_identifier": "192.168.33.200:705/UDP",
"port": 705,
"protocol": "UDP",
"address": "192.168.33.200",
"description": "Remote logging server",
"port_logging_enabled": false,
"min_severity": "warning"
}
}
HTTP status code 400
Returns an error after the operation failed due to invalid request.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'services_syslog-1' was not provided in the request",
"args": {
"param": "services_syslog_servers-1"
},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 500
Error saving syslog configuration.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 2,
"code": 25,
"text": "'' is not a valid hostname",
"args": {
"address": "",
"uuid": "services_syslog_servers-1"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/syslog/{syslog_server_id}
Set the syslog server configuration
NetOps Console Server base authentication scheme.
URI Parameters
- syslog_server_id: required(string)
unique identifier for syslog servers
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- syslogServer: required(object)
- port: (integer - minimum: 1 - maximum: 65535)
Port number on which the syslog server is listening. The default port is 514 for UDP and 601 for TCP.
- protocol: (one of TCP, UDP - default: UDP)
Protocol used to communicate with the syslog server.
- address: required(string)
IP address of the syslog server.
- description: (string)
A description of the syslog server (optional) for informational purposes only. This field is not used to uniquely identify the server.
- port_logging_enabled: (boolean)
Enable sending of serial port data logs to this remote syslog server. Logging must be separately enabled for each port for there to be any events, and only those ports that have logging explicitly enabled will have port data logged.
- min_severity: (one of emergency, alert, critical, error, warning, notice, info, debug)
Messages with a severity level equal to or greater than this severity are sent to the remote syslog server. 'debug' is the least severe, 'emergency' is the most severe. [no_sorting_required]
- port: (integer - minimum: 1 - maximum: 65535)
Example:
{
"syslogServer": {
"address": "192.168.33.199",
"port": 1000,
"protocol": "UDP",
"description": "Remote logging server",
"port_logging_enabled": false,
"min_severity": "debug"
}
}
HTTP status code 200
Returns the updated syslog server configuration.
Body
Media type: application/json
Type: object
Properties- syslogServer: required(object)
- id: required(string)
Unique ID assigned to the syslog server configuration. This value is used to query the '/services/syslog/:id:' endpoint. This value is automatically assigned.
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this syslog server in command line tools. It cannot be used to identify a specific instance when querying the '/services/syslog/:id:' endpoint, the 'id' value must be used. This value acts as a secondary unique key and is automatically assigned and is made up of the combination of several fields (address, port, protocol).
- port: required(integer)
Port number on which the syslog server is listening. The default port is 514 for UDP and 601 for TCP.
- protocol: required(one of TCP, UDP - default: UDP)
Protocol used to communicate with the syslog server.
- address: required(string)
IP address of the syslog server.
- description: required(string)
A description of the syslog server for informational purposes only. This field is not used to uniquely identify the server.
- port_logging_enabled: required(boolean)
Enable sending of serial port data logs to this remote syslog server. Logging must be separately enabled for each port for there to be any events, and only those ports that have logging explicitly enabled will have port data logged.
- min_severity: required(one of emergency, alert, critical, error, warning, notice, info, debug)
Messages with a severity level equal to or greater than this severity are sent to the remote syslog server. 'debug' is the least severe, 'emergency' is the most severe. [no_sorting_required]
- id: required(string)
Example:
{
"syslogServer": {
"id": "services_syslog_servers-1",
"multi_field_identifier": "192.168.33.200:705/UDP",
"port": 705,
"protocol": "UDP",
"address": "192.168.33.200",
"description": "Remote logging server",
"port_logging_enabled": false,
"min_severity": "debug"
}
}
HTTP status code 400
Returns an error after the operation failed due to invalid request.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'services_syslog-1' was not provided in the request",
"args": {
"param": "services_syslog_servers-1"
},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Error saving syslog configuration.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 25,
"text": "'' is not a valid hostname",
"args": {
"address": "",
"uuid": "services_syslog_servers-1"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /services/syslog/{syslog_server_id}
Delete a syslog server.
NetOps Console Server base authentication scheme.
URI Parameters
- syslog_server_id: required(string)
unique identifier for syslog servers
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
syslog server deleted
HTTP status code 400
Returns an error after the operation failed due to invalid request.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'services_syslog-1' was not provided in the request",
"args": {
"param": "services_syslog_servers-1"
},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
syslog server does not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'services_syslog_servers-2'",
"args": {
"uuid": "services_syslog_servers-2"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure the SNMP TRAP/INFORM settings.
Get the snmp manager legacy configuration.
Set the snmp manager legacy configuration.
get /services/snmp_manager
Get the snmp manager legacy configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, masked - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmp_manager: required(object)
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this snmp alert manager
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: required(string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send. [visible:version:in:v2c|v3]
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive,visible:version:in:v1|v2c,required:version:in:v1|v2c]
- auth_protocol: (one of SHA, MD5)
[visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
[sensitive,visible:security_level:in:authNoPriv|authPriv]
- username: (string)
[visible:version:=:v3]
- engine_id: (string)
[visible:version:=:v3]
- privacy_protocol: (one of AES, DES)
[visible:security_level:=:authPriv]
- privacy_password: (string)
[sensitive,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
[visible:version:=:v3]
Example:
{
"snmp_manager": {
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/snmp_manager
Set the snmp manager legacy configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- snmp_manager: required(object)
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: (string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send. [visible:version:in:v2c|v3]
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive,visible:version:in:v1|v2c,required:version:in:v1|v2c]
- auth_protocol: (one of SHA, MD5)
[visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
[sensitive,visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- username: (string)
[visible:version:=:v3]
- engine_id: (string)
[visible:version:=:v3]
- privacy_protocol: (one of AES, DES)
[visible:version:=:v3,visible:security_level:=:authPriv]
- privacy_password: (string)
[sensitive,visible:version:=:v3,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
[visible:version:=:v3]
Example:
{
"snmp_manager": {
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"auth_password": "secret123",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"privacy_password": "secret123",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmp_manager: required(object)
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this snmp alert manager
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: required(string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send. [visible:version:in:v2c|v3]
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive,visible:version:in:v1|v2c,required:version:in:v1|v2c]
- auth_protocol: (one of SHA, MD5)
[visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
[sensitive,visible:security_level:in:authNoPriv|authPriv]
- username: (string)
[visible:version:=:v3]
- engine_id: (string)
[visible:version:=:v3]
- privacy_protocol: (one of AES, DES)
[visible:security_level:=:authPriv]
- privacy_password: (string)
[sensitive,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
[visible:version:=:v3]
Example:
{
"snmp_manager": {
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
SNMP Alert Managers are used to receive and log SNMP TRAP and INFORM messages sent by the NetOps Console Server. To receive SNMP alerts generated by the system at least one SNMP Alert Manager must be configured.
Get the snmp manager configuration.
Add a new snmp manager.
get /services/snmp_alert_managers
Get the snmp manager configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, masked - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmp_alert_managers: required(array of object)
Items: items
- id: required(string)
The primary unique identifier for this SNMP Alert Manager.
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this SNMP Alert Manager when using ogcli. It consists of "\
\:\\/\ " - name: (string)
A description used to identify the SNMP Alert Manager.
- protocol: required(one of UDP, TCP, UDP6, TCP6)
The transport protocol used to deliver SNMP alert messages to the SNMP Alert Manager.
- address: required(string)
The IPv4/IPv6 address or domain name of the SNMP Alert Manager where the SNMP alerts will be sent.
- port: (integer - minimum: 1 - maximum: 65535)
The port used by the SNMP Alert Managaer to receive SNMP alerts. The default value is 162.
- msg_type: required(one of TRAP, INFORM)
The type of SNMP message to send to the SNMP Alert Manager. The INFORM option will receive an acknowledgment from the SNMP Alert Manager and will retransmit if required. The TRAP option does not expect acknowledgments. [visible:version:in:v2c|v3]
- version: required(one of v1, v2c, v3)
The version of SNMP that will be used when sending a message to this SNMP Alert Manager.
- community: (string)
A group name authorized to send traps by the SNMP Alert Manager configuration for SNMPv1 and SNMPv2c. This needs to match what is setup in the SNMP Alert Manager. Examples of commonly used values are 'log', 'execute', 'net' and 'public'. [sensitive,visible:version:in:v1|v2c,required:version:in:v1|v2c]
- auth_protocol: (one of SHA, MD5)
The encryption algorithm to use for authentication with SNMPv3. [visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The plaintext authentication password to use with SNMPv3. [sensitive,visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- username: (string)
Set the username to be used for authentication with SNMPv3 to allow clients to retrieve and set values, it is not related to system users. [visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- engine_id: (string)
A unique identifier for the SNMP agent entity. This needs to match the engineID of the SNMP Alert Manager. For example,
0x80001f8803555000000000
. [visible:version:=:v3] - privacy_protocol: (one of AES, DES)
The encryption algorithm to use for privacy with SNMPv3. [visible:version:=:v3,visible:security_level:=:authPriv]
- privacy_password: (string)
The plaintext privacy password to use with SNMPv3. [sensitive,visible:version:=:v3,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Set the User-based Security Model to use for communication with the SNMP Alert Manager. [visible:version:=:v3]
- id: required(string)
Example:
{
"snmp_alert_managers": [
{
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /services/snmp_alert_managers
Add a new snmp manager.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- snmp_alert_manager: required(object)
- name: (string)
A description used to identify the SNMP Alert Manager.
- protocol: required(one of UDP, TCP, UDP6, TCP6)
The transport protocol used to deliver SNMP alert messages to the SNMP Alert Manager.
- address: (string)
The IPv4/IPv6 address or domain name of the SNMP Alert Manager where the SNMP alerts will be sent.
- port: (integer - minimum: 1 - maximum: 65535)
The port used by the SNMP Alert Managaer to receive SNMP alerts. The default value is 162.
- msg_type: required(one of TRAP, INFORM)
The type of SNMP message to send to the SNMP Alert Manager. The INFORM option will receive an acknowledgment from the SNMP Alert Manager and will retransmit if required. The TRAP option does not expect acknowledgments. [visible:version:in:v2c|v3,required:version:in:v2c|v3]
- version: required(one of v1, v2c, v3)
The version of SNMP that will be used when sending a message to this SNMP Alert Manager. Additional properties may be required depending on the version specified.
- community: (string)
A shared secret that allows SNMP alerts to be sent by the SNMP Alert Manager configuration for SNMPv1 and SNMPv2c. This needs to match what is setup in the SNMP Alert Manager. Examples of commonly used values are 'log', 'execute', 'net' and 'public'. [sensitive,visible:version:in:v1|v2c,required:version:in:v1|v2c]
- auth_protocol: (one of SHA, MD5)
The encryption algorithm to use for authentication with SNMPv3. [visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The plaintext authentication password to use with SNMPv3. [sensitive,visible:security_level:in:authNoPriv|authPriv]
- username: (string)
Set the username to be used for authentication with SNMPv3 to allow clients to retrieve and set values, it is not related to system users. [visible:version:=:v3]
- engine_id: (string)
A unique identifier for the SNMP agent entity. This needs to match the engineID of the SNMP Alert Manager. For example,
0x80001f8803555000000000
. [visible:version:=:v3] - privacy_protocol: (one of AES, DES)
The encryption algorithm to use for privacy with SNMPv3. [visible:security_level:=:authPriv]
- privacy_password: (string)
The plaintext privacy password to use with SNMPv3. [sensitive,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv - default: noAuthNoPriv)
Set the User-based Security Model to use for communication with the SNMP Alert Manager. [visible:version:=:v3,required:version:=:v3]
- name: (string)
Example:
{
"snmp_alert_manager": {
"name": "A SNMP Alert Manager",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}
HTTP status code 200
The snmp manager was added.
Body
Media type: application/json
Type: object
Properties- snmp_alert_manager: required(object)
The SNMP manager configuration
- id: required(string)
The primary unique identifier for this SNMP Alert Manager.
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this SNMP Alert Manager when using ogcli. It consists of "\
\:\\/\ " - name: (string)
A description used to identify the SNMP Alert Manager.
- protocol: required(one of UDP, TCP, UDP6, TCP6)
The transport protocol used to deliver SNMP alert messages to the SNMP Alert Manager.
- address: required(string)
The IPv4/IPv6 address or domain name of the SNMP Alert Manager where the SNMP alerts will be sent.
- port: (integer - minimum: 1 - maximum: 65535)
The port used by the SNMP Alert Managaer to receive SNMP alerts. The default value is 162.
- msg_type: required(one of TRAP, INFORM)
The type of SNMP message to send to the SNMP Alert Manager. The INFORM option will receive an acknowledgment from the SNMP Alert Manager and will retransmit if required. The TRAP option does not expect acknowledgments. [visible:version:in:v2c|v3]
- version: required(one of v1, v2c, v3)
The version of SNMP that will be used when sending a message to this SNMP Alert Manager.
- community: (string)
A group name authorized to send traps by the SNMP Alert Manager configuration for SNMPv1 and SNMPv2c. This needs to match what is setup in the SNMP Alert Manager. Examples of commonly used values are 'log', 'execute', 'net' and 'public'. [sensitive,visible:version:in:v1|v2c,required:version:in:v1|v2c]
- auth_protocol: (one of SHA, MD5)
The encryption algorithm to use for authentication with SNMPv3. [visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The plaintext authentication password to use with SNMPv3. [sensitive,visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- username: (string)
Set the username to be used for authentication with SNMPv3 to allow clients to retrieve and set values, it is not related to system users. [visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- engine_id: (string)
A unique identifier for the SNMP agent entity. This needs to match the engineID of the SNMP Alert Manager. For example,
0x80001f8803555000000000
. [visible:version:=:v3] - privacy_protocol: (one of AES, DES)
The encryption algorithm to use for privacy with SNMPv3. [visible:version:=:v3,visible:security_level:=:authPriv]
- privacy_password: (string)
The plaintext privacy password to use with SNMPv3. [sensitive,visible:version:=:v3,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Set the User-based Security Model to use for communication with the SNMP Alert Manager. [visible:version:=:v3]
- id: required(string)
Example:
{
"snmp_alert_manager": {
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP",
"name": "A SNMP Alert Manager",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and update information for a specific SNMP Alert Manager.
Get the configuration of an SNMP Manager
Update settings for SNMP Managers on the NetOps Console Server appliance.
Delete an snmp manager
get /services/snmp_alert_managers/{id}
Get the configuration of an SNMP Manager
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, masked - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmp_alert_manager: required(object)
The SNMP manager configuration
- id: required(string)
The primary unique identifier for this SNMP Alert Manager.
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this SNMP Alert Manager when using ogcli. It consists of "\
\:\\/\ " - name: (string)
A description used to identify the SNMP Alert Manager.
- protocol: required(one of UDP, TCP, UDP6, TCP6)
The transport protocol used to deliver SNMP alert messages to the SNMP Alert Manager.
- address: required(string)
The IPv4/IPv6 address or domain name of the SNMP Alert Manager where the SNMP alerts will be sent.
- port: (integer - minimum: 1 - maximum: 65535)
The port used by the SNMP Alert Managaer to receive SNMP alerts. The default value is 162.
- msg_type: required(one of TRAP, INFORM)
The type of SNMP message to send to the SNMP Alert Manager. The INFORM option will receive an acknowledgment from the SNMP Alert Manager and will retransmit if required. The TRAP option does not expect acknowledgments. [visible:version:in:v2c|v3]
- version: required(one of v1, v2c, v3)
The version of SNMP that will be used when sending a message to this SNMP Alert Manager.
- community: (string)
A group name authorized to send traps by the SNMP Alert Manager configuration for SNMPv1 and SNMPv2c. This needs to match what is setup in the SNMP Alert Manager. Examples of commonly used values are 'log', 'execute', 'net' and 'public'. [sensitive,visible:version:in:v1|v2c,required:version:in:v1|v2c]
- auth_protocol: (one of SHA, MD5)
The encryption algorithm to use for authentication with SNMPv3. [visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The plaintext authentication password to use with SNMPv3. [sensitive,visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- username: (string)
Set the username to be used for authentication with SNMPv3 to allow clients to retrieve and set values, it is not related to system users. [visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- engine_id: (string)
A unique identifier for the SNMP agent entity. This needs to match the engineID of the SNMP Alert Manager. For example,
0x80001f8803555000000000
. [visible:version:=:v3] - privacy_protocol: (one of AES, DES)
The encryption algorithm to use for privacy with SNMPv3. [visible:version:=:v3,visible:security_level:=:authPriv]
- privacy_password: (string)
The plaintext privacy password to use with SNMPv3. [sensitive,visible:version:=:v3,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Set the User-based Security Model to use for communication with the SNMP Alert Manager. [visible:version:=:v3]
- id: required(string)
Example:
{
"snmp_alert_manager": {
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP",
"name": "A SNMP Alert Manager",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/snmp_alert_managers/{id}
Update settings for SNMP Managers on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- snmp_alert_manager: required(object)
- name: (string)
A description used to identify the SNMP Alert Manager.
- protocol: required(one of UDP, TCP, UDP6, TCP6)
The transport protocol used to deliver SNMP alert messages to the SNMP Alert Manager.
- address: (string)
The IPv4/IPv6 address or domain name of the SNMP Alert Manager where the SNMP alerts will be sent.
- port: (integer - minimum: 1 - maximum: 65535)
The port used by the SNMP Alert Managaer to receive SNMP alerts. The default value is 162.
- msg_type: required(one of TRAP, INFORM)
The type of SNMP message to send to the SNMP Alert Manager. The INFORM option will receive an acknowledgment from the SNMP Alert Manager and will retransmit if required. The TRAP option does not expect acknowledgments. [visible:version:in:v2c|v3,required:version:in:v2c|v3]
- version: required(one of v1, v2c, v3)
The version of SNMP that will be used when sending a message to this SNMP Alert Manager. Additional properties may be required depending on the version specified.
- community: (string)
A shared secret that allows SNMP alerts to be sent by the SNMP Alert Manager configuration for SNMPv1 and SNMPv2c. This needs to match what is setup in the SNMP Alert Manager. Examples of commonly used values are 'log', 'execute', 'net' and 'public'. [sensitive,visible:version:in:v1|v2c,required:version:in:v1|v2c]
- auth_protocol: (one of SHA, MD5)
The encryption algorithm to use for authentication with SNMPv3. [visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The plaintext authentication password to use with SNMPv3. [sensitive,visible:security_level:in:authNoPriv|authPriv]
- username: (string)
Set the username to be used for authentication with SNMPv3 to allow clients to retrieve and set values, it is not related to system users. [visible:version:=:v3]
- engine_id: (string)
A unique identifier for the SNMP agent entity. This needs to match the engineID of the SNMP Alert Manager. For example,
0x80001f8803555000000000
. [visible:version:=:v3] - privacy_protocol: (one of AES, DES)
The encryption algorithm to use for privacy with SNMPv3. [visible:security_level:=:authPriv]
- privacy_password: (string)
The plaintext privacy password to use with SNMPv3. [sensitive,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv - default: noAuthNoPriv)
Set the User-based Security Model to use for communication with the SNMP Alert Manager. [visible:version:=:v3,required:version:=:v3]
- name: (string)
Example:
{
"snmp_alert_manager": {
"name": "Existing SNMP Alert Manager",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "user1",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmp_alert_manager: required(object)
The SNMP manager configuration
- id: required(string)
The primary unique identifier for this SNMP Alert Manager.
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this SNMP Alert Manager when using ogcli. It consists of "\
\:\\/\ " - name: (string)
A description used to identify the SNMP Alert Manager.
- protocol: required(one of UDP, TCP, UDP6, TCP6)
The transport protocol used to deliver SNMP alert messages to the SNMP Alert Manager.
- address: required(string)
The IPv4/IPv6 address or domain name of the SNMP Alert Manager where the SNMP alerts will be sent.
- port: (integer - minimum: 1 - maximum: 65535)
The port used by the SNMP Alert Managaer to receive SNMP alerts. The default value is 162.
- msg_type: required(one of TRAP, INFORM)
The type of SNMP message to send to the SNMP Alert Manager. The INFORM option will receive an acknowledgment from the SNMP Alert Manager and will retransmit if required. The TRAP option does not expect acknowledgments. [visible:version:in:v2c|v3]
- version: required(one of v1, v2c, v3)
The version of SNMP that will be used when sending a message to this SNMP Alert Manager.
- community: (string)
A group name authorized to send traps by the SNMP Alert Manager configuration for SNMPv1 and SNMPv2c. This needs to match what is setup in the SNMP Alert Manager. Examples of commonly used values are 'log', 'execute', 'net' and 'public'. [sensitive,visible:version:in:v1|v2c,required:version:in:v1|v2c]
- auth_protocol: (one of SHA, MD5)
The encryption algorithm to use for authentication with SNMPv3. [visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The plaintext authentication password to use with SNMPv3. [sensitive,visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- username: (string)
Set the username to be used for authentication with SNMPv3 to allow clients to retrieve and set values, it is not related to system users. [visible:version:=:v3,visible:security_level:in:authNoPriv|authPriv]
- engine_id: (string)
A unique identifier for the SNMP agent entity. This needs to match the engineID of the SNMP Alert Manager. For example,
0x80001f8803555000000000
. [visible:version:=:v3] - privacy_protocol: (one of AES, DES)
The encryption algorithm to use for privacy with SNMPv3. [visible:version:=:v3,visible:security_level:=:authPriv]
- privacy_password: (string)
The plaintext privacy password to use with SNMPv3. [sensitive,visible:version:=:v3,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Set the User-based Security Model to use for communication with the SNMP Alert Manager. [visible:version:=:v3]
- id: required(string)
Example:
{
"snmp_alert_manager": {
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP-v3-TRAP",
"name": "A SNMP Alert Manager",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /services/snmp_alert_managers/{id}
Delete an snmp manager
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
snmp manager deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Simple Network Management Protocol (SNMP) is an Internet Standard protocol for collecting and organizing information about managed devices on IP networks and for modifying that information to change device behaviour. This entity allows configuration of the SNMP service.
Get the snmpd configuration.
Set the snmpd configuration.
get /services/snmpd
Get the snmpd configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, masked - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmpd: required(object)
- enabled: (boolean - default: false)
Enable or disable the SNMP service.
- port: (integer - default: 161 - minimum: 1 - maximum: 65535)
Specify the port for the SNMP service to use. The default value is 161.
- protocol: (one of UDP, TCP - default: UDP)
Set the protocol for the SNMP service to use. The default value is UDP.
- enable_legacy_versions: (boolean - default: false)
Enable SNMPv1 and SNMPv2c.
- rocommunity: (string)
The read-only community is a shared secret allowing clients to read SNMP information from the server. [sensitive,visible:enable_legacy_versions:=:true]
- rwcommunity: (string)
The read-write community is a shared secret allowing clients to set data via SNMP on the server. [sensitive,visible:enable_legacy_versions:=:true]
- enable_secure_snmp: (boolean - default: false)
Enable SNMPv3.
- security_level: (one of noauth, auth, priv - default: priv)
Set User-based Security Model settings to allow communication without authentication or privacy (noauth), authentication without privacy (auth), or authentication and privacy (priv). [visible:enable_secure_snmp:=:true]
- security_name: (string)
Set the username to be used for authentication with SNMPv3. [visible:enable_secure_snmp:=:true,required:enable_secure_snmp:=:true]
- engine_id: (string)
A unique identifier for the SNMP agent entity. [visible:enable_secure_snmp:=:true]
- auth_protocol: (one of SHA, MD5)
The encryption algorithm to use for authentication with SNMPv3. [visible:enable_secure_snmp:=:true,visible:security_level:in:auth|priv]
- auth_use_plaintext: (boolean - default: false)
Use plaintext password for authentication with SNMPv3 instead of a localized key. [visible:enable_secure_snmp:=:true,visible:security_level:in:auth|priv]
- auth_password: (string)
The plaintext authentication password to use with SNMPv3. [sensitive,visible:enable_secure_snmp:=:true,visible:auth_use_plaintext:=:true,visible:security_level:in:auth|priv]
- auth_localized_key: (string)
An encrpytion key for authentication used with SNMPv3 that incorporates the engineID of the SNMP agent. [visible:enable_secure_snmp:=:true,visible:auth_use_plaintext:=:false,visible:security_level:in:auth|priv]
- priv_protocol: (one of AES, DES)
The encryption algorithm to use for privacy with SNMPv3. [visible:enable_secure_snmp:=:true,visible:security_level:=:priv]
- priv_use_plaintext: (boolean - default: false)
Use plaintext password for privacy with SNMPv3 instead of a localized key. [visible:enable_secure_snmp:=:true,visible:security_level:=:priv]
- priv_password: (string)
The plaintext privacy passsword to use with SNMPv3. [sensitive,visible:enable_secure_snmp:=:true,visible:priv_use_plaintext:=:true,visible:security_level:=:priv]
- priv_localized_key: (string)
A encryption key for privacy used with SNMPv3 that incorporates the engineID of the SNMP agent. [visible:enable_secure_snmp:=:true,visible:priv_use_plaintext:=:false,visible:security_level:=:priv]
- enabled: (boolean - default: false)
Example:
{
"snmpd": {
"port": 161,
"protocol": "UDP",
"enable_legacy_versions": true,
"rocommunity": "public",
"rwcommunity": "private",
"enable_secure_snmp": true,
"security_level": "priv",
"security_name": "newuser",
"engine_id": "0x80001f8803555000000000",
"auth_protocol": "MD5",
"auth_use_plaintext": true,
"auth_password": "authPassword",
"auth_localized_key": "0x123456789ABCDEF",
"priv_protocol": "DES",
"priv_use_plaintext": true,
"priv_password": "privPassword",
"priv_localized_key": "0xFEDCBA987654321"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/snmpd
Set the snmpd configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- snmpd: required(object)
- enabled: (boolean - default: false)
Enable or disable the SNMP service.
- port: (integer - default: 161 - minimum: 1 - maximum: 65535)
Specify the port for the SNMP service to use. The default value is 161.
- protocol: (one of UDP, TCP - default: UDP)
Set the protocol for the SNMP service to use. The default value is UDP.
- enable_legacy_versions: (boolean - default: false)
Enable SNMPv1 and SNMPv2c.
- rocommunity: (string)
The read-only community is a shared secret allowing clients to read SNMP information from the server. [sensitive,visible:enable_legacy_versions:=:true]
- rwcommunity: (string)
The read-write community is a shared secret allowing clients to set data via SNMP on the server. [sensitive,visible:enable_legacy_versions:=:true]
- enable_secure_snmp: (boolean - default: false)
Enable SNMPv3.
- security_level: (one of noauth, auth, priv - default: priv)
Set User-based Security Model settings to allow communication without authentication or privacy (noauth), authentication without privacy (auth), or authentication and privacy (priv). [visible:enable_secure_snmp:=:true]
- security_name: (string)
Set the username to be used for authentication with SNMPv3. [visible:enable_secure_snmp:=:true,required:enable_secure_snmp:=:true]
- engine_id: (string)
A unique identifier for the SNMP agent entity. [visible:enable_secure_snmp:=:true]
- auth_protocol: (one of SHA, MD5)
The encryption algorithm to use for authentication with SNMPv3. [visible:enable_secure_snmp:=:true,visible:security_level:in:auth|priv]
- auth_use_plaintext: (boolean - default: false)
Use plaintext password for authentication with SNMPv3 instead of a localized key. [visible:enable_secure_snmp:=:true,visible:security_level:in:auth|priv]
- auth_password: (string)
The plaintext authentication password to use with SNMPv3. [sensitive,visible:enable_secure_snmp:=:true,visible:auth_use_plaintext:=:true,visible:security_level:in:auth|priv]
- auth_localized_key: (string)
An encrpytion key for authentication used with SNMPv3 that incorporates the engineID of the SNMP agent. [visible:enable_secure_snmp:=:true,visible:auth_use_plaintext:=:false,visible:security_level:in:auth|priv]
- priv_protocol: (one of AES, DES)
The encryption algorithm to use for privacy with SNMPv3. [visible:enable_secure_snmp:=:true,visible:security_level:=:priv]
- priv_use_plaintext: (boolean - default: false)
Use plaintext password for privacy with SNMPv3 instead of a localized key. [visible:enable_secure_snmp:=:true,visible:security_level:=:priv]
- priv_password: (string)
The plaintext privacy passsword to use with SNMPv3. [sensitive,visible:enable_secure_snmp:=:true,visible:priv_use_plaintext:=:true,visible:security_level:=:priv]
- priv_localized_key: (string)
A encryption key for privacy used with SNMPv3 that incorporates the engineID of the SNMP agent. [visible:enable_secure_snmp:=:true,visible:priv_use_plaintext:=:false,visible:security_level:=:priv]
- enabled: (boolean - default: false)
Example:
{
"snmpd": {
"port": 161,
"protocol": "UDP",
"enable_legacy_versions": true,
"rocommunity": "public",
"rwcommunity": "private",
"enable_secure_snmp": true,
"security_level": "priv",
"security_name": "newuser",
"engine_id": "0x80001f8803555000000000",
"auth_protocol": "MD5",
"auth_use_plaintext": true,
"auth_password": "authPassword",
"auth_localized_key": "0x123456789ABCDEF",
"priv_protocol": "DES",
"priv_use_plaintext": true,
"priv_password": "privPassword",
"priv_localized_key": "0xFEDCBA987654321"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmpd: required(object)
- enabled: (boolean - default: false)
Enable or disable the SNMP service.
- port: (integer - default: 161 - minimum: 1 - maximum: 65535)
Specify the port for the SNMP service to use. The default value is 161.
- protocol: (one of UDP, TCP - default: UDP)
Set the protocol for the SNMP service to use. The default value is UDP.
- enable_legacy_versions: (boolean - default: false)
Enable SNMPv1 and SNMPv2c.
- rocommunity: (string)
The read-only community is a shared secret allowing clients to read SNMP information from the server. [sensitive,visible:enable_legacy_versions:=:true]
- rwcommunity: (string)
The read-write community is a shared secret allowing clients to set data via SNMP on the server. [sensitive,visible:enable_legacy_versions:=:true]
- enable_secure_snmp: (boolean - default: false)
Enable SNMPv3.
- security_level: (one of noauth, auth, priv - default: priv)
Set User-based Security Model settings to allow communication without authentication or privacy (noauth), authentication without privacy (auth), or authentication and privacy (priv). [visible:enable_secure_snmp:=:true]
- security_name: (string)
Set the username to be used for authentication with SNMPv3. [visible:enable_secure_snmp:=:true,required:enable_secure_snmp:=:true]
- engine_id: (string)
A unique identifier for the SNMP agent entity. [visible:enable_secure_snmp:=:true]
- auth_protocol: (one of SHA, MD5)
The encryption algorithm to use for authentication with SNMPv3. [visible:enable_secure_snmp:=:true,visible:security_level:in:auth|priv]
- auth_use_plaintext: (boolean - default: false)
Use plaintext password for authentication with SNMPv3 instead of a localized key. [visible:enable_secure_snmp:=:true,visible:security_level:in:auth|priv]
- auth_password: (string)
The plaintext authentication password to use with SNMPv3. [sensitive,visible:enable_secure_snmp:=:true,visible:auth_use_plaintext:=:true,visible:security_level:in:auth|priv]
- auth_localized_key: (string)
An encrpytion key for authentication used with SNMPv3 that incorporates the engineID of the SNMP agent. [visible:enable_secure_snmp:=:true,visible:auth_use_plaintext:=:false,visible:security_level:in:auth|priv]
- priv_protocol: (one of AES, DES)
The encryption algorithm to use for privacy with SNMPv3. [visible:enable_secure_snmp:=:true,visible:security_level:=:priv]
- priv_use_plaintext: (boolean - default: false)
Use plaintext password for privacy with SNMPv3 instead of a localized key. [visible:enable_secure_snmp:=:true,visible:security_level:=:priv]
- priv_password: (string)
The plaintext privacy passsword to use with SNMPv3. [sensitive,visible:enable_secure_snmp:=:true,visible:priv_use_plaintext:=:true,visible:security_level:=:priv]
- priv_localized_key: (string)
A encryption key for privacy used with SNMPv3 that incorporates the engineID of the SNMP agent. [visible:enable_secure_snmp:=:true,visible:priv_use_plaintext:=:false,visible:security_level:=:priv]
- enabled: (boolean - default: false)
Example:
{
"snmpd": {
"port": 161,
"protocol": "UDP",
"enable_legacy_versions": true,
"rocommunity": "public",
"rwcommunity": "private",
"enable_secure_snmp": true,
"security_level": "priv",
"security_name": "newuser",
"engine_id": "0x80001f8803555000000000",
"auth_protocol": "MD5",
"auth_use_plaintext": true,
"auth_password": "authPassword",
"auth_localized_key": "0x123456789ABCDEF",
"priv_protocol": "DES",
"priv_use_plaintext": true,
"priv_password": "privPassword",
"priv_localized_key": "0xFEDCBA987654321"
}
}
HTTP status code 400
Returns an error after the operation failed due to incomplete data.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'priv_localized_key' was not provided in the request",
"args": {
"param": "priv_localized_key"
},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Failed to save the configuration.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Configure the Secure Shell Protocol (SSH) service.
Fetch configuration for the SSH service.
Set configuration for the SSH service.
get /services/ssh
Fetch configuration for the SSH service.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- ssh: required(object)
- ssh_url_delimiter: required(string)
The character used to separate the username with port selection information. The default delimiter is '+', for example, username+port@address.
- maxstartups_start: (integer)
The SSH daemon rejects a proportion of connection attempts when the number of unauthenticated connections reaches this value. The probability of rejection is determined by 'maxstartups_rate'.
- maxstartups_rate: (integer)
The probability that a connection attempt is rejected once the number of unauthenticated connections reaches 'maxstartups_start'. The probability increases linearly with more connection attempts, and all connection attempts are refused if the number reaches 'maxstartups_full'.
- maxstartups_full: (integer)
All connection attempts are refused if the number of unauthenticated connections reaches this number.
- unauthenticated_serial_port_access: (boolean)
Unauthenticated access to all serial ports will be available through SSH on TCP port 3000+ or Serial Port IP aliases.
- ssh_url_delimiter: required(string)
Example:
{
"ssh": {
"ssh_url_delimiter": "+",
"maxstartups_rate": 30,
"maxstartups_start": 10,
"maxstartups_full": 100,
"unauthenticated_serial_port_access": false
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/ssh
Set configuration for the SSH service.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- ssh: required(object)
- ssh_url_delimiter: (string - pattern: ^([^@]){1}$)
The character used to separate the username with port selection information. The default delimiter is '+', for example, username+port@address. [regexerr:A single character other than '@'.]
- maxstartups_start: (integer - default: 10 - minimum: 1)
The SSH daemon rejects a proportion of connection attempts when the number of unauthenticated connections reaches this value. The probability of rejection is determined by 'maxstartups_rate'.
- maxstartups_rate: (integer - minimum: 1 - maximum: 100)
The probability that a connection attempt is rejected once the number of unauthenticated connections reaches 'maxstartups_start'. The probability increases linearly with more connection attempts, and all connection attempts are refused if the number reaches 'maxstartups_full'.
- maxstartups_full: (integer - minimum: 1 - maximum: 100)
All connection attempts are refused if the number of unauthenticated connections reaches this number.
- unauthenticated_serial_port_access: (boolean)
Unauthenticated access to all serial ports will be available through SSH on TCP port 3000+ or Serial Port IP aliases.
- ssh_url_delimiter: (string - pattern: ^([^@]){1}$)
Example:
{
"ssh": {
"ssh_url_delimiter": ":",
"maxstartups_rate": 30,
"maxstartups_start": 10,
"maxstartups_full": 100,
"unauthenticated_serial_port_access": false
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- ssh: required(object)
- ssh_url_delimiter: required(string)
The character used to separate the username with port selection information. The default delimiter is '+', for example, username+port@address.
- maxstartups_start: (integer)
The SSH daemon rejects a proportion of connection attempts when the number of unauthenticated connections reaches this value. The probability of rejection is determined by 'maxstartups_rate'.
- maxstartups_rate: (integer)
The probability that a connection attempt is rejected once the number of unauthenticated connections reaches 'maxstartups_start'. The probability increases linearly with more connection attempts, and all connection attempts are refused if the number reaches 'maxstartups_full'.
- maxstartups_full: (integer)
All connection attempts are refused if the number of unauthenticated connections reaches this number.
- unauthenticated_serial_port_access: (boolean)
Unauthenticated access to all serial ports will be available through SSH on TCP port 3000+ or Serial Port IP aliases.
- ssh_url_delimiter: required(string)
Example:
{
"ssh": {
"ssh_url_delimiter": ":",
"maxstartups_rate": 30,
"maxstartups_start": 10,
"maxstartups_full": 100,
"unauthenticated_serial_port_access": false
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure routing services on the NetOps Console Server appliance.
Fetch the configuration for the available routing daemons.
Set the configuration for the available routing daemons.
get /services/routing
Fetch the configuration for the available routing daemons.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- routing: required(object)
- bgpd: required(object)
Border Gateway Protocol (BGP) is a gateway protocol that enables the Internet to exchange routing information between autonomous systems.
- enabled: required(boolean)
Is bdgpd enabled
- enabled: required(boolean)
- ospfd: required(object)
Open Shortest Path First (OSPF) is a routing protocol for Internet Protocol (IP) networks. It uses a link state routing (LSR) algorithm and falls into the group of interior gateway protocols (IGPs), operating within a single autonomous system.
- enabled: required(boolean)
Is ospfd enabled
- router_id: (string - pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?){1}$|^$)
A 32 bit number expressed in dotted decimal notation (A.B.C.D) that identifies the OSPF router. The number must be unique within the OSPF network and does not need to be a real IPv4 address. The highest RID will determine which node is the designated router (DR). [regexerr: Dotted decimal notation format required]
- redistribute_connected: (boolean)
Whether or not to add 'redistribute_connected' option to the system OSPF configuration. If this is enabled, any directly connected network routes will be advertised to OSPF neighbours.
- redistribute_static: (boolean)
Whether or not to add 'redistribute_static' option to the system OSPF configuration. If this is enabled, statically defined network routes will be advertised to OSPF neighbours.
- redistribute_kernel: (boolean)
Whether or not to add 'redistribute_kernel' option to the system OSPF configuration. If this is enabled, static routes defined in the kernel will be advertised to OSPF neighbours.
- interfaces: (array of object)
The specific individual interface related parameters for OSPF.
Items: items
- name: required(string)
The name of the interface these settings apply to. This should match the name of an interface on the device.
- cost: (integer - minimum: 1 - maximum: 65535)
The link cost of the interface used in OSPF route calculations. This is in the range of 1 to 65535.
- hello_interval: (integer - minimum: 1 - maximum: 65535)
The interval (in seconds) between sending OSPF hello packets over this interface. [required:dead_interval:!=:]
- dead_interval: (integer - minimum: 1 - maximum: 65535)
The interval (in seconds) to elapse after receiving the last OSPF hello packet and declaring the neighbor dead. [required:hello_interval:!=:]
- priority: (integer - minimum: 0 - maximum: 255)
The priority is used to determine which OSPF router should be the designated router (DR) for a OSPF network. The priority can be in the range of 0 to 255. A higher priority will always win the DR election process.
- area: (string - pattern: (^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$)|^[0-9]+$|^$)
A numerical identifier assigned to a specific OSPF area on an interface. The area determines the boundaries and scope of OSPF routing on that interface. Enter in the dotted decimal notation format(a.b.c.d) or a postive integer. [regexerr:An area code in a.b.c.d dotted decimal notation format or a positive integer]
- non_broadcast: required(boolean)
Whether or not the interface should be marked as non broadcast for OSPF purposes. Enabling this would mean OSPF would not use multicast on this link.
- passive: required(boolean)
Whether or not the interface should be marked as passive for OSPF purposes. Enabling this would mean LSAs are not traded on this link.
- auth_method: required(one of no_auth, cleartext, md5)
The authentication method to use for communications on this interface. Should be one of 'no_auth', 'cleartext' or 'md5'
- auth_keys: required(array of object)
The authentication keys for the associated method. [visible:auth_method:in:cleartext|md5,required:auth_method:in:cleartext|md5]
Items: items
- id: required(string)
The id of the associated key.
- key: required(string)
The actual key value.
- id: required(string)
- name: required(string)
- neighbors: (array of object)
Specifies the static OSPF neighbor devices for non-broadcast networks. Use this field to configure and manage specific OSPF neighbors manually.
Items: items
- address: required(string - pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?){1}$)
A IPv4 host address of the neighbor. [regexerr:An IPv4 address in a.b.c.d dotted decimal notation format]
- address: required(string - pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?){1}$)
- networks: (array of object)
The IP network configurations to enable the system OSPF service for.
Items: items
- address_with_mask: required(string - pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}\/([1-9]|[1-2][0-9]|3[0-2])$)
An IPv4 network address with CIDR subnet mask to enable OSPF for. No host bits should be set. [regexerr:An IPv4 address in a.b.c.d/
format] - area: (string - pattern: (^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$)|^[0-9]+$|^$)
A numerical identifier assigned to a specific OSPF area within a network. The area determines the boundaries and scope of OSPF routing. Enter in the dotted decimal notation format(a.b.c.d) or a postive integer. [regexerr:An area code in a.b.c.d dotted decimal notation format or a positive integer]
- address_with_mask: required(string - pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}\/([1-9]|[1-2][0-9]|3[0-2])$)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- enabled: required(boolean)
- isisd: required(object)
Intermediate System to Intermediate System (IS-IS) is a routing protocol designed to move information efficiently within a computer network, a group of physically connected computers or similar devices. It accomplishes this by determining the best route for data through a packet switching network.
- enabled: required(boolean)
Is isisd enabled
- enabled: required(boolean)
- ripd: required(object)
Routing Information Protocol (RIP) is a distance-vector routing protocol which employs the hop count as a routing metric. RIP prevents routing loops by implementing a limit on the number of hops allowed in a path from source to destination.
- enabled: required(boolean)
Is ripd enabled
- enabled: required(boolean)
- bgpd: required(object)
Examples:
example1:
{
"routing": {
"bgpd": {
"enabled": true
},
"isisd": {
"enabled": false
},
"ripd": {
"enabled": true
},
"ospfd": {
"enabled": false,
"router_id": "",
"redistribute_connected": false,
"redistribute_static": false,
"redistribute_kernel": false,
"interfaces": [],
"neighbors": [],
"networks": []
}
}
}
example2:
{
"routing": {
"bgpd": {
"enabled": true
},
"isisd": {
"enabled": true
},
"ripd": {
"enabled": false
},
"ospfd": {
"enabled": true,
"router_id": "10.0.0.2",
"redistribute_connected": false,
"redistribute_static": true,
"redistribute_kernel": false,
"interfaces": [
{
"name": "net2",
"cost": 10,
"non_broadcast": false,
"passive": true,
"auth_method": "no_auth",
"auth_keys": []
},
{
"name": "net1",
"non_broadcast": true,
"passive": false,
"auth_method": "md5",
"auth_keys": [
{
"id": "2",
"key": "2AAA8335FD030E054A98E3B2C5852B34"
},
{
"id": "4",
"key": "3A6BD16D50D2DA27B07DAA2088E56CE6"
}
]
}
],
"neighbors": [
{
"address": "10.0.0.1"
}
],
"networks": [
{
"address_with_mask": "5.5.5.0/24",
"area": "40"
},
{
"address_with_mask": "10.0.0.0/8",
"area": "0.0.0.0"
}
]
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/routing
Set the configuration for the available routing daemons.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- routing: required(object)
- bgpd: required(object)
Border Gateway Protocol (BGP) is a gateway protocol that enables the Internet to exchange routing information between autonomous systems.
- enabled: required(boolean)
Is bdgpd enabled
- enabled: required(boolean)
- ospfd: required(object)
Open Shortest Path First (OSPF) is a routing protocol for Internet Protocol (IP) networks. It uses a link state routing (LSR) algorithm and falls into the group of interior gateway protocols (IGPs), operating within a single autonomous system.
- enabled: required(boolean)
Is ospfd enabled
- router_id: (string - pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?){1}$|^$)
A 32 bit number expressed in dotted decimal notation (A.B.C.D) that identifies the OSPF router. The number must be unique within the OSPF network and does not need to be a real IPv4 address. The highest RID will determine which node is the designated router (DR). [regexerr: Dotted decimal notation format required]
- redistribute_connected: (boolean)
Whether or not to add 'redistribute_connected' option to the system OSPF configuration. If this is enabled, any directly connected network routes will be advertised to OSPF neighbours.
- redistribute_static: (boolean)
Whether or not to add 'redistribute_static' option to the system OSPF configuration. If this is enabled, statically defined network routes will be advertised to OSPF neighbours.
- redistribute_kernel: (boolean)
Whether or not to add 'redistribute_kernel' option to the system OSPF configuration. If this is enabled, static routes defined in the kernel will be advertised to OSPF neighbours.
- interfaces: (array of object)
The specific individual interface related parameters for OSPF.
Items: items
- name: required(string)
The name of the interface these settings apply to. This should match the name of an interface on the device.
- cost: (integer - minimum: 1 - maximum: 65535)
The link cost of the interface used in OSPF route calculations. This is in the range of 1 to 65535.
- hello_interval: (integer - minimum: 1 - maximum: 65535)
The interval (in seconds) between sending OSPF hello packets over this interface. [required:dead_interval:!=:]
- dead_interval: (integer - minimum: 1 - maximum: 65535)
The interval (in seconds) to elapse after receiving the last OSPF hello packet and declaring the neighbor dead. [required:hello_interval:!=:]
- priority: (integer - minimum: 0 - maximum: 255)
The priority is used to determine which OSPF router should be the designated router (DR) for a OSPF network. The priority can be in the range of 0 to 255. A higher priority will always win the DR election process.
- area: (string - pattern: (^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$)|^[0-9]+$|^$)
A numerical identifier assigned to a specific OSPF area on an interface. The area determines the boundaries and scope of OSPF routing on that interface. Enter in the dotted decimal notation format(a.b.c.d) or a postive integer. [regexerr:An area code in a.b.c.d dotted decimal notation format or a positive integer]
- non_broadcast: required(boolean)
Whether or not the interface should be marked as non broadcast for OSPF purposes. Enabling this would mean OSPF would not use multicast on this link.
- passive: required(boolean)
Whether or not the interface should be marked as passive for OSPF purposes. Enabling this would mean LSAs are not traded on this link.
- auth_method: required(one of no_auth, cleartext, md5)
The authentication method to use for communications on this interface. Should be one of 'no_auth', 'cleartext' or 'md5'
- auth_keys: required(array of object)
The authentication keys for the associated method. [visible:auth_method:in:cleartext|md5,required:auth_method:in:cleartext|md5]
Items: items
- id: required(string)
The id of the associated key.
- key: required(string)
The actual key value.
- id: required(string)
- name: required(string)
- neighbors: (array of object)
Specifies the static OSPF neighbor devices for non-broadcast networks. Use this field to configure and manage specific OSPF neighbors manually.
Items: items
- address: required(string - pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?){1}$)
A IPv4 host address of the neighbor. [regexerr:An IPv4 address in a.b.c.d dotted decimal notation format]
- address: required(string - pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?){1}$)
- networks: (array of object)
The IP network configurations to enable the system OSPF service for.
Items: items
- address_with_mask: required(string - pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}\/([1-9]|[1-2][0-9]|3[0-2])$)
An IPv4 network address with CIDR subnet mask to enable OSPF for. No host bits should be set. [regexerr:An IPv4 address in a.b.c.d/
format] - area: (string - pattern: (^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$)|^[0-9]+$|^$)
A numerical identifier assigned to a specific OSPF area within a network. The area determines the boundaries and scope of OSPF routing. Enter in the dotted decimal notation format(a.b.c.d) or a postive integer. [regexerr:An area code in a.b.c.d dotted decimal notation format or a positive integer]
- address_with_mask: required(string - pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}\/([1-9]|[1-2][0-9]|3[0-2])$)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- enabled: required(boolean)
- isisd: required(object)
Intermediate System to Intermediate System (IS-IS) is a routing protocol designed to move information efficiently within a computer network, a group of physically connected computers or similar devices. It accomplishes this by determining the best route for data through a packet switching network.
- enabled: required(boolean)
Is isisd enabled
- enabled: required(boolean)
- ripd: required(object)
Routing Information Protocol (RIP) is a distance-vector routing protocol which employs the hop count as a routing metric. RIP prevents routing loops by implementing a limit on the number of hops allowed in a path from source to destination.
- enabled: required(boolean)
Is ripd enabled
- enabled: required(boolean)
- bgpd: required(object)
Examples:
example1:
{
"routing": {
"bgpd": {
"enabled": true
},
"isisd": {
"enabled": false
},
"ripd": {
"enabled": true
},
"ospfd": {
"enabled": false
}
}
}
example2:
{
"routing": {
"bgpd": {
"enabled": true
},
"isisd": {
"enabled": false
},
"ripd": {
"enabled": false
},
"ospfd": {
"enabled": true,
"router_id": "10.0.1.2",
"redistribute_connected": true,
"redistribute_static": false,
"redistribute_kernel": false,
"interfaces": [
{
"name": "net1",
"cost": 1,
"non_broadcast": false,
"passive": false,
"auth_method": "cleartext",
"auth_keys": [
{
"id": "0",
"key": "my_awesome_password"
}
]
}
],
"neighbors": [
{
"address": "16.17.0.1"
},
{
"address": "10.0.1.1"
}
],
"networks": [
{
"address_with_mask": "16.17.0.0/16",
"area": "0.0.0.0"
},
{
"address_with_mask": "10.0.0.0/8",
"area": "0.0.0.0"
}
]
}
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- routing: required(object)
- bgpd: required(object)
Border Gateway Protocol (BGP) is a gateway protocol that enables the Internet to exchange routing information between autonomous systems.
- enabled: required(boolean)
Is bdgpd enabled
- enabled: required(boolean)
- ospfd: required(object)
Open Shortest Path First (OSPF) is a routing protocol for Internet Protocol (IP) networks. It uses a link state routing (LSR) algorithm and falls into the group of interior gateway protocols (IGPs), operating within a single autonomous system.
- enabled: required(boolean)
Is ospfd enabled
- router_id: (string - pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?){1}$|^$)
A 32 bit number expressed in dotted decimal notation (A.B.C.D) that identifies the OSPF router. The number must be unique within the OSPF network and does not need to be a real IPv4 address. The highest RID will determine which node is the designated router (DR). [regexerr: Dotted decimal notation format required]
- redistribute_connected: (boolean)
Whether or not to add 'redistribute_connected' option to the system OSPF configuration. If this is enabled, any directly connected network routes will be advertised to OSPF neighbours.
- redistribute_static: (boolean)
Whether or not to add 'redistribute_static' option to the system OSPF configuration. If this is enabled, statically defined network routes will be advertised to OSPF neighbours.
- redistribute_kernel: (boolean)
Whether or not to add 'redistribute_kernel' option to the system OSPF configuration. If this is enabled, static routes defined in the kernel will be advertised to OSPF neighbours.
- interfaces: (array of object)
The specific individual interface related parameters for OSPF.
Items: items
- name: required(string)
The name of the interface these settings apply to. This should match the name of an interface on the device.
- cost: (integer - minimum: 1 - maximum: 65535)
The link cost of the interface used in OSPF route calculations. This is in the range of 1 to 65535.
- hello_interval: (integer - minimum: 1 - maximum: 65535)
The interval (in seconds) between sending OSPF hello packets over this interface. [required:dead_interval:!=:]
- dead_interval: (integer - minimum: 1 - maximum: 65535)
The interval (in seconds) to elapse after receiving the last OSPF hello packet and declaring the neighbor dead. [required:hello_interval:!=:]
- priority: (integer - minimum: 0 - maximum: 255)
The priority is used to determine which OSPF router should be the designated router (DR) for a OSPF network. The priority can be in the range of 0 to 255. A higher priority will always win the DR election process.
- area: (string - pattern: (^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$)|^[0-9]+$|^$)
A numerical identifier assigned to a specific OSPF area on an interface. The area determines the boundaries and scope of OSPF routing on that interface. Enter in the dotted decimal notation format(a.b.c.d) or a postive integer. [regexerr:An area code in a.b.c.d dotted decimal notation format or a positive integer]
- non_broadcast: required(boolean)
Whether or not the interface should be marked as non broadcast for OSPF purposes. Enabling this would mean OSPF would not use multicast on this link.
- passive: required(boolean)
Whether or not the interface should be marked as passive for OSPF purposes. Enabling this would mean LSAs are not traded on this link.
- auth_method: required(one of no_auth, cleartext, md5)
The authentication method to use for communications on this interface. Should be one of 'no_auth', 'cleartext' or 'md5'
- auth_keys: required(array of object)
The authentication keys for the associated method. [visible:auth_method:in:cleartext|md5,required:auth_method:in:cleartext|md5]
Items: items
- id: required(string)
The id of the associated key.
- key: required(string)
The actual key value.
- id: required(string)
- name: required(string)
- neighbors: (array of object)
Specifies the static OSPF neighbor devices for non-broadcast networks. Use this field to configure and manage specific OSPF neighbors manually.
Items: items
- address: required(string - pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?){1}$)
A IPv4 host address of the neighbor. [regexerr:An IPv4 address in a.b.c.d dotted decimal notation format]
- address: required(string - pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?){1}$)
- networks: (array of object)
The IP network configurations to enable the system OSPF service for.
Items: items
- address_with_mask: required(string - pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}\/([1-9]|[1-2][0-9]|3[0-2])$)
An IPv4 network address with CIDR subnet mask to enable OSPF for. No host bits should be set. [regexerr:An IPv4 address in a.b.c.d/
format] - area: (string - pattern: (^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$)|^[0-9]+$|^$)
A numerical identifier assigned to a specific OSPF area within a network. The area determines the boundaries and scope of OSPF routing. Enter in the dotted decimal notation format(a.b.c.d) or a postive integer. [regexerr:An area code in a.b.c.d dotted decimal notation format or a positive integer]
- address_with_mask: required(string - pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}\/([1-9]|[1-2][0-9]|3[0-2])$)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- enabled: required(boolean)
- isisd: required(object)
Intermediate System to Intermediate System (IS-IS) is a routing protocol designed to move information efficiently within a computer network, a group of physically connected computers or similar devices. It accomplishes this by determining the best route for data through a packet switching network.
- enabled: required(boolean)
Is isisd enabled
- enabled: required(boolean)
- ripd: required(object)
Routing Information Protocol (RIP) is a distance-vector routing protocol which employs the hop count as a routing metric. RIP prevents routing loops by implementing a limit on the number of hops allowed in a path from source to destination.
- enabled: required(boolean)
Is ripd enabled
- enabled: required(boolean)
- bgpd: required(object)
Examples:
example1:
{
"routing": {
"bgpd": {
"enabled": true
},
"isisd": {
"enabled": false
},
"ripd": {
"enabled": true
},
"ospfd": {
"enabled": false,
"router_id": "",
"redistribute_connected": false,
"redistribute_static": false,
"redistribute_kernel": false,
"interfaces": [],
"neighbors": [],
"networks": []
}
}
}
example2:
{
"routing": {
"bgpd": {
"enabled": true
},
"isisd": {
"enabled": false
},
"ripd": {
"enabled": false
},
"ospfd": {
"enabled": true,
"router_id": "10.0.1.2",
"redistribute_connected": true,
"redistribute_static": false,
"redistribute_kernel": false,
"interfaces": [
{
"name": "net1",
"cost": 1,
"non_broadcast": false,
"passive": false,
"auth_method": "cleartext",
"auth_keys": [
{
"id": "0",
"key": "my_awesome_password"
}
]
}
],
"neighbors": [
{
"address": "16.17.0.1"
},
{
"address": "10.0.1.1"
}
],
"networks": [
{
"address_with_mask": "16.17.0.0/16",
"area": "0.0.0.0"
},
{
"address_with_mask": "10.0.0.0/8",
"area": "0.0.0.0"
}
]
}
}
}
HTTP status code 400
Returns an error after the operation failed due to incomplete data.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'bgpd' was not provided in the request",
"args": {
"param": "bgpd"
},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Failed to save the configuration.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/alerts
Used to configure various types of alerts
Retrieve and configure Authentication Trap Group settings.
Get the authentication trap group settings.
Set the authentication trap group settings.
get /alerts/authentication
Get the authentication trap group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- authentication_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"authentication_trap_group": {
"enabled": true
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /alerts/authentication
Set the authentication trap group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- authentication_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"authentication_trap_group": {
"enabled": true
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- authentication_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"authentication_trap_group": {
"enabled": true
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure System Trap Group settings.
Get the system trap group settings.
Set the system trap group settings.
get /alerts/system
Get the system trap group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_trap_group: required(object)
- enabled: required(boolean)
- power_supply_millivolt_lower: required(integer)
- power_supply_millivolt_upper: required(integer)
Example:
{
"system_trap_group": {
"enabled": true,
"power_supply_millivolt_lower": 11000,
"power_supply_millivolt_upper": 13000
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /alerts/system
Set the system trap group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_trap_group: required(object)
- enabled: required(boolean)
- power_supply_millivolt_lower: required(integer)
- power_supply_millivolt_upper: required(integer)
Example:
{
"system_trap_group": {
"enabled": true,
"power_supply_millivolt_lower": 11000,
"power_supply_millivolt_upper": 13000
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_trap_group: required(object)
- enabled: required(boolean)
- power_supply_millivolt_lower: required(integer)
- power_supply_millivolt_upper: required(integer)
Example:
{
"system_trap_group": {
"enabled": true,
"power_supply_millivolt_lower": 11000,
"power_supply_millivolt_upper": 13000
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure Networking Trap Group settings.
Get the networking trap group settings.
Set the networking trap group settings.
get /alerts/networking
Get the networking trap group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- networking_trap_group: required(object)
- enabled: required(boolean)
- signal_strength_threshold_lower: (integer)
- signal_strength_threshold_upper: (integer)
Examples:
example1:
With a cell modem
{
"networking_trap_group": {
"enabled": true,
"signal_strength_threshold_lower": 33,
"signal_strength_threshold_upper": 66
}
}
example2:
Without a cell modem
{
"networking_trap_group": {
"enabled": true
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /alerts/networking
Set the networking trap group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- networking_trap_group: required(object)
- enabled: required(boolean)
- signal_strength_threshold_lower: (integer)
- signal_strength_threshold_upper: (integer)
Examples:
example1:
With a cell modem
{
"networking_trap_group": {
"enabled": true,
"signal_strength_threshold_lower": 33,
"signal_strength_threshold_upper": 66
}
}
example2:
Without a cell modem
{
"networking_trap_group": {
"enabled": true
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- networking_trap_group: required(object)
- enabled: required(boolean)
- signal_strength_threshold_lower: (integer)
- signal_strength_threshold_upper: (integer)
Examples:
example1:
With a cell modem
{
"networking_trap_group": {
"enabled": true,
"signal_strength_threshold_lower": 33,
"signal_strength_threshold_upper": 66
}
}
example2:
Without a cell modem
{
"networking_trap_group": {
"enabled": true
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure config change trap group settings.
Get the config change trap group settings.
Set the config trap group settings.
get /alerts/config_change
Get the config change trap group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- config_change_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"config_change_trap_group": {
"enabled": true
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /alerts/config_change
Set the config trap group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- config_change_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"config_change_trap_group": {
"enabled": true
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- config_change_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"config_change_trap_group": {
"enabled": true
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/monitoring
Used to configure various types of monitoring systems
Used to configure various types of alerts
Retrieve and configure Networking Alert Group settings.
Get the networking alert group settings.
Set the networking alert group settings.
get /monitoring/alerts/networking
Get the networking alert group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- networking_alert_group: required(object)
- cell_signal_strength_alert: (object)
The alert related to this functionality is the Network Connection Status which sends an alert when cell signal strength leaves or re-enters a user-defined range, or, when the network link state changes.
- enabled: (boolean - default: false)
Enable the alerts for network connection status signal strength. If this is true, an alert will be sent when any network interfaces goes up or down. For cellular devices, alerts will also be sent if the signal strength crosses a threshold.
- threshold_lower: (integer - default: 33 - minimum: 0 - maximum: 100)
The lower level for the network signal strength range (in percent %). If alerts are enabled and the signal strength goes below this value, an alert is sent. Field is only valid when a cell modem is present.
- threshold_upper: (integer - default: 66 - minimum: 0 - maximum: 100)
The upper level for the network signal strength range (in percent %). If alerts are enabled and the signal strength goes above this value, an alert is sent. Field is only valid when a cell modem is present.
- enabled: (boolean - default: false)
- cell_signal_strength_alert: (object)
Examples:
example1:
All network alerts enabled.
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true,
"threshold_lower": 33,
"threshold_upper": 66
}
}
}
example2:
All network alerts enabled when there is no cell modem (Network link state is enabled under cell_signal_strength_alert).
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /monitoring/alerts/networking
Set the networking alert group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- networking_alert_group: required(object)
- cell_signal_strength_alert: (object)
The alert related to this functionality is the Network Connection Status which sends an alert when cell signal strength leaves or re-enters a user-defined range, or, when the network link state changes.
- enabled: (boolean - default: false)
Enable the alerts for network connection status signal strength. If this is true, an alert will be sent when any network interfaces goes up or down. For cellular devices, alerts will also be sent if the signal strength crosses a threshold.
- threshold_lower: (integer - default: 33 - minimum: 0 - maximum: 100)
The lower level for the network signal strength range (in percent %). If alerts are enabled and the signal strength goes below this value, an alert is sent. Field is only valid when a cell modem is present.
- threshold_upper: (integer - default: 66 - minimum: 0 - maximum: 100)
The upper level for the network signal strength range (in percent %). If alerts are enabled and the signal strength goes above this value, an alert is sent. Field is only valid when a cell modem is present.
- enabled: (boolean - default: false)
- cell_signal_strength_alert: (object)
Examples:
example1:
Enable all network alerts.
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true,
"threshold_lower": 33,
"threshold_upper": 66
}
}
}
example2:
Enable all network alerts when there is no cell modem (Enables network link state under cell_signal_strength_alert).
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true
}
}
}
example3:
Disable all network alerts.
{
"networking_alert_group": {}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- networking_alert_group: required(object)
- cell_signal_strength_alert: (object)
The alert related to this functionality is the Network Connection Status which sends an alert when cell signal strength leaves or re-enters a user-defined range, or, when the network link state changes.
- enabled: (boolean - default: false)
Enable the alerts for network connection status signal strength. If this is true, an alert will be sent when any network interfaces goes up or down. For cellular devices, alerts will also be sent if the signal strength crosses a threshold.
- threshold_lower: (integer - default: 33 - minimum: 0 - maximum: 100)
The lower level for the network signal strength range (in percent %). If alerts are enabled and the signal strength goes below this value, an alert is sent. Field is only valid when a cell modem is present.
- threshold_upper: (integer - default: 66 - minimum: 0 - maximum: 100)
The upper level for the network signal strength range (in percent %). If alerts are enabled and the signal strength goes above this value, an alert is sent. Field is only valid when a cell modem is present.
- enabled: (boolean - default: false)
- cell_signal_strength_alert: (object)
Examples:
example1:
All network alerts enabled.
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true,
"threshold_lower": 33,
"threshold_upper": 66
}
}
}
example2:
All network alerts enabled when there is no cell modem (Network link state is enabled under cell_signal_strength_alert).
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure Power Alert Group settings.
Get the power alert group settings.
Set the power alert group settings.
get /monitoring/alerts/power
Get the power alert group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- power_alert_group: required(object)
- power_supply_voltage_alert: (object)
System alerts are sent when the system reboots or the supply bus voltages are out of range.
- enabled: (boolean - default: false)
Enable the alerts for supply voltage range. If this is true, an alert will be sent when device's supply bus voltages are out of range. [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"power_alert_group":{"power_supply_voltage_alert":{"snmp":{"enabled":null}}}},"since":"10/2022"}
- deprecatedProperty
- millivolt_lower: (integer - default: 11000 - minimum: 8000 - maximum: 16000)
The lower level for the device's supply voltage range (in mV). If alerts are enabled and the supply voltage goes below this value, an alert is sent.
- millivolt_upper: (integer - default: 13000 - minimum: 8000 - maximum: 16000)
The upper level for the device's supply voltage range (in mV). If alerts are enabled and the supply voltage goes above this value, an alert is sent.
- snmp: (object)
"Power alert configuration specific to SNMP"
- enabled: (boolean - default: false)
Enable SNMP alerts for supply voltage range. If this is true, an alert will be sent when device's supply bus voltages are out of range.
- enabled: (boolean - default: false)
- syslog: (object)
"Power alert configuration specific to syslog"
- enabled: (boolean - default: false)
Enable logging of supply voltage alerts to syslog.
- alert_active_severity: (one of emergency, alert, critical, error, warning, notice, info, debug - default: error)
Syslog severity level to use when the alert becomes active (voltage is out of range) [no_sorting_required]
- alert_inactive_severity: (one of emergency, alert, critical, error, warning, notice, info, debug - default: info)
Syslog severity level to use when the alert becomes inactive (voltage is within range) [no_sorting_required]
- enabled: (boolean - default: false)
- enabled: (boolean - default: false)
- power_supply_voltage_alert: (object)
Example:
{
"power_alert_group": {
"power_supply_voltage_alert": {
"millivolt_lower": 11000,
"millivolt_upper": 13000,
"snmp": {
"enabled": true
},
"syslog": {
"enabled": true,
"alert_active_severity": "error",
"alert_inactive_severity": "info"
}
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /monitoring/alerts/power
Set the power alert group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- power_alert_group: required(object)
- power_supply_voltage_alert: (object)
System alerts are sent when the system reboots or the supply bus voltages are out of range.
- enabled: (boolean - default: false)
Enable the alerts for supply voltage range. If this is true, an alert will be sent when device's supply bus voltages are out of range. [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"power_alert_group":{"power_supply_voltage_alert":{"snmp":{"enabled":null}}}},"since":"10/2022"}
- deprecatedProperty
- millivolt_lower: (integer - default: 11000 - minimum: 8000 - maximum: 16000)
The lower level for the device's supply voltage range (in mV). If alerts are enabled and the supply voltage goes below this value, an alert is sent.
- millivolt_upper: (integer - default: 13000 - minimum: 8000 - maximum: 16000)
The upper level for the device's supply voltage range (in mV). If alerts are enabled and the supply voltage goes above this value, an alert is sent.
- snmp: (object)
"Power alert configuration specific to SNMP"
- enabled: (boolean - default: false)
Enable SNMP alerts for supply voltage range. If this is true, an alert will be sent when device's supply bus voltages are out of range.
- enabled: (boolean - default: false)
- syslog: (object)
"Power alert configuration specific to syslog"
- enabled: (boolean - default: false)
Enable logging of supply voltage alerts to syslog.
- alert_active_severity: (one of emergency, alert, critical, error, warning, notice, info, debug - default: error)
Syslog severity level to use when the alert becomes active (voltage is out of range) [no_sorting_required]
- alert_inactive_severity: (one of emergency, alert, critical, error, warning, notice, info, debug - default: info)
Syslog severity level to use when the alert becomes inactive (voltage is within range) [no_sorting_required]
- enabled: (boolean - default: false)
- enabled: (boolean - default: false)
- power_supply_voltage_alert: (object)
Example:
example1:
Enable all power alerts.
{
"power_alert_group": {
"power_supply_voltage_alert": {
"millivolt_lower": 11000,
"millivolt_upper": 13000,
"snmp": {
"enabled": true
},
"syslog": {
"enabled": true,
"alert_active_severity": "error",
"alert_inactive_severity": "info"
}
}
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- power_alert_group: required(object)
- power_supply_voltage_alert: (object)
System alerts are sent when the system reboots or the supply bus voltages are out of range.
- enabled: (boolean - default: false)
Enable the alerts for supply voltage range. If this is true, an alert will be sent when device's supply bus voltages are out of range. [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"power_alert_group":{"power_supply_voltage_alert":{"snmp":{"enabled":null}}}},"since":"10/2022"}
- deprecatedProperty
- millivolt_lower: (integer - default: 11000 - minimum: 8000 - maximum: 16000)
The lower level for the device's supply voltage range (in mV). If alerts are enabled and the supply voltage goes below this value, an alert is sent.
- millivolt_upper: (integer - default: 13000 - minimum: 8000 - maximum: 16000)
The upper level for the device's supply voltage range (in mV). If alerts are enabled and the supply voltage goes above this value, an alert is sent.
- snmp: (object)
"Power alert configuration specific to SNMP"
- enabled: (boolean - default: false)
Enable SNMP alerts for supply voltage range. If this is true, an alert will be sent when device's supply bus voltages are out of range.
- enabled: (boolean - default: false)
- syslog: (object)
"Power alert configuration specific to syslog"
- enabled: (boolean - default: false)
Enable logging of supply voltage alerts to syslog.
- alert_active_severity: (one of emergency, alert, critical, error, warning, notice, info, debug - default: error)
Syslog severity level to use when the alert becomes active (voltage is out of range) [no_sorting_required]
- alert_inactive_severity: (one of emergency, alert, critical, error, warning, notice, info, debug - default: info)
Syslog severity level to use when the alert becomes inactive (voltage is within range) [no_sorting_required]
- enabled: (boolean - default: false)
- enabled: (boolean - default: false)
- power_supply_voltage_alert: (object)
Example:
{
"power_alert_group": {
"power_supply_voltage_alert": {
"millivolt_lower": 11000,
"millivolt_upper": 13000,
"snmp": {
"enabled": true
},
"syslog": {
"enabled": true,
"alert_active_severity": "error",
"alert_inactive_severity": "info"
}
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure System Alert Group settings.
Get the system alert group settings.
Set the system alert group settings.
get /monitoring/alerts/system
Get the system alert group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_alert_group: required(object)
- authentication_alert: (object)
Authentication alerts are triggered when a user attempts to log in via SSH, REST API, or the device's serial ports. An alert is sent regardless of whether the login has succeeded or failed.
- enabled: (boolean - default: false)
Enable the alerts for authentication. If this is true, an alert will be sent when a user attempts to log in.
- enabled: (boolean - default: false)
- config_change_alert: (object)
Configuration change alerts are sent when changes occur to the system configuration.
- enabled: (boolean - default: false)
Enable the alerts for configuration changes. If this is true, an alert will be sent when changes occur to the system configuration.
- enabled: (boolean - default: false)
- temperature_alert: (object)
A temperature notification will be sent when any of the temperature sensors leaves or re-enters the specified range.
- enabled: (boolean - default: false)
Enable the alerts for the device's temperature range. If this is true, an alert will be sent when device's temperature sensors leaves or re-enters the specified range.
- threshold_lower: (integer - minimum: -127 - maximum: 127)
The lower trigger level for the device's temperature (in °C). If alerts are enabled and the temperature sensors goes below this value, an alert is sent.
- threshold_upper: (integer - minimum: -127 - maximum: 127)
The upper trigger level for the device's temperature (in °C). If alerts are enabled and the temperature sensors goes above this value, an alert is sent.
- enabled: (boolean - default: false)
- authentication_alert: (object)
Example:
{
"system_alert_group": {
"authentication_alert": {
"enabled": true
},
"config_change_alert": {
"enabled": true
},
"temperature_alert": {
"enabled": true,
"threshold_lower": 35,
"threshold_upper": 67
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /monitoring/alerts/system
Set the system alert group settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_alert_group: required(object)
- authentication_alert: (object)
Authentication alerts are triggered when a user attempts to log in via SSH, REST API, or the device's serial ports. An alert is sent regardless of whether the login has succeeded or failed.
- enabled: (boolean - default: false)
Enable the alerts for authentication. If this is true, an alert will be sent when a user attempts to log in.
- enabled: (boolean - default: false)
- config_change_alert: (object)
Configuration change alerts are sent when changes occur to the system configuration.
- enabled: (boolean - default: false)
Enable the alerts for configuration changes. If this is true, an alert will be sent when changes occur to the system configuration.
- enabled: (boolean - default: false)
- temperature_alert: (object)
A temperature notification will be sent when any of the temperature sensors leaves or re-enters the specified range.
- enabled: (boolean - default: false)
Enable the alerts for the device's temperature range. If this is true, an alert will be sent when device's temperature sensors leaves or re-enters the specified range.
- threshold_lower: (integer - minimum: -127 - maximum: 127)
The lower trigger level for the device's temperature (in °C). If alerts are enabled and the temperature sensors goes below this value, an alert is sent.
- threshold_upper: (integer - minimum: -127 - maximum: 127)
The upper trigger level for the device's temperature (in °C). If alerts are enabled and the temperature sensors goes above this value, an alert is sent.
- enabled: (boolean - default: false)
- authentication_alert: (object)
Examples:
example1:
Enable all system alerts.
{
"system_alert_group": {
"authentication_alert": {
"enabled": true
},
"config_change_alert": {
"enabled": true
},
"temperature_alert": {
"enabled": true,
"threshold_lower": 35,
"threshold_upper": 67
}
}
}
example2:
Disable all system alerts.
{
"system_alert_group": {}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_alert_group: required(object)
- authentication_alert: (object)
Authentication alerts are triggered when a user attempts to log in via SSH, REST API, or the device's serial ports. An alert is sent regardless of whether the login has succeeded or failed.
- enabled: (boolean - default: false)
Enable the alerts for authentication. If this is true, an alert will be sent when a user attempts to log in.
- enabled: (boolean - default: false)
- config_change_alert: (object)
Configuration change alerts are sent when changes occur to the system configuration.
- enabled: (boolean - default: false)
Enable the alerts for configuration changes. If this is true, an alert will be sent when changes occur to the system configuration.
- enabled: (boolean - default: false)
- temperature_alert: (object)
A temperature notification will be sent when any of the temperature sensors leaves or re-enters the specified range.
- enabled: (boolean - default: false)
Enable the alerts for the device's temperature range. If this is true, an alert will be sent when device's temperature sensors leaves or re-enters the specified range.
- threshold_lower: (integer - minimum: -127 - maximum: 127)
The lower trigger level for the device's temperature (in °C). If alerts are enabled and the temperature sensors goes below this value, an alert is sent.
- threshold_upper: (integer - minimum: -127 - maximum: 127)
The upper trigger level for the device's temperature (in °C). If alerts are enabled and the temperature sensors goes above this value, an alert is sent.
- enabled: (boolean - default: false)
- authentication_alert: (object)
Example:
{
"system_alert_group": {
"authentication_alert": {
"enabled": true
},
"config_change_alert": {
"enabled": true
},
"temperature_alert": {
"enabled": true,
"threshold_lower": 35,
"threshold_upper": 67
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/physifs
Read and manipulate the network physical interfaces on the NetOps Console Server appliance.
Get a list of the network interfaces on the NetOps Console Server appliance.
Add a new interface to the NetOps Console Server appliance.
Update a list of the network interfaces on the NetOps Console Server appliance.
get /physifs
Get a list of the network interfaces on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Possible types:
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
Example:
{
"physifs": [
{
"enabled": true,
"id": "system_net_physifs-1",
"name": "init_net1",
"media": "ethernet",
"mtu": 1500,
"device": "net1",
"mac_address": "00:00:de:ad:be:f1",
"dns": {
"nameservers": [],
"search_domains": []
},
"runtime_status": {
"status": "UP",
"id": "system_net_physifs-1"
},
"ethernet_setting": {
"id": "system_net_physifs-1",
"link_speed": "auto"
},
"description": "NET1 - 10G SFP+"
},
{
"enabled": true,
"id": "system_net_physifs-2",
"name": "init_net2",
"media": "ethernet",
"mtu": 1400,
"device": "net2",
"mac_address": "00:00:de:ad:be:f1",
"dns": {
"nameservers": [],
"search_domains": []
},
"runtime_status": {
"status": "UP",
"id": "system_net_physifs-2"
},
"ethernet_setting": {
"id": "system_net_physifs-2",
"link_speed": "auto"
},
"description": "NET2 - 1G Copper/SFP"
},
{
"enabled": false,
"id": "system_net_physifs-3",
"name": "init_cellular",
"media": "cellular",
"device": "wwan0",
"mac_address": "00:00:de:ad:be:f3",
"dns": {
"nameservers": [],
"search_domains": []
},
"runtime_status": {
"id": "system_net_physifs-3_runtime_status",
"status": "ENABLED"
},
"cellular_setting": {
"id": "system_net_physifs-3_cellular_setting",
"active_sim": 2,
"sim_failover_policy": "never",
"sim_failback_policy": "never",
"sims": [
{
"id": "system_net_physifs-3_cellular_setting_sims-1",
"slot": 1,
"apn": "vzwinternet",
"iptype": "IPv4v6",
"mtu": 1500,
"runtime_status": {
"id": "system_net_physifs-3_cellular_setting_sims-1_runtime_status",
"status": "DISABLED"
}
},
{
"id": "system_net_physifs-3_cellular_setting_sims-2",
"slot": 2,
"apn": "i2gold",
"iptype": "IPv4v6",
"ipv4_netmask": "255.255.255.252",
"mtu": 1492,
"runtime_status": {
"id": "system_net_physifs-3_cellular_setting_sims-2_runtime_status",
"status": "ENABLED"
}
}
]
},
"description": "Cellular Interface (LTE)"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /physifs
Add a new interface to the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Possible types:
postPhysif
- physif: required(object)
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: required(one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- device: (string - minLength: 1 - maxLength: 15 - pattern: ^[a-zA-Z0-9-_]+$)
The device name for this interface [regexerr:Upper and lowercase letters, regexerr:Numbers, regexerr:"-", regexerr:"_"]
Example:
net1
- enabled: required(boolean)
- physif: required(object)
postPhysif
- physif: required(object)
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: required(one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- device: (string - minLength: 1 - maxLength: 15 - pattern: ^[a-zA-Z0-9-_]+$)
The device name for this interface [regexerr:Upper and lowercase letters, regexerr:Numbers, regexerr:"-", regexerr:"_"]
Example:
net1
- enabled: required(boolean)
- physif: required(object)
postPhysif
- physif: required(object)
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: required(one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- device: (string - minLength: 1 - maxLength: 15 - pattern: ^[a-zA-Z0-9-_]+$)
The device name for this interface [regexerr:Upper and lowercase letters, regexerr:Numbers, regexerr:"-", regexerr:"_"]
Example:
net1
- enabled: required(boolean)
- physif: required(object)
postPhysif
- physif: required(object)
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: required(one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- device: (string - minLength: 1 - maxLength: 15 - pattern: ^[a-zA-Z0-9-_]+$)
The device name for this interface [regexerr:Upper and lowercase letters, regexerr:Numbers, regexerr:"-", regexerr:"_"]
Example:
net1
- enabled: required(boolean)
- physif: required(object)
Examples:
example1:
{
"physif": {
"enabled": true,
"media": "bridge",
"slaves": [
"net1",
"net2"
],
"dns": {
"nameservers": [],
"search_domains": []
}
}
}
example2:
{
"physif": {
"enabled": true,
"media": "bond",
"slaves": [
"net1",
"net2"
],
"bond_setting": {
"mode": "balance-rr"
},
"device": "bnd2"
}
}
HTTP status code 200
The new physif is returned.
Body
Media type: application/json
Possible types:
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
Example:
{
"physif": {
"id": "system_net_physifs-5",
"enabled": true,
"name": "init_br0",
"media": "bridge",
"device": "br0",
"mac_address": "00:00:de:ad:be:f1",
"description": "BR0 - Aggregate",
"slaves": [
"net1",
"net2"
],
"dns": {
"nameservers": [],
"search_domains": []
},
"runtime_status": {
"status": "UP",
"id": "system_net_physifs-5"
}
}
}
HTTP status code 400
Validation failure. For example, invalid or missing fields. Slave interfaces not valid.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /physifs
Update a list of the network interfaces on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Possible types:
putPhysifList
- physifs: required(array of object)
Items: physif
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: required(one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- device: (string - minLength: 1 - maxLength: 15 - pattern: ^[a-zA-Z0-9-_]+$)
The device name for this interface [regexerr:Upper and lowercase letters, regexerr:Numbers, regexerr:"-", regexerr:"_"]
Example:
net1
- enabled: required(boolean)
- physifs: required(array of object)
putPhysifList
- physifs: required(array of object)
Items: physif
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: required(one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- device: (string - minLength: 1 - maxLength: 15 - pattern: ^[a-zA-Z0-9-_]+$)
The device name for this interface [regexerr:Upper and lowercase letters, regexerr:Numbers, regexerr:"-", regexerr:"_"]
Example:
net1
- enabled: required(boolean)
- physifs: required(array of object)
putPhysifList
- physifs: required(array of object)
Items: physif
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: required(one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- device: (string - minLength: 1 - maxLength: 15 - pattern: ^[a-zA-Z0-9-_]+$)
The device name for this interface [regexerr:Upper and lowercase letters, regexerr:Numbers, regexerr:"-", regexerr:"_"]
Example:
net1
- enabled: required(boolean)
- physifs: required(array of object)
putPhysifList
- physifs: required(array of object)
Items: physif
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: required(one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- device: (string - minLength: 1 - maxLength: 15 - pattern: ^[a-zA-Z0-9-_]+$)
The device name for this interface [regexerr:Upper and lowercase letters, regexerr:Numbers, regexerr:"-", regexerr:"_"]
Example:
net1
- enabled: required(boolean)
- physifs: required(array of object)
Example:
{
"physifs": [
{
"enabled": true,
"media": "ethernet",
"mtu": 1500,
"device": "net1",
"ethernet_setting": {
"link_speed": "auto"
},
"description": "NET1 - 10G SFP+"
},
{
"enabled": true,
"media": "ethernet",
"mtu": 1400,
"device": "net2",
"ethernet_setting": {
"link_speed": "auto"
},
"description": "NET2 - 1G Copper/SFP"
},
{
"enabled": false,
"media": "cellular",
"device": "wwan0",
"cellular_setting": {
"active_sim": 2,
"sim_failover_policy": "never",
"sim_failback_policy": "never",
"sims": [
{
"slot": 1,
"apn": "vzwinternet",
"ipv4_netmask": "255.255.255.255",
"iptype": "IPv4v6",
"mtu": 1500
},
{
"slot": 2,
"apn": "i2gold",
"iptype": "IPv4v6",
"mtu": 1492
}
]
},
"description": "Cellular Interface (LTE)"
},
{
"enabled": true,
"media": "bridge",
"slaves": [
"net1",
"net2"
]
}
]
}
HTTP status code 200
Body
Media type: application/json
Possible types:
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
HTTP status code 400
Validation failure. For example, invalid or missing fields. Slave interfaces not valid.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and update configuration for a specific network interface on the NetOps Console Server.
Get a network interface on the NetOps Console Server appliance by id.
Update settings for a network interface on the NetOps Console Server appliance.
Delete a network interface by id. Currently only aggregate interfaces can be deleted.
get /physifs/{id}
Get a network interface on the NetOps Console Server appliance by id.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Possible types:
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
Example:
{
"physif": {
"enabled": true,
"id": "system_net_physifs-2",
"name": "init_net2",
"media": "ethernet",
"device": "net2",
"mac_address": "00:00:de:ad:be:f0",
"dns": {
"nameservers": [
"9.9.9.9",
"8.8.8.8"
],
"search_domains": [
"iot",
"foobar.iot"
]
},
"runtime_status": {
"status": "UP",
"id": "system_net_physifs-2"
},
"ethernet_setting": {
"id": "system_net_physifs-2",
"link_speed": "auto"
},
"description": "NET2 - 1G Copper/SFP"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /physifs/{id}
Update settings for a network interface on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Possible types:
putPhysif
- physif: required(object)
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: (one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type [visible:never]
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- enabled: required(boolean)
- physif: required(object)
putPhysif
- physif: required(object)
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: (one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type [visible:never]
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- enabled: required(boolean)
- physif: required(object)
putPhysif
- physif: required(object)
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: (one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type [visible:never]
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- enabled: required(boolean)
- physif: required(object)
putPhysif
- physif: required(object)
- enabled: required(boolean)
Enable or Disable this interface
- mtu: (integer - default: 1500 - minimum: 68 - maximum: 1500)
maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction [visible:media:!=:loopback]
- description: (string)
A description of this physical interface.
- media: (one of ethernet, cellular, bridge, bond, vlan, loopback)
The device media type [visible:never]
- slaves: (array of string)
A list of physifs to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond. [visible:media:in:bond|bridge]
- dns: (object)
DNS Settings for the interface [visible:media:!=:loopback]
- nameservers: (array of string)
A List of Name servers addresses
- search_domains: (array of string)
A List of Search domains
- nameservers: (array of string)
- ethernet_setting: (object)
Settings for this Ethernet interface [visible:media:=:ethernet, required:media:=:ethernet]
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
Settings for this Cellular interface [visible:media:=:cellular, required:media:=:cellular]
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sims: required(array of object)
Contains the sim settings for the cellular modems. Includes fields like abn and failover configuation [fixed-size]
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
Settings for this Bond interface [visible:media:=:bond, required:media:=:bond]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
Settings for this Bridge interface [visible:media:=:bridge, required:media:=:bridge]
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
Settings for this VLAN interface [visible:media:=:vlan, required:media:=:vlan]
- parent_physif: (string)
Primary physical interface used for vlan configuration [computed_options:physifs_no_loopbacks]
- vlan_id: (integer - minimum: 1 - maximum: 4094)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- enabled: required(boolean)
- physif: required(object)
Example:
{
"physif": {
"enabled": true,
"ethernet_setting": {
"link_speed": "auto"
}
}
}
HTTP status code 200
The physif {id} settings was updated.
Body
Media type: application/json
Possible types:
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
The Link Speed for this interface.
- hd = half duplex
- fd = full duplex
- auto = auto negotiation of link speed
- id: required(string)
- link_speed: required(one of auto, 1000mbps-hd, 1000mbps-fd, 100mbps-hd, 100mbps-fd, 10mbps-hd, 10mbps-fd)
- cellular_setting: (object)
- apn: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[visible:never, sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- active_sim: (number - minimum: 1 - maximum: 2)
The current selected SIM
- sim_failover_policy: (one of never, on_disconnect)
Failover policy for SIM-SIM
- sim_failover_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- sim_failback_policy: (one of never, delayed, on_disconnect)
Method of checking if a cellular connection should failback to the primary SIM
- sim_failback_disconnect_mode: (ping)
Method of checking if a cellular connection has been disconnected
- id: required(string)
- sims: required(array of object)
Items: items
- slot: (integer - minimum: 1 - maximum: 2)
SIM Slot
- apn: (string)
SIM APN
- username: (string)
SIM User
- password: (string)
Cellular Password [sensitive]
- iptype: (one of IPv4, IPv6, IPv4v6)
The type of connection for this SIM
- ipv4_netmask: (string)
This IPv4 Subnet Mask will override the carrier allocated one
- mtu: (number)
Maximum Transmission Unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single network layer transaction
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number - default: 600 - minimum: 10)
Test interval (in seconds)
- fail_probe_count: (number - default: 3 - minimum: 1)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number - default: 1 - minimum: 1)
Number of consecutive test failures before failover/failback
- id: required(string)
- runtime_status: (object)
- id: required(string)
- iccid: (string)
SIM ICCID
- status: (string)
- slot: (integer - minimum: 1 - maximum: 2)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
Specifies one of the bonding policies to be used
- poll_interval: (integer - default: 100 - minimum: 0)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces. [computed_options:physifs_no_loopbacks]
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address. [computed_options:physifs_no_loopbacks]
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- dns: required(object)
- nameservers: required(array of string)
- search_domains: required(array of string)
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
Example:
{
"physif": {
"enabled": true,
"id": "system_net_physifs-2",
"name": "init_net2",
"media": "ethernet",
"device": "net2",
"mac_address": "00:00:de:ad:be:f0",
"dns": {
"nameservers": [],
"search_domains": []
},
"runtime_status": {
"status": "UP",
"id": "system_net_physifs-2"
},
"ethernet_setting": {
"id": "system_net_physifs-2",
"link_speed": "auto"
},
"description": "NET2 - 1G Copper/SFP"
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: physif id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
physif {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /physifs/{id}
Delete a network interface by id. Currently only aggregate interfaces can be deleted.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
The aggregate physif {id} was deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
physif {id} does not exist. physif {id} is not an aggregate interface.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/conns
Read and manipulate the network connections on the NetOps Console Server appliance.
Get a list of the network connections on the server.
Add a new network connection to the NetOps Console Server appliance.
Put a list of the network connections on the server.
get /conns
Get a list of the network connections on the server.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Possible types:
connGetList
- conns: required(array of object)
A Network Conn
Items: connGetItem
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- id: required(string)
- name: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv4_address
- address: (string)
- netmask: (string)
- last_status_change: required(number)
- gateway: (string)
- dns1: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- conns: required(array of object)
connGetList
- conns: required(array of object)
A Network Conn
Items: connGetItem
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- id: required(string)
- name: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv6_address
- address: (string)
- prefix_length: (number)
- last_status_change: required(number)
- gateway: (string)
- dns1: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- conns: required(array of object)
Example:
{
"conns": [
{
"id": "system_net_conns-1",
"name": "default-conn-1",
"description": "IPv4 static network connection",
"physif": "net1",
"mode": "static",
"ipv4_static_settings": {
"netmask": "255.255.255.0",
"address": "192.168.87.156",
"gateway": "192.168.87.100",
"broadcast": "192.168.87.255"
},
"runtime_status": {
"status": "running",
"last_status_change": 1471506633,
"addresses": [
{
"id": "system_net_conns-address-1",
"address": "192.168.87.156",
"netmask": "255.255.255.0"
}
],
"gateway": "192.168.87.254",
"dns1": "8.8.8.8",
"dns2": "192.168.33.254"
}
},
{
"id": "system_net_conns-3",
"name": "default-conn-2",
"description": "IPv6 static network connection",
"physif": "net1",
"mode": "ipv6_static",
"ipv6_static_settings": {
"address": "2001:b:c:d::8329",
"prefix_length": 64,
"gateway": "2001:b:c:d::254"
},
"runtime_status": {
"status": "running",
"last_status_change": 1471506633,
"addresses": [
{
"id": "system_net_conns-2-address-1",
"address": "2001:b:c:d::8329",
"prefix_length": 64
},
{
"id": "system_net_conns-2-address-2",
"address": "2001:b:c:d::8320",
"netmask": "64"
}
],
"gateway": "192.168.87.254",
"dns1": "DDDD:0002:3008:8CFD:00AB:0002:3008:AAAA",
"dns2": "DDDD:0002:3008:8CFD:00AB:0002:3008:BBBB"
}
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /conns
Add a new network connection to the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- conn: required(object)
A Network Conn
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
Example:
{
"conn": {
"ipv4_static_settings": {
"netmask": "255.255.255.0",
"address": "192.168.87.156",
"gateway": "192.168.87.100",
"broadcast": "192.168.87.255"
},
"mode": "static",
"physif": "net1"
}
}
HTTP status code 200
The conn {id} settings was updated.
Body
Media type: application/json
Possible types:
connGet
- conn: required(object)
A Network Conn
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- id: required(string)
- name: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv4_address
- address: (string)
- netmask: (string)
- last_status_change: required(number)
- gateway: (string)
- dns1: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- conn: required(object)
connGet
- conn: required(object)
A Network Conn
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- id: required(string)
- name: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv6_address
- address: (string)
- prefix_length: (number)
- last_status_change: required(number)
- gateway: (string)
- dns1: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- conn: required(object)
Example:
{
"conn": {
"id": "system_net_conns-9",
"mode": "static",
"physif": "net1",
"name": "default-conn-2",
"ipv4_static_settings": {
"netmask": "255.255.255.0",
"address": "192.168.87.156",
"gateway": "192.168.87.100",
"broadcast": "192.168.87.255"
},
"runtime_status": {
"status": "reloading",
"addresses": [
{}
],
"last_status_change": 1536209633
}
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: conn id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Conn {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /conns
Put a list of the network connections on the server.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- conns: required(array of object)
Items: items
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- name: required(string)
Example:
{
"conns": [
{
"name": "conn-66",
"mode": "static",
"physif": "net1",
"ipv4_static_settings": {
"netmask": "255.255.255.0",
"address": "192.168.87.156",
"gateway": "192.168.87.100",
"broadcast": "192.168.87.255"
}
},
{
"name": "conn-67",
"mode": "static",
"physif": "net2",
"ipv4_static_settings": {
"netmask": "255.255.255.0",
"address": "192.168.7.16",
"gateway": "192.168.7.1",
"broadcast": "192.168.7.255"
}
}
]
}
HTTP status code 200
Body
Media type: application/json
Possible types:
connGetList
- conns: required(array of object)
A Network Conn
Items: connGetItem
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- id: required(string)
- name: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv4_address
- address: (string)
- netmask: (string)
- last_status_change: required(number)
- gateway: (string)
- dns1: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- conns: required(array of object)
connGetList
- conns: required(array of object)
A Network Conn
Items: connGetItem
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- id: required(string)
- name: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv6_address
- address: (string)
- prefix_length: (number)
- last_status_change: required(number)
- gateway: (string)
- dns1: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- conns: required(array of object)
HTTP status code 400
Validation failure. For example, invalid or missing fields. Duplicate conn names.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and update configuration for a specific network connection on the NetOps Console Server.
Get the configuration of a network connection on the NetOps Console Server appliance.
Update settings for a network connection on the NetOps Console Server appliance.
Delete a network connection on the NetOps Console Server appliance.
get /conns/{id}
Get the configuration of a network connection on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Possible types:
connGet
- conn: required(object)
A Network Conn
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- id: required(string)
- name: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv4_address
- address: (string)
- netmask: (string)
- last_status_change: required(number)
- gateway: (string)
- dns1: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- conn: required(object)
connGet
- conn: required(object)
A Network Conn
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- id: required(string)
- name: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv6_address
- address: (string)
- prefix_length: (number)
- last_status_change: required(number)
- gateway: (string)
- dns1: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- conn: required(object)
Example:
{
"conn": {
"name": "default-conn-1",
"ipv4_static_settings": {
"netmask": "255.255.255.0",
"address": "192.168.87.156",
"gateway": "192.168.87.100",
"broadcast": "192.168.87.255"
},
"id": "system_net_conns-1",
"mode": "static",
"description": "Default static network connection",
"physif": "net1",
"runtime_status": {
"status": "reloading",
"addresses": [
{}
],
"last_status_change": 1536210047
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /conns/{id}
Update settings for a network connection on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- conn: required(object)
A Network Conn
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
Example:
{
"conn": {
"ipv4_static_settings": {
"netmask": "255.255.255.0",
"address": "192.168.87.156",
"gateway": "192.168.87.100",
"broadcast": "192.168.87.255"
},
"mode": "static",
"physif": "net1"
}
}
HTTP status code 200
The conn settings were updated.
Body
Media type: application/json
Possible types:
connGet
- conn: required(object)
A Network Conn
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- id: required(string)
- name: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv4_address
- address: (string)
- netmask: (string)
- last_status_change: required(number)
- gateway: (string)
- dns1: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- conn: required(object)
connGet
- conn: required(object)
A Network Conn
- description: (string)
- mode: required(string)
The connection can be configured as one of the following modes:
- static: static ipv4 connection
- ipv6_static: static ipv6 connection
- dhcp: dhcp ipv4 connection
- ipv6_automatic: dhcp ipv6 connection [computed_options:loopback_modes]
- physif: required(string)
The network interface to be used for this connection [reference:physif:device]
- ipv4_static_settings: (object)
Settings for ipv4 static connection [visible:mode:=:static, required:mode:=:static]
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- ipv6_static_settings: (object)
Settings for ipv6 static connection [visible:mode:=:ipv6_static, required:mode:=:ipv6_static]
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
[visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- id: required(string)
- name: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv6_address
- address: (string)
- prefix_length: (number)
- last_status_change: required(number)
- gateway: (string)
- dns1: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- dns2: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"physif":{"dns":{"nameservers":[]}}},"since":"10/2021"}
- deprecatedProperty
- conn: required(object)
Example:
{
"conn": {
"name": "default-conn-2",
"ipv4_static_settings": {
"broadcast": "192.168.87.255",
"gateway": "192.168.87.100",
"address": "192.168.87.156",
"netmask": "255.255.255.0"
},
"id": "system_net_conns-2",
"mode": "static",
"physif": "net1",
"runtime_status": {
"status": "reloading",
"addresses": [
{}
],
"last_status_change": 1536210052
}
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: conn id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Conn {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /conns/{id}
Delete a network connection on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Conn deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
User did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find conn with name or id 'system_net_conns-1'",
"args": {
"uuid": "system_net_conns-1"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/static_routes
Configuring and viewing static routes
Get list of static routes
Create a list of static routes. Overwrite existing routes
Add a static route
Delete all static routes
get /static_routes
Get list of static routes
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- static_routes: required(array of object)
The root object
Items: items
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer - minimum: 0 - maximum: 128)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given. [computed_options:physifs_no_loopbacks]
- metric: (integer - minimum: 0)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- id: required(string)
Unique id of item
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this static route
- destination_address: required(string)
Examples:
example1:
Gets two static routes
{
"static_routes": [
{
"id": "system_net_static_routes-1",
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100,
"multi_field_identifier": "192.168.10.0/24-100"
},
{
"id": "system_net_static_routes-2",
"destination_address": "192.168.20.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net2",
"multi_field_identifier": "192.168.20.0/24"
}
]
}
example2:
No static routes present
{
"static_routes": []
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /static_routes
Create a list of static routes. Overwrite existing routes
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- static_routes: required(array of object)
The root object
Items: items
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer - minimum: 0 - maximum: 128)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given. [computed_options:physifs_no_loopbacks]
- metric: (integer - minimum: 0)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- destination_address: required(string)
Example:
example1:
Sets two routes
{
"static_routes": [
{
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100
},
{
"destination_address": "192.168.20.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net2",
"metric": 100
}
]
}
HTTP status code 200
List of static routes
Body
Media type: application/json
Type: object
Properties- static_routes: required(array of object)
The root object
Items: items
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer - minimum: 0 - maximum: 128)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given. [computed_options:physifs_no_loopbacks]
- metric: (integer - minimum: 0)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- id: required(string)
Unique id of item
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this static route
- destination_address: required(string)
Example:
{
"static_routes": [
{
"id": "system_net_static_routes-1",
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100,
"multi_field_identifier": "192.168.10.0/24-100"
},
{
"id": "system_net_static_routes-2",
"destination_address": "192.168.20.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net2",
"metric": 100,
"multi_field_identifier": "192.168.20.0/24-100"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /static_routes
Add a static route
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- static_route: required(object)
The root object
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer - minimum: 0 - maximum: 128)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given. [computed_options:physifs_no_loopbacks]
- metric: (integer - minimum: 0)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- destination_address: required(string)
Example:
{
"static_route": {
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100
}
}
HTTP status code 200
Static route was created
Body
Media type: application/json
Type: object
Properties- static_route: required(object)
The root object
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer - minimum: 0 - maximum: 128)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given. [computed_options:physifs_no_loopbacks]
- metric: (integer - minimum: 0)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- id: required(string)
Unique id of item
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this static route
- destination_address: required(string)
Example:
{
"static_route": {
"id": "system_net_static_routes-1",
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100,
"multi_field_identifier": "192.168.10.0/24-100"
}
}
HTTP status code 400
Failed to create static route
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /static_routes
Delete all static routes
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Static routes were removed
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and update configuration for a specific static route.
Get the configuration of a static route by its id.
Set the properties of a static route.
Delete a static route
get /static_routes/{id}
Get the configuration of a static route by its id.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The requested static route configuration.
Body
Media type: application/json
Type: object
Properties- static_route: required(object)
The root object
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer - minimum: 0 - maximum: 128)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given. [computed_options:physifs_no_loopbacks]
- metric: (integer - minimum: 0)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- id: required(string)
Unique id of item
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this static route
- destination_address: required(string)
Example:
{
"static_route": {
"id": "system_net_static_routes-1",
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100,
"multi_field_identifier": "192.168.10.0/24-100"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 404
The static route doesn't exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find static_route with multi_field_identifier or id 'system_net_static_routes-1'",
"args": {
"uuid": "system_net_static_routes-1"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /static_routes/{id}
Set the properties of a static route.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- static_route: required(object)
The root object
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer - minimum: 0 - maximum: 128)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given. [computed_options:physifs_no_loopbacks]
- metric: (integer - minimum: 0)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- destination_address: required(string)
Example:
{
"static_route": {
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100
}
}
HTTP status code 200
The updated static route configuration.
Body
Media type: application/json
Type: object
Properties- static_route: required(object)
The root object
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer - minimum: 0 - maximum: 128)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given. [computed_options:physifs_no_loopbacks]
- metric: (integer - minimum: 0)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- id: required(string)
Unique id of item
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this static route
- destination_address: required(string)
Example:
{
"static_route": {
"id": "system_net_static_routes-1",
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100,
"multi_field_identifier": "192.168.10.0/24-100"
}
}
HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
The static route doesn't exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find static_route with multi_field_identifier or id 'system_net_static_routes-1'",
"args": {
"uuid": "system_net_static_routes-1"
},
"level": 1
}
]
}
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /static_routes/{id}
Delete a static route
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Static route deleted
HTTP status code 400
Static route does not exist
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/lighthouse_enrollments
View and control enrollment to a lighthouse
Get the information about the lighthouse enrollments
Create a new lighthouse enrollment
get /lighthouse_enrollments
Get the information about the lighthouse enrollments
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- lighthouse-enrollments: required(array of object)
Items: items
- port: (integer)
The Lighthouse server port to use when requesting enrollment. Default port is 443.
- address: required(string)
The address of the Lighthouse server to request enrollment with.
- id: required(string)
Automatically generated unique ID of this Lighthouse enrollment configuration.
- bundle: (string)
Name of the Lighthouse bundle to request during enrollment. This should match the name of a pre-configured bundle in the Lighthouse instance.
- status: required(string)
Current status of this Lighthouse enrollment (Connected, Disconnected).
- port: (integer)
Example:
{
"lighthouse-enrollments": [
{
"port": 443,
"address": "192.168.0.1",
"id": "lighthouse_enrollments-1",
"bundle": "bundle",
"status": "Enrolling"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /lighthouse_enrollments
Create a new lighthouse enrollment
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- lighthouse_enrollment: required(object)
- address: required(string)
The address of the Lighthouse server to request enrollment with.
- port: (integer - default: 443 - minimum: 1 - maximum: 65535)
The Lighthouse server port to use when requesting enrollment. Default port is 443.
- bundle: (string)
Name of the Lighthouse bundle to request during enrollment. This must match the name of a pre-configured bundle in the Lighthouse instance.
- token: required(string)
The shared secret used to authenticate the enrollment request (required). If a bundle name is specified this must match the token specified in the bundle configuration, otherwise it must match the general enrollment token.
- address: required(string)
Example:
{
"lighthouse_enrollment": {
"address": "192.168.0.1",
"token": "password",
"bundle": "bundle-1",
"port": 8443
}
}
HTTP status code 201
The new lighthouse enrollment was successfully created and callhome enrollment was started.
Body
Media type: application/json
Type: object
Properties- lighthouse_enrollment: required(object)
- port: (integer)
The Lighthouse server port to use when requesting enrollment. Default port is 443.
- address: required(string)
The address of the Lighthouse server to request enrollment with.
- id: required(string)
Automatically generated unique ID of this Lighthouse enrollment configuration.
- bundle: (string)
Name of the Lighthouse bundle to request during enrollment. This should match the name of a pre-configured bundle in the Lighthouse instance.
- status: required(string)
Current status of this Lighthouse enrollment (Connected, Disconnected).
- port: (integer)
Example:
{
"lighthouse_enrollment": {
"id": "lighthouse_enrollments-1",
"port": 8443,
"status": "Enrolling",
"address": "192.168.0.1"
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or remove configuration for a specific Lighthouse enrollment.
Get lighthouse-enrollment information by id.
Delete lighthouse enrollment object and begin unenrollment
get /lighthouse_enrollments/{id}
Get lighthouse-enrollment information by id.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
ID of the lighthouse-enrollment to fetch
Example:
lighthouse_enrollment-2
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- lighthouse_enrollment: required(object)
- port: (integer)
The Lighthouse server port to use when requesting enrollment. Default port is 443.
- address: required(string)
The address of the Lighthouse server to request enrollment with.
- id: required(string)
Automatically generated unique ID of this Lighthouse enrollment configuration.
- bundle: (string)
Name of the Lighthouse bundle to request during enrollment. This should match the name of a pre-configured bundle in the Lighthouse instance.
- status: required(string)
Current status of this Lighthouse enrollment (Connected, Disconnected).
- port: (integer)
Example:
{
"lighthouse_enrollment": {
"id": "lighthouse_enrollments-2",
"port": 443,
"status": "Connected",
"address": "192.168.0.1"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 404
The lighthouse-enrollment doesn't exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find lighthouse_enrollment with address or id 'lighthouse_enrollments-6'",
"args": {
"uuid": "lighthouse_enrollments-6"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /lighthouse_enrollments/{id}
Delete lighthouse enrollment object and begin unenrollment
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
ID of the lighthouse-enrollment to fetch
Example:
lighthouse_enrollment-2
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"message": "OK"
}
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find lighthouse_enrollment with address or id 'lighthouse_enrollments-20'",
"args": {
"uuid": "lighthouse_enrollments-20"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/registration
Registration endpoint accessed by a Lighthouse to start Lighthouse driven enrollment
Initial contact from Lighthouse to start the Enrollment process
Remove connection to this lighthouse
post /registration
Initial contact from Lighthouse to start the Enrollment process
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- id: required(string)
- package_password: required(string)
- server: required(string)
- server_api_port: (integer)
- lh_ext_eps: (array of object)
Items: items
- server: required(string)
- server_api_port: (integer)
- server_vpn_port: (integer)
Example:
{
"id": "nodes-1",
"server": "192.168.0.1",
"server_api_port": 8443,
"package_password": "password",
"lh_ext_eps": [
{
"server": "162.168.0.1",
"server_api_port": 8443,
"server_vpn_port": 1121
},
{
"server": "162.168.0.2",
"server_api_port": 601,
"server_vpn_port": 1121
}
]
}
HTTP status code 201
Body
Media type: application/json
Type: object
Example:
{
"message": "OK"
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /registration
Remove connection to this lighthouse
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"message": "OK"
}
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 500
Internal Server Error
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Remove a connection to a given Lighthouse by ID
delete /registration/{id}
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
The lighthouse system name
Example:
lighthouse-5633-1563
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Lighthouse connection removed successfully
Body
Media type: application/json
Type: object
Example:
{
"message": "OK"
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Example:
{
"error": "Parameter 'id' not provided."
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
HTTP status code 500
Internal server error
Body
Media type: application/json
Type: object
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Update the lhvpn_tunnel server address
put /registration/{id}/server_address
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
The lighthouse system name
Example:
lighthouse-5633-1563
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- address: required(string)
Example:
{
"address": "192.168.0.1"
}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"message": "OK"
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'nodes-1'",
"args": {
"uuid": "nodes-1"
},
"level": 1
}
]
}
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/system
System endpoints are related to configuring and accessing information about the NetOps Console Server appliance itself.
Retrieve the system's Disk Space usage
get /system/diskspace
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_disk_space: required(array of object)
Items: items
- path: required(string)
- total_space: required(integer)
total space for the path in bytes
- free_space: required(integer)
available space for the path in bytes
Example:
{
"system_disk_space": [
{
"path": "/etc",
"total_space": 511044485120,
"free_space": 401935421440
},
{
"path": "/tmp",
"total_space": 511044485120,
"free_space": 401935421440
},
{
"path": "/mnt/nvram",
"total_space": 511044485120,
"free_space": 401935421440
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
get /system/diskspace/{path}
NetOps Console Server base authentication scheme.
URI Parameters
- path: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_disk_space_item: required(object)
A disk space entry.
- path: required(string)
- total_space: required(integer)
total space for the path in bytes
- free_space: required(integer)
available space for the path in bytes
Example:
{
"system_disk_space_item": {
"path": "/etc",
"total_space": 511044485120,
"free_space": 401935421440
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or change the NetOps Console Server appliance system's hostname.
Get the NetOps Console Server appliance hostname.
Set the NetOps Console Server appliance hostname.
get /system/hostname
Get the NetOps Console Server appliance hostname.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_hostname: required(object)
- hostname: required(string)
Example:
{
"system_hostname": {
"hostname": "OM2000"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/hostname
Set the NetOps Console Server appliance hostname.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_hostname: required(object)
- hostname: required(string)
Example:
{
"system_hostname": {
"hostname": "OM2000"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_hostname: required(object)
- hostname: required(string)
Example:
{
"system_hostname": {
"hostname": "OM2000"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or change the NetOps Console Server appliance system's banner text.
Get the NetOps Console Server appliance banner text.
Set the NetOps Console Server appliance banner text.
get /system/banner
Get the NetOps Console Server appliance banner text.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_banner: required(object)
- banner: required(string)
This message will be displayed as the banner when users login via SSH, console and the web UI. [multi-line-string,can-be-empty]
- banner: required(string)
Example:
{
"system_banner": {
"banner": "********************************************************************************\nUNAUTHORIZED ACCESS TO THIS DEVICE IS PROHIBITED\nYou must have explicit, authorized permission to access or configure this\n device. Unauthorized attempts and actions to access or use this system may\n result in civil and/or criminal penalties. All activities performed on this\n device are logged and monitored.\n********************************************************************************"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/banner
Set the NetOps Console Server appliance banner text.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_banner: required(object)
- banner: required(string)
This message will be displayed as the banner when users login via SSH, console and the web UI. [multi-line-string,can-be-empty]
- banner: required(string)
Example:
{
"system_banner": {
"banner": "********************************************************************************\nUNAUTHORIZED ACCESS TO THIS DEVICE IS PROHIBITED\nYou must have explicit, authorized permission to access or configure this\n device. Unauthorized attempts and actions to access or use this system may\n result in civil and/or criminal penalties. All activities performed on this\n device are logged and monitored.\n********************************************************************************"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_banner: required(object)
- banner: required(string)
This message will be displayed as the banner when users login via SSH, console and the web UI. [multi-line-string,can-be-empty]
- banner: required(string)
Example:
{
"system_banner": {
"banner": "A new banner\nWith 2 lines"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or change the NetOps Console Server appliance system's cloud connect configuration.
Get the NetOps Console Server appliance cloud connect configuration.
Set the NetOps Console Server appliance cloud connect configuration.
get /system/cloud_connect
Get the NetOps Console Server appliance cloud connect configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_cloud_connect: required(object)
- cloud_connect_url: required(string)
The URL to use for cloud connect.
- cloud_callhome_enabled: required(boolean)
Set this to true to enable cloud connect.
- cloud_connect_url: required(string)
Example:
{
"system_cloud_connect": {
"cloud_connect_url": "tm1.digi.com",
"cloud_callhome_enabled": true
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/cloud_connect
Set the NetOps Console Server appliance cloud connect configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_cloud_connect: required(object)
- cloud_connect_url: required(string)
The URL to use for cloud connect.
- cloud_callhome_enabled: required(boolean)
Set this to true to enable cloud connect.
- cloud_connect_url: required(string)
Example:
{
"system_cloud_connect": {
"cloud_connect_url": "tm2.digi.com",
"cloud_callhome_enabled": false
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_cloud_connect: required(object)
- cloud_connect_url: required(string)
The URL to use for cloud connect.
- cloud_callhome_enabled: required(boolean)
Set this to true to enable cloud connect.
- cloud_connect_url: required(string)
Example:
{
"system_cloud_connect": {
"cloud_connect_url": "tm2.digi.com",
"cloud_callhome_enabled": false
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or change the NetOps Console Server appliance WebUI session timeout.
Retrieve the WebUI session timeout (in minutes).
Set the WebUI session timeout (in minutes).
get /system/webui_session_timeout
Retrieve the WebUI session timeout (in minutes).
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_webui_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_webui_session_timeout": {
"timeout": 20
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/webui_session_timeout
Set the WebUI session timeout (in minutes).
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_webui_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_webui_session_timeout": {
"timeout": 20
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_webui_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_webui_session_timeout": {
"timeout": 20
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or change the NetOps Console Server appliance CLI.
Retrieve the CLI session timeout (in minutes).
Set the CLI session timeout (in minutes).
get /system/cli_session_timeout
Retrieve the CLI session timeout (in minutes).
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_cli_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_cli_session_timeout": {
"timeout": 0
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/cli_session_timeout
Set the CLI session timeout (in minutes).
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_cli_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_cli_session_timeout": {
"timeout": 20
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_cli_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_cli_session_timeout": {
"timeout": 20
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or change the NetOps Console Server appliance session timeouts.
Retrieve session timeouts (in minutes).
Set the session timeouts (in minutes).
get /system/session_timeout
Retrieve session timeouts (in minutes).
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_session_timeout: required(object)
- cli_timeout: required(number - minimum: 0 - maximum: 1440)
The timeout (in minutes) for local console, web terminal, and ssh sessions. Maximum value is 1440. Set this to 0 to disable the timeout.
- webui_timeout: required(integer - minimum: 1 - maximum: 1440)
The timeout (in minutes) for web UI and REST API sessions. Maximum value is 1440.
- serial_port_timeout: required(number - minimum: 0 - maximum: 1440)
The timeout (in minutes) for serial port sessions. Maximum value is 1440.
- cli_timeout: required(number - minimum: 0 - maximum: 1440)
Example:
{
"system_session_timeout": {
"cli_timeout": 0,
"webui_timeout": 20,
"serial_port_timeout": 0
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/session_timeout
Set the session timeouts (in minutes).
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_session_timeout: required(object)
- cli_timeout: required(number - minimum: 0 - maximum: 1440)
The timeout (in minutes) for local console, web terminal, and ssh sessions. Maximum value is 1440. Set this to 0 to disable the timeout.
- webui_timeout: required(integer - minimum: 1 - maximum: 1440)
The timeout (in minutes) for web UI and REST API sessions. Maximum value is 1440.
- serial_port_timeout: required(number - minimum: 0 - maximum: 1440)
The timeout (in minutes) for serial port sessions. Maximum value is 1440.
- cli_timeout: required(number - minimum: 0 - maximum: 1440)
Example:
{
"system_session_timeout": {
"cli_timeout": 20,
"webui_timeout": 20,
"serial_port_timeout": 20
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_session_timeout: required(object)
- cli_timeout: required(number - minimum: 0 - maximum: 1440)
The timeout (in minutes) for local console, web terminal, and ssh sessions. Maximum value is 1440. Set this to 0 to disable the timeout.
- webui_timeout: required(integer - minimum: 1 - maximum: 1440)
The timeout (in minutes) for web UI and REST API sessions. Maximum value is 1440.
- serial_port_timeout: required(number - minimum: 0 - maximum: 1440)
The timeout (in minutes) for serial port sessions. Maximum value is 1440.
- cli_timeout: required(number - minimum: 0 - maximum: 1440)
Example:
{
"system_session_timeout": {
"cli_timeout": 20,
"webui_timeout": 20,
"serial_port_timeout": 20
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Configure the SSH authorized keys for all users.
Retrieve ssh authorized keys for all users
Add an SSH key for the specified user
get /system/system_authorized_keys
Retrieve ssh authorized keys for all users
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_authorized_keys: required(array of object)
Items: items
- id: required(string)
ID of SSH key
- key: required(string)
The SSH key
- key_fingerprint: required(string)
The fingerprint of the SSH key
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this key
- username: required(string)
The user associated with the SSH key
- id: required(string)
Examples:
example1:
System that has 2 SSH keys belonging to 2 different users
{
"system_authorized_keys": [
{
"id": "users_ssh_authorized_keys-1",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF /home/root/.ssh/id_rsa\n",
"key_fingerprint": "2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 /home/root/.ssh/id_rsa\n (RSA)",
"username": "root",
"multi_field_identifier": "root 2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 /home/root/.ssh/id_rsa\n (RSA)"
},
{
"id": "users_ssh_authorized_keys-2",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCb/1mDgaqjrBq1Mnyt1oOxFkmSm6HOCUlETW0KCGpSTpaKppb35I2ec7Pka8H4u40FFUcVQeAtHl2R1JIWo5d+Avb1+W/+uhEiJ2TI9GQTeLiHEJYD0QwhwJLUYXk0FkLPkpvVBag3MwUIh3atun0Aq/2C42EeIhFkcniGQFZsgjDaASw7QEYUTyIYr5AARA2cM1OXWNneJOKsOlOxVwQJPeTBa1tFKjg0cw5ISBXHyqUvUJfwZkI8FCfAyJ2Q7OEjJcKCydL500ZmpmDre+gth3qkgGIiteMvbN3OBmFBLq8pZdzsX7tkT28eyJ7FJTSkvsRkHkHQkZW/gaXPp5PR admin@admin-1",
"key_fingerprint": "2048 SHA256:KXoalyRQfYNhKr3stn3YPvvxuWS7L3LWqsHPInvRgqY admin@admin-1 (RSA)",
"username": "admin",
"multi_field_identifier": "admin 2048 SHA256:KXoalyRQfYNhKr3stn3YPvvxuWS7L3LWqsHPInvRgqY admin@admin-1 (RSA)"
}
]
}
example2:
System that has no SSH keys
{
"system_authorized_keys": []
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /system/system_authorized_keys
Add an SSH key for the specified user
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_authorized_key: required(object)
- key: required(string)
The SSH key
- username: required(string)
The user associated with the SSH key
- key: required(string)
Example:
{
"system_authorized_key": {
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF test",
"username": "root"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_authorized_key: required(object)
- id: required(string)
ID of SSH key
- key: required(string)
The SSH key
- key_fingerprint: required(string)
The fingerprint of the SSH key
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this key
- username: required(string)
The user associated with the SSH key
- id: required(string)
Example:
{
"system_authorized_key": {
"id": "users_ssh_authorized_keys-3",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF test",
"key_fingerprint": "2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 test (RSA)",
"username": "root",
"multi_field_identifier": "root 2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 test (RSA)"
}
}
HTTP status code 400
Invalid SSH key.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 317,
"text": "Invalid SSH key",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 403
Duplicate SSH key.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 2,
"code": 314,
"level": 1,
"args": {
"element_name": "ssh.authorized_keys",
"duplicate_value": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF test"
},
"text": "List 'ssh.authorized_keys' contains duplicate entry 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF test'."
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Delete an SSH key.
Get an SSH key by key-id
delete /system/system_authorized_keys/{key-id}
Delete an SSH key.
NetOps Console Server base authentication scheme.
URI Parameters
- key-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
SSH key deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 403
Failed due to not having permission to delete key.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 7,
"code": 47,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}
HTTP status code 404
SSH key does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'users_ssh_authorized_keys-9'",
"args": {
"uuid": "users_ssh_authorized_keys-9"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
get /system/system_authorized_keys/{key-id}
Get an SSH key by key-id
NetOps Console Server base authentication scheme.
URI Parameters
- key-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_authorized_key: required(object)
- id: required(string)
ID of SSH key
- key: required(string)
The SSH key
- key_fingerprint: required(string)
The fingerprint of the SSH key
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this key
- username: required(string)
The user associated with the SSH key
- id: required(string)
Example:
{
"system_authorized_key": {
"id": "users_ssh_authorized_keys-3",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF test",
"key_fingerprint": "2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 test (RSA)",
"username": "root",
"multi_field_identifier": "root 2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 test (RSA)"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
The SSH port used in Direct SSH links.
Retrieve the system SSH port.
Set the system SSH port.
get /system/ssh_port
Retrieve the system SSH port.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_ssh_port: required(object)
- port: required(number - minimum: 1 - maximum: 65535)
Set this option if you have configured SSH to be reachable on a non-standard port. Direct SSH links on the serial ports page will use this port number.
- port: required(number - minimum: 1 - maximum: 65535)
Example:
{
"system_ssh_port": {
"port": 22
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/ssh_port
Set the system SSH port.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_ssh_port: required(object)
- port: required(number - minimum: 1 - maximum: 65535)
Set this option if you have configured SSH to be reachable on a non-standard port. Direct SSH links on the serial ports page will use this port number.
- port: required(number - minimum: 1 - maximum: 65535)
Example:
{
"system_ssh_port": {
"port": 22
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_ssh_port: required(object)
- port: required(number - minimum: 1 - maximum: 65535)
Set this option if you have configured SSH to be reachable on a non-standard port. Direct SSH links on the serial ports page will use this port number.
- port: required(number - minimum: 1 - maximum: 65535)
Example:
{
"system_ssh_port": {
"port": 22
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and update the system's timezone.
Retrieves the system timezone.
Set the system timezone.
get /system/timezone
Retrieves the system timezone.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_timezone: required(object)
- timezone: required(one of Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Inuvik, America/Iqaluit, America/Jamaica, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Velho, America/Puerto_Rico, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Chita, Asia/Choibalsan, Asia/Colombo, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Gaza, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kathmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Thimphu, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faroe, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/Stanley, Atlantic/St_Helena, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/Perth, Australia/Sydney, CET, CST6CDT, EET, EST, EST5EDT, Europe/Amsterdam, Europe/Andorra, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GMT, GMT+0, GMT0, Greenwich, HST, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, MET, MST, MST7MDT, NZ, NZ-CHAT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Wake, Pacific/Wallis, PRC, PST8PDT, ROC, ROK, UCT, UTC, Universal, W-SU, WET, Zulu)
A TZ-compatible string for the timezone.
- timezone: required(one of Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Inuvik, America/Iqaluit, America/Jamaica, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Velho, America/Puerto_Rico, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Chita, Asia/Choibalsan, Asia/Colombo, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Gaza, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kathmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Thimphu, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faroe, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/Stanley, Atlantic/St_Helena, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/Perth, Australia/Sydney, CET, CST6CDT, EET, EST, EST5EDT, Europe/Amsterdam, Europe/Andorra, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GMT, GMT+0, GMT0, Greenwich, HST, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, MET, MST, MST7MDT, NZ, NZ-CHAT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Wake, Pacific/Wallis, PRC, PST8PDT, ROC, ROK, UCT, UTC, Universal, W-SU, WET, Zulu)
Example:
{
"system_timezone": {
"timezone": "Australia/Brisbane"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/timezone
Set the system timezone.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_timezone: required(object)
- timezone: required(one of Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Inuvik, America/Iqaluit, America/Jamaica, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Velho, America/Puerto_Rico, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Chita, Asia/Choibalsan, Asia/Colombo, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Gaza, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kathmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Thimphu, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faroe, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/Stanley, Atlantic/St_Helena, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/Perth, Australia/Sydney, CET, CST6CDT, EET, EST, EST5EDT, Europe/Amsterdam, Europe/Andorra, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GMT, GMT+0, GMT0, Greenwich, HST, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, MET, MST, MST7MDT, NZ, NZ-CHAT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Wake, Pacific/Wallis, PRC, PST8PDT, ROC, ROK, UCT, UTC, Universal, W-SU, WET, Zulu)
A TZ-compatible string for the timezone.
- timezone: required(one of Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Inuvik, America/Iqaluit, America/Jamaica, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Velho, America/Puerto_Rico, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Chita, Asia/Choibalsan, Asia/Colombo, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Gaza, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kathmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Thimphu, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faroe, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/Stanley, Atlantic/St_Helena, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/Perth, Australia/Sydney, CET, CST6CDT, EET, EST, EST5EDT, Europe/Amsterdam, Europe/Andorra, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GMT, GMT+0, GMT0, Greenwich, HST, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, MET, MST, MST7MDT, NZ, NZ-CHAT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Wake, Pacific/Wallis, PRC, PST8PDT, ROC, ROK, UCT, UTC, Universal, W-SU, WET, Zulu)
Example:
{
"system_timezone": {
"timezone": "Australia/Brisbane"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_timezone: required(object)
- timezone: required(one of Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Inuvik, America/Iqaluit, America/Jamaica, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Velho, America/Puerto_Rico, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Chita, Asia/Choibalsan, Asia/Colombo, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Gaza, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kathmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Thimphu, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faroe, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/Stanley, Atlantic/St_Helena, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/Perth, Australia/Sydney, CET, CST6CDT, EET, EST, EST5EDT, Europe/Amsterdam, Europe/Andorra, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GMT, GMT+0, GMT0, Greenwich, HST, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, MET, MST, MST7MDT, NZ, NZ-CHAT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Wake, Pacific/Wallis, PRC, PST8PDT, ROC, ROK, UCT, UTC, Universal, W-SU, WET, Zulu)
A TZ-compatible string for the timezone.
- timezone: required(one of Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Inuvik, America/Iqaluit, America/Jamaica, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Velho, America/Puerto_Rico, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Chita, Asia/Choibalsan, Asia/Colombo, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Gaza, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kathmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Thimphu, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faroe, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/Stanley, Atlantic/St_Helena, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/Perth, Australia/Sydney, CET, CST6CDT, EET, EST, EST5EDT, Europe/Amsterdam, Europe/Andorra, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GMT, GMT+0, GMT0, Greenwich, HST, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, MET, MST, MST7MDT, NZ, NZ-CHAT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Wake, Pacific/Wallis, PRC, PST8PDT, ROC, ROK, UCT, UTC, Universal, W-SU, WET, Zulu)
Example:
{
"system_timezone": {
"timezone": "Australia/Brisbane"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and update the NetOps Console Server's time.
Retrieve the NetOps Console Server current time.
Set the NetOps Console Server current time.
get /system/time
Retrieve the NetOps Console Server current time.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- time: required(object)
- time: required(string - pattern: ^(^([0-2][0-9]:[0-5][0-9] [a-zA-Z]{3} [0-3][0-9][,]? [0-9][0-9][0-9][0-9])$)|(^([0-2][0-9]:[0-5][0-9] [0-3][0-9] [a-zA-Z]{3} [0-9][0-9][0-9][0-9])$)|$)
The time, as a formatted string. When setting the time, this string is parsed by the date utility. The format that is returned is HH:MM mmm DD, YYYY (mmm = "short month") eg. 14:30 Mar 24, 2022 = 2:30pm, 24th March, 2022 The following formats are supported: HH:MM mmm DD, YYYY eg. 14:30 Mar 24, 2022 = 2:30pm, 24th March, 2022 HH:MM DD mmm YYYY eg. 14:30 24 Mar 2022 = 2:30pm, 24th March, 2022 [regexerr: A valid date in HH:MM mmm DD YYYY format, regexerr: A valid date in HH:MM DD mmm YYYY format]
- time: required(string - pattern: ^(^([0-2][0-9]:[0-5][0-9] [a-zA-Z]{3} [0-3][0-9][,]? [0-9][0-9][0-9][0-9])$)|(^([0-2][0-9]:[0-5][0-9] [0-3][0-9] [a-zA-Z]{3} [0-9][0-9][0-9][0-9])$)|$)
Example:
{
"time": {
"time": "16:22 Sep 23, 2016"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/time
Set the NetOps Console Server current time.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- time: required(object)
- time: required(string - pattern: ^(^([0-2][0-9]:[0-5][0-9] [a-zA-Z]{3} [0-3][0-9][,]? [0-9][0-9][0-9][0-9])$)|(^([0-2][0-9]:[0-5][0-9] [0-3][0-9] [a-zA-Z]{3} [0-9][0-9][0-9][0-9])$)|$)
The time, as a formatted string. When setting the time, this string is parsed by the date utility. The format that is returned is HH:MM mmm DD, YYYY (mmm = "short month") eg. 14:30 Mar 24, 2022 = 2:30pm, 24th March, 2022 The following formats are supported: HH:MM mmm DD, YYYY eg. 14:30 Mar 24, 2022 = 2:30pm, 24th March, 2022 HH:MM DD mmm YYYY eg. 14:30 24 Mar 2022 = 2:30pm, 24th March, 2022 [regexerr: A valid date in HH:MM mmm DD YYYY format, regexerr: A valid date in HH:MM DD mmm YYYY format]
- time: required(string - pattern: ^(^([0-2][0-9]:[0-5][0-9] [a-zA-Z]{3} [0-3][0-9][,]? [0-9][0-9][0-9][0-9])$)|(^([0-2][0-9]:[0-5][0-9] [0-3][0-9] [a-zA-Z]{3} [0-9][0-9][0-9][0-9])$)|$)
Example:
{
"time": {
"time": "16:22 Sep 23, 2016"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- time: required(object)
- time: required(string - pattern: ^(^([0-2][0-9]:[0-5][0-9] [a-zA-Z]{3} [0-3][0-9][,]? [0-9][0-9][0-9][0-9])$)|(^([0-2][0-9]:[0-5][0-9] [0-3][0-9] [a-zA-Z]{3} [0-9][0-9][0-9][0-9])$)|$)
The time, as a formatted string. When setting the time, this string is parsed by the date utility. The format that is returned is HH:MM mmm DD, YYYY (mmm = "short month") eg. 14:30 Mar 24, 2022 = 2:30pm, 24th March, 2022 The following formats are supported: HH:MM mmm DD, YYYY eg. 14:30 Mar 24, 2022 = 2:30pm, 24th March, 2022 HH:MM DD mmm YYYY eg. 14:30 24 Mar 2022 = 2:30pm, 24th March, 2022 [regexerr: A valid date in HH:MM mmm DD YYYY format, regexerr: A valid date in HH:MM DD mmm YYYY format]
- time: required(string - pattern: ^(^([0-2][0-9]:[0-5][0-9] [a-zA-Z]{3} [0-3][0-9][,]? [0-9][0-9][0-9][0-9])$)|(^([0-2][0-9]:[0-5][0-9] [0-3][0-9] [a-zA-Z]{3} [0-9][0-9][0-9][0-9])$)|$)
Example:
{
"time": {
"time": "16:22 Sep 23, 2016"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Delete the configuration effectively performing a system reset. The will reset to factory settings and reboot.
delete /system/config
Delete the configuration effectively performing a system reset. The will reset to factory settings and reboot.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The factory reset process was started successfully.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Wait 10 seconds then perform a system reboot.
post /system/reboot
Wait 10 seconds then perform a system reboot.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The factory reboot process was started successfully.
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or change the NetOps Console Server appliance system's information (hostname, contact and location).
Get the NetOps Console Server appliance system information.
Set the NetOps Console Server appliance system information.
get /system/admin_info
Get the NetOps Console Server appliance system information.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_admin_info: required(object)
- hostname: required(string)
The hostname for the system.
- contact: (string)
Administration contact for the system.
- location: (string)
Location for the system.
- hostname: required(string)
Example:
{
"system_admin_info": {
"hostname": "myhost1",
"contact": "admin@example.com",
"location": "USA"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/admin_info
Set the NetOps Console Server appliance system information.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_admin_info: required(object)
- hostname: required(string)
The hostname for the system.
- contact: (string)
Administration contact for the system.
- location: (string)
Location for the system.
- hostname: required(string)
Example:
{
"system_admin_info": {
"hostname": "myhost1",
"contact": "admin@example.com",
"location": "USA"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_admin_info: required(object)
- hostname: required(string)
The hostname for the system.
- contact: (string)
Administration contact for the system.
- location: (string)
Location for the system.
- hostname: required(string)
Example:
{
"system_admin_info": {
"hostname": "myhost1",
"contact": "admin@example.com",
"location": "USA"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Cellular logging provides the ability to capture the RRC connection messages from the cellular module. This entity allows configuration of cellular logging and is only to be used during compliance testing.
Retrieves configuration for cellular logging.
Set the configuration for cellular logging.
get /system/cellular_logging
Retrieves configuration for cellular logging.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_cellular_logging: required(object)
- enabled: required(boolean)
Enable cellular logging on the device. This puts the system in Diagnostic Mode.
- filter: required(string)
The name of a binary filter file to be provided to the Sierra Wireless utility.
- device: required(string)
The path to the cellular modem QCDM device.
- enabled: required(boolean)
Example:
{
"system_cellular_logging": {
"enabled": true,
"filter": "/usr/libexec/sierra/filters/RRC_OTA_0xB0C0.sqf",
"device": "/dev/ttyUSB0"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/cellular_logging
Set the configuration for cellular logging.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_cellular_logging: required(object)
- enabled: required(boolean)
Enable cellular logging on the device. This puts the system in Diagnostic Mode.
- filter: required(string)
The name of a binary filter file to be provided to the Sierra Wireless utility.
- device: required(string)
The path to the cellular modem QCDM device.
- enabled: required(boolean)
Example:
{
"system_cellular_logging": {
"enabled": true,
"filter": "/usr/libexec/sierra/filters/RRC_OTA_0xB0C0.sqf",
"device": "/dev/ttyUSB0"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_cellular_logging: required(object)
- enabled: required(boolean)
Enable cellular logging on the device. This puts the system in Diagnostic Mode.
- filter: required(string)
The name of a binary filter file to be provided to the Sierra Wireless utility.
- device: required(string)
The path to the cellular modem QCDM device.
- enabled: required(boolean)
Example:
{
"system_cellular_logging": {
"enabled": true,
"filter": "/usr/libexec/sierra/filters/RRC_OTA_0xB0C0.sqf",
"device": "/dev/ttyUSB0"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve configuration items related to running the cell reliability test.
Update configuration items related to running the cell reliability test. This allows the user to enable and disable the test, change how frequently it executes, configure the URL to use in the test and configure the alert threshold for signal strength.
get /system/cell_reliability_test
Retrieve configuration items related to running the cell reliability test.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Cell reliability test configuration retrieved successfully.
Body
Media type: application/json
Type: object
Properties- cell_reliability_test: required(object)
- enabled: required(boolean)
Enable or disable the cell reliability test.
- period: required(integer - minimum: 0)
The time between cell reliability test runs.
- test_url: required(array of any)
The URL to perform the cell reliability test against.
- signal_strength_threshold: required(object)
The lower and upper threshold values for acceptable cellular signal strength.
- lower: required(integer - minimum: 0 - maximum: 100)
The lower threshold value for acceptable signal strength.
- upper: required(integer - minimum: 0 - maximum: 100)
The upper threshold value for acceptable signal strength.
- lower: required(integer - minimum: 0 - maximum: 100)
- enabled: required(boolean)
Example:
{
"cell_reliability_test": {
"enabled": true,
"period": 120,
"test_url": [
"https://www.opengear.com/",
"http://[684D:1111:222:3333:4444:5555:6:77]/"
],
"signal_strength_threshold": {
"lower": 25,
"upper": 75
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/cell_reliability_test
Update configuration items related to running the cell reliability test. This allows the user to enable and disable the test, change how frequently it executes, configure the URL to use in the test and configure the alert threshold for signal strength.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- cell_reliability_test: required(object)
- enabled: required(boolean)
Enable or disable the cell reliability test.
- period: required(integer - minimum: 0)
The time between cell reliability test runs.
- test_url: required(array of any)
The URL to perform the cell reliability test against.
- signal_strength_threshold: required(object)
The lower and upper threshold values for acceptable cellular signal strength.
- lower: required(integer - minimum: 0 - maximum: 100)
The lower threshold value for acceptable signal strength.
- upper: required(integer - minimum: 0 - maximum: 100)
The upper threshold value for acceptable signal strength.
- lower: required(integer - minimum: 0 - maximum: 100)
- enabled: required(boolean)
Example:
{
"cell_reliability_test": {
"enabled": true,
"period": 120,
"test_url": [
"https://www.opengear.com/",
"http://[684D:1111:222:3333:4444:5555:6:77]/"
],
"signal_strength_threshold": {
"lower": 25,
"upper": 75
}
}
}
HTTP status code 200
The configuration has been updated.
Body
Media type: application/json
Type: object
Properties- cell_reliability_test: required(object)
- enabled: required(boolean)
Enable or disable the cell reliability test.
- period: required(integer - minimum: 0)
The time between cell reliability test runs.
- test_url: required(array of any)
The URL to perform the cell reliability test against.
- signal_strength_threshold: required(object)
The lower and upper threshold values for acceptable cellular signal strength.
- lower: required(integer - minimum: 0 - maximum: 100)
The lower threshold value for acceptable signal strength.
- upper: required(integer - minimum: 0 - maximum: 100)
The upper threshold value for acceptable signal strength.
- lower: required(integer - minimum: 0 - maximum: 100)
- enabled: required(boolean)
Example:
{
"cell_reliability_test": {
"enabled": true,
"period": 120,
"test_url": [
"https://www.opengear.com/",
"http://[684D:1111:222:3333:4444:5555:6:77]/"
],
"signal_strength_threshold": {
"lower": 25,
"upper": 75
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
This entity is used to upgrade the system firmware of the NetOps Console Server appliance.
Upgrade the system firmware either by uploading a file or providing a url to download the file from. This endpoint will always return success if the firmware upgrade job was started - it occurs in the background and the state of which should be retrieved from the GET /system/firmware_upgrade_status endpoint. At least 'file' or 'firmware_url' are required.
post /system/firmware_upgrade
Upgrade the system firmware either by uploading a file or providing a url to download the file from. This endpoint will always return success if the firmware upgrade job was started - it occurs in the background and the state of which should be retrieved from the GET /system/firmware_upgrade_status endpoint. At least 'file' or 'firmware_url' are required.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: multipart/form-data
Type: object
Properties- file: (file)
The file to be uploaded.
- firmware_url: (string)
A url for the file to download.
- firmware_options: (string)
Options for the firmware upgrade tool. Supported options include: -I (ignore version), -E (erase config), -R (reboot after installation)
HTTP status code 200
The firmware upgrade process was started.
Body
Media type: application/json
Type: object
Properties- system_firmware_upgrade_status: required(object)
- state: (one of pending, running, error, finished)
- error_message: (one of format_error, download_error, version_error, runtime_error)
Example:
{
"system_firmware_upgrade_status": {
"state": "running"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
This entity provides the status of the most recent firmware upgrade job.
Retrieve the status of the most recent firmware upgrade job.
get /system/firmware_upgrade_status
Retrieve the status of the most recent firmware upgrade job.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The factory reset process was started successfully.
Body
Media type: application/json
Type: object
Properties- system_firmware_upgrade_status: required(object)
- state: (one of pending, running, error, finished)
- error_message: (one of format_error, download_error, version_error, runtime_error)
Example:
{
"system_firmware_upgrade_status": {
"state": "error",
"error_message": "download_error"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the NetOps Console Server's most recent firmware and REST API version.
Get the version information.
get /system/version
Get the version information.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_version: required(object)
- rest_api_version: required(string)
The version of the REST API installed on the NetOps Console Server.
- firmware_version: required(string)
The version of the system firmware installed on the NetOps Console Server.
- rest_api_version: required(string)
Example:
{
"system_version": {
"rest_api_version": "v2",
"firmware_version": "18.Q3.0"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the NetOps Console Server appliance's serial number.
Get the serial number information.
get /system/serial_number
Get the serial number information.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_serial_number: required(object)
- serial_number: required(string)
The serial number of the NetOps Console Server.
- serial_number: required(string)
Example:
{
"system_serial_number": {
"serial_number": "409155v03.0001"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the NetOps Console Server appliance's model name.
Get the model name information.
get /system/model_name
Get the model name information.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_model_name: required(object)
- model_name: required(string)
The SKU of the NetOps Console Server.
- model_name: required(string)
Example:
{
"system_model_name": {
"model_name": "OM2248-DAC"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve basic system information
Retrieve basic system information
get /system/info
Retrieve basic system information
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_info: required(object)
- cellfw_info: required(object)
[visible:has_cellular:=:true]
- firmware: required(object)
- model: required(string)
The model name of this cell modem
- boot_version: required(string)
The version of the boot firmware on this cell modem
- amss_version: required(string)
The version of the AMSS (Advanced Mode Subscriber Software) on this cell modem
- sku_id: required(string)
The SKU (Stock Keeping Unit) that uniquely identifies this cell modem
- package_id: required(string)
The id of the update package used for the cell modem firmware
- carrier_id: required(string)
The id of the cellular carrier being used
- config_version: required(string)
The version of the config installed on this cell modem
- model: required(string)
- operating_mode: required(object)
- mode: required(string)
The connection status of this cell modem
- hw_restricted: required(string)
The status of hardware restriction on this cell modem
- mode: required(string)
- firmware: required(object)
- has_cellular: required(boolean)
[visible:never]
- model_name: required(string)
- serial_number: required(string)
- system_versions: required(object)
- rest_api_version: required(string)
The version of the REST API installed on the NetOps Console Server.
- firmware_version: required(string)
The version of the system firmware installed on the NetOps Console Server.
- rest_api_version: required(string)
- cellfw_info: required(object)
Example:
{
"system_info": {
"model_name": "OM2216-L",
"serial_number": "22161912071736",
"cellfw_info": {
"firmware": {
"amss_version": "SWI9X50C_01.07.02.00",
"boot_version": "SWI9X50C_01.07.02.00",
"carrier_id": "4",
"config_version": "002.008_004",
"model": "EM7565",
"package_id": "unknown",
"sku_id": "1104207"
},
"operating_mode": {
"hw_restricted": "no",
"mode": "online"
}
},
"has_cellular": true,
"system_versions": {
"firmware_version": "23.03.0-dev",
"rest_api_version": "v2"
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
This system configuration option allows users to set whether the OpenSSL package uses only FIPS 140-2 compliant cryptographic modules.
Retrieves the system configuration of FIPS 140-2 compliance for the OpenSSL package.
Set whether the OpenSSL packages only uses FIPS 140-2 compliant cryptographic modules.
get /system/fips
Retrieves the system configuration of FIPS 140-2 compliance for the OpenSSL package.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- fips: required(object)
- enabled: required(boolean)
Set whether the OpenSSL package only uses FIPS 140-2 compliant cryptographic modules.
- enabled: required(boolean)
Example:
{
"fips": {
"enabled": false
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/fips
Set whether the OpenSSL packages only uses FIPS 140-2 compliant cryptographic modules.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- fips: required(object)
- enabled: required(boolean)
Set whether the OpenSSL package only uses FIPS 140-2 compliant cryptographic modules.
- enabled: required(boolean)
Example:
{
"fips": {
"enabled": false
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- fips: required(object)
- enabled: required(boolean)
Set whether the OpenSSL package only uses FIPS 140-2 compliant cryptographic modules.
- enabled: required(boolean)
Example:
{
"fips": {
"enabled": false
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/support_report
A report which will provide information about the state of the NetOps Console Server appliance. This information can be used to help analyse and understand the state of the system. The report is large and may take in the order of a minute to obtain.
Retrieve the support report data.
get /support_report
Retrieve the support report data.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
System report was successfully generated and returned including a url to a corresponding zip file.
Body
Media type: application/json
Type: object
Properties- support_report: required(object)
- contents: required(string)
A new line delimited dump of the current state of the system.
- zip_file: required(string)
url to a zip file which contains the system report.
- contents: required(string)
Example:
{
"support_report": {
"contents": "*** System time ***\nMon Aug 22 11:27:29 2016\n\n\n*** Firmware Version ***\n$ sysflash_info\nsysflash info\ncurrent copy name: 'root1'\ncurrent config dev: '/dev/sda6'\ncurrent root dev: '/dev/sda5'\ncurrent boot dev: '/dev/sda2'\nother (upgradable) copy name: 'root2'\nother (upgradable) config dev: '/dev/sda8'\nother (upgradable) root dev: '/dev/sda7'\nother (upgradable) boot dev: '/dev/sda3'\nboard name: 'OM-2000'\nboard rev: '1.0'\ncurrent software vendor: 'opengear'\ncurrent software product: 'operations manager'\ncurrent software version: '1.0.0'\ncurrent software variant: 'dev'\n\n*** Uptime ***\n359140.57 715606.84\n\n*** IP Configuration ***\n$ ifconfig\nnet1 Link encap:Ethernet HWaddr 08:00:27:d7:1c:38 \n ",
"zip_file": "/api/v2/support_report?zip=1"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/auth
Configure remote authentication, authorization, accounting (AAA) servers.
Retrieve information on AAA servers.
Set the AAA config.
get /auth
Retrieve information on AAA servers.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
A JSON object containing the AAA config is returned.
Body
Media type: application/json
Type: object
Properties- auth: required(object)
- mode: required(one of local, radius, tacacs, ldap)
The service to use for authentication of users.
- policy: required(one of remotedownlocal, remotelocal)
The auth policy determines whether to always check local credentials after a remote authentication failure or to only check the local credentials if the remote authentication server is unreachable. [visible:mode:!=:local]
- radiusAuthenticationServers: (array of object)
A list of RADIUS servers to use for authentication. [visible:mode:=:radius,required:mode:=:radius]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- radiusAccountingServers: (array of object)
A list of RADIUS servers to use for accounting. [visible:mode:=:radius,required:mode:=:radius]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- tacacsMethod: (one of pap, chap, login - default: pap)
The login method to use with the TACACS server. [visible:mode:=:tacacs]
- tacacsService: (string - default: raccess)
The service to use with the TACACS server. [visible:mode:=:tacacs]
- tacacsAuthenticationServers: (array of object)
A list of TACACS servers to use. [visible:mode:=:tacacs, required:mode:=:tacacs]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- tacacsAccountingEnabled: (boolean - default: true)
Enable accounting for TACACS+. Accounting logs are sent to the first active TACACS+ Authentication Server. [visible:mode:=:tacacs, required:mode:=:tacacs]
- ldapBaseDN: (string)
The Base DN to use with the LDAP server. [visible:mode:=:ldap, required:mode:=:ldap]
- ldapBindDN: (string)
The Bind DN to use with the LDAP server. [visible:mode:=:ldap]
- ldapIgnoreReferrals: (boolean - default: false)
Should referrals from the LDAP server be ignored? [visible:mode:=:ldap]
- ldapUsernameAttribute: required(string)
The attribute that should be used for the user name. [visible:mode:=:ldap, required:mode:=:ldap]
- ldapGroupMembershipAttribute: (string)
The attribute that should be used for the group name. [visible:mode:=:ldap]
- ldapAuthenticationServers: (array of object)
A list of LDAP servers to use. [visible:mode:=:ldap, required:mode:=:ldap]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- mode: required(one of local, radius, tacacs, ldap)
Example:
{
"auth": {
"mode": "tacacs",
"policy": "remotedownlocal",
"radiusAuthenticationServers": [
{
"hostname": "192.168.250.1.2"
}
],
"radiusAccountingServers": [
{
"hostname": "192.168.250.1.2"
}
],
"tacacsService": "raccess",
"tacacsMethod": "pap",
"tacacsAccountingEnabled": false,
"tacacsAuthenticationServers": [
{
"hostname": "192.168.1.2"
}
],
"ldapAuthenticationServers": [
{
"hostname": "192.168.1.2"
}
],
"ldapBaseDN": "cn=Users,dc=example,dc=com",
"ldapBindDN": "cn=Administrator,cn=Users,dc=example,dc=com",
"ldapUsernameAttribute": "sAMAccountName"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /auth
Set the AAA config.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- auth: required(object)
- mode: required(one of local, radius, tacacs, ldap)
The service to use for authentication of users.
- policy: required(one of remotedownlocal, remotelocal)
The auth policy determines whether to always check local credentials after a remote authentication failure or to only check the local credentials if the remote authentication server is unreachable. [visible:mode:!=:local]
- radiusAuthenticationServers: (array of object)
A list of RADIUS servers to use for authentication. [visible:mode:=:radius,required:mode:=:radius]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- radiusAccountingServers: (array of object)
A list of RADIUS servers to use for accounting. [visible:mode:=:radius,required:mode:=:radius]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- tacacsMethod: (one of pap, chap, login - default: pap)
The login method to use with the TACACS server. [visible:mode:=:tacacs]
- tacacsService: (string - default: raccess)
The service to use with the TACACS server. [visible:mode:=:tacacs]
- tacacsAuthenticationServers: (array of object)
A list of TACACS servers to use. [visible:mode:=:tacacs, required:mode:=:tacacs]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- tacacsAccountingEnabled: (boolean - default: true)
Enable accounting for TACACS+. Accounting logs are sent to the first active TACACS+ Authentication Server. [visible:mode:=:tacacs, required:mode:=:tacacs]
- ldapBaseDN: (string)
The Base DN to use with the LDAP server. [visible:mode:=:ldap, required:mode:=:ldap]
- ldapBindDN: (string)
The Bind DN to use with the LDAP server. [visible:mode:=:ldap]
- ldapIgnoreReferrals: (boolean - default: false)
Should referrals from the LDAP server be ignored? [visible:mode:=:ldap]
- ldapUsernameAttribute: required(string)
The attribute that should be used for the user name. [visible:mode:=:ldap, required:mode:=:ldap]
- ldapGroupMembershipAttribute: (string)
The attribute that should be used for the group name. [visible:mode:=:ldap]
- ldapAuthenticationServers: (array of object)
A list of LDAP servers to use. [visible:mode:=:ldap, required:mode:=:ldap]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- radiusPassword: (string)
The password to use when accessing the RADIUS server. [sensitive, visible:mode:=:radius, required:mode:=:radius]
- tacacsPassword: (string)
The password to use when accessing the TACACS server. [sensitive, visible:mode:=:tacacs, required:mode:=:tacacs]
- ldapBindPassword: (string)
The password to use when accessing the LDAP server. [sensitive, visible:mode:=:ldap]
- mode: required(one of local, radius, tacacs, ldap)
Example:
{
"auth": {
"mode": "radius",
"policy": "remotelocal",
"radiusPassword": "hunter2",
"radiusAuthenticationServers": [
{
"hostname": "192.168.250.2"
}
],
"radiusAccountingServers": [
{
"hostname": "192.168.250.2"
}
],
"tacacsAuthenticationServers": [],
"tacacsPassword": "",
"ldapBaseDN": "",
"ldapUsernameAttribute": "",
"ldapBindPassword": "",
"ldapAuthenticationServers": []
}
}
HTTP status code 200
A JSON object containing the AAA config is returned.
Body
Media type: application/json
Type: object
Properties- auth: required(object)
- mode: required(one of local, radius, tacacs, ldap)
The service to use for authentication of users.
- policy: required(one of remotedownlocal, remotelocal)
The auth policy determines whether to always check local credentials after a remote authentication failure or to only check the local credentials if the remote authentication server is unreachable. [visible:mode:!=:local]
- radiusAuthenticationServers: (array of object)
A list of RADIUS servers to use for authentication. [visible:mode:=:radius,required:mode:=:radius]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- radiusAccountingServers: (array of object)
A list of RADIUS servers to use for accounting. [visible:mode:=:radius,required:mode:=:radius]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- tacacsMethod: (one of pap, chap, login - default: pap)
The login method to use with the TACACS server. [visible:mode:=:tacacs]
- tacacsService: (string - default: raccess)
The service to use with the TACACS server. [visible:mode:=:tacacs]
- tacacsAuthenticationServers: (array of object)
A list of TACACS servers to use. [visible:mode:=:tacacs, required:mode:=:tacacs]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- tacacsAccountingEnabled: (boolean - default: true)
Enable accounting for TACACS+. Accounting logs are sent to the first active TACACS+ Authentication Server. [visible:mode:=:tacacs, required:mode:=:tacacs]
- ldapBaseDN: (string)
The Base DN to use with the LDAP server. [visible:mode:=:ldap, required:mode:=:ldap]
- ldapBindDN: (string)
The Bind DN to use with the LDAP server. [visible:mode:=:ldap]
- ldapIgnoreReferrals: (boolean - default: false)
Should referrals from the LDAP server be ignored? [visible:mode:=:ldap]
- ldapUsernameAttribute: required(string)
The attribute that should be used for the user name. [visible:mode:=:ldap, required:mode:=:ldap]
- ldapGroupMembershipAttribute: (string)
The attribute that should be used for the group name. [visible:mode:=:ldap]
- ldapAuthenticationServers: (array of object)
A list of LDAP servers to use. [visible:mode:=:ldap, required:mode:=:ldap]
Items: items
- hostname: required(string)
An IP address for the server. Supports IPv4, IPv6 or a name that can be resolved using DNS.
- port: (integer)
Set this to use a non-standard port when connecting to the server.
- hostname: required(string)
- mode: required(one of local, radius, tacacs, ldap)
Example:
{
"auth": {
"tacacsAuthenticationServers": [],
"ldapBaseDN": "",
"ldapUsernameAttribute": "",
"ldapIgnoreReferrals": false,
"ldapAuthenticationServers": [],
"mode": "radius",
"policy": "remotelocal",
"radiusAuthenticationServers": [
{
"port": 1812,
"hostname": "192.168.250.2"
}
],
"radiusAccountingServers": [
{
"port": 1813,
"hostname": "192.168.250.2"
}
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/local_password_policy
Configure the password policy for local users. This includes expiry and complexity settings.
Retrieve the local password policy.
Set the local password policy.
get /local_password_policy
Retrieve the local password policy.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
A JSON object containing the local password policy is returned.
Body
Media type: application/json
Type: object
Properties- local_password_policy: required(object)
- password_expiry_interval_enabled: required(boolean)
Setting this to true causes passwords to expire after an interval.
- password_expiry_interval_days: required(integer)
The number of days after which a password should expire. This only applies if password expiry is enabled. [visible:password_expiry_interval_enabled:=:true]
- password_complexity_enabled: required(boolean)
Setting this to true causes password complexity to be enforced. This requires that a password is not exactly the same as the previous password. All local users, including root, are subject to the complexity requirements.
- password_minimum_length: required(integer)
Specify the minimum required length for passwords. Cannot be set to less than 6. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_must_contain_upper_case: required(boolean)
Set this to true to require that at least one uppercase character (A-Z) is included in passwords. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_must_contain_special: required(boolean)
Set this to true to require that at least one special character (anything other than A-Z or 0-9) is included in passwords. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_must_contain_number: required(boolean)
Set this to true to require that at least one numeric character (0-9) is included in passwords. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_disallow_username: required(boolean)
Set this to true to check whether the password (with possible modifications) contains the user name in some form. It is not performed for user names shorter than 3 characters. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_expiry_interval_enabled: required(boolean)
Example:
{
"local_password_policy": {
"password_expiry_interval_enabled": true,
"password_expiry_interval_days": 1,
"password_complexity_enabled": true,
"password_minimum_length": 10,
"password_must_contain_upper_case": true,
"password_must_contain_special": false,
"password_must_contain_number": true,
"password_disallow_username": false
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /local_password_policy
Set the local password policy.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- local_password_policy: required(object)
- password_expiry_interval_enabled: required(boolean)
Setting this to true causes passwords to expire after an interval.
- password_expiry_interval_days: required(integer)
The number of days after which a password should expire. This only applies if password expiry is enabled. [visible:password_expiry_interval_enabled:=:true]
- password_complexity_enabled: required(boolean)
Setting this to true causes password complexity to be enforced. This requires that a password is not exactly the same as the previous password. All local users, including root, are subject to the complexity requirements.
- password_minimum_length: required(integer)
Specify the minimum required length for passwords. Cannot be set to less than 6. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_must_contain_upper_case: required(boolean)
Set this to true to require that at least one uppercase character (A-Z) is included in passwords. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_must_contain_special: required(boolean)
Set this to true to require that at least one special character (anything other than A-Z or 0-9) is included in passwords. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_must_contain_number: required(boolean)
Set this to true to require that at least one numeric character (0-9) is included in passwords. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_disallow_username: required(boolean)
Set this to true to check whether the password (with possible modifications) contains the user name in some form. It is not performed for user names shorter than 3 characters. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_expiry_interval_enabled: required(boolean)
Example:
{
"local_password_policy": {
"password_expiry_interval_enabled": false,
"password_expiry_interval_days": 10,
"password_complexity_enabled": false,
"password_minimum_length": 10,
"password_must_contain_upper_case": false,
"password_must_contain_special": true,
"password_must_contain_number": true,
"password_disallow_username": true
}
}
HTTP status code 200
A JSON object containing the local password policy is returned.
Body
Media type: application/json
Type: object
Properties- local_password_policy: required(object)
- password_expiry_interval_enabled: required(boolean)
Setting this to true causes passwords to expire after an interval.
- password_expiry_interval_days: required(integer)
The number of days after which a password should expire. This only applies if password expiry is enabled. [visible:password_expiry_interval_enabled:=:true]
- password_complexity_enabled: required(boolean)
Setting this to true causes password complexity to be enforced. This requires that a password is not exactly the same as the previous password. All local users, including root, are subject to the complexity requirements.
- password_minimum_length: required(integer)
Specify the minimum required length for passwords. Cannot be set to less than 6. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_must_contain_upper_case: required(boolean)
Set this to true to require that at least one uppercase character (A-Z) is included in passwords. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_must_contain_special: required(boolean)
Set this to true to require that at least one special character (anything other than A-Z or 0-9) is included in passwords. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_must_contain_number: required(boolean)
Set this to true to require that at least one numeric character (0-9) is included in passwords. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_disallow_username: required(boolean)
Set this to true to check whether the password (with possible modifications) contains the user name in some form. It is not performed for user names shorter than 3 characters. This only applies if password complexity is enabled. [visible:password_complexity_enabled:=:true]
- password_expiry_interval_enabled: required(boolean)
Example:
{
"local_password_policy": {
"password_expiry_interval_enabled": false,
"password_expiry_interval_days": 10,
"password_complexity_enabled": true,
"password_minimum_length": 6,
"password_must_contain_upper_case": true,
"password_must_contain_special": true,
"password_must_contain_number": false,
"password_disallow_username": true
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/users
Retrieve and update user information.
Retrieve a list of users.
Replace current user list with a new one. Used by Lighthouse Template push
Create a new User data in the config.
get /users
Retrieve a list of users.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
A JSON object containing Users Config is returned.
Body
Media type: application/json
Type: object
Properties- users: required(array of object)
Items: items
- description: (string)
A descriptive string for the user.
- enabled: (boolean - default: true)
Only enabled users are able to login.
- hashed_password: (string)
A hashed password, compatible with the crypt GNU C Library function, to set for the user. [visible:never]
- no_password: (boolean - default: false)
Set this to false for local users. One of password or hashed_password is required. Set this to true for remote-only (AAA) users. Both password and hashed_password must be unset. [visible:password:=:]
- ssh_password_enabled: (boolean - default: true)
Allow ssh login using a password. If this is false and an authorized key has been set, the user can still login to ssh.
- groups: (array of string)
A list of groups for which this user is a member.
- username: required(string)
The POSIX name for the user.
- id: required(string)
A unique identifier for this user.
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groupNames: required(array of string)
A duplicate list of group names for the user.
- description: (string)
- meta: required(object)
- total_pages: (string)
Example:
{
"users": [
{
"username": "root",
"description": "System wide SuperUser account",
"enabled": true,
"id": "users-1",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp"
],
"groupNames": [
"g1"
]
},
{
"username": "tu0",
"description": "",
"enabled": true,
"id": "users-2",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp"
],
"groupNames": [
"g1"
]
}
],
"meta": {
"total_pages": "1"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /users
Replace current user list with a new one. Used by Lighthouse Template push
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- users: required(array of object)
The users to add
Items: items
- description: (string)
A descriptive string for the user.
- enabled: (boolean - default: true)
Only enabled users are able to login.
- hashed_password: (string)
A hashed password, compatible with the crypt GNU C Library function, to set for the user. [visible:never]
- no_password: (boolean - default: false)
Set this to false for local users. One of password or hashed_password is required. Set this to true for remote-only (AAA) users. Both password and hashed_password must be unset. [visible:password:=:]
- ssh_password_enabled: (boolean - default: true)
Allow ssh login using a password. If this is false and an authorized key has been set, the user can still login to ssh.
- groups: (array of string)
A list of groups for which this user is a member.
- username: required(string)
The POSIX name for the user.
- password: (string - pattern: ^(?!default$).*)
The plaintext password to set for the user. For increased security, it is strongly recommended to enable Password Complexity. [sensitive,required:always,visible:no_password:!=:true,regexerr:'default' is not a valid password option.]
- description: (string)
Example:
{
"users": [
{
"username": "user1",
"description": "An admin user",
"password": "OGTest1",
"groups": [
"g1",
"g2",
"g3"
]
},
{
"username": "user2",
"description": "Another user",
"password": "OGTest1",
"groups": [
"g1"
]
}
]
}
HTTP status code 200
A JSON object containing Users Config is returned.
Body
Media type: application/json
Type: object
Properties- users: required(array of object)
Items: items
- description: (string)
A descriptive string for the user.
- enabled: (boolean - default: true)
Only enabled users are able to login.
- hashed_password: (string)
A hashed password, compatible with the crypt GNU C Library function, to set for the user. [visible:never]
- no_password: (boolean - default: false)
Set this to false for local users. One of password or hashed_password is required. Set this to true for remote-only (AAA) users. Both password and hashed_password must be unset. [visible:password:=:]
- ssh_password_enabled: (boolean - default: true)
Allow ssh login using a password. If this is false and an authorized key has been set, the user can still login to ssh.
- groups: (array of string)
A list of groups for which this user is a member.
- username: required(string)
The POSIX name for the user.
- id: required(string)
A unique identifier for this user.
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groupNames: required(array of string)
A duplicate list of group names for the user.
- description: (string)
- meta: required(object)
- total_pages: (string)
Example:
{
"users": [
{
"username": "root",
"enabled": true,
"id": "users-1",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp",
"admin"
],
"groupNames": [
"g1",
"g2"
]
},
{
"username": "user1",
"enabled": true,
"description": "An admin user",
"id": "users-2",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$697qmlbgz79fbNhl$Px.GuCYD1pEdUZUZR9aBKC14OlhQfYldn79tVluNCtD",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp",
"admin",
"my_group"
],
"groupNames": [
"g1",
"g2",
"g3"
]
},
{
"username": "user2",
"enabled": true,
"description": "Another user",
"id": "users-3",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$697qmlbgz79fbNhl$Px.GuCYD1pEdUZUZR9aBKC14OlhQfYldn79tVluNCtD",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp"
],
"groupNames": [
"g1"
]
}
],
"meta": {
"total_pages": "1"
}
}
HTTP status code 400
Failed to initiate user creation due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(string)
Example:
{
"error": "Failed to parse request data"
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /users
Create a new User data in the config.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- user: required(object)
- description: (string)
A descriptive string for the user.
- enabled: (boolean - default: true)
Only enabled users are able to login.
- hashed_password: (string)
A hashed password, compatible with the crypt GNU C Library function, to set for the user. [visible:never]
- no_password: (boolean - default: false)
Set this to false for local users. One of password or hashed_password is required. Set this to true for remote-only (AAA) users. Both password and hashed_password must be unset. [visible:password:=:]
- ssh_password_enabled: (boolean - default: true)
Allow ssh login using a password. If this is false and an authorized key has been set, the user can still login to ssh.
- groups: (array of string)
A list of groups for which this user is a member.
- username: required(string)
The POSIX name for the user.
- password: (string - pattern: ^(?!default$).*)
The plaintext password to set for the user. For increased security, it is strongly recommended to enable Password Complexity. [sensitive,required:always,visible:no_password:!=:true,regexerr:'default' is not a valid password option.]
- description: (string)
Example:
{
"user": {
"username": "tu1",
"description": "testupdated",
"enabled": true,
"no_password": true,
"groups": [
"admin"
]
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- user: required(object)
- description: (string)
A descriptive string for the user.
- enabled: (boolean - default: true)
Only enabled users are able to login.
- hashed_password: (string)
A hashed password, compatible with the crypt GNU C Library function, to set for the user. [visible:never]
- no_password: (boolean - default: false)
Set this to false for local users. One of password or hashed_password is required. Set this to true for remote-only (AAA) users. Both password and hashed_password must be unset. [visible:password:=:]
- ssh_password_enabled: (boolean - default: true)
Allow ssh login using a password. If this is false and an authorized key has been set, the user can still login to ssh.
- groups: (array of string)
A list of groups for which this user is a member.
- username: required(string)
The POSIX name for the user.
- id: required(string)
A unique identifier for this user.
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groupNames: required(array of string)
A duplicate list of group names for the user.
- description: (string)
Example:
{
"user": {
"username": "tu1",
"description": "testupdated",
"enabled": true,
"id": "users-5",
"no_password": true,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"admin"
],
"groupNames": [
"g2"
]
}
}
HTTP status code 400
Failed to initiate user creation due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 12,
"text": "Element is below the minimum allowed length of 1 character(s)",
"args": {
"min": "1",
"uuid": "{60e2b0a-aafa-11e6-aca7-cb7fd0646002"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and update information for a specific user.
Retrieve the User information by ID.
Set a user's properties in the config.
Delete a User
get /users/{user-id}
Retrieve the User information by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- user-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
User exists
Body
Media type: application/json
Type: object
Properties- user: required(object)
- description: (string)
A descriptive string for the user.
- enabled: (boolean - default: true)
Only enabled users are able to login.
- hashed_password: (string)
A hashed password, compatible with the crypt GNU C Library function, to set for the user. [visible:never]
- no_password: (boolean - default: false)
Set this to false for local users. One of password or hashed_password is required. Set this to true for remote-only (AAA) users. Both password and hashed_password must be unset. [visible:password:=:]
- ssh_password_enabled: (boolean - default: true)
Allow ssh login using a password. If this is false and an authorized key has been set, the user can still login to ssh.
- groups: (array of string)
A list of groups for which this user is a member.
- username: required(string)
The POSIX name for the user.
- id: required(string)
A unique identifier for this user.
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groupNames: required(array of string)
A duplicate list of group names for the user.
- description: (string)
Example:
{
"user": {
"username": "tu0",
"description": "",
"enabled": true,
"id": "users-2",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp"
],
"groupNames": [
"g1"
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}
HTTP status code 404
User does not exist. User Not Found.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find user with username or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /users/{user-id}
Set a user's properties in the config.
NetOps Console Server base authentication scheme.
URI Parameters
- user-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- user: required(object)
- description: (string)
A descriptive string for the user.
- enabled: (boolean - default: true)
Only enabled users are able to login.
- hashed_password: (string)
A hashed password, compatible with the crypt GNU C Library function, to set for the user. [visible:never]
- no_password: (boolean - default: false)
Set this to false for local users. One of password or hashed_password is required. Set this to true for remote-only (AAA) users. Both password and hashed_password must be unset. [visible:password:=:]
- ssh_password_enabled: (boolean - default: true)
Allow ssh login using a password. If this is false and an authorized key has been set, the user can still login to ssh.
- groups: (array of string)
A list of groups for which this user is a member.
- password: (string - pattern: ^(?!default$).*)
The plaintext password to set for the user. For increased security, it is strongly recommended to enable Password Complexity. [sensitive,visible:no_password:!=:true,required:no_password:=:true:stored,regexerr:'default' is not a valid password option.]
- description: (string)
Example:
{
"user": {
"description": "testupdated",
"enabled": true,
"no_password": true,
"ssh_password_enabled": true,
"groups": [
"admin"
]
}
}
HTTP status code 200
User has been Updated.
Body
Media type: application/json
Type: object
Properties- user: required(object)
- description: (string)
A descriptive string for the user.
- enabled: (boolean - default: true)
Only enabled users are able to login.
- hashed_password: (string)
A hashed password, compatible with the crypt GNU C Library function, to set for the user. [visible:never]
- no_password: (boolean - default: false)
Set this to false for local users. One of password or hashed_password is required. Set this to true for remote-only (AAA) users. Both password and hashed_password must be unset. [visible:password:=:]
- ssh_password_enabled: (boolean - default: true)
Allow ssh login using a password. If this is false and an authorized key has been set, the user can still login to ssh.
- groups: (array of string)
A list of groups for which this user is a member.
- username: required(string)
The POSIX name for the user.
- id: required(string)
A unique identifier for this user.
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groupNames: required(array of string)
A duplicate list of group names for the user.
- description: (string)
Example:
{
"user": {
"username": "tu1",
"description": "testupdated",
"enabled": true,
"no_password": true,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"id": "users-5",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"admin"
],
"groupNames": [
"g2"
]
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /users/{user-id}
Delete a User
NetOps Console Server base authentication scheme.
URI Parameters
- user-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
User deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
User did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find user with username or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Configure the SSH authorized keys for a specific user.
Retrieve ssh authorized keys for a user
Add an SSH key for a user
get /users/{user-id}/ssh/authorized_keys
Retrieve ssh authorized keys for a user
NetOps Console Server base authentication scheme.
URI Parameters
- user-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- authorized_keys: required(array of object)
Items: items
- id: required(string)
ID of SSH key
- key: required(string)
The SSH key
- key_fingerprint: required(string)
The fingerprint of the SSH key
- id: required(string)
Examples:
example1:
User with 2 keys
{
"authorized_keys": [
{
"id": "users_ssh_authorized_keys-1",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF /home/lincolnr/.ssh/id_rsa\n",
"key_fingerprint": "2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 /home/lincolnr/.ssh/id_rsa\n (RSA)"
},
{
"id": "users_ssh_authorized_keys-2",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDcsp/AQJKLsinT822ZXAnyXpSykeRXPlOvvOH3zi7QkYLz4+VBbTqJO/R2AJp8Cd0MrGMwuzzbwM25bAb7mesni+RRUAcNPqDD8/z8PKKKRzU1aKRqi/Za3FDRxPAOPJ/Wy1F1lGG6BSKe3gH9QHkPpy5ZPkDcs0S9+qoUYwNCAaB2tcK1jp/L6RXuJ3yLhRBIMpYicRwYcXDOX7QFt4BhnKMrR1ufcU08CGRLYLxnsd2RuiPn2jAz8OHJN7GUvrQ6VK+k47vEj0YLBuP27ZbFKwAJd3dhdezlhjlDDGrVrrXZgwxR+LeOuTnkqUVHOXkYVuiWQZqGS/hC76wJEt2xHinW5+4GuN69qBeY//jCYT+DHe9qJ0MEB5xNjVoWXxb9C7Pc1+/3y+p84X2Oa2nYJm3Vsn8u/S2Mbu1epf16i2qnLEInXkbBF/3T06NZAR+8in51MYE+kQkWq7dlkX20b5l28Ugu8VYYrcxxg0AREfqaL5FbyPS1OHaEb5zvabN23JTPpG8LBnXSjNu8AIpbfM8PaXT+7c5nSSQ+y0G1kZsP9MberstvExJOOYl8eviShb41RuApZL3ik/gY1pZKhBNQbx7eD84q1f2cXtyAw554WWrnM4BlFZB86/M7rrX+GkHRbgv57dc/j5pID08MZ5w/52Tj9KpApYKcQkNFSQ== root@root-1",
"key_fingerprint": "4096 SHA256:a3MIQdLMB/kOUYcHSnlqHagOfHdlv4A/RCaTUr8o6MY root@root-1 (RSA)"
}
]
}
example2:
User with no keys
{
"authorized_keys": []
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /users/{user-id}/ssh/authorized_keys
Add an SSH key for a user
NetOps Console Server base authentication scheme.
URI Parameters
- user-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- authorized_key: required(object)
- key: required(string)
The SSH key to authenticate as this user.
- key: required(string)
Example:
{
"authorized_key": {
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF test"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- authorized_key: required(object)
- id: required(string)
ID of SSH key
- key: required(string)
The SSH key
- key_fingerprint: required(string)
The fingerprint of the SSH key
- id: required(string)
Example:
{
"authorized_key": {
"id": "users_ssh_authorized_keys-3",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF test",
"key_fingerprint": "2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 test (RSA)"
}
}
HTTP status code 400
Invalid SSH key.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 317,
"text": "Invalid SSH key",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve ssh authorized keys for a user
Delete an SSH key for a user.
get /users/{user-id}/ssh/authorized_keys/{key-id}
Retrieve ssh authorized keys for a user
NetOps Console Server base authentication scheme.
URI Parameters
- user-id: required(string)
- key-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- authorized_key: required(object)
- id: required(string)
ID of SSH key
- key: required(string)
The SSH key
- key_fingerprint: required(string)
The fingerprint of the SSH key
- id: required(string)
Example:
example1:
User key
{
"authorized_key": {
"id": "users_ssh_authorized_keys-2",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDcsp/AQJKLsinT822ZXAnyXpSykeRXPlOvvOH3zi7QkYLz4+VBbTqJO/R2AJp8Cd0MrGMwuzzbwM25bAb7mesni+RRUAcNPqDD8/z8PKKKRzU1aKRqi/Za3FDRxPAOPJ/Wy1F1lGG6BSKe3gH9QHkPpy5ZPkDcs0S9+qoUYwNCAaB2tcK1jp/L6RXuJ3yLhRBIMpYicRwYcXDOX7QFt4BhnKMrR1ufcU08CGRLYLxnsd2RuiPn2jAz8OHJN7GUvrQ6VK+k47vEj0YLBuP27ZbFKwAJd3dhdezlhjlDDGrVrrXZgwxR+LeOuTnkqUVHOXkYVuiWQZqGS/hC76wJEt2xHinW5+4GuN69qBeY//jCYT+DHe9qJ0MEB5xNjVoWXxb9C7Pc1+/3y+p84X2Oa2nYJm3Vsn8u/S2Mbu1epf16i2qnLEInXkbBF/3T06NZAR+8in51MYE+kQkWq7dlkX20b5l28Ugu8VYYrcxxg0AREfqaL5FbyPS1OHaEb5zvabN23JTPpG8LBnXSjNu8AIpbfM8PaXT+7c5nSSQ+y0G1kZsP9MberstvExJOOYl8eviShb41RuApZL3ik/gY1pZKhBNQbx7eD84q1f2cXtyAw554WWrnM4BlFZB86/M7rrX+GkHRbgv57dc/j5pID08MZ5w/52Tj9KpApYKcQkNFSQ== root@root-1",
"key_fingerprint": "4096 SHA256:a3MIQdLMB/kOUYcHSnlqHagOfHdlv4A/RCaTUr8o6MY root@root-1 (RSA)"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /users/{user-id}/ssh/authorized_keys/{key-id}
Delete an SSH key for a user.
NetOps Console Server base authentication scheme.
URI Parameters
- user-id: required(string)
- key-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
SSH key deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 403
Failed due to not having permission to delete key.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 7,
"code": 47,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}
HTTP status code 404
SSH key does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ssh/authorized_key with key or id 'users_ssh_authorized_keys-9'",
"args": {
"uuid": "users_ssh_authorized_keys-9"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/groups
Retrieve or update group information.
Retrieve a list of groups.
Replace current groups list with a new one. Used by Lighthouse Template push
Create a new Group in the config.
get /groups
Retrieve a list of groups.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
A JSON object containing Groups config is returned.
Body
Media type: application/json
Type: object
Properties- groups: required(array of object)
Items: items
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
The POSIX name for the group (maximum of 60 characters). [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-" except for first character, regexerr:"." except for first character]
- enabled: (boolean - default: true)
If the group is currently enabled. If a group is disabled, any permissions attached to it will not be bestowed upon users in that group.
- mode: (one of global, scoped)
Set to global to allow access to all ports. Set to scoped to limit access to specific ports. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- role: (one of Administrator, ConsoleUser)
Set to Administrator to allow access to the entire web UI. Set to ConsoleUser to limit access to serial port pages only. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- access_rights: (array of string)
A list of resources or features that members of this group have been granted access to.
- description: (string - maxLength: 128)
A description of the group's purpose.
- members: (array of string)
A list of users assigned to this group. The users can be referenced by either usernames or user ids.
- ports: (array of string)
The ports that users in this group can access.
- id: required(string)
A unique identifier for this group
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
- meta: required(object)
- total_pages: (string)
Example:
{
"groups": [
{
"id": "groups-1",
"enabled": true,
"groupname": "usergrp",
"mode": "scoped",
"role": "ConsoleUser",
"access_rights": [
"web_ui",
"pmshell"
],
"description": "The ConsoleUser group",
"members": [
"root",
"tu0"
],
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
],
"rights": {
"delete": true,
"modify": false
}
},
{
"id": "groups-2",
"enabled": true,
"groupname": "admin",
"mode": "global",
"role": "Administrator",
"access_rights": [
"admin"
],
"description": "Administrator",
"members": [
"root",
"tu0"
],
"rights": {
"delete": true,
"modify": true
}
}
],
"meta": {
"total_pages": "1"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /groups
Replace current groups list with a new one. Used by Lighthouse Template push
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- groups: required(array of object)
The groups to add
Items: items
- name: required(string)
The POSIX name for the group (maximum of 60 characters).
- description: required(string)
A description of the group's purpose.
- roles: required(array of string)
Set to ["admin"] to allow access to the entire web UI. Set to ["all_ports_user", "pmshell_user"] to limit access to serial port pages only. Set to ["basic_webui_user", "pmshell_user"] to limit access to serial port pages only.
- ports: (array of string)
The boolean at each index indicates if the port for that index is accessible. The ports field is required if roles[0] is set to 'basic_webui_user'. [reference:port:name]
- name: required(string)
Example:
{
"groups": [
{
"name": "group1",
"description": "an admin group",
"roles": [
"admin"
],
"ports": []
},
{
"name": "group2",
"description": "an unrestricted consoleUser",
"roles": [
"all_ports_user",
"pmshell_user"
],
"ports": []
},
{
"name": "group3",
"description": "a restricted consoleUser",
"roles": [
"basic_webui_user",
"pmshell_user"
],
"ports": [
"port01",
"port03",
"port04"
]
}
]
}
HTTP status code 200
A JSON object containing Groups Config is returned.
Body
Media type: application/json
Type: object
Properties- groups: required(array of object)
Items: items
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
The POSIX name for the group (maximum of 60 characters). [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-" except for first character, regexerr:"." except for first character]
- enabled: (boolean - default: true)
If the group is currently enabled. If a group is disabled, any permissions attached to it will not be bestowed upon users in that group.
- mode: (one of global, scoped)
Set to global to allow access to all ports. Set to scoped to limit access to specific ports. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- role: (one of Administrator, ConsoleUser)
Set to Administrator to allow access to the entire web UI. Set to ConsoleUser to limit access to serial port pages only. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- access_rights: (array of string)
A list of resources or features that members of this group have been granted access to.
- description: (string - maxLength: 128)
A description of the group's purpose.
- members: (array of string)
A list of users assigned to this group. The users can be referenced by either usernames or user ids.
- ports: (array of string)
The ports that users in this group can access.
- id: required(string)
A unique identifier for this group
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
- meta: required(object)
- total_pages: (string)
Example:
{
"groups": [
{
"enabled": true,
"id": "groups-1",
"groupname": "usergrp",
"description": "The consoleUser group",
"mode": "scoped",
"role": "ConsoleUser",
"access_rights": [
"web_ui",
"pmshell"
],
"members": [
"root",
"tu0"
],
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
],
"rights": {
"delete": true,
"modify": true
}
},
{
"enabled": true,
"id": "groups-2",
"groupname": "admin",
"description": "Administrator",
"mode": "global",
"role": "Administrator",
"access_rights": [
"admin"
],
"members": [
"root",
"tu0"
],
"rights": {
"delete": true,
"modify": true
}
}
],
"meta": {
"total_pages": "1"
}
}
HTTP status code 400
Failed to initiate user creation due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(string)
Example:
{
"error": "Failed to parse request data"
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /groups
Create a new Group in the config.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- group: required(object)
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
The POSIX name for the group (maximum of 60 characters). [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-" except for first character, regexerr:"." except for first character]
- enabled: (boolean - default: true)
If the group is currently enabled. If a group is disabled, any permissions attached to it will not be bestowed upon users in that group.
- mode: (one of global, scoped)
Set to global to allow access to all ports. Set to scoped to limit access to specific ports. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- role: (one of Administrator, ConsoleUser)
Set to Administrator to allow access to the entire web UI. Set to ConsoleUser to limit access to serial port pages only. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- access_rights: (array of string)
A list of resources or features that members of this group have been granted access to.
- description: (string - maxLength: 128)
A description of the group's purpose.
- members: (array of string)
A list of users assigned to this group. The users can be referenced by either usernames or user ids.
- ports: (array of string)
The ports that users in this group can access.
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
Examples:
group_for_admin:
{
"group": {
"groupname": "local_admin",
"enabled": true,
"access_rights": [
"admin"
]
}
}
group_for_users:
{
"group": {
"groupname": "my_group",
"enabled": true,
"access_rights": [
"web_ui",
"pmshell"
],
"members": [
"tu0",
"tu1"
],
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
]
}
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- group: required(object)
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
The POSIX name for the group (maximum of 60 characters). [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-" except for first character, regexerr:"." except for first character]
- enabled: (boolean - default: true)
If the group is currently enabled. If a group is disabled, any permissions attached to it will not be bestowed upon users in that group.
- mode: (one of global, scoped)
Set to global to allow access to all ports. Set to scoped to limit access to specific ports. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- role: (one of Administrator, ConsoleUser)
Set to Administrator to allow access to the entire web UI. Set to ConsoleUser to limit access to serial port pages only. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- access_rights: (array of string)
A list of resources or features that members of this group have been granted access to.
- description: (string - maxLength: 128)
A description of the group's purpose.
- members: (array of string)
A list of users assigned to this group. The users can be referenced by either usernames or user ids.
- ports: (array of string)
The ports that users in this group can access.
- id: required(string)
A unique identifier for this group
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
Examples:
admin_group:
{
"group": {
"id": "groups-1",
"enabled": true,
"groupname": "local-admin",
"mode": "global",
"role": "Administrator",
"access_rights": [
"admin"
],
"members": [],
"ports": [],
"rights": {
"delete": true,
"modify": true
}
}
}
ConsoleUser_group:
{
"group": {
"id": "groups-3",
"enabled": true,
"groupname": "my_group",
"mode": "scoped",
"role": "ConsoleUser",
"access_rights": [
"web_ui",
"pmshell"
],
"description": "Group for ConsoleUser",
"members": [
"tu0",
"tu1"
],
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
],
"rights": {
"delete": true,
"modify": false
}
}
}
HTTP status code 400
Failed to initiate group creation due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 26,
"level": 1,
"text": "Duplicate 'groupname' fields with value 'netgrp'",
"args": {
"value": "netgrp",
"uuid": "root-1-@groups",
"field": "groupname"
}
},
{
"type": 1,
"code": 33,
"level": 1,
"text": "Push command failed",
"args": {}
}
]
}
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update information for a specific group.
Retrieve the Group information by ID.
Update a Group data in the config.
Delete a Group
get /groups/{id}
Retrieve the Group information by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Group exists
Body
Media type: application/json
Type: object
Properties- group: required(object)
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
The POSIX name for the group (maximum of 60 characters). [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-" except for first character, regexerr:"." except for first character]
- enabled: (boolean - default: true)
If the group is currently enabled. If a group is disabled, any permissions attached to it will not be bestowed upon users in that group.
- mode: (one of global, scoped)
Set to global to allow access to all ports. Set to scoped to limit access to specific ports. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- role: (one of Administrator, ConsoleUser)
Set to Administrator to allow access to the entire web UI. Set to ConsoleUser to limit access to serial port pages only. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- access_rights: (array of string)
A list of resources or features that members of this group have been granted access to.
- description: (string - maxLength: 128)
A description of the group's purpose.
- members: (array of string)
A list of users assigned to this group. The users can be referenced by either usernames or user ids.
- ports: (array of string)
The ports that users in this group can access.
- id: required(string)
A unique identifier for this group
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
Example:
{
"group": {
"id": "groups-6",
"enabled": true,
"groupname": "netgrp2",
"mode": "scoped",
"role": "ConsoleUser",
"access_rights": [
"web_ui",
"pmshell"
],
"members": [
"root",
"tu0"
],
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
],
"rights": {
"delete": true,
"modify": false
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}
HTTP status code 404
Group does not exist. Group Not Found.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find group with groupname or id 'group59'",
"args": {
"uuid": "group59"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /groups/{id}
Update a Group data in the config.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- group: required(object)
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
The POSIX name for the group (maximum of 60 characters). [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-" except for first character, regexerr:"." except for first character]
- enabled: (boolean - default: true)
If the group is currently enabled. If a group is disabled, any permissions attached to it will not be bestowed upon users in that group.
- mode: (one of global, scoped)
Set to global to allow access to all ports. Set to scoped to limit access to specific ports. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- role: (one of Administrator, ConsoleUser)
Set to Administrator to allow access to the entire web UI. Set to ConsoleUser to limit access to serial port pages only. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- access_rights: (array of string)
A list of resources or features that members of this group have been granted access to.
- description: (string - maxLength: 128)
A description of the group's purpose.
- members: (array of string)
A list of users assigned to this group. The users can be referenced by either usernames or user ids.
- ports: (array of string)
The ports that users in this group can access.
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
Example:
{
"group": {
"enabled": true,
"groupname": "netgrp2",
"access_rights": [
"web_ui",
"pmshell"
],
"description": "Group for ConsoleUser role",
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
]
}
}
HTTP status code 200
Group has been updated.
Body
Media type: application/json
Type: object
Properties- group: required(object)
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
The POSIX name for the group (maximum of 60 characters). [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-" except for first character, regexerr:"." except for first character]
- enabled: (boolean - default: true)
If the group is currently enabled. If a group is disabled, any permissions attached to it will not be bestowed upon users in that group.
- mode: (one of global, scoped)
Set to global to allow access to all ports. Set to scoped to limit access to specific ports. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- role: (one of Administrator, ConsoleUser)
Set to Administrator to allow access to the entire web UI. Set to ConsoleUser to limit access to serial port pages only. [visible:never]
Annotations
- deprecatedProperty
{"since":"08/2022"}
- deprecatedProperty
- access_rights: (array of string)
A list of resources or features that members of this group have been granted access to.
- description: (string - maxLength: 128)
A description of the group's purpose.
- members: (array of string)
A list of users assigned to this group. The users can be referenced by either usernames or user ids.
- ports: (array of string)
The ports that users in this group can access.
- id: required(string)
A unique identifier for this group
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groupname: required(string - maxLength: 60 - pattern: ^[a-zA-Z0-9_]+[a-zA-Z0-9._-]*$)
Example:
{
"group": {
"id": "groups-6",
"enabled": true,
"groupname": "netgrp2",
"mode": "scoped",
"role": "ConsoleUser",
"access_rights": [
"web_ui",
"pmshell"
],
"description": "Group for ConsoleUser role",
"members": [
"root",
"tu0"
],
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
],
"rights": {
"delete": true,
"modify": false
}
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /groups/{id}
Delete a Group
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Group deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Group did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find group with groupname or id 'group6'",
"args": {
"uuid": "group6"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/scripts
The scripts endpoint is used to upload and execute custom user scripts on the NetOps Console Server appliance and to retrieve the status of currently executing scripts.
Upload a shell script to be executed on the node
Retrieve the status of a script executing on the node, as in GET /scripts?execution_id={id}, where id is the value for execution_id returned in the 200 response to the POST /scripts request.
post /scripts
Upload a shell script to be executed on the node
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: multipart/form-data
Type: object
Properties- script_metadata: required(object)
JSON object containing script_timeout in minutes and the script_checksum (SHA1).
- script_timeout: required(integer)
The number of minutes that the script is allowed to run
- script_checksum: required(string)
The SHA1 checksum of the script
- script_timeout: required(integer)
- file: required(file)
The file to be uploaded.
HTTP status code 200
Successful request
Body
Media type: application/json
Type: object
Properties- info: required(string)
- execution_id: required(string)
Example:
{
"info": "Script execution started successfully",
"execution_id": "ASE12"
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Example:
{
"error": "Invalid script metadata"
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
get /scripts
Retrieve the status of a script executing on the node, as in GET /scripts?execution_id={id}, where id is the value for execution_id returned in the 200 response to the POST /scripts request.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- execution_id: required(string)
The execution_id returned from a /scripts POST request
HTTP status code 200
Successful request
Body
Media type: application/json
Type: object
Properties- script_status: required(one of in_progress, timed_out, completed)
Example:
{
"script_status": "in_progress"
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Example:
{
"error": "Script execution ID not provided"
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 500
Unexpected error
Body
Media type: application/json
Type: object
Example:
{
"error": "Script exit code not found"
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/firewall
Firewall endpoints are related to configuring and accessing information about the firewall running on the NetOps Console Server appliance.
Collection of custom services defined for the NetOps Console Server appliance's firewall. A service is a named grouping of one or more TCP or UDP ports for a particular networking protocol. For example, the 'https' service refers to TCP port 443. The appliance includes many predefined services for common protocols (see /firewall/predefined_services). This collection contains only custom services which have been defined by the administrator.
Retrieve a list of custom services defined for the NetOps Console Server appliance.
Create a new custom service in the config.
get /firewall/services
Retrieve a list of custom services defined for the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The list of custom services.
Body
Media type: application/json
Type: object
Properties- firewall_services: required(array of object)
Items: items
- id: required(string)
The unique identifier for this firewall service.
- name: required(string)
The name of this firewall service.
- label: required(string)
The human-readable label of this firewall service.
- ports: required(array of object)
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
The protocol for this firewall service.
- port: required(integer - minimum: 0 - maximum: 65535)
The port used for this firewall service.
- protocol: required(one of tcp, udp, tcp+udp)
- id: required(string)
- meta: required(object)
- total_pages: (string)
Example:
{
"firewall_services": [
{
"id": "firewall-services-0",
"name": "http",
"label": "HTTP",
"ports": [
{
"protocol": "tcp",
"port": 80
}
]
},
{
"id": "firewall-services-1",
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
],
"meta": {
"total_pages": "1"
}
}
HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /firewall/services
Create a new custom service in the config.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_service: required(object)
- name: required(string)
Symbolic name for a service. Limited to '-', '_', and alphanumeric characters. This is an identifier field used to select a specific service in command line tools, and is the identifier to use when adding services to a firewall zone. For example, "my-service".
- label: required(string)
A concise, user-friendly label for this service. This value is displayed in the web user interface. For example, "My Service".
- ports: required(array of object)
The set of protocol/port combinations used by this service.
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
The protocol for this firewall service.
- port: required(integer - minimum: 0 - maximum: 65535)
The port used for this firewall service.
- protocol: required(one of tcp, udp, tcp+udp)
- name: required(string)
Example:
{
"firewall_service": {
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
}
HTTP status code 200
Service was added.
Body
Media type: application/json
Type: object
Properties- firewall_service: required(object)
A firewall service
- id: required(string)
The unique identifier for this firewall service.
- name: required(string)
The name of this firewall service.
- label: required(string)
The human-readable label of this firewall service.
- ports: required(array of object)
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
The protocol for this firewall service.
- port: required(integer - minimum: 0 - maximum: 65535)
The port used for this firewall service.
- protocol: required(one of tcp, udp, tcp+udp)
- id: required(string)
Example:
{
"firewall_service": {
"id": "firewall-services-1",
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
}
HTTP status code 400
Failed due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 12,
"text": "Element is below the minimum allowed length of 1 character(s)",
"args": {
"min": "1",
"uuid": "{60e2b0a-aafa-11e6-aca7-cb7fd0646002"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update a specific custom firewall service.
Retrieve the custom service by ID.
Set the configuration for an existing firewall service.
Delete a service.
get /firewall/services/{id}
Retrieve the custom service by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Service exists.
Body
Media type: application/json
Type: object
Properties- firewall_service: required(object)
A firewall service
- id: required(string)
The unique identifier for this firewall service.
- name: required(string)
The name of this firewall service.
- label: required(string)
The human-readable label of this firewall service.
- ports: required(array of object)
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
The protocol for this firewall service.
- port: required(integer - minimum: 0 - maximum: 65535)
The port used for this firewall service.
- protocol: required(one of tcp, udp, tcp+udp)
- id: required(string)
Example:
{
"firewall_service": {
"id": "firewall-services-1",
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}
HTTP status code 404
Service does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find user with username or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /firewall/services/{id}
Set the configuration for an existing firewall service.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_service: required(object)
- name: required(string)
Symbolic name for a service. Limited to '-', '_', and alphanumeric characters. This is an identifier field used to select a specific service in command line tools, and is the identifier to use when adding services to a firewall zone. For example, "my-service".
- label: required(string)
A concise, user-friendly label for this service. This value is displayed in the web user interface. For example, "My Service".
- ports: required(array of object)
The set of protocol/port combinations used by this service.
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
The protocol for this firewall service.
- port: required(integer - minimum: 0 - maximum: 65535)
The port used for this firewall service.
- protocol: required(one of tcp, udp, tcp+udp)
- name: required(string)
Example:
{
"firewall_service": {
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
}
HTTP status code 200
Service has been updated.
Body
Media type: application/json
Type: object
Properties- firewall_service: required(object)
A firewall service
- id: required(string)
The unique identifier for this firewall service.
- name: required(string)
The name of this firewall service.
- label: required(string)
The human-readable label of this firewall service.
- ports: required(array of object)
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
The protocol for this firewall service.
- port: required(integer - minimum: 0 - maximum: 65535)
The port used for this firewall service.
- protocol: required(one of tcp, udp, tcp+udp)
- id: required(string)
Example:
{
"firewall_service": {
"id": "firewall-services-1",
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Service does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/service with name or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /firewall/services/{id}
Delete a service.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Service deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Service does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/service with name or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Collection of zones defined for the NetOps Console Server appliance's firewall. A zone includes 1 or more interfaces.
Retrieve a list of zones defined for the NetOps Console Server appliance.
Create a new zone in the config.
Set a list of firewall zones in the config.
get /firewall/zones
Retrieve a list of zones defined for the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The list of zones.
Body
Media type: application/json
Type: object
Properties- firewall_zones: required(array of object)
Items: items
- id: required(string)
The unique identifier for this firewall zone.
- name: required(string)
The name used to identify this firewall zone.
- label: required(string)
A human-readable label to identify this firewall zone.
- description: required(string)
A description of this firewall zone.
- physifs: (array of string)
The network interfaces this firewall zone applies to.
- wireguards: (array of string)
The list of wireguard tunnels that are included in this firewall zone.
- permit_all_traffic: required(boolean)
When enabled, all traffic will be permitted in this zone. Any rules configured in this zone will have no effect.
- masquerade: required(boolean)
When enabled, traffic through this zone is masqueraded.
- permitted_services: (array of string)
List of services that are allowed for this zone. Each entry is the service name, not the service label (e.g. 'dhcpv6-client' rather than 'DHCPv6 Client'). See fireware/predefined_services for the list of predefined services, and firewall/services for custom services. [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"address_filters":[{"source_address":"0.0.0.0/0","services":[]},{"source_address":"::/0","services":[]}]},"since":"12/2022"}
- deprecatedProperty
- port_forwarding_rules: required(array of object)
List of port forwarding rules
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
Apply port forwarding to this transport protocol.
- from_port: required(string - pattern: ^((^|,)\d{1,5}(-\d{1,5})?)+$)
A comma-separated set of individual port numbers, and/or port ranges (e.g. 22,290-300,443). Traffic received on each of these ports or port ranges will be forwarded to the specified 'to_port'. [regexerr:A comma-separated set of port numbers, and/or port ranges (0-65535).]
- to_port: required(integer - minimum: 0 - maximum: 65535)
The network port number
- to_address: (string)
The IP Address to forward packets to
- protocol: required(one of tcp, udp, tcp+udp)
- custom_rules: required(array of object)
List of user defined rich rules
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional) for this rich rule item.
- rule_content: required(string)
- address_filters: (array of object)
Items: items
- source_address: required(string)
The source address or network that the services are allowed on.
- services: required(array of string)
- source_address: required(string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- id: required(string)
- meta: required(object)
- total_pages: (string)
Example:
{
"firewall_zones": [
{
"id": "firewall-zones-0",
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"wireguards": [],
"permit_all_traffic": false,
"masquerade": false,
"port_forwarding_rules": [
{
"protocol": "tcp",
"from_port": "33",
"to_port": 44
}
],
"custom_rules": [
{
"rule_content": "rule family='ipv4' source address='192.168.67.101/32' service name='telnet' accept",
"description": "allow rule"
}
],
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ssh",
"https"
]
},
{
"source_address": "::/0",
"services": [
"ssh",
"https"
]
}
]
},
{
"id": "firewall-zones-1",
"name": "lan2",
"label": "LAN 2",
"description": "Backup Network",
"physifs": [],
"permit_all_traffic": false,
"masquerade": false,
"port_forwarding_rules": [],
"custom_rules": [],
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ssh",
"https"
]
},
{
"source_address": "::/0",
"services": [
"ssh",
"https"
]
}
]
},
{
"id": "firewall-zones-2",
"name": "smf-1",
"label": "SMF-1",
"description": "OSPF Network",
"wireguards": [
"wg0"
],
"permit_all_traffic": false,
"masquerade": false,
"port_forwarding_rules": [],
"custom_rules": [],
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ospf"
]
},
{
"source_address": "::/0",
"services": [
"ospf"
]
}
]
}
],
"meta": {
"total_pages": "1"
}
}
HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /firewall/zones
Create a new zone in the config.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_zone: required(object)
A single firewall zone
- name: required(string - maxLength: 17 - pattern: ^[a-zA-Z0-9_]+$)
Symbolic name for this firewall zone. Limited to uppercase (A-Z), lowercase (a-z), digits (0-9), and underscore characters, up to a maximum length of 17 characters. This is an identifier field used to select a specific zone in command line tools. For example, "myzone". [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_"]
- label: required(string)
A concise, user-friendly label for this firewall zone. This value is displayed in the web user interface. For example, "My Zone".
- description: required(string)
A comment field used to provide a full description of this firewall zone.
- physifs: (array of string)
The network interfaces this firewall zone applies to.
- wireguards: (array of string)
The wireguard tunnels this firewall zone applies to.
- permit_all_traffic: required(boolean)
When enabled, all traffic will be permitted in this zone. Any rules configured in this zone will have no effect.
- masquerade: required(boolean)
When enabled, traffic through this zone is masqueraded.
- permitted_services: (array of string)
List of services that are allowed for this zone. Each entry is the service name, not the service label (e.g. 'dhcpv6-client' rather than 'DHCPv6 Client'). See fireware/predefined_services for the list of predefined services, and firewall/services for custom services. [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"address_filters":[{"source_address":"0.0.0.0/0","services":[]},{"source_address":"::/0","services":[]}]},"since":"12/2022"}
- deprecatedProperty
- port_forwarding_rules: (array of object)
List of port forwarding rules
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
Apply port forwarding to this transport protocol.
- from_port: required(string - pattern: ^((^|,)\d{1,5}(-\d{1,5})?)+$)
A comma-separated set of individual port numbers, and/or port ranges (e.g. 22,290-300,443). Traffic received on each of these ports or port ranges will be forwarded to the specified 'to_port'. [regexerr:A comma-separated set of port numbers, and/or port ranges (0-65535).]
- to_port: required(integer - minimum: 0 - maximum: 65535)
The network port number
- to_address: (string)
The IP Address to forward packets to
- protocol: required(one of tcp, udp, tcp+udp)
- custom_rules: (array of object)
List of user defined rich rules
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional) for this rich rule item.
- rule_content: required(string)
- address_filters: (array of object)
A list of source address filters that specify which services can be accepted over a specified source address or network
Items: items
- source_address: required(string)
The source address or network that the services are allowed on.
- services: required(array of string)
- source_address: required(string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- name: required(string - maxLength: 17 - pattern: ^[a-zA-Z0-9_]+$)
Example:
{
"firewall_zone": {
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ssh",
"https"
]
},
{
"source_address": "::/0",
"services": [
"ssh",
"https"
]
}
]
}
}
HTTP status code 200
Zone was added.
Body
Media type: application/json
Type: object
Properties- firewall_zone: required(object)
A firewall zone
- id: required(string)
The unique identifier for this firewall zone.
- name: required(string)
The name used to identify this firewall zone.
- label: required(string)
A human-readable label to identify this firewall zone.
- description: required(string)
A description of this firewall zone.
- physifs: (array of string)
The network interfaces this firewall zone applies to.
- wireguards: (array of string)
The list of wireguard tunnels that are included in this firewall zone.
- permit_all_traffic: required(boolean)
When enabled, all traffic will be permitted in this zone. Any rules configured in this zone will have no effect.
- masquerade: required(boolean)
When enabled, traffic through this zone is masqueraded.
- permitted_services: (array of string)
List of services that are allowed for this zone. Each entry is the service name, not the service label (e.g. 'dhcpv6-client' rather than 'DHCPv6 Client'). See fireware/predefined_services for the list of predefined services, and firewall/services for custom services. [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"address_filters":[{"source_address":"0.0.0.0/0","services":[]},{"source_address":"::/0","services":[]}]},"since":"12/2022"}
- deprecatedProperty
- port_forwarding_rules: required(array of object)
List of port forwarding rules
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
Apply port forwarding to this transport protocol.
- from_port: required(string - pattern: ^((^|,)\d{1,5}(-\d{1,5})?)+$)
A comma-separated set of individual port numbers, and/or port ranges (e.g. 22,290-300,443). Traffic received on each of these ports or port ranges will be forwarded to the specified 'to_port'. [regexerr:A comma-separated set of port numbers, and/or port ranges (0-65535).]
- to_port: required(integer - minimum: 0 - maximum: 65535)
The network port number
- to_address: (string)
The IP Address to forward packets to
- protocol: required(one of tcp, udp, tcp+udp)
- custom_rules: required(array of object)
List of user defined rich rules
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional) for this rich rule item.
- rule_content: required(string)
- address_filters: (array of object)
Items: items
- source_address: required(string)
The source address or network that the services are allowed on.
- services: required(array of string)
- source_address: required(string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- id: required(string)
Example:
{
"firewall_zone": {
"id": "firewall-zones-0",
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"port_forwarding_rules": [
{
"protocol": "tcp",
"from_port": "33",
"to_port": 44
}
],
"custom_rules": [],
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ssh",
"https"
]
},
{
"source_address": "::/0",
"services": [
"ssh",
"https"
]
}
]
}
}
HTTP status code 400
Failed due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 12,
"text": "Element is below the minimum allowed length of 1 character(s)",
"args": {
"min": "1",
"uuid": "{60e2b0a-aafa-11e6-aca7-cb7fd0646002"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /firewall/zones
Set a list of firewall zones in the config.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_zones: required(array of object)
Items: items
- name: required(string - maxLength: 17 - pattern: ^[a-zA-Z0-9_]+$)
Symbolic name for this firewall zone. Limited to uppercase (A-Z), lowercase (a-z), digits (0-9), and underscore characters, up to a maximum length of 17 characters. This is an identifier field used to select a specific zone in command line tools. For example, "myzone". [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_"]
- label: required(string)
A concise, user-friendly label for this firewall zone. This value is displayed in the web user interface. For example, "My Zone".
- description: required(string)
A comment field used to provide a full description of this firewall zone.
- physifs: (array of string)
The network interfaces this firewall zone applies to.
- wireguards: (array of string)
The wireguard tunnels this firewall zone applies to.
- permit_all_traffic: required(boolean)
When enabled, all traffic will be permitted in this zone. Any rules configured in this zone will have no effect.
- masquerade: required(boolean)
When enabled, traffic through this zone is masqueraded.
- permitted_services: (array of string)
List of services that are allowed for this zone. Each entry is the service name, not the service label (e.g. 'dhcpv6-client' rather than 'DHCPv6 Client'). See fireware/predefined_services for the list of predefined services, and firewall/services for custom services. [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"address_filters":[{"source_address":"0.0.0.0/0","services":[]},{"source_address":"::/0","services":[]}]},"since":"12/2022"}
- deprecatedProperty
- port_forwarding_rules: (array of object)
List of port forwarding rules
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
Apply port forwarding to this transport protocol.
- from_port: required(string - pattern: ^((^|,)\d{1,5}(-\d{1,5})?)+$)
A comma-separated set of individual port numbers, and/or port ranges (e.g. 22,290-300,443). Traffic received on each of these ports or port ranges will be forwarded to the specified 'to_port'. [regexerr:A comma-separated set of port numbers, and/or port ranges (0-65535).]
- to_port: required(integer - minimum: 0 - maximum: 65535)
The network port number
- to_address: (string)
The IP Address to forward packets to
- protocol: required(one of tcp, udp, tcp+udp)
- custom_rules: (array of object)
List of user defined rich rules
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional) for this rich rule item.
- rule_content: required(string)
- address_filters: (array of object)
A list of source address filters that specify which services can be accepted over a specified source address or network
Items: items
- source_address: required(string)
The source address or network that the services are allowed on.
- services: required(array of string)
- source_address: required(string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- name: required(string - maxLength: 17 - pattern: ^[a-zA-Z0-9_]+$)
Example:
{
"firewall_zones": [
{
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"port_forwarding_rules": [
{
"protocol": "tcp",
"from_port": "33",
"to_port": 44
}
],
"custom_rules": [
{
"rule_content": "rule family='ipv4' source address='192.168.67.101/32' service name='telnet' accept",
"description": "allow rule"
}
],
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ssh",
"https"
]
},
{
"source_address": "::/0",
"services": [
"ssh",
"https"
]
}
]
},
{
"name": "lhvpn",
"label": "LHVPN",
"description": "VPN connections to Lighthouse central management",
"physifs": [],
"permit_all_traffic": true,
"masquerade": true,
"port_forwarding_rules": [],
"custom_rules": [],
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ssh",
"https"
]
},
{
"source_address": "::/0",
"services": [
"ssh",
"https"
]
}
]
},
{
"name": "smf1",
"label": "SMF-1",
"description": "OSPF network",
"wireguards": [
"wg0"
],
"permit_all_traffic": false,
"masquerade": false,
"port_forwarding_rules": [],
"custom_rules": [],
"address_filters": []
}
]
}
HTTP status code 200
The list of zones have been updated.
Body
Media type: application/json
Type: object
Properties- firewall_zones: required(array of object)
Items: items
- id: required(string)
The unique identifier for this firewall zone.
- name: required(string)
The name used to identify this firewall zone.
- label: required(string)
A human-readable label to identify this firewall zone.
- description: required(string)
A description of this firewall zone.
- physifs: (array of string)
The network interfaces this firewall zone applies to.
- wireguards: (array of string)
The list of wireguard tunnels that are included in this firewall zone.
- permit_all_traffic: required(boolean)
When enabled, all traffic will be permitted in this zone. Any rules configured in this zone will have no effect.
- masquerade: required(boolean)
When enabled, traffic through this zone is masqueraded.
- permitted_services: (array of string)
List of services that are allowed for this zone. Each entry is the service name, not the service label (e.g. 'dhcpv6-client' rather than 'DHCPv6 Client'). See fireware/predefined_services for the list of predefined services, and firewall/services for custom services. [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"address_filters":[{"source_address":"0.0.0.0/0","services":[]},{"source_address":"::/0","services":[]}]},"since":"12/2022"}
- deprecatedProperty
- port_forwarding_rules: required(array of object)
List of port forwarding rules
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
Apply port forwarding to this transport protocol.
- from_port: required(string - pattern: ^((^|,)\d{1,5}(-\d{1,5})?)+$)
A comma-separated set of individual port numbers, and/or port ranges (e.g. 22,290-300,443). Traffic received on each of these ports or port ranges will be forwarded to the specified 'to_port'. [regexerr:A comma-separated set of port numbers, and/or port ranges (0-65535).]
- to_port: required(integer - minimum: 0 - maximum: 65535)
The network port number
- to_address: (string)
The IP Address to forward packets to
- protocol: required(one of tcp, udp, tcp+udp)
- custom_rules: required(array of object)
List of user defined rich rules
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional) for this rich rule item.
- rule_content: required(string)
- address_filters: (array of object)
Items: items
- source_address: required(string)
The source address or network that the services are allowed on.
- services: required(array of string)
- source_address: required(string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- id: required(string)
- meta: required(object)
- total_pages: (string)
Example:
{
"firewall_zones": [
{
"id": "firewall_zones-1",
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"port_forwarding_rules": [
{
"protocol": "tcp",
"from_port": "33",
"to_port": 44
}
],
"custom_rules": [
{
"rule_content": "rule family='ipv4' source address='192.168.67.101/32' service name='telnet' accept",
"description": "allow rule"
}
],
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ssh",
"https"
]
},
{
"source_address": "::/0",
"services": [
"ssh",
"https"
]
}
]
},
{
"id": "firewall_zones-4",
"name": "lhvpn",
"label": "LHVPN",
"description": "VPN connections to Lighthouse central management",
"physifs": [],
"permit_all_traffic": true,
"masquerade": true,
"port_forwarding_rules": [],
"custom_rules": [],
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ssh",
"https"
]
},
{
"source_address": "::/0",
"services": [
"ssh",
"https"
]
}
]
},
{
"id": "firewall_zones-6",
"name": "smf-1",
"label": "SMF-1",
"description": "OSPF network",
"physifs": [],
"permit_all_traffic": false,
"masquerade": false,
"port_forwarding_rules": [],
"custom_rules": [],
"address_filters": []
}
],
"meta": {
"total_pages": "1"
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Zone does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/zone with name or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update a specific firewall zone.
Retrieve the zone by ID.
Set the configuration for an existing firewall zone.
Delete a zone.
get /firewall/zones/{id}
Retrieve the zone by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Zone exists.
Body
Media type: application/json
Type: object
Properties- firewall_zone: required(object)
A firewall zone
- id: required(string)
The unique identifier for this firewall zone.
- name: required(string)
The name used to identify this firewall zone.
- label: required(string)
A human-readable label to identify this firewall zone.
- description: required(string)
A description of this firewall zone.
- physifs: (array of string)
The network interfaces this firewall zone applies to.
- wireguards: (array of string)
The list of wireguard tunnels that are included in this firewall zone.
- permit_all_traffic: required(boolean)
When enabled, all traffic will be permitted in this zone. Any rules configured in this zone will have no effect.
- masquerade: required(boolean)
When enabled, traffic through this zone is masqueraded.
- permitted_services: (array of string)
List of services that are allowed for this zone. Each entry is the service name, not the service label (e.g. 'dhcpv6-client' rather than 'DHCPv6 Client'). See fireware/predefined_services for the list of predefined services, and firewall/services for custom services. [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"address_filters":[{"source_address":"0.0.0.0/0","services":[]},{"source_address":"::/0","services":[]}]},"since":"12/2022"}
- deprecatedProperty
- port_forwarding_rules: required(array of object)
List of port forwarding rules
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
Apply port forwarding to this transport protocol.
- from_port: required(string - pattern: ^((^|,)\d{1,5}(-\d{1,5})?)+$)
A comma-separated set of individual port numbers, and/or port ranges (e.g. 22,290-300,443). Traffic received on each of these ports or port ranges will be forwarded to the specified 'to_port'. [regexerr:A comma-separated set of port numbers, and/or port ranges (0-65535).]
- to_port: required(integer - minimum: 0 - maximum: 65535)
The network port number
- to_address: (string)
The IP Address to forward packets to
- protocol: required(one of tcp, udp, tcp+udp)
- custom_rules: required(array of object)
List of user defined rich rules
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional) for this rich rule item.
- rule_content: required(string)
- address_filters: (array of object)
Items: items
- source_address: required(string)
The source address or network that the services are allowed on.
- services: required(array of string)
- source_address: required(string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- id: required(string)
Example:
{
"firewall_zone": {
"id": "firewall-zones-0",
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"port_forwarding_rules": [
{
"protocol": "tcp",
"from_port": "33",
"to_port": 44
}
],
"custom_rules": [],
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ssh",
"https"
]
},
{
"source_address": "::/0",
"services": [
"ssh",
"https"
]
}
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}
HTTP status code 404
Zone does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/zone with name or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /firewall/zones/{id}
Set the configuration for an existing firewall zone.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_zone: required(object)
A single firewall zone
- name: required(string - maxLength: 17 - pattern: ^[a-zA-Z0-9_]+$)
Symbolic name for this firewall zone. Limited to uppercase (A-Z), lowercase (a-z), digits (0-9), and underscore characters, up to a maximum length of 17 characters. This is an identifier field used to select a specific zone in command line tools. For example, "myzone". [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_"]
- label: required(string)
A concise, user-friendly label for this firewall zone. This value is displayed in the web user interface. For example, "My Zone".
- description: required(string)
A comment field used to provide a full description of this firewall zone.
- physifs: (array of string)
The network interfaces this firewall zone applies to.
- wireguards: (array of string)
The wireguard tunnels this firewall zone applies to.
- permit_all_traffic: required(boolean)
When enabled, all traffic will be permitted in this zone. Any rules configured in this zone will have no effect.
- masquerade: required(boolean)
When enabled, traffic through this zone is masqueraded.
- permitted_services: (array of string)
List of services that are allowed for this zone. Each entry is the service name, not the service label (e.g. 'dhcpv6-client' rather than 'DHCPv6 Client'). See fireware/predefined_services for the list of predefined services, and firewall/services for custom services. [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"address_filters":[{"source_address":"0.0.0.0/0","services":[]},{"source_address":"::/0","services":[]}]},"since":"12/2022"}
- deprecatedProperty
- port_forwarding_rules: (array of object)
List of port forwarding rules
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
Apply port forwarding to this transport protocol.
- from_port: required(string - pattern: ^((^|,)\d{1,5}(-\d{1,5})?)+$)
A comma-separated set of individual port numbers, and/or port ranges (e.g. 22,290-300,443). Traffic received on each of these ports or port ranges will be forwarded to the specified 'to_port'. [regexerr:A comma-separated set of port numbers, and/or port ranges (0-65535).]
- to_port: required(integer - minimum: 0 - maximum: 65535)
The network port number
- to_address: (string)
The IP Address to forward packets to
- protocol: required(one of tcp, udp, tcp+udp)
- custom_rules: (array of object)
List of user defined rich rules
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional) for this rich rule item.
- rule_content: required(string)
- address_filters: (array of object)
A list of source address filters that specify which services can be accepted over a specified source address or network
Items: items
- source_address: required(string)
The source address or network that the services are allowed on.
- services: required(array of string)
- source_address: required(string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- name: required(string - maxLength: 17 - pattern: ^[a-zA-Z0-9_]+$)
Example:
{
"firewall_zone": {
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ssh",
"https"
]
},
{
"source_address": "::/0",
"services": [
"ssh",
"https"
]
}
]
}
}
HTTP status code 200
Zone has been updated.
Body
Media type: application/json
Type: object
Properties- firewall_zone: required(object)
A firewall zone
- id: required(string)
The unique identifier for this firewall zone.
- name: required(string)
The name used to identify this firewall zone.
- label: required(string)
A human-readable label to identify this firewall zone.
- description: required(string)
A description of this firewall zone.
- physifs: (array of string)
The network interfaces this firewall zone applies to.
- wireguards: (array of string)
The list of wireguard tunnels that are included in this firewall zone.
- permit_all_traffic: required(boolean)
When enabled, all traffic will be permitted in this zone. Any rules configured in this zone will have no effect.
- masquerade: required(boolean)
When enabled, traffic through this zone is masqueraded.
- permitted_services: (array of string)
List of services that are allowed for this zone. Each entry is the service name, not the service label (e.g. 'dhcpv6-client' rather than 'DHCPv6 Client'). See fireware/predefined_services for the list of predefined services, and firewall/services for custom services. [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"address_filters":[{"source_address":"0.0.0.0/0","services":[]},{"source_address":"::/0","services":[]}]},"since":"12/2022"}
- deprecatedProperty
- port_forwarding_rules: required(array of object)
List of port forwarding rules
Items: items
- protocol: required(one of tcp, udp, tcp+udp)
Apply port forwarding to this transport protocol.
- from_port: required(string - pattern: ^((^|,)\d{1,5}(-\d{1,5})?)+$)
A comma-separated set of individual port numbers, and/or port ranges (e.g. 22,290-300,443). Traffic received on each of these ports or port ranges will be forwarded to the specified 'to_port'. [regexerr:A comma-separated set of port numbers, and/or port ranges (0-65535).]
- to_port: required(integer - minimum: 0 - maximum: 65535)
The network port number
- to_address: (string)
The IP Address to forward packets to
- protocol: required(one of tcp, udp, tcp+udp)
- custom_rules: required(array of object)
List of user defined rich rules
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional) for this rich rule item.
- rule_content: required(string)
- address_filters: (array of object)
Items: items
- source_address: required(string)
The source address or network that the services are allowed on.
- services: required(array of string)
- source_address: required(string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- id: required(string)
Example:
{
"firewall_zone": {
"id": "firewall-zones-1",
"name": "lan2",
"label": "LAN 2",
"description": "Backup Network",
"physifs": [
"net1"
],
"permit_all_traffic": true,
"masquerade": true,
"port_forwarding_rules": [
{
"protocol": "tcp",
"from_port": "33",
"to_port": 44
}
],
"custom_rules": [],
"address_filters": [
{
"source_address": "0.0.0.0/0",
"services": [
"ssh",
"https"
]
},
{
"source_address": "::/0",
"services": [
"ssh",
"https"
]
}
]
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Zone does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/zone with name or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /firewall/zones/{id}
Delete a zone.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Zone deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Zone does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/zone with name or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Collection of rules defined for the NetOps Console Server appliance's firewall. A rule maps a service to a zone.
Retrieve a list of rules defined for the NetOps Console Server appliance.
Create a new rule in the config.
Bulk delete a list of rules defined for the NetOps Console Server appliance.
get /firewall/rules
Retrieve a list of rules defined for the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The list of rules.
Body
Media type: application/json
Type: object
Properties- firewall_rules: required(array of object)
Items: items
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this firewall rule
- service: required(string)
- zone: required(string)
Example:
{
"firewall_rules": [
{
"id": "firewall-rules-0",
"multi_field_identifier": "wan-http",
"service": "http",
"zone": "wan"
},
{
"id": "firewall-rules-1",
"multi_field_identifier": "lan-https",
"service": "https",
"zone": "lan"
}
]
}
HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /firewall/rules
Create a new rule in the config.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_rule: required(object)
- service: required(string)
- zone: required(string)
The zone this firewall rule will be added to. [reference:firewall/zone:name]
Example:
{
"firewall_rule": {
"service": "https",
"zone": "wan"
}
}
HTTP status code 200
Rule was added.
Body
Media type: application/json
Type: object
Properties- firewall_rule: required(object)
A firewall rule
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this firewall rule
- service: required(string)
- zone: required(string)
Example:
{
"firewall_rule": {
"id": "firewall-rules-1",
"multi_field_identifier": "wan-https",
"service": "https",
"zone": "wan"
}
}
HTTP status code 400
Failed due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 12,
"text": "Element is below the minimum allowed length of 1 character(s)",
"args": {
"min": "1",
"uuid": "{60e2b0a-aafa-11e6-aca7-cb7fd0646002"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /firewall/rules
Bulk delete a list of rules defined for the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_rules: required(array of string)
Example:
{
"firewall_rules": [
"firewall_rules-1",
"firewall_rules-5"
]
}
HTTP status code 204
All rules were deleted successfully.
HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Rule(s) do not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'firewall_rules-5'",
"args": {
"uuid": "firewall_rules-5"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update a specific firewall rich rule.
Retrieve the rule by ID.
Set the configuration for an existing firewall rule.
Delete a rule.
get /firewall/rules/{id}
Retrieve the rule by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Rule exists.
Body
Media type: application/json
Type: object
Properties- firewall_rule: required(object)
A firewall rule
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this firewall rule
- service: required(string)
- zone: required(string)
Example:
{
"firewall_rule": {
"id": "firewall-rules-1",
"multi_field_identifier": "wan-https",
"service": "https",
"zone": "wan"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}
HTTP status code 404
Rule does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /firewall/rules/{id}
Set the configuration for an existing firewall rule.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_rule: required(object)
- service: required(string)
- zone: required(string)
The zone this firewall rule will be added to. [reference:firewall/zone:name]
Example:
{
"firewall_rule": {
"service": "https",
"zone": "wan"
}
}
HTTP status code 200
Rule has been updated.
Body
Media type: application/json
Type: object
Properties- firewall_rule: required(object)
A firewall rule
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this firewall rule
- service: required(string)
- zone: required(string)
Example:
{
"firewall_rule": {
"id": "firewall-rules-1",
"multi_field_identifier": "wan-https",
"service": "https",
"zone": "wan"
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Rule does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /firewall/rules/{id}
Delete a rule.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Rule deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Rule does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Collection of predefined services defined for the NetOps Console Server appliance's firewall. A service is a named grouping of one or more TCP or UDP ports for a particular networking protocol. For example, the 'https' service refers to TCP port 443. This collection contains predefined services for common protocols and doesn't include the services added by the administrator.
Retrieve a list of predefined services defined for the NetOps Console Server appliance.
get /firewall/predefined_services
Retrieve a list of predefined services defined for the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The list of predefined services.
Body
Media type: application/json
Type: object
Properties- predefined_firewall_services: required(array of object)
Items: items
- name: required(string)
- label: required(string)
- ports: (array of object)
Items: items
- protocol: required(string)
- port: required(string)
Can be a numeric port number or a range such as 5900-5903
- meta: required(object)
- total_pages: (string)
Example:
{
"predefined_firewall_services": [
{
"name": "http",
"label": "HTTP",
"ports": [
{
"protocol": "tcp",
"port": "80"
}
]
},
{
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": "443"
}
]
}
],
"meta": {
"total_pages": "1"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve a predefined service by name.
get /firewall/predefined_services/{name}
URI Parameters
- name: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- predefined_firewall_service: required(object)
A predefined firewall service
- name: required(string)
- label: required(string)
- ports: (array of object)
Items: items
- protocol: required(string)
- port: required(string)
Can be a numeric port number or a range such as 5900-5903
Example:
{
"predefined_firewall_service": {
"name": "http",
"label": "HTTP",
"ports": [
{
"protocol": "tcp",
"port": "80"
}
]
}
}
Collection of policies defined for the NetOps Console Server appliance's firewall. A policy applies a set of rules to traffic flowing between between zones.
Retrieve a list of policies defined for the NetOps Console Server appliance.
Create a new policy in the config.
get /firewall/policies
Retrieve a list of policies defined for the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The list of policies.
Body
Media type: application/json
Type: object
Properties- firewall_policies: required(array of object)
Items: items
- id: required(string)
The unique identifier for this firewall policy.
- name: required(string)
The name used to identify this firewall policy.
- description: (string)
A description of this firewall policy.
- priority: (integer)
The priority of the policy dictates when it is applied compared to other policies and zones. Policies with negative priorities are applied before rules in zones; policies with positive priorities are applied after. A priority of 0 is a special priority and cannot be set.
- default_action: (string)
The default action of the policy i.e. what happens to packets that don't match any rule.
- ingress_zones: required(array of string)
Traffic originating from the ingress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- egress_zones: required(array of string)
Traffic directed to the egress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- rules: (array of object)
A list of rules that specify what happens to specific packets as they pass through the firewall policy.
Items: items
- services: (array of string)
A list of services that this rule will apply to. If no services are specified this rule will apply to all services.
- source_address: (string)
The source address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:destination_address:=:]
- destination_address: (string)
The destination address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:source_address:=:]
- log_prefix: (string)
This sets the prefix of the info level log that is sent when this rule is hit. If this is left blank no log will be sent.
- priority: (integer - default: 0 - minimum: -32768 - maximum: 32767)
The priority given to this rule. Rules with a lower priority are applied first. The default value is 0.
- action: required(one of accept, reject, drop)
The action that is going to be taken on matching packets.
- services: (array of string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- id: required(string)
- meta: required(object)
- total_pages: (string)
Example:
{
"firewall_policies": [
{
"id": "firewall_policies-1",
"name": "lan_to_wan",
"description": "LAN --> WAN",
"priority": -1,
"default_action": "accept",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan"
],
"rules": []
},
{
"id": "firewall_policies-2",
"name": "wan_to_lan",
"priority": -1,
"default_action": "continue",
"ingress_zones": [
"wan"
],
"egress_zones": [
"lan"
],
"rules": [
{
"services": [
"https",
"http"
],
"source_address": "1.2.3.4",
"destination_address": "5.6.7.8",
"log_prefix": "blah: ",
"priority": 0,
"action": "reject"
}
]
}
],
"meta": {
"total_pages": "1"
}
}
HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /firewall/policies
Create a new policy in the config.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_policy: required(object)
- name: required(string - pattern: ^([a-zA-Z0-9_]){1,17}$)
The name used to identify this firewall policy. [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:Maximum length of 17 characters]
- description: (string)
A description of this firewall policy.
- priority: (integer - default: -1 - minimum: -32768 - maximum: 32767)
The priority of the policy dictates when it is applied compared to other policies and zones. Policies with negative priorities are applied before rules in zones; policies with positive priorities are applied after. A priority of 0 is a special priority and cannot be set.
- default_action: (one of accept, reject, drop, continue - default: accept)
The default action of the policy i.e. what happens to packets that don't match any rule.
- ingress_zones: required(array of string)
Traffic originating from the ingress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- egress_zones: required(array of string)
Traffic directed to the egress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- rules: (array of object)
A list of rules that specify what happens to specific packets as they pass through the firewall policy.
Items: items
- services: (array of string)
A list of services that this rule will apply to. If no services are specified this rule will apply to all services.
- source_address: (string)
The source address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:destination_address:=:]
- destination_address: (string)
The destination address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:source_address:=:]
- log_prefix: (string)
This sets the prefix of the info level log that is sent when this rule is hit. If this is left blank no log will be sent.
- priority: (integer - default: 0 - minimum: -32768 - maximum: 32767)
The priority given to this rule. Rules with a lower priority are applied first. The default value is 0.
- action: required(one of accept, reject, drop)
The action that is going to be taken on matching packets.
- services: (array of string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- name: required(string - pattern: ^([a-zA-Z0-9_]){1,17}$)
Example:
{
"firewall_policy": {
"name": "lan_to_wan",
"description": "LAN --> WAN",
"priority": -1,
"default_action": "continue",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan",
"lhvpn"
],
"rules": [
{
"services": [
"https",
"http"
],
"source_address": "1.2.3.4",
"destination_address": "5.6.7.8",
"log_prefix": "blah: ",
"priority": 0,
"action": "reject"
}
]
}
}
HTTP status code 201
Policy was added.
Body
Media type: application/json
Type: object
Properties- firewall_policy: required(object)
A firewall policy
- id: required(string)
The unique identifier for this firewall policy.
- name: required(string)
The name used to identify this firewall policy.
- description: (string)
A description of this firewall policy.
- priority: (integer)
The priority of the policy dictates when it is applied compared to other policies and zones. Policies with negative priorities are applied before rules in zones; policies with positive priorities are applied after. A priority of 0 is a special priority and cannot be set.
- default_action: (string)
The default action of the policy i.e. what happens to packets that don't match any rule.
- ingress_zones: required(array of string)
Traffic originating from the ingress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- egress_zones: required(array of string)
Traffic directed to the egress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- rules: (array of object)
A list of rules that specify what happens to specific packets as they pass through the firewall policy.
Items: items
- services: (array of string)
A list of services that this rule will apply to. If no services are specified this rule will apply to all services.
- source_address: (string)
The source address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:destination_address:=:]
- destination_address: (string)
The destination address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:source_address:=:]
- log_prefix: (string)
This sets the prefix of the info level log that is sent when this rule is hit. If this is left blank no log will be sent.
- priority: (integer - default: 0 - minimum: -32768 - maximum: 32767)
The priority given to this rule. Rules with a lower priority are applied first. The default value is 0.
- action: required(one of accept, reject, drop)
The action that is going to be taken on matching packets.
- services: (array of string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- id: required(string)
Example:
{
"firewall_policy": {
"id": "firewall_policies-1",
"name": "lan_to_wan",
"description": "LAN --> WAN",
"priority": -1,
"default_action": "continue",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan",
"lhvpn"
],
"rules": [
{
"services": [
"https",
"http"
],
"source_address": "1.2.3.4",
"destination_address": "5.6.7.8",
"log_prefix": "blah: ",
"priority": 0,
"action": "reject"
}
]
}
}
HTTP status code 400
Failed due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 12,
"text": "Element is below the minimum allowed length of 1 character(s)",
"args": {
"min": "1",
"uuid": "{60e2b0a-aafa-11e6-aca7-cb7fd0646002"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update a specific firewall policy.
Retrieve the policy by ID.
Set the configuration for an existing firewall policy.
Delete a policy.
get /firewall/policies/{id}
Retrieve the policy by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Policy exists.
Body
Media type: application/json
Type: object
Properties- firewall_policy: required(object)
A firewall policy
- id: required(string)
The unique identifier for this firewall policy.
- name: required(string)
The name used to identify this firewall policy.
- description: (string)
A description of this firewall policy.
- priority: (integer)
The priority of the policy dictates when it is applied compared to other policies and zones. Policies with negative priorities are applied before rules in zones; policies with positive priorities are applied after. A priority of 0 is a special priority and cannot be set.
- default_action: (string)
The default action of the policy i.e. what happens to packets that don't match any rule.
- ingress_zones: required(array of string)
Traffic originating from the ingress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- egress_zones: required(array of string)
Traffic directed to the egress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- rules: (array of object)
A list of rules that specify what happens to specific packets as they pass through the firewall policy.
Items: items
- services: (array of string)
A list of services that this rule will apply to. If no services are specified this rule will apply to all services.
- source_address: (string)
The source address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:destination_address:=:]
- destination_address: (string)
The destination address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:source_address:=:]
- log_prefix: (string)
This sets the prefix of the info level log that is sent when this rule is hit. If this is left blank no log will be sent.
- priority: (integer - default: 0 - minimum: -32768 - maximum: 32767)
The priority given to this rule. Rules with a lower priority are applied first. The default value is 0.
- action: required(one of accept, reject, drop)
The action that is going to be taken on matching packets.
- services: (array of string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- id: required(string)
Example:
{
"firewall_policy": {
"id": "firewall_policies-1",
"name": "lan_to_wan",
"description": "LAN --> WAN",
"priority": -1,
"default_action": "continue",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan"
],
"rules": [
{
"services": [
"https",
"http"
],
"source_address": "1.2.3.4",
"destination_address": "5.6.7.8",
"log_prefix": "blah: ",
"priority": 0,
"action": "reject"
}
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}
HTTP status code 404
Policy does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/policy with name or id 'firewall_policies-2'",
"args": {
"uuid": "firewall_policies-2"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /firewall/policies/{id}
Set the configuration for an existing firewall policy.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_policy: required(object)
- name: required(string - pattern: ^([a-zA-Z0-9_]){1,17}$)
The name used to identify this firewall policy. [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:Maximum length of 17 characters]
- description: (string)
A description of this firewall policy.
- priority: (integer - default: -1 - minimum: -32768 - maximum: 32767)
The priority of the policy dictates when it is applied compared to other policies and zones. Policies with negative priorities are applied before rules in zones; policies with positive priorities are applied after. A priority of 0 is a special priority and cannot be set.
- default_action: (one of accept, reject, drop, continue - default: accept)
The default action of the policy i.e. what happens to packets that don't match any rule.
- ingress_zones: required(array of string)
Traffic originating from the ingress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- egress_zones: required(array of string)
Traffic directed to the egress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- rules: (array of object)
A list of rules that specify what happens to specific packets as they pass through the firewall policy.
Items: items
- services: (array of string)
A list of services that this rule will apply to. If no services are specified this rule will apply to all services.
- source_address: (string)
The source address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:destination_address:=:]
- destination_address: (string)
The destination address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:source_address:=:]
- log_prefix: (string)
This sets the prefix of the info level log that is sent when this rule is hit. If this is left blank no log will be sent.
- priority: (integer - default: 0 - minimum: -32768 - maximum: 32767)
The priority given to this rule. Rules with a lower priority are applied first. The default value is 0.
- action: required(one of accept, reject, drop)
The action that is going to be taken on matching packets.
- services: (array of string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- name: required(string - pattern: ^([a-zA-Z0-9_]){1,17}$)
Example:
{
"firewall_policy": {
"name": "lan_to_wan",
"description": "LAN --> WAN",
"priority": -1,
"default_action": "continue",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan"
],
"rules": [
{
"services": [
"https",
"http"
],
"source_address": "1.2.3.4",
"destination_address": "5.6.7.8",
"log_prefix": "blah: ",
"priority": 0,
"action": "reject"
}
]
}
}
HTTP status code 200
Policy has been updated.
Body
Media type: application/json
Type: object
Properties- firewall_policy: required(object)
A firewall policy
- id: required(string)
The unique identifier for this firewall policy.
- name: required(string)
The name used to identify this firewall policy.
- description: (string)
A description of this firewall policy.
- priority: (integer)
The priority of the policy dictates when it is applied compared to other policies and zones. Policies with negative priorities are applied before rules in zones; policies with positive priorities are applied after. A priority of 0 is a special priority and cannot be set.
- default_action: (string)
The default action of the policy i.e. what happens to packets that don't match any rule.
- ingress_zones: required(array of string)
Traffic originating from the ingress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- egress_zones: required(array of string)
Traffic directed to the egress zones will be subject to this policy. The allowed values are those defined in firewall/zones or the symbolic values HOST/ANY. (If HOST or ANY are selected then they must be the only zone selected)
- rules: (array of object)
A list of rules that specify what happens to specific packets as they pass through the firewall policy.
Items: items
- services: (array of string)
A list of services that this rule will apply to. If no services are specified this rule will apply to all services.
- source_address: (string)
The source address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:destination_address:=:]
- destination_address: (string)
The destination address that this rule will apply to. One of source_address or destination_address is required. Use 0.0.0.0/0 or ::/0 to match on any address. [required:source_address:=:]
- log_prefix: (string)
This sets the prefix of the info level log that is sent when this rule is hit. If this is left blank no log will be sent.
- priority: (integer - default: 0 - minimum: -32768 - maximum: 32767)
The priority given to this rule. Rules with a lower priority are applied first. The default value is 0.
- action: required(one of accept, reject, drop)
The action that is going to be taken on matching packets.
- services: (array of string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- id: required(string)
Example:
{
"firewall_policy": {
"id": "firewall_policies-1",
"name": "lan_to_wan",
"description": "LAN --> WAN",
"priority": -1,
"default_action": "continue",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan"
],
"rules": [
{
"services": [
"https",
"http"
],
"source_address": "1.2.3.4",
"destination_address": "5.6.7.8",
"log_prefix": "blah: ",
"priority": 0,
"action": "reject"
}
]
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Policy does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/policy with name or id 'firewall_policies-2'",
"args": {
"uuid": "firewall_policies-2"
},
"level": 1
}
]
}
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /firewall/policies/{id}
Delete a policy.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Policy deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Policy does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/policy with name or id 'firewall_policies-2'",
"args": {
"uuid": "firewall_policies-2"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Collection of source addresses matched with a list of services for which source nating rules will be applied.
Retrieve a list of source address matched with services defined for the NetOps Console Server appliance.
Replace current firewall service translation list with a new one.
Create a new service translation in the config.
get /firewall/service_translations
Retrieve a list of source address matched with services defined for the NetOps Console Server appliance.
HTTP status code 200
The list of services used in source nating rules for an address
Body
Media type: application/json
Type: object
Properties- firewall_service_translations: required(array of object)
Items: items
- id: required(string)
The unique identifier for this firewall service translation.
- address: required(string)
The address that services will use when exiting the device.
- services: required(array of string)
A list of services that will have the associated address assigned to them
- id: required(string)
Example:
{
"firewall_service_translations": [
{
"id": "firewall_service_translations-1",
"address": "1.1.1.1",
"services": [
"dns",
"https"
]
},
{
"id": "firewall_service_translations-2",
"address": "2.2.2.2",
"services": [
"custom_service_1"
]
}
]
}
HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
put /firewall/service_translations
Replace current firewall service translation list with a new one.
Body
Media type: application/json
Type: object
Properties- firewall_service_translations: required(array of object)
Items: items
- address: required(string)
The address that services will use when exiting the device. [warning_function:check_if_ip_exists]
- services: required(array of string)
A list of services that will have the associated address assigned to them
- address: required(string)
Example:
{
"firewall_service_translations": [
{
"address": "1.1.1.1",
"services": [
"dns",
"https"
]
},
{
"address": "2.2.2.2",
"services": [
"custom_service_1"
]
}
]
}
HTTP status code 200
List was applied succesfully.
Body
Media type: application/json
Type: object
Properties- firewall_service_translations: required(array of object)
Items: items
- id: required(string)
The unique identifier for this firewall service translation.
- address: required(string)
The address that services will use when exiting the device.
- services: required(array of string)
A list of services that will have the associated address assigned to them
- id: required(string)
Example:
{
"firewall_service_translations": [
{
"id": "firewall_service_translations-1",
"address": "1.1.1.1",
"services": [
"dns",
"https"
]
},
{
"id": "firewall_service_translations-2",
"address": "2.2.2.2",
"services": [
"custom_service_1"
]
}
]
}
HTTP status code 400
Failed due to error in post body.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 2,
"code": 305,
"text": "Property 'dns' is invalid as it is already being used for another firewall_service_translation",
"args": {
"property": "dns",
"reason": "as it is already being used for another firewall_service_translation"
},
"level": 1
}
]
}
post /firewall/service_translations
Create a new service translation in the config.
Body
Media type: application/json
Type: object
Properties- firewall_service_translation: required(object)
A firewall service translation
- address: required(string)
The address that services will use when exiting the device. [warning_function:check_if_ip_exists]
- services: required(array of string)
A list of services that will have the associated address assigned to them
- address: required(string)
Example:
{
"firewall_service_translation": {
"address": "2.2.2.2",
"services": [
"custom_service_1"
]
}
}
HTTP status code 201
Service translation was added.
Body
Media type: application/json
Type: object
Properties- firewall_service_translation: required(object)
A firewall service translation
- id: required(string)
The unique identifier for this firewall service translation.
- address: required(string)
The address that services will use when exiting the device.
- services: required(array of string)
A list of services that will have the associated address assigned to them
- id: required(string)
Example:
{
"firewall_service_translation": {
"id": "firewall_service_translations-2",
"address": "2.2.2.2",
"services": [
"custom_service_1"
]
}
}
HTTP status code 400
Failed due to error in post body.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 2,
"code": 305,
"text": "Property 'dns' is invalid as it is already being used for another firewall_service_translation",
"args": {
"property": "dns",
"reason": "as it is already being used for another firewall_service_translation"
},
"level": 1
}
]
}
Retrieve or update a specific firewall service translation.
Retrieve the specific firewall service translation by ID.
Set the configuration for an existing service translation.
Delete a service translation.
get /firewall/service_translations/{id}
Retrieve the specific firewall service translation by ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
firewall service translation exists.
Body
Media type: application/json
Type: object
Properties- firewall_service_translation: required(object)
A firewall service translation
- id: required(string)
The unique identifier for this firewall service translation.
- address: required(string)
The address that services will use when exiting the device.
- services: required(array of string)
A list of services that will have the associated address assigned to them
- id: required(string)
Example:
{
"firewall_service_translation": {
"id": "firewall_service_translations-2",
"address": "2.2.2.2",
"services": [
"custom_service_1"
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}
HTTP status code 404
Firewall service translation does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find item with UUID 'firewall_service_translations-1'",
"args": {
"uuid": "firewall_service_translations-1"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /firewall/service_translations/{id}
Set the configuration for an existing service translation.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_service_translation: required(object)
A firewall service translation
- address: required(string)
The address that services will use when exiting the device. [warning_function:check_if_ip_exists]
- services: required(array of string)
A list of services that will have the associated address assigned to them
- address: required(string)
Example:
{
"firewall_service_translation": {
"address": "2.2.2.2",
"services": [
"custom_service_1"
]
}
}
HTTP status code 200
Service translation has been updated.
Body
Media type: application/json
Type: object
Properties- firewall_service_translation: required(object)
A firewall service translation
- id: required(string)
The unique identifier for this firewall service translation.
- address: required(string)
The address that services will use when exiting the device.
- services: required(array of string)
A list of services that will have the associated address assigned to them
- id: required(string)
Example:
{
"firewall_service_translation": {
"id": "firewall_service_translations-2",
"address": "2.2.2.2",
"services": [
"custom_service_1"
]
}
}
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Firewall service translation does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find item with UUID 'firewall_service_translations-1'",
"args": {
"uuid": "firewall_service_translations-1"
},
"level": 1
}
]
}
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /firewall/service_translations/{id}
Delete a service translation.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Service translation deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Firewall service translation does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find item with UUID 'firewall_service_translations-1'",
"args": {
"uuid": "firewall_service_translations-1"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/cellfw
The cellfw endpoints are related to checking, upgrading and scheduling upgrades for modem firmware.
Retrieve cellular modem version and related information.
Retrieve cellular modem version and related information.
get /cellfw/info
Retrieve cellular modem version and related information.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- cellfw_info: required(object)
- firmware: required(object)
- model: required(string)
The model name of this cell modem
- boot_version: required(string)
The version of the boot firmware on this cell modem
- amss_version: required(string)
The version of the AMSS (Advanced Mode Subscriber Software) on this cell modem
- sku_id: required(string)
The SKU (Stock Keeping Unit) that uniquely identifies this cell modem
- package_id: required(string)
The id of the update package used for the cell modem firmware
- carrier_id: required(string)
The id of the cellular carrier being used
- config_version: required(string)
The version of the config installed on this cell modem
- model: required(string)
- operating_mode: required(object)
- mode: required(string)
The connection status of this cell modem
- hw_restricted: required(string)
The status of hardware restriction on this cell modem
- mode: required(string)
- firmware: required(object)
Example:
{
"cellfw_info": {
"firmware": {
"amss_version": "SWI9X50C_01.07.02.00",
"boot_version": "SWI9X50C_01.07.02.00",
"carrier_id": "4",
"config_version": "002.008_004",
"model": "EM7565",
"package_id": "unknown",
"sku_id": "1104207"
},
"operating_mode": {
"hw_restricted": "no",
"mode": "online"
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/export
Retrieve system configuration for the NetOps Console Server.
get /export
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- export: required(object)
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/failover
Failover endpoint is to check failover status and retrieve / change failover settings.
failover/settings endpoint is to check and update failover settings. When failover is enabled, this device will consume from 1MB to 1.6 MB of bandwidth per day on the probe_physif connection. If the probe addresses are unreachable, this device will take from 108 to 156 seconds to enter the failover state.
Retrieve the current failover settings.
Set the failover settings.
get /failover/settings
Retrieve the current failover settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current failover settings.
Body
Media type: application/json
Type: object
Properties- failover_settings: required(object)
- enabled: required(boolean - default: false)
Enable or disable failover.
- probe_physif: required(string)
The interface through which the device will attempt to probe the given probe_address. A Failover event occurs if the probe_address isn't reachable on this interface.
- probe_address: required(string - maxLength: 253)
Probe address can be an IPv4 address, IPv6 address or a hostname. Be aware that hostnames may not resolve during Failover depending on DNS settings.
- probe_address_2: (string - maxLength: 253)
Probe address can be an IPv4 address, IPv6 address, or a hostname. Be aware that hostnames may not resolve during Failover depending on DNS settings. If configured, this address is probed by probe_physif if probe_address isn't reachable. A Failover event occurs if this address isn't reachable.
- dormant_dns: (boolean - default: false)
Whether DNS is dormant (not configured) for the Failover interface in normal operation. During Failover this will be restored.
- failover_physif: (string)
Fail over to this network interface.
- enabled: required(boolean - default: false)
Example:
{
"failover_settings": {
"enabled": true,
"probe_physif": "net1",
"probe_address": "8.8.8.8",
"probe_address_2": "1.1.1.1",
"dormant_dns": true,
"failover_physif": "wwan0"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /failover/settings
Set the failover settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- failover_settings: required(object)
- probe_physif: required(string)
The interface through which the device will attempt to probe the given probe_address. A Failover event occurs if the probe_address isn't reachable on this interface. [Optional when Failover is disabled, computed_options:physifs_no_loopbacks]
- failover_physif: (string)
Fail over to this network interface. Note that if this field is omitted when failover is enabled, it will be set to wwan0 (for compatibility with older releases). [Optional when Failover is disabled, computed_options:physifs_no_loopbacks]
- enabled: required(boolean - default: false)
Enable or disable failover.
- probe_address: required(string - maxLength: 253)
Probe address can be an IPv4 address, IPv6 address or a hostname. Be aware that hostnames may not resolve during Failover depending on DNS settings.
- probe_address_2: (string - maxLength: 253)
Probe address can be an IPv4 address, IPv6 address, or a hostname. Be aware that hostnames may not resolve during Failover depending on DNS settings. If configured, this address is probed by probe_physif if probe_address isn't reachable. A Failover event occurs if this address isn't reachable.
- dormant_dns: (boolean - default: false)
Whether DNS is dormant (not configured) for the Failover interface in normal operation. During Failover this will be restored.
- probe_physif: required(string)
Examples:
example1:
{
"failover_settings": {
"enabled": true,
"probe_physif": "net1",
"probe_address": "8.8.8.8"
}
}
example2:
{
"failover_settings": {
"enabled": false,
"probe_physif": "net2",
"probe_address": "192.168.0.1",
"probe_address_2": "",
"dormant_dns": true,
"failover_physif": "wwan0"
}
}
HTTP status code 200
Returns the current failover settings.
Body
Media type: application/json
Type: object
Properties- failover_settings: required(object)
- enabled: required(boolean - default: false)
Enable or disable failover.
- probe_physif: required(string)
The interface through which the device will attempt to probe the given probe_address. A Failover event occurs if the probe_address isn't reachable on this interface.
- probe_address: required(string - maxLength: 253)
Probe address can be an IPv4 address, IPv6 address or a hostname. Be aware that hostnames may not resolve during Failover depending on DNS settings.
- probe_address_2: (string - maxLength: 253)
Probe address can be an IPv4 address, IPv6 address, or a hostname. Be aware that hostnames may not resolve during Failover depending on DNS settings. If configured, this address is probed by probe_physif if probe_address isn't reachable. A Failover event occurs if this address isn't reachable.
- dormant_dns: (boolean - default: false)
Whether DNS is dormant (not configured) for the Failover interface in normal operation. During Failover this will be restored.
- failover_physif: (string)
Fail over to this network interface.
- enabled: required(boolean - default: false)
Examples:
example1:
{
"failover_settings": {
"enabled": true,
"probe_physif": "net1",
"probe_address": "8.8.8.8",
"probe_address_2": "1.1.1.1",
"dormant_dns": false,
"failover_physif": "wwan0"
}
}
example2:
{
"failover_settings": {
"enabled": false,
"probe_physif": "net2",
"probe_address": "192.168.0.1",
"probe_address_2": "",
"dormant_dns": true,
"failover_physif": "wwan0"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
failover/status endpoint is to check current failover status.
Retrieve the current failover status.
get /failover/status
Retrieve the current failover status.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current failover status.
Body
Media type: application/json
Type: object
Properties- failover_status: required(object)
- status: required(one of primary_starting, primary_complete, primary_stopping, failover_starting, failover_complete, failover_stopping, disabled, unknown)
Failover status
- status: required(one of primary_starting, primary_complete, primary_stopping, failover_starting, failover_complete, failover_stopping, disabled, unknown)
Example:
{
"failover_status": {
"status": "failover_complete"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/cellmodem
Retrieve information about the cell modem.
This endpoint is used to retrieve status data about the cellular modem in the device
get /cellmodem
This endpoint is used to retrieve status data about the cellular modem in the device
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
A JSON object containing cellmodem information.
Body
Media type: application/json
Type: object
Properties- cellmodem: required(object)
- enabled: (boolean)
Is the cell modem currently enabled
- device: (string)
Device name
- up: (boolean)
Is this cell modem currently connected
- signalStrength: (integer)
Signal quality (%) (backwards compatable)
- signal_quality: (integer)
Signal quality (%)
- rssi: (integer)
Received Signal Strength Indicator (RSSI)
- technology: (string)
Access technology
- modem_status: (string)
Modem status
- failure_reason: (string)
Failure reason
- ipv4_addresses: (array of string)
IPv4 addresses of the cell modem
- ipv6_addresses: (array of string)
IPv6 addresses of the cell modem
- failover: (object)
Details about whether failover is enabled on the cell modem
- enabled: (boolean)
Is Failover enabled
- active: (boolean)
Is Failover active
- dormant: (boolean)
Does the interface stay up when not failed-over to
- enabled: (boolean)
- sims: required(object)
Details about the current SIM cards
- active_sim: (number)
The current selected SIM
- failover_status: (one of disabled, enabled, failing_over, failed_over, failing_back, unknown)
The current SIM failover state
- sim1: required(object)
Details about SIM1
- iccid: (string)
SIM ICCID
- carrier: (string)
SIM Carrier
- apn: (string)
SIM APN
- ip_type: (string)
SIM IP-Type
- username: (string)
SIM User
- imsi: (string)
SIM IMSI
- state: (string)
Current state of the SIM
- last_active: (number)
The time-stamp of the last time this SIM became active
- last_update: (number)
The time-stamp of the last update
- signal_strength: (number)
Signal strength of the modem connection with this SIM
- iccid: (string)
- sim2: required(object)
Details about SIM2
- iccid: (string)
SIM ICCID
- carrier: (string)
SIM Carrier
- apn: (string)
SIM APN
- ip_type: (string)
SIM IP-Type
- username: (string)
SIM User
- imsi: (string)
SIM IMSI
- state: (string)
Current state of the SIM
- last_active: (number)
The time-stamp of the last time this SIM became active
- last_update: (number)
The time-stamp of the last update
- signal_strength: (number)
Signal strength of the modem connection with this SIM
- iccid: (string)
- active_sim: (number)
- enabled: (boolean)
Example:
{
"cellmodem": {
"enabled": true,
"device": "wwan0",
"up": true,
"signalStrength": 89,
"signal_quality": 89,
"rssi": -67,
"technology": "lte",
"modem_status": "connected",
"failure_reason": "none",
"ipv4_addresses": [
"123.127.198.4"
],
"ipv6_addresses": [
"fe80::69dc:654f:f1e5:ff12"
],
"failover": {
"enabled": false,
"dormant": false,
"active": false
},
"sims": {
"active_sim": 2,
"failover_status": "enabled",
"sim1": {
"iccid": "89148000004743232368",
"carrier": "Verizon Wireless",
"apn": "VZWINTERNET",
"ip_type": "ipv4v6",
"username": "",
"imsi": "",
"state": "present",
"last_active": 1598222515038,
"last_update": 1598222515038,
"signal_strength": 94
},
"sim2": {
"iccid": "89014103278929156118",
"carrier": "AT&T Wireless Inc",
"apn": "i2gold",
"ip_type": "ipv4v6",
"username": "",
"imsi": "310410892915611",
"state": "present",
"last_active": 1598222515038,
"last_update": 1598222515038,
"signal_strength": 93
}
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 404
Cellular modem was not found.
Body
Media type: application/json
Type: object
Properties- error: required(string)
Example:
{
"error": "No Cellular Modem detected"
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Cell modem SIM status
Retrieve the current SIM status.
get /cellmodem/sims
Retrieve the current SIM status.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current SIM status.
Body
Media type: application/json
Type: object
Properties- cellmodem_sims: required(array of object)
Items: items
- id: required(string)
- active: (boolean)
This SIM is the currently selected SIM
- slot: (number)
SIM Slot
- iccid: (string)
SIM ICCID
- carrier: (string)
SIM Carrier
- apn: (string)
SIM APN
- ip_type: (string)
SIM IP-Type
- username: (string)
SIM User
- imsi: (string)
SIM IMSI
- state: (string)
Current state of the SIM
- last_active: (number)
The time-stamp of the last time this SIM became active
- last_update: (number)
The time-stamp of the last update
- signal_strength: (number)
Signal strength of the modem connection with this SIM
Example:
{
"cellmodem_sims": [
{
"id": "cellmodem-sim-1",
"active": true,
"slot": 1,
"iccid": "89148000004743232368",
"carrier": "Verizon Wireless",
"apn": "VZWINTERNET",
"ip_type": "ipv4v6",
"username": "",
"imsi": "",
"state": "present",
"last_active": 1598222515038,
"last_update": 1598222515038,
"signal_strength": 94
},
{
"id": "cellmodem-sim-2",
"active": false,
"slot": 2,
"iccid": "89014103278929156118",
"carrier": "AT&T Wireless Inc",
"apn": "i2gold",
"ip_type": "ipv4v6",
"username": "",
"imsi": "310410892915611",
"state": "present",
"last_active": 1598222515038,
"last_update": 1598222515038,
"signal_strength": 93
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 404
Cellular modem was not found.
Body
Media type: application/json
Type: object
Properties- error: required(string)
Example:
{
"error": "No Cellular Modem detected"
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the status information for a specific Cell Modem SIM
get /cellmodem/sims/{id}
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- cellmodem_sim: required(object)
Cell Modem SIM Status Information
- id: required(string)
- active: (boolean)
This SIM is the currently selected SIM
- slot: (number)
SIM Slot
- iccid: (string)
SIM ICCID
- carrier: (string)
SIM Carrier
- apn: (string)
SIM APN
- ip_type: (string)
SIM IP-Type
- username: (string)
SIM User
- imsi: (string)
SIM IMSI
- state: (string)
Current state of the SIM
- last_active: (number)
The time-stamp of the last time this SIM became active
- last_update: (number)
The time-stamp of the last update
- signal_strength: (number)
Signal strength of the modem connection with this SIM
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/ipsec_tunnels
Read and manipulate the IPsec tunnels on the NetOps Console Server appliance.
Get a list of the IPsec tunnels.
Add a new network tunnel to the NetOps Console Server appliance.
get /ipsec_tunnels
Get a list of the IPsec tunnels.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- ipsec_tunnels: required(array of object)
Items: items
- id: required(string)
Database ID for this IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(string)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: required(integer)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean)
- dpd_action: (string)
Determines the action to perform on timeout.
- dpd_delay: (integer)
Defines the time interval between keep-alive exchanges sent to the peer.
- dpd_timeout: required(integer)
Defines the timeout period for a connection.
- phase1_rekey_time: (integer)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (string)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (string)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (string)
Determines the units for phase1_random_time.
- phase1_over_time: (integer)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (string)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (string)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (string)
Determines the units for phase2_random_time.
- phase2_life_time: (integer)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (string)
Determines the units for phase2_life_time.
- proposal: required(string)
Algorithm to be used for Key Exchange for establishing this tunnel
Annotations
- deprecatedProperty
{"since":"03/2021"}
- deprecatedProperty
- phase1_proposal: required(string)
Algorithms to be used for Key Exchange (Phase 1) for establishing this tunnel
- phase2_proposal: required(string)
Algorithms to be used for IPsec/Child SA (Phase 2) for this tunnel
- phase2_proposal_type: required(one of esp, ah)
IPsec/Child SA proposal type. ESP protocol or AH protocol can be selected
- local_id: required(string)
Local IKE identity to use for authentication.
- remote_id: required(string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address.
- encap: (boolean)
Force encapsulation
- local_subnet: required(string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: required(string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: required(one of psk, pki - default: psk)
Authentication type for this tunnel, 'psk' (Pre-Shared Key) or 'pki' (Public Key Infrastructure). If this field is not provided then 'psk' mode will be selected.
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required when auth_mode is set to 'psk'. [sensitive]
- runtime_status: required(object)
- established: required(boolean)
This value is reported as true when the tunnel has been negotiated successfully and is currently active.
- established: required(boolean)
- id: required(string)
Example:
{
"ipsec_tunnels": [
{
"id": "0",
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv2",
"keying_tries": 5,
"dpd_enabled": true,
"dpd_action": "trap",
"dpd_delay": 20,
"dpd_timeout": 80,
"phase1_rekey_time": 4,
"phase1_rekey_unit": "days",
"phase1_reauth_time": 4,
"phase1_reauth_unit": "weeks",
"phase1_random_time": 2,
"phase1_random_unit": "minutes",
"phase1_over_time": 10,
"phase1_over_unit": "hours",
"phase2_rekey_time": 1,
"phase2_rekey_unit": "weeks",
"phase2_random_time": 70,
"phase2_random_unit": "seconds",
"phase2_life_time": 22,
"phase2_life_unit": "hours",
"proposal": "default-pfs",
"phase1_proposal": "default",
"phase2_proposal": "aes128-aes192-aes256-sha256-sha384-sha512-sha1-aesxcbc-modp2048-modp3072-modp4096-modp6144-modp8192-ecp224-ecp256-ecp384-ecp521",
"phase2_proposal_type": "esp",
"local_id": "",
"remote_id": "",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"encap": true,
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "psk",
"shared_secret": "default",
"runtime_status": {
"established": false
}
},
{
"id": "1",
"name": "remote-tunnel",
"enabled": false,
"initiate": false,
"version": "IKEv2",
"keying_tries": 15,
"dpd_enabled": true,
"dpd_action": "clear",
"dpd_delay": 40,
"dpd_timeout": 70,
"phase1_rekey_time": 2,
"phase1_rekey_unit": "days",
"phase1_reauth_time": 5,
"phase1_reauth_unit": "weeks",
"phase2_rekey_time": 2,
"phase2_rekey_unit": "weeks",
"proposal": "3des-sha-modp1024",
"phase1_proposal": "3des-sha-modp1024",
"phase2_proposal": "3des-sha-modp1024",
"phase2_proposal_type": "esp",
"local_id": "",
"remote_id": "",
"local_address": "",
"remote_address": "192.168.126.77",
"encap": true,
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "psk",
"shared_secret": "password2",
"runtime_status": {
"established": true
}
},
{
"id": "2",
"name": "tunnel-pki",
"enabled": false,
"initiate": false,
"version": "IKEv2",
"keying_tries": 15,
"dpd_enabled": true,
"dpd_action": "clear",
"dpd_delay": 40,
"dpd_timeout": 70,
"phase1_rekey_time": 2,
"phase1_rekey_unit": "days",
"phase1_reauth_time": 5,
"phase1_reauth_unit": "weeks",
"phase2_rekey_time": 2,
"phase2_rekey_unit": "seconds",
"proposal": "3des-sha-modp1024",
"phase1_proposal": "3des-sha-modp1024",
"phase2_proposal": "3des-sha-modp1024",
"phase2_proposal_type": "esp",
"local_id": "",
"remote_id": "",
"local_address": "",
"remote_address": "192.168.126.78",
"encap": true,
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "pki",
"runtime_status": {
"established": true
}
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec_tunnels
Add a new network tunnel to the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- ipsec_tunnel: required(object)
This object contains configuration information for an IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
Enables or disables the IPSec VPN Tunnel connection.
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(one of IKEv2, IKEv1, IKEv1-aggressive)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: (integer - default: 0)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean - default: false)
Enables or disables Dead Peer Detection.
- dpd_action: (one of clear, trap, restart - default: restart)
Determines the action to perform on timeout for Dead Peer Detection. [visible:dpd_enabled:=:true]
- dpd_delay: (integer - default: 60 - minimum: 0)
Defines the time interval between keep-alive exchanges sent to the peer for Dead Peer Detection. [visible:dpd_enabled:=:true]
- dpd_timeout: (integer - default: 90 - minimum: 0)
Defines the connection timeout period for Dead Peer Detection. [visible:dpd_enabled:=:true]
- phase1_rekey_time: (integer - default: 4 - minimum: 0)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (one of seconds, minutes, hours, days, weeks - default: hours)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer - default: 0 - minimum: 0)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (one of seconds, minutes, hours, days, weeks - default: seconds)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer - minimum: 0)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (one of seconds, minutes, hours, days, weeks)
Determines the units for phase1_random_time.
- phase1_over_time: (integer - minimum: 0)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (one of seconds, minutes, hours, days, weeks)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer - default: 1 - minimum: 0)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (one of seconds, minutes, hours, days, weeks - default: hours)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer - minimum: 0)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (one of seconds, minutes, hours, days, weeks)
Determines the units for phase2_random_time.
- phase2_life_time: (integer - minimum: 0)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (one of seconds, minutes, hours, days, weeks)
Determines the units for phase2_life_time.
- proposal: (string)
Algorithm to be used for Key Exchange for establishing this tunnel. Note that this property is deprecated and the following properties should be used instead:
- phase1_proposal
- phase2_proposal [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"phase1_proposal":"ike_proposals","phase2_proposal":"ipsec_proposals"},"since":"03/2021"}
- phase1_proposal: (string - default: default)
Algorithm proposals to be used for Key Exchange (Phase 1) for establishing this tunnel. A proposal is a set of algorithms. For non-AEAD algorithms, this includes for IKE an encryption algorithm, an integrity algorithm, a pseudo random function and a Diffie-Hellman group. For AEAD algorithms, instead of encryption and integrity algorithms, a combined algorithm is used.
See the following pages to check which algorithms are supported by strongswan.
- IKEv1 Cipher Suites: https://wiki.strongswan.org/projects/strongswan/wiki/IKEv1CipherSuites
- IKEv2 Cipher Suites: https://wiki.strongswan.org/projects/strongswan/wiki/IKEv2CipherSuites
Multiple proposals may be provided through a comma-separated string.
- example: aes128-sha256-ecp256,aes128-sha256-modp2048 Multiple algorithm types may be present in a single proposal (natively supported in IKEv2 and our backend will split it for IKEv1 cases).
- example: aes128-aes256-sha256-sha384-ecp256-modp2048 (single proposal with 2 encryption algorithms, 2 integrigity algorithms and 2 DH groups)
See also swanctl.conf connections.
.proposals field: https://wiki.strongswan.org/projects/strongswan/wiki/Swanctlconf - phase2_proposal: (string - default: default)
Algorithm proposals to be used for IPsec/Child SA (Phase 2) for this tunnel.
See phase1_proposal's description to for more information about proposals.
See also swanctl.conf ah_proposals and esp_proposals fields: https://wiki.strongswan.org/projects/strongswan/wiki/Swanctlconf
- phase2_proposal_type: (one of esp, ah - default: esp)
IPsec/Child SA proposal type. ESP protocol (encryption + authentication) or AH protocol (authentication only) can be selected
- local_id: (string)
Local IKE identity to use for authentication.
- remote_id: (string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address. [required:initiate:=:true]
- encap: (boolean - default: false)
Force UDP encapsulation for ESP packets. This is used for NAT traversal.
- local_subnet: (string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: (string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: (one of psk, pki - default: psk)
Authentication type for this tunnel, 'psk' (Pre-Shared Key) or 'pki' (Public Key Infrastructure). If this field is not provided then 'psk' mode will be selected.
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required when auth_mode is set to 'psk'. When the secret starts with "0s", base64 encoding is expected for the rest of the password. Example: 0sZGVmYXVsdA== Likewise, when the secret starts with "0x", hexadecimal encoding is expected for the rest of the password. Example: 0x64656661756c74 [sensitive,visible:auth_mode:=:psk,required:auth_mode:=:psk]
- name: required(string)
Example:
{
"ipsec_tunnel": {
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv1",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"shared_secret": "default"
}
}
HTTP status code 200
The tunnel {id} settings was updated.
Body
Media type: application/json
Type: object
Properties- ipsec_tunnel: required(object)
This object contains configuration information for an IPsec tunnel.
- id: required(string)
Database ID for this IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(string)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: required(integer)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean)
- dpd_action: (string)
Determines the action to perform on timeout.
- dpd_delay: (integer)
Defines the time interval between keep-alive exchanges sent to the peer.
- dpd_timeout: required(integer)
Defines the timeout period for a connection.
- phase1_rekey_time: (integer)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (string)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (string)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (string)
Determines the units for phase1_random_time.
- phase1_over_time: (integer)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (string)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (string)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (string)
Determines the units for phase2_random_time.
- phase2_life_time: (integer)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (string)
Determines the units for phase2_life_time.
- proposal: required(string)
Algorithm to be used for Key Exchange for establishing this tunnel
Annotations
- deprecatedProperty
{"since":"03/2021"}
- deprecatedProperty
- phase1_proposal: required(string)
Algorithms to be used for Key Exchange (Phase 1) for establishing this tunnel
- phase2_proposal: required(string)
Algorithms to be used for IPsec/Child SA (Phase 2) for this tunnel
- phase2_proposal_type: required(one of esp, ah)
IPsec/Child SA proposal type. ESP protocol or AH protocol can be selected
- local_id: required(string)
Local IKE identity to use for authentication.
- remote_id: required(string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address.
- encap: (boolean)
Force encapsulation
- local_subnet: required(string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: required(string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: required(one of psk, pki - default: psk)
Authentication type for this tunnel, 'psk' (Pre-Shared Key) or 'pki' (Public Key Infrastructure). If this field is not provided then 'psk' mode will be selected.
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required when auth_mode is set to 'psk'. [sensitive]
- runtime_status: required(object)
- established: required(boolean)
This value is reported as true when the tunnel has been negotiated successfully and is currently active.
- established: required(boolean)
- id: required(string)
Example:
{
"ipsec_tunnel": {
"id": "0",
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv1",
"keying_tries": 0,
"dpd_enabled": true,
"dpd_action": "restart",
"dpd_delay": 60,
"dpd_timeout": 90,
"phase1_rekey_time": 4,
"phase1_rekey_unit": "hours",
"phase1_reauth_time": 0,
"phase1_reauth_unit": "seconds",
"phase2_rekey_time": 1,
"phase2_rekey_unit": "hours",
"proposal": "default",
"phase1_proposal": "default",
"phase2_proposal": "default",
"phase2_proposal_type": "esp",
"local_id": "",
"remote_id": "",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "psk",
"shared_secret": "default",
"runtime_status": {
"established": false
}
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: tunnel id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update configuration for a specific IPsec tunnel on the NetOps Console Server.
Get the configuration of an IPsec tunnel on the NetOps Console Server appliance.
Update settings for an IPsec tunnel on the NetOps Console Server appliance.
Delete an IPsec tunnel on the NetOps Console Server appliance.
get /ipsec_tunnels/{id}
Get the configuration of an IPsec tunnel on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- ipsec_tunnel: required(object)
This object contains configuration information for an IPsec tunnel.
- id: required(string)
Database ID for this IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(string)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: required(integer)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean)
- dpd_action: (string)
Determines the action to perform on timeout.
- dpd_delay: (integer)
Defines the time interval between keep-alive exchanges sent to the peer.
- dpd_timeout: required(integer)
Defines the timeout period for a connection.
- phase1_rekey_time: (integer)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (string)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (string)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (string)
Determines the units for phase1_random_time.
- phase1_over_time: (integer)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (string)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (string)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (string)
Determines the units for phase2_random_time.
- phase2_life_time: (integer)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (string)
Determines the units for phase2_life_time.
- proposal: required(string)
Algorithm to be used for Key Exchange for establishing this tunnel
Annotations
- deprecatedProperty
{"since":"03/2021"}
- deprecatedProperty
- phase1_proposal: required(string)
Algorithms to be used for Key Exchange (Phase 1) for establishing this tunnel
- phase2_proposal: required(string)
Algorithms to be used for IPsec/Child SA (Phase 2) for this tunnel
- phase2_proposal_type: required(one of esp, ah)
IPsec/Child SA proposal type. ESP protocol or AH protocol can be selected
- local_id: required(string)
Local IKE identity to use for authentication.
- remote_id: required(string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address.
- encap: (boolean)
Force encapsulation
- local_subnet: required(string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: required(string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: required(one of psk, pki - default: psk)
Authentication type for this tunnel, 'psk' (Pre-Shared Key) or 'pki' (Public Key Infrastructure). If this field is not provided then 'psk' mode will be selected.
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required when auth_mode is set to 'psk'. [sensitive]
- runtime_status: required(object)
- established: required(boolean)
This value is reported as true when the tunnel has been negotiated successfully and is currently active.
- established: required(boolean)
- id: required(string)
Example:
{
"ipsec_tunnel": {
"id": "0",
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv1-aggressive",
"keying_tries": 10,
"dpd_enabled": true,
"dpd_action": "clear",
"dpd_delay": 40,
"dpd_timeout": 100,
"phase1_rekey_time": 3,
"phase1_rekey_unit": "hours",
"phase1_reauth_time": 0,
"phase1_reauth_unit": "seconds",
"phase2_rekey_time": 2,
"phase2_rekey_unit": "hours",
"proposal": "3des-md5-modp768",
"phase1_proposal": "3des-md5-modp768",
"phase2_proposal": "3des-md5-modp768",
"phase2_proposal_type": "esp",
"local_id": "me@test.net",
"remote_id": "",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "psk",
"shared_secret": "default",
"runtime_status": {
"established": false
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /ipsec_tunnels/{id}
Update settings for an IPsec tunnel on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- ipsec_tunnel: required(object)
This object contains configuration information for an IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
Enables or disables the IPSec VPN Tunnel connection.
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(one of IKEv2, IKEv1, IKEv1-aggressive)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: (integer - default: 0)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean - default: false)
Enables or disables Dead Peer Detection.
- dpd_action: (one of clear, trap, restart - default: restart)
Determines the action to perform on timeout for Dead Peer Detection. [visible:dpd_enabled:=:true]
- dpd_delay: (integer - default: 60 - minimum: 0)
Defines the time interval between keep-alive exchanges sent to the peer for Dead Peer Detection. [visible:dpd_enabled:=:true]
- dpd_timeout: (integer - default: 90 - minimum: 0)
Defines the connection timeout period for Dead Peer Detection. [visible:dpd_enabled:=:true]
- phase1_rekey_time: (integer - default: 4 - minimum: 0)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (one of seconds, minutes, hours, days, weeks - default: hours)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer - default: 0 - minimum: 0)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (one of seconds, minutes, hours, days, weeks - default: seconds)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer - minimum: 0)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (one of seconds, minutes, hours, days, weeks)
Determines the units for phase1_random_time.
- phase1_over_time: (integer - minimum: 0)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (one of seconds, minutes, hours, days, weeks)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer - default: 1 - minimum: 0)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (one of seconds, minutes, hours, days, weeks - default: hours)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer - minimum: 0)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (one of seconds, minutes, hours, days, weeks)
Determines the units for phase2_random_time.
- phase2_life_time: (integer - minimum: 0)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (one of seconds, minutes, hours, days, weeks)
Determines the units for phase2_life_time.
- proposal: (string)
Algorithm to be used for Key Exchange for establishing this tunnel. Note that this property is deprecated and the following properties should be used instead:
- phase1_proposal
- phase2_proposal [visible:never]
Annotations
- deprecatedProperty
{"replaceWith":{"phase1_proposal":"ike_proposals","phase2_proposal":"ipsec_proposals"},"since":"03/2021"}
- phase1_proposal: (string - default: default)
Algorithm proposals to be used for Key Exchange (Phase 1) for establishing this tunnel. A proposal is a set of algorithms. For non-AEAD algorithms, this includes for IKE an encryption algorithm, an integrity algorithm, a pseudo random function and a Diffie-Hellman group. For AEAD algorithms, instead of encryption and integrity algorithms, a combined algorithm is used.
See the following pages to check which algorithms are supported by strongswan.
- IKEv1 Cipher Suites: https://wiki.strongswan.org/projects/strongswan/wiki/IKEv1CipherSuites
- IKEv2 Cipher Suites: https://wiki.strongswan.org/projects/strongswan/wiki/IKEv2CipherSuites
Multiple proposals may be provided through a comma-separated string.
- example: aes128-sha256-ecp256,aes128-sha256-modp2048 Multiple algorithm types may be present in a single proposal (natively supported in IKEv2 and our backend will split it for IKEv1 cases).
- example: aes128-aes256-sha256-sha384-ecp256-modp2048 (single proposal with 2 encryption algorithms, 2 integrigity algorithms and 2 DH groups)
See also swanctl.conf connections.
.proposals field: https://wiki.strongswan.org/projects/strongswan/wiki/Swanctlconf - phase2_proposal: (string - default: default)
Algorithm proposals to be used for IPsec/Child SA (Phase 2) for this tunnel.
See phase1_proposal's description to for more information about proposals.
See also swanctl.conf ah_proposals and esp_proposals fields: https://wiki.strongswan.org/projects/strongswan/wiki/Swanctlconf
- phase2_proposal_type: (one of esp, ah - default: esp)
IPsec/Child SA proposal type. ESP protocol (encryption + authentication) or AH protocol (authentication only) can be selected
- local_id: (string)
Local IKE identity to use for authentication.
- remote_id: (string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address. [required:initiate:=:true]
- encap: (boolean - default: false)
Force UDP encapsulation for ESP packets. This is used for NAT traversal.
- local_subnet: (string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: (string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: (one of psk, pki - default: psk)
Authentication type for this tunnel, 'psk' (Pre-Shared Key) or 'pki' (Public Key Infrastructure). If this field is not provided then 'psk' mode will be selected.
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required when auth_mode is set to 'psk'. When the secret starts with "0s", base64 encoding is expected for the rest of the password. Example: 0sZGVmYXVsdA== Likewise, when the secret starts with "0x", hexadecimal encoding is expected for the rest of the password. Example: 0x64656661756c74 [sensitive,visible:auth_mode:=:psk,required:auth_mode:=:psk]
- name: required(string)
Example:
{
"ipsec_tunnel": {
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv1",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"local_subnet": "",
"remote_subnet": "",
"shared_secret": "default"
}
}
HTTP status code 200
The tunnel settings were updated.
Body
Media type: application/json
Type: object
Properties- ipsec_tunnel: required(object)
This object contains configuration information for an IPsec tunnel.
- id: required(string)
Database ID for this IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(string)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: required(integer)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean)
- dpd_action: (string)
Determines the action to perform on timeout.
- dpd_delay: (integer)
Defines the time interval between keep-alive exchanges sent to the peer.
- dpd_timeout: required(integer)
Defines the timeout period for a connection.
- phase1_rekey_time: (integer)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (string)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (string)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (string)
Determines the units for phase1_random_time.
- phase1_over_time: (integer)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (string)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (string)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (string)
Determines the units for phase2_random_time.
- phase2_life_time: (integer)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (string)
Determines the units for phase2_life_time.
- proposal: required(string)
Algorithm to be used for Key Exchange for establishing this tunnel
Annotations
- deprecatedProperty
{"since":"03/2021"}
- deprecatedProperty
- phase1_proposal: required(string)
Algorithms to be used for Key Exchange (Phase 1) for establishing this tunnel
- phase2_proposal: required(string)
Algorithms to be used for IPsec/Child SA (Phase 2) for this tunnel
- phase2_proposal_type: required(one of esp, ah)
IPsec/Child SA proposal type. ESP protocol or AH protocol can be selected
- local_id: required(string)
Local IKE identity to use for authentication.
- remote_id: required(string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address.
- encap: (boolean)
Force encapsulation
- local_subnet: required(string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: required(string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: required(one of psk, pki - default: psk)
Authentication type for this tunnel, 'psk' (Pre-Shared Key) or 'pki' (Public Key Infrastructure). If this field is not provided then 'psk' mode will be selected.
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required when auth_mode is set to 'psk'. [sensitive]
- runtime_status: required(object)
- established: required(boolean)
This value is reported as true when the tunnel has been negotiated successfully and is currently active.
- established: required(boolean)
- id: required(string)
Example:
{
"ipsec_tunnel": {
"id": "0",
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv1",
"keying_tries": 0,
"dpd_enabled": true,
"dpd_action": "restart",
"dpd_delay": 60,
"dpd_timeout": 90,
"phase1_rekey_time": 4,
"phase1_rekey_unit": "hours",
"phase1_reauth_time": 0,
"phase1_reauth_unit": "seconds",
"phase2_rekey_time": 1,
"phase2_rekey_unit": "hours",
"proposal": "default",
"phase1_proposal": "default",
"phase2_proposal": "default",
"phase2_proposal_type": "esp",
"local_id": "",
"remote_id": "",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "psk",
"shared_secret": "default",
"runtime_status": {
"established": false
}
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: tunnel id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
tunnel {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /ipsec_tunnels/{id}
Delete an IPsec tunnel on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Tunnel deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Tunnel did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec_tunnel with name or id 'system_net_ipsec-1'",
"args": {
"uuid": "system_net_ipsec-1"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/ipsec
Read and manipulate files that are used by IPsec tunnels using Public Key Infrastructure (PKI) for authentication.
An x509 bundle is a collection of certificates stored in PKCS12 format. This bundle removes the need to upload individual certificates.
Get a list of x509 bundles stored on the device.
Configure a new x509 bundle.
get /ipsec/x509_bundles
Get a list of x509 bundles stored on the device.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
The list of x509 bundles.
Body
Media type: application/json
Type: object
Properties- x509_bundles: required(array of object)
Items: items
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The base64 encoded binary content of the file.
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_bundles": [
{
"id": "system_net_ipsec_files_x509_bundles-1",
"name": "bundle_1.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCBmh3XIDOI0NuoYnqtWDVBA==",
"timestamp": "2021-05-31T22:57:25+00:00"
},
{
"id": "system_net_ipsec_files_x509_bundles-2",
"name": "bundle_2.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g==",
"timestamp": "2021-05-31T22:57:25+00:00"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec/x509_bundles
Configure a new x509 bundle.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- x509_bundle: required(object)
This object contains information for an IPsec bundle file which is encrypted with a password (default is None).
- name: required(string)
The file's name.
- content: required(string)
The base64 encoded binary content of the file. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- name: required(string)
Example:
{
"x509_bundle": {
"name": "bundle.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g=="
}
}
HTTP status code 201
The x509 bundle /{id} settings was updated.
Body
Media type: application/json
Type: object
Properties- x509_bundle: required(object)
This object contains information for an IPsec bundle file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The base64 encoded binary content of the file.
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_bundle": {
"id": "system_net_ipsec_files_x509_bundles-1",
"name": "bundle.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g==",
"timestamp": "2021-05-31T22:57:25+00:00"
}
}
HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema. Incomplete data: x509 bundle parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update a single configured x509 bundle.
Get a single configured x509 bundle by its ID.
Set the configuration for an existing x509 bundle.
Delete an x509 Bundle.
get /ipsec/x509_bundles/{id}
Get a single configured x509 bundle by its ID.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Get an x509 bundle.
Body
Media type: application/json
Type: object
Properties- x509_bundle: required(object)
This object contains information for an IPsec bundle file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The base64 encoded binary content of the file.
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_bundle": {
"id": "system_net_ipsec_files_x509_bundles-1",
"name": "bundle.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g==",
"timestamp": "2021-05-31T22:57:25+00:00"
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /ipsec/x509_bundles/{id}
Set the configuration for an existing x509 bundle.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- x509_bundle: required(object)
This object contains information for an IPsec bundle file which is encrypted with a password (default is None).
- name: required(string)
The file's name.
- content: required(string)
The base64 encoded binary content of the file. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- name: required(string)
Example:
{
"x509_bundle": {
"name": "bundle.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g=="
}
}
HTTP status code 200
The x509 bundle settings were updated.
Body
Media type: application/json
Type: object
Properties- x509_bundle: required(object)
This object contains information for an IPsec bundle file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The base64 encoded binary content of the file.
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_bundle": {
"id": "system_net_ipsec_files_x509_bundles-1",
"name": "bundle.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g==",
"timestamp": "2021-05-31T22:57:25+00:00"
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: x509_bundle parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
x509_bundle {id} does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /ipsec/x509_bundles/{id}
Delete an x509 Bundle.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
x509 bundle deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
x509 bundle did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec/x509_bundle with name or id 'x509_bundles-1000'",
"args": {
"uuid": "x509_bundles-1000"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Read, add, modify and delete Certificate Authority (CA) certificates used by IPsec tunnels using Public Key Infrastructure (PKI) for authentication
Get a list of all configured CA certificates
Configure a new CA certificate
get /ipsec/x509_ca_certificates
Get a list of all configured CA certificates
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_ca_certificates: required(array of object)
Items: items
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_ca_certificates": [
{
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_ca_certificates-1"
},
{
"name": "512b-rsa-example-request.der",
"content": "-----BEGIN CERTIFICATE----- MIIEFzCCAv+gAwIBAgIUETRacm1rXeNxAVKbjv1eKzV55KowDQYJKoZIhvcNAQEL BQAwgZoxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApRdWVlbnNsYW5kMREwDwYDVQQH DAhCcmlzYmFuZTEZMBcGA1UECgwQT3BlbmdlYXIgUHR5IEx0ZDENMAsGA1UECwwE TkdDUzEUMBIGA1UEAwwLRGF2aWQgQnVybnMxIzAhBgkqhkiG9w0BCQEWFGRhdmlk LmJ1cm5zQGRpZ2kuY29tMB4XDTIxMDUxMTAwMDY0OFoXDTIyMDUxMTAwMDY0OFow gZoxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApRdWVlbnNsYW5kMREwDwYDVQQHDAhC cmlzYmFuZTEZMBcGA1UECgwQT3BlbmdlYXIgUHR5IEx0ZDENMAsGA1UECwwETkdD UzEUMBIGA1UEAwwLRGF2aWQgQnVybnMxIzAhBgkqhkiG9w0BCQEWFGRhdmlkLmJ1 cm5zQGRpZ2kuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5LV/ qA57gwiDGHEw1wRKqpOuprPypX4giu3RBEzW6+nrlmK/08sgNOLHbjR8nQLfanGI hQHImGpW11hWNbI9na5XSYjbiAaGaasCfm67NQu+mdQrDAQ3q6LZ7s2afdex5XOw nzQvgbfvKdCKmeMll0DHe88u/FDi5FquFE2/NLqqFNx1WkDP/YFd8ZRWcyjSEcG6 IcKErsY6iZFW6ouoUXJlFB8FztYN8/+E4w96G7GGZTxDesDYUqQr0voeo7PK/njp 7GR8zINU7Msah0TWRPymUwCgCdJ6bMtWTEpCsCmtNpil4UombiNB+zFCayHpivfP EnP8M/XFt/UE9UPXAQIDAQABo1MwUTAdBgNVHQ4EFgQUQGvvNmeHR2GY2IJxxYHm mZilZh0wHwYDVR0jBBgwFoAUQGvvNmeHR2GY2IJxxYHmmZilZh0wDwYDVR0TAQH/ BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEARXJRnC623g3IgOPwftW4bWxAtghO jmlN/b9rn1Ka5hAJ2AlqJjeuIgDMd3cAXGsZ/LvqyTz4Z6ZDEg2uqsH5BXlUYt7Q 6SB6DYbnIxhw8PgDG5Je1TQerSJcOM87oMyO28ZiaDwQsjISML9BEK783FQ2mGj+ dXizJ5O2KonxJH9hkC2k0AI9YT7Xolb1CLQTqOsE4aYMQyU39Df3dFChOKeqBW8i HCMw+NKuKRJnW11lxIVS8YODx3kiGFroWBbfN99Wl9tCSoLmX2Myy9wflFOeIocE vo3lO39INFK+WdmP5z0YJ9U3I3Mowkvlu/KcvpZF+y7hVLmt67zOhXE/Kg== -----END CERTIFICATE-----",
"timestamp": "2021-03-12T20:43:39+00:00",
"id": "system_net_ipsec_x509_ca_certificate-2"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec/x509_ca_certificates
Configure a new CA certificate
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- x509_ca_certificate: required(object)
This object contains information for an IPsec x509 certificate file.
- name: required(string)
The file's name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_ca_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- x509_ca_certificate: required(object)
This object contains information for an IPsec x509 certificate file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_ca_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_ca_certificates-1"
}
}
HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update a single configured CA.
Get a single configured CA by it ID
Update a single configured CA
Delete a CA
get /ipsec/x509_ca_certificates/{id}
Get a single configured CA by it ID
URI Parameters
- id: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_ca_certificate: required(object)
This object contains information for an IPsec x509 certificate file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_ca_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_ca_certificates-3"
}
}
HTTP status code 404
CA did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec/x509_ca_certificate with name or id 'x509_ca_certificates-1000'",
"args": {
"uuid": "x509_ca_certificates-1000"
},
"level": 1
}
]
}
put /ipsec/x509_ca_certificates/{id}
Update a single configured CA
URI Parameters
- id: required(string)
Body
Media type: application/json
Type: object
Properties- x509_ca_certificate: required(object)
This object contains information for an IPsec x509 certificate file.
- name: required(string)
The file's name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_ca_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_ca_certificate: required(object)
This object contains information for an IPsec x509 certificate file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_ca_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_ca_certificates-5"
}
}
HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
HTTP status code 404
CA did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec/x509_ca_certificate with name or id 'x509_ca_certificate-1000'",
"args": {
"uuid": "x509_ca_certificate-1000"
},
"level": 1
}
]
}
delete /ipsec/x509_ca_certificates/{id}
Delete a CA
URI Parameters
- id: required(string)
HTTP status code 204
CA deleted
HTTP status code 404
CA did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec/x509_ca_certificate with name or id 'x509_ca_certificates-1000'",
"args": {
"uuid": "x509_ca_certificate-1000"
},
"level": 1
}
]
}
Read, add, modify and delete Certificate Revocation Lists for use by ipsec tunnels using Public Key Infrastucture (PKI) for authentication.
Get a list of all configured CRLs
Configure a new CRL file
get /ipsec/x509_crls
Get a list of all configured CRLs
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_crls: required(array of object)
Items: items
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_crls": [
{
"name": "512b-rsa-example-request.pem",
"content": "-----BEGIN X509 CRL----- MIIBtjCBnwIBATANBgkqhkiG9w0BAQsFADA6MQswCQYDVQQGEwJDSDETMBEGA1UE ChMKc3Ryb25nU3dhbjEWMBQGA1UEAxMNVHVubmVsIFBLSSBDQRcNMjEwNjA0MDYx MTU1WhcNMjEwNjE5MDYxMTU1WjAAoC8wLTAfBgNVHSMEGDAWgBTCsezxD76B2m0e vLTp+AX42Tw7lTAKBgNVHRQEAwIBATANBgkqhkiG9w0BAQsFAAOCAQEAkJvZSk3X cnf423IVzJC1kwM8lMZJfX8Duz+PyqjPEOGW5U2kBkJn6fStXRRh/LnyvNAABfpk /51Iz8IJTEPwlcLnFvLQqqqJDsmSlZC4V3VwctcMg77gQLAm5oD1ljgv8RGTtGgZ flu1oQjvOVst0lw8lktH0ijjEFPkTfLOb5iCRSlG7+rCPrHjnzo1S20MCB/zOSbF z0gVAmTPCA8PMvsqnnZsN+1j8dwmF4h0hqiKAoB95xaHnUmuudvaNEGAyg3D9rqE YzIVOh2Ec47fomPc6d9rWPMb/Jjz04gGHUTLtmQEY3l2LNcxaMAGXOU2eykxrF8L F5Qi0ZjK1rXcEg== -----END X509 CRL-----",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_crls-1"
},
{
"name": "512b-rsa-example-request.der",
"content": "MIIBBDCBrwIBADBKMQswCQYDVQQGEwJKUDEOMAwGA1UECAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANLADBIAkEAm/xmkHmEQrurE/0re/jeFRLl8ZPjBop7uLHhnia7lQG/5zDtZIUC3RVpqDSwBuw/NTweGyuP+o8AG98HxqxTBwIDAQABoAAwDQYJKoZIhvcNAQEFBQADQQByOV52Y17y8xw1V/xvru3rLPrVxYAXS5SgvNpfBsj38lNVtTvuH/MgroBgmjSpnqKqBiBDkoY2YUET2qmGjAu9Cg==",
"timestamp": "2021-03-12T20:43:39+00:00",
"id": "system_net_ipsec_files_x509_crls-2"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec/x509_crls
Configure a new CRL file
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- x509_crl: required(object)
This object contains information for an IPsec x509 certificate file.
- name: required(string)
The file's name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_crl": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- x509_crl: required(object)
This object contains information for an IPsec x509 certificate file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_crl": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_crls-3"
}
}
HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update a single configured CRL.
Get a single configured CRL by it ID
Update a single configured CRL
Delete a CRL
get /ipsec/x509_crls/{id}
Get a single configured CRL by it ID
URI Parameters
- id: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_crl: required(object)
This object contains information for an IPsec x509 certificate file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_crl": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_crls-1"
}
}
HTTP status code 404
CRL did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec/x509_crl with name or id 'x509_crls-1000'",
"args": {
"uuid": "x509_crls-1000"
},
"level": 1
}
]
}
put /ipsec/x509_crls/{id}
Update a single configured CRL
URI Parameters
- id: required(string)
Body
Media type: application/json
Type: object
Properties- x509_crl: required(object)
This object contains information for an IPsec x509 certificate file.
- name: required(string)
The file's name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_crl": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_crl: required(object)
This object contains information for an IPsec x509 certificate file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_crl": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_crls-2"
}
}
HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
HTTP status code 404
CRL did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec/x509_crl with name or id 'x509_crls-1000'",
"args": {
"uuid": "x509_crls-1000"
},
"level": 1
}
]
}
delete /ipsec/x509_crls/{id}
Delete a CRL
URI Parameters
- id: required(string)
Read, add, modify and delete private keys.
Get a list of the configured private keys.
Configure a new private key.
get /ipsec/private_keys
Get a list of the configured private keys.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- private_keys: required(array of object)
Items: items
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- id: required(string)
Example:
{
"private_keys": [
{
"id": "system_net_ipsec_files_private_keys-1",
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword",
"timestamp": "2021-03-12T20:43:39+00:00"
},
{
"id": "system_net_ipsec_files_private_keys-2",
"name": "512b-rsa-example-key.pem",
"content": "-----BEGIN RSA PRIVATE KEY----- MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSF At0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOr QA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DS kQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce 7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0J BO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCN A24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Yw== -----END RSA PRIVATE KEY-----",
"timestamp": "2021-03-12T20:43:39+00:00"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec/private_keys
Configure a new private key.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- private_key: required(object)
This object contains information for an IPsec private key file that may be encrypted with a password.
- name: required(string)
The file's name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- name: required(string)
Example:
{
"private_key": {
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword"
}
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- private_key: required(object)
This object contains information for an IPsec private key file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- id: required(string)
Example:
{
"private_key": {
"id": "system_net_ipsec_files_private_keys-1",
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword",
"timestamp": "2021-03-12T20:43:39+00:00"
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: private key parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update a single configured private key.
Get a single configured private key by its ID.
Update a single configured private key.
Delete a private key.
get /ipsec/private_keys/{id}
Get a single configured private key by its ID.
URI Parameters
- id: required(string)
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- private_key: required(object)
This object contains information for an IPsec private key file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- id: required(string)
Example:
{
"private_key": {
"id": "system_net_ipsec_files_private_keys-1",
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword",
"timestamp": "2021-03-12T20:43:39+00:00"
}
}
put /ipsec/private_keys/{id}
Update a single configured private key.
URI Parameters
- id: required(string)
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- private_key: required(object)
This object contains information for an IPsec private key file that may be encrypted with a password.
- name: required(string)
The file's name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- name: required(string)
Example:
{
"private_key": {
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword"
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- private_key: required(object)
This object contains information for an IPsec private key file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- id: required(string)
Example:
{
"private_key": {
"id": "system_net_ipsec_files_private_keys-1",
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword",
"timestamp": "2021-03-12T20:43:39+00:00"
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: Private key parameter missing.
HTTP status code 404
Private key {id} does not exist.
delete /ipsec/private_keys/{id}
Delete a private key.
URI Parameters
- id: required(string)
HTTP status code 204
Private key deleted..
HTTP status code 404
Private key did not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec/private_key with name or id 'private_keys-1000'",
"args": {
"uuid": "private_keys-1000"
},
"level": 1
}
]
}
Read, add, modify and delete x509 certificates (also known as Entity Certificates).
Get a list of the configured x509 certificates.
Configure a new x509 certificate.
get /ipsec/x509_certificates
Get a list of the configured x509 certificates.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_certificates: required(array of object)
Items: items
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_certificates": [
{
"id": "system_net_ipsec_files_x509_certificates-1",
"name": "512b-rsa-example-cert-base64.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUNFakNDQVhzQ0FnMzZNQTBHQ1NxR1NJYjNEUUVCQlFVQU1JR2JNUXN3Q1FZRFZRUUdFd0pLVURFT01Bd0cKQTFVRUNCTUZWRzlyZVc4eEVEQU9CZ05WQkFjVEIwTm9kVzh0YTNVeEVUQVBCZ05WQkFvVENFWnlZVzVyTkVSRQpNUmd3RmdZRFZRUUxFdzlYWldKRFpYSjBJRk4xY0hCdmNuUXhHREFXQmdOVkJBTVREMFp5WVc1ck5FUkVJRmRsCllpQkRRVEVqTUNFR0NTcUdTSWIzRFFFSkFSWVVjM1Z3Y0c5eWRFQm1jbUZ1YXpSa1pDNWpiMjB3SGhjTk1USXcKT0RJeU1EVXlOalUwV2hjTk1UY3dPREl4TURVeU5qVTBXakJLTVFzd0NRWURWUVFHRXdKS1VERU9NQXdHQTFVRQpDQXdGVkc5cmVXOHhFVEFQQmdOVkJBb01DRVp5WVc1ck5FUkVNUmd3RmdZRFZRUUREQTkzZDNjdVpYaGhiWEJzClpTNWpiMjB3WERBTkJna3Foa2lHOXcwQkFRRUZBQU5MQURCSUFrRUFtL3hta0htRVFydXJFLzByZS9qZUZSTGwKOFpQakJvcDd1TEhobmlhN2xRRy81ekR0WklVQzNSVnBxRFN3QnV3L05Ud2VHeXVQK284QUc5OEh4cXhUQndJRApBUUFCTUEwR0NTcUdTSWIzRFFFQkJRVUFBNEdCQUJTMlRMdUJlVFBtY2FUYVVXL0xDQjJOWU95OEdNZHpSMW14CjhpQkl1Mkg2L0UydGlZM1JJZXZWMk9XNjFxWTIvWFJRZzdZUHh4M2ZmZVV1Z1g5RjRKL2lQbm51MXpBeHh5QnkKMlZndUt2NFNXalJGb1JrSWZJbEhYMHFWdmlNaFNsTnkyaW9GTHk3SmNQWmIrdjNmdERHeXdVcWNCaVZEb2VhMApIbitHbXhaQQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==",
"timestamp": "2021-03-12T20:43:39+00:00"
},
{
"id": "system_net_ipsec_files_x509_certificates-2",
"name": "512b-rsa-example-cert-base64.der",
"content": "MIICEjCCAXsCAg36MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwGA1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNEREMRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdlYiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIwODIyMDUyNjU0WhcNMTcwODIxMDUyNjU0WjBKMQswCQYDVQQGEwJKUDEOMAwGA1UECAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANLADBIAkEAm/xmkHmEQrurE/0re/jeFRLl8ZPjBop7uLHhnia7lQG/5zDtZIUC3RVpqDSwBuw/NTweGyuP+o8AG98HxqxTBwIDAQABMA0GCSqGSIb3DQEBBQUAA4GBABS2TLuBeTPmcaTaUW/LCB2NYOy8GMdzR1mx8iBIu2H6/E2tiY3RIevV2OW61qY2/XRQg7YPxx3ffeUugX9F4J/iPnnu1zAxxyBy2VguKv4SWjRFoRkIfIlHX0qVviMhSlNy2ioFLy7JcPZb+v3ftDGywUqcBiVDoea0Hn+GmxZACg==",
"timestamp": "2021-03-12T20:43:39+00:00"
},
{
"id": "system_net_ipsec_files_x509_certificates-3",
"name": "512b-rsa-example-cert.pem",
"content": "-----BEGIN CERTIFICATE----- MIICEjCCAXsCAg36MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw ODIyMDUyNjU0WhcNMTcwODIxMDUyNjU0WjBKMQswCQYDVQQGEwJKUDEOMAwGA1UE CAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBs ZS5jb20wXDANBgkqhkiG9w0BAQEFAANLADBIAkEAm/xmkHmEQrurE/0re/jeFRLl 8ZPjBop7uLHhnia7lQG/5zDtZIUC3RVpqDSwBuw/NTweGyuP+o8AG98HxqxTBwID AQABMA0GCSqGSIb3DQEBBQUAA4GBABS2TLuBeTPmcaTaUW/LCB2NYOy8GMdzR1mx 8iBIu2H6/E2tiY3RIevV2OW61qY2/XRQg7YPxx3ffeUugX9F4J/iPnnu1zAxxyBy 2VguKv4SWjRFoRkIfIlHX0qVviMhSlNy2ioFLy7JcPZb+v3ftDGywUqcBiVDoea0 Hn+GmxZA -----END CERTIFICATE-----",
"timestamp": "2021-03-12T20:43:39+00:00"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec/x509_certificates
Configure a new x509 certificate.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- x509_certificate: required(object)
This object contains information for an IPsec x509 certificate file.
- name: required(string)
The file's name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- x509_certificate: required(object)
This object contains information for an IPsec x509 certificate file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_certificate": {
"id": "system_net_ipsec_files_x509_certificates-1",
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00"
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: x509 certificate parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or udpate a single configured x509 certificate.
Get a single configured x509 certificate by its ID.
Update a single configured x509 certificate.
Delete an x509 certificate.
get /ipsec/x509_certificates/{id}
Get a single configured x509 certificate by its ID.
URI Parameters
- id: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_certificate: required(object)
This object contains information for an IPsec x509 certificate file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_certificate": {
"id": "system_net_ipsec_files_x509_certificates-1",
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00"
}
}
put /ipsec/x509_certificates/{id}
Update a single configured x509 certificate.
URI Parameters
- id: required(string)
Body
Media type: application/json
Type: object
Properties- x509_certificate: required(object)
This object contains information for an IPsec x509 certificate file.
- name: required(string)
The file's name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_certificate: required(object)
This object contains information for an IPsec x509 certificate file.
- id: required(string)
Database ID for this file.
- name: required(string)
The name of the file. This should contain the file extension.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The last time the file was updated. This will be returned in rfc3339 format.
- id: required(string)
Example:
{
"x509_certificate": {
"id": "system_net_ipsec_files_x509_certificates-1",
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00"
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: X509 certificate parameter missing.
HTTP status code 404
X509 Certificate {id} does not exist.
delete /ipsec/x509_certificates/{id}
Delete an x509 certificate.
URI Parameters
- id: required(string)
HTTP status code 204
X509 certificate deleted.
HTTP status code 404
X509 certificate did not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec/x509_certificate with name or id 'x509_certificates-1000'",
"args": {
"uuid": "x509_certificates-1000"
},
"level": 1
}
]
}
/pdus
Configure, monitor and control PDUs connected to the device.
Get a list of all configured PDUs.
Add a new PDU.
get /pdus
Get a list of all configured PDUs.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pdus: required(array of object)
Items: items
- name: required(string)
A unique user specified name for the PDU.
- driver: required(object)
The driver to use to control and monitor the PDU.
- id: required(string)
The identifier of the PDU driver to use. [computed_options:driver_list]
- name: (string)
The name of the PDU driver. [visible:never,required:never]
- id: required(string)
- method: required(one of powerman, shell, snmp)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- id: required(string)
The unique id of the PDU.
- outlet_count: (integer)
The number of outlets on the PDU.
- powerman: (object)
The configuration for the powerman PDU method. [visible:method:=:powerman]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- id: required(string)
The unique identifier of this serial PDU configuration.
- username: (string)
- shell: (object)
The configuration for the shell PDU method. [visible:method:=:shell]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- id: required(string)
The unique identifier of this serial PDU configuration.
- username: (string)
- snmp: (object)
The configuration for the SNMP PDU method. [visible:method:=:snmp]
- protocol: required(one of UDP, TCP - default: UDP)
The protocol that is used to access this PDU via SNMP. The default protocol is UDP.
- address: required(string)
The network address of this PDU to be accessed via SNMP.
- port: (integer - minimum: 1 - maximum: 65535)
The port to be used to access this PDU via SNMP.
- version: required(one of 1, 2c, 3)
The version of SNMP used to access this PDU.
- community: (string)
The community string used to access this PDU via SNMP. [visible:version:in:1|2c,required:version:in:1|2c]
- auth_protocol: (one of SHA, MD5)
The authentication protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The authentication password to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- security_name: (string)
The security name used to access this PDU via SNMPv3. [visible:version:=:3,required:version:=:3]
- engine_id: (string)
The unique identifier string of the SNMP agent of this PDU. [visible:version:=:3]
- privacy_protocol: (one of AES, DES)
The privacy protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:=:authPriv]
- privacy_password: (string)
The privacy password used to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv - default: authPriv)
The security level to access this PDU via SNMPv3. [visible:version:=:3]
- id: required(string)
The unique identifier for this SNMP PDU.
- protocol: required(one of UDP, TCP - default: UDP)
- outlets: (array of object)
The list of power outlets controlled by this PDU.
Items: items
- number: required(integer)
The outlet number of this PDU. (read only)
- name: (string)
The name associated with this PDU outlet.
- port: (string)
The serial port ID that is associated with this PDU outlet. [computed_options:port_consoleservers_all]
- status: (string)
[visible:never]
- status_timestamp: (string)
[visible:never]
- last_action: (string)
[visible:never]
- last_action_timestamp: (string)
[visible:never]
- id: required(string)
The unique identifier for the PDU outlet.
- number: required(integer)
- name: required(string)
Example:
{
"pdus": [
{
"id": "pdus-1",
"name": "ServerTech PDU",
"driver": {
"id": "servertech",
"name": "Servertech driver"
},
"monitor": true,
"method": "snmp",
"outlet_count": 2,
"outlets": [
{
"id": "outlets-1",
"number": 1,
"name": "servertech outlet 1",
"port": "serial/by-opengear-id/port07",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "on",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
},
{
"id": "outlets-2",
"number": 2,
"name": "servertech outlet 2",
"port": "serial/by-opengear-id/port08",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "off",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
}
],
"snmp": {
"id": "snmp-1",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"engine_id": "0x80001f8803555000000000",
"version": "3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"address": "snmp.example.com",
"port": 167
}
},
{
"id": "pdus-2",
"name": "apc PDU",
"driver": {
"id": "apcpdu4",
"name": "APC 24 Port (AP7998) PDU"
},
"monitor": true,
"method": "powerman",
"outlet_count": 2,
"outlets": [
{
"id": "outlets-3",
"number": 1,
"name": "apc outlet 1",
"port": "serial/by-opengear-id/port08",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "on",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
},
{
"id": "outlets-4",
"number": 2,
"name": "apc outlet 2",
"port": "serial/by-opengear-id/port09",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "off",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
}
],
"powerman": {
"id": "powerman-1",
"username": "admin",
"password": "password",
"port": "serial/by-opengear-id/port01"
}
},
{
"id": "pdus-2",
"name": "shell PDU",
"monitor": true,
"driver": {
"id": "apc_pdu",
"name": "APC PDU"
},
"method": "shell",
"outlet_count": 2,
"outlets": [
{
"id": "outlets-5",
"number": 1,
"name": "shell outlet 1",
"port": "serial/by-opengear-id/port03",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "on",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
},
{
"id": "outlets-4",
"number": 2,
"name": "shell outlet 2",
"port": "serial/by-opengear-id/port04",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "off",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
}
],
"shell": {
"id": "shell-1",
"username": "admin",
"password": "password",
"port": "serial/by-opengear-id/port02"
}
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /pdus
Add a new PDU.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- pdu: required(object)
- name: required(string)
A unique user specified name for the PDU.
- driver: required(object)
"The driver to use to control and monitor the PDU." [visible:method:in:powerman|shell|snmp]
- id: required(string)
The identifier of the PDU driver to use. [computed_options:driver_list]
- name: (string)
The name of the PDU driver. [visible:never,required:never]
- id: required(string)
- method: required(one of powerman, shell, snmp)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- powerman: (object)
The configuration for the powerman PDU method. [visible:method:=:powerman]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- username: (string)
- shell: (object)
The configuration for the shell PDU method. [visible:method:=:shell]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- username: (string)
- snmp: (object)
The configuration for the SNMP PDU method. [visible:method:=:snmp]
- protocol: required(one of UDP, TCP - default: UDP)
The protocol that is used to access this PDU via SNMP. The default protocol is UDP.
- address: required(string)
The network address of this PDU to be accessed via SNMP.
- port: (integer - minimum: 1 - maximum: 65535)
The port to be used to access this PDU via SNMP.
- version: required(one of 1, 2c, 3)
The version of SNMP used to access this PDU.
- community: (string)
The community string used to access this PDU via SNMP. [visible:version:in:1|2c,required:version:in:1|2c]
- auth_protocol: (one of SHA, MD5)
The authentication protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The authentication password to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- security_name: (string)
The security name used to access this PDU via SNMPv3. [visible:version:=:3,required:version:=:3]
- engine_id: (string)
The unique identifier string of the SNMP agent of this PDU. [visible:version:=:3]
- privacy_protocol: (one of AES, DES)
The privacy protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:=:authPriv]
- privacy_password: (string)
The privacy password used to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv - default: authPriv)
The security level to access this PDU via SNMPv3. [visible:version:=:3]
- protocol: required(one of UDP, TCP - default: UDP)
- outlets: (array of object)
The list of power outlets controlled by this PDU.
Items: items
- number: required(integer)
The outlet number of this PDU. (read only)
- name: (string)
The name associated with this PDU outlet.
- port: (string)
The serial port ID that is associated with this PDU outlet. [computed_options:port_consoleservers_all]
- status: (string)
[visible:never]
- status_timestamp: (string)
[visible:never]
- last_action: (string)
[visible:never]
- last_action_timestamp: (string)
[visible:never]
- number: required(integer)
- name: required(string)
Example:
{
"pdu": {
"name": "example",
"driver": {
"id": "apc24",
"name": "apc_24_port_(ap7998)"
},
"monitor": true,
"method": "powerman",
"powerman": {
"username": "user1",
"password": "password",
"port": "serial/by-opengear-id/port01"
}
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pdu: required(object)
Get a PDU specified by ID.
- name: required(string)
A unique user specified name for the PDU.
- driver: required(object)
The driver to use to control and monitor the PDU.
- id: required(string)
The identifier of the PDU driver to use. [computed_options:driver_list]
- name: (string)
The name of the PDU driver. [visible:never,required:never]
- id: required(string)
- method: required(one of powerman, shell, snmp)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- id: required(string)
The unique id of the PDU.
- outlet_count: (integer)
The number of outlets on the PDU.
- powerman: (object)
The configuration for the powerman PDU method. [visible:method:=:powerman]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- id: required(string)
The unique identifier of this serial PDU configuration.
- username: (string)
- shell: (object)
The configuration for the shell PDU method. [visible:method:=:shell]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- id: required(string)
The unique identifier of this serial PDU configuration.
- username: (string)
- snmp: (object)
The configuration for the SNMP PDU method. [visible:method:=:snmp]
- protocol: required(one of UDP, TCP - default: UDP)
The protocol that is used to access this PDU via SNMP. The default protocol is UDP.
- address: required(string)
The network address of this PDU to be accessed via SNMP.
- port: (integer - minimum: 1 - maximum: 65535)
The port to be used to access this PDU via SNMP.
- version: required(one of 1, 2c, 3)
The version of SNMP used to access this PDU.
- community: (string)
The community string used to access this PDU via SNMP. [visible:version:in:1|2c,required:version:in:1|2c]
- auth_protocol: (one of SHA, MD5)
The authentication protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The authentication password to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- security_name: (string)
The security name used to access this PDU via SNMPv3. [visible:version:=:3,required:version:=:3]
- engine_id: (string)
The unique identifier string of the SNMP agent of this PDU. [visible:version:=:3]
- privacy_protocol: (one of AES, DES)
The privacy protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:=:authPriv]
- privacy_password: (string)
The privacy password used to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv - default: authPriv)
The security level to access this PDU via SNMPv3. [visible:version:=:3]
- id: required(string)
The unique identifier for this SNMP PDU.
- protocol: required(one of UDP, TCP - default: UDP)
- outlets: (array of object)
The list of power outlets controlled by this PDU.
Items: items
- number: required(integer)
The outlet number of this PDU. (read only)
- name: (string)
The name associated with this PDU outlet.
- port: (string)
The serial port ID that is associated with this PDU outlet. [computed_options:port_consoleservers_all]
- status: (string)
[visible:never]
- status_timestamp: (string)
[visible:never]
- last_action: (string)
[visible:never]
- last_action_timestamp: (string)
[visible:never]
- id: required(string)
The unique identifier for the PDU outlet.
- number: required(integer)
- name: required(string)
Example:
{
"pdu": {
"id": "pdus-1",
"name": "example",
"driver": {
"id": "apc_24_port_(ap7998)",
"name": "APC 24 port - AP7998"
},
"monitor": true,
"method": "powerman",
"powerman": {
"id": "powerman-1",
"username": "user1",
"password": "password",
"port": "serial/by-opengear-id/port01"
},
"outlets": [
{
"id": "outlets-1",
"number": 1,
"name": "shell outlet 1",
"port": "serial/by-opengear-id/port03",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "on",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
},
{
"id": "outlets-2",
"number": 2,
"name": "shell outlet 2",
"port": "serial/by-opengear-id/port04",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00"
}
]
}
}
HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update a specific PDU.
Get a PDU by id.
Update an existing PDU.
Delete a PDU.
get /pdus/{id}
Get a PDU by id.
URI Parameters
- id: required(string)
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pdu: required(object)
Get a PDU specified by ID.
- name: required(string)
A unique user specified name for the PDU.
- driver: required(object)
The driver to use to control and monitor the PDU.
- id: required(string)
The identifier of the PDU driver to use. [computed_options:driver_list]
- name: (string)
The name of the PDU driver. [visible:never,required:never]
- id: required(string)
- method: required(one of powerman, shell, snmp)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- id: required(string)
The unique id of the PDU.
- outlet_count: (integer)
The number of outlets on the PDU.
- powerman: (object)
The configuration for the powerman PDU method. [visible:method:=:powerman]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- id: required(string)
The unique identifier of this serial PDU configuration.
- username: (string)
- shell: (object)
The configuration for the shell PDU method. [visible:method:=:shell]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- id: required(string)
The unique identifier of this serial PDU configuration.
- username: (string)
- snmp: (object)
The configuration for the SNMP PDU method. [visible:method:=:snmp]
- protocol: required(one of UDP, TCP - default: UDP)
The protocol that is used to access this PDU via SNMP. The default protocol is UDP.
- address: required(string)
The network address of this PDU to be accessed via SNMP.
- port: (integer - minimum: 1 - maximum: 65535)
The port to be used to access this PDU via SNMP.
- version: required(one of 1, 2c, 3)
The version of SNMP used to access this PDU.
- community: (string)
The community string used to access this PDU via SNMP. [visible:version:in:1|2c,required:version:in:1|2c]
- auth_protocol: (one of SHA, MD5)
The authentication protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The authentication password to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- security_name: (string)
The security name used to access this PDU via SNMPv3. [visible:version:=:3,required:version:=:3]
- engine_id: (string)
The unique identifier string of the SNMP agent of this PDU. [visible:version:=:3]
- privacy_protocol: (one of AES, DES)
The privacy protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:=:authPriv]
- privacy_password: (string)
The privacy password used to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv - default: authPriv)
The security level to access this PDU via SNMPv3. [visible:version:=:3]
- id: required(string)
The unique identifier for this SNMP PDU.
- protocol: required(one of UDP, TCP - default: UDP)
- outlets: (array of object)
The list of power outlets controlled by this PDU.
Items: items
- number: required(integer)
The outlet number of this PDU. (read only)
- name: (string)
The name associated with this PDU outlet.
- port: (string)
The serial port ID that is associated with this PDU outlet. [computed_options:port_consoleservers_all]
- status: (string)
[visible:never]
- status_timestamp: (string)
[visible:never]
- last_action: (string)
[visible:never]
- last_action_timestamp: (string)
[visible:never]
- id: required(string)
The unique identifier for the PDU outlet.
- number: required(integer)
- name: required(string)
Example:
{
"pdu": {
"id": "pdus-1",
"name": "ServerTech PDU",
"driver": {
"id": "servertech",
"name": "Servertech PDU"
},
"monitor": true,
"method": "snmp",
"outlet_count": 2,
"outlets": [
{
"id": "outlets-1",
"number": 1,
"name": "servertech outlet 1",
"port": "serial/by-opengear-id/port07",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "on",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
},
{
"id": "outlets-2",
"number": 2,
"name": "servertech outlet 2",
"port": "serial/by-opengear-id/port08",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "off",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
}
],
"snmp": {
"id": "snmp-1",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"engine_id": "0x80001f8803555000000000",
"version": "3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"address": "snmp.example.com",
"port": 167
}
}
}
HTTP status code 404
No PDU found with that ID.
put /pdus/{id}
Update an existing PDU.
URI Parameters
- id: required(string)
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- pdu: required(object)
- name: required(string)
A unique user specified name for the PDU.
- driver: required(object)
"The driver to use to control and monitor the PDU." [visible:method:in:powerman|shell|snmp]
- id: required(string)
The identifier of the PDU driver to use. [computed_options:driver_list]
- name: (string)
The name of the PDU driver. [visible:never,required:never]
- id: required(string)
- method: required(one of powerman, shell, snmp)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- powerman: (object)
The configuration for the powerman PDU method. [visible:method:=:powerman]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- username: (string)
- shell: (object)
The configuration for the shell PDU method. [visible:method:=:shell]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- username: (string)
- snmp: (object)
The configuration for the SNMP PDU method. [visible:method:=:snmp]
- protocol: required(one of UDP, TCP - default: UDP)
The protocol that is used to access this PDU via SNMP. The default protocol is UDP.
- address: required(string)
The network address of this PDU to be accessed via SNMP.
- port: (integer - minimum: 1 - maximum: 65535)
The port to be used to access this PDU via SNMP.
- version: required(one of 1, 2c, 3)
The version of SNMP used to access this PDU.
- community: (string)
The community string used to access this PDU via SNMP. [visible:version:in:1|2c,required:version:in:1|2c]
- auth_protocol: (one of SHA, MD5)
The authentication protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The authentication password to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- security_name: (string)
The security name used to access this PDU via SNMPv3. [visible:version:=:3,required:version:=:3]
- engine_id: (string)
The unique identifier string of the SNMP agent of this PDU. [visible:version:=:3]
- privacy_protocol: (one of AES, DES)
The privacy protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:=:authPriv]
- privacy_password: (string)
The privacy password used to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv - default: authPriv)
The security level to access this PDU via SNMPv3. [visible:version:=:3]
- protocol: required(one of UDP, TCP - default: UDP)
- outlets: (array of object)
The list of power outlets controlled by this PDU.
Items: items
- number: required(integer)
The outlet number of this PDU. (read only)
- name: (string)
The name associated with this PDU outlet.
- port: (string)
The serial port ID that is associated with this PDU outlet. [computed_options:port_consoleservers_all]
- status: (string)
[visible:never]
- status_timestamp: (string)
[visible:never]
- last_action: (string)
[visible:never]
- last_action_timestamp: (string)
[visible:never]
- number: required(integer)
- name: required(string)
Example:
{
"pdu": {
"name": "example",
"driver": {
"id": "apc24",
"name": "apc_24_port_(ap7998)"
},
"monitor": true,
"method": "powerman",
"powerman": {
"username": "user1",
"password": "password",
"port": "serial/by-opengear-id/port01"
}
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pdu: required(object)
Get a PDU specified by ID.
- name: required(string)
A unique user specified name for the PDU.
- driver: required(object)
The driver to use to control and monitor the PDU.
- id: required(string)
The identifier of the PDU driver to use. [computed_options:driver_list]
- name: (string)
The name of the PDU driver. [visible:never,required:never]
- id: required(string)
- method: required(one of powerman, shell, snmp)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- id: required(string)
The unique id of the PDU.
- outlet_count: (integer)
The number of outlets on the PDU.
- powerman: (object)
The configuration for the powerman PDU method. [visible:method:=:powerman]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- id: required(string)
The unique identifier of this serial PDU configuration.
- username: (string)
- shell: (object)
The configuration for the shell PDU method. [visible:method:=:shell]
- username: (string)
The user account on the PDU that will be used for access over serial connection.
- password: (string)
The password to be used to access this PDU over serial connection. [sensitive]
- port: required(string)
The port ID that is associated with this PDU. [computed_options:port_consoleservers_all]
- id: required(string)
The unique identifier of this serial PDU configuration.
- username: (string)
- snmp: (object)
The configuration for the SNMP PDU method. [visible:method:=:snmp]
- protocol: required(one of UDP, TCP - default: UDP)
The protocol that is used to access this PDU via SNMP. The default protocol is UDP.
- address: required(string)
The network address of this PDU to be accessed via SNMP.
- port: (integer - minimum: 1 - maximum: 65535)
The port to be used to access this PDU via SNMP.
- version: required(one of 1, 2c, 3)
The version of SNMP used to access this PDU.
- community: (string)
The community string used to access this PDU via SNMP. [visible:version:in:1|2c,required:version:in:1|2c]
- auth_protocol: (one of SHA, MD5)
The authentication protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- auth_password: (string)
The authentication password to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:in:authNoPriv|authPriv]
- security_name: (string)
The security name used to access this PDU via SNMPv3. [visible:version:=:3,required:version:=:3]
- engine_id: (string)
The unique identifier string of the SNMP agent of this PDU. [visible:version:=:3]
- privacy_protocol: (one of AES, DES)
The privacy protocol used to access this PDU via SNMPv3. [visible:version:=:3,visible:security_level:=:authPriv]
- privacy_password: (string)
The privacy password used to access this PDU via SNMPv3. [sensitive,visible:version:=:3,visible:security_level:=:authPriv]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv - default: authPriv)
The security level to access this PDU via SNMPv3. [visible:version:=:3]
- id: required(string)
The unique identifier for this SNMP PDU.
- protocol: required(one of UDP, TCP - default: UDP)
- outlets: (array of object)
The list of power outlets controlled by this PDU.
Items: items
- number: required(integer)
The outlet number of this PDU. (read only)
- name: (string)
The name associated with this PDU outlet.
- port: (string)
The serial port ID that is associated with this PDU outlet. [computed_options:port_consoleservers_all]
- status: (string)
[visible:never]
- status_timestamp: (string)
[visible:never]
- last_action: (string)
[visible:never]
- last_action_timestamp: (string)
[visible:never]
- id: required(string)
The unique identifier for the PDU outlet.
- number: required(integer)
- name: required(string)
Example:
{
"pdu": {
"id": "pdu-1",
"name": "example",
"driver": {
"id": "apc_24_port_(ap7998)",
"name": "APC 24 port - AP7998"
},
"monitor": true,
"method": "powerman",
"powerman": {
"id": "powerman-1",
"username": "user1",
"password": "passwords",
"port": "serial/by-opengear-id/port01"
},
"outlets": [
{
"id": "outlets-1",
"number": 1,
"name": "shell outlet 1\"",
"port": "serial/by-opengear-id/port03",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00"
},
{
"id": "outlets-2",
"number": 2,
"name": "shell outlet 2\"",
"port": "serial/by-opengear-id/port04",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00"
}
]
}
}
HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema. Incomplete data: PDU id parameter missing.
HTTP status code 404
PDU did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find pdu with name or id 'pdu-1'",
"args": {
"uuid": "pdu-1"
},
"level": 1
}
]
}
delete /pdus/{id}
Delete a PDU.
Read PDU driver list
Get a list of the PDU drivers. [visible:never]
get /pdus/drivers
Get a list of the PDU drivers. [visible:never]
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- driver_list: required(object)
Example:
{
"driver_list": {
"powerman_list": [
{
"id": "apcpdu4",
"name": "APC 24 Port (AP7998) PDU"
},
{
"id": "apcpdu",
"name": "APC 24 Port Switched Rack PDU (APPv2.6.5/AOSv2.6.4)"
},
{
"id": "apcpdu3",
"name": "APC 24 Port Switched Rack PDU (APPv3.3.3/AOSv3.4.4)"
}
],
"shell_list": [
{
"id": "apc_pdu",
"name": "APC PDU"
},
{
"id": "apc_pdu_ap8953_ap8959_(appv6.4.6-aosv6.4.6)",
"name": "APC PDU AP8953 AP8959 (APPv6.4.6/AOSv6.4.6)"
},
{
"id": "apc_pdu_ap8959_(appv5.1.6-aosv5.1.9)",
"name": "APC PDU AP8959 (APPv5.1.6/AOSv5.1.9)"
}
],
"snmp_list": [
{
"id": "apc",
"name": "SNMP Controlled APC PDU"
},
{
"id": "avocent",
"name": "SNMP Controlled Avocent PDU"
}
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/auto_response
Read and manipulate information pertaining to the Auto-Response system running on the NetOps Console Server appliance.
Read and manipulate the Auto-Response beacons on the NetOps Console Server appliance.
Get a list of the Auto-Response Beacons.
Add a new Auto-Response beacon to the NetOps Console Server appliance.
Bulk delete a list of beacons defined for the NetOps Console Server appliance.
get /auto_response/beacons
Get a list of the Auto-Response Beacons.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- beacons: required(array of object)
Items: items
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: required(boolean)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
The Playbook will be triggered if the cellular signal strength moves below the given threshold [visible:module:=:cell_signal_strength,required:module:=:cell_signal_strength]
- threshold: required(number - minimum: 0 - maximum: 99)
- on_change_only: required(boolean)
- emit_at_startup: required(boolean)
- cell_message: (object)
The Playbook will be triggered when an SMS message that matches the message pattern is received from any of the configured phone numbers. [visible:module:=:cell_message,required:module:=:cell_message]
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
Periodically attempts to perform a HTTP request using curl and triggers the Playbook based on the results [visible:module:=:curl,required:module:=:curl]
- urls: required(array of any)
- request: required(string)
- on_change_only: required(boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
Periodically run a custom command and trigger the Playbook on failure. [visible:module:=:custom_cmd]
- shell_command: required(string)
- timeout: required(number)
- load: (object)
Monitors the system load average and triggers the Playbook if it breaches the acceptable range in any period [visible:module:=:load]
- one_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- five_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- fifteen_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- emit_at_startup: required(boolean)
- on_change_only: required(boolean)
- one_minute: required(object)
- mem: (object)
The Playbook is triggered if the system memory usage exceeds the given threshold [visible:module:=:mem]
- percent: required(number - minimum: 0 - maximum: 100)
- on_change_only: required(boolean)
- network: (object)
Monitor network interfaces for specific attributes and trigger when they change [visible:module:=:network]
- coalesce: required(string)
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID [computed_options:physif_no_master]
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- ping: (object)
Periodically ping an address and trigger on failure [visible:module:=:ping]
- interface: required(string)
"Reference to a physif ID" [computed_options:physif_no_master|physifs_no_loopbacks]
- destination: required(string)
- on_change_only: required(boolean)
- interface: required(string)
- serial_login: (object)
Monitor the serial ports and trigger on user login and logout events [visible:module:=:serial_login]
- check_login: required(boolean - default: true)
- check_logout: required(boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
Monitor the given serial ports and trigger when signals are changed [visible:module:=:serial_signal]
- ports: required(array of string)
- signals: required(array of string)
- serial_patterns: (array of object)
Monitor the serial ports and trigger when data matching a pattern is received on specific ports [visible:module:=:serial_pattern]
Items: items
- pattern: required(string)
- disconnect: required(boolean - default: false)
- trigger_rx: required(boolean - default: true)
- trigger_tx: required(boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
Monitor the terminal and trigger on user login and logout events. [visible:module:=:wtmp]
- login: required(boolean)
- logout: required(boolean)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
[reference:auto_response/reaction:name]
- resolution_values: (array of string)
[visible:parent.module:in:cell_signal_strength|curl|custom_cmd|ping,required:parent.module:in:cell_signal_strength|curl|custom_cmd|ping]
- action: required(string)
- dependant_keys_any: (array of any)
"A list of keys that are or'd to determine the Auto-Response Beacon state" [visible:never]
- dependant_keys_all: (array of any)
"A list of keys that are and'd to determine the Auto-Response Beacon state" [visible:never]
- id: required(string)
- meta: required(object)
- total_pages: (string)
Example:
{
"beacons": [
{
"id": "0",
"name": "wtmp-beacon",
"description": "Description for the wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [],
"dependant_keys_any": [],
"dependant_keys_all": []
},
{
"id": "1",
"name": "custom-beacon",
"module": "custom_cmd",
"interval": 60,
"enable": true,
"custom_cmd": {
"shell_command": "/usr/bin/top -n 5 | grep ssh",
"timeout": 5
},
"actions": [
{
"action": "auto_response_reactions-7",
"resolution_values": [
"trigger",
"resolve"
]
}
],
"dependant_keys_any": [],
"dependant_keys_all": []
}
],
"meta": {
"total_pages": "1"
}
}
HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /auto_response/beacons
Add a new Auto-Response beacon to the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(object)
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: (boolean - default: false)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
The Playbook will be triggered if the cellular signal strength moves below the given threshold [visible:module:=:cell_signal_strength]
- threshold: required(number - minimum: 1 - maximum: 99)
- on_change_only: (boolean - default: true)
- emit_at_startup: (boolean - default: true)
- cell_message: (object)
The Playbook will be triggered when an SMS message that matches the message pattern is received from any of the configured phone numbers. [visible:module:=:cell_message]
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
Periodically attempts to perform a HTTP request using curl and triggers the Playbook based on the results [visible:module:=:curl]
- urls: required(array of any)
- request: (string - default: GET)
- on_change_only: (boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
Periodically run a custom command and trigger the Playbook on failure. [visible:module:=:custom_cmd]
- shell_command: required(string)
- timeout: (number - default: 10 - minimum: 1)
- load: (object)
Monitors the system load average and triggers the Playbook if it breaches the acceptable range in any period [visible:module:=:load]
- one_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- five_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- fifteen_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- emit_at_startup: (boolean - default: true)
- on_change_only: (boolean - default: false)
- one_minute: required(object)
- mem: (object)
The Playbook is triggered if the system memory usage exceeds the given threshold [visible:module:=:mem]
- percent: required(number - minimum: 0 - maximum: 100)
- on_change_only: (boolean - default: false)
- network: (object)
Monitor network interfaces for specific attributes and trigger when they change [visible:module:=:network]
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID [computed_options:physif_no_master]
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- coalesce: required(boolean)
- interfaces: required(array of object)
- ping: (object)
Periodically ping an address and trigger on failure [visible:module:=:ping,required:module:=:ping]
- interface: required(string)
"Reference to a physif ID" [computed_options:physif_no_master|physifs_no_loopbacks]
- destination: required(string)
- on_change_only: (boolean - default: true)
- interface: required(string)
- serial_login: (object)
Monitor the serial ports and trigger on user login and logout events [visible:module:=:serial_login]
- check_login: (boolean - default: true)
- check_logout: (boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
Monitor the given serial ports and trigger when signals are changed [visible:module:=:serial_signal]
- ports: required(array of string)
- signals: required(array of string)
- serial_patterns: (array of object)
Monitor the serial ports and trigger when data matching a pattern is received on specific ports [visible:module:=:serial_pattern]
Items: items
- pattern: required(string)
- disconnect: (boolean - default: false)
- trigger_rx: (boolean - default: true)
- trigger_tx: (boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
Monitor the terminal and trigger on user login and logout events. [visible:module:=:wtmp]
- login: required(boolean - default: true)
- logout: required(boolean - default: true)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
[reference:auto_response/reaction:name]
- resolution_values: (array of string)
[visible:parent.module:in:cell_signal_strength|curl|custom_cmd|ping,required:parent.module:in:cell_signal_strength|curl|custom_cmd|ping]
- action: required(string)
- dependant_keys_any: (array of any)
"A list of keys that are or'd to determine the Auto-Response Beacon state" [visible:never]
- dependant_keys_all: (array of any)
"A list of keys that are and'd to determine the Auto-Response Beacon state" [visible:never]
- name: required(string)
Example:
{
"auto_response_beacon": {
"name": "wtmp-beacon",
"description": "The description for this wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [
{
"action": "auto_response_reactions-7",
"resolution_values": [
"trigger",
"resolve"
]
}
],
"dependant_keys_any": [],
"dependant_keys_all": []
}
}
HTTP status code 200
The beacon was added.
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(object)
An Auto-Response Beacon
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: required(boolean)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
The Playbook will be triggered if the cellular signal strength moves below the given threshold [visible:module:=:cell_signal_strength,required:module:=:cell_signal_strength]
- threshold: required(number - minimum: 0 - maximum: 99)
- on_change_only: required(boolean)
- emit_at_startup: required(boolean)
- cell_message: (object)
The Playbook will be triggered when an SMS message that matches the message pattern is received from any of the configured phone numbers. [visible:module:=:cell_message,required:module:=:cell_message]
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
Periodically attempts to perform a HTTP request using curl and triggers the Playbook based on the results [visible:module:=:curl,required:module:=:curl]
- urls: required(array of any)
- request: required(string)
- on_change_only: required(boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
Periodically run a custom command and trigger the Playbook on failure. [visible:module:=:custom_cmd]
- shell_command: required(string)
- timeout: required(number)
- load: (object)
Monitors the system load average and triggers the Playbook if it breaches the acceptable range in any period [visible:module:=:load]
- one_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- five_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- fifteen_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- emit_at_startup: required(boolean)
- on_change_only: required(boolean)
- one_minute: required(object)
- mem: (object)
The Playbook is triggered if the system memory usage exceeds the given threshold [visible:module:=:mem]
- percent: required(number - minimum: 0 - maximum: 100)
- on_change_only: required(boolean)
- network: (object)
Monitor network interfaces for specific attributes and trigger when they change [visible:module:=:network]
- coalesce: required(string)
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID [computed_options:physif_no_master]
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- ping: (object)
Periodically ping an address and trigger on failure [visible:module:=:ping]
- interface: required(string)
"Reference to a physif ID" [computed_options:physif_no_master|physifs_no_loopbacks]
- destination: required(string)
- on_change_only: required(boolean)
- interface: required(string)
- serial_login: (object)
Monitor the serial ports and trigger on user login and logout events [visible:module:=:serial_login]
- check_login: required(boolean - default: true)
- check_logout: required(boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
Monitor the given serial ports and trigger when signals are changed [visible:module:=:serial_signal]
- ports: required(array of string)
- signals: required(array of string)
- serial_patterns: (array of object)
Monitor the serial ports and trigger when data matching a pattern is received on specific ports [visible:module:=:serial_pattern]
Items: items
- pattern: required(string)
- disconnect: required(boolean - default: false)
- trigger_rx: required(boolean - default: true)
- trigger_tx: required(boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
Monitor the terminal and trigger on user login and logout events. [visible:module:=:wtmp]
- login: required(boolean)
- logout: required(boolean)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
[reference:auto_response/reaction:name]
- resolution_values: (array of string)
[visible:parent.module:in:cell_signal_strength|curl|custom_cmd|ping,required:parent.module:in:cell_signal_strength|curl|custom_cmd|ping]
- action: required(string)
- dependant_keys_any: (array of any)
"A list of keys that are or'd to determine the Auto-Response Beacon state" [visible:never]
- dependant_keys_all: (array of any)
"A list of keys that are and'd to determine the Auto-Response Beacon state" [visible:never]
- id: required(string)
Example:
{
"auto_response_beacon": {
"id": "0",
"name": "wtmp-beacon",
"description": "The description for this wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [],
"dependant_keys_any": [],
"dependant_keys_all": []
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: beacon id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Beacon {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /auto_response/beacons
Bulk delete a list of beacons defined for the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(array of string)
Example:
{
"auto_response_beacon": [
"auto_response_beacon-1",
"auto_response_beacon-5"
]
}
HTTP status code 204
All beacons were deleted successfully.
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Beacon(s) do not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find auto_response/beacon with name or id 'auto_response_beacon-5'",
"args": {
"uuid": "auto_response_beacon-5"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update configuration for a specific Auto-Response beacon.
Get the configuration of an Auto-Response beacon on the NetOps Console Server appliance.
Update settings for an Auto-Response beacon on the NetOps Console Server appliance.
Delete an Auto-Response beacon on the NetOps Console Server appliance.
get /auto_response/beacons/{id}
Get the configuration of an Auto-Response beacon on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(object)
An Auto-Response Beacon
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: required(boolean)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
The Playbook will be triggered if the cellular signal strength moves below the given threshold [visible:module:=:cell_signal_strength,required:module:=:cell_signal_strength]
- threshold: required(number - minimum: 0 - maximum: 99)
- on_change_only: required(boolean)
- emit_at_startup: required(boolean)
- cell_message: (object)
The Playbook will be triggered when an SMS message that matches the message pattern is received from any of the configured phone numbers. [visible:module:=:cell_message,required:module:=:cell_message]
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
Periodically attempts to perform a HTTP request using curl and triggers the Playbook based on the results [visible:module:=:curl,required:module:=:curl]
- urls: required(array of any)
- request: required(string)
- on_change_only: required(boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
Periodically run a custom command and trigger the Playbook on failure. [visible:module:=:custom_cmd]
- shell_command: required(string)
- timeout: required(number)
- load: (object)
Monitors the system load average and triggers the Playbook if it breaches the acceptable range in any period [visible:module:=:load]
- one_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- five_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- fifteen_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- emit_at_startup: required(boolean)
- on_change_only: required(boolean)
- one_minute: required(object)
- mem: (object)
The Playbook is triggered if the system memory usage exceeds the given threshold [visible:module:=:mem]
- percent: required(number - minimum: 0 - maximum: 100)
- on_change_only: required(boolean)
- network: (object)
Monitor network interfaces for specific attributes and trigger when they change [visible:module:=:network]
- coalesce: required(string)
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID [computed_options:physif_no_master]
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- ping: (object)
Periodically ping an address and trigger on failure [visible:module:=:ping]
- interface: required(string)
"Reference to a physif ID" [computed_options:physif_no_master|physifs_no_loopbacks]
- destination: required(string)
- on_change_only: required(boolean)
- interface: required(string)
- serial_login: (object)
Monitor the serial ports and trigger on user login and logout events [visible:module:=:serial_login]
- check_login: required(boolean - default: true)
- check_logout: required(boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
Monitor the given serial ports and trigger when signals are changed [visible:module:=:serial_signal]
- ports: required(array of string)
- signals: required(array of string)
- serial_patterns: (array of object)
Monitor the serial ports and trigger when data matching a pattern is received on specific ports [visible:module:=:serial_pattern]
Items: items
- pattern: required(string)
- disconnect: required(boolean - default: false)
- trigger_rx: required(boolean - default: true)
- trigger_tx: required(boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
Monitor the terminal and trigger on user login and logout events. [visible:module:=:wtmp]
- login: required(boolean)
- logout: required(boolean)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
[reference:auto_response/reaction:name]
- resolution_values: (array of string)
[visible:parent.module:in:cell_signal_strength|curl|custom_cmd|ping,required:parent.module:in:cell_signal_strength|curl|custom_cmd|ping]
- action: required(string)
- dependant_keys_any: (array of any)
"A list of keys that are or'd to determine the Auto-Response Beacon state" [visible:never]
- dependant_keys_all: (array of any)
"A list of keys that are and'd to determine the Auto-Response Beacon state" [visible:never]
- id: required(string)
Example:
{
"auto_response_beacon": {
"id": "0",
"name": "wtmp-beacon",
"description": "The description for this wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [],
"dependant_keys_any": [],
"dependant_keys_all": []
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /auto_response/beacons/{id}
Update settings for an Auto-Response beacon on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(object)
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: (boolean - default: false)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
The Playbook will be triggered if the cellular signal strength moves below the given threshold [visible:module:=:cell_signal_strength]
- threshold: required(number - minimum: 1 - maximum: 99)
- on_change_only: (boolean - default: true)
- emit_at_startup: (boolean - default: true)
- cell_message: (object)
The Playbook will be triggered when an SMS message that matches the message pattern is received from any of the configured phone numbers. [visible:module:=:cell_message]
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
Periodically attempts to perform a HTTP request using curl and triggers the Playbook based on the results [visible:module:=:curl]
- urls: required(array of any)
- request: (string - default: GET)
- on_change_only: (boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
Periodically run a custom command and trigger the Playbook on failure. [visible:module:=:custom_cmd]
- shell_command: required(string)
- timeout: (number - default: 10 - minimum: 1)
- load: (object)
Monitors the system load average and triggers the Playbook if it breaches the acceptable range in any period [visible:module:=:load]
- one_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- five_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- fifteen_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- emit_at_startup: (boolean - default: true)
- on_change_only: (boolean - default: false)
- one_minute: required(object)
- mem: (object)
The Playbook is triggered if the system memory usage exceeds the given threshold [visible:module:=:mem]
- percent: required(number - minimum: 0 - maximum: 100)
- on_change_only: (boolean - default: false)
- network: (object)
Monitor network interfaces for specific attributes and trigger when they change [visible:module:=:network]
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID [computed_options:physif_no_master]
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- coalesce: required(boolean)
- interfaces: required(array of object)
- ping: (object)
Periodically ping an address and trigger on failure [visible:module:=:ping,required:module:=:ping]
- interface: required(string)
"Reference to a physif ID" [computed_options:physif_no_master|physifs_no_loopbacks]
- destination: required(string)
- on_change_only: (boolean - default: true)
- interface: required(string)
- serial_login: (object)
Monitor the serial ports and trigger on user login and logout events [visible:module:=:serial_login]
- check_login: (boolean - default: true)
- check_logout: (boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
Monitor the given serial ports and trigger when signals are changed [visible:module:=:serial_signal]
- ports: required(array of string)
- signals: required(array of string)
- serial_patterns: (array of object)
Monitor the serial ports and trigger when data matching a pattern is received on specific ports [visible:module:=:serial_pattern]
Items: items
- pattern: required(string)
- disconnect: (boolean - default: false)
- trigger_rx: (boolean - default: true)
- trigger_tx: (boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
Monitor the terminal and trigger on user login and logout events. [visible:module:=:wtmp]
- login: required(boolean - default: true)
- logout: required(boolean - default: true)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
[reference:auto_response/reaction:name]
- resolution_values: (array of string)
[visible:parent.module:in:cell_signal_strength|curl|custom_cmd|ping,required:parent.module:in:cell_signal_strength|curl|custom_cmd|ping]
- action: required(string)
- dependant_keys_any: (array of any)
"A list of keys that are or'd to determine the Auto-Response Beacon state" [visible:never]
- dependant_keys_all: (array of any)
"A list of keys that are and'd to determine the Auto-Response Beacon state" [visible:never]
- name: required(string)
Example:
{
"auto_response_beacon": {
"name": "wtmp-beacon",
"description": "The description for this wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [],
"dependant_keys_any": [],
"dependant_keys_all": []
}
}
HTTP status code 200
The beacon settings were updated.
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(object)
An Auto-Response Beacon
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: required(boolean)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
The Playbook will be triggered if the cellular signal strength moves below the given threshold [visible:module:=:cell_signal_strength,required:module:=:cell_signal_strength]
- threshold: required(number - minimum: 0 - maximum: 99)
- on_change_only: required(boolean)
- emit_at_startup: required(boolean)
- cell_message: (object)
The Playbook will be triggered when an SMS message that matches the message pattern is received from any of the configured phone numbers. [visible:module:=:cell_message,required:module:=:cell_message]
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
Periodically attempts to perform a HTTP request using curl and triggers the Playbook based on the results [visible:module:=:curl,required:module:=:curl]
- urls: required(array of any)
- request: required(string)
- on_change_only: required(boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
Periodically run a custom command and trigger the Playbook on failure. [visible:module:=:custom_cmd]
- shell_command: required(string)
- timeout: required(number)
- load: (object)
Monitors the system load average and triggers the Playbook if it breaches the acceptable range in any period [visible:module:=:load]
- one_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- five_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- fifteen_minute: required(object)
- low: required(number - minimum: 0 - maximum: 100)
- high: required(number - minimum: 0 - maximum: 100)
- emit_at_startup: required(boolean)
- on_change_only: required(boolean)
- one_minute: required(object)
- mem: (object)
The Playbook is triggered if the system memory usage exceeds the given threshold [visible:module:=:mem]
- percent: required(number - minimum: 0 - maximum: 100)
- on_change_only: required(boolean)
- network: (object)
Monitor network interfaces for specific attributes and trigger when they change [visible:module:=:network]
- coalesce: required(string)
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID [computed_options:physif_no_master]
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- ping: (object)
Periodically ping an address and trigger on failure [visible:module:=:ping]
- interface: required(string)
"Reference to a physif ID" [computed_options:physif_no_master|physifs_no_loopbacks]
- destination: required(string)
- on_change_only: required(boolean)
- interface: required(string)
- serial_login: (object)
Monitor the serial ports and trigger on user login and logout events [visible:module:=:serial_login]
- check_login: required(boolean - default: true)
- check_logout: required(boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
Monitor the given serial ports and trigger when signals are changed [visible:module:=:serial_signal]
- ports: required(array of string)
- signals: required(array of string)
- serial_patterns: (array of object)
Monitor the serial ports and trigger when data matching a pattern is received on specific ports [visible:module:=:serial_pattern]
Items: items
- pattern: required(string)
- disconnect: required(boolean - default: false)
- trigger_rx: required(boolean - default: true)
- trigger_tx: required(boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
Monitor the terminal and trigger on user login and logout events. [visible:module:=:wtmp]
- login: required(boolean)
- logout: required(boolean)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
[reference:auto_response/reaction:name]
- resolution_values: (array of string)
[visible:parent.module:in:cell_signal_strength|curl|custom_cmd|ping,required:parent.module:in:cell_signal_strength|curl|custom_cmd|ping]
- action: required(string)
- dependant_keys_any: (array of any)
"A list of keys that are or'd to determine the Auto-Response Beacon state" [visible:never]
- dependant_keys_all: (array of any)
"A list of keys that are and'd to determine the Auto-Response Beacon state" [visible:never]
- id: required(string)
Example:
{
"auto_response_beacon": {
"id": "0",
"name": "wtmp-beacon",
"description": "The description for this wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [],
"dependant_keys_any": [],
"dependant_keys_all": []
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: beacon id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
beacon {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /auto_response/beacons/{id}
Delete an Auto-Response beacon on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Beacon deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Beacon did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find auto_response/beacon with name or id 'services_autoresponse_beacon-1'",
"args": {
"uuid": "services_autoresponse_beacon-1"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Read and manipulate the Auto-Response reactions on the NetOps Console Server appliance.
Get a list of the Auto-Response Reactions.
Add a new Auto-Response reaction to the NetOps Console Server appliance.
Bulk delete a list of reactions defined for the NetOps Console Server appliance.
get /auto_response/reactions
Get a list of the Auto-Response Reactions.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- reactions: (array of object)
Items: items
- id: required(string)
Database ID for this Auto-Response Reaction.
- name: required(string)
Each Auto-Response Reaction has a non-unique name to help distinguish it.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
[visible:sub_type:=:custom_command,required:sub_type:=:custom_command]
- shell_command: required(string)
- timeout: required(number)
- cell_message_react: (object)
[visible:sub_type:=:cell_message_react,required:sub_type:=:cell_message_react]
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
[visible:sub_type:=:serial_text,required:sub_type:=:serial_text]
- port: required(string)
Reference to a port ID [computed_options:port_consoleservers_all]
- command: required(string)
- response: required(string)
- timeout: required(number - minimum: 0)
- port: required(string)
- slack: (object)
[visible:sub_type:=:slack,required:sub_type:=:slack]
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
[visible:sub_type:=:snmp,required:sub_type:=:snmp]
- oid: required(string)
- timeout: required(number)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- id: required(string)
- meta: required(object)
- total_pages: (string)
Example:
{
"reactions": [
{
"id": "0",
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
},
{
"id": "1",
"name": "cell_message-reaction",
"sub_type": "cell_message_react",
"cell_message_react": {
"phone_numbers": [
"15551234",
"15554321"
],
"message": "Example SMS text"
}
}
],
"meta": {
"total_pages": "1"
}
}
HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /auto_response/reactions
Add a new Auto-Response reaction to the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(object)
- name: required(string)
Each Auto-Response Reaction must have a unique symbolic name. Use this to distinguish between multiple Auto-Response Reaction's on the device.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
[visible:sub_type:=:custom_command,required:sub_type:=:custom_command]
- shell_command: required(string)
- timeout: (number - default: 10 - minimum: 1)
- cell_message_react: (object)
[visible:sub_type:=:cell_message_react,required:sub_type:=:cell_message_react]
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
[visible:sub_type:=:serial_text,required:sub_type:=:serial_text]
- port: required(string)
Reference to a port ID [computed_options:port_consoleservers]
- command: required(string)
- response: required(string)
- timeout: (number - default: 10 - minimum: 1)
- port: required(string)
- slack: (object)
[visible:sub_type:=:slack,required:sub_type:=:slack]
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
[visible:sub_type:=:snmp,required:sub_type:=:snmp]
- oid: required(string)
- timeout: required(number - default: 10 - minimum: 1)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- name: required(string)
Example:
{
"auto_response_reaction": {
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
}
}
HTTP status code 200
The reaction was added.
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(object)
An Auto-Response Reaction
- id: required(string)
Database ID for this Auto-Response Reaction.
- name: required(string)
Each Auto-Response Reaction has a non-unique name to help distinguish it.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
[visible:sub_type:=:custom_command,required:sub_type:=:custom_command]
- shell_command: required(string)
- timeout: required(number)
- cell_message_react: (object)
[visible:sub_type:=:cell_message_react,required:sub_type:=:cell_message_react]
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
[visible:sub_type:=:serial_text,required:sub_type:=:serial_text]
- port: required(string)
Reference to a port ID [computed_options:port_consoleservers_all]
- command: required(string)
- response: required(string)
- timeout: required(number - minimum: 0)
- port: required(string)
- slack: (object)
[visible:sub_type:=:slack,required:sub_type:=:slack]
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
[visible:sub_type:=:snmp,required:sub_type:=:snmp]
- oid: required(string)
- timeout: required(number)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- id: required(string)
Example:
{
"auto_response_reaction": {
"id": "0",
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: reaction id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Reaction {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /auto_response/reactions
Bulk delete a list of reactions defined for the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(array of string)
Example:
{
"auto_response_reaction": [
"auto_response_reaction-1",
"auto_response_reaction-5"
]
}
HTTP status code 204
All reactions were deleted successfully.
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Reaction(s) do not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find auto_response/reaction with name or id 'auto_response_reaction-5'",
"args": {
"uuid": "auto_response_reaction-5"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or update configuration for a specific Auto-Response reaction.
Get the configuration of an Auto-Response reaction on the NetOps Console Server appliance.
Update settings for an Auto-Response reaction on the NetOps Console Server appliance.
Delete an Auto-Response reaction on the NetOps Console Server appliance.
get /auto_response/reactions/{id}
Get the configuration of an Auto-Response reaction on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(object)
An Auto-Response Reaction
- id: required(string)
Database ID for this Auto-Response Reaction.
- name: required(string)
Each Auto-Response Reaction has a non-unique name to help distinguish it.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
[visible:sub_type:=:custom_command,required:sub_type:=:custom_command]
- shell_command: required(string)
- timeout: required(number)
- cell_message_react: (object)
[visible:sub_type:=:cell_message_react,required:sub_type:=:cell_message_react]
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
[visible:sub_type:=:serial_text,required:sub_type:=:serial_text]
- port: required(string)
Reference to a port ID [computed_options:port_consoleservers_all]
- command: required(string)
- response: required(string)
- timeout: required(number - minimum: 0)
- port: required(string)
- slack: (object)
[visible:sub_type:=:slack,required:sub_type:=:slack]
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
[visible:sub_type:=:snmp,required:sub_type:=:snmp]
- oid: required(string)
- timeout: required(number)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- id: required(string)
Example:
{
"auto_response_reaction": {
"id": "0",
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /auto_response/reactions/{id}
Update settings for an Auto-Response reaction on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(object)
- name: required(string)
Each Auto-Response Reaction must have a unique symbolic name. Use this to distinguish between multiple Auto-Response Reaction's on the device.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
[visible:sub_type:=:custom_command,required:sub_type:=:custom_command]
- shell_command: required(string)
- timeout: (number - default: 10 - minimum: 1)
- cell_message_react: (object)
[visible:sub_type:=:cell_message_react,required:sub_type:=:cell_message_react]
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
[visible:sub_type:=:serial_text,required:sub_type:=:serial_text]
- port: required(string)
Reference to a port ID [computed_options:port_consoleservers]
- command: required(string)
- response: required(string)
- timeout: (number - default: 10 - minimum: 1)
- port: required(string)
- slack: (object)
[visible:sub_type:=:slack,required:sub_type:=:slack]
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
[visible:sub_type:=:snmp,required:sub_type:=:snmp]
- oid: required(string)
- timeout: required(number - default: 10 - minimum: 1)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- name: required(string)
Example:
{
"auto_response_reaction": {
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
}
}
HTTP status code 200
The reaction settings were updated.
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(object)
An Auto-Response Reaction
- id: required(string)
Database ID for this Auto-Response Reaction.
- name: required(string)
Each Auto-Response Reaction has a non-unique name to help distinguish it.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
[visible:sub_type:=:custom_command,required:sub_type:=:custom_command]
- shell_command: required(string)
- timeout: required(number)
- cell_message_react: (object)
[visible:sub_type:=:cell_message_react,required:sub_type:=:cell_message_react]
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
[visible:sub_type:=:serial_text,required:sub_type:=:serial_text]
- port: required(string)
Reference to a port ID [computed_options:port_consoleservers_all]
- command: required(string)
- response: required(string)
- timeout: required(number - minimum: 0)
- port: required(string)
- slack: (object)
[visible:sub_type:=:slack,required:sub_type:=:slack]
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
[visible:sub_type:=:snmp,required:sub_type:=:snmp]
- oid: required(string)
- timeout: required(number)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- id: required(string)
Example:
{
"auto_response_reaction": {
"id": "0",
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
}
}
HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: reaction id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
reaction {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /auto_response/reactions/{id}
Delete an Auto-Response reaction on the NetOps Console Server appliance.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Reaction deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Reaction did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find auto_response/reaction with name or id 'services_autoresponse_reaction-1'",
"args": {
"uuid": "services_autoresponse_reaction-1"
},
"level": 1
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Read the AutoResponse Status on the NetOps Console Server appliance.
Get the status of the Auto-Response Beacons.
get /auto_response/status
Get the status of the Auto-Response Beacons.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- eventLines: (integer - default: 50)
The number of event lines to fetch - min 0.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- auto_response_status: required(object)
- beacons: required(array of object)
Status for all Beacons
Items: items
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon is using.
- trigger_count: required(integer)
The number of Auto-Response Beacon events that were triggered, includes resolved events
- last_triggered: (string)
The date and timestamp when the last Auto-Response Beacon event occurred
- beacon_data: (object)
The data the Auto-Response Beacon was triggered with
- events: (array of any)
The Auto-Response Beacon events since last boot
- id: required(string)
- beacons: required(array of object)
Example:
{
"auto_response_status": {
"beacons": [
{
"id": "0",
"name": "wtmp-beacon",
"module": "wtmp",
"trigger_count": 0,
"last_triggered": "",
"beacon_data": {},
"events": []
},
{
"id": "1",
"name": "curl-beacon",
"module": "curl",
"trigger_count": 1,
"last_triggered": "2020-01-16T20:22:14.477327",
"beacon_data": {
"cmd": [
"/usr/bin/curl",
"--max-time",
"3",
"--request",
"GET",
"http://www.google.com"
],
"exit_status": 0,
"timeout": 5,
"_stamp": "2020-01-16T20:22:14.477327",
"id": "22161907057534",
"result": "success"
},
"events": [
{
"beacon_data": {
"cmd": [
"/usr/bin/curl",
"--max-time",
"3",
"--request",
"GET",
"http://www.google.com"
],
"exit_status": 0,
"timeout": 5,
"_stamp": "2020-01-16T20:22:14.477327",
"id": "22161907057534",
"result": "success"
},
"beacon_id": "auto_response_beacons-1",
"timestamp": "2020-01-16T20:22:14.477327",
"beacon_name": "curl-beacon"
},
{
"timestamp": "2020-01-16T20:22:14",
"beacon_id": "auto_response_beacons-1",
"reactor_id": "auto_response_reactions-1",
"reactor_type": "custom_command",
"reactor_name": "custom cmd reaction test",
"beacon_tag": "salt/beacon/22481809000004/curl-beacon/",
"beacon_name": "curl-beacon",
"reactor_filename": "reactor_0_0.py"
}
]
}
]
}
}
HTTP status code 400
Number of eventLines is not a positive number.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Read the status of Auto-Response beacons on the NetOps Console Server appliance.
Get the status of the Auto-Response Beacon
get /auto_response/status/beacons/{id}
Get the status of the Auto-Response Beacon
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- eventLines: (integer - default: 50)
The number of event lines to fetch - min 0.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- auto_response_status: required(object)
The Auto-Response Status of a Beacon
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon is using.
- trigger_count: required(integer)
The number of Auto-Response Beacon events that were triggered, includes resolved events
- last_triggered: (string)
The date and timestamp when the last Auto-Response Beacon event occurred
- beacon_data: (object)
The data the Auto-Response Beacon was triggered with
- events: (array of any)
The Auto-Response Beacon events since last boot
- id: required(string)
Example:
{
"auto_response_status": {
"id": "1",
"name": "curl-beacon",
"module": "curl",
"trigger_count": 1,
"last_triggered": "2020-01-16T20:22:14.477327",
"beacon_data": {
"cmd": [
"/usr/bin/curl",
"--max-time",
"3",
"--request",
"GET",
"http://www.google.com"
],
"exit_status": 0,
"timeout": 5,
"_stamp": "2020-01-16T20:22:14.477327",
"id": "22161907057534",
"result": "success"
},
"events": [
{
"beacon_data": {
"cmd": [
"/usr/bin/curl",
"--max-time",
"3",
"--request",
"GET",
"http://www.google.com"
],
"exit_status": 0,
"timeout": 5,
"_stamp": "2020-01-16T20:22:14.477327",
"id": "22161907057534",
"result": "success"
},
"beacon_id": "auto_response_beacons-1",
"timestamp": "2020-01-16T20:22:14.477327",
"beacon_name": "curl-beacon"
},
{
"timestamp": "2020-01-16T20:22:14",
"beacon_id": "auto_response_beacons-1",
"reactor_id": "auto_response_reactions-1",
"reactor_type": "custom_command",
"reactor_name": "custom cmd reaction test",
"beacon_tag": "salt/beacon/22481809000004/curl-beacon/",
"beacon_name": "curl-beacon",
"reactor_filename": "reactor_0_0.py"
}
]
}
}
HTTP status code 400
Number of eventLines is not a positive number.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 404
beacon {id} does not exist.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Read the AutoResponse Status of Beacon Modules on the NetOps Console Server appliance.
Get all the Beacon Modules and their resolution values that can be used to filter beacon events.
get /auto_response/status/beacon-modules
Get all the Beacon Modules and their resolution values that can be used to filter beacon events.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- beacon-modules: required(array of object)
Status for all Beacon Modules
Items: items
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response beacon module.
- resolution_values: (array of string)
"The list of resolution values to filter on for a reaction for this beacon module." [visible:module:in:cell_signal_strength|curl|custom_cmd|ping,required:module:in:cell_signal_strength|curl|custom_cmd|ping]
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
Example:
{
"beacon-modules": [
{
"module": "ping",
"resolution_values": [
"trigger",
"resolve"
]
},
{
"module": "cell_message",
"resolution_values": []
},
{
"module": "network",
"resolution_values": []
},
{
"module": "serial_signal",
"resolution_values": []
},
{
"module": "mem",
"resolution_values": []
},
{
"module": "cell_signal_strength",
"resolution_values": [
"trigger",
"resolve"
]
},
{
"module": "custom_cmd",
"resolution_values": [
"trigger",
"resolve"
]
},
{
"module": "serial_pattern",
"resolution_values": []
},
{
"module": "curl",
"resolution_values": [
"trigger",
"resolve"
]
},
{
"module": "cell_connection",
"resolution_values": []
},
{
"module": "serial_login",
"resolution_values": []
},
{
"module": "btmp",
"resolution_values": []
},
{
"module": "load",
"resolution_values": []
},
{
"module": "wtmp",
"resolution_values": []
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get the status of a specific Auto-Response beacon module.
get /auto_response/status/beacon-modules/{beacon-module}
NetOps Console Server base authentication scheme.
URI Parameters
- beacon-module: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- beacon-module: required(object)
The Auto-Response Status of all the Beacon Modules
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response beacon module.
- resolution_values: (array of string)
"The list of resolution values to filter on for a reaction for this beacon module." [visible:module:in:cell_signal_strength|curl|custom_cmd|ping,required:module:in:cell_signal_strength|curl|custom_cmd|ping]
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
Example:
{
"beacon-module": {
"module": "ping",
"resolution_values": [
"trigger",
"resolve"
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/ip_passthrough
IP Passthrough endpoints are for retrieving / changing IP Passthrough settings.
Retrieve the current IP Passthrough settings.
Set the IP Passthrough settings.
get /ip_passthrough
Retrieve the current IP Passthrough settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current IP Passthrough settings.
Body
Media type: application/json
Type: object
Properties- ip_passthrough: required(object)
- enabled: required(boolean)
Enable or disable IP Passthrough.
- passthrough_physif: required(string)
The network interface port used for ethernet connection to the downstream device. [Optional when IP Passthrough is disabled, computed_options:physifs_no_loopbacks]
- mac_address: (string)
The downstream device's MAC address that is connected to the NetOps Console Server. If mac_address is not specified, the NetOps Console Server will connect to the first downstream device requesting a DHCP assigned IP address. All 3 of the standard MAC formats are accepted (00:00:00:00:00:00, 00-00-00-00-00-00, 0000.0000.0000) but the system converts to 00:00:00:00:00:00 format for storage and replies. If this field is empty when IP Passthrough is to be disabled, the stored MAC address will be removed.
- service_intercepts: required(object)
Service intercepts allow specific protocols to be accessed on the NetOps Console Server in addition to those found on the downstream device.
- https: (integer)
Choose an unused port number, so that the HTTPS server on the NetOps Console Server can be accessed. This will not impede traffic bound for the downstream device's configured HTTPS port.
If https is an empty field, omitted entirely, or set to 0, incoming HTTPS connections are passed through to the downstream device by default, and the NetOps Console Server's HTTPS server will be inaccessible via incoming connections through the cellular interface.
- ssh: (integer)
Choose an unused port number, so that the SSH server on the NetOps Console Server can be accessed. This will not impede traffic bound for the downstream device's configured SSH port.
If ssh is an empty field, omitted entirely, or set to 0, incoming SSH connections are passed through to the downstream device by default, and the NetOps Console Server's SSH server will be inaccessible via incoming connections through the cellular interface.
- allowlist: (array of string)
A list of allowed addresses (x.x.x.x) or networks (x.x.x.x/y). If this list is empty, any address that is not explicitly blocked will be allowed.
- blocklist: (array of string)
A list of blocked addresses (x.x.x.x) or networks (x.x.x.x/y).
- https: (integer)
- enabled: required(boolean)
Examples:
example1:
{
"ip_passthrough": {
"enabled": false,
"passthrough_physif": "net1",
"mac_address": "None",
"service_intercepts": {
"https": 0,
"ssh": 0
}
}
}
example2:
{
"ip_passthrough": {
"enabled": true,
"passthrough_physif": "net2",
"mac_address": "00:e0:4c:12:93:8d",
"service_intercepts": {
"https": 5511,
"ssh": 0
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /ip_passthrough
Set the IP Passthrough settings.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- ip_passthrough: required(object)
- enabled: required(boolean)
Enable or disable IP Passthrough.
- passthrough_physif: required(string)
The network interface port used for ethernet connection to the downstream device. [Optional when IP Passthrough is disabled, computed_options:physifs_no_loopbacks]
- mac_address: (string)
The downstream device's MAC address that is connected to the NetOps Console Server. If mac_address is not specified, the NetOps Console Server will connect to the first downstream device requesting a DHCP assigned IP address. All 3 of the standard MAC formats are accepted (00:00:00:00:00:00, 00-00-00-00-00-00, 0000.0000.0000) but the system converts to 00:00:00:00:00:00 format for storage and replies. If this field is empty when IP Passthrough is to be disabled, the stored MAC address will be removed.
- service_intercepts: required(object)
Service intercepts allow specific protocols to be accessed on the NetOps Console Server in addition to those found on the downstream device.
- https: (integer)
Choose an unused port number, so that the HTTPS server on the NetOps Console Server can be accessed. This will not impede traffic bound for the downstream device's configured HTTPS port.
If https is an empty field, omitted entirely, or set to 0, incoming HTTPS connections are passed through to the downstream device by default, and the NetOps Console Server's HTTPS server will be inaccessible via incoming connections through the cellular interface.
- ssh: (integer)
Choose an unused port number, so that the SSH server on the NetOps Console Server can be accessed. This will not impede traffic bound for the downstream device's configured SSH port.
If ssh is an empty field, omitted entirely, or set to 0, incoming SSH connections are passed through to the downstream device by default, and the NetOps Console Server's SSH server will be inaccessible via incoming connections through the cellular interface.
- allowlist: (array of string)
A list of allowed addresses (x.x.x.x) or networks (x.x.x.x/y). If this list is empty, any address that is not explicitly blocked will be allowed.
- blocklist: (array of string)
A list of blocked addresses (x.x.x.x) or networks (x.x.x.x/y).
- https: (integer)
- enabled: required(boolean)
Examples:
example1:
{
"ip_passthrough": {
"enabled": true,
"passthrough_physif": "net1",
"mac_address": "00:e0:4c:12:93:8d",
"service_intercepts": {
"https": 8443,
"ssh": 8222,
"allowlist": [
"10.0.0.0/24"
],
"blocklist": [
"10.2.3.200"
]
}
}
}
example2:
{
"ip_passthrough": {
"enabled": false,
"passthrough_physif": "net2",
"service_intercepts": {}
}
}
HTTP status code 200
Returns the current IP Passthrough settings.
Body
Media type: application/json
Type: object
Properties- ip_passthrough: required(object)
- enabled: required(boolean)
Enable or disable IP Passthrough.
- passthrough_physif: required(string)
The network interface port used for ethernet connection to the downstream device. [Optional when IP Passthrough is disabled, computed_options:physifs_no_loopbacks]
- mac_address: (string)
The downstream device's MAC address that is connected to the NetOps Console Server. If mac_address is not specified, the NetOps Console Server will connect to the first downstream device requesting a DHCP assigned IP address. All 3 of the standard MAC formats are accepted (00:00:00:00:00:00, 00-00-00-00-00-00, 0000.0000.0000) but the system converts to 00:00:00:00:00:00 format for storage and replies. If this field is empty when IP Passthrough is to be disabled, the stored MAC address will be removed.
- service_intercepts: required(object)
Service intercepts allow specific protocols to be accessed on the NetOps Console Server in addition to those found on the downstream device.
- https: (integer)
Choose an unused port number, so that the HTTPS server on the NetOps Console Server can be accessed. This will not impede traffic bound for the downstream device's configured HTTPS port.
If https is an empty field, omitted entirely, or set to 0, incoming HTTPS connections are passed through to the downstream device by default, and the NetOps Console Server's HTTPS server will be inaccessible via incoming connections through the cellular interface.
- ssh: (integer)
Choose an unused port number, so that the SSH server on the NetOps Console Server can be accessed. This will not impede traffic bound for the downstream device's configured SSH port.
If ssh is an empty field, omitted entirely, or set to 0, incoming SSH connections are passed through to the downstream device by default, and the NetOps Console Server's SSH server will be inaccessible via incoming connections through the cellular interface.
- allowlist: (array of string)
A list of allowed addresses (x.x.x.x) or networks (x.x.x.x/y). If this list is empty, any address that is not explicitly blocked will be allowed.
- blocklist: (array of string)
A list of blocked addresses (x.x.x.x) or networks (x.x.x.x/y).
- https: (integer)
- enabled: required(boolean)
Examples:
example1:
{
"ip_passthrough": {
"enabled": true,
"passthrough_physif": "net1",
"mac_address": "00:e0:4c:12:93:8d",
"service_intercepts": {
"https": 8443,
"ssh": 8222
}
}
}
example2:
{
"ip_passthrough": {
"enabled": false,
"passthrough_physif": "net2",
"mac_address": "None",
"service_intercepts": {
"https": 0,
"ssh": 0
}
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
The IP Passthrough status endpoint provides information about what part of the IP Passthrough connection process the device is currently at and information about the connected downstream device.
Retrieve the current IP Passthrough status.
get /ip_passthrough/status
Retrieve the current IP Passthrough status.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
This response object provides information about the current status of the IP Passthrough connection and the connected downstream device.
Body
Media type: application/json
Type: object
Properties- ip_passthrough_status: required(object)
- status: required(one of disabled, cell_not_active, connecting, active)
A status value indicating the current state of the IP Passthrough connection with a downstream device.
- downstream_ip: required(string)
The IP address taken from the device's cellular modem and assigned to the downstream device.
- downstream_mac: required(string)
The MAC address of the downstream device that has been assigned the cellular IP address.
- status: required(one of disabled, cell_not_active, connecting, active)
Examples:
example1:
{
"ip_passthrough_status": {
"status": "active",
"downstream_ip": "100.120.10.1",
"downstream_mac": "01:02:03:04:05:06"
}
}
example2:
{
"ip_passthrough_status": {
"status": "connecting",
"downstream_ip": "",
"downstream_mac": ""
}
}
example3:
{
"ip_passthrough_status": {
"status": "cell_not_active",
"downstream_ip": "",
"downstream_mac": ""
}
}
example4:
{
"ip_passthrough_status": {
"status": "disabled",
"downstream_ip": "",
"downstream_mac": ""
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/access_rights
An access right is a permit granting the holder access to a feature or collection of related features.
Get a list of all known access rights.
get /access_rights
Get a list of all known access rights.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- access_rights: required(array of object)
Items: items
- name: required(string)
Name of the access right.
- label: required(string)
Suggested text/label to display in place of the name.
- description: required(string)
A description of the access right.
- name: required(string)
Example:
{
"access_rights": [
{
"description": "Administrator right providing full access.",
"name": "admin",
"label": "Administrator"
},
{
"description": "Permits access to the Web UI.",
"name": "web_ui",
"label": "Web UI"
},
{
"description": "Permits shell access.",
"name": "pmshell",
"label": "PM Shell"
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve an access right by name.
get /access_rights/{name}
URI Parameters
- name: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- access_right: required(object)
This object describes a specific access right which is a permit granting the holder access to a feature or collection of related features.
- name: required(string)
Name of the access right.
- label: required(string)
Suggested text/label to display in place of the name.
- description: required(string)
A description of the access right.
- name: required(string)
Example:
{
"access_right": {
"description": "Permits shell access.",
"name": "pmshell",
"label": "PM Shell"
}
}
/wireguards
Wireguard is a point-to-multipoint vpn. This entity provides access to the wireguard configurations on the system.
Retrieves all wireguard configurations.
Create a wireguard configuration.
get /wireguards
Retrieves all wireguard configurations.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns all current wireguard configurations.
Body
Media type: application/json
Type: object
Properties- wireguards: required(array of object)
Items: items
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
The name of the wireguard interface. Names must be unique, max 15 characters and only contain letters, numbers, hyphens or underscores. [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-"]
- description: (string)
A description of the purpose of this wireguard configuration.
- enabled: required(boolean)
- port: (integer - minimum: 1 - maximum: 65535)
The port the local instance of wireguard will listen on. Valid values are 1 to 65535.
- private_key: required(string)
The private key to use to authenticate the local wireguard interface.
- public_key: (string)
The public key that corresponds your private key, which wireguard peers will authenticate with.
- addresses: required(array of string)
The IPv4 CIDR addresses of the local wireguard interface.
- mtu: (integer - default: 1420 - minimum: 1200 - maximum: 1472)
The MTU for the local wireguard interface. Valid values are 1200 to 1472. 1420 is default if left unspecified.
- table: (string - pattern: ^([0-9]|[1-9][0-9]{1,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5]|auto|off)$)
The routing table for the wireguard routes. Can be a table number, 'off' or 'auto'. [regexerr:'auto', regexerr:'off', regexerr:a routing table number]
- pre_down_hooks: (array of string)
The commands to execute before closing a wireguard interface.
- pre_up_hooks: (array of string)
The commands to execute before starting a wireguard interface.
- post_down_hooks: (array of string)
The commands to execute after closing a wireguard interface.
- post_up_hooks: (array of string)
The commands to execute after starting a wireguard interface.
- peers: required(array of object)
The wireguard peers for this wireguard interface.
Items: items
- endpoint_address: (string)
A publicly accessible address (hostname or IP) for a remote peer. [required:endpoint_port:!=:]
- endpoint_port: (integer - minimum: 1 - maximum: 65535)
The port the remote wireguard peer is listening on. [required:endpoint_address:!=:]
- public_key: required(string)
The public key to used to authenticate this wireguard peer.
- allowed_ips: required(array of string)
The IPv4 network ranges that wireguard can route to this peer.
- keep_alive: (integer)
The persistent keep alive interval in seconds.
- endpoint_address: (string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
Example:
{
"wireguards": [
{
"name": "wg0",
"description": "Our wireguard vpn",
"enabled": true,
"addresses": [
"172.30.0.2/32"
],
"port": 51820,
"private_key": "****",
"public_key": "******",
"mtu": 1280,
"table": "1000",
"pre_down_hooks": [
"echo %i stopping"
],
"pre_up_hooks": [],
"post_down_hooks": [],
"post_up_hooks": [],
"peers": [
{
"endpoint_address": "1.2.3.4",
"endpoint_port": 51820,
"public_key": "********",
"allowed_ips": [
"172.30.0.0/24"
],
"keep_alive": 25
}
]
},
{
"name": "wg1-example2",
"enabled": true,
"addresses": [
"10.0.0.1/32"
],
"private_key": "****",
"pre_down_hooks": [],
"pre_up_hooks": [],
"post_down_hooks": [],
"post_up_hooks": [],
"peers": [
{
"public_key": "********",
"allowed_ips": [
"10.0.0.2/32"
],
"endpoint_port": 51820
}
]
}
]
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /wireguards
Create a wireguard configuration.
NetOps Console Server base authentication scheme.
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- wireguard: required(object)
This object contains configuration information for a wireguard interface.
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
The name of the wireguard interface. Names must be unique, max 15 characters and only contain letters, numbers, hyphens or underscores. [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-"]
- description: (string)
A description of the purpose of this wireguard configuration.
- enabled: required(boolean)
- port: (integer - minimum: 1 - maximum: 65535)
The port the local instance of wireguard will listen on. Valid values are 1 to 65535.
- private_key: required(string)
The private key to use to authenticate the local wireguard interface.
- public_key: (string)
The public key that corresponds your private key, which wireguard peers will authenticate with.
- addresses: required(array of string)
The IPv4 CIDR addresses of the local wireguard interface.
- mtu: (integer - default: 1420 - minimum: 1200 - maximum: 1472)
The MTU for the local wireguard interface. Valid values are 1200 to 1472. 1420 is default if left unspecified.
- table: (string - pattern: ^([0-9]|[1-9][0-9]{1,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5]|auto|off)$)
The routing table for the wireguard routes. Can be a table number, 'off' or 'auto'. [regexerr:'auto', regexerr:'off', regexerr:a routing table number]
- pre_down_hooks: (array of string)
The commands to execute before closing a wireguard interface.
- pre_up_hooks: (array of string)
The commands to execute before starting a wireguard interface.
- post_down_hooks: (array of string)
The commands to execute after closing a wireguard interface.
- post_up_hooks: (array of string)
The commands to execute after starting a wireguard interface.
- peers: required(array of object)
The wireguard peers for this wireguard interface.
Items: items
- endpoint_address: (string)
A publicly accessible address (hostname or IP) for a remote peer. [required:endpoint_port:!=:]
- endpoint_port: (integer - minimum: 1 - maximum: 65535)
The port the remote wireguard peer is listening on. [required:endpoint_address:!=:]
- public_key: required(string)
The public key to used to authenticate this wireguard peer.
- allowed_ips: required(array of string)
The IPv4 network ranges that wireguard can route to this peer.
- keep_alive: (integer)
The persistent keep alive interval in seconds.
- endpoint_address: (string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
Example:
{
"wireguard": {
"name": "wg0",
"description": "Our wireguard vpn",
"enabled": true,
"addresses": [
"172.30.0.2/32"
],
"port": 51820,
"private_key": "****",
"public_key": "******",
"mtu": 1420,
"table": "1000",
"pre_down_hooks": [
"echo %i stopping"
],
"pre_up_hooks": [],
"post_down_hooks": [],
"post_up_hooks": [],
"peers": [
{
"endpoint_address": "1.2.3.4",
"endpoint_port": 51820,
"public_key": "********",
"allowed_ips": [
"172.30.0.0/24"
],
"keep_alive": 25
}
]
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- wireguard: required(object)
This object contains configuration information for a wireguard interface.
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
The name of the wireguard interface. Names must be unique, max 15 characters and only contain letters, numbers, hyphens or underscores. [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-"]
- description: (string)
A description of the purpose of this wireguard configuration.
- enabled: required(boolean)
- port: (integer - minimum: 1 - maximum: 65535)
The port the local instance of wireguard will listen on. Valid values are 1 to 65535.
- private_key: required(string)
The private key to use to authenticate the local wireguard interface.
- public_key: (string)
The public key that corresponds your private key, which wireguard peers will authenticate with.
- addresses: required(array of string)
The IPv4 CIDR addresses of the local wireguard interface.
- mtu: (integer - default: 1420 - minimum: 1200 - maximum: 1472)
The MTU for the local wireguard interface. Valid values are 1200 to 1472. 1420 is default if left unspecified.
- table: (string - pattern: ^([0-9]|[1-9][0-9]{1,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5]|auto|off)$)
The routing table for the wireguard routes. Can be a table number, 'off' or 'auto'. [regexerr:'auto', regexerr:'off', regexerr:a routing table number]
- pre_down_hooks: (array of string)
The commands to execute before closing a wireguard interface.
- pre_up_hooks: (array of string)
The commands to execute before starting a wireguard interface.
- post_down_hooks: (array of string)
The commands to execute after closing a wireguard interface.
- post_up_hooks: (array of string)
The commands to execute after starting a wireguard interface.
- peers: required(array of object)
The wireguard peers for this wireguard interface.
Items: items
- endpoint_address: (string)
A publicly accessible address (hostname or IP) for a remote peer. [required:endpoint_port:!=:]
- endpoint_port: (integer - minimum: 1 - maximum: 65535)
The port the remote wireguard peer is listening on. [required:endpoint_address:!=:]
- public_key: required(string)
The public key to used to authenticate this wireguard peer.
- allowed_ips: required(array of string)
The IPv4 network ranges that wireguard can route to this peer.
- keep_alive: (integer)
The persistent keep alive interval in seconds.
- endpoint_address: (string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
Example:
{
"wireguard": {
"name": "wg0",
"description": "Our wireguard vpn",
"enabled": true,
"addresses": [
"172.30.0.2/32"
],
"port": 51820,
"private_key": "****",
"public_key": "******",
"mtu": 1280,
"table": "1000",
"pre_down_hooks": [
"echo %i stopping"
],
"pre_up_hooks": [],
"post_down_hooks": [],
"post_up_hooks": [],
"peers": [
{
"endpoint_address": "1.2.3.4",
"endpoint_port": 51820,
"public_key": "********",
"allowed_ips": [
"172.30.0.0/24"
],
"keep_alive": 25
}
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve, update or remove a specific wireguard configuration.
Retrieve a wireguard configuration by id.
Update a wireguard configuration by id.
Delete the wireguard configuration and stop that wireguard interface.
get /wireguards/{id}
Retrieve a wireguard configuration by id.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- wireguard: required(object)
This object contains configuration information for a wireguard interface.
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
The name of the wireguard interface. Names must be unique, max 15 characters and only contain letters, numbers, hyphens or underscores. [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-"]
- description: (string)
A description of the purpose of this wireguard configuration.
- enabled: required(boolean)
- port: (integer - minimum: 1 - maximum: 65535)
The port the local instance of wireguard will listen on. Valid values are 1 to 65535.
- private_key: required(string)
The private key to use to authenticate the local wireguard interface.
- public_key: (string)
The public key that corresponds your private key, which wireguard peers will authenticate with.
- addresses: required(array of string)
The IPv4 CIDR addresses of the local wireguard interface.
- mtu: (integer - default: 1420 - minimum: 1200 - maximum: 1472)
The MTU for the local wireguard interface. Valid values are 1200 to 1472. 1420 is default if left unspecified.
- table: (string - pattern: ^([0-9]|[1-9][0-9]{1,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5]|auto|off)$)
The routing table for the wireguard routes. Can be a table number, 'off' or 'auto'. [regexerr:'auto', regexerr:'off', regexerr:a routing table number]
- pre_down_hooks: (array of string)
The commands to execute before closing a wireguard interface.
- pre_up_hooks: (array of string)
The commands to execute before starting a wireguard interface.
- post_down_hooks: (array of string)
The commands to execute after closing a wireguard interface.
- post_up_hooks: (array of string)
The commands to execute after starting a wireguard interface.
- peers: required(array of object)
The wireguard peers for this wireguard interface.
Items: items
- endpoint_address: (string)
A publicly accessible address (hostname or IP) for a remote peer. [required:endpoint_port:!=:]
- endpoint_port: (integer - minimum: 1 - maximum: 65535)
The port the remote wireguard peer is listening on. [required:endpoint_address:!=:]
- public_key: required(string)
The public key to used to authenticate this wireguard peer.
- allowed_ips: required(array of string)
The IPv4 network ranges that wireguard can route to this peer.
- keep_alive: (integer)
The persistent keep alive interval in seconds.
- endpoint_address: (string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
Example:
{
"wireguard": {
"name": "wg0",
"description": "Our wireguard vpn",
"enabled": true,
"addresses": [
"172.30.0.2/32"
],
"port": 51820,
"private_key": "****",
"public_key": "******",
"mtu": 1280,
"table": "1000",
"pre_down_hooks": [
"echo %i stopping"
],
"pre_up_hooks": [],
"post_down_hooks": [],
"post_up_hooks": [],
"peers": [
{
"endpoint_address": "1.2.3.4",
"endpoint_port": 51820,
"public_key": "********",
"allowed_ips": [
"172.30.0.0/24"
],
"keep_alive": 25
}
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
example2:
{
"error": [
{
"type": 7,
"code": 46,
"level": 1,
"text": "Permission denied",
"args": {}
}
]
}
HTTP status code 404
Not found, Wireguard configuration does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /wireguards/{id}
Update a wireguard configuration by id.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- wireguard: required(object)
This object contains configuration information for a wireguard interface.
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
The name of the wireguard interface. Names must be unique, max 15 characters and only contain letters, numbers, hyphens or underscores. [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-"]
- description: (string)
A description of the purpose of this wireguard configuration.
- enabled: required(boolean)
- port: (integer - minimum: 1 - maximum: 65535)
The port the local instance of wireguard will listen on. Valid values are 1 to 65535.
- private_key: required(string)
The private key to use to authenticate the local wireguard interface.
- public_key: (string)
The public key that corresponds your private key, which wireguard peers will authenticate with.
- addresses: required(array of string)
The IPv4 CIDR addresses of the local wireguard interface.
- mtu: (integer - default: 1420 - minimum: 1200 - maximum: 1472)
The MTU for the local wireguard interface. Valid values are 1200 to 1472. 1420 is default if left unspecified.
- table: (string - pattern: ^([0-9]|[1-9][0-9]{1,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5]|auto|off)$)
The routing table for the wireguard routes. Can be a table number, 'off' or 'auto'. [regexerr:'auto', regexerr:'off', regexerr:a routing table number]
- pre_down_hooks: (array of string)
The commands to execute before closing a wireguard interface.
- pre_up_hooks: (array of string)
The commands to execute before starting a wireguard interface.
- post_down_hooks: (array of string)
The commands to execute after closing a wireguard interface.
- post_up_hooks: (array of string)
The commands to execute after starting a wireguard interface.
- peers: required(array of object)
The wireguard peers for this wireguard interface.
Items: items
- endpoint_address: (string)
A publicly accessible address (hostname or IP) for a remote peer. [required:endpoint_port:!=:]
- endpoint_port: (integer - minimum: 1 - maximum: 65535)
The port the remote wireguard peer is listening on. [required:endpoint_address:!=:]
- public_key: required(string)
The public key to used to authenticate this wireguard peer.
- allowed_ips: required(array of string)
The IPv4 network ranges that wireguard can route to this peer.
- keep_alive: (integer)
The persistent keep alive interval in seconds.
- endpoint_address: (string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
Example:
{
"wireguard": {
"name": "wg0",
"description": "Our wireguard vpn",
"enabled": true,
"addresses": [
"172.30.0.2/32"
],
"port": 51820,
"private_key": "****",
"public_key": "******",
"mtu": 1420,
"table": "1000",
"pre_down_hooks": [
"echo %i stopping"
],
"pre_up_hooks": [],
"post_down_hooks": [],
"post_up_hooks": [],
"peers": [
{
"endpoint_address": "1.2.3.4",
"endpoint_port": 51820,
"public_key": "********",
"allowed_ips": [
"172.30.0.0/24"
],
"keep_alive": 25
}
]
}
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- wireguard: required(object)
This object contains configuration information for a wireguard interface.
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
The name of the wireguard interface. Names must be unique, max 15 characters and only contain letters, numbers, hyphens or underscores. [regexerr:Uppercase and lowercase letters, regexerr:Numbers, regexerr:"_", regexerr:"-"]
- description: (string)
A description of the purpose of this wireguard configuration.
- enabled: required(boolean)
- port: (integer - minimum: 1 - maximum: 65535)
The port the local instance of wireguard will listen on. Valid values are 1 to 65535.
- private_key: required(string)
The private key to use to authenticate the local wireguard interface.
- public_key: (string)
The public key that corresponds your private key, which wireguard peers will authenticate with.
- addresses: required(array of string)
The IPv4 CIDR addresses of the local wireguard interface.
- mtu: (integer - default: 1420 - minimum: 1200 - maximum: 1472)
The MTU for the local wireguard interface. Valid values are 1200 to 1472. 1420 is default if left unspecified.
- table: (string - pattern: ^([0-9]|[1-9][0-9]{1,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[01][0-9]{2}|42949672[0-8][0-9]|429496729[0-5]|auto|off)$)
The routing table for the wireguard routes. Can be a table number, 'off' or 'auto'. [regexerr:'auto', regexerr:'off', regexerr:a routing table number]
- pre_down_hooks: (array of string)
The commands to execute before closing a wireguard interface.
- pre_up_hooks: (array of string)
The commands to execute before starting a wireguard interface.
- post_down_hooks: (array of string)
The commands to execute after closing a wireguard interface.
- post_up_hooks: (array of string)
The commands to execute after starting a wireguard interface.
- peers: required(array of object)
The wireguard peers for this wireguard interface.
Items: items
- endpoint_address: (string)
A publicly accessible address (hostname or IP) for a remote peer. [required:endpoint_port:!=:]
- endpoint_port: (integer - minimum: 1 - maximum: 65535)
The port the remote wireguard peer is listening on. [required:endpoint_address:!=:]
- public_key: required(string)
The public key to used to authenticate this wireguard peer.
- allowed_ips: required(array of string)
The IPv4 network ranges that wireguard can route to this peer.
- keep_alive: (integer)
The persistent keep alive interval in seconds.
- endpoint_address: (string)
- managed_by: (string)
The user or system responsible for management of this object. If managed_by is set to a non-empty string then client interfaces (like the web ui or config shell) will prevent users from editing this object. Managed_by should be an intelligible string as client interfaces may display it to users. [visible:managed_by:!=::stored]
- name: required(string - maxLength: 15 - pattern: ^[a-zA-Z0-9_-]+$)
Example:
{
"wireguard": {
"name": "wg0",
"description": "Our wireguard vpn",
"enabled": true,
"addresses": [
"172.30.0.2/32"
],
"port": 51820,
"private_key": "****",
"public_key": "******",
"mtu": 1280,
"table": "1000",
"pre_down_hooks": [
"echo %i stopping"
],
"pre_up_hooks": [],
"post_down_hooks": [],
"post_up_hooks": [],
"peers": [
{
"endpoint_address": "1.2.3.4",
"endpoint_port": 51820,
"public_key": "********",
"allowed_ips": [
"172.30.0.0/24"
],
"keep_alive": 25
}
]
}
}
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found, Wireguard configuration does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /wireguards/{id}
Delete the wireguard configuration and stop that wireguard interface.
NetOps Console Server base authentication scheme.
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Wireguard configuration was removed.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}
HTTP status code 404
Not found, Wireguard configuration does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c