Difference between revisions of "OPC UA Client Application Operations in OpcCmd"

From OPC Labs Knowledge Base
Jump to navigation Jump to search
Line 4: Line 4:
  
 
# At the {{Style=label|OpcCmd>}} prompt, enter {{Style=keyboard|uaClient getService uaClientApplication}}, or shortened: {{Style=keyboard|uac gs uaca}}.<br/>The program responds with the name of the client application (""OPC Command-line Tool"), which will be used for registrations to GDS. If this is the first time the program is run, it also creates its self-signed client certificate.<br/>All following commands are entered at the {{Style=label|uaClientApplication>}} prompt. You can enter <code>-?</code>, <code>-h</code> or <code>--help</code> (possibly preceded by the command name) at any time to obtain help for this prompt (or its commands).
 
# At the {{Style=label|OpcCmd>}} prompt, enter {{Style=keyboard|uaClient getService uaClientApplication}}, or shortened: {{Style=keyboard|uac gs uaca}}.<br/>The program responds with the name of the client application (""OPC Command-line Tool"), which will be used for registrations to GDS. If this is the first time the program is run, it also creates its self-signed client certificate.<br/>All following commands are entered at the {{Style=label|uaClientApplication>}} prompt. You can enter <code>-?</code>, <code>-h</code> or <code>--help</code> (possibly preceded by the command name) at any time to obtain help for this prompt (or its commands).
# {{Style=keyboard|registerToGds opc.tcp://opcua.demo-this.com:58810/GlobalDiscoveryServer -eu appadmin:demo}} (<code>registerToGds</code> can be shortened to <code>rtg</code>).
+
# In order to create application registration ibn the GDS, enter {{Style=keyboard|registerToGds opc.tcp://opcua.demo-this.com:58810/GlobalDiscoveryServer -eu appadmin:demo}} (<code>registerToGds</code> can be shortened to <code>rtg</code>). The argument to the command is the URL of the Global Discovery Server (GDS). The <code>-eu</code> option (shortened form of <code>--EndpointUser</code>) specifies the user name and password for user authentication to the GDS. The command argument and option is repeated in many commands further below, and they have the same meaning.  
# {{Style=keyboard|findGdsRegistrations opc.tcp://opcua.demo-this.com:58810/GlobalDiscoveryServer -eu appadmin:demo}} (<code>findGdsRegistrations</code> can be shortened to <code>fgr</code>).
+
# {{Style=keyboard|findGdsRegistrations opc.tcp://opcua.demo-this.com:58810/GlobalDiscoveryServer -eu appadmin:demo}} (<code>findGdsRegistrations</code> can be shortened to <code>fgr</code>). When the operation is successful, the GDS assigns an application ID to the client application, and the OpcCmd utility displays this application ID to you. The application ID an OPC UA node ID for a node that represents the application inside the GDS.
  
 
{{Style=keyboard|obtainNewCertificate opc.tcp://opcua.demo-this.com:58810/GlobalDiscoveryServer -eu appadmin:demo}}
 
{{Style=keyboard|obtainNewCertificate opc.tcp://opcua.demo-this.com:58810/GlobalDiscoveryServer -eu appadmin:demo}}

Revision as of 10:49, 15 January 2021

Tutorial:

If you execute the commands listed in the tutorial below, you will get an overview of available client application operations.

  1. At the OpcCmd> prompt, enter uaClient getService uaClientApplication, or shortened: uac gs uaca.
    The program responds with the name of the client application (""OPC Command-line Tool"), which will be used for registrations to GDS. If this is the first time the program is run, it also creates its self-signed client certificate.
    All following commands are entered at the uaClientApplication> prompt. You can enter -?, -h or --help (possibly preceded by the command name) at any time to obtain help for this prompt (or its commands).
  2. In order to create application registration ibn the GDS, enter registerToGds opc.tcp://opcua.demo-this.com:58810/GlobalDiscoveryServer -eu appadmin:demo (registerToGds can be shortened to rtg). The argument to the command is the URL of the Global Discovery Server (GDS). The -eu option (shortened form of --EndpointUser) specifies the user name and password for user authentication to the GDS. The command argument and option is repeated in many commands further below, and they have the same meaning.
  3. findGdsRegistrations opc.tcp://opcua.demo-this.com:58810/GlobalDiscoveryServer -eu appadmin:demo (findGdsRegistrations can be shortened to fgr). When the operation is successful, the GDS assigns an application ID to the client application, and the OpcCmd utility displays this application ID to you. The application ID an OPC UA node ID for a node that represents the application inside the GDS.

obtainNewCertificate opc.tcp://opcua.demo-this.com:58810/GlobalDiscoveryServer -eu appadmin:demo

?

refreshTrustLists opc.tcp://opcua.demo-this.com:58810/GlobalDiscoveryServer -eu appadmin:demo

unregisterFromGds opc.tcp://opcua.demo-this.com:58810/GlobalDiscoveryServer -eu appadmin:demo

removeInstanceCertificate

  1. You can check the parameters of the client instance certificate by entering getInstanceCertificate, or shortened: gic.
  2. If you want to force the application to generate a new self-signed client certificate, you can do so by entering removeInstanceCertificate, or shortened: ric. This might be useful e.g. for repeated testing against a GDS, if you have already received a client certificate from GDS (signed by a certificate authority), and want to revert to the initial state. At the next OPC UA operation, the application will generate a new self-signed certificate for itself, and use it for subsequent operations.