HTTP status code 200

Body

Media type: application/json

Type: object

• 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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "text": "Invalid login credentials",
      "args": {},
      "level": 1
    }
  ]
}

{
  "error": [
    {
      "type": 7,
      "code": 113,
      "text": "You are required to change your password immediately",
      "args": {},
      "level": 1
    }
  ]
}

{
  "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
    }
  ]
}

HTTP status code 200

Session exists

Body

Media type: application/json

Type: object

• 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

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "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

HTTP status code 200

Response applied. Next challenge in {challenge} if required.

Body

Media type: application/json

Type: object

• 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

• error: required(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

• error: required(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

• error: required(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

• error: required(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

HTTP status code 200

Session deleted

Body

Media type: application/json

Type: object

• 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

• error: required(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

• error: required(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

HTTP status code 200

The array of ports, either a full array or as requested by parameters

Body

Media type: application/json

Type: object

• 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]

  • 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: (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"]

  • 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]

  • 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.

  • 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.

Example:

{
  "ports": [
    {
      "parity": "none",
      "label": "Port-1",
      "id": "ports-1",
      "escape_char": null,
      "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,
      "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,
      "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,
      "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": null,
      "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,
      "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": null,
      "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,
      "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": null,
      "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,
      "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,
      "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,
      "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,
      "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,
      "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

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "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

• error: required(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

• error: required(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

HTTP status code 200

The array of ports, either a full array or as requested by parameters

Body

Media type: application/json

Type: object

• 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]

  • 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: (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"]

  • 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]

  • 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.

  • 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.

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": null,
      "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": null,
      "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": null,
      "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

• error: required(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

• error: required(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

• error: required(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

• error: required(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

HTTP status code 200

Port has been updated.

Body

Media type: application/json

Type: object

• 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]

  • 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: (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"]

  • 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]

  • 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.

  • 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.

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

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "error": [
    {
      "type": 7,
      "code": 46,
      "level": 1,
      "text": "Permission denied",
      "args": {}
    }
  ]
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Port has been updated.

Body

Media type: application/json

Type: object

• 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]

  • 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: (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"]

  • 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]

  • 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.

  • 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.

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

• error: required(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

• error: required(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

• error: required(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

• error: required(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

HTTP status code 200

Body

Media type: application/json

Type: object

• 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.

Example:

{
  "port_sessions": [
    {
      "username": "alice",
      "client_pid": 123
    }
  ]
}

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "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

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

• disconnected_session_count: required(integer)

Example:

{
  "disconnected_session_count": 1
}

HTTP status code 400

Incomplete data

Body

Media type: application/json

Type: object

• error: required(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

• error: required(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

HTTP status code 200

Body

Media type: application/json

Type: object

• 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.

Example:

{
  "port_session": {
    "username": "alice",
    "client_pid": 123
  }
}

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "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

HTTP status code 204

Request succeeded.

HTTP status code 400

Incomplete data

Body

Media type: application/json

Type: object

• error: required(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

• error: required(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

HTTP status code 200

Power command executed.

Body

Media type: application/json

Type: object

• cmd: required(string)

Example:

{
  "cmd": "/usr/bin/ogpowergroup 'port16' cycle"
}

HTTP status code 400

Power command failed.

Body

Media type: application/json

Type: object

• error: required(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

• error: required(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

• error: required(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

• error: required(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

HTTP status code 200

The counter reset was successfully performed.

Body

Media type: application/json

Type: object

• 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

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

• error: required(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

• error: required(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

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:

      .+

• 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:

      .+

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(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

• error: required(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

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

• error: required(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

• error: required(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

HTTP status code 200

The Port Auto-Discovery script state

Body

Media type: application/json

Type: object

• auto_discover: required(object)

  The Port Auto-Discovery root object

  • status: required(string)

    The status, as returned by the Port Auto-Discover process

Example:

{
  "auto_discover": {
    "status": "running"
  }
}

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "error": [
    {
      "type": 7,
      "code": 46,
      "level": 1,
      "text": "Permission denied",
      "args": {}
    }
  ]
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

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]

• 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]

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(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

• error: required(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

• error: required(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

• error: required(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

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]

• 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]

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

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "error": [
    {
      "type": 7,
      "code": 46,
      "level": 1,
      "text": "Permission denied",
      "args": {}
    }
  ]
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Body

Media type: application/json

Type: object

• 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

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "error": [
    {
      "type": 7,
      "code": 46,
      "level": 1,
      "text": "Permission denied",
      "args": {}
    }
  ]
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Body

Media type: application/json

Type: object

• 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

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "error": [
    {
      "type": 7,
      "code": 46,
      "level": 1,
      "text": "Permission denied",
      "args": {}
    }
  ]
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

An object containing an array of ports with their corresponding signal values

Body

Media type: application/json

Type: object

• 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.

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

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "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

• error: required(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

HTTP status code 200

An object containing an array of ports with their corresponding signal values

Body

Media type: application/json

Type: object

• 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.

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

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "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

• error: required(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

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

• 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.

• 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

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "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

• error: required(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

• error: required(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

HTTP status code 200

Management Ports have been updated.

Body

Media type: application/json

Type: object

• 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.

• 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

• error: required(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

• error: required(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

• error: required(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

• error: required(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

HTTP status code 200

management port has been updated.

Body

Media type: application/json

Type: object

• 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.

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

• error: required(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

• error: required(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:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

{
  "error": [
    {
      "type": 7,
      "code": 46,
      "level": 1,
      "text": "Permission denied",
      "args": {}
    }
  ]
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Management Port has been updated.

Body

Media type: application/json

Type: object

• 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.

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

• error: required(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

• error: required(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

• error: required(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

• error: required(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

HTTP status code 200

Returns the last n lines in the syslog

Body

Media type: application/json

Type: object

• 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

• error: required(array of object)

  A list of errors

  Items: items

  • type: required(integer)
  • code: required(integer)
  • level: required(integer)
  • text: required(string)
  • args: required(object)