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
| Cookie name | Description | Required | Values |
|---|---|---|---|
| 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"
}
}
| Element | Type | Description | |
|---|---|---|---|
| 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.
Code Description Notes 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.
| Code | Description | Notes |
|---|---|---|
| 404 | NotFound | The requested object does not exist. |
| 405 | DeleteNotAllowedOnBuiltInPatternSet | The deletion of built-in telnet pattern sets is not allowed. |
