This document will provide you with information & instructions on how to administer WSO2 Tungsten server using a menu driven command line tool instead of the AJAX Management Console. This tool is for the benefit of those who are more comfortable in using command line.
Although the AJAX driven Tungsten Management Console provides administrative functions in a fast and easy to use manner via GUIs, for the command line fans, there's nothing more efficient than a command line tool. This menu driven command line tool satisfies such users by giving them the power to administer Tungsten server using command lines.
This script file to run this tool is located in TUNGSTEN_HOME/bin
While WSO2 Tungsten server is running, run adminclient.bat or adminclient.sh and you will be asked to provide the following on the command prompt (or command line console):
WSO2-Tungsten Server IP : Type the IP address of the
remote server you want to administerWSO2-Tungsten Server HTTPS port : Type the port on which
the server is runningWSO2-Tungsten Server context root : If Tungsten is running
inside any Web application server, then type
“tungsten”if Tungsten is running as a standalone
server, then type “/”Admin Username: (default is admin)Password: (default is admin)If you are logged into the Tungsten admin console successfully you will get following on the command prompt (or command line console):
Log in successful. admin@127.0.0.1:9443/: w/>
Now you can administer the system by simply typing the commands listed in following section.
| Command | Description | Parameters |
|---|---|---|
| System (Server) Related | ||
| exit | Exits from console | |
| ss | Gets current status of the system | |
| sd | Gets the server information | |
| rs | Restarts Tungsten server | |
| logout | Signs out from system | |
| login | Signs into the system | |
| tr | Gets the number of requests to the system | |
| Axis2 Global Information | ||
| gp | Gets the global phases for a given flow | [gp flowIndex] |
| gph | Gets the handlers in a given global phase | [gph flowIndex phaseName] |
| sdp | Lists global parameters | |
| sp | Adds a new parameter or change existing parameter | [ssp name value locked(boolean)] |
| ds | Uploads a service archive file into the server | [ds absolute_file_path] |
| dm | Uploads a module archive file into the server | [dm absolute_file_path] |
| sgp | Lists service group parameters for a given service group | [sgp groupName] |
| sgdp | Lists declared service group parameters for a given service group | [sgdp groupName] |
| ssgp | Adds new parameter or change existing parameter | [ssgp groupName paraName paraValue locked] |
| rsg | Removes a service group from the server | [rsg groupName] |
| lsg | Lists all available service groups in the system | |
| Service Data | ||
| ls | Lists services in a given service group | [ls serviceGroupName] |
| src | Gets the number of request for a given service | [src serviceName] |
| gsp | Gets the parameters for a given service | [gsp serviceName] |
| gsdp | Gets the declared parameters for a given service | [gsp serviceName] |
| ssp | Adds a new parameter or change existing parameter | [ssp serviceName paraName paraValue locked] |
| wsdl | Gets the wsdl for a given service | [wsdl serviceName outputlocation] |
| gsd | Gets service data | [gsd serviceName] |
| start | Activate a given service | [start serviceName] |
| stop | Inactivate a given service | [stop serviceName] |
| cs | Creates a service in the server just by giving qualified name of a service | [cs className] |
| Service and Users | ||
| eufs | Enables a user for a given service | [eufs serviceName userName] |
| gsu | Gets all users for a given service | [gsu serviceName] |
| Operation Data | ||
| lop | Lists operation specific phases | [lop serviceName operationName flowIndex] |
| loph | Lists handlers in a given phase of an operation | [loph serviceName operationName flowIndex phaseName] |
| lpo | Lists only the published operations in a given service | [lpo serviceName] |
| lao | Lists all operations in a given service | [lao serviceName] |
| lco | Lists all the control operations in a given service | [lco serviceName] |
| gorc | Gets the number of requests count for a given operation | [gorc serviceName operationName] |
| gop | Gets operation parameters | [gop serviceName operationName] |
| godp | Gets declared operation parameters | [gop serviceName operationName] |
| sop | Sets or add a new parameter to a given operation | [sop serviceName operationName paraName paraValue locked] |
| Module Data | ||
| lm | Lists all available modules in the system | |
| lem | Lists globally engaged modules | |
| lsm | Lists all modules for a given service | [lsm serviceName] |
| gmp | Gets all available parameters for a given module | [gmp moduleName moduleVersion] |
| smp | Changes or add new parameters for a given module | [smp moduleName moduleVersion paraName paraValue locked] |
| emg | Engages module globally | [emg moduleName moduleVersion] |
| demg | Disengages module globally | [demg moduleName moduleVersion] |
| emts | Engages module to a given service | [emts serviceName moduleName moduleVersion] |
| dems | Disengages module from a given service | [dems serviceName moduleName moduleVersion] |
| emto | Engages module to a given operation | [emto serviceName operationName moduleName moduleVersion] |
| demo | Disengages module from a given operation | [demo serviceName operationName moduleName moduleVersion] |
| User/ Role Data | ||
| gu | Gets all the users in the system | |
| gr | Gets all available roles in the system | |
| ar | Adds a new role to the system | [ar roleName description] |
| au | Adds a new user to the system | [au userName password role] |
| eupw | Edits a given user | [eupw userName password oldpassword] |
| eur | Edits a given users role | [eur userName role] |