Advantech JWT Authentication Service (CLI)
The default install location is:
- Windows:
C:\Program Files\Advantech\auth-server - Linux:
/opt/auth-server
Usage:
auth-server [flags]
auth-server [command]
Available Commands:
help Help about any command
ldap setup the LDAP authentication
password Manage admin password
service Manage service
Flags:
-a, --address string The IP address on which to listen for the --port port.
If blank, all interfaces will be used (0.0.0.0 for all IPv4
interfaces and :: for all IPv6 interfaces). (default "")
-p, --port int The port on which to serve HTTPS with
authentication and authorization.
(default 6443)
--tls-cert-file string File containing the default x509 Certificate for HTTPS.
(CA cert, if any, concatenated after server cert).
If --tls-cert-file and --tls-private-key-file are not provided,
a self-signed certificate and key are generated for the public address
and saved to the --tls-key-dir.
(default "cert.crt")
--tls-private-key-file string File containing the default x509 private key
matching --tls-cert-file.
(default "key.pem")
--tls-key-dir string Location of --tls-cert-file and --tls-private-key-file
(default "/etc/xdg/Advantech/.auth-server/keys")
--insecure-address string The IP address on which to serve the --insecure-port
(set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).
--insecure-port int The port on which to serve unsecured,
unauthenticated access. Set to 0 to disable. (default 6880)
--jwt-cert-file string File containing the default x509 Certificate for JWT.
(CA cert, if any, concatenated after server cert).
If --jwt-cert-file and --jwt-private-key-file are not provided,
a self-signed certificate and key are generated for the public address
and saved to the --jwt-key-dir.
(default "cert.crt")
--jwt-private-key-file string File containing the default x509 private key matching --jwt-cert-file.
(default "key.pem")
--jwt-key-dir string Location of --jwt-cert-file and --jwt-private-key-file
(default "/etc/xdg/Advantech/.auth-server/jwt/keys")
--timeout duration Duration that a jwt token is valid. (default 15m0s)
--max-refresh duration It allows clients to refresh their token until --max-refresh has passed.
Note that clients can refresh their token in the last moment of --max-refresh.
This means that the maximum validity timespan for a token is --timeout + --max-refresh.
Set to 0 to disable. (default 0s)
--jwt-secure-cookie Return the token as a cookie with Secure and HttpOnly flags (default true)
-d, --debug enable debug output (default disabled)
--config string Location of config files (default /etc/xdg/Advantech/.auth-server)
-h, --help help for auth-server
--version version for auth-server
Use "auth-server [command] --help" for more information about a command.
-
servicecommandManage service
Usage:
auth-server service [flags]
auth-server service [command]
Available Commands:
install install service
restart restart service
start start service
stop stop service
uninstall uninstall service
Flags:
-h, --help help for service
Global Flags:
--config string Location of config files (default /etc/xdg/Advantech/.auth-server)
Use "auth-server service [command] --help" for more information about a command. -
passwordcommandManage admin password
Usage:
auth-server password [flags]
auth-server password [command]
Available Commands:
reset reset admin password
Flags:
-h, --help help for password
Global Flags:
--config PathString Location of config files
Use "auth-server password [command] --help" for more information about a command.
Advantech EdgeHub Device Agent Service (CLI)
The default install location is:
- Windows:
C:\Program Files\Advantech\edgehub-agent - Linux:
/opt/edgehub-agent
Usage:
edgehub-agent [flags]
edgehub-agent [command]
Available Commands:
conn Apply connection setting
help Help about any command
service Manage service
Flags:
-a, --address string The IP address on which to listen for the --port port.
If blank, all interfaces will be used (0.0.0.0 for all IPv4
interfaces and :: for all IPv6 interfaces). (default "")
-p, --port int The port on which to serve HTTPS with
authentication and authorization.
(default 8744)
--tls-cert-file string File containing the default x509 Certificate for HTTPS.
(CA cert, if any, concatenated after server cert).
If --tls-cert-file and --tls-private-key-file are not provided,
a self-signed certificate and key are generated for the public address
and saved to the --tls-key-dir.
(default "cert.crt")
--tls-private-key-file string File containing the default x509 private key
matching --tls-cert-file.
(default "key.pem")
--tls-key-dir string Location of --tls-cert-file and --tls-private-key-file
(default "/etc/xdg/Advantech/.edgehub-agent/keys")
--insecure-address string The IP address on which to serve the --insecure-port
(set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).
--insecure-port int The port on which to serve unsecured,
unauthenticated access. Set to 0 to disable. (default 8789)
--jwt-auth-server-url string Authentication Server URL
(default "https://localhost:6443")
--jwt-cert-file string File containing the default x509 Certificate for JWT.
(CA cert, if any, concatenated after server cert).
(default "cert.crt")
--jwt-cert-dir string Location of --jwt-cert-file
(default "/etc/xdg/Advantech/.edgehub-agent/keys/jwt")
--jwt-check-interval duration Duration that check and download JWT certificate
from the authentication server. (default 5s)
--config string Location of config files
(default "/etc/xdg/Advantech/.edgehub-agent")
-d, --debug enable debug output
-h, --help help for edgehub-agent
--version version for edgehub-agent
Use "edgehub-agent [command] --help" for more information about a command.
-
servicecommandManage service
Usage:
edgehub-agent service [flags]
edgehub-agent service [command]
Available Commands:
install install service
restart restart service
start start service
stop stop service
uninstall uninstall service
Flags:
-h, --help help for service
Global Flags:
--config string Location of config files
(default "/etc/xdg/Advantech/.edgehub-agent")
-d, --debug enable debug output
Use "edgehub-agent service [command] --help" for more information about a command. -
conncommandApply connection setting
Usage:
edgehub-agent conn [flags]
edgehub-agent conn [command]
Available Commands:
disable Set connection to Disabled state
enable Set connection to Enabled state
mac Get MAC address for the connection
reset Reset connection settings
status Get connection status
Flags:
-a, --address string The MQTT broker host address (i.e. localhost, 127.0.0.1)
-p, --port int The MQTT broker port number
-u, --username string Username for the MQTT connection
-P, --password string Password for the MQTT connection
--enable-tls Enable TLS connection
--over-ws Enable MQTT over WebSocket
--cs string The Azure IoTHub Device Connection String
-h, --help help for conn
Global Flags:
--config PathString Location of config files
-d, --debug enable debug output (default true)
Use "edgehub-agent conn [command] --help" for more information about a command.
Advantech Platform REST API Service (CLI)
The default install location is:
- Windows:
C:\Program Files\Advantech\rest-server - Linux:
/opt/rest-server
Usage:
rest-server [flags]
rest-server [command]
Available Commands:
help Help about any command
service Manage service
Flags:
-a, --address string The IP address on which to listen for the --port port.
If blank, all interfaces will be used (0.0.0.0 for all IPv4
interfaces and :: for all IPv6 interfaces). (default "")
-p, --port int The port on which to serve HTTPS with
authentication and authorization.
(default 8743)
--tls-cert-file string File containing the default x509 Certificate for HTTPS.
(CA cert, if any, concatenated after server cert).
If --tls-cert-file and --tls-private-key-file are not provided,
a self-signed certificate and key are generated for the public address
and saved to the --tls-key-dir.
(default "cert.crt")
--tls-private-key-file string File containing the default x509 private key
matching --tls-cert-file.
(default "key.pem")
--tls-key-dir string Location of --tls-cert-file and --tls-private-key-file
(default "/etc/xdg/Advantech/.rest-server/keys")
--insecure-address string The IP address on which to serve the --insecure-port
(set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).
--insecure-port int The port on which to serve unsecured,
unauthenticated access. Set to 0 to disable. (default 8788)
--jwt-auth-server-url string Authentication Server URL
(default "https://localhost:6443")
--jwt-cert-file string File containing the default x509 Certificate for JWT.
(CA cert, if any, concatenated after server cert).
(default "cert.crt")
--jwt-cert-dir string Location of --jwt-cert-file
(default "/etc/xdg/Advantech/.rest-server/keys/jwt")
--jwt-check-interval duration Duration that check and download JWT certificate
from the authentication server. (default 5s)
-d, --debug enable debug output (default disabled)
--config string Location of config files
(default "/etc/xdg/Advantech/.rest-server")
-h, --help help for rest-server
--version version for rest-server
Use "rest-server [command] --help" for more information about a command.
-
servicecommandManage service
Usage:
rest-server service [flags]
rest-server service [command]
Available Commands:
install install service
restart restart service
start start service
stop stop service
uninstall uninstall service
Flags:
-h, --help help for service
Global Flags:
--config string Location of config files
(default "/etc/xdg/Advantech/.rest-server")
Use "rest-server service [command] --help" for more information about a command.
Advantech Platform Portal Service (CLI)
The default install location is:
- Windows:
C:\Program Files\Advantech\portal-service - Linux:
/opt/portal-service
Usage:
portal-service [flags]
portal-service [command]
Available Commands:
container Run service in container mode or native mode
help Help about any command
service Manage service
Flags:
-d, --debug enable debug output
--container run service in container mode (default true)
--config string Location of config files
(default "/etc/xdg/Advantech/.portal-service")
-h, --help help for portal-service
--version version for portal-service
Use "portal-service [command] --help" for more information about a command.
-
servicecommandManage service
Usage:
portal-service service [flags]
portal-service service [command]
Available Commands:
install install service
restart restart service
start start service
stop stop service
uninstall uninstall service
Flags:
-h, --help help for service
Global Flags:
--config string Location of config files
(default "/etc/xdg/Advantech/.portal-service")
Use "portal-service service [command] --help" for more information about a command. -
containercommandRun service in container mode or native mode
Usage:
portal-service container [flags]
portal-service container [command]
Available Commands:
off Switch to native mode
on Switch to container mode
setting Show the current setting
Flags:
-h, --help help for container
Global Flags:
--config string Location of config files
(default "/etc/xdg/Advantech/.portal-service")
Use "portal-service container [command] --help" for more information about a command.