2.9 Options for Launching a Remote Management Operation

When you launch a remote management operation from the command line, you can specify options to control the behavior of the remote session. For example, specifying the remotecontrol option launches a Remote Control operation on the device and specifying the notoolbar option hides the toolbar of the viewing window.

Remote Management uses certain options internally when you launch a remote management operation on a device. For example, the zenrights option specifies that the authentication scheme is ZENworks Rights Authentication. You must not specify these internal options when you use the command line to launch a remote management operation on a device. For more information on the options that are internally used, see Section 2.9.2, Internal Options for Launching a Remote Operation.

Review the following sections for more information on the remote management options:

2.9.1 Command Line Options for Launching a Remote Operation

Use the following command line options to control a remote operation:

Table 2-1 Command Line Options for Launching a Remote Operation

Command Line Option

Parameter

Description

listen

port

Enables the listener to listen to the remote session requests on the port specified. By default, the port is 5550.

restricted

 

Hides the toolbar and system menu.

viewonly

 

Launches a Remote View operation on the managed device.

remotecontrol

 

Launches a Remote Control operation on the managed device.

ftponly

 

Launches a File Transfer operation on the managed device.

remoteexecute

 

Launches a Remote Execute operation on the managed device.

diagnostics

appname

Launches a Remote Diagnostics operation on the managed device. If the appname parameter is specified, then that application is launched on the managed device.

filecompressionlevel

level

Provides means of optimizing the file compression process for better speed or better compression during a file transfer operation. The compression level can vary from 0 to 9:

  • 0 indicates no compression

  • 1 indicates best speed

  • 9 indicates best compression

If the compression level is not specified, the default compression level of 6, which is optimized for both speed and compression, is used.

noencrypt

 

Launches the remote session in an unencrypted mode.

fullscreen

 

Launches a remote operation in the full screen mode on the managed device.

notoolbar

 

Hides the toolbar of the viewing window.

exclusive

 

Launches the remote session in an exclusive mode.

8bit

 

Specifies the color depth to be used to render the session data.

shared

 

Enables a shared connection, allowing you to share the desktop with other clients already using it. This option is True by default.

collaborate

 

Launches the remote session in a collaborative mode. This option is not yet supported on Linux.

noshared

 

Enables an unshared connection, which disconnects other connected clients or refuses your connection, depending on the server configuration.

swapmouse

 

Swaps the mouse buttons.

nocursor

 

Displays only the managed device mouse pointer. The local mouse pointer is not displayed.

dotcursor

 

Displays the local mouse pointer as a dot. This option is true by default.

smalldotcursor

 

Displays the local mouse pointer as a small dot.

normalcursor

 

Displays the local mouse pointer in the default shape.

belldeiconify

 

Allows the transmission of a bell character, causing a beep at the viewer. This option also causes a minimized vncviewer to be maximized when the bell character is received.

emulate3

 

Users with a two-button mouse can emulate a middle button by pressing both buttons at once. This option is True by default

noemulate3

 

Does not emulate a three-button mouse.

nojpeg

 

Disables lossy JPEG compression. This is not recommended because the efficiency of the encoder might reduce. You might want to use this option if it is absolutely necessary to achieve a perfect image quality.

nocursorshape

 

Disables the cursor shape updates to handle remote cursor movements. Using the cursor shape updates decreases the delays with remote cursor movements, and can improve bandwidth usage dramatically.

noremotecursor

 

Does not show the remote cursor.

fitwindow

 

Hides the scroll bar of the viewing window.

scale

percentage

Zooms the viewing window to the percentage of scaling specified.

emulate3timeout

ms

Specifies the time-out for emulating a three-button mouse.

disableclipboard

 

Disables the copying of data into the clipboard.

delay

 

Renders a display area and waits for the specified time before retrieving the next update.

loglevel

n

Specifies the levels of information logging.

console

 

Logs information in a console window.

logfile

filename

Name of the log file where information is to be logged.

config

filename

Name of the configuration file to be used for loading predefined configuration settings.

key

filename

Name of the file where private key is stored. This key is used during an SSL handshake with the managed device.

IMPORTANT:The key and the cert options must be used together. If you use these options along with the nzrViewer command, then for security reasons you must disable the Allow connection when Remote Management Console does not have SSL certificate option in the security settings of the Remote Management policy.

cert

filename

Name of the file where the certificate corresponding to the private key is stored.

IMPORTANT:The key and the cert options must be used together. If you use these options along with the nzrViewer command, then for security reasons you must disable the Allow connection when Remote Management Console does not have SSL certificate option in the security settings of the Remote Management policy.

CAcert

filename

Name of the file where the root certificate is stored. This certificate is used to verify the managed device certificate during an SSL handshake.

encoding

encname

Specifies the desired encoding to be used for the session. The different types of encoding are Raw, CopyRect, RRE, CoRRE, Hextile, Zlib, and Tight.

compresslevel

n

Specifies the compression level to compress the remote session data from 0 to 9. Level 1 uses a minimum of CPU time and achieves weak compression ratios, and level 9 offers best compression but is slow in terms of CPU time consumption on the server side. Use high levels with very slow network connections, and low levels when working over high-speed LANs. We recommend that you do not use compression level 0.

quality

n

Specifies the JPEG quality level from 0 to 9. Quality level 0 denotes poor image quality but very impressive compression ratios, and level 9 offers very good image quality at lower compression ratios.

zenpasswd

 

Specifies that the authentication scheme to be used is ZENworks Password Authentication.

locale

 

Specifies the locale in which the resources are to be displayed. By default, English is used. The values for this option are: English, French, German, Spanish, Portuguese, Japanese, Italian, Chinese(Simplified), and Chinese(Traditional).

proxy

proxy_server

Specifies the DNS name or the IP address of the remote management proxy and the port number in one of the following formats:

  • IP address~~Port. For example 10.0.0.0~~5750.

  • IP address~Port. For example 10.0.0.0~50.

The default port for the proxy is 5750. This option is not yet supported on Linux.

2.9.2 Internal Options for Launching a Remote Operation

The following table lists the options that Remote Management uses internally. These options should not be used when you launch a remote management operation from the command line.

Table 2-2 Internal Options for Launching a Remote Operation

Option

Description

zenrights

Specifies ZENworks Rights Authentication as the authentication scheme.

pipe

Specifies authentication information.