CLI Reference > Server Administration Commands > integrity setserveralert
  
integrity setserveralert
creates and clears Windchill RV&S Server alert messages
Synopsis
integrity setserveralert [--clear] [--message=value] [--messageFile=value] [--height=value] [--width=value] [--user=name] [--hostname=server] [--password=password] [--port=number] [(-?|--usage)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [-g|--gui] [(-Ffile|--selectionFile=file)] [--settingsUI=[gui|default]] [--quiet] [--status=[none|gui|default]]
Description
integrity setserveralert sends alert messages to all users currently logged in to the Windchill RV&S Server, or clears the current alert message. The alert message displays who sent the message, the server it came from, when it was sent, and the message. Sending alert messages is useful for notifying users about important information, such as an impending server upgrade in which the server will be shut down.
* 
To create and clear alert messages, you need one of the following permissions: mks:AdminServer, mks:im:Admin, mks:im:AdminServer, mks:si:AdminServer.
You can create one message for a given server at a single time. Creating a new message deletes the previous message.
Alert messages are stored in the server’s memory. If the server shuts down, the message is deleted.
If a user connects to the server after a message is sent, the user still receives the message.
For users working in the Windchill RV&S Client GUI with the system tray or Web interface for workflows and documents, alert messages appear in a window at the bottom of the interface. Users working in the CLI and Windchill RV&S Client GUI without the system tray must manually check for alert messages from the CLI.
Alert messages are plain text only and allow a maximum 4000 KB.
In the Web interface, the date displayed for an alert message is the server’s date, time, and time zone. In the GUI and CLI, the date displayed for an alert message is the client’s date, time, and time zone.
Options
This command takes the universal options available to all integrity commands, as well as some general options. See the options reference page for descriptions.
--clear=server
clears the current alert message.
--message=value
specifies the alert message to send to all users currently logged in to the Windchill RV&S Server.
--messageFile=server
specifies a file containing the alert message to send to all users currently logged in to the Windchill RV&S Server.
--hostname=server
specifies the name of the Windchill RV&S Server to send the alert message to.
--port=number
specifies the port of the Windchill RV&S Server to send the alert message to.
See Also
Commands: integrity serveralerts, integrity viewserveralert, integrity admingui, integrity servers
Miscellaneous: options