Using OpcCmd Utility for OPC UA File Transfer

For general information about the OpcCmd tool, see Category:OpcCmd Utility.

Tutorial

If you execute the commands listed in the tutorial below, you will get an overview of basic operations that can be made with an OPC UA Server that provides OPC UA File Transfer model.

This tutorial works with Unified Automation UA .NET SDK Bundle server. You should be able to use the principles explained in this tutorial with other OPC UA servers that provide the File Transfer model, by modifying the relevant parameters used in the commands.

1. Start the Unified Automation UA .NET SDK Bundle server, by typing start UaServerNET.exe at the operating system command prompt, when in the 'bin' directory of the Unified Automation UA .NET SDK Bundle.
   
   
2. Start the OpcCmd utility in interactive mode. The interactive mode is always in effect e.g. when you use ClickOnce, or when running the utility from QuickOPC Launcher/Start menu. In other cases, you need to use the -i (or --interactive) option on the command line.
   
   
3. At the OpcCmd> prompt, enter uaFileTransferClient, or shortened: uaftc. This command tells the utility that from now on, we will be accessing the File Transfer functionality of OPC UA. The programs responds with a confirmation of the command.
   
   Subsequent commands are entered at the uaFileTransferClient> 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).
   
   
4. In order to access a file that is represented by a standalone node in the server (not part of the OPC UA file system), enter getFileInfo opc.tcp://localhost:48030 "nsu=http://www.unifiedautomation.com/DemoServer/ ;s=Demo.Files.TextFile" (getFileInfo can be shortened to gfi). The node Id used in this command refers to a predefined node in the server which contains a demo text file. Subsequent commands are entered at the fileInfo> prompt.
   
   
5. Display the file properties by entering get.
   
   
6. The OpcCmd Utility will now ask you whether you want the client to trust the server certificate. Verify that that you have been presented with the right server server certificate, and if so, accept the certificate by pressing Y for "Yes".
   After the certificate is accepted, the get command proceeds. If OpcCmd is set to the "OPC compliance" mode, in which the secure connections are the default, and this is the first operation made from this client on the server, you will most likely receive file properties where the relevant values (such as file length, and last modified data) will be missing. This is caused by the fact that the server does not trust the client. In order to establish the trust:
   1. The Unified Automation UA .NET SDK Bundle server will show the rejected client certificate on the "Rejected Certificates" tab of its window. On this tab, locate the rejected OpcCmd application certificate, right-click on it and select "Trust Permanently"; when asked, confirm the operation.
      
      
   2. Enter the get command again.
      
      
7. saveTo --osFilePath c:\work\file1.txt
   
   
8. exit
   
   
9. getDirectoryContents opc.tcp://localhost:48030 "nsu=http://www.unifiedautomation.com/DemoServer/ ;s=Demo.Files.FileSystem" --EndpointUser root:secret
   
   
10. clear
    
    
11. fileInfo MyTestFile.txt loadFrom --osFilePath c:\work\file1.txt
    
    
12. fileInfos?
    
    
13. createSubdirectory MyTestDirectory
    
    
14. fileInfo MyTestFile.txt copyTo MyTestDirectory/CopyOfMyTestFile.txt
    
    
15. browseTree
    
    
16. fileInfo MyTestDirectory/CopyOfMyTestFile.txt delete
    
    
17. browseTree