mgmttelnet API

This document provides a brief description of the mgmttelnet OpEN APIs. It provides the following services:

• Sets admin mode of telnet Session.
• Gets admin mode of telnet session.
• Sets the port-number for Telnet Access.
• Gets telnet access port number.
• Sets maximum number of telnet sessions.
• Gets maximum number of telnet sessions.
• Sets telnet session timeout (in minutes).
• Gets telnet session timeout information.
• Sets new telnet sessions acceptance state.
• Gets new telnet session acceptance state.
• Gets current active number of telnet sessions.

Example C Application mgmttelnet_example

Initialization

In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.

mgmttelnet_example

mgmttelnet_example.c is a sample application that demonstrates the use of OpEN's mgmttelnet APIs. mgmttelnet_example is started from the command line and can be used to exercise the various APIs by specifying arguments on the command line.

Sample Output

• Usage: ./mgmttelnet_example <test#> <arg1> <arg2> ...
• Test 1: Sets admin mode of telnet Session: mgmttelnet_example 1 <mode>
• Test 2: Gets admin mode of telnet session: mgmttelnet_example 2
• Test 3: Sets the port-number for Telnet Access: mgmttelnet_example 3 <port><flag>
• Test 4: Gets telnet access port number: mgmttelnet_example 4
• Test 5: Sets maximum number of telnet sessions: mgmttelnet_example 5 <maxSession>
• Test 6: Gets maximum number of telnet sessions: mgmttelnet_example 6
• Test 7: Sets telnet session timeout (in minutes): mgmttelnet_example 7 <timeout>
• Test 8: Gets telnet session timeout information: mgmttelnet_example 8
• Test 9: Sets new telnet sessions acceptance state: mgmttelnet_example 9 <state>
• Test 10: Gets new telnet session acceptance state: mgmttelnet_example 10
• Test 11: Gets current active number of telnet sessions: mgmttelnet_example 11
• Test 12: Run API sanity checks: mgmttelnet_example 12

mgmttelnet CLI/API Cross Reference

CLI Command	OpEN API Reference
#telnetcon maxsessions <noOfRemoteSessions>	openapiAgentTelnetNumSessionsSet()
#telnetcon timeout <time>	openapiAgentTelnetTimeoutSet()
#ip telnet port <portNo>	openapiSwDevCtrlTelnetMgmtPortNumSet()
# [no] ip telnet server enable	openapiAgentTelnetAdminModeSet()
(Config-line)# [no] transport input telnet	openapiAgentTelnetNewSessionsSet()
#show telnetcon	openapiAgentTelnetAdminModeGet() openapiSwDevCtrlTelnetMgmtPortNumGet() openapiAgentTelnetNumSessionsGet() openapiAgentTelnetTimeoutGet() openapiAgentTelnetNewSessionsGet() openapiAgentTelnetCurrentNumSessionsGet()