Cheatsheet
+Cheatsheet
The rctl is a command-line interface for running commands against a Routr server. This overview covers rctl syntax, describes the command operations and provides common examples. For details about each command, including all the supported flags and subcommands, see the reference documentation below. This tool ships separately from the Routr server.
Installation
+Installation
To get the Routr Command-Line Tool run the following command:
npm install -g routr-ctl
The command-line tool is now globally accessible.
-Login to a Routr server
+Login to a Routr server
To login to a Routr server, use the login command.
rctl login https://127.0.0.1:4567/api/{apiVersion} -u admin -p changeit
-The current API version is v1beta1
Syntax
+Syntax
Use the following syntax to run rctl commands from your terminal window:
rctl COMMAND [REF] [flags]
where COMMAND, subcommand REF, and flags are:
SyntaxExamples: Common operations
+Examples: Common operations
Use the following set of examples to help you familiarize yourself with running the commonly used rctl operations:
rctl locate or rctl loc - Locate a sip device registered on the Routr server
// Locate all Sip Devices registered against a Routr server
$ rctl loc
E
// Update an existing resource(s) .yaml or .yml.
$ rctl apply -f new-gateway.yaml
// Update an existing resource(s) .yaml or .yml.
$ rctl apply -f new-gateway.yaml
rctl delete - delete a resource.
// Delete all numbers for gateway reference gweef506
$ rctl delete numbers --filter "@.metadata.gwRef=='gweef506'"
// Delete a single agent (using delete alias)
$ rctl del agent ag3f77f6
Cheat Sheet
+Cheat Sheet
-Create, delete, and update are only available in some implementations of the
resourcesmodule.
Request and store token
+Request and store token
# Request authentication for subsequent commands
$ rctl login https://127.0.0.1:4567/api/{apiVersion} -u admin -p changeit
Clear out the session credentials
+Clear out the session credentials
# Clear session credentials
$ rctl logout
Launch the Web Console
+Launch the Web Console
# The Web Console re-uses the credentials of your Command-Line Tool
rctl proxy
Showing the Registry
+Showing the Registry
# Shows all the Gateways that are currently available
$ rctl registry # Shows only current registrations. You may use `reg` for short
Locating SIP Devices
+Locating SIP Devices
# Find all sip devices available at the location service
$ rctl locate # This list does not include number-ingress-routes or domain-egress-routes
Creating Resources
+Creating Resources
# Create new peers and agents
$ rctl create -f asterisk.yaml # Create Peer in file asterisk.yaml
$ rctl create -f agents-list.yaml # Create Agents in file agents-list.yaml
Finding Resources
+Finding Resources
# Get Numbers
$ rctl get numbers # List all available Numbers
$ rctl get number # List all available Numbers
$ rctl get number --filter "@.metadata.ref=='dd50baa4'" # Shows Number with reference 'Number0001'
$ rctl get number --filter "@.metadata.gwRef=='gweef506'" # Shows Numbers with Gateway reference 'GW1232'
# Get agents
$ rctl get agents # List all Agents
Deleting Resources
+Deleting Resources
# Delete command by refernce or filter
$ rctl delete agent ag3f77f6 # Delete Agent by reference
$ rctl del numbers --filter '@.metadata.gwRef=gweef506' # Delete Numbers using a filter
Updating Resources
+Updating Resources
$ rctl apply -f asterisk.yaml # Create Peer in file asterisk.yaml
$ rctl apply -f agents-list.yaml # Create Agents in file agents-list.yaml
Dump all available logs
+Dump all available logs
$ rctl logs
Restart the engine
+Restart the engine
# To restart the engine immediately use the --now flag
$ rctl restart --now
Stop the engine
+Stop the engine
# To stop the engine immediately use the --now flag
$ rctl restart --now
Check the engine status
+Check the engine status
$ rctl ping
Display version information
+Display version information
$ rctl ver
Manage general configuration
-# To update configuration use the apply subommand
$ rctl config apply -f /path/to/config.yml
# To see the configuration use the describe subcommand
$ rctl config describe --full
Manage general configuration
+# To update configuration use the apply subommand
$ rctl config apply -f /path/to/config.yml
# To see the configuration use the describe subcommand
$ rctl config describe --full