Web Services Session; Sample Web Services Session - Quantum DXi V1000 Command Manual

Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012

Web Services Session

Sample Web Services
Session
8
• syscli --list share ... --ws localhost:9090
• syscli --list share ... --ws localhost
• syscli --list share ... --ws :9090
For security reasons the WS server cannot allow an arbitrary client to send
commands to it for execution. Before a client can execute any command, it has
to log in the WS server first in order to begin a WS session. If the login is
successful, the server will send back a credential token (an encrypted string). The
client has to include this credential token in all subsequent WS commands that
it sends to the server for execution. When the client is done with its commands,
it can log out the server. If the client is idle for more than 30 minutes, the server
automatically terminates the session. This time-out value can be overridden in
the login command.
A Web Services session begins when the user logs in successfully and terminates
when the user logs out (releases credential), or when the session is idle for
30 minutes.
During the session:
• Any CLI commands specified with the --ws option will be executed on the
axis2 server.
• Any CLI commands without the --ws option will be executed directly as
usual (i.e, not via Web Services).
Logging in to Start a Web Services Session
syscli --authenticate --name <username> --password <password> --client
<client_info> --ws [<host>:[<port>]]
Use this CLI command to start a Web Services session. If the password is not
specified, the system will prompt for it interactively. In this case, the password is
not echoed on screen.
Running CLI Commands
After login, each subsequent command, uses the term --list share, which can be
used as follows:
syscli --list share [--credtoken <credential_token>] --ws [<host>:[<port>]]
Note that the syntax of running a CLI command over Web Services is
unchanged, except that it must have a mandatory option --ws and an optional
option --credtoken. Here, credential_token is the value returned in the output
of the authenticate command. The --credtoken can be specified explicitly or
omitted because the syscli program is smart enough to cache the credential
token in the authenticate command for subsequent use.
Web Services Support (Optional)