| ? | 1.0a100 | | aosh_commands | displays the help screen | [<b>syntax</b>|<i>command</i>] |
| add_backup_server | 1.0a108 | | servers | adds a new backup server | <i>hostname</i> <i>farm</i> <i>owner</i> <i>description</i> <i>backup_hour</i> <i>os_type</i> <i>os_version</i> <i>architecture</i> <i>username</i> <i>password</i> <i>contact_phone</i> <i>contact_email</i> |
| add_business | 1.0a103 | | businesses | adds a new business to the system | <i>accounting_code</i> <i>contract_version</i> <i>default_server</i> <i>parent_business</i> <i>can_add_backup_server</i> <i>can_add_businesses</i> <i>can_see_prices</i> <i>bill_parent</i> |
| add_business_administrator | 1.44 | | business_administrators | adds a business administrator to the list of people who may maintain the account | <i>username</i> <i>full_name</i> {""|<i>title</i>} {""|<i>birthday</i>} <i>is_private</i> <i>work_phone</i> {""|<i>home_phone</i>} {""|<i>cell_phone</i>} {""|<i>fax</i>} <i>email_address</i> {""|<i>address1</i>} {""|<i>address2</i>} {""|<i>city</i>} {""|<i>state</i>} {""|<i>country</i>} {""|<i>zip</i>} <i>enable_email_support</i> |
| add_business_profile | 1.81.20 | | business_profiles | adds a new business profile to a business | <i>business</i> <i>name</i> <i>is_private</i> <i>phone</i> {""|<i>fax</i>} <i>address1</i> {""|<i>address2</i>} <i>city</i> {""|<i>state</i>} <i>country</i> {""|<i>zip</i>} <i>send_invoice</i> <i>billing_contact</i> <i>billing_email</i> <i>billingEmailFormat</i> <i>technical_contact</i> <i>technical_email</i> <i>technicalEmailFormat</i> |
| add_business_server | 1.31 | | business_servers | grants a business access to a server | <i>business</i> <i>server</i> |
| add_cvs_repository | 1.0a100 | | cvs_repositories | adds a CVS repository to a server | <i>ao_server</i> <i>path</i> <i>username</i> <i>group</i> <i>mode</i> |
| add_dns_record | 1.86.0 | | dns_records | adds a record to a name server zone | <i>zone</i> {<b>@</b>|<i>hostname</i>} {<b>A</b>|<b>AAAA</b>|<b>CNAME</b>|<b>NS</b>|<b>PTR</b>|<b>TXT</b>} {<i>hostname</i>|<i>ip_address</i>|<i>destination</i>|<i>value</i>} [{""|<i>ttl</i>}]
<i>zone</i> {<b>@</b>|<i>hostname</i>} <b>CAA</b> <i>flag</i> {<b>issue</b>|<b>issuewild</b>|<b>iodef</b>|<b>contactemail</b>|<b>contactphone</b>} <i>value</i> [{""|<i>ttl</i>}]
<i>zone</i> {<b>@</b>|<i>hostname</i>} <b>MX</b> <i>priority</i> {<i>hostname</i>|<i>destination</i>} [{""|<i>ttl</i>}]
<i>zone</i> {<b>@</b>|<i>hostname</i>} <b>SRV</b> <i>priority</i> <i>weight</i> <i>port</i> <i>target</i> [{""|<i>ttl</i>}]
<i>zone</i> {<b>@</b>|<i>hostname</i>} <i>type</i> {""|<i>priority</i>} {""|<i>weight</i>} {""|<i>port</i>} {""|<i>flag</i>} {""|<i>tag</i>} <i>value</i> [{""|<i>ttl</i>}] |
| add_dns_zone | 1.0a127 | | dns_zones | adds a zone to the name servers | <i>package</i> <i>zone</i> <i>ip_address</i> <i>ttl</i> |
| add_email_domain | 1.0a100 | | email_domains | adds a new email domain | <i>domain</i> <i>ao_server</i> <i>package</i> |
| add_email_forwarding | 1.0a100 | | email_forwarding | attaches a forwarding address to an email address | <i>from_address</i> <i>ao_server</i> <i>to_address</i> [<i>from_address</i> <i>ao_server</i> <i>to_address</i>]... |
| add_email_list | 1.0a100 | | email_lists | adds a new email list | <i>ao_server</i> <i>path</i> <i>username</i> <i>group</i> |
| add_email_list_address | 1.0a100 | | email_list_addresses | attaches an email address to an email list | <i>address</i> <i>path</i> <i>ao_server</i> [<i>address</i> <i>path</i> <i>ao_server</i>]... |
| add_email_pipe | 1.80.0 | | email_pipes | adds a new email pipe | <i>ao_server</i> <i>command</i> <i>package</i> |
| add_email_pipe_address | 1.0a100 | | email_pipe_addresses | attaches an email address to an email pipe | <i>address</i> <i>pipe_pkey</i> [<i>address</i> <i>pipe_pkey</i>]... |
| add_email_smtp_relay | 1.0a100 | | email_smtp_relays | adds a SMTP relay rule | <i>package</i> {""|<i>ao_server</i>} <i>host</i> <i>type</i> {""|<i>duration</i>} |
| add_file_backup_setting | 1.62 | | file_backup_settings | creates a new FileBackupSetting | <i>replication</i> <i>path</i> <i>backup_enabled</i> <i>required</i> |
| add_ftp_guest_user | 1.0a100 | | ftp_guest_users | adds a new FTP guest user | <i>username</i> |
| add_httpd_jboss_site | 1.81.10 | | httpd_jboss_sites | creates a new web site space running a JBoss configuration | <i>ao_server</i> <i>site_name</i> <i>package</i> <i>username</i> <i>group</i> <i>server_admin_email</i> <i>use_apache</i> {""|<i>ip_address</i>} {""|<i>net_device</i>} <i>jboss_version</i> <i>primary_http_hostname</i> [<i>alternate_http_hostname</i>]... |
| add_httpd_shared_tomcat | 1.81.10 | | httpd_shared_tomcats | adds a new Multi-Site Tomcat JVM to a server | <i>tomcat_name</i> <i>ao_server</i> <i>tomcat_version</i> <i>linux_server_account</i> <i>linux_server_group</i> |
| add_httpd_site_authenticated_location | 1.81.13 | | httpd_site_authenticated_locations | adds an authenticated location to a web site | <i>site_name</i> <i>ao_server</i> <i>path</i> <i>is_regular_expression</i> <i>auth_name</i> {""|<i>auth_group_file</i>} {""|<i>auth_user_file</i>} <i>require</i> {""|<i>handler</i>} |
| add_httpd_site_url | 1.0a100 | | httpd_site_urls | adds a hostname to a web site | <i>httpd_site_bind_pkey</i> <i>hostname</i> |
| add_httpd_tomcat_context | 1.81.3 | | httpd_tomcat_contexts | adds a context (webapp) to a Tomcat site | <i>site_name</i> <i>ao_server</i> {""|<i>class_name</i>} <i>use_cookies</i> <i>cross_context</i> <i>doc_base</i> <i>allow_override</i> <i>path</i> <i>is_privileged</i> <i>is_reloadable</i> <i>use_naming</i> {""|<i>wrapper_class</i>} <i>debug_level</i> {""|<i>work_dir</i>} <i>server_xml_configured</i> |
| add_httpd_tomcat_data_source | 1.5 | | httpd_tomcat_data_sources | adds a data source to a Tomcat context (webapp) | <i>site_name</i> <i>ao_server</i> <i>path</i> <i>name</i> <i>driver_class_name</i> <i>url</i> <i>username</i> <i>password</i> <i>max_active</i> <i>max_idle</i> <i>max_wait</i> {""|<i>validation_query</i>} |
| add_httpd_tomcat_parameter | 1.5 | | httpd_tomcat_parameters | adds a parameter to a Tomcat context (webapp) | <i>site_name</i> <i>ao_server</i> <i>path</i> <i>name</i> <i>value</i> <i>override</i> {""|<i>description</i>} |
| add_httpd_tomcat_shared_site | 1.81.10 | | httpd_tomcat_shared_sites | creates a new web site space running a shared Tomcat configuration | <i>ao_server</i> <i>site_name</i> <i>package</i> <i>username</i> <i>group</i> <i>server_admin</i> <i>use_apache</i> {""|<i>ip_address</i>} {""|<i>net_device</i>} {<i>shared_tomcat_name</i>} <i>primary_http_hostname</i> [<i>alternate_http_hostname</i>]... |
| add_httpd_tomcat_site_jk_mount | 1.81.6 | | httpd_tomcat_site_jk_mounts | adds a JkMount or JkUnMount to a Tomcat site | <i>site_name</i> <i>ao_server</i> <i>path</i> <i>mount</i> |
| add_httpd_tomcat_std_site | 1.81.10 | | httpd_tomcat_std_sites | creates a new web site space running a standard Tomcat configuration | <i>ao_server</i> <i>site_name</i> <i>package</i> <i>username</i> <i>group</i> <i>server_admin</i> <i>use_apache</i> {""|<i>ip_address</i>} {""|<i>net_device</i>} <i>tomcat_version</i> <i>primary_http_hostname</i> [<i>alternate_http_hostname</i>]... |
| add_ip_reputation | 1.65 | | ip_reputation_sets | adds reputation for a host and its network | <i>identifier</i> <i>ip_address</i> {<b>uncertain</b>|<b>definite</b>} {<b>good</b>|<b>bad</b>} <i>score</i> |
| add_linux_acc_address | 1.0a100 | | linux_acc_addresses | attaches an email address to a Linux account | <i>address</i> <i>ao_server</i> <i>username</i> |
| add_linux_account | 1.80.1 | | linux_accounts | adds a new Linux account | <i>username</i> <i>primary_group</i> {""|<i>full_name</i>} {""|<i>office_location</i>} {""|<i>office_phone</i>} {""|<i>home_phone</i>} <i>type</i> <i>shell</i> |
| add_linux_group | 1.0a100 | | linux_groups | adds a new Linux group | <i>group</i> <i>package</i> <i>type</i> |
| add_linux_group_account | 1.0a100 | | linux_group_accounts | grants a Linux account access to a Linux group | <i>group</i> <i>username</i> |
| add_linux_server_account | 1.0a100 | | linux_server_accounts | grants a Linux account access to a server | <i>username</i> <i>ao_server</i> {""|<i>home_directory</i>} |
| add_linux_server_group | 1.0a100 | | linux_server_groups | adds a Linux group to a server | <i>group</i> <i>ao_server</i> |
| add_majordomo_list | 1.0a100 | | majordomo_lists | adds a new Majordomo list | <i>domain</i> <i>ao_server</i> <i>list_name</i> |
| add_majordomo_server | 1.0a100 | | majordomo_servers | adds a new Majordomo server | <i>domain</i> <i>ao_server</i> <i>linux_account</i> <i>linux_group</i> <i>version</i> |
| add_mysql_database | 1.4 | | mysql_databases | adds a new MySQL database | <i>database_name</i> <i>mysql_server</i> <i>ao_server</i> <i>package</i> |
| add_mysql_db_user | 1.81.2 | | mysql_db_users | grants a MySQL user permission to access a MySQL database | <i>database_name</i> <i>mysql_server</i> <i>ao_server</i> <i>username</i> <i>can_select</i> <i>can_insert</i> <i>can_update</i> <i>can_delete</i> <i>can_create</i> <i>can_drop</i> <i>can_reference</i> <i>can_index</i> <i>can_alter</i> <i>can_create_temp_table</i> <i>can_lock_tables</i> <i>can_create_view</i> <i>can_show_view</i> <i>can_create_routine</i> <i>can_alter_routine</i> <i>can_execute</i> <i>can_event</i> <i>can_trigger</i> |
| add_mysql_server_user | 1.4 | | mysql_server_users | adds a MySQL user to a server | <i>username</i> <i>mysql_server</i> <i>ao_server</i> <i>host</i> |
| add_mysql_user | 1.0a100 | | mysql_users | adds a MySQL user to the system | <i>username</i> |
| add_net_bind | 1.81.0 | | net_binds | adds a net binds to the system | <i>server</i> <i>package</i> <i>ip_address</i> <i>net_device</i> <i>port</i> <i>net_protocol</i> <i>app_protocol</i> <i>monitoring_enabled</i> [<i>firewalld_zone</i>] [...] |
| add_notice_log | 1.83.0 | | notice_log | adds a notice log entry to a business | <i>business</i> <i>billing_contact</i> <i>email_address</i> <i>type</i> {""|<i>transaction_id</i>} |
| add_package | 1.0a123 | | packages | adds a new package to a business | <i>package</i> <i>business</i> <i>package_definition</i> |
| add_postgres_database | 1.27 | | postgres_databases | adds a new PostgreSQL database | <i>database_name</i> <i>postgres_server</i> <i>ao_server</i> <i>datdba</i> <i>encoding</i> <i>enable_postgis</i> |
| add_postgres_server_user | 1.0a100 | | postgres_server_users | adds a PostgreSQL user to a server | <i>username</i> <i>postgres_server</i> <i>ao_server</i> |
| add_postgres_user | 1.0a100 | | postgres_users | adds a PostgreSQL user to the system | <i>username</i> |
| add_spam_email_message | 1.0a100 | | spam_email_messages | adds a spam email message to the database | <i>email_relay</i> <i>message</i> |
| add_username | 1.0a100 | | usernames | adds a new username | <i>package</i> <i>username</i> |
| are_linux_account_passwords_set | 1.0a100 | | linux_accounts | determines if <b>all</b>, <b>some</b>, or <b>none</b> of the passwords for a Linux account are set | <i>username</i> |
| are_mysql_user_passwords_set | 1.0a100 | | mysql_users | determines if <b>all</b>, <b>some</b>, or <b>none</b> of the passwords for a MySQL account are set | <i>username</i> |
| are_postgres_user_passwords_set | 1.0a100 | | postgres_users | determines if <b>all</b>, <b>some</b>, or <b>none</b> of the passwords for a PostgreSQL account are set | <i>username</i> |
| are_username_passwords_set | 1.0a100 | | usernames | determines if <b>all</b>, <b>some</b>, or <b>none</b> of the passwords for a username are set | <i>username</i> |
| billing.Transaction.add | 1.83.0 | | transactions | adds a new transaction to an account | {<b>now</b>|<b>today</b>|<i>YYYY-MM-DD</i>|<i>YYYY-MM-DD HH:MM[:SS[.nnnnnnnnn]]</i>} <i>account</i> <i>sourceAccount</i> <i>administrator</i> <i>type</i> <i>description</i> <i>quantity</i> <i>currency</i> <i>rate</i> {""|<i>paymentType</i>} {""|<i>paymentInfo</i>} {""|<i>processor</i>} {<b>Pending</b>|<b>Confirmed</b>|<b>Failed</b>} |
| cancel_business | 1.0a100 | | businesses | cancels a business | <i>accounting_code</i> <i>cancel_reason</i> |
| check_accounting | 1.0a100 | | businesses | checks the format of an accounting code | <i>accounting_code</i> |
| check_business_administrator_password | 1.0a100 | | business_administrators | checks the format of a password for a business administrator | <i>username</i> <i>password</i> |
| check_dns_zone | 1.0a100 | | dns_zones | checks the format of a zone name | <i>zone</i> |
| check_email_address | 1.0a100 | | email_addresses | checks the format of an email address | <i>address</i> [<i>...</i>] |
| check_email_domain | 1.0a100 | | email_domains | checks the format of an email domain | <i>domain</i> |
| check_email_list_path | 1.80.2 | | email_lists | checks the format of an email list path | <i>ao_server</i> <i>path</i> |
| check_linux_account_name | 1.0a100 | | linux_accounts | checks the format of a Linux account full name | <i>full_name</i> |
| check_linux_account_password | 1.0a100 | | linux_accounts | checks the format of a password for a Linux account | <i>username</i> <i>password</i> |
| check_linux_group_name | 1.0a100 | | linux_groups | checks validity of a Linux group name | <i>groupname</i> |
| check_majordomo_list_name | 1.0a100 | | majordomo_lists | checks the format of a Majordomo list name | <i>list_name</i> |
| check_mysql_database_name | 1.0a100 | | mysql_databases | checks the format of a MySQL database name | <i>database_name</i> |
| check_mysql_password | 1.0a100 | | mysql_users | checks the format of a password for a MySQL user | <i>username</i> <i>password</i> |
| check_mysql_server_name | 1.4 | | mysql_servers | checks the format of a MySQL server name | <i>name</i> |
| check_mysql_username | 1.0a100 | | mysql_users | checks the format of a MySQL username | <i>username</i> |
| check_postgres_database_name | 1.0a100 | | postgres_databases | checks the format of a PostgreSQL database name | <i>database_name</i> |
| check_postgres_password | 1.0a100 | | postgres_users | checks the format of a password for a PostgreSQL user | <i>username</i> <i>password</i> |
| check_postgres_server_name | 1.0a100 | | postgres_servers | checks the format of a PostgreSQL server name | <i>name</i> |
| check_postgres_username | 1.0a100 | | postgres_users | checks the format of a PostgreSQL username | <i>username</i> |
| check_shared_tomcat_name | 1.0a100 | | httpd_shared_tomcats | checks the format of a Multi-Site Tomcat JVM name | <i>shared_tomcat_name</i> |
| check_site_name | 1.0a100 | | httpd_sites | checks the format of a site name | <i>site_name</i> |
| check_username | 1.0a100 | | usernames | checks the format of a username | <i>username</i> |
| check_username_password | 1.0a100 | | usernames | checks the format of a password for a Username | <i>username</i> <i>password</i> |
| clear | 1.0a100 | | | clears the screen | |
| compare_linux_server_account_password | 1.0a100 | | linux_server_accounts | compares the provided password to the password on the server | <i>username</i> <i>ao_server</i> <i>password</i> |
| copy_home_directory | 1.0a100 | | linux_server_accounts | copies the contents of a home directory from one server to another | <i>username</i> <i>from_ao_server</i> <i>to_ao_server</i> |
| copy_linux_server_account_password | 1.0a100 | | linux_server_accounts | copies the password of one Linux account to another account | <i>from_username</i> <i>from_ao_server</i> <i>to_username</i> <i>to_ao_server</i> |
| create_virtual_server | 1.64 | | virtual_servers | calls "xl create" on the current primary physical server | <i>virtual_server</i> |
| crypt | 1.0a100 | | business_administrators | encrypts a password as used in Apache password lists | <i>password</i> [<i>salt</i>] |
| decline_credit_card | 1.0a100 | | credit_cards | declines and disables a credit card | <i>pkey</i> <i>reason</i> |
| desc | 1.0a100 | | schema_tables | describes the structure of a table | <i>table_name</i> |
| describe | 1.0a100 | | schema_tables | describes the structure of a table | <i>table_name</i> |
| destroy_virtual_server | 1.64 | | virtual_servers | calls "xl destroy" on the current primary physical server | <i>virtual_server</i> |
| disable_business | 1.0a100 | | businesses | disables a business and everything in it, except its business administrators | <i>accounting</i> <i>reason</i> |
| disable_business_administrator | 1.0a100 | | business_administrators | disables a business administrator account | <i>username</i> <i>reason</i> |
| disable_cvs_repositories | 1.0a100 | | cvs_repositories | disables a CVS repository | <i>pkey</i> <i>reason</i> |
| disable_email_list | 1.0a100 | | email_lists | disables an email list | <i>path</i> <i>ao_server</i> <i>reason</i> |
| disable_email_pipe | 1.0a100 | | email_pipes | disables an email pipe | <i>pkey</i> <i>reason</i> |
| disable_email_smtp_relay | 1.0a100 | | email_smtp_relays | disables a SMTP access rule | <i>pkey</i> <i>reason</i> |
| disable_httpd_shared_tomcat | 1.0a100 | | httpd_shared_tomcats | disables a Multi-Site Tomcat JVM | <i>name</i> <i>ao_server</i> <i>reason</i> |
| disable_httpd_site | 1.0a100 | | httpd_sites | disables a web site, including its Java virtual machine and all network ports | <i>site_name</i> <i>ao_server</i> <i>reason</i> |
| disable_httpd_site_bind | 1.0a100 | | httpd_site_binds | disables one network port of a web site | <i>pkey</i> <i>reason</i> |
| disable_linux_account | 1.0a100 | | linux_accounts | disables a Linux account and removes its access to all servers | <i>username</i> <i>reason</i> |
| disable_linux_server_account | 1.0a100 | | linux_server_accounts | disables a Linux account on one server | <i>username</i> <i>ao_server</i> <i>reason</i> |
| disable_mysql_server_user | 1.4 | | mysql_server_users | disables a MySQL account on one server | <i>username</i> <i>mysql_server</i> <i>ao_server</i> <i>reason</i> |
| disable_mysql_user | 1.0a100 | | mysql_users | disables a MySQL account on all servers | <i>username</i> <i>reason</i> |
| disable_package | 1.0a100 | | packages | disables a package and everything in it, except its business administrators | <i>name</i> <i>reason</i> |
| disable_postgres_server_user | 1.0a100 | | postgres_server_users | disables a PostgreSQL account on one server | <i>username</i> <i>postgres_server</i> <i>ao_server</i> <i>reason</i> |
| disable_postgres_user | 1.0a100 | | postgres_users | disables a PostgreSQL account on all servers | <i>username</i> <i>reason</i> |
| disable_username | 1.0a100 | | usernames | disables a username and accounts using it, except its business administrator | <i>username</i> <i>reason</i> |
| dump_mysql_database | 1.80.0 | | mysql_databases | dumps the contents of a MySQL database | <i>database_name</i> <i>mysql_server</i> <i>ao_server</i> <i>gzip</i> |
| dump_postgres_database | 1.80.0 | | postgres_databases | dumps the contents of a PostgreSQL database | <i>database_name</i> <i>postgres_server</i> <i>ao_server</i> <i>gzip</i> |
| echo | 1.0a100 | | | echoes the parameters to standard output | [<i>params</i>] |
| enable_business | 1.0a100 | | businesses | enables a business and everything in it | <i>accounting</i> |
| enable_business_administrator | 1.0a100 | | business_administrators | enables a business administrator account | <i>username</i> |
| enable_cvs_repositories | 1.0a100 | | cvs_repositories | enables a CVS repository | <i>pkey</i> |
| enable_email_list | 1.0a100 | | email_lists | enables an email list | <i>path</i> <i>ao_server</i> |
| enable_email_pipe | 1.0a100 | | email_pipes | enables an email pipe | <i>pkey</i> |
| enable_email_smtp_relay | 1.0a100 | | email_smtp_relays | enables a SMTP access rule | <i>pkey</i> |
| enable_httpd_shared_tomcat | 1.0a100 | | httpd_shared_tomcats | enables a Multi-Site Tomcat JVM | <i>name</i> <i>ao_server</i> |
| enable_httpd_site | 1.0a100 | | httpd_sites | enables a web site, including its Java virtual machine and all network ports | <i>site_name</i> <i>ao_server</i> |
| enable_httpd_site_bind | 1.0a100 | | httpd_site_binds | enables one network port of a web site | <i>pkey</i> |
| enable_linux_account | 1.0a100 | | linux_accounts | enables a Linux account and restores its access to all servers | <i>username</i> |
| enable_linux_server_account | 1.0a100 | | linux_server_accounts | enables a Linux account on one server | <i>username</i> <i>ao_server</i> |
| enable_mysql_server_user | 1.4 | | mysql_server_users | enables a MySQL account on one server | <i>username</i> <i>mysql_server</i> <i>ao_server</i> |
| enable_mysql_user | 1.0a100 | | mysql_users | enables a MySQL account on all servers | <i>username</i> |
| enable_package | 1.0a100 | | packages | enables a package and everything in it | <i>name</i> |
| enable_postgres_server_user | 1.0a100 | | postgres_server_users | enables a PostgreSQL account on one server | <i>username</i> <i>postgres_server</i> <i>ao_server</i> |
| enable_postgres_user | 1.0a100 | | postgres_users | enables a PostgreSQL account on all servers | <i>username</i> |
| enable_username | 1.0a100 | | usernames | enables a username and accounts using it | <i>username</i> |
| exit | 1.0a100 | | | exits the shell | |
| generate_accounting | 1.0a100 | | businesses | generates a unique accounting code based on a template | <i>template</i> |
| generate_mysql_database_name | 1.0a100 | | mysql_databases | generates a unique MySQL database name | <i>template_base</i> <i>template_added</i> |
| generate_package_name | 1.0a100 | | packages | generates a unique package name based on a template | <i>template</i> |
| generate_password | 1.0a100 | | linux_accounts | generates a random, valid password | |
| generate_postgres_database_name | 1.0a100 | | postgres_databases | generates a unique PostgreSQL database name | <i>template_base</i> <i>template_added</i> |
| generate_shared_tomcat_name | 1.0a100 | | httpd_shared_tomcats | generates a unique Multi-Site Tomcat JVM name based on a template | <i>template</i> |
| generate_site_name | 1.0a100 | | httpd_sites | generates a unique site name based on a template | <i>template</i> |
| get_autoresponder_content | 1.0a100 | | linux_server_accounts | gets the message body of an autoresponder | <i>username</i> <i>ao_server</i> |
| get_awstats_file | 1.0a128 | | httpd_sites | gets a file from the AWStats report | <i>site_name</i> <i>ao_server</i> <i>path</i> {""|<i>query_string</i>} |
| get_backup_partition_total_size | 1.0a100 | | backup_partitions | gets the total size of a backup partition | <i>ao_server</i> <i>path</i> |
| get_backup_partition_used_size | 1.0a100 | | backup_partitions | gets the disk space used on a backup partition | <i>ao_server</i> <i>path</i> |
| get_cron_table | 1.0a100 | | linux_server_accounts | gets the contents of a user cron table | <i>username</i> <i>ao_server</i> |
| get_email_list | 1.0a100 | | email_lists | gets the list of addresses for a list | <i>path</i> <i>ao_server</i> |
| get_failover_file_replication_activity | 1.76 | | failover_file_replications | gets the most recently reported replication activity | <i>from_server</i> <i>to_server</i> <i>path</i> |
| get_httpd_server_concurrency | 1.81.11 | | httpd_servers | gets the current concurrency of an HTTP server instance | <i>ao_server</i> {""|<i>name</i>} |
| get_imap_folder_sizes | 1.0a120 | | linux_server_accounts | gets the file sizes for IMAP folders | <i>username</i> <i>ao_server</i> <i>folder_name</i> [...] |
| get_inbox_attributes | 1.0a100 | | linux_server_accounts | gets the attributes of an email inbox | <i>username</i> <i>ao_server</i> |
| get_majordomo_info_file | 1.0a100 | | majordomo_lists | gets the info file for a Majordomo list | <i>domain</i> <i>ao_server</i> <i>list_name</i> |
| get_majordomo_intro_file | 1.0a100 | | majordomo_lists | gets the intro file for a Majordomo list | <i>domain</i> <i>ao_server</i> <i>list_name</i> |
| get_mrtg_file | 1.0a100 | | ao_servers | gets a file from the MRTG report directory | <i>ao_server</i> <i>filename</i> |
| get_primary_physical_server | 1.73 | | virtual_servers | gets the physical server that is currently the primary node for this virtual server | <i>virtual_server</i> |
| get_root_business | 1.0a100 | | businesses | gets the name of the root business in the business tree | |
| get_secondary_physical_server | 1.73 | | virtual_servers | gets the physical server that is currently the secondary node for this virtual server | <i>virtual_server</i> |
| get_ups_status | 1.63 | | ao_servers | gets the status of the UPS powering this server | <i>ao_server</i> |
| get_virtual_server_status | 1.64 | | virtual_servers | calls "xl list" to get the current state on the current primary physical server | <i>virtual_server</i> |
| help | 1.0a100 | | aosh_commands | displays the help screen | [<b>syntax</b>|<i>command</i>] |
| invalidate | 1.31 | | | globally invalidates a table | <i>table_name</i> [<i>ao_servers.hostname</i> or <i>servers.package.name</i>/<i>servers.name</i> or <i>servers.pkey</i>] |
| is_accounting_available | 1.0a100 | | businesses | checks the availability of an accounting code | <i>accounting_code</i> |
| is_business_administrator_password_set | 1.0a100 | | business_administrators | determines if a business administrator password is set | <i>username</i> |
| is_dns_zone_available | 1.0a100 | | dns_zones | checks the availability of a DNS zone | <i>zone</i> |
| is_email_domain_available | 1.0a100 | | email_domains | checks the availability of an email domain | <i>domain</i> <i>ao_server</i> |
| is_ip_address_used | 1.33 | | ip_addresses | determines if an IP address is currently in use | <i>ip_address</i> <i>server</i> <i>net_device</i> |
| is_linux_group_name_available | 1.0a100 | | linux_groups | check availability Linux group name | <i>groupname</i> |
| is_linux_server_account_password_set | 1.0a100 | | linux_server_accounts | determines if a Linux account password is set | <i>username</i> <i>ao_server</i> |
| is_linux_server_account_procmail_manual | 1.0a116 | | linux_server_accounts | determines if a Linux account is in manual procmail mode | <i>username</i> <i>ao_server</i> |
| is_mysql_database_name_available | 1.4 | | mysql_databases | determines if a MySQL database name is available | <i>database_name</i> <i>mysql_server</i> <i>ao_server</i> |
| is_mysql_server_name_available | 1.4 | | mysql_servers | determines if a MySQL server name is available | <i>server_name</i> <i>ao_server</i> |
| is_mysql_server_user_password_set | 1.4 | | mysql_server_users | determines if a MySQL account password is set | <i>username</i> <i>mysql_server</i> <i>ao_server</i> |
| is_package_name_available | 1.0a100 | | packages | checks the availability of a package name | <i>package</i> |
| is_postgres_database_name_available | 1.0a100 | | postgres_databases | determines if a PostgreSQL database name is available | <i>database_name</i> <i>postgres_server</i> <i>ao_server</i> |
| is_postgres_server_name_available | 1.0a100 | | postgres_servers | determines if a PostgreSQL server name is available | <i>server_name</i> <i>ao_server</i> |
| is_postgres_server_user_password_set | 1.0a100 | | postgres_server_users | determines if a PostgreSQL account password is set | <i>username</i> <i>postgres_server</i> <i>ao_server</i> |
| is_shared_tomcat_name_available | 1.0a100 | | httpd_shared_tomcats | determines if a name may be used for a Multi-Site Tomcat JVM | <i>name</i> |
| is_site_name_available | 1.0a100 | | httpd_sites | determines if a site name is available | <i>site_name</i> |
| is_username_available | 1.0a100 | | usernames | checks the availability of a username | <i>username</i> |
| jobs | 1.0a100 | | | lists all of the background processes | |
| move_business | 1.0a100 | | businesses | moves all of the resources for one business from one server to another server | <i>business</i> <i>from_ao_server</i> <i>to_ao_server</i> |
| move_ip_address | 1.0a100 | | ip_addresses | moves an IP address to a new server | <i>ip_address</i> <i>from_server</i> <i>from_net_device</i> <i>to_server</i> |
| pause_virtual_server | 1.64 | | virtual_servers | calls "xl pause" on the current primary physical server | <i>virtual_server</i> |
| ping | 1.0a100 | | | times the communication with the server | |
| pki.Certificate.check | 1.83.0 | | ssl_certificates | checks an SSL certificate status | <i>server</i> <i>keyFile_or_certbotName</i> <i>allowCached</i> |
| print_zone_file | 1.0a100 | | dns_zones | generates a zone file | <i>zone</i> |
| reboot_virtual_server | 1.64 | | virtual_servers | calls "xl reboot" on the current primary physical server | <i>virtual_server</i> |
| refresh_email_smtp_relay | 1.0a100 | | email_smtp_relays | refreshes a SMTP access rule | <i>pkey</i> {""|<i>min_duration</i>} |
| remove_blackhole_email_address | 1.0a100 | | blackhole_email_addresses | stops emails from being discarded to /dev/null | <i>address</i> <i>ao_server</i> |
| remove_business_administrator | 1.0a100 | | business_administrators | removes the administrative access for a user | <i>username</i> |
| remove_business_server | 1.0a100 | | business_servers | removes a business' access to a server | <i>business</i> <i>server</i> |
| remove_credit_card | 1.0a100 | | credit_cards | removes a credit card from a business | <i>pkey</i> |
| remove_cvs_repository | 1.0a100 | | cvs_repositories | removes a CVS repository from a server | <i>ao_server</i> <i>path</i> |
| remove_dns_record | 1.86.0 | | dns_records | removes a record from a name server zone | <i>pkey</i>
<i>zone</i> {<b>@</b>|<i>hostname</i>} <i>type</i> {""|<i>tag</i>} <i>value</i> |
| remove_dns_zone | 1.0a100 | | dns_zones | removes a zone from the name servers | <i>zone</i> |
| remove_email_address | 1.0a100 | | email_addresses | removes an email address and all associated resources | <i>address</i> <i>ao_server> [<i>...</i>] |
| remove_email_domain | 1.0a100 | | email_domains | removes an email domain and all associated email addresses | <i>domain</i> <i>ao_server</i> |
| remove_email_forwarding | 1.0a100 | | email_forwarding | detaches a forwarding address from an email address | <i>from_address</i> <i>ao_server</i> <i>to_address</i> |
| remove_email_list | 1.0a100 | | email_lists | removes an email list | <i>path</i> <i>ao_server</i> |
| remove_email_list_address | 1.0a100 | | email_list_addresses | detaches an email address from an email list | <i>address</i> <i>path</i> <i>ao_server</i> |
| remove_email_pipe | 1.0a100 | | email_pipes | removes an email pipe | <i>pipe_pkey</i> |
| remove_email_pipe_address | 1.0a100 | | email_pipe_addresses | detaches an email address from an email pipe | <i>address</i> <i>pipe_pkey</i> |
| remove_email_smtp_relay | 1.0a100 | | email_smtp_relays | removes a SMTP access rule | <i>pkey</i> |
| remove_file_backup_setting | 1.31 | | file_backup_settings | removes a FileBackupSetting | <i>replication</i> <i>path</i> |
| remove_ftp_guest_user | 1.0a100 | | ftp_guest_users | removes a FTP guest user | <i>username</i> |
| remove_httpd_shared_tomcat | 1.0a100 | | httpd_shared_tomcats | removes a multi-site Tomcat JVM from the servers | <i>name</i> <i>ao_server</i> |
| remove_httpd_site | 1.0a100 | | httpd_sites | removes a web site from the servers | <i>site_name</i> <i>ao_server</i> |
| remove_httpd_site_url | 1.0a100 | | httpd_site_urls | removes a hostname from a web site | <i>pkey</i> |
| remove_httpd_tomcat_context | 1.0a100 | | httpd_tomcat_contexts | removes a context (webapp) from a Tomcat site | <i>pkey</i> |
| remove_httpd_tomcat_data_source | 1.5 | | httpd_tomcat_data_sources | removes a data source from a Tomcat context (webapp) | <i>pkey</i> |
| remove_httpd_tomcat_parameter | 1.5 | | httpd_tomcat_parameters | removes a parameter from a Tomcat context (webapp) | <i>pkey</i> |
| remove_httpd_tomcat_site_jk_mount | 1.81.6 | | httpd_tomcat_site_jk_mounts | removes a JkMount or JkUnMount from a Tomcat site | <i>site_name</i> <i>ao_server</i> <i>path</i> |
| remove_linux_acc_address | 1.0a100 | | linux_acc_addresses | detaches an email address from a Linux account | <i>address</i> <i>ao_server</i> <i>username</i> |
| remove_linux_account | 1.0a100 | | linux_accounts | removes a Linux account from all servers | <i>username</i> |
| remove_linux_group | 1.0a100 | | linux_groups | removes a Linux group | <i>group</i> |
| remove_linux_group_account | 1.0a100 | | linux_group_accounts | revokes access of a Linux account to a Linux group | <i>group</i> <i>username</i> |
| remove_linux_server_account | 1.0a100 | | linux_server_accounts | removes a Linux account from a server | <i>username</i> <i>ao_server</i> |
| remove_linux_server_group | 1.0a100 | | linux_server_groups | removes a Linux group from a server | <i>group</i> <i>ao_server</i> |
| remove_majordomo_server | 1.0a100 | | majordomo_servers | remvoes a Majordomo server | <i>domain</i> <i>ao_server</i> |
| remove_mysql_database | 1.4 | | mysql_databases | removes a MySQL database | <i>database_name</i> <i>mysql_server</i> <i>ao_server</i> |
| remove_mysql_db_user | 1.4 | | mysql_db_users | removes a MySQL user's access to a MySQL database | <i>database_name</i> <i>mysql_server</i> <i>ao_server</i> <i>username</i> |
| remove_mysql_server_user | 1.4 | | mysql_server_users | removes a MySQL user from a server | <i>username</i> <i>mysql_server</i> <i>ao_server</i> |
| remove_mysql_user | 1.0a100 | | mysql_users | removes a MySQL user from the system | <i>username</i> |
| remove_net_bind | 1.0a104 | | net_binds | removes a net binds from the system | <i>pkey</i> |
| remove_postgres_database | 1.0a100 | | postgres_databases | removes a PostgreSQL database | <i>database_name</i> <i>postgres_server</i> <i>ao_server</i> |
| remove_postgres_server_user | 1.0a100 | | postgres_server_users | removes a PostgreSQL user from a server | <i>username</i> <i>postgres_server</i> <i>ao_server</i> |
| remove_postgres_user | 1.0a100 | | postgres_users | removes a PostgreSQL user from the system | <i>username</i> |
| remove_username | 1.0a100 | | usernames | removes a username from the system | <i>username</i> |
| repeat | 1.0a100 | | | repeatedly executes a command | <i>count</i> <i>command</i> [<i>params</i>] |
| restart_apache | 1.0a100 | | ao_servers | restarts the Apache web server | <i>ao_server</i> |
| restart_cron | 1.0a100 | | ao_servers | restarts the cron daemon | <i>ao_server</i> |
| restart_mysql | 1.4 | | mysql_servers | restarts the MySQL database server | <i>mysql_server</i> <i>ao_server</i> |
| restart_postgresql | 1.0a100 | | postgres_servers | restarts the PostgreSQL database server | <i>postgres_server</i> <i>ao_server</i> |
| restart_xfs | 1.0a100 | | ao_servers | restarts the X Font Server | <i>ao_server</i> |
| restart_xvfb | 1.0a100 | | ao_servers | restarts the X Virtual Frame Buffer | <i>ao_server</i> |
| select | 1.0a100 | | schema_tables | selects rows and columns from a table | {<b>*</b>|<i>column[::type][.join][, column[::type][.join]]</i>|<b>count(*)</b>} <b>from</b> <i>table_name</i> [order by <i>column[::type][.join][, column[::type][.join]]]</i> |
| set_autoresponder | 1.0a100 | | linux_server_accounts | configures an autoresponder | <i>username</i> <i>ao_server</i> <i>from_address</i> <i>from_domain</i> <i>subject</i> <i>content</i> <i>enabled</i> |
| set_business_accounting | 1.0a100 | | businesses | changes the accounting code that uniquely identifies a business | <i>old_accounting</i> <i>new_accounting</i> |
| set_business_administrator_password | 1.0a100 | | business_administrators | sets the password used for administrative access | <i>username</i> <i>password</i> |
| set_business_administrator_profile | 1.0a100 | | business_administrators | sets the profile associated with a business administrator | <i>username</i> <i>full_name</i> {""|<i>title</i>} {""|<i>birthday</i>} <i>is_private</i> <i>work_phone</i> {""|<i>home_phone</i>} {""|<i>cell_phone</i>} {""|<i>fax</i>} <i>email_address</i> {""|<i>address1</i>} {""|<i>address2</i>} {""|<i>city</i>} {""|<i>state</i>} {""|<i>country</i>} {""|<i>zip</i>} |
| set_cron_table | 1.0a100 | | linux_server_accounts | sets the contents of a user cron table | <i>username</i> <i>ao_server</i> <i>cron_table</i> |
| set_cvs_repository_mode | 1.0a100 | | cvs_repositories | sets the directory permissions of a CVS repository | <i>ao_server</i> <i>path</i> <i>mode</i> |
| set_default_business_server | 1.0a100 | | business_servers | sets the default server for a business | <i>business</i> <i>server</i> |
| set_dns_zone_ttl | 1.0a127 | | dns_zones | sets the default TTL value for a name server zone | <i>zone</i> <i>ttl</i> |
| set_email_list | 1.0a100 | | email_lists | sets the list of addresses for a list | <i>path</i> <i>ao_server</i> <i>list_contents</i> |
| set_file_backup_setting | 1.62 | | file_backup_settings | sets the values in a FileBackupSetting | <i>replication</i> <i>path</i> <i>backup_enabled</i> <i>required</i> |
| set_httpd_shared_tomcat_auto_deploy | 1.80.1 | | httpd_shared_tomcats | sets the autoDeploy setting for a Multi-Site Tomcat installation | <i>name</i> <i>ao_server</i> <i>auto_deploy</i> |
| set_httpd_shared_tomcat_is_manual | 1.0a100 | | httpd_shared_tomcats | sets the is_manual flag for a Multi-Site Tomcat JVM | <i>name</i> <i>ao_server</i> <i>is_manual</i> |
| set_httpd_shared_tomcat_max_post_size | 1.80.1 | | httpd_shared_tomcats | sets the maxPostSize setting for a Multi-Site Tomcat installation | <i>name</i> <i>ao_server</i> {""|<i>max_post_size</i>} |
| set_httpd_shared_tomcat_unpack_wars | 1.80.1 | | httpd_shared_tomcats | sets the unpackWARs setting for a Multi-Site Tomcat installation | <i>name</i> <i>ao_server</i> <i>unpack_wars</i> |
| set_httpd_shared_tomcat_version | 1.81.12 | | httpd_shared_tomcats | sets the Tomcat version for a Multi-Site Tomcat installation | <i>name</i> <i>ao_server</i> <i>series</i>[.<i>major</i>[.<i>minor</i>]] |
| set_httpd_site_authenticated_location_attributes | 1.81.13 | | httpd_site_authenticated_locations | updates an authenticated location on a web site | <i>site_name</i> <i>ao_server</i> <i>path</i> <i>is_regular_expression</i> <i>auth_name</i> {""|<i>auth_group_file</i>} {""|<i>auth_user_file</i>} <i>require</i> {""|*|<i>handler</i>} |
| set_httpd_site_bind_is_manual | 1.0a100 | | httpd_site_binds | sets the is_manual flag for one network port of a web site | <i>pkey</i> <i>is_manual</i> |
| set_httpd_site_bind_redirect_to_primary_hostname | 1.19 | | httpd_site_binds | sets the redirect_to_primary_hostname flag for one network port of a web site | <i>pkey</i> <i>redirect_to_primary_hostname</i> |
| set_httpd_site_block_core_dumps | 1.81.6 | | httpd_sites | sets the block_core_dumps flag for a web site | <i>site_name</i> <i>ao_server</i> <i>block_core_dumps</i> |
| set_httpd_site_block_editor_backups | 1.81.6 | | httpd_sites | sets the block_editor_backups flag for a web site | <i>site_name</i> <i>ao_server</i> <i>block_editor_backups</i> |
| set_httpd_site_block_scm | 1.81.6 | | httpd_sites | sets the block_scm flag for a web site | <i>site_name</i> <i>ao_server</i> <i>block_scm</i> |
| set_httpd_site_block_trace_track | 1.81.6 | | httpd_sites | sets the block_trace_track flag for a web site | <i>site_name</i> <i>ao_server</i> <i>block_trace_track</i> |
| set_httpd_site_enable_anonymous_ftp | 1.80.1 | | httpd_sites | sets the enable_anonymous_ftp flag for a web site | <i>site_name</i> <i>ao_server</i> <i>enable_anonymous_ftp</i> |
| set_httpd_site_enable_cgi | 1.80.1 | | httpd_sites | sets the enable_cgi flag for a web site | <i>site_name</i> <i>ao_server</i> <i>enable_cgi</i> |
| set_httpd_site_enable_follow_symlinks | 1.80.1 | | httpd_sites | sets the enable_follow_symlinks flag for a web site | <i>site_name</i> <i>ao_server</i> <i>enable_follow_symlinks</i> |
| set_httpd_site_enable_htaccess | 1.80.1 | | httpd_sites | sets the enable_htaccess flag for a web site | <i>site_name</i> <i>ao_server</i> <i>enable_htaccess</i> |
| set_httpd_site_enable_indexes | 1.80.1 | | httpd_sites | sets the enable_indexes flag for a web site | <i>site_name</i> <i>ao_server</i> <i>enable_indexes</i> |
| set_httpd_site_enable_ssi | 1.80.1 | | httpd_sites | sets the enable_ssi flag for a web site | <i>site_name</i> <i>ao_server</i> <i>enable_ssi</i> |
| set_httpd_site_is_manual | 1.0a100 | | httpd_sites | sets the is_manual flag for a web site | <i>site_name</i> <i>ao_server</i> <i>is_manual</i> |
| set_httpd_site_php_version | 1.80.1 | | httpd_sites | sets the PHP version for a web site | <i>site_name</i> <i>ao_server</i> {""|<i>php_version</i>} |
| set_httpd_site_server_admin | 1.0a100 | | httpd_sites | sets the administrative email address for a web site | <i>site_name</i> <i>ao_server</i> <i>email_address</i> |
| set_httpd_tomcat_context_attributes | 1.81.3 | | httpd_tomcat_contexts | sets the attributes for a context (webapp) on a Tomcat site | <i>site_name</i> <i>ao_server</i> <i>old_path</i> {""|<i>class_name</i>} <i>use_cookies</i> <i>cross_context</i> <i>doc_base</i> <i>allow_override</i> <i>new_path</i> <i>is_privileged</i> <i>is_reloadable</i> <i>use_naming</i> {""|<i>wrapper_class</i>} <i>debug_level</i> {""|<i>work_dir</i>} <i>server_xml_configured</i> |
| set_httpd_tomcat_site_block_webinf | 1.81.6 | | httpd_tomcat_sites | sets the block_webinf flag for a Tomcat-enabled web site | <i>site_name</i> <i>ao_server</i> <i>block_webinf</i> |
| set_httpd_tomcat_site_use_apache | 1.80.1 | | httpd_tomcat_sites | sets the use_apache flag for a Tomcat-enabled web site | <i>site_name</i> <i>ao_server</i> <i>use_apache</i> |
| set_httpd_tomcat_std_site_auto_deploy | 1.80.1 | | httpd_tomcat_std_sites | sets the autoDeploy setting for a standard Tomcat installation | <i>site_name</i> <i>ao_server</i> <i>auto_deploy</i> |
| set_httpd_tomcat_std_site_max_post_size | 1.80.1 | | httpd_tomcat_std_sites | sets the maxPostSize setting for a standard Tomcat installation | <i>site_name</i> <i>ao_server</i> {""|<i>max_post_size</i>} |
| set_httpd_tomcat_std_site_unpack_wars | 1.80.1 | | httpd_tomcat_std_sites | sets the unpackWARs setting for a standard Tomcat installation | <i>site_name</i> <i>ao_server</i> <i>unpack_wars</i> |
| set_httpd_tomcat_std_site_version | 1.81.12 | | httpd_tomcat_std_sites | sets the Tomcat version for a standard Tomcat installation | <i>site_name</i> <i>ao_server</i> <i>series</i>[.<i>major</i>[.<i>minor</i>]] |
| set_ip_address_dhcp_address | 1.0a100 | | ip_addresses | sets the new IP address for a DHCP-enabled device | <i>pkey</i> <i>ip_address</i> |
| set_ip_address_hostname | 1.33 | | ip_addresses | sets the hostname associated with an IP address | <i>ip_address</i> <i>server</i> <i>net_device</i> <i>hostname</i> |
| set_ip_address_monitoring_enabled | 1.81.18 | | IpAddressMonitoring | enables or disables the monitoring of an IP address | <i>ip_address</i> <i>server</i> <i>net_device</i> <i>enabled</i> |
| set_ip_address_package | 1.33 | | ip_addresses | sets the package ownership of an IP address | <i>ip_address</i> <i>server</i> <i>net_device</i> <i>package</i> |
| set_linux_account_home_phone | 1.0a100 | | linux_accounts | sets the home phone number for a Linux account | <i>username</i> {""|<i>phone_number</i>} |
| set_linux_account_name | 1.80.1 | | linux_accounts | sets the full name for a Linux account | <i>username</i> {""|<i>full_name</i>} |
| set_linux_account_office_location | 1.0a100 | | linux_accounts | sets the office location for a Linux account | <i>username</i> {""|<i>location</i>} |
| set_linux_account_office_phone | 1.0a100 | | linux_accounts | sets the office phone number for a Linux account | <i>username</i> {""|<i>phone_number</i>} |
| set_linux_account_password | 1.0a100 | | linux_accounts | sets the password for a Linux account on all servers | <i>username</i> <i>password</i> |
| set_linux_account_shell | 1.0a100 | | linux_accounts | sets the shell used by a Linux account | <i>username</i> <i>shell</i> |
| set_linux_server_account_junk_email_retention | 1.0a120 | | linux_server_accounts | sets the number of days emails will remain in the Junk folder | <i>username</i> <i>ao_server</i> {""|<i>days</i>} |
| set_linux_server_account_password | 1.0a100 | | linux_server_accounts | sets the password for a Linux account on one server | <i>username</i> <i>ao_server</i> <i>password</i> |
| set_linux_server_account_spamassassin_integration_mode | 1.0a120 | | linux_server_accounts | sets the behavior of the SpamAssassin filters | <i>username</i> <i>ao_server</i> <i>mode</i> |
| set_linux_server_account_spamassassin_required_score | 1.0a124 | | linux_server_accounts | sets the required score for the SpamAssassin filters | <i>username</i> <i>ao_server</i> <i>required_score</i> |
| set_linux_server_account_trash_email_retention | 1.0a100 | | linux_server_accounts | sets the number of days emails will remain in the Trash folder | <i>username</i> <i>ao_server</i> {""|<i>days</i>} |
| set_linux_server_account_use_inbox | 1.0a100 | | linux_server_accounts | sets whether or not email will be stored in the inbox | <i>username</i> <i>ao_server</i> <i>use_inbox</i> |
| set_majordomo_info_file | 1.0a100 | | majordomo_lists | sets the info file for a Majordomo list | <i>domain</i> <i>ao_server</i> <i>list_name</i> <i>file</i> |
| set_majordomo_intro_file | 1.0a100 | | majordomo_lists | sets the intro file for a Majordomo list | <i>domain</i> <i>ao_server</i> <i>list_name</i> <i>file</i> |
| set_mysql_server_user_password | 1.4 | | mysql_server_users | sets the password for a MySQL user on one server | <i>username</i> <i>mysql_server</i> <i>ao_server</i> <i>password</i> |
| set_mysql_user_password | 1.0a100 | | mysql_users | sets the password for a MySQL user on all servers | <i>username</i> <i>password</i> |
| set_net_bind_firewalld_zones | 1.81.0 | | net_binds | sets the enabled firewalld zones for this port | <i>pkey</i> [<i>firewalld_zone</i>] [...] |
| set_net_bind_monitoring_enabled | 1.0a105 | | net_binds | enables or disables the monitoring of this port | <i>pkey</i> <i>enabled</i> |
| set_postgres_server_user_password | 1.0a100 | | postgres_server_users | sets the password for a PostgreSQL user on one server | <i>username</i> <i>postgres_server</i> <i>ao_server</i> <i>password</i> |
| set_postgres_user_password | 1.0a100 | | postgres_users | sets the password for a PostgreSQL user on all servers | <i>username</i> <i>password</i> |
| set_primary_httpd_site_url | 1.0a100 | | httpd_site_urls | sets the primary hostname for one specific IP address and port | <i>pkey</i> |
| set_primary_linux_group_account | 1.0a100 | | linux_group_accounts | sets the primary Linux group associated with a Linux account | <i>group</i> <i>username</i> |
| set_username_password | 1.0a100 | | usernames | sets the password for a Username on all services | <i>username</i> <i>password</i> |
| show | 1.0a100 | | schema_tables | shows information about tables | <b>tables</b> |
| shutdown_virtual_server | 1.64 | | virtual_servers | calls "xl shutdown" on the current primary physical server | <i>virtual_server</i> |
| start_apache | 1.0a100 | | ao_servers | starts the Apache web server | <i>ao_server</i> |
| start_cron | 1.0a100 | | ao_servers | starts the cron daemon | <i>ao_server</i> |
| start_distro | 1.0a100 | | distro_files | starts the distribution verification on a server | <i>ao_server</i> <i>include_user</i> |
| start_jvm | 1.0a100 | | httpd_tomcat_sites | starts the Java VM | <i>site_name</i> <i>ao_server</i> |
| start_mysql | 1.4 | | mysql_servers | starts the MySQL database server | <i>mysql_server</i> <i>ao_server</i> |
| start_postgresql | 1.0a100 | | postgres_servers | starts the PostgreSQL database server | <i>postgres_server</i> <i>ao_server</i> |
| start_xfs | 1.0a100 | | ao_servers | starts the X Font Server | <i>ao_server</i> |
| start_xvfb | 1.0a100 | | ao_servers | starts the X Virtual Frame Buffer | <i>ao_server</i> |
| stop_apache | 1.0a100 | | ao_servers | stops the Apache web server | <i>ao_server</i> |
| stop_cron | 1.0a100 | | ao_servers | stops the cron daemon | <i>ao_server</i> |
| stop_jvm | 1.0a100 | | httpd_tomcat_sites | stops the Java VM | <i>site_name</i> <i>ao_server</i> |
| stop_mysql | 1.4 | | mysql_servers | stops the MySQL database server | <i>mysql_server</i> <i>ao_server</i> |
| stop_postgresql | 1.0a100 | | postgres_servers | stops the PostgreSQL database server | <i>postgres_server</i> <i>ao_server</i> |
| stop_xfs | 1.0a100 | | ao_servers | stops the X Font Server | <i>ao_server</i> |
| stop_xvfb | 1.0a100 | | ao_servers | stops the X Virtual Frame Buffer | <i>ao_server</i> |
| su | 1.0a100 | | | switches to a different user | <i>username</i> [<i>command</i> [<i>params</i>]] |
| time | 1.0a100 | | | times a command | <i>command</i> [<i>params</i>] |
| unpause_virtual_server | 1.64 | | virtual_servers | calls "xl unpause" on the current primary physical server | <i>virtual_server</i> |
| update_httpd_tomcat_data_source | 1.5 | | httpd_tomcat_data_sources | updates a Tomcat context (webapp) data source | <i>site_name</i> <i>ao_server</i> <i>path</i> <i>old_name</i> <i>new_name</i> <i>driver_class_name</i> <i>url</i> <i>username</i> <i>password</i> <i>max_active</i> <i>max_idle</i> <i>max_wait</i> {""|<i>validation_query</i>} |
| update_httpd_tomcat_parameter | 1.5 | | httpd_tomcat_parameters | updates a Tomcat context (webapp) parameter | <i>site_name</i> <i>ao_server</i> <i>path</i> <i>old_name</i> <i>new_name</i> <i>value</i> <i>override</i> {""|<i>description</i>} |
| verify_virtual_disk | 1.71 | | virtual_disks | begins a verification of the redundancy of the virtual disk | <i>virtual_server</i> <i>device</i> |
| wait_for_httpd_site_rebuild | 1.0a100 | | httpd_sites | waits for any pending or processing changes to complete | <i>ao_server</i> |
| wait_for_linux_account_rebuild | 1.0a100 | | linux_accounts | waits for any pending or current server config rebuild to complete | <i>ao_server</i> |
| wait_for_mysql_database_rebuild | 1.0a100 | | mysql_databases | waits for any pending or current MySQL database config rebuilds to complete | <i>ao_server</i> |
| wait_for_mysql_db_user_rebuild | 1.0a100 | | mysql_db_users | waits for any pending or current MySQL permission config rebuilds to complete | <i>ao_server</i> |
| wait_for_mysql_server_rebuild | 1.4 | | mysql_servers | waits for any pending or current database server config rebuilds to complete | <i>ao_server</i> |
| wait_for_mysql_user_rebuild | 1.0a100 | | mysql_users | waits for any pending or current MySQL user config rebuilds to complete | <i>ao_server</i> |
| wait_for_postgres_database_rebuild | 1.0a100 | | postgres_databases | waits for any pending or current database config rebuilds to complete | <i>ao_server</i> |
| wait_for_postgres_server_rebuild | 1.0a100 | | postgres_servers | waits for any pending or current database server config rebuilds to complete | <i>ao_server</i> |
| wait_for_postgres_user_rebuild | 1.0a100 | | postgres_users | waits for any pending or current database user config rebuilds to complete | <i>ao_server</i> |
| web.tomcat.PrivateTomcatSite.maxParameterCount.set | 1.92.0 | | httpd_tomcat_std_sites | sets the maxParameterCount setting for a standard Tomcat installation | <i>site_name</i> <i>ao_server</i> {""|<i>maxParameterCount</i>} |
| web.tomcat.PrivateTomcatSite.tomcatAuthentication.set | 1.83.2 | | httpd_tomcat_std_sites | sets the tomcatAuthentication setting for a standard Tomcat installation | <i>site_name</i> <i>ao_server</i> <i>tomcatAuthentication</i> |
| web.tomcat.PrivateTomcatSite.undeployOldVersions.set | 1.92.0 | | httpd_tomcat_std_sites | sets the undeployOldVersions setting for a standard Tomcat installation | <i>site_name</i> <i>ao_server</i> <i>undeployOldVersions</i> |
| web.tomcat.SharedTomcat.maxParameterCount.set | 1.92.0 | | httpd_shared_tomcats | sets the maxParameterCount setting for a Multi-Site Tomcat installation | <i>name</i> <i>ao_server</i> {""|<i>maxParameterCount</i>} |
| web.tomcat.SharedTomcat.tomcatAuthentication.set | 1.83.2 | | httpd_shared_tomcats | sets the tomcatAuthentication setting for a Multi-Site Tomcat installation | <i>name</i> <i>ao_server</i> <i>tomcatAuthentication</i> |
| web.tomcat.SharedTomcat.undeployOldVersions.set | 1.92.0 | | httpd_shared_tomcats | sets the undeployOldVersions setting for a Multi-Site Tomcat installation | <i>name</i> <i>ao_server</i> <i>undeployOldVersions</i> |
| whoami | 1.0a100 | | | displays who is logged in | |
