LATEST VERSION (Nov 25): 0.9.8-17

Cli Commands

v-backup-user

backup system user with all its objects options:

USER NOTIFY


The call is used for backing up user with all its domains and databases.




v-delete-user-package

delete user package options:

PACKAGE


The function for deleting user package. It does not allow to delete package if it is in use.




v-list-dns-records

list dns domain records options:

USER DOMAIN [FORMAT]


The function for getting all DNS domain records.




v-update-web-templates

update web templates options:

[RESTART]


The function for obtaining updated pack of web templates.




v-sign-letsencrypt-csr

sing letsencrypt csr options:

USER DOMAIN CSR_DIR [FORMAT]


The function signs certificate request using LetsEncript API




v-delete-mail-domains

delete mail domains options:

USER


The function for deleting all users mail domains.




v-delete-web-domain-httpauth

delete http auth user options:

USER DOMAIN AUTH_USER [RESTART]


The call is used for deleting http auth user




v-list-sys-vesta-ssl

list vesta ssl certificate options:

[FORMAT]


The function of obtaining vesta ssl files.




v-insert-dns-records

inserts dns records options:

USER DOMAIN DATA_FILE [RESTART]


The function copy dns record to the domain conf




v-generate-password-hash

GENERATE PASSWORD HASH options:

HASH-METHOD SALT PASSWORD


The function generates password hash




v-suspend-remote-dns-host

suspend remote dns server options:

HOST


The function for suspending remote dns server.




v-list-sys-languages

list system users options:

[FORMAT]


The function for obtaining the list of system users without detailed information.




v-restart-web-backend

restart backend server options:

NONE


The function reloads backend server configuration.




v-change-user-ns

change user nameservers options:

USER NS1 NS2 [NS3] [NS4] [NS5] [NS6] [NS7] [NS8]


The function for changing default nameservers for specific user.




v-update-sys-rrd-nginx

update nginx rrd options:

PERIOD


The function is for updating nginx rrd database and graphic.




v-get-fs-file-type

get file type options:

USER FILE


The function shows file type




v-update-sys-queue

update system queue options:

PIPE


This function is responsible queue processing. Restarts of services, scheduled backups, web log parsing and other heavy resource consuming operations are handled by this script. It helps to optimize system behaviour. In a nutshell Apache will be restarted only once even if 10 domains are added or deleted.




v-delete-letsencrypt-domain

deleting letsencrypt ssl cetificate for domain options:

USER DOMAIN [RESTART]


The function turns off letsencrypt SSL support for a domain.




v-change-web-domain-ip

change web domain ip options:

USER DOMAIN DOMAIN [RESTART]


The call is used for changing domain ip




v-rebuild-databases

rebuild databases options:

USER


The function for rebuilding of all databases of a single user.




v-open-fs-config

open config options:

CONFIG


The function opens/reads config files on the file system




v-restart-service

restart service options:

SERVICE


The function restarts system service.




v-delete-web-domains

delete web domains options:

USER [RESTART]


The function deletes all user's webdomains.




v-unsuspend-web-domains

unsuspend web domains options:

USER [RESTART]


The function of unsuspending all user's sites.




v-list-mail-account

list mail domain account options:

USER DOMAIN ACCOUNT [FORMAT]


The function of obtaining the list of account parameters.




v-restart-ftp

restart ftp service options:

NONE


The function tells ftp server to reread its configuration.




v-list-sys-db-status

list db status options:

[FORMAT]


The function lists db server status




v-update-sys-rrd-net

update network rrd options:

PERIOD


The function is for updating network usage rrd database and graphic.




v-get-dns-domain-value

get dns domain value options:

USER DOMAIN KEY


The function for getting a certain DNS domain parameter.




v-update-web-domain-disk

update disk usage for domain options:

USER DOMAIN


The function recalculates disk usage for specific webdomain.




v-add-mail-domain-antispam

add mail domain antispam support options:

USER DOMAIN


The function enables spamassasin for incoming emails.




v-list-mail-account-autoreply

list mail account autoreply options:

USER DOMAIN ACCOUNT [FORMAT]


The function of obtaining mail account autoreply message.




v-add-firewall-chain

add firewall chain options:

CHAIN [PORT] [PROTOCOL] [PROTOCOL]


The function adds new rule to system firewall




v-list-sys-spamd-config

list spamassassin config parameters options:

[FORMAT]


The function for obtaining the list of spamassassin config parameters.




v-rebuild-mail-domains

rebuild mail domains options:

USER


The function rebuilds EXIM configuration files for all mail domains.




v-add-domain

add web/dns/mail domain options:

USER DOMAIN [IP] [RESTART]


The function adds web/dns/mail domain to a server.




v-update-sys-rrd-mem

update memory rrd options:

PERIOD


The function is for updating memory rrd database and graphic.




v-copy-fs-directory

copy directory options:

USER SRC_DIRECTORY DST_DIRECTORY


The function copies directory on the file system




v-suspend-domain

suspend web/dns/mail domain options:

USER DOMAIN


The function suspends web/dns/mail domain.




v-generate-ssl-cert

generate self signed certificate and CSR request options:

DOMAIN EMAIL COUNTRY STATE CITY ORG UNIT [ALIASES] [FORMAT]


The function generates self signed SSL certificate and CSR request




v-delete-mail-domain-catchall

delete mail domain catchall email options:

USER DOMAIN


The function disables mail domain cathcall.




v-list-firewall-ban

list firewall block list options:

[FORMAT]


The function of obtaining the list of currently blocked ips.




v-delete-cron-job

delete cron job options:

USER JOB


The function deletes cron job.




v-update-web-domain-traff

update domain bandwidth usage options:

USER DOMAIN


The function recalculates bandwidth usage for specific domain.




v-restore-user

restore user options:

USER BACKUP [WEB] [DNS] [MAIL] [DB] [CRON] [UDIR] [NOTIFY]


The function for resotring user from backup.




v-unsuspend-dns-domains

unsuspend dns domains options:

USER [RESTART]


The function unsuspends all user's DNS domains.




v-change-dns-record

change dns domain record options:

USER DOMAIN ID VALUE [PRIORITY] [RESTART]


The function for changing DNS record.




v-restart-cron

restart cron service options:

NONE


The function tells crond service to reread its configuration files.




v-search-object

search objects options:

OBJECT [FORMAT]


The function that allows to find system objects.




v-add-user

add system user options:

USER PASSWORD EMAIL [PACKAGE] [FNAME] [LNAME]


The function creates new user account.




v-delete-firewall-ban

delete firewall blocking rule options:

IP CHAIN


The function deletes blocking rule from system firewall




v-list-sys-proftpd-config

list proftpd config parameters options:

[FORMAT]


The function for obtaining the list of proftpd config parameters.




v-delete-mail-account-forward

delete mail account forward options:

USER DOMAIN ACCOUNT EMAIL


The function add delete email account forward address.




v-unsuspend-dns-domain

unsuspend dns domain options:

USER DOMAIN


The function unsuspends a certain user's domain.




v-change-user-shell

change user shell options:

USER SHELL


The function changes system shell of a user. Shell gives ability to use ssh.




v-delete-database-host

delete database server options:

TYPE HOST


The function for deleting the database host from vesta configuration. It will be deleted if there are no databases created on it only.




v-add-firewall-ban

add firewall blocking rule options:

IP CHAIN


The function adds new blocking rule to system firewall




v-list-sys-pgsql-config

list postgresql config parameters options:

[FORMAT]


The function for obtaining the list of postgresql config parameters.




v-suspend-dns-domains

suspend dns domains options:

USER [RESTART]


The function suspends all user's DNS domains.




v-acknowledge-user-notification

update user notification options:

USER NOTIFICATION


The function updates user notification.




v-change-dns-domain-tpl

change dns domain template options:

USER DOMAIN TEMPLATE [RESTART]


The function for changing the template of records. By updating old records will be removed and new records will be generated in accordance with parameters of new template.




v-list-sys-vsftpd-config

list vsftpd config parameters options:

[FORMAT]


The function for obtaining the list of vsftpd config parameters.




v-check-letsencrypt-domain

check letsencrypt domain options:

USER DOMAIN


The function check and validates domain with LetsEncript




v-change-sys-ip-nat

change ip nat address options:

IP NAT_IP [RESTART]


The function for changing nat ip associated with ip.




v-list-user-package

list user package options:

PACKAGE [FORMAT]


The function for getting the list of system ip parameters.




v-list-dns-domain

list dns domain options:

USER DOMAIN [FORMAT]


The function of obtaining the list of dns domain parameters.




v-stop-firewall

stop system firewall options:

NONE


The function stops iptables




v-delete-web-domain-ftp

delete webdomain ftp account options:

USER DOMAIN FTP_USER


The function deletes additional ftp account.




v-list-sys-disk-status

list disk information options:

[FORMAT]


The function lists disk information




v-add-sys-ip

add system ip address options:

IP NETMASK [INTERFACE] [USER] [IP_STATUS] [IP_NAME] [NAT_IP]


The function adds ip address into a system. It also creates rc scripts. You can specify ip name which will be used as root domain for temporary aliases. For example, if you set a1.myhosting.com as name, each new domain created on this ip will automatically receive alias $domain.a1.myhosting.com. Of course you must have wildcard record *.a1.myhosting.com pointed to ip. This feature is very handy when customer wants to test domain before dns migration.




v-delete-cron-reports

delete cron reports options:

USER


The script for disabling reports on cron tasks and administrative notifications.




v-delete-mail-account-autoreply

delete mail account autoreply message options:

USER DOMAIN ACCOUNT ALIAS


The function delete email account autoreply.




v-insert-dns-record

insert dns record options:

USER DOMAIN DATA [RESTART]


The function inserts raw dns record to the domain conf




v-update-user-package

update user package options:

PACKAGE


The function propagates package to connected users.




v-add-web-domain-stats

add log analyzer to generate domain statitics options:

USER DOMAIN TYPE


The call is used for enabling log analyzer system to a domain. At this time two types of these system is supported - awstats and webalizer. For viewing the domain statistics use http://domain.tld/vstats/ link. Access this page is not protected by default. If you want to secure it with passwords you should use v-add-web-domain_stat_auth script.




v-suspend-web-domain

suspend web domain options:

USER DOMAIN


The function for suspending the site's operation. After blocking it all visitors will be redirected to a web page explaining the reason of suspend. By blocking the site the content of all its directories remains untouched.




v-get-mail-domain-value

get mail domain value options:

USER DOMAIN KEY


The function for getting a certain mail domain parameter.




v-delete-user-backup-exclusions

delete backup exclusion options:

USER [SYSTEM]


The function for deleting backup exclusion




v-delete-firewall-chain

delete firewall chain options:

CHAIN


The function adds new rule to system firewall




v-change-mail-account-password

change mail account password options:

USER DOMAIN ACCOUNT PASSWORD


The function changes email account password.




v-list-mail-accounts

list mail domain accounts options:

USER DOMAIN [FORMAT]


The function of obtaining the list of all user domains.




v-delete-cron-vesta-autoupdate

delete vesta autoupdate cron job options:

NONE


The function deletes vesta autoupdate cron job.




v-list-sys-services

list system services options:

[FORMAT]


The function for obtaining the list of configured system services.




v-list-sys-dns-status

list dns status options:

[FORMAT]


The function lists dns server status




v-list-sys-interfaces

list system interfaces options:

[FORMAT]


The function for obtaining the list of network interfaces.




v-list-remote-dns-hosts

list remote dns host options:

[FORMAT]


The function for obtaining the list of remote dns host.




v-change-sys-vesta-ssl

change vesta ssl certificate options:

SSL_DIR [RESTART]


The function changes vesta SSL certificate and the key.




v-change-user-template

change user default template options:

USER TYPE TEMPLATE


The function changes default user web template.




v-add-user-sftp-jail

add user sftp jail options:

USER


The script enables sftp jailed environment




v-delete-web-domain-stats-user

disable webdomain stats authentication support options:

USER DOMAIN


The function removes authentication of statistics system. If the script is called without naming a certain user, all users will be removed. After deleting all of them statistics will be accessible for view without an authentication.




v-unsuspend-database-host

unsuspend database server options:

TYPE HOST


The function for unsuspending a database server.




v-list-user

list user parameters options:

USER [FORMAT]


The function to obtain user parameters.




v-delete-domain

delete web/dns/mail domain options:

USER DOMAIN


The function deletes web/dns/mail domain.




v-add-web-domain-ftp

add ftp account for web domain. options:

USER DOMAIN FTP_USER FTP_PASSWORD [FTP_PATH]


The function creates additional ftp account for web domain.




v-update-sys-rrd-la

update load average rrd options:

PERIOD


The function is for updating load average rrd database and graphic.




v-move-fs-file

move file options:

USER SRC_FILE DST_FLE


The function moved file or directory on the file system. This function can also be used to rename files just like normal mv command.




v-suspend-mail-account

suspend mail account options:

USER DOMAIN ACCOUNT


The function suspends mail account.




v-delete-mail-account-fwd-only

delete mail account forward-only flag options:

USER DOMAIN ACCOUNT


The function deletes fwd-only flag




v-delete-remote-dns-record

delete remote dns domain record options:

USER DOMAIN ID


The function synchronize dns with the remote server.




v-search-fs-object

search file or directory options:

USER OBJECT [PATH]


The function search files and directories on the file system




v-change-web-domain-stats

change web domain statistics options:

USER DOMAIN TYPE


The function of deleting site's system of statistics. Its type is automatically chooses from client's configuration file.




v-delete-user-ips

delete user ips options:

USER


The function deletes all user's ip addresses.




v-unsuspend-mail-domain

unsuspend mail domain options:

USER DOMAIN


The function unsuspends mail domain.




v-unsuspend-databases

unsuspend databases options:

USER


The function for unsuspending all user's databases.




v-change-user-name

change user full name options:

USER FNAME LNAME


The function allow to change user's full name.




v-delete-dns-record

delete dns record options:

USER DOMAIN ID [RESTART]


The function for deleting a certain record of DNS zone.




v-change-database-host-password

change database server password options:

TYPE HOST USER PASSWORD


The function changes database server password.




v-deactivate-vesta-license

deactivate vesta license options:

MODULE LICENSE


The function deactivates vesta license




v-change-remote-dns-domain-soa

change remote dns domain SOA options:

USER DOMAIN


The function synchronize dns domain with the remote server.




v-update-database-disk

update database disk usage options:

USER DATABASE


The function recalculates disk usage for specific database.




v-add-web-domain-httpauth

add password protection for web domain options:

USER DOMAIN AUTH_USER AUTH_PASSWORD [RESTART]


The call is used for securing web domain with http auth




v-list-web-templates-proxy

listing proxy templates options:

[FORMAT]


The function for obtaining the list of proxy templates available to a user.




v-update-sys-rrd-ftp

update ftp rrd options:

PERIOD


The function is for updating ftpd rrd database and graphic.




v-change-sys-language

change sys language options:

LANGUAGE


The function for changing system language.




v-add-database-host

add new database server options:

TYPE HOST DBUSER DBPASS [MAX_DB] [CHARSETS] [TEMPLATE]


The function add new database server to the server pool. It supports local and remote database servers, which is useful for clusters. By adding a host you can set limit for number of databases on a host. Template parameter is used only for PostgreSQL and has an default value "template1". You can read more about templates in official PostgreSQL documentation.




v-list-sys-php-config

list php config parameters options:

[FORMAT]


The function for obtaining the list of php config parameters.




v-add-sys-firewall

add system firewall options:

NONE


The script enables firewall




v-update-user-disk

update user disk usage options:

USER


The functions recalculates disk usage and updates database.




v-delete-web-domain-ssl

delete web domain SSL support options:

USER DOMAIN


The function disable https support and deletes SSL certificates.




v-update-sys-ip

update system ip options:

[USER] [IP_STATUS]


The function scans configured ip in the system and register them with vesta internal database. This call is intended for use on vps servers, where ip is set by hypervizor.




v-list-web-templates

list web templates options:

USER [FORMAT]


The function for obtaining the list of web templates available to a user.




v-list-database-hosts

list database hosts options:

[FORMAT]


The function for obtaining the list of all configured database hosts.




v-list-mail-domains

list mail domains options:

USER [FORMAT]


The function of obtaining the list of all user domains.




v-list-web-domain-accesslog

list web domain access log options:

USER DOMAIN [LINES] [FORMAT]


The function of obtaining raw access web domain logs.




v-suspend-dns-domain

suspend dns domain options:

USER DOMAIN [RESTART]


The function suspends a certain user's domain.




v-delete-web-domain-proxy

deleting web domain proxy configuration options:

USER DOMAIN


The function of deleting the virtualhost proxy configuration.




v-update-web-domains-stat

update domains statistics options:

USER


The function runs log analyzer usage for all user webdomains.




v-unsuspend-user

unsuspend user options:

USER [RESTART]


The function unsuspends user and all his objects.




v-restart-web

restart web server options:

NONE


The function reloads web server configuration.




v-change-web-domain-httpauth

change password for http auth user options:

USER DOMAIN AUTH_USER AUTH_PASSWORD


The call is used for changing http auth user password




v-delete-web-domain-alias

delete web domain alias options:

USER DOMAIN ALIAS [RESTART]


The function of deleting the alias domain (parked domain). By this call default www aliase can be removed as well.




v-stop-service

stop service options:

SERVICE


The function stops system service.




v-change-firewall-rule

change firewall rule options:

RULE ACTION IP PORT [PROTOCOL] [COMMENT]


The function is used for changing existing firewall rule. It fully replace rule with new one but keeps same id.




v-change-domain-owner

change domain owner options:

DOMAIN USER


The function of changing domain ownership.




v-suspend-mail-accounts

suspend all mail domain accounts options:

USER DOMAIN


The function suspends all mail domain accounts.




v-list-user-ips

list user ips options:

USER [FORMAT]


The function for obtaining the list of available ip addresses.




v-add-dns-record

add dns record options:

USER DOMAIN RECORD TYPE VALUE [PRIORITY] [ID] [RESTART]


The call is used for adding new DNS record. Complex records of TXT, MX and SRV types can be used by a filling in the 'value' argument. The function also gets an id parameter for definition of certain record identifier or for the regulation of records.




v-list-user-notifications

list user notifications options:

USER [FORMAT]


The function for getting the list notifications




v-add-web-domain-backend

add web domain backend options:

USER DOMAIN [TEMPLATE] [RESTART]


The call is used for adding web backend configuration.




v-list-user-backup-exclusions

list backup exclusions options:

USER [FORMAT]


The function for obtaining the backup exclusion list




v-list-sys-users

list system users options:

[FORMAT]


The function for obtaining the list of system users without detailed information.




v-unsuspend-mail-accounts

unsuspend all mail domain accounts options:

USER DOMAIN


The function unsuspends all mail domain accounts.




v-list-sys-dovecot-config

list dovecot config parameters options:

[FORMAT]


The function for obtaining the list of dovecot config parameters.




v-suspend-mail-domain

suspend mail domain options:

USER DOMAIN


The function suspends mail domain.




v-suspend-database

suspend database options:

USER DATABASE


The function for suspending a certain user database.




v-delete-remote-dns-domains

delete remote dns domains options:

[HOST]


The function deletes remote dns domains.




v-add-web-domain-ssl

adding ssl for domain options:

USER DOMAIN SSL_DIR [SSL_HOME] [RESTART]


The function turns on SSL support for a domain. Parameter ssl_dir is a path to directory where 2 or 3 ssl files can be found. Certificate file domain.tld.crt and its key domain.tld.key are mandatory. Certificate authority domain.tld.ca file is optional. If home directory parameter (ssl_home) is not set, https domain uses public_shtml as separate documentroot directory.




v-list-user-backup

list user backup options:

USER BACKUP [FORMAT]


The function of obtaining the list of backup parameters. This call, just as all v_list_* calls, supports 3 formats - json, shell and plain.




v-add-sys-sftp-jail

add system sftp jail options:

NONE


The script enables sftp jailed environment




v-list-sys-mail-status

list mail status options:

[FORMAT]


The function lists mail server status




v-update-sys-rrd-mail

update mail rrd options:

PERIOD


The function is for updating mail rrd database and graphic.




v-change-sys-config-value

change sysconfig value options:

KEY VALUE


The function is for changing main config settings such as COMPANY_NAME or COMPANY_EMAIL and so on.




v-suspend-web-domains

suspend web domains options:

USER [RESTART]


The function of suspending all user's sites.




v-search-user-object

search objects options:

USER OBJECT [FORMAT]


The function that allows to find user objects.




v-delete-sys-firewall

delete system firewall options:

NONE


The script disables firewall support




v-backup-users

backup all users options:

NONE


The function backups all system users.




v-delete-dns-on-web-alias

delete dns domain or dns record based on web domain alias options:

USER DOMAIN


The function deletes dns domain or dns record based on web domain alias.




v-add-firewall-rule

add firewall rule options:

ACTION IP PORT [PROTOCOL] [COMMENT] [RULE]


The function adds new rule to system firewall




v-check-fs-permission

open file options:

USER FILE


The function opens/reads files on the file system




v-add-mail-account-autoreply

add mail account autoreply message options:

USER DOMAIN ACCOUNT MESSAGE


The function add new email account.




v-delete-user-notification

delete user notification options:

USER NOTIFICATION


The function deletes user notification.




v-update-sys-rrd-httpd

update httpd rrd options:

PERIOD


The function is for updating apache rrd database and graphic.




v-add-user-notification

add user notification options:

USER TOPIC NOTICE [TYPE]


The function adds user notification.




v-unsuspend-database

unsuspend database options:

USER DATABASE


The function for unsuspending database.




v-add-remote-dns-domain

add remote dns domain options:

USER DOMAIN [FLUSH]


The function synchronize dns domain with the remote server.




v-insert-dns-domain

insert dns domain options:

USER DATA [SRC] [FLUSH] [RESTART]


The function inserts raw record to the dns.conf




v-add-web-domain-alias

add web domain alias options:

USER DOMAIN ALIASES [RESTART]


The call is intended for adding aliases to a domain (it is also called "domain parking"). The function supports wildcards *.domain.tpl.




v-list-cron-job

list cron job options:

USER JOB [FORMAT]


The function of obtaining cron job parameters.




v-sync-dns-cluster

synchronize dns domains options:

HOST


The function synchronize all dns domains.




v-list-databases

listing databases options:

USER [FORMAT]


The function for obtaining the list of all user's databases.




v-change-database-password

change database password options:

USER DATABASE DBPASS


The function for changing database user password to a database. It uses the full name of database as argument.




v-schedule-user-backup

schedule user backup creation options:

USER


The function for scheduling user backup creation.




v-update-sys-rrd-ssh

update ssh rrd options:

PERIOD


The function is for updating ssh rrd database and graphic.




v-change-sys-ip-status

change ip status options:

IP IP_STATUS


The function of changing an ip address's status.




v-update-web-domain-stat

update domain statistics options:

USER DOMAIN


The function runs log analyzer for specific webdomain.




v-list-sys-web-status

list web status options:

[FORMAT]


The function lists web server status




v-list-dns-domains

list dns domains options:

USER [FORMAT]


The function for obtaining all DNS domains of a user.




v-add-mail-account-alias

add mail account alias aka nickname options:

USER DOMAIN ACCOUNT ALIAS


The function add new email alias.




v-list-sys-shells

list system shells options:

[FORMAT]


The function for obtaining the list of system shells.




v-unsuspend-web-domain

unsuspend web domain options:

USER DOMAIN


The function of unsuspending the domain.




v-update-firewall

update system firewall rules options:

NONE


The function updates iptables rules




v-list-sys-cpu-status

list system cpu info options:

[FORMAT]


The function lists cpu information




v-delete-user-sftp-jail

delete user sftp jail options:

USER


The script disables sftp jailed environment for USER




v-change-user-package

change user package options:

USER PACKAGE [FORCE]


The function changes user's hosting package.




v-add-cron-job

add cron job options:

USER MIN HOUR DAY MONTH WDAY COMMAND [JOB] [RESTART]


The function adds a job to cron daemon. When executing commands, any output is mailed to user's email if parameter REPORTS is set to 'yes'.




v-list-sys-memory-status

list virtual memory info options:

[FORMAT]


The function lists virtual memory information




v-add-dns-on-web-alias

add dns domain or dns record after web domain alias options:

USER ALIAS IP [RESTART]


The function adds dns domain or dns record based on web domain alias.




v-suspend-dns-record

suspend dns domain record options:

USER DOMAIN ID [RESTART]


The function suspends a certain domain record.




v-rebuild-dns-domains

rebuild dns domains options:

USER [RESTART] [UPDATE_SERIAL]


The function rebuilds DNS configuration files.




v-list-database

list database options:

USER DATABASE [FORMAT]


The function for obtaining of all database's parameters.




v-delete-remote-dns-host

delete remote dns host options:

HOST


The function for deleting the remote dns host from vesta configuration.




v-update-web-domains-traff

update domains bandwidth usage options:

USER


The function recalculates bandwidth usage for all user webdomains.




v-update-web-domain-ssl

updating ssl certificate for domain options:

USER DOMAIN SSL_DIR [RESTART]


The function updates the SSL certificate for a domain. Parameter ssl_dir is a path to directory where 2 or 3 ssl files can be found. Certificate file domain.tld.crt and its key domain.tld.key are mandatory. Certificate authority domain.tld.ca file is optional.




v-suspend-mail-domains

suspend mail domains options:

USER


The function suspends all user's MAIL domains.




v-list-database-types

list supported database types options:

[FORMAT]


The function for obtaining the list of database types.




v-suspend-cron-jobs

Suspending sys cron jobs options:

USER [RESTART]


The function suspends all user cron jobs.




v-list-user-favourites

list user favourites options:

USER [FORMAT]


The function for getting the list of favourite user objects




v-change-cron-job

change cron job options:

USER JOB MIN HOUR DAY MONTH WDAY COMMAND


The function is used for changing existing job. It fully replace job parameters with new one but with same id.




v-list-sys-config

list system configuration options:

[FORMAT]


The function for obtaining the list of system parameters.




v-add-remote-dns-record

add remote dns domain record options:

USER DOMAIN ID


The function synchronize dns domain with the remote server.




v-get-user-value

get user value options:

USER KEY


The function for obtaining certain user's parameters.




v-extract-fs-archive

archive to directory options:

USER ARCHIVE DIRECTORY


The function extracts archive into directory on the file system




v-add-dns-domain

add dns domain options:

USER DOMAIN IP [NS1] [NS2] [NS3] [..] [NS8] [RESTART]


The function adds DNS zone with records defined in the template. If the exp argument isn't stated, the expiration date value will be set to next year. The soa argument is responsible for the relevant record. By default the first user's NS server is used. TTL is set as common for the zone and for all of its records with a default value of 14400 seconds.




v-change-web-domain-name

change web domain name options:

USER DOMAIN NEW_DOMAIN [RESTART]


The call is used for changing the domain name.




v-list-users

list users options:

[FORMAT]


The function to obtain the list of all system users.




v-generate-api-key

generate api key options:

NONE


The function creates a key file in /usr/local/vesta/data/keys/




v-unsuspend-domain

unsuspend web/dns/mail domain options:

USER DOMAIN


The function unsuspends web/dns/mail domain.




v-unsuspend-dns-record

unsuspend dns domain record options:

USER DOMAIN ID [RESTART]


The function unsuspends a certain domain record.




v-open-fs-file

open file options:

USER FILE


The function opens/reads files on the file system




v-update-sys-ip-counters

update IP usage counters options:

IP


Function updates usage U_WEB_ADOMAINS and U_SYS_USERS counters.




v-list-web-stats

list web statistics options:

[FORMAT]


The function for obtaining the list of web statistics analyzer.




v-delete-mail-domain-antispam

delete mail domain antispam support options:

USER DOMAIN


The function disable spamassasin for incoming emails.




v-delete-sys-sftp-jail

delete system sftp jail options:

NONE


The script disables sftp jailed environment




v-get-web-domain-value

get web domain value options:

USER DOMAIN KEY


The function is intended for obtaining a domain value by the key. This call is useful for arranging composite queries. The answer is displayed only in raw form; output formats aren't supported.




v-update-user-stats

update user statistics options:

USER


Function logs user parameters into statistics database.




v-delete-dns-domains

delete dns domains options:

USER


The function for deleting all users DNS domains.




v-change-dns-record-id

change dns domain record id options:

USER DOMAIN ID NEWID [RESTART]


The function for changing internal record id.




v-activate-vesta-license

activate vesta license options:

MODULE LICENSE


The function activates and registers the vesta license




v-delete-fs-file

delete file options:

USER FILE


The function deletes file on the file system




v-list-web-domains

list web domains options:

USER [FORMAT]


The function to obtain the list of all user web domains.




v-delete-mail-account

delete mail account options:

USER DOMAIN ACCOUNT


The function deletes email account.




v-change-sys-hostname

change hostname options:

HOSTNAME


The function for changing system hostname.




v-change-web-domain-backend-tpl

change web domain backend template options:

USER DOMAIN TEMPLATE [RESTART]


The function changes backend template




v-change-sys-service-config

change service config options:

CONFIG SERVICE [RESTART]


The function for changing service confguration.




v-delete-backup-host

delete backup ftp server options:

TYPE


The function deletes ftp backup host




v-add-web-domain

add web domain options:

USER DOMAIN [IP] [ALIASES] [PROXY_EXTENSIONS] [RESTART]


The function adds virtual host to a server. In cases when ip is undefined in the script, "default" template will be used. The alias of www.domain.tld type will be automatically assigned to the domain unless "none" is transmited as argument. If ip have associated dns name, this domain will also get the alias domain-tpl.$ipname. An alias with the ip name is useful during the site testing while dns isn't moved to server yet.




v-list-cron-jobs

list user cron jobs options:

USER [FORMAT]


The function for obtaining the list of all users cron jobs.




v-list-user-ns

list user nameservers options:

USER [FORMAT]


Function for obtaining the list of user's DNS servers.




v-restart-mail

restart mail service options:

NONE


The function tells Exim service to reload configuration files.




v-add-remote-dns-host

add new remote dns host options:

HOST PORT USER PASSWORD [TYPE] [DNS_USER]


The function adds remote dns server to the dns cluster.




v-add-letsencrypt-domain

adding letsencrypt ssl cetificate for domain options:

USER DOMAIN [ALIASES] [RESTART] [NOTIFY]


The function turns on SSL support for a domain. Parameter ssl_dir is a path to directory where 2 or 3 ssl files can be found. Certificate file domain.tld.crt and its key domain.tld.key are mandatory. Certificate authority domain.tld.ca file is optional. If home directory parameter (ssl_home) is not set, https domain uses public_shtml as separate documentroot directory.




v-delete-fs-directory

delete directory options:

USER DIRECTORY


The function deletes directory on the file system




v-unsuspend-cron-job

unsuspend cron job options:

USER JOB [RESTART]


The function unsuspend certain cron job.




v-change-dns-domain-ip

change dns domain ip address options:

USER DOMAIN IP


The function for changing the main ip of DNS zone.




v-get-sys-timezone

get system timezone options:

[FORMAT]


The function to get system timezone




v-list-dns-template

list dns template options:

TEMPLATE [FORMAT]


The function for obtaining the DNS template parameters.




v-list-dns-templates

list dns templates options:

[FORMAT]


The function for obtaining the list of all DNS templates available.




v-list-web-domain

list web domain parameters options:

USER DOMAIN [FORMAT]


The function to obtain web domain parameters.




v-update-sys-rrd

update system rrd charts options:

NONE


The script is wrapper for all rrd functions. It updates all v-update-sys-rrd_* at once.




v-list-user-stats

list user stats options:

[FORMAT]


The function for listing user statistics




v-schedule-user-restore

schedule user backup restoration options:

USER BACKUP [WEB] [DNS] [MAIL] [DB] [CRON] [UDIR]


The function for scheduling user backup restoration.




v-update-letsencrypt-ssl

update letsencrypt ssl certificates options:

NONE


The function for renew letsencrypt expired ssl certificate for all users




v-change-database-user

change database username options:

USER DATABASE DBUSER [DBPASS]


The function for changing database user. It uses the




v-update-mail-domain-disk

update mail domain disk usage options:

USER DOMAIN


The function updates domain disk usage.




v-change-mail-domain-catchall

change mail domain catchall email options:

USER DOMAIN EMAIL


The function changes mail domain catchall.




v-list-user-packages

list user packages options:

[FORMAT]


The function for obtaining the list of available hosting packages.




v-add-sys-quota

add system quota options:

NONE


The script enables filesystem quota on /home partition




v-list-database-host

list database host options:

TYPE HOST [FORMAT]


The function for obtaining database host parameters.




v-delete-web-domain-backend

deleting web domain backend configuration options:

USER DOMAIN [RESTART]


The function of deleting the virtualhost backend configuration.




v-change-sys-ip-owner

change ip owner options:

IP USER


The function of changing ip address ownership.




v-delete-mail-domain-dkim

delete mail domain dkim support options:

USER DOMAIN [DKIM_SIZE]


The function delete DKIM domain pem.




v-add-fs-file

add file options:

USER FILE


The function creates new files on file system




v-delete-firewall-rule

delete firewall rule options:

RULE


The function deletes firewall rule.




v-add-fs-directory

add directory options:

USER DIRECTORY


The function creates new directory on the file system




v-unsuspend-cron-jobs

unsuspend sys cron options:

USER [RESTART]


The function unsuspends all suspended cron jobs.




v-change-sys-timezone

change system timezone options:

TIMEZONE


The function for changing system timezone.




v-change-web-domain-sslhome

changing domain ssl home options:





v-rebuild-web-domains

rebuild web domains options:

USER [RESTART]


The function rebuilds web configuration files.




v-change-remote-dns-domain-ttl

change remote dns domain TTL options:

USER DOMAIN


The function synchronize dns domain with the remote server.




v-add-mail-domain-antivirus

add mail domain antivirus support options:

USER DOMAIN


The function enables clamav scan for incoming emails.




v-list-backup-host

list backup host options:

TYPE HOST [FORMAT]


The function for obtaining the list of backup host parameters.




v-restart-dns

restart dns service options:

NONE


The function tells BIND service to reload dns zone files.




v-delete-user-favourites

deleting user favourites options:

USER SYSTEM OBJECT


The function deletes object from users favourites




v-update-mail-domains-disk

calculate disk usage for all mail domains options:

USER


The function calculates disk usage for all mail domains.




v-add-cron-letsencrypt-job

add letsencrypt cronjob options:

NONE


The script for enabling letsencrypt cronjob




v-list-sys-network-status

list system network status options:

[FORMAT]


The function lists network status




v-update-sys-rrd-mysql

update MySQL rrd options:

PERIOD


The function is for updating mysql rrd database and graphic.




v-copy-fs-file

copy file options:

USER SRC_FILE DST_FLE


The function copies file on the file system




v-list-sys-nginx-config

list nginx config parameters options:

[FORMAT]


The function for obtaining the list of nginx config parameters.




v-update-web-domains-disk

update domains disk usage options:

USER


The function recalculates disk usage for all user webdomains.




v-move-fs-directory

move file options:

USER SRC_DIRECTORY DST_DIRECTORY


The function moved file or directory on the file system. This function can also be used to rename files just like normal mv command.




v-rebuild-cron-jobs

rebuild cron jobs options:

USER [RESTART]


The function rebuilds system cron config file for specified user.




v-change-sys-ip-name

change ip name options:

IP NAME


The function for changing dns domain associated with ip.




v-delete-cron-restart-job

delete restart job options:

NONE


The script for disabling restart cron tasks




v-add-fs-archive

archive directory options:

USER ARCHIVE SOURCE


The function creates tar archive




v-suspend-user

suspend user options:

USER [RESTART]


The function suspends a certain user and all his objects.




v-unsuspend-firewall-rule

unsuspend firewall rule options:

RULE


The function unsuspends a certain firewall rule.




v-delete-mail-domain-antivirus

delete mail domain antivirus support options:

USER DOMAIN


The function disables clamav scan for incoming emails.




v-change-user-contact

change user contact email options:

USER EMAIL


The function for changing of e-mail associated with a certain user.




v-suspend-databases

suspend databases options:

USER


The function for suspending of all databases of a single user.




v-update-user-backup-exclusions

update backup exclusion list options:

USER FILE


The function for updating backup exclusion list




v-schedule-letsencrypt-domain

adding cronjob for letsencrypt cetificate installation options:

USER DOMAIN [ALIASES]


The function adds cronjob for letsencrypt ssl certificate installation




v-restart-proxy

restart proxy server options:

NONE


The function reloads proxy server configuration.




v-list-mail-domain-dkim

list mail domain dkim options:

USER DOMAIN [FORMAT]


The function of obtaining domain dkim files.




v-delete-mail-domain

delete mail domain options:

USER DOMAIN


The function for deleting MAIL domain. By deleting it all accounts will also be deleted.




v-list-web-domain-ssl

list web domain ssl certificate options:

USER DOMAIN [FORMAT]


The function of obtaining domain ssl files.




v-delete-web-domain-stats

delete web domain statistics options:

USER DOMAIN


The function of deleting site's system of statistics. Its type is automatically chooses from client's configuration file.




v-update-user-quota

update user disk quota options:

USER


The functions upates disk quota for specific user




v-update-sys-rrd-apache2

update apache2 rrd options:

PERIOD


The function is for updating apache rrd database and graphic.




v-delete-database

delete database options:

USER DATABASE


The function for deleting the database. If database user have access to another database, he will not be deleted.




v-delete-mail-account-alias

delete mail account alias aka nickname options:

USER DOMAIN ACCOUNT ALIAS


The function deletes email account alias.




v-change-dns-domain-exp

change dns domain expiration date options:

USER DOMAIN EXP


The function of changing the term of expiration domain's registration. The serial number will be refreshed automatically during update.




v-suspend-firewall-rule

suspend firewall rule options:

RULE


The function suspends a certain firewall rule.




v-change-web-domain-ftp-password

change ftp user password. options:

USER DOMAIN FTP_USER FTP_PASSWORD


The function changes ftp user password.




v-list-sys-clamd-config

list clamd config parameters options:

[FORMAT]


The function for obtaining the list of clamd config parameters.




v-list-firewall-rule

list firewall rule options:

RULE [FORMAT]


The function of obtaining firewall rule parameters.




v-add-backup-host

add backup host options:

TYPE HOST USERNAME PASSWORD [PATH] [PORT]


This function adds a backup host




v-list-letsencrypt-user

list letsencrypt key options:

USER [FORMAT]


The function for obtaining the letsencrypt key thumbprint




v-add-web-domain-proxy

add webdomain proxy support options:

USER DOMAIN [TEMPLATE] [EXTENTIONS] [RESTART]


The function enables proxy support for a domain. This can significantly improve website speed.




v-list-sys-vesta-updates

list system updates options:

[FORMAT]


The function checks available updates for vesta packages.




v-list-web-templates-backend

listing backend templates options:

[FORMAT]


The function for obtaining the list of available backend templates.




v-add-mail-domain-dkim

add mail domain dkim support options:

USER DOMAIN [DKIM_SIZE]


The function adds DKIM signature to outgoing domain emails.




v-change-remote-dns-domain-exp

change remote dns domain expiration date options:

USER DOMAIN


The function synchronize dns domain with the remote server.




v-change-mail-account-quota

change mail account quota options:

USER DOMAIN ACCOUNT QUOTA


The function changes email account disk quota.




v-get-sys-timezones

list system timezone options:

[FORMAT]


The function checks system timezone settings




v-list-user-log

list user log options:

USER [FORMAT]


The function of obtaining the list of 100 last users commands.




v-update-databases-disk

update databases disk usage options:

USER


The function recalculates disk usage for all user databases.




v-add-cron-vesta-autoupdate

add cron job for vesta autoupdates options:

NONE


The function adds cronjob for vesta autoupdate.




v-update-user-counters

update user usage counters options:

USER


Function updates usage counters like U_WEB_DOMAINS, U_MAIL_ACCOUNTS, etc.




v-change-fs-file-permission

change file permission options:

USER FILE PERMISSIONS


The function changes file access permissions on the file system




v-suspend-cron-job

suspend cron job options:

USER JOB [RESTART]


The function suspends a certain job of the cron scheduler.




v-check-vesta-license

check vesta license options:

[MODULE]


The function activates and register vesta license




v-add-web-domain-stats-user

add password protection to web domain statistics options:

USER DOMAIN STATS_USER STATS_PASSWORD


The call is used for securing the web statistics page.




v-add-mail-account-forward

add mail account forward address options:

USER DOMAIN ACCOUNT FORWARD


The function add new email account.




v-update-sys-rrd-pgsql

update PostgreSQL rrd options:

PERIOD


The function is for updating postgresql rrd database and graphic.




v-get-mail-account-value

get mail account value options:

USER DOMAIN ACCOUNT KEY


The function for getting a certain mail account parameter.




v-update-dns-templates

update dns templates options:

[RESTART]


The function for obtaining updated pack of dns templates.




v-list-sys-ips

list system ips options:

[FORMAT]


The function for obtaining the list of system ip adresses.




v-delete-remote-dns-domain

delete remote dns domain options:

USER DOMAIN


The function synchronize dns with the remote server.




v-list-sys-mysql-config

list mysql config parameters options:

[FORMAT]


The function for obtaining the list of mysql config parameters.




v-update-sys-vesta-all

update all vesta packages options:

USER [RESTART]


The function of updating all vesta packages




v-delete-databases

delete user databases options:

USER


The function deletes all user databases.




v-delete-sys-quota

delete system quota options:

NONE


The script disables filesystem quota on /home partition




v-suspend-database-host

suspend database server options:

TYPE HOST


The function for suspending a database server.




v-change-web-domain-ftp-path

change path for ftp user. options:

USER DOMAIN FTP_USER FTP_PATH


The function changes ftp user path.




v-unsuspend-mail-account

unsuspend mail account options:

USER DOMAIN ACCOUNT


The function unsuspends mail account.




v-add-mail-domain-catchall

add mail domain catchall account options:

USER DOMAIN EMAIL


The function enables catchall account for incoming emails.




v-update-sys-vesta

update vesta package/configs options:

PACKAGE [VERSION]


The function runs as rpm update trigger. It pulls shell script from vesta server and runs it.




v-add-letsencrypt-user

register letsencrypt user account options:

USER [EMAIL]


The function creates and register LetsEncript account key




v-list-web-domain-errorlog

list web domain error log options:

USER DOMAIN [LINES] [FORMAT]


The function of obtaining raw error web domain logs.




v-change-dns-domain-soa

change dns domain soa record options:

USER DOMAIN SOA


The function for changing SOA record. This type of records can not be modified by v-change-dns-record call.




v-delete-dns-domains-src

delete dns domains based on SRC field options:

USER SRC [RESTART]


The function for deleting DNS domains related to a certain host.




v-list-mail-domain-dkim-dns

list mail domain dkim dns records options:

USER DOMAIN [FORMAT]


The function of obtaining domain dkim dns records for proper setup.




v-add-mail-account-fwd-only

add mail account forward-only flag options:

USER DOMAIN ACCOUNT


The function adds fwd-only flag




v-change-web-domain-tpl

change web domain template options:

USER DOMAIN TEMPLATE [RESTART]


The function changes template of the web configuration file. The content of webdomain directories remains untouched.




v-rebuild-dns-domain

rebuild dns domain options:

USER DOMAIN [RESTART] [UPDATE_SERIAL]


The function rebuilds DNS configuration files.




v-unsuspend-remote-dns-host

unsuspend remote dns server options:

HOST


The function for unsuspending remote dns server.




v-check-user-password

check user password options:

USER PASSWORD [IP]


The function verifies user password from file




v-add-mail-account

add mail domain account options:

USER DOMAIN ACCOUNT PASSWORD [QUOTA]


The function add new email account.




v-change-web-domain-proxy-tpl

change web domain proxy template options:

USER DOMAIN TEMPLATE [EXTENTIONS] [RESTART]


The function changes proxy template




v-add-user-package

adding user package options:

PKG_DIR PACKAGE [REWRITE]


The function adds new user package to the system.




v-delete-user

delete user options:

USER


This function deletes a certain user and all his resources such as domains, databases, cron jobs, etc.




v-list-sys-ip

list system ip options:

IP [FORMAT]


The function for getting the list of system ip parameters.




v-change-database-owner

change database owner options:

DATABASE USER


The function for changing database owner.




v-add-mail-domain

add mail domain options:

USER DOMAIN [ANTISPAM] [ANTIVIRUS] [DKIM] [DKIM_SIZE]


The function adds MAIL domain.




v-list-sys-vesta-autoupdate

list vesta autoupdate settings options:

[FORMAT]


The function for obtaining autoupdate setings.




v-delete-dns-domain

delete dns domain options:

USER DOMAIN


The function for deleting DNS domain. By deleting it all records will also be deleted.




v-list-sys-info

list system os options:

[FORMAT]


The function checks available updates for vesta packages.




v-change-dns-domain-ttl

change dns domain ttl options:

USER DOMAIN TTL


The function for changing the time to live TTL parameter for all records.




v-search-domain-owner

search domain owner options:

DOMAIN [TYPE]


The function that allows to find user objects.




v-start-service

start service options:

SERVICE


The function starts system service.




v-delete-web-domain

delete web domain options:

USER DOMAIN


The call of function leads to the removal of domain and all its components (statistics, folders contents, ssl certificates, etc.). This operation is not fully supported by "undo" function, so the data recovery is possible only with a help of reserve copy.




v-list-user-backups

list user backups options:

USER [FORMAT]


The function for obtaining the list of available user backups.




v-list-fs-directory

list directory options:

USER DIRECTORY


The function lists directory on the file system




v-add-cron-restart-job

add cron reports options:

NONE


The script for enabling restart cron tasks




v-list-sys-rrd

list system rrd charts options:

[FORMAT]


List available rrd graphics, its titles and paths.




v-add-user-favourites

adding user favourites options:

USER SYSTEM OBJECT


The function adds object to users favourites




v-rebuild-user

rebuild system user options:

USER [RESTART]


The function rebuilds system user account.




v-restart-system

restart operating system options:

RESTART


The function restarts operating system.




v-list-users-stats

list overall user stats options:

[FORMAT]


The function for listing overall user statistics




v-change-web-domain-sslcert

change domain ssl certificate options:

USER DOMAIN SSL_DIR [RESTART]


The function changes SSL domain certificate and the key. If ca file present it will be replaced as well.




v-delete-sys-ip

delete system ip options:

IP


The function for deleting a system ip. It does not allow to delete first ip on interface and do not allow to delete ip which is used by a web domain.




v-list-firewall

list iptables rules options:

[FORMAT]


The function of obtaining the list of all iptables rules.




v-change-user-language

change user language options:

USER LANGUAGE


The function for changing language.




v-delete-user-backup

delete user backup options:

USER NACKUP


The function deletes user backup.




v-change-user-password

change user password options:

USER PASSWORD


The function changes user's password and updates RKEY value.




v-unsuspend-mail-domains

unsuspend mail domains options:

USER


The function unsuspends all user's MAIL domains.




v-list-mail-domain

list mail domain options:

USER DOMAIN [FORMAT]


The function of obtaining the list of domain parameters.