About Command Line
The PortRemoter Command Line is used to control the running state of the PortRemoter service and manage the settings that the PortRemoter Administrator is not capable of handing as follows:
Running State
The following command line switches can be used to change or query the running state of the PortRemoter service:
--start : Starts the PortRemoter service (normal):
user@DEMO:/home/user$ sudo PortRemoter --start
(does not return until service stopped)
--startd : Starts the PortRemoter service (daemonized):
user@DEMO:/home/user$ sudo PortRemoter --startd
Status: The PortRemoter service is starting
--pause : Pauses the PortRemoter service:
user@DEMO:/home/user$ sudo PortRemoter --pause
Status: The PortRemoter service is paused
--resume : Resumes the PortRemoter service:
user@DEMO:/home/user$ sudo PortRemoter --resume
Status: The PortRemoter service is running
--stop : Stops the PortRemoter service:
user@DEMO:/home/user$ sudo PortRemoter --stop
Status: The PortRemoter service is stopped
--status : Displays the PortRemoter service running state:
user@DEMO:/home/user$ sudo PortRemoter --status
Status: The PortRemoter service is stopped
Setting Properties
The following command line switches can be used to change some of the settings in the PortRemoter Administrator:
--enable : Sets the access mode to enabled, in which the Administrator allows full access to the settings:
user@DEMO:/home/user$ sudo PortRemoter --enable
Status: The PortRemoter Administrator is enabled
--lock : Sets the access mode to locked, in which the Administrator allows read-only access to the settings:
user@DEMO:/home/user$ sudo PortRemoter --lock
Status: The PortRemoter Administrator is locked
--disable : Sets the access mode to disabled, in which the Administrator is turned off:
user@DEMO:/home/user$ sudo PortRemoter --disable
Status: The PortRemoter Administrator is disabled
--credentials : Sets the username "hello" and password "world" for the Administrator, which is used to authenticate the connected user:
user@DEMO:/home/user$ sudo PortRemoter --credentials hello:world
Status: The PortRemoter Administrator credentials have been changed
And, if the username and password are not provided, then no user authentication is utilized:
user@DEMO:/home/user$ sudo PortRemoter --credentials
Status: The PortRemoter Administrator credentials have been changed
--listen : Sets the ipaddress "192.168.1.2" and port "443" for the Administrator to listen for incoming connections:
user@DEMO:/home/user$ sudo PortRemoter --listen 192.168.1.2:443
Status: The PortRemoter Administrator listen settings have been changed
The PortRemoter service needs to be stopped or paused before changing the listen settings.
--update : Modifies additional properties for the Administrator.
Below are some examples:
Sets the paired mode setting (Disabled or Enabled) for the Administrator:
user@DEMO:/home/user$ sudo PortRemoter --update PairedMode=Enabled
Status: The PortRemoter Administrator paired mode has been changed
Or, sets the data compression setting (Disabled or ClientResponses) for the Administrator:
user@DEMO:/home/user$ sudo PortRemoter --update DataCompression=ClientResponses
Status: The PortRemoter Administrator data compression has been changed
Or, sets the data encryption setting (Disabled or ClientResponses) for the Administrator:
user@DEMO:/home/user$ sudo PortRemoter --update DataEncryption=ClientResponses
Status: The PortRemoter Administrator data encryption has been changed
Or, sets the data validation setting (Disabled or ClientResponses) for the Administrator:
user@DEMO:/home/user$ sudo PortRemoter --update DataValidation=ClientResponses
Status: The PortRemoter Administrator data validation has been changed
Or, sets the private key setting (128-bit, 192-bit or 256-bit) for the Administrator:
user@DEMO:/home/user$ sudo PortRemoter --update PrivateKey=0123456789ABCDEF0123456789ABCDEF
Status: The PortRemoter Administrator private key has been changed
Or, sets the server certificate for the Administrator to enable HTTPS support:
user@DEMO:/home/user$ sudo PortRemoter --update ServerCertificate="My Certificate"
Status: The PortRemoter Administrator server certificate has been changed
The PortRemoter service needs to be stopped or paused before changing any of these settings.
--import : Imports additional Administrator properties from files.
Below are some examples:
Sets the certificate chain to use to identify the Administrator web application:
user@DEMO:/home/user$ sudo PortRemoter --import X509Certificate=./full-chain.pem
Status: The PortRemoter Administrator Administrator X.509 Certificate has been changed
Or, sets the private key for the leaf certificate in the certificate chain:
user@DEMO:/home/user$ sudo PortRemoter --import PKCS8PrivateKey=./cert-key.pem
Status: The PortRemoter Administrator PKCS #8 Private Key has been changed
The PortRemoter service needs to be stopped or paused before changing any of these settings.
--settings : Displays the Administrator settings:
user@DEMO:/home/user$ sudo PortRemoter --settings
Access Mode: Enabled
User Name: hello
Password: ***********
Local Address: 192.168.1.2
Local Port: 443
Server Certificate: My Certificate
Paired Mode: Enabled
Data Compression: Client Responses
Data Encryption: Client Responses
Data Validation: Client Responses
Private Key: 0123456789ABCDEF0123456789ABCDEF
Key Length: 128-bit
Quick Help
The following command line switch can be used to display quick help content:
--help : Displays quick help text.