Legacy Agent CLI Usage
Please see potctl for current CLI usage: potctl
iofog-agent command --option <argument>
Commands
config | Change the software configuration according to the options provided. |
switch | Switch between dev, prod, or def (default) configs. |
info | Display the current configuration and other information about the software. |
provision | Attach this software to the configured ioFog controller. |
deprovision | Detach this software from all ioFog controllers. |
status | Display current status information about the software. |
version | Display the software version and license information. |
prune | Prune docker images. |
help | Display the help and usage information. |
config
Change the software configuration according to the options provided.
iofog-agent config --option [<optional-argument>]
iofog-agent config defaults
defaults | Reset configuration to default values |
-d number | Set the limit, in GiB, of disk space that the message archive is allowed to use |
-dl | Set the message archive directory to use for disk storage |
-m number | Set the limit, in MiB, of RAM memory that the software is allowed to use for messages |
-p number | Set the limit, in percentage, of CPU time that the software is allowed to use |
-a string | Set the uri of the fog controller to which this software connects |
-ac string | Set the file path of the SSL/TLS certificate for validating the fog controller identity, default: /etc/iofog-agent/cert.crt |
-c string | Set the UNIX socket or network address that the Docker daemon is using |
-n string | Set the name of the network adapter that holds the correct IP address of this machine |
-l number | Set the limit, in GiB, of disk space that the log files can consume |
-ld string | Set the directory to use for log file storage, default: /var/log/iofog-agent |
-lc number | Set the number of log files to evenly split the log storage limit |
-ll string | Set the level for logging output. Valid options are FINE, INFO, WARNING, SEVERE |
-sf number | Set the status update frequency |
-cf number | Set the get changes frequency |
-df number | Set the post diagnostics frequency |
-sd number | Set the scan devices frequency |
-pf number | Set the docker pruning frequency |
-uf number | Set the isReadyToUpgradeScan frequency |
-dt number | Set the available disk threshold for docker pruning. Agent uses this value to trigger pruning when system available disk is less than available disk threshold |
-idc on/off | Set the mode on which any not registered docker container will be shut down |
-gps auto/off/number | Set gps location of fog. Use auto to get coordinates by IP, use off to forbid gps, use GPS coordinates in DD format to set them manually. Format: DD.DDD(lat), DD.DDD(lon) |
-ft auto/intel_amd/arm | Set fog type. Use auto to detect fog type by system commands, use arm or intel_amd to set it manually |
-sec on/off | Set the secure mode without using ssl certificates |
-dev on/off | Set the developer's mode |
switch
Switch between dev, prod, or def (default) configs.
iofog-agent switch <dev|prod|def>
info
Display the current configuration and other information about the software.
iofog-agent info
provision
Attach this software to the configured ioFog controller.
iofog-agent provision <provisioning key>
deprovision
Detach this software from all ioFog controllers.
iofog-agent deprovision
status
Display current status information about the software.
iofog-agent status
version
Display the software version and license information.
iofog-agent version
prune
Prune docker images.
iofog-agent prune
help
Display the help and usage information.
iofog-agent help