WebMgmt API

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

• Sets System Web Mode.
• Gets admin mode of System Web.
• Sets the port-number for HTTP Access.
• Gets HTTP access port number.
• Sets maximum number of HTTP web sessions.
• Gets maximum number of HTTP web sessions.
• Sets HTTP session soft timeout (in minutes).
• Gets HTTP session soft timeout information.
• Sets HTTP session hard timeout (in hours).
• Gets HTTP session hard timeout information (in hours).

Example C Application webmgmt_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.

webmgmt_example

webmgmt_example.c is a sample application that demonstrates the use of OpEN's WebMgmt APIs. webmgmt_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: ./webmgmt_example <test#> <arg1> <arg2> ...
• Test 1: Sets System Web Mode: webmgmt_example 1 <mode>
• Test 2: Gets admin mode of System Web: webmgmt_example 2
• Test 3: Sets the port-number for HTTP Access: webmgmt_example 3 <port><flag>
• Test 4: Gets HTTP access port number: webmgmt_example 4
• Test 5: Sets maximum number of HTTP web sessions: webmgmt_example 5 <maxSession>
• Test 6: Gets maximum number of HTTP web sessions: webmgmt_example 6
• Test 7: Sets HTTP session soft timeout (in minutes): webmgmt_example 7 <timeout>
• Test 8: Gets HTTP session soft timeout information: webmgmt_example 8
• Test 9: Sets HTTP session hard timeout (in hours): webmgmt_example 9 <timeout>
• Test 10: Gets HTTP session hard timeout information (in hours): webmgmt_example 10
• Test 11: Run API sanity checks: webmgmt_example 11

WebMgmt CLI/API Cross Reference

CLI Command	OpEN API Reference
#ip http server	openapiSwDevCtrlWebMgmtModeSet()
#ip http port	openapiSwDevCtrlWebMgmtPortNumSet()
#ip http session maxsessions	openapiCliWebHttpNumSessionsSet()
#ip http session soft-timeout	openapiCliWebHttpSessionSoftTimeOutSet()
#ip http session hard-timeout	openapiCliWebHttpSessionHardTimeOutSet()
#show ip http	openapiSwDevCtrlWebMgmtModeGet() openapiSwDevCtrlWebMgmtPortNumGet() openapiCliWebHttpNumSessionsGet() openapiCliWebHttpSessionSoftTimeOutGet() openapiCliWebHttpSessionHardTimeOutGet()