SCP Command-line Options
Various command-line options are available to perform SCP-related tasks, such as installing, starting, and configuring SCP.
>You should execute the commands from the path where the SCP service is running, which is different in Windows and Linux.
The command-line options are categorized as:
>Examples of Using SCP Command-line Options
SCP Management Options
|
Option |
Description |
Windows | Linux |
|---|---|---|---|
|
–install or –i |
Installs the SCP service. |
a | x |
|
–installstart -mode "offline_uploader" |
Install and then start the SCP service in offline mode. |
a | x |
| -start |
Starts the SCP service. |
a | a |
|
-start -mode "offline_uploader" |
Starts the SCP service in offline mode. |
a | a |
|
-stop |
Stops the SCP service. |
a | a |
| -restart | Restart the SCP service. | a | a |
|
-restart -mode "offline_uploader" |
Restarts the SCP service in offline mode. |
a | a |
|
-status |
Checks if the SCP service is already running or not. |
a | a |
|
-remove or –r |
Removes the SCP service. |
a | x |
|
-help |
Displays information on various options. |
a | a |
|
–fr or –rf |
Initiates forced refresh of the SCP service running already. During the refresh operation, the usage is synched. |
a | a |
|
-hc |
Monitors the health of SCP and the RMS License Manager. This option logs the following details in the SCP log file: >Directory Services URL >License Manager URL >List of customers >Proxy settings, such as proxy mode and .pac file location. >Logging settings, such as enable/disable status, log level, log type, and log file location. >The configuration file path >Previous network communication success time >Current communication status with the RMS License Manager |
a | a |
NOTE On Linux:
>The commands start, stop, restart, and status are executed from the location /etc/init.d.
>Other commands are executed from the /usr/sbin location followed by the service name and list of arguments.
SCP Configuration Options
The command-line options described in this section are used to set SCP configuration properties. Consider the following points before using the command line configuration options:
>On Linux, to use the command line configuration options, you need to first stop SCP and then use the command-line option with SCP start. On Windows, you can directly use the restart option.
>The configuration options must be used in collaboration with the start option.
General Options
|
Option |
Description |
|---|---|
|
-overwrite |
Overwrites the values given in the SCP configuration file. NOTE This flag is used to permanently write the values given on command-line to the configuration file. When this option is not used, by default, the command-line values temporarily override the values given in the configuration file. |
|
-ypsaddress |
Sets the URL of Directory Services (DS) provided as an input. For example: https://demo-yps.com/YPServer. |
| -UsageUploadMode | Sets the mode to upload the usage data. |
Logging Options
|
Option |
Description |
|---|---|
|
–logging |
Enable/disable logging. Valid values are: >0: Logging is OFF >1: Logging is ON |
|
-loglevel |
Specify the level of logging (Error/Debug). Possible values are: >1: Error (Default) >2: Debug |
|
-logfilepath |
Specify the name and path of the log file. NOTE Currently, there is no limit on the maximum size of a log file. |
|
-logfilemode |
Specify if a new log file should be created or the existing file should be appended. Possible values are: >1: Create a new file for logging. >2: Append the existing file for logging. |
|
-logtype |
Specify whether to perform logging at system or file level. Possible values are: >1: Logging is to be done in a file. >2: Logging is to be done in the OS event logger. |
Proxy Options
|
Option |
Description |
|---|---|
|
No Proxy (ProxyMode value="1") |
|
|
-proxydisable |
Set the no-proxy mode. |
|
Manual Proxy Settings (ProxyMode value="2") |
|
|
-proxyhost |
Proxy host name or IP address. |
|
-proxyport |
Port at which proxy is running. |
|
-proxyuser |
User name used for the proxy authentication. Specify this if you want the proxy authentication to be done by credentials other than the system credentials. |
|
-proxypassword |
Proxy password used for the proxy authentication. Specify this if you want the proxy authentication to be done by credentials other than the system credentials. |
|
PAC-Proxy with PAC File Support Settings (ProxyMode value="3") |
|
|
-proxypac |
Location of the .pac file will be used for proxy detection. This option takes the URL or hosted path of the .pac file (such as, "http://ProxyScriptHostUrl/proxy.pac") as input. If ProxyPAC value is not set, and WPAD is defined on the client, then its settings are automatically detected. The proxy detection can be done using either DNS or DHCP discovery methods: >DHCP has a higher priority than DNS. The WPAD-enabled client first uses DHCP to find a proxy server, and if the desired information is not obtained, DNS is used. >If the wpad.dat file is not found or if a proxy is not detected while running wpad.dat, no error is returned. Instead, the client tries to connect in a manner similar to when the proxy is disabled (No Proxy). |
Examples of Using SCP Command-line Options
In all the examples given below, sntlcloudps refers to the name of the SCP executable.
Windows
To start scp in offline mode:
sntlcloudps_[vendor_alias].exe -start -mode "offline_uploader"
To restart scp in offline mode:
sntlcloudps[vendor_alias].exe -restart -mode "offline_uploader"
To set ypsaddress and disable proxy:
sntlcloudps[vendor_alias].exe –start –ypsaddress http://demo-yps/YPServer –proxydisable
To configure ypsaddress and manual proxy settings:
sntlcloudps[vendor_alias].exe –start –ypsaddress http://demo-yps/YPServer -proxyhost localhost –proxyuser sampleuser –proxypassword samplepwd –proxyport 5800
To configure ypsaddress and specify the auto-proxy through PAC:
sntlcloudps[vendor_alias].exe –start –ypsaddress http://demo-yps/YPServer -proxypac http://test.com/proxy.pac
To configure ypsaddress and logging settings:
sntlcloudps[vendor_alias].exe –start –ypsaddress http://demo-yps/YPServer –logging 1 –loglevel 1 –logfilepath C:/logfilepath/scp.log –logfilemode 1 –logtype 1
To overwrite ypsaddress in the SCP configuration file:
sntlcloudps[vendor_alias].exe –start –ypsaddress http://demo-yps/YPServer
–overwrite
To refresh sync usage when the SCP service is running:
sntlcloudps[vendor_alias].exe –fr
To run the health check:
sntlcloudps[vendor_alias].exe –hc
Linux
All the below commands are executed from the following path: /usr/sbin/.
NOTE The commands shown below are for 32-bit applications. For 64-bit applications, replace sntlcloudps by sntlcloudps64.
To start scp in offline mode:
/etc/init.d/sntlcloudps_[vendor_alias] start -mode "offline_uploader"
To restart scp in offline mode:
/etc/init.d/sntlcloudps_[vendor_alias] restart -mode "offline_uploader"
To set ypsaddress and disable proxy:
./sntlcloudps_[vendor_alias] –ypsaddress http://demo-yps/YPServer –proxydisable
To configure ypsaddress and manual proxy settings:
./sntlcloudps_[vendor_alias] –ypsaddress http://demo-yps/YPServer -proxyhost localhost –proxyuser sampleuser –proxypassword samplepwd –proxyport 5800
To configure ypsaddress and specify the auto-proxy through PAC:
./sntlcloudps_[vendor_alias] –ypsaddress http://demo-yps/YPServer -proxypac http://test.com/proxy.pac
To configure ypsaddress and logging settings.
./sntlcloudps_[vendor_alias] –ypsaddress http://demo-yps/YPServer –logging 1 –loglevel 1 –logfilepath /home/logfilepath/scp.log –logfilemode 1 –logtype 1
To overwrite ypsaddress in the SCP configuration file:
./sntlcloudps_[vendor_alias] –ypsaddress http://demo-yps/YPServer -overwrite
To sync usage when the SCP service is running:
./sntlcloudps_[vendor_alias] –fr
To run the health check:
./sntlcloudps_[vendor_alias] –hc