Skip to main content

Legacy Agent CLI Usage

Please see potctl for current CLI usage: potctl

iofog-agent command --option <argument>

Commands

configChange the software configuration according to the options provided.
switchSwitch between dev, prod, or def (default) configs.
infoDisplay the current configuration and other information about the software.
provisionAttach this software to the configured ioFog controller.
deprovisionDetach this software from all ioFog controllers.
statusDisplay current status information about the software.
versionDisplay the software version and license information.
prunePrune docker images.
helpDisplay 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
defaultsReset configuration to default values
-d numberSet the limit, in GiB, of disk space that the message archive is allowed to use
-dlSet the message archive directory to use for disk storage
-m numberSet the limit, in MiB, of RAM memory that the software is allowed to use for messages
-p numberSet the limit, in percentage, of CPU time that the software is allowed to use
-a stringSet the uri of the fog controller to which this software connects
-ac stringSet the file path of the SSL/TLS certificate for validating the fog controller identity, default: /etc/iofog-agent/cert.crt
-c stringSet the UNIX socket or network address that the Docker daemon is using
-n stringSet the name of the network adapter that holds the correct IP address of this machine
-l numberSet the limit, in GiB, of disk space that the log files can consume
-ld stringSet the directory to use for log file storage, default: /var/log/iofog-agent
-lc numberSet the number of log files to evenly split the log storage limit
-ll stringSet the level for logging output. Valid options are FINE, INFO, WARNING, SEVERE
-sf numberSet the status update frequency
-cf numberSet the get changes frequency
-df numberSet the post diagnostics frequency
-sd numberSet the scan devices frequency
-pf numberSet the docker pruning frequency
-uf numberSet the isReadyToUpgradeScan frequency
-dt numberSet 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/offSet the mode on which any not registered docker container will be shut down
-gps auto/off/numberSet 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/armSet fog type. Use auto to detect fog type by system commands, use arm or intel_amd to set it manually
-sec on/offSet the secure mode without using ssl certificates
-dev on/offSet 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