pscuiagentctl command

Purpose

Used to set up the PowerSC GUI agent options.

Syntax

pscuiagentctl disable logging

pscuiagentctl enable logging

pscuiagentctl get [localListeningPort]

pscuiagentctl get [socksProxyHost]

pscuiagentctl get [socksProxyPort]

pscuiagentctl get [remotePort]

pscuiagentctl get [verbose]

pscuiagentctl get [httpsProxyHost]

pscuiagentctl get [httpsProxyPort]

pscuiagentctl get [localBindAddress]

pscuiagentctl get [maxHeap]

pscuiagentctl get [jrePath]

pscuiagentctl get [enabledProtocols]

pscuiagentctl get [enabledCipherSuites]

pscuiagentctl set [localListeningPort]

pscuiagentctl set [socksProxyHost]

pscuiagentctl set [socksProxyPort]

pscuiagentctl set [remotePort]

pscuiagentctl set [verbose]

pscuiagentctl set [httpsProxyHost]

pscuiagentctl set [httpsProxyPort]

pscuiagentctl set [localBindAddress]

pscuiagentctl set [maxHeap]

pscuiagentctl set [jrePath]

pscuiagentctl set [enabledProtocols]

pscuiagentctl set [enabledCipherSuites]

Flags

disable logging: Disables pscuiagentctl debug logging.

enable logging: Enables pscuiagentctl debug logging. Sets the value com.rocketsoft.nm.vertical.powersc.endpoint.level=ALL in /opt/powersc/uiAgent/bin/jre/lib/logging.properties.

get: Gets a PowerSC GUI server option.

set: Sets or gets a PowerSC GUI server option.

Parameters

localListeningPort portno: Specifies the port number used by the PowerSC GUI agent to listen for secure communication from the PowerSC GUI server.

socksProxyHost servername: Specifies the server name of the SOCKS proxy server that will be referenced by the PowerSC GUI agent to send all communication to the PowerSC GUI server. The default value for socksProxyHost is an empty string signifying the agent will not use a SOCKS proxy server.

socksProxyPort portno: Specifies the port that the SOCKS proxy server uses to listen for communication from the PowerSC GUI agent. The default value for socksProxyPort is 1080.

remotePort portno: Specifies the port that the PowerSC GUI server listens for communications from the PowerSC GUI agent. This port is used when no SOCKS proxy server is specified.

verbose true | false: Enables verbose logging from the PowerSC GUI agent. The default is true.

httpsProxyHost hostname: Specifies the HTTPS proxy host for the PowerSC GUI agent.

httpsProxyPort port: Specifies the HTTPS proxy port for the PowerSC GUI agent.

localBindAddress address: Specifies the network address (usually an IP address and port number) on which to listen for incoming connections, specifying where the service is available on the network. The localBindAddress you specify must be a valid network address.

maxHeap value: Specifies the maximum amount of heap space. Consult your JRE documentation for guidelines on setting the maximum heap space.

jrePath path: Specifies the path for the Java™ Runtime Environment (JRE).

enabledProtocols value: Specify the comma-separated names of protocols to use, as allowed by the JRE. For example, TLSv1.3. Consult your JRE documentation for the allowed values. The values are written to /etc/security/powersc/uiAgent/uiAgent.conf

enabledCipherSuites value: Specify the comma-separated names of cipher suites to use, as allowed by the JRE. For example, "TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256". Consult your JRE documentation for the allowed values. The values are written to /etc/security/powersc/uiAgent/uiAgent.conf.

Exit Status

This command returns the following exit values:

0: Successful completion.
>0: An error occurred.

Examples

To view the port that the PowerSC GUI agent listens for secure communication from the PowerSC GUI server:
```
pscuiagentctl set|get localListeningPort 
  
```
To change the port on which the PowerSC GUI agent listens for secure communication from the PowerSC GUI server:
```
pscuiagentctl set localListeningPort portno 
  
```
To specify the name of the SOCKS proxy host server:
```
pscuiagentctl set socksProxyHost servername  
```
To specify the port on which the SOCKS proxy server listens for communication from the PowerSC GUI agent:
```
pscuiagentctl set  socksProxyPort portno 
```
To specify the port on which the PowerSC GUI server listens for communications from the PowerSC GUI agent:
```
pscuiagentctl set remotePort portno
```
To enable verbose logging:
```
pscuiagentctl set verbose true  
```
To disable verbose logging:
```
pscuiagentctl set verbose false  
```

To enable debug logging:

stopsrc -s pscuiagent
pscuiagentctl enable logging
startsrc -s pscuiagent

To disable debug logging:

stopsrc -s pscuiagent
pscuiagentctl disable logging
startsrc -s pscuiagent

To configure the PowerSC GUI agent HTTPS proxy host and port:

pscuiagentctl set httpsProxyHost localhost
pscuiagentctl set httpsProxyPort port-number

To configure the JRE path:

pscuiagentctl set jrePath "/usr/java8/jre"

To configure the localBindAddress:

pscuiagentctl set localBindAddress address:port

To configure the maxHeap:
```
pscuiagentctl set maxHeap value
```
To configure the enabledProtocols:
```
pscuiagentctl set enabledProtocols TLSv1.3
```

To configure the enabledCipherSuites:

pscuiagentctl set enabledCipherSuites TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256