| Option | Description |
|---|---|
| tool | Launch the configuration tool instead of the extractor. Use the configuration tool to analyze the server and suggest a suitable set of configuration options. |
| -e|—endpoint-url [host] | Override the source.endpoint-url configuration parameter and connect to the specified port. This generally has to be on the form opc.tcp://…:port. |
| -u|—user [username] | Override the Source/Username option and use the specified username to connect to the OPC UA server. |
| -p|—password [password] | Override the Source/Password option and use the specified password to connect to the OPC UA server. |
| —secure | Allow the extractor to try to connect to a secure endpoint if possible. This corresponds to the Source/Secure configuration option. |
| -f|—config-file [path] | Override the location of the YAML configuration file. This can be a relative or absolute path. |
| —auto-accept | Auto-accept connections from unrecognized servers. You can set this the first time the extractor or the configuration tool connects to the server and then remove it to ensure that the client only accepts connections from a server with the same certificate as the first time. |
| -d|—config-dir [dir] | Override the path to the configuration files. This is overwritten by the config-file option for YAML configuration files but will still apply to the OPC UA XML configuration file. You can also set this using the OPCUA_CONFIG_DIR environment variable. |
| -o|—config-target [path] | Set the output path for the configuration tool. This should be a YAML file, and it will be overwritten. If this is the same as the configuration file, then (mostly) the results will be written back. We recommend that you use a different file. |
| -n|—no-config | Don’t load any YAML configuration file. The OPC UA XML configuration file is still needed, but as long as the necessary information is provided using command-line options, the extractor or the configuration tool can be run in a simple configuration without any configuration file. |
| -l|—log-level [level] | Override the logger/console/level option. One of verbose, debug, information, warning, error. |
| -w|—working-dir [dir] | Set the working directory of the extractor. Relative paths are relative to this value. Default is the current directory for standalone or one level above executable if starting as a service. |
| -s|—service | Required when starting the extractor as a service. This option won’t start the extractor as a service on its own, but makes the necessary modifications when it’s called from the system. |
| -x|—exit | Exit the extractor on failure. Overrides the Source/ExitOnFailure configuration option. |
| —dry-run | Run the extractor in dry run mode. In this mode, the extractor will not push anything to any destination. |
| —version | Show the current extractor version. |
| -?|—h—help | Show the available command line options. |
Command-line arguments
Reference guide for all available command-line arguments when running the OPC UA extractor, including options for configuration, authentication, and tool mode.
Last modified on August 19, 2026