List of options that affect all Telnet connections.
URL
GET https://<IP-address-of-SPS>/api/configuration/telnet/options
Cookies
| session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists global Telnet options.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/telnet/options
Response
The following is a sample response received when listing the default global Telnet options.
For more information on the meta object, see Message format.
{
"body": {
"channel_database_cleanup": {
"enabled": false
},
"service": {
"enabled": false
}
}
}
"key": "options",
"meta": {
"first": "/api/configuration/telnet/channel_policies",
"href": "/api/configuration/telnet/options",
"last": "/api/configuration/telnet/options",
"next": null,
"parent": "/api/configuration/telnet",
"previous": "/api/configuration/telnet/channel_policies",
"transaction": "/api/transaction"
}
}
|
key |
|
Top level item |
Contains the ID of the endpoint. |
|
body |
|
Top level item |
Contains the elements of the global Telnet options. |
| |
channel_database_cleanup |
Top level item |
Contains settings for database cleanup. |
| |
service |
Top level item |
Global setting to enable Telnet connections, and specify the logging detail. |
| days |
integer |
Applies only if enabled is set to true.
Global retention time for the metadata of Telnet connections, in days. Must exceed the retention time of the archiving policy (or policies) used for Telnet connections, and the connection-specific database cleanup times (if configured). |
|
enabled |
boolean |
To enable the global cleanup of Telnet connection metadata, set this element to true. |
| log_level |
integer |
Applies only if enabled is set to true.
Defines the logging detail of Telnet connections. |
|
enabled |
boolean |
Set to true to enable Telnet connections. |
Examples
Querying the full list of global Telnet options:
{
"body": {
"channel_database_cleanup": {
"enabled": true,
"days": 365
},
"service": {
"enabled": true,
"log_level": 4
}
}
"key": "options",
"meta": {
"first": "/api/configuration/telnet/channel_policies",
"href": "/api/configuration/telnet/options",
"last": "/api/configuration/telnet/options",
"next": null,
"parent": "/api/configuration/telnet",
"previous": "/api/configuration/telnet/channel_policies",
"transaction": "/api/transaction"
}
}
Modify global Telnet settings
To modify global Telnet settings, you have to:
-
Open a transaction.
For more information, see Open a transaction.
-
Modify the JSON object of the global Telnet settings endpoint.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/telnet/options endpoint.
You can find a detailed description of the available parameters listed in Element.
For more information about the elements of the channel_database_cleanup item, see Elements of channel_database_cleanup.
For more information about the elements of the service item, see Elements of service.
-
Commit your changes.
For more information, see Commit a transaction.
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| 201 |
Created |
The new resource was successfully created. |
| 401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that the SPS REST API attempted to access, but could not retrieve. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that the SPS REST API attempted to access, but could not retrieve. |
| 404 |
NotFound |
The requested object does not exist. |
List of Telnet pattern sets that help to extract the username from Telnet connections.
URL
GET https://<IP-address-of-SPS>/api/configuration/telnet/pattern_sets
Cookies
| session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists the available Telnet pattern sets.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/telnet/pattern_sets
Response
The following is a sample response received when listing the available Telnet pattern sets.
For more information on the meta object, see Message format.
{
"items": [
{
"body": { "name": "Cisco devices",
"description: "Cisco devices that require authentication"
},
"key": "-8000",
"meta": { "href": "/api/configuration/telnet/pattern_sets/-8000" }
},
{
"body": { "name": "Cisco devices without authentication",
"description": "Cisco devices that do not require authentication"
},
"key": "-8001",
"meta": { "href": "/api/configuration/telnet/pattern_sets/-8001" }
},
{
"body": { "name": "General Telnet",
"description": "General Telnet servers (for example, Linux telnetd)"
},
"key": "-8002",
"meta": { "href": "/api/configuration/telnet/pattern_sets/-8002" }
}
],
"meta": {
"first": "/api/configuration/telnet/authentication_policies",
"href": "/api/configuration/telnet/pattern_sets",
"last": "/api/configuration/telnet/pattern_sets",
"next": null,
"parent": "/api/configuration/telnet",
"previous": "/api/configuration/telnet/options",
"remaining_seconds": 600,
"transaction": "/api/transaction"
}
}
| key |
|
string |
Contains the ID of the pattern set. The pattern set IDs can be used for specifying the active_pattern_sets JSON list at the configuration of Telnet authentication policies.. |
| body |
|
string |
Contains the descriptive name of the pattern set. |
|
name |
string |
Descriptive name of the pattern set. |
To upload a telnet pattern set:
-
Open a transaction.
For more information, see Open a transaction.
-
Upload the telnet pattern set file.
POST the valid_pattern_set.tps file to the https://<IP-address-of-SPS>/api/upload/pattern_set endpoint, for example:
curl -X POST --cookie cookies --insecure https://<IP-address-of-SPS>/api/upload/pattern_set --data-binary @<path-to-pattern_set.tps>
The following is a sample response received:
For details of the meta object, see Message format.
{
"body": {
"description": "Test Pattern Set description",
"name": "Test Pattern Set"
},
"key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"meta": {
"href": "/api/configuration/telnet/pattern_sets/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"parent": "/api/configuration/telnet/pattern_sets"
}
}
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| 400 |
PatternSetValidationFailed |
The validation of the telnet pattern set file failed. |
| 401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
-
Commit your changes.
For more information, see Commit a transaction.
Note the following points:
-
Built-in telnet pattern sets cannot be deleted. The ID of built-in pattern sets begins with "-".
-
Existing pattern sets cannot be re-loaded, only if you delete them beforehand.
Operations with the /pattern_sets endpoint
-
/api/configuration/telnet/pattern_sets: GET
-
/api/configuratation/telnet/pattern_sets/<id>: GET, DELETE
-
/api/upload/pattern_set: POST
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| 404 |
NotFound |
The requested object does not exist. |
| 405 |
DeleteNotAllowedOnBuiltInPatternSet |
The deletion of built-in telnet pattern sets is not allowed. |
List of endpoints for configuring the policies, options and connection rules of VNC connections.
URL
GET https://<IP-address-of-SPS>/api/configuration/vnc
Cookies
| session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists the available settings for configuring for VNC connections.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/vnc
Response
The following is a sample response received when listing the configuration settings.
For more information on the meta object, see Message format.
{
"items": [
{
"key": "channel_policies",
"meta": {
"href": "/api/configuration/vnc/channel_policies"
}
},
{
"key": "connections",
"meta": {
"href": "/api/configuration/vnc/connections"
}
},
{
"key": "options",
"meta": {
"href": "/api/configuration/vnc/options"
}
}
],
"meta": {
"first": "/api/configuration/aaa",
"href": "/api/configuration/vnc",
"last": "/api/configuration/x509",
"next": "/api/configuration/x509",
"parent": "/api/configuration",
"previous": "/api/configuration/troubleshooting",
"transaction": "/api/transaction"
}
}
| channel_policies |
List of the default and custom channel policies. |
|
connections |
List of the VNC connection policies. |
| options |
List of global VNC options that affect all connections. |
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| 401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 404 |
NotFound |
The requested object does not exist. |
