/sessions

The sessions endpoint is used to authenticate the user and create a session token for accessing all other NetOps Console Server endpoints.

post

Create a new authenticated session.

get

Retrieve the state of an authentication session.

put

Apply a challenge response to a session

delete

Log out of and delete a session

/ports

Configuring and viewing ports information [no_sorting_required]

get

Gets ports attached to the NetOps Console Server appliance.

put

Update properties for all ports attached to the NetOps Console Server appliance.

Viewing and deleting of any active session on a specific port.

get

Retrieve a single port by ID.

put

Set the properties for a single port.

get

Retrieve all active sessions on this port.

delete

Disconnect active sessions on this port. Use query parameters to select a subset of sessions for disconnection. If no query parameters are given, all sessions on this port will be disconnected.

get

Retrieve an active session on this port.

delete

Disconnect the session.

put

Control power for a console device.

post

Reset the tx/rx counters for a particular serial port.

Manage Port Auto-Discovery

post

Trigger the port Auto-Discovery process

delete

Cancel an Auto-Discovery job

get

Get Port Auto-Discovery state

Manage Port Auto-Discovery Scheduling

put

Schedule the Port Auto-Discovery process

get

Get the Port Auto-Discovery schedule

Get auto_discovery logs.

get

Get auto_discovery logs.

Get logs for the last auto_discovery run.

get

Get logs for the last auto_discovery run.

Provides information about the serial pin status and Tx & Rx counters for each of this device's serial ports

get

Gets the list of active pin status for all serial port signals and the Tx and RX byte counters.

/managementports

Used for working with local management console information.

get

Gets the local management console ports attached to the NetOps Console Server appliance.

put

Set the properties for local management console ports.

Used for working with a specific management port.

get

Retrieve a single local management console port by ID.

put

Set properties for a single local management console port.

/logs

Used for working with the logs on the system.

get

Fetch last n log lines in syslog.

get

Fetch last n log lines in portlog.

logs/portlog_settings endpoint is to check and update port log settings.

get

Retrieve the current settings.

put

Set the port log settings.

/monitor

Used for monitoring the state of the various services running on the system.

Used for monitoring the state of the various network discovery (LLDP/CDP) protocols running on the system.

Get the current status of the network discovery (LLDP/CDP) protocols on this device.

get

Get the current status of the network discovery (LLDP/CDP) protocols on this device.

Get the list of neighboring devices (peers) that have been discovered by the LLDP protocol.

get

Get the list of neighboring devices (peers) that have been discovered by the LLDP protocol.

Retrieve a single LLDP neighbor status by ID. Used for working with a specific LLDP neighbor status item.

get

Retrieve a single LLDP neighbor status by ID.

Used for monitoring addresses banned by Brute Force Protection.

get

Retrieves information about IP addresses banned by Brute Force Protection

Used for working with a specific ban.

get

Retrieve a single ban by ID.

Used for monitoring the status of static routes. Only IPv4 static routes are supported.

get

Retrieves information about the status of static routes.

Used for working with a specific static route status.

get

Retrieve a single static route status by ID.

/services

Used for working with the properties of the various services running on the system.

Provides access to the Brute Force Protection configuration on the system. When this service is enabled, the system watches for multiple failed login attempts and temporarily bans the offending IP Address for the configured amount of time.

get

Retrieves the Brute Force Protection configuration

put

Set the Brute Force Protection configuration

Provides access to the SSL certificate used by web services on the device.

get

Returns the current HTTPS certificate, CSR details and indicate if a pending CSR exists.

put

Create a new CSR, delete the pending CSR or upload the certificate for the pending CSR.

get

download description

Trivial File Transfer Protocol (TFTP) is a service that allows files to be transferred to or from the NetOps Console Server appliance. This entity provides access to the TFTP server configuration on the system.

get

Retrieves the TFTP server configuration.

put

Set the TFTP server configuration.

Provides access to the NTP client configuration on the system.

get

Fetch NTP client configuration.

put

Set the NTP client configuration, including enabling/disabling the NTP service.

Provides information the current synchronization state of NTP

get

Gets the current sync status for NTP

Provides access to the Network Discovery Protocols (LLDP/CDP) configuration.

get

Fetch the Network Discovery Protocols configuration.

put

Modify Network Discovery Protocols configuration.

Provides access to the remote syslog server configuration.

get

Fetch remote syslog server configuration list.

post

Create a new syslog server data in the configuration.

get

Fetch a configured syslog server by id.

put

Set the syslog server configuration

delete

Delete a syslog server.

Retrieve and configure the SNMP TRAP/INFORM settings.

get

Get the snmp manager legacy configuration.

put

Set the snmp manager legacy configuration.

SNMP Alert Managers are used to receive and log SNMP TRAP and INFORM messages sent by the NetOps Console Server. To receive SNMP alerts generated by the system at least one SNMP Alert Manager must be configured.

get

Get the snmp manager configuration.

post

Add a new snmp manager.

get

Get the configuration of an SNMP Manager

put

Update settings for SNMP Managers on the NetOps Console Server appliance.

delete

Delete an snmp manager

Simple Network Management Protocol (SNMP) is an Internet Standard protocol for collecting and organizing information about managed devices on IP networks and for modifying that information to change device behaviour. This entity allows configuration of the SNMP service.

get

Get the snmpd configuration.

put

Set the snmpd configuration.

Configure the Secure Shell Protocol (SSH) service.

get

Fetch configuration for the SSH service.

put

Set configuration for the SSH service.

Retrieve and configure routing services on the NetOps Console Server appliance.

get

Fetch the configuration for the available routing daemons.

put

Set the configuration for the available routing daemons.

/alerts

Used to configure various types of alerts

Retrieve and configure Authentication Trap Group settings.

get

Get the authentication trap group settings.

put

Set the authentication trap group settings.

Retrieve and configure System Trap Group settings.

get

Get the system trap group settings.

put

Set the system trap group settings.

Retrieve and configure Networking Trap Group settings.

get

Get the networking trap group settings.

put

Set the networking trap group settings.

Retrieve and configure config change trap group settings.

get

Get the config change trap group settings.

put

Set the config trap group settings.

/monitoring

Used to configure various types of monitoring systems

Used to configure various types of alerts

Retrieve and configure Networking Alert Group settings.

get

Get the networking alert group settings.

put

Set the networking alert group settings.

Retrieve and configure Power Alert Group settings.

get

Get the power alert group settings.

put

Set the power alert group settings.

Retrieve and configure System Alert Group settings.

get

Get the system alert group settings.

put

Set the system alert group settings.

/physifs

Read and manipulate the network physical interfaces on the NetOps Console Server appliance.

get

Get a list of the network interfaces on the NetOps Console Server appliance.

post

Add a new interface to the NetOps Console Server appliance.

put

Update a list of the network interfaces on the NetOps Console Server appliance.

get

Get a network interface on the NetOps Console Server appliance by id.

put

Update settings for a network interface on the NetOps Console Server appliance.

delete

Delete a network interface by id. Currently only aggregate interfaces can be deleted.

/conns

Read and manipulate the network connections on the NetOps Console Server appliance.

get

Get a list of the network connections on the server.

post

Add a new network connection to the NetOps Console Server appliance.

get

Get the configuration of a network connection on the NetOps Console Server appliance.

put

Update settings for a network connection on the NetOps Console Server appliance.

delete

Delete a network connection on the NetOps Console Server appliance.