Introduction
vSEC: CMS can be installed on a host as a client Admin application whereby an operator can log onto the vSEC: CMS OC. The Admin application can be configured to communicate with the vSEC: CMS server either over gRPC/HTTP or SOAP/HTTP. In this article, we will describe how you can install the Admin application and configure it to use gRPC or SOAP, or both.
For instructions on configuring the Admin application service on the server-side refer to the article vSEC:CMS Client-Server Communication for details.
Install
1. On the client host start the vSEC:CMS installer and click I Agree.
2. Select the Admin: Admin interface to the server option and click Next.
3. Select the default location for the installation or click Browse to install to a different location. Click Install to begin the installation.
4. When complete click Close.
Silent
It is possible to perform a silent install by passing /S to the installer. Additionally, you should pass the URL for the backend service that the Admin application needs to connect to. The parameter name is -soap_client and you should enter the full URL for the server where the operator console service is running.
For example, if you run from a command prompt it would be like below:
vSEC_CMS_Setup.exe /S -soap_client "http://my-cms-server:8443/adm"
Configure
From version 6.2 you can configure the connection settings by starting the application from the shortcut icon on the desktop. You will get a dialog similar to below. Depending on your configuration enter the URLs for SOAP or gRPC or both and specify what protocol to use.
Additionally, you can configure this through the registry. See the details below on how to do this.
It will be necessary to configure the connections to the backend where the vSEC:CMS server is running. This can be done via registry.
You can set this either based on per user (HKEY_CURRENT_USER) or per host (HKEY_LOCAL_MACHINE).
Note: Registry settings in HKEY_LOCAL_MACHINE will have higher priority over settings in HKEY_CURRENT_USER.
If you configure it per user then you need to set the below registry settings in this location:
[HKEY_CURRENT_USER\Software\Versatile Security\vSEC_CMS_T]
If you configure it per host then you need to set the below registry settings in this location for 32-bit version:
[HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Versatile Security\vSEC_CMS_T]
And here:
[HKEY_LOCAL_MACHINE\SOFTWARE\Versatile Security\vSEC_CMS_T]
for 64-bit version.
The registry values are:
cms.adm.server.protocol (DWORD)
Where the values can be:
1 - which sets Prefer SOAP;
2 - which sets Prefer gRPC;
3 - which sets Force SOAP;
4 - which sets Force gRPC.
Prefer SOAP and Prefer gRPC will configure the Admin application to try whichever one is set and if for whatever reason the preferred protocol is not available then the Admin application will try the other protocol.
grpc.adm.server.url (String)
Where you enter the URL of the backend where gRPC is listening. This would normally be configured by host name and port number, for example, http://<cms-host>:<port-number> OR if SSL/TLS is used https://<cms-host>:<port-number>
soap.adm.server.url (String)
Where you enter the URL of the backend where SOAP is listening. This would normally be configured by hostname and port number, for example, http://<cms-host>:<port-number>/adm OR if SSL/TLS is used https://<cms-host>:<port-number>/adm
Note: the /adm appended to the end for SOAP protocol is important to include otherwise the connection will fail.
Comments
0 comments
Please sign in to leave a comment.