Domain Administrator Accounts: domadmin Utility

The domadmin utility is used to manage domain administrator accounts through CLI. The utility allows the following operations:

editing domain administrator's personal information
viewing the information about a domain
changing the domain management preferences (control panel access and interface features) and permissions

Usage

domadmin <command> <domain_name> [

<option_1> [<param>]

[<option_2> [<param>]]

… [<option_N> [<param>]]

Example

The following command sets the personal name for the administrator of the domain example.com to John Doe, allows the use of the standard view only for the administrator, sets the administrator's password to mypass, sets the interface language to Russian, and allows the domain content management by the domain administrator.

# ./domadmin --update example.com -pname "John Doe" -dashboard false -stdgui true -passwd mypass -locale ru-RU -manage_phosting true

Commands

Command	Parameter	Description	Example
`--update` or `-u`	`<domain_name>`	Updates configuration of an existing domain administrator's account with data specified in the options.	To set a password for the domain administrator's account on the domain example.com to sample: # ./domadmin --update example.com -passwd sample or # ./domadmin -u example.com -passwd sample
`--info` or `-i`	`<domain_name>`	Displays information about a domain administrator's account.	To view the information about the example.com administrator's account: # ./domadmin --info example.com or # ./domadmin -i example.com
`--help` or `-h`		Displays help on the use of the utility.	To view help on the use of this utility: # ./domadmin --help or # ./domadmin -h

Command

Parameter

Description

Example

--update or -u

<domain_name>

Updates configuration of an existing domain administrator's account with data specified in the options.

To set a password for the domain administrator's account on the domain example.com to sample:

# ./domadmin --update example.com -passwd sample

# ./domadmin -u example.com -passwd sample

--info or -i

<domain_name>

Displays information about a domain administrator's account.

To view the information about the example.com administrator's account:

# ./domadmin --info example.com

# ./domadmin -i example.com

--help or -h

Displays help on the use of the utility.

To view help on the use of this utility:

# ./domadmin --help

# ./domadmin -h

Options

Option	Parameter	Description	Example
`-status`	`true\|false`	Enables/Disables domain administrator's account. Is `true` by default.	To disable example.com administrator's account: # ./domadmin --update example.com -status false
`-passwd`	`<password>`	Sets the domain administrator's password. Required with `-passwd_type` option. See additional comments in the Note below the table.	To set the example.com administrator's password to sample : # ./domadmin -u example.com -passwd sample
`-passwd_type`	`plain\|encrypted`	Specifies the type of the domain administrator's password. Requires `-passwd` option. Is `plain` by default. See additional comments in the Note below the table.	To set the example.com administrator's password to qweqwe and password type to encrypted: # ./domadmin -u example.com -passwd_type encrypted -passwd "as9C3ml08ncCE"
`-pname`	`<string>`	Sets a domain administrator's personal name.	To set the example.com administrator's personal name to John Doe: # ./domadmin -u example.com -pname "John Doe"
`-company`	`<string>`	Sets domain administrator's company name.	To set the example.com administrator's company name to Network Solutions: # ./domadmin -u example.com -company "Network Solutions"
`-phone`	`<number>`	Sets a domain administrator's phone number.	To set the example.com administrator's phone number to (112)112-2211: # ./domadmin -u example.com -phone "(112)112-2211"
`-fax`	`<number>`	Sets a domain administrator's fax number.	To set the example.com administrator's fax number to (112)112-2212: # ./domadmin -u example.com -fax "(112)112-2212"
`-email`	`<string>`	Sets a domain administrator's email address.	To set the example.com administrator's email to admin@example.com: # ./domadmin -u example.com -email admin@for.example.com
`-address`	`<string>`	Sets a domain administrator's street address.	To set the example.com administrator's street address to 22 Drury lane: # ./domadmin -u example.com -address "22 Drury lane"
`-city`	`<string>`	Sets a domain administrator's city.	To set the example.com administrator's city to New York: # ./domadmin -u example.com -address "New York"
`-state`	`<string>`	Sets a domain administrator's state or province.	To set the example.com administrator's state to NY: # ./domadmin -u example.com -state NY
`-zip`	`<string>`	Sets a domain administrator's ZIP/postal code.	To set the example.com administrator's postal code to 64023-1920: # ./domadmin -u example.com -zip 64023-1920
`-country`	`<country_code>`	Sets a domain administrator's country. The option's argument must be a valid two-letter code as described in ISO-3166).	To set the domain administrator's country to United States: # ./domadmin -u example.com -country US
`-language`	`<language_code>`	Specifies which language is used in a client's control panel interface. Deprecated. Use `-locale` option instead.	To set Italian language as default for the example.com administrator's account: # ./domadmin -u example.com -language it-IT
`-locale`	`<language_code>`	Specifies which language is used in a client's control panel interface. The option's argument must be a valid four-letter language code derived from the language code described in ISO-639-2 and the corresponding country code described in ISO-3166.	To set Italian language as default for the example.com administrator's account: # ./domadmin -u example.com -locale it-IT
`-multiple-sessions`	`true\|false`	Allows/Prohibits having several simultaneous sessions in the control panel. Is `false` by default.	To allow example.com administrator to have several simultaneous sessions in the control panel: # ./domadmin -u example.com -multiple-sessions true
`-max-button-length`	`<number>`	Limits button label length for the domain administrator's control panel interface.	To restrict the maximum button label length for the example.com administrator's control panel interface to 10: # ./domadmin -u example.com -max-button-length 10
`-skin`	`<string>`	Specifies which skin is used in a domain administrator's control panel interface.	To set the example.com administrator's control panel interface skin to WinXP Reloaded: # ./domadmin -u example.com -skin "WinXP Reloaded"
`-lock-screen`	`true\|false`	Prevents/Allows working with Plesk until page is completely loaded. Is `true` by default.	To allow example.com administrator to work with the control panel even if control panel screens are not completely loaded: # ./domadmin -u example.com -lock-screen false
`-desktop-preset`	`<string>`	Specifies the desktop preset for the domain administrator's control panel interface.	To preset the example.com administrator's desktop to the New Domain Owner Desktop: # ./domadmin -u example.com -desktop-preset "New Domain Owner Desktop"
`-manage_phosting`	`true\|false`	Allows/Prohibits managing physical hosting. Is `false` by default.	To allow example.com administrator to manage physical hosting: # ./domadmin -u example.com -manage_phosting true
`-manage_ftp_password`	`true\|false`	Allows/Prohibits managing FTP account password. Is `false` by default.	To allow example.com administrator to manage the FTP user password: # ./domadmin -u example.com -manage_ftp_password true
`-manage_sh_access`	`true\|false`	Allows/Prohibits managing access to server shell with FTP user's credentials. Is `false` by default.	To enable shell access to the domain example.com by the example.com administrator using the ftp user's credentials: # ./domadmin -u example.com -manage_sh_access true
`-manage_not_chroot_shell`	`true\|false`	Enables/Disables managing of server shell access to the chrooted environment by a domain administrator.	To enable access to shells of any type on domain example.com by the domain administrator using the ftp user credentials: # ./domadmin -u example.com -manage_not_chroot_shell true -manage_sh_access true
`-manage_quota`	`true\|false`	Allows/Prohibits changing limits on using disk space. Is `false` by default.	To allow example.com administrator to set hard disk quota: # ./domadmin -u example.com -manage_quota true
`-manage_subdomains`	`true\|false`	Allows/Prohibits managing subdomains. Is `false` by default.	To allow example.com administrator to manage subdomains: # ./domadmin -u example.com -manage_subdomains true
`-manage_domain_aliases`	`true\|false`	Allows/Prohibits managing domain aliases. Is `false` by default.	To allow example.com administrator to manage domain aliases: # ./domadmin -u example.com -manage_domain_aliases true
`-manage_log`	`true\|false`	Allows/Prohibits managing log rotation, namely, to adjust the cleanup and recycling of processed log files. Is `false` by default.	To allow example.com administrator to manage log rotation: # ./domadmin -u example.com -manage_log true
`-manage_anonftp`	`true\|false`	Allows/Prohibits managing Anonymous FTP. Is `false` by default.	To allow example.com administrator to manage Anonymous FTP: # ./domadmin -u example.com -manage_anonftp true
`-manage_crontab`	`true\|false`	Allows/Prohibits managing task scheduler. Is `false` by default.	To allow example.com administrator to manage task scheduler: # ./domadmin -u example.com -manage_crontab true
`-manage_dns`	`true\|false`	Allows/Prohibits managing DNS. Is `false` by default.	To allow example.com administrator to manage DNS: # ./domadmin -u example.com -manage_dns true
`-manage_webapps`	`true\|false`	Allows/Prohibits managing Tomcat web applications. Is `false` by default.	To allow example.com administrator to manage Tomcat web applications: # ./domadmin -u example.com -manage_webapps true
`-manage_maillists`	`true\|false`	Allows/Prohibits managing mailing lists. Is `false` by default.	To allow example.com administrator to manage mailing lists: # ./domadmin -u example.com -manage_maillists true
`-make_dumps`	`true\|false`	Allows/Prohibits backing up and restoring data. Deprecated. Use `-allow_local_backups` or `-allow_ftp_backups` instead.	To allow the example.com administrator to backup and restore data : # ./domadmin -u example.com -make_dumps true
`allow_local_backups`	`true\|false`	Allows/Prohibits backing up and restoring data using the control panel repository. Is `false` by default.	To allow the example.com administrator to backup and restore data using the control panel's repository: # ./domadmin -u example.com -allow_local_backups true
`-allow_ftp_backups`	`true\|false`	Allows/Prohibits backing up and restoring data using the FTP repository. Is `false` by default.	To allow the example.com administrator to backup and restore data using the FTP repository: # ./domadmin -u example.com -allow_ftp_backups true
`-manage_drweb`	`true\|false`	Allows/Prohibits managing antivirus protection. Is `false` by default. Deprecated. Use the `-manage_virusfilter` option instead.	To allow the example.com administrator to manage antivirus applications: # ./domadmin -u example.com -manage_drweb true
`-manage_virusfilter`	`true\|false`	Allows/Prohibits managing antivirus protection. Is `false` by default.	To allow the example.com administrator to manage antivirus applications: # ./domadmin -u example.com -manage_virusfilter true
`-manage_dashboard`	`true\|false`	Allows/Prohibits managing desktop view. Can be set to `true` only if the `-dashboard` option is set to `true`. Is `true` by default.	To prohibit example.com administrator from managing desktop view: # ./domadmin -u example.com -manage_dashboard false
`-dashboard`	`true\|false`	Allows/Prohibits using desktop view. Can be set to `false` only if the `-stdgui` option is set to `true`. Is `true` by default.	To prohibit example.com administrator from using desktop view: # ./domadmin -u example.com -dashboard false
`-stdgui`	`true\|false`	Allows/Prohibits using standard view. Can be set to `false` only if the `-dashboard` option is set to `true`. Is `true` by default.	To prohibit example.com administrator from using standard view: # ./domadmin -u example.com -stdgui false
`-manage_spamfilter`	`true\|false`	Allows/Prohibits managing spam filter. Is `false` by default.	To allow example.com administrator to manage spam filter: # ./domadmin -u example.com -manage_spamfilter true
`-select_db_server`	`true\|false`	Allows/Prohibits choosing a DB server from the servers registered in Plesk, when creating a database. Is `false` by default. Available since Plesk 8.6.	To allow example.com administrator to choose a DB server on which a database is to be created: # ./domadmin -u example.com -select_db_server true

Note: Use of this option is not recommended. Passing passwords through CLI as parameters of the -passwd option may potentially compromise the system's security as command line can be observed by other users of the system. It is more secure to pass passwords through the environment variables. You can transfer non-encrypted passwords by using environment variable PSA_PASSWORD while using single quotes to specify the empty values in the command line for the argument of the -passwd - -passwd_type options.
Similarly, you can transfer encrypted passwords through the environment variable PSA_CRYPTED_PASSWORD while using single quotes to specify the empty values in the command line for the argument of the -passwd and -passwd_type options.