GRPC
Start, stop, restart, and configure the gRPC server.
Syntax
GRPC <Application Path> Option <value> Server {Start On | Stop Off}
Description
You can start, stop, restart, and configure the gRPC server using the options in the table below. You must include Server and select a value (On/Off) for it. Default values will be used for any missing parameters.
The following options are available:| Option | Description |
|---|---|
| Host <host> | Use this to specify the host ID. |
| Port <Port> | Use this to specify the port number. |
| AllowExternalConnections <value> | Enter <value> as positive (true/yes/on) or negative (false/no/off). The default is false. |
| AuthenticationType <value> | Set <value> as one of the following: EnforceSingleUserLocal, MutualTLS, or Insecure. The default is EnforceSingleUserLocal. |
| TLSServerCertificateFilePath <"filepath"> | Provide a file path for the server certificate when AuthenticationType = MutualTLS. |
| TLSServerKeyFilePath <"filepath"> | Provide a file path for the key when AuthenticationType = MutualTLS. |
| TLSRootCertificateFilePath <"filepath"> | Provide a file path for the root certificate when AuthenticationType = MutualTLS. |
Examples
Enable the gRPC server:
GRPC / Server On
Set the gRPC port to 40704:
GRPC / Port 40704 Server On
Set the gRPC server to 127.0.0.1:
GRPC Host 127.0.0.1 Server On
Set the host to 127.0.0.1 and the port to 40704:
GRPC / Host 127.0.0.1 Port 40704 Server On
Configure an "open" gRPC server to disallow external connections and restrict to local use only:
GRPC / AllowExternalConnections false AuthenticationType EnforceSingleUserLocal Server On
Configure the gRPC server to MTLS and provide the server cert, key, and root cert:
GRPC / AuthenticationType MutualTLS TLSServerCertificateFilePath "C://Documents/STK/GRPC/MyServerCert.crt" TLSServerKeyFilePath "C://Documents/STK/GRPC/MyCertKey.key" TLSRootCertificateFilePath "C://Documents/STK/GRPC/MyRootCert.crt" Server On
Turn off the gRPC server:
GRPC / Server Off
Return message
Group membership
This command belongs to the following group(s):
Version
13.0.1