The available Telnet channel types and their functionalities are described below.
Channel | Special options | Description |
---|---|---|
telnet | Yes |
telnet: Enables access to the server's terminal. This channel must be enabled for Telnet to work. Channel-specific actions:
For example: "actions": { "audit": true, "four_eyes": true, "content_policy": { "key": "433849548566ab327522e6" "meta": { "href": "/api/configuration/policies/content_policies/44287216854f482e7f2b24" } }, } |
Lists the configured authentication methods that can be used in a connection. Each connection policy uses an authentication policy to determine how the client can authenticate on the SPS gateway.
GET https://<IP-address-of-SPS>/api/configuration/telnet/authentication_policies
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 details on authentication, see Authenticate to the SPS REST API. Note that 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). |
The following command lists Telnet authentication policies.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/telnet/authentication_policies
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/telnet/authentication_policies<object-id>
The following is a sample response received when listing Telnet authentication policies.
For details of the meta object, see Message format.
{ "items": [ { "key": "-200", "meta": { "href": "/api/configuration/telnet/authentication_policies/-200" } }, { "key": "-304002001", "meta": { "href": "/api/configuration/telnet/authentication_policies/-304002001" } } } ], "meta": { "first": "/api/configuration/telnet/authentication_policies", "href": "/api/configuration/telnet/authentication_policies", "last": "/api/configuration/telnet/settings_policies", "next": "/api/configuration/telnet/channel_policies", "parent": "/api/configuration/telnet", "previous": null, "transaction": "/api/transaction" } }
When retrieving the endpoint of a specific policy, the response is the following.
{ "body": { "active_pattern_sets": [], "backend": { "selection": "ldap" }, "name": "telnet_auth_policy_with_ldap"
}
Element | Type | Description | ||
---|---|---|---|---|
key | string | Top level element, contains the ID of the policy. | ||
body | Top level element | Contains the elements of the policy. | ||
name | string | The name of the object. This name is also displayed on the SPS web interface. It cannot contain whitespace. | ||
active_pattern_sets | JSON list |
The list of patterns to use to extract the username from the sessions. For details, see "Extracting username from Telnet connections" in the Administration Guide. For example: "active_pattern_sets": ["-8000","-8001","-8002"] | ||
backend | Top level item | Client-side gateway authentication settings. The value of selection defines which authentication method is used. | ||
selection | string |
Defines the authentication method for client-side gateway authentication. Possible values are:
|
Elements of servers | Type | Description | |
---|---|---|---|
address | Top level element | Defines the address of a RADIUS server. | |
selection | string |
Required child of the address element. Possible values are:
| |
value | string | The IP or the FQDN address of the RADIUS server. | |
port | int | The port number of the RADIUS server. | |
shared_secret | string |
References the key of the shared secret for the RADIUS server. You can configure shared secrets at the /api/configuration/passwords/ endpoint. To modify or add a shared secret, use the value of the returned key as the value of the shared_secret element, and remove any child elements (including the key). Alternatively, you can include the new password as plain text. "shared_secret": { "plain": "<new-password>" } |
Querying base authentication policy without gateway authentication:
{ "key": "-304002001", "body": { "name": "base", "backend": { "selection": "none" } } }
Querying authentication policy with LDAP backend:
{ "key": "telnet-auth-pol-2", "body": { "name": "telnet_ldap", "backend": { "selection": "ldap", "timeout": 3600, "keepalive": true } } }
Querying authentication policy with local backend:
{ "key": "telnet-auth-pol-3", "body": { "name": "telnet_local", "backend": { "selection": "local", "user_database": { "key": "local-user-database-1", "meta": { "href": "/api/configuration/policies/user_databases/local-user-database-1" } }, "timeout": 3600, "keepalive": true } } }
Querying authentication policy with RADIUS backend:
{ "key": "telnet-auth-pol-4", "body": { "name": "telnet_radius", "backend": { "selection": "radius", "servers": [ { "address": { "selection": "ip", "value": "1.2.3.4" }, "port": 1812, "shared_secret": { "key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "meta": { "href": "/api/configuration/passwords#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } } } ], "authentication_protocol": "pap", "timeout": 3600, "keepalive": true } } }
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 |
---|---|---|
201 | Created | The new resource was successfully created. |
400 | InvalidQuery | The requested filter or its value is invalid. |
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. |
To add a Telnet authentication policy, you have to:
For details, see Open a transaction.
POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/telnet/authentication_policies/ endpoint. You can find a detailed description of the available parameters listed in Telnet authentication policies.
If the POST request is successful, the response includes the key of the new policy. For example:
{ "key": "6f924f39-e4c9-4b0f-8018-8842e2115ebd", "meta": { "href": "/api/configuration/telnet/authentication_policies/6f924f39-e4c9-4b0f-8018-8842e2115ebd", "parent": "/api/configuration/telnet/authentication_policies", "transaction": "/api/transaction" } }
For details, see Commit a transaction.
To modify a Telnet authentication policy, you have to:
For details, see Open a transaction.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/telnet/authentication_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in Telnet authentication policies.
For details, see Commit a transaction.
List of options that affect all Telnet connections.
GET https://<IP-address-of-SPS>/api/configuration/telnet/options
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 details on authentication, see Authenticate to the SPS REST API. Note that 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). |
The following command lists global Telnet options.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/telnet/options
The following is a sample response received when listing global Telnet options.
For details of the meta object, see Message format.
{ "body": { "audit": { "cleanup": { "enabled": false }, "timestamping": { "selection": "local", "signing_interval": 30 } }, "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" } }
Element | Type | Description | ||
---|---|---|---|---|
key | Top level item | Contains the ID of the endpoint. | ||
body | Top level item | Contains the elements of the global Telnet options. | ||
audit | Top level item | Contains settings for timestamping and cleanup. | ||
service | Top level item | Global setting to enable Telnet connections, and specify the logging detail. | ||
enabled | boolean | Set to true to enable Telnet connections. | ||
log_level | int | Defines the logging detail of Telnet connections. |
Set SPS as the timestamping server:
{ "audit": { "cleanup": { "enabled": false }, "timestamping": { "selection": "local", "signing_interval": 30 } }, "service": { "enabled": true, "log_level": 4 } }
Enable cleanup, and set it to occur every 10 days:
{ "audit": { "cleanup": { "channel_database_cleanup_days": 10, "enabled": true }, "timestamping": { "selection": "local", "signing_interval": 30 } }, "service": { "enabled": true, "log_level": 4 } }
Change timestamping to a remote server, without specifying a timestamping policy:
{ "audit": { "cleanup": { "channel_database_cleanup_days": 10, "enabled": true }, "timestamping": { "oid": { "enabled": false }, "selection": "remote", "server_url": "<url-of-timestamping-server>", "signing_interval": 30 } }, "service": { "enabled": true, "log_level": 4 } }
Change timestamping to a remote server, and specify the 1.2.3 timestamping policy:
{ "audit": { "cleanup": { "channel_database_cleanup_days": 10, "enabled": true }, "timestamping": { "oid": { "enabled": true, "policy_oid": "1.2.3" }, "selection": "remote", "server_url": "<url-of-timestamping-server>", "signing_interval": 30 } }, "service": { "enabled": true, "log_level": 4 } }
To modify global Telnet settings, you have to:
For details, see Open a transaction.
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 . The elements of the audit item are described in Elements of audit.
For details, see Commit a transaction.
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 |
---|---|---|
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 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. |
List of Telnet pattern sets that help to extract the username from Telnet connections.
GET https://<IP-address-of-SPS>/api/configuration/telnet/pattern_sets
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 details on authentication, see Authenticate to the SPS REST API. Note that 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). |
The following command lists the available Telnet pattern sets.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/telnet/pattern_sets
The following is a sample response received when listing the available Telnet pattern sets.
For details of the meta object, see Message format.
{ "items": [ { "body": { "name": "Cisco devices" }, "key": "-8000", "meta": { "href": "/api/configuration/telnet/pattern_sets/-8000" } }, { "body": { "name": "Cisco devices without authentication" }, "key": "-8001", "meta": { "href": "/api/configuration/telnet/pattern_sets/-8001" } }, { "body": { "name": "General Telnet" }, "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. |
NOTE: The pattern set files (the available pattern sets) can only be uploaded through the Web UI. REST API only provides read-only access.
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 |
---|---|---|
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. |
© ALL RIGHTS RESERVED. Feedback Termini di utilizzo Privacy Cookie Preference Center