Using OpcCmd Utility for OPC UA File Transfer: Difference between revisions

From OPC Labs Knowledge Base
Line 5: Line 5:


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.
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.


# Start the Unified Automation UA .NET SDK Bundle server, by typing {{Style=keyboard|start UaServerNET.exe}} at the operating system command prompt, when in the 'bin' directory of the Unified Automation UA .NET SDK Bundle.<br/><br/>
# Start the Unified Automation UA .NET SDK Bundle server, by typing {{Style=keyboard|start UaServerNET.exe}} at the operating system command prompt, when in the 'bin' directory of the Unified Automation UA .NET SDK Bundle.<br/><br/>
# 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 <code>-i</code> (or <code>--interactive</code>) option on the command line.<br/><br/>
# 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 <code>-i</code> (or <code>--interactive</code>) option on the command line.<br/><br/>
# {{Style=keyboard|uaFileTransferClient}}<br/><br/>
# At the {{Style=label|OpcCmd>}} prompt, enter {{Style=keyboard|uaFileTransferClient}}, or shortened: {{Style=keyboard|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.<br/><br/>Subsequent commands are entered at the {{Style=label|uaFileTransferClient>}} 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).<br/><br/>
# {{Style=keyboard|1=getFileInfo opc.tcp://localhost:48030 "nsu=http://www.unifiedautomation.com/DemoServer/ ;s=Demo.Files.TextFile"}}<br/><br/>
# In order to access a file in the server that is represented by a standalone node (not part of the OPC UA file system), enter {{Style=keyboard|1=getFileInfo opc.tcp://localhost:48030 "nsu=http://www.unifiedautomation.com/DemoServer/ ;s=Demo.Files.TextFile"}} (<code>getFileInfo</code> can be shortened to <code>gfi</code>). 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 {{Style=label|fileInfo>}} prompt.<br/><br/>
# {{Style=keyboard|get}}<br/><br/>
# Display the file properties by entering {{Style=keyboard|get}}.<br/><br/>
# ''(establish trust)''<br/><br/>
# ''(establish trust)''<br/><br/>
# {{Style=keyboard|saveTo --osFilePath c:\work\file1.txt}}<br/><br/>
# {{Style=keyboard|saveTo --osFilePath c:\work\file1.txt}}<br/><br/>

Revision as of 10:34, 17 May 2021

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 in the server that is represented by a standalone node (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. (establish trust)

  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

Retrieved from "https://kb.opclabs.com/index.php?title=Using_OpcCmd_Utility_for_OPC_UA_File_Transfer&oldid=3741"