F5OS-A#

RESTSH_MODULES=("cert" "custom" "f5osa")

Restsh is using the restconf port 8888 (API prefix /restconf).

All functions for this module are prefixed with f5osa..

Example configuration file: .restsh-config.dist.f5osa

Authentication#

You can use basic authentication with username and password to retrieve a token for further authentication.

See Passwords and Secrets for storing the credentials encrypted.

[ -n "${RESTSH_AUTH+x}" ] || export RESTSH_AUTH="token"
[ -n "${RESTSH_TOKEN_HEADER+x}" ] || export RESTSH_TOKEN_HEADER="X-Auth-Token"
[ -n "${RESTSH_USER+x}" ] || export RESTSH_USER="<user>"
[ -n "${RESTSH_PASS+x}" ] || export RESTSH_PASS="<password>"

Call f5osa.auth.token.get to retrieve the token. It uses the provided username and password to retrieve the token and sets the RESTSH_TOKEN_VALUE environment variable. The initial token is retrieved on startup and renewal is also managed by Restsh.

References#

List of all functions#