|
|
|
|
|
Wireless Data Server 2.5 | Administrator's Guide |
| View in pdf format |
| Go to User's Guide |
Server utilities
This appendix contains full instructions on the usage and syntax of all utilities used by Wireless Data Server. All utilities are installed in Wireless Data Server's bin directory, with the exception of smsnotify, which you must install on your calendar server host.
The following table lists all utilities in alphabetical order.
Table B.1 · Wireless Data Server utilities
CSPASSWD Set an encrypted password in a Wireless Data Server initialization file 51 SMSNOTIFY Send XML or plain-text content to Wireless Data Server via SMTP 53 WDS Install and uninstall Wireless Data Server 55 WDSCHKXSL Check the output of an XSL stylesheet 57 WDSCTRL Start, stop and monitor Wireless Data Server 58
CSPASSWDcspasswd -- Set an encrypted password in a Wireless Data Server initialization file.
SYNTAX
- cspasswd -f <filename> -s <section> -k <parameter> <value> [-D | -Q | -T]
- cspasswd -V
- cspasswd -H
DESCRIPTION
This utility encrypts a given string and sets the value of a specified parameter in a Wireless Data Server configuration file to the encrypted string. Use this utility to specify SYSOP passwords for your calendar server connections, and to specify a password for Wireless Data Server when using the SMPP plug-in.
OPTIONS
-D
-f
Specify the Wireless Data Server configuration file in which cspasswd will set the new value.
-k
Specify the name of the parameter to set, and the unencrypted string you want to set it to. If you do not specify the <value> argument on the command line, cspasswd will prompt you for it.
-Q
-s
Specify the section of the configuration file in which the desired parameter is to be found.
-T
-V
Print the current version number of cspasswd.
-H
Print a usage message explaining how to run cspasswd.
EXAMPLES
- Encrpyt and set the value of the [UNISON21] passwd parameter in /etc/config/wds.ini to "mypassword":
SMSNOTIFYsmsnotify -- Send Wireless Data Server an XML or plain text file for delivery via SMS.
SYNTAX
- smsnotify [[-host <hostname>] [-port <number>] | -hostlist <listofnames> [-loadbalance]] -n <msisdn> [-smsc <msisdn>] [-d <domain>] [-t <type>] [-calnotif] [-r <leadtime>] [-s <sender>] [-D] [-Q] [-T] < <contentfilename>
- smsnotify -v
- smsnotify -h
DESCRIPTION
The smsnotify utility is one way to send a message to Wireless Data Server for delivery. It initiates an SMTP connection with Wireless Data Server, and submits a specified file for delivery.
Oracle's calendar server invokes smsnotify to send calendar notifications and reminders to Wireless Data Server. You should never have to use the smsnotify utility yourself for this purpose; as long as smsnotify is installed and the calendar server is configured correctly, calendar notifications and reminders will be sent automatically. If you use an alternate content source such as a subscription server, you may choose to configure your content server to use smsnotify instead of sending messages to Wireless Data Server directly by SMTP.
If you do decide to use smsnotify to deliver content to Wireless Data Server, you must make sure that any additional MIME headers, such as X-Service, X-Content and Content-Type, are supplied along with the other message headers. In addition, some smsnotify options such as -domain, -calnotif and -r are only intended only for use by the calendar service; they should not be used for other services.
Specify the name of the file to be sent by preceding it on the command line with the < character.
Note that the smsnotify utility is in a separate package from the Wireless Data Server core. For the purposes of calendar notification, you must install it on your calendar server host, and configure your calendar server's unison.ini file to use it for notifications and reminders. Consult the smsnotify readme for details.
OPTIONS
-calnotif
Calendar-specific. Specifies that the current message is a calendar notification. Obsolete in calendar servers of version 5.1 or greater.
-d
Calendar-specific. Specifies the Domain ID of the message recipient.
-D
-host
Specify the name or address of the Wireless Data Server host. If this option is not specified, the local host is assumed.
-hostlist
Specify a list of Wireless Data Server hosts. By default, smsnotify will deliver the specified message to the first host in the list; if that host is down, smsnotify will try the next one. See also the -loadbalance option. Hosts in the list should be separated by a single blank space and specified in the following format: <hostname>:<port>
-loadbalance
Can only be used when the -hostlist option is specified. Causes smsnotify to choose hosts from the list at random rather than in the order presented.
-n
Specify the MSISDN of the intended recipient of the message.
-port
Specify the port number of the Wireless Data Server on the host specified by the -host option. If this option is not included, port 4573 is assumed.
-Q
-r
Calendar-specific. Specifies an alarm lead time for vCalendar messages.
-s
Specify a sender for this message.
-smsc
Specify a preferred SMSC to use for this message.
-t
Specify the type of mobile device used by the message recipient.
-T
-v
Print the current version number of smsnotify.
-h
Print a usage message explaining how to run smsnotify.
EXAMPLES
- Send a file named notification.xml to a user whose mobile phone number is +15147338500, using a Wireless Data Server installed on host "blue" and listening on port 4572:
WDSwds -- Install and uninstall Wireless Data Server.
SYNTAX
- wds -i [-n <name>] [-d <displayName>] [-s <startType>]
- wds -u
- wds -v
- wds -h
DESCRIPTION
This utility installs and uninstalls Wireless Data Server.
OPTIONS
-d
Specify a name for Wireless Data Server to display in the Services control panel on Windows operating systems. If this argument is not present, the default value is Wireless Data Server.
-i
Install Wireless Data Server on the local host.
-n
Specify a name for Wireless Data Server on Windows operating systems. If this argument is not present, the default value is wds.
-s
Specify a start type for Wireless Data Server on Windows operating systems. This argument may take either of the following values:
- start -- indicates that Wireless Data Server should run automatically on system startup;
- demand -- indicates that Wireless Data Server must be started manually.
If this argument is not present, the default value is demand.
-u
Uninstall Wireless Data Server from the local host.
-v
Print the current version number of wds.
-h
Print a usage message explaining how to run wds.
EXAMPLES
- Install Wireless Data Server on a UNIX system:
- Install Wireless Data Server on a Windows platform, specifying the display name "Oracle notification service", and specifying that manual startup will be required:
- Uninstall Wireless Data Server on either a UNIX or Windows system:
WDSCHKXSLwdschkxsl -- Check the output of a Wireless Data Server XML stylesheet.
SYNTAX
- wdschkxsl -xml <filename> -xsl <filename> [-param <name> <value>] [-out <filename>] [-t]
- wdschkxsl -v
- wdschkxsl -h
DESCRIPTION
This utility runs a specified XML document through a specified stylesheet, and returns the formatted text to standard output or a specified file.
Invoke the -param argument as many times as necessary to specify any additional parameters for the script to use (for example, the type of wireless device, notification language, etc.)
OPTIONS
-out
Specify an output file for the wdschkxsl utility. If this argument is not present, the utility prints to standard output.
-param
Specify a parameter and corresponding value to be passed to the processing stylesheet. If you specify a string for the parameter value, you must enclose it in single quotes.
-t
Calculate and print the processing time.
-xml
Specify an XML document for the wdschkxsl utility to transform.
-xsl
Specify an XSL stylesheet with which to format the document specified by the -xml option.
-v
Print the current version number of wdschkxsl.
-h
Print a usage message explaining how to run wdschkxsl.
EXAMPLES
- Format the /wds/etc/template/calendar_notif.xml file using the calendar_notif.xsl stylesheet, printing the results to standard output:
- Format the /wds/etc/template/calendar_notif.xml file using the calendar_notif.xsl stylesheet, specifying a French-language Nokia 9100 phone, and printing the results to a file named testresults.txt:
WDSCTRLwdsctrl -- Start, stop and monitor Wireless Data Server.
SYNTAX
- wdsctrl start [-D | -Q | -T]
- wdsctrl stop [-D | -Q | -T]
- wdsctrl status [-D | -Q | -T]
- wdsctrl -V
- wdsctrl -H
DESCRIPTION
This utility starts, stops, and gives the status of Wireless Data Server.
On Windows platforms, the Services control panel may be used as an alternative to this utility.
OPTIONS
-D
-Q
start
status
Report whether Wireless Data Server is up or down.
stop
-T
-V
Print the current version number of wdsctrl.
-H
Print a usage message explaining how to run wdsctrl.
EXAMPLES
|
|
|
|
|
| Copyright information | |||