# Executing this version

Check the following examples for executing your controller.

# Parameters

You can obtain a complete list of the available input parameters by executing:

./agents-controller --help

# Version

You can easily check the version, the target operating system, architecture, and extra information about your controller by executing:

./agents-controller --version

# Default

The basic command for running your controller is as follows:

./agents-controller --agency 127.0.0.1:9191 --token abcde

This command will set your controller as follows:

  • It will identify your controller into the IoTHub with the token abcde. Note that this token MUST be provided the first time that you attempt to connect the controller with the IoTHub.
  • It will connect your controller with the IoTHub Agency module running at the address 127.0.0.1 port 9191
  • It will create a default folder for storing the agents' binary files downloaded by the controller at ./_elcoagents
  • It will disable the internal debug mode by logging only info, warnings, and error messages

# Enable debug

For enabling the internal debug mode and log also debug messages wou can execute your controller as follows:

./agents-controller --agency 127.0.0.1:9191 \
  --debug true

# Custom name

For identifying your controller in the IoTHub with a specific name you can execute your controller as follows:

./agents-controller --name MyController \
  --agency 127.0.0.1:9191 \
  --debug true

# Custom storage

For specifying a custom path to store the agents' binary files downloaded by the controller, you can execute it as follows:

./agents-controller --name MyController \
  --bin /path/to/controller/files/ \
  --agency 127.0.0.1:9191 \
  --debug true

# Config file

You can also specify a YAML file with your input settings.

token: abcde
name: MyController
bin: /path/to/controller/files/
agency: iothub.company.com:9191
debug: true

Then, you can input this configuration file into your controller as follows:

./agents-controller --config /path/to/config.yml
Last Updated: 1/14/2022, 12:37:23 PM