CLI Reference
Besides timeplusd-client, Timeplus also provide the timeplus command line interface to help you manage the self-hosted deployments.
For bare metal installation, the timeplus binary is available in /bin folder. For Kubernetes deployments, please add the following section to values.yaml :
timeplusCli:
enabled: true
Then upgrade the helm chart via:
helm -n $NS upgrade -f values.yaml $RELEASE timeplus/timeplus-enterprise
Once timeplus-cli pod is up and running, you can run kubectl exec -n $NS -it timeplus-cli -- /bin/bash to run commands in the pod.
Here are examples to manage users via the timeplus user CLI.
# Get the IP of timeplusd pods
export TIMEPLUSD_POD_IPS=timeplusd-0.timeplusd-svc.timeplus.svc.cluster.local:8463
# List users
timeplus user list --address ${TIMEPLUSD_POD_IPS} --admin-password timeplusd@t+
# Create an user with username "hello" and password "word"
timeplus user create --address ${TIMEPLUSD_POD_IPS} --admin-password timeplusd@t+ --user hello --password world
# Delete the user "hello"
timeplus user delete --address ${TIMEPLUSD_POD_IPS} --admin-password timeplusd@t+ --user hello
Commands
The following table displays the available top-level timeplus commands.
| Command | Description |
|---|---|
| timeplus start | Start Timeplus Enterprise services |
| timeplus stop | Stop Timeplus Enterprise services |
| timeplus restart | Restart Timeplus Enterprise services |
| timeplus service | Add Timeplus Enterprise services to systemd control |
| timeplus license | Manage Timeplus Enterprise licenses |
| timeplus user | Manage Timeplus Enterprise users |
| timeplus diag | Run diagnostics of Timeplus Enterprise services |
| timeplus migrate | Migrate data and resources between Timeplus Enterprise deployments |
| timeplus backup | Create a Timeplus enterprise backup |
| timeplus restore | Restore a Timeplus enterprise backup |
| timeplus sync | Synchronizes resources to Timeplus Enterprise |
| timeplus version | Show Timeplus Enterprise version |
| timeplus help | Help about any command |
Common Flags
Most of the commands support the following flags:
-v, or--verbose: run the command in the verbose mode-h, or--help: show the help message for the command, with sub-commands and flags.