Command Line Tools

Ring2All provides a command-line utility called ss_cmd for administrative tasks that need to be performed directly on the server.

Overview

The ss_cmd command is installed automatically with the Softswitch API package and is available system-wide at /usr/local/bin/ss_cmd.

Usage

Bash

ss_cmd <command> [options]

Available Commands

reset-pwd - Reset web GUI password for a user
make-backup - Create a backup using a backup job ID
list-backups - Display available backup jobs
help - Show help message

---

Reset User Password

Use this command when a user has forgotten their password or when you need to reset the admin password.

Syntax

Bash

ss_cmd reset-pwd <username> [password]

Parameters

username (required): The email address of the user account
password (optional): The new password. If omitted, a random password is generated

Examples

Reset admin password with auto-generated password:

Bash

ss_cmd reset-pwd admin@main.local

Output:

Plaintext

Password reset successfully for: admin@main.local
New password: Xk9mP2nQ4rT7vB3c

Reset password with specific value:

Bash

ss_cmd reset-pwd admin@main.local MyNewPassword123!

Output:

Plaintext

Password reset successfully for: admin@main.local

Note: When using a specific password, ensure it meets the password requirements (minimum 8 characters).

---

Backup Management

List Available Backup Jobs

View all configured backup jobs:

Bash

ss_cmd list-backups

Output:

Plaintext

Available Backup Jobs:
ID  | Name              | Type   | Schedule
----|-------------------|--------|----------
1   | Daily Full Backup | full   | 0 2 * * *
2   | Config Only       | config | 0 */6 * * *

Execute a Backup

Run a backup job manually:

Bash

ss_cmd make-backup <backup_job_id>

Example:

Bash

ss_cmd make-backup 1

Output:

Plaintext

Starting backup job: Daily Full Backup
Backup completed: /var/backups/softswitch/backup_2026-02-05_143022.tar.gz

---

Troubleshooting

Command Not Found

If ss_cmd is not found, verify the installation:

Bash

ls -la /usr/local/bin/ss_cmd

If missing, reinstall the API package:

Bash

apt install --reinstall softswitch-api

API Not Running

The command requires the Softswitch API to be installed. Verify:

Bash

ls -la /var/www/softswitch/apps/api/
systemctl status softswitch-api

Permission Denied

Ensure you are running the command as root or with sudo:

Bash

sudo ss_cmd reset-pwd admin@main.local