例えば、「クライアントアカウント作成」イベントのイベントハンドラを作成してみます。 ハンドラはクライアント名を最初のパラメータとして受け入れ、クライアントのログインを2番目のパラメータとして受け入れます。 説明を簡単にする為に、以下のような test-handler.sh
と呼ばれるシェルスクリプトを使用します。
#!/bin/bash
echo "--------------" >> /tmp/event_handler.log
/bin/date >> /tmp/event_handler.log # イベント日時に関する情報
/usr/bin/id >> /tmp/event_handler.log # スクリプトが代わりに実行される先のユーザの情報(制御を確実にするため)
echo "client created" >> /tmp/event_handler.log # 作成されたクライアントアカウントの情報
echo "name: $1" >> /tmp/event_handler.log # クライアント名
echo "login: $2" >> /tmp/event_handler.log # クライアントのログイン
echo "--------------" >> /tmp/event_handler.log
このスクリプトはファイルにある情報をプリントし、その実行を制御します(スクリプトはバックグラウンドモードで実行されるため、stdout/stderrには情報を出力できません)。
例えば、使用するスクリプトがディレクトリ /plesk_installation_directory/bin
にあると仮定します。 コントロールパネル経由でイベントハンドラを作成し、スクリプトを登録します。
複数のハンドラを1つのイベントに割り当てる場合、異なる優先度(高い値に設定すると優先度も高くなります)でハンドラの実行シーケンスを指定できます。
/usr/local/psa/bin/test-handler.sh <new_contact_name> <new_login_name>
です。注: コマンドラインのうち、括弧でくくった
と <new_contact_name>
<
new_login_name
の部分でパラメータを指定します。 ハンドラを実行する前に、作成したクライアントの名前とログインをそれぞれ置き換えます。 使用可能なパラメータの完全なリストは次のセクションで提供されます。 削除オペレーションでは、new_xxx のパラメータは空白行にする点に注意して下さい。 作成オペレーションでは、old_xxx のパラメータが空白行になります。>
Pleskコントロールパネルにログインし新規クライアントを作成するには、[連絡名] フィールドに「Some Client」、[ログイン]フィールドに「some_client」という値を指定してハンドラを呼び出すと、以下のレコードが /tmp/event_handler.log
に追加されます。
Sat Jun 26 21:46:34 NOVT 2004
uid=0(root) gid=0(root) groups=0(root)
client created
name: Some client
login: some_client
1つ以上のハンドラを指定するには、他のハンドラについても同じアクションを繰り返して下さい。
イベントハンドラ設定時に使用可能なパラメータテンプレートは以下の表の通りです。
表. 使用可能なイベントハンドラパラメータテンプレート
コンポーネント名と説明 |
コマンドラインパラメータ |
注 |
|
古いコンポーネントの値 |
新規のコンポーネントの値 |
||
「クライアントアカウント作成」、「クライアントアカウント更新」、「クライアントアカウント削除」のイベント |
|||
ログイン名 |
old_login_name |
new_login_name |
必須 |
連絡名 |
old_contact_name |
new_contact_name |
必須 |
会社名 |
old_company_name |
new_company_name |
|
電話番号 |
old_phone |
new_phone |
|
ファックス |
old_fax |
new_fax |
|
old_email |
new_email |
|
|
住所 |
old_address |
new_address |
|
都市 |
old_city |
new_city |
|
州または県 |
old_state_province |
new_state_province |
|
郵便番号 |
old_postal_zip_code |
new_postal_zip_code |
|
国 |
old_country |
new_country |
|
「ドメイン作成」、「ドメイン更新」、「ドメイン削除」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
「サブドメイン作成」、「サブドメイン更新」、「サブドメイン削除」のイベント |
|||
サブドメイン名 |
old_subdomain_name |
new_subdomain_name |
必須 |
親ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
FTPアカウント |
old_system_user_type |
new_system_user_type |
|
サブドメイン管理者のログイン名 |
old_system_user |
new_system_user |
|
ハードディスククォータ |
old_hard_disk_quota |
new_hard_disk_quota |
|
SSI対応 |
old_ssi_support |
new_ssi_support |
|
PHP対応 |
old_php_support |
new_php_support |
|
CGI対応 |
old_cgi_support |
new_cgi_support |
|
Perl対応 |
old_mod_perl_support |
new_mod_perl_support |
|
Python対応 |
old_mod_python_support |
new_mod_python_support |
|
ColdFusion対応 |
old_coldfusion_support |
new_coldfusion_support |
|
Apache::ASP対応 |
old_apache_asp_support |
new_apache_asp_support |
|
SSL対応 |
old_ssl_support |
new_ssl_support |
|
「ドメインエイリアス作成」、「ドメインエイリアス更新」、「ドメインエイリアス削除」のイベント |
|||
ドメインエイリアス名 |
old_domain_alias_name |
new_domain_alias_name |
必須 |
ドメインエイリアスのオンまたはオフ |
old_status |
new_status |
|
ドメインエイリアスのWebサービスのオンまたはオフ |
old_domain_alias_web |
new_domain_alias_web |
|
ドメインエイリアスのメールサービスのオンまたはオフ |
old_domain_alias_mail |
new_domain_alias_mail |
|
ドメインエイリアスビジターがJavaのWebアプリケーションへアクセス(オンまたはオフ) |
old_domain_alias_tomcat |
new_domain_alias_tomcat |
|
「物理ホスティング作成」、「物理ホスティング更新」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
IPアドレス |
old_ip_address |
new_ip_address |
|
IPタイプ |
old_ip_type |
new_ip_type |
|
システムユーザ |
old_system_user |
new_system_user |
|
システムユーザパスワード |
old_system_user_password |
new_system_user_password |
|
シェルアクセス |
old_system_shell |
new_system_shell |
|
FP対応 |
old_fp_support |
new_fp_support |
|
FP-SSL対応 |
old_fpssl_support |
new_fpssl_support |
|
FPオーサリング |
old_fp_authoring |
new_fp_authoring |
|
FP管理者ログイン |
old_fp_admin_login |
new_fp_admin_login |
|
FP管理者パスワード |
old_fp_admin_password |
new_fp_admin_password |
|
SSI対応 |
old_ssi_support |
new_ssi_support |
|
PHP対応 |
old_php_support |
new_php_support |
|
CGI対応 |
old_cgi_support |
new_cgi_support |
|
Mod Perl対応 |
old_mod_perl_support |
new_mod_perl_support |
|
Apache::ASP対応 |
old_apache_asp_support |
new_apache_asp_support |
|
SSL対応 |
old_ssl_support |
new_ssl_support |
|
Web統計 |
old_web_statistics |
new_web_statistics |
|
エラードキュメントをカスタマイズする |
old_apache_error_documents |
new_apache_error_documents |
|
ハードディスククォータ |
old_hard_disk_quota |
new_hard_disk_quota |
|
「物理ホスティング削除」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
「メール名作成」、「メール名削除」のイベント |
|||
メール名 |
old_mailname |
new_mailname |
必須(mailname@domain 形式) |
「メール名更新」のイベント |
|||
メール名 |
old_mailname |
new_mailname |
必須(mailname@domain 形式) |
メールボックス |
old_mailbox |
new_mailbox |
|
パスワード |
old_password |
new_password |
|
メールボックスクォータ |
old_mailbox_quota |
new_mailbox_quota |
|
転送 |
old_redirect |
new_redirect |
|
転送アドレス |
old_redirect_address |
new_redirect_address |
|
メールグループ |
old_mail_group |
new_mail_group |
|
自動応答 |
old_autoresponders |
new_autoresponders |
|
メールユーザコントロールパネルアクセス |
old_mail_controlpanel_access |
new_mail_controlpanel_access |
|
「Webユーザ削除」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
Webユーザ名 |
old_webuser_name |
new_webuser_name |
必須 |
「Webユーザ作成」、「Webユーザ更新」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
Webユーザ名 |
old_webuser_name |
new_webuser_name |
必須 |
Webユーザパスワード |
old_webuser_password |
new_webuser_password |
|
SSI対応 |
old_ssi_support |
new_ssi_support |
|
PHP対応 |
old_php_support |
new_php_support |
|
CGI対応 |
old_cgi_support |
new_cgi_support |
|
Mod Perl対応 |
old_mod_perl_support |
new_mod_perl_support |
|
Mod Python対応 |
old_mod_python_support |
new_mod_python_support |
|
Apache::ASP対応 |
old_apache_asp_support |
new_apache_asp_support |
|
ハードディスククォータ |
old_hard_disk_quota |
new_hard_disk_quota |
|
「クライアント制限更新」のイベント |
|||
連絡名 |
old_contact_name |
new_contact_name |
必須 |
ドメインの上限数 |
old_maximum_domains |
new_maximum_domains |
|
ディスク容量の上限 |
old_maximum_disk_space |
new_maximum_disk_space |
|
トラフィックの上限量 |
old_maximum_traffic |
new_maximum_traffic |
|
Webユーザの上限数 |
old_maximum_webusers |
new_maximum_webusers |
|
データベースの上限数 |
old_maximum_databases |
new_maximum_databases |
|
メールボックスの上限数 |
old_maximum_mailboxes |
new_maximum_mailboxes |
|
メールボックスクォータ |
old_maximum_mailbox_quota |
new_maximum_mailbox_quota |
|
メール転送の上限数 |
old_maximum_mail_redirects |
new_maximum_mail_redirects |
|
メールグループの上限数 |
old_maximum_mail_groups |
new_maximum_mail_groups |
|
メール自動応答の上限数 |
old_maximum_mail_autoresponders |
new_maximum_mail_autoresponders |
|
メーリングリストの上限数 |
old_maximum_mail_lists |
new_maximum_mail_lists |
|
Javaアプリケーションの上限数 |
old_maximum_tomcat_web_applications |
new_maximum_tomcat_web_applications |
|
有効期限 |
old_expiration_date |
new_expiration_date |
|
「ドメイン制限更新」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
ディスク容量の上限 |
old_maximum_disk_space |
new_maximum_disk_space |
|
トラフィックの上限量 |
old_maximum_traffic |
new_maximum_traffic |
|
Webユーザの上限数 |
old_maximum_webusers |
new_maximum_webusers |
|
データベースの上限数 |
old_maximum_databases |
new_maximum_databases |
|
メールボックスの上限数 |
old_maximum_mailboxes |
new_maximum_mailboxes |
|
メールボックスクォータ |
old_maximum_mailbox_quota |
new_maximum_mailbox_quota |
|
メール転送の上限数 |
old_maximum_mail_redirects |
new_maximum_mail_redirects |
|
メールグループの上限数 |
old_maximum_mail_groups |
new_maximum_mail_groups |
|
メール自動応答の上限数 |
old_maximum_mail_autoresponders |
new_maximum_mail_autoresponders |
|
メーリングリストの上限数 |
old_maximum_mail_lists |
new_maximum_mail_lists |
|
Javaアプリケーションの上限数 |
old_maximum_tomcat_web_applications |
new_maximum_tomcat_web_applications |
|
有効期限 |
old_expiration_date |
new_expiration_date |
|
「メーリングリスト作成」、「メーリングリスト更新」、「メーリングリスト削除」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
メーリングリスト名 |
old_mail_list_name |
new_mail_list_name |
必須 |
有効なメーリングリスト |
old_mail_list_enabled |
new_mail_list_enabled |
|
「コントロールパネルユーザのログイン」、「コントロールパネルユーザのログアウト」のイベント |
|||
連絡名 |
old_contact_name |
new_contact_name |
|
「ドメイン管理者アカウント更新」のイベント |
|||
ドメイン管理者にアクセスを許可 |
old_allow_domain_user_access |
new_allow_domain_user_access |
|
ログイン名 |
old_login_name |
new_login_name |
必須 |
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
連絡名 |
old_contact_name |
new_contact_name |
|
会社名 |
old_company_name |
new_company_name |
|
電話番号 |
old_phone |
new_phone |
|
ファックス |
old_fax |
new_fax |
|
old_email |
new_email |
|
|
住所 |
old_address |
new_address |
|
都市 |
old_city |
new_city |
|
州または県 |
old_state_province |
new_state_province |
|
郵便番号 |
old_postal_zip_code |
new_postal_zip_code |
|
国 |
old_country |
new_country |
|
「サイトアプリケーションのインストール」、「サイトアプリケーションの再構築」、「サイトアプリケーションのアンインストール」のイベント |
|||
サイトアプリケーションパッケージ名 |
old_site_application_package_name |
new_site_application_package_name |
必須 |
ドメインタイプ(ドメインまたはサブドメイン) |
old_site_application_domain_type |
new_site_application_domain_type |
必須 |
インストレーションパス(httpdocs または httpsdocs) |
old_site_application_directory |
new_site_application_directory |
必須 |
インストール先ディレクトリ内のインストレーションパス |
old_site_application_installation_prefix |
new_site_application_installation_prefix |
必須 |
「サイトアプリケーションパッケージのインストール」、「サイトアプリケーションパッケージのアンインストール」のイベント |
|||
サイトアプリケーションパッケージ名 |
old_site_application_package_name |
new_site_application_package_name |
必須 |
「サービスの停止、起動、または再起動」のイベント |
|||
サービス |
old_service |
new_service |
必須 |
「IPアドレス作成、変更、削除」のイベント |
|||
IPアドレス |
old_ip_address |
new_ip_address |
必須 |
IPマスク |
old_ip_mask |
new_ip_mask |
|
インターフェース |
old_interface |
new_interface |
|
IPタイプ |
old_ip_type |
new_ip_type |
|
「転送作成、変更、削除」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
転送タイプ |
old_forwarding_type |
new_forwarding_type |
|
URL |
old_url |
new_url |
|
「管理者情報変更」のイベント |
|||
Login name |
old_login_name |
new_login_name |
必須 |
連絡名 |
old_contact_name |
new_contact_name |
|
会社名 |
old_company_name |
new_company_name |
|
電話番号 |
old_phone |
new_phone |
|
ファックス |
old_fax |
new_fax |
|
old_email |
new_email |
|
|
住所 |
old_address |
new_address |
|
都市 |
old_city |
new_city |
|
州または県 |
old_state_province |
new_state_province |
|
郵便番号 |
old_postal_zip_code |
new_postal_zip_code |
|
国 |
old_country |
new_country |
|
「サイトアプリケーションのインストール、再構築、アンインストール」のイベント |
|||
サイトアプリケーション名 |
old_package_name |
new_package_name |
必須 |
「クライアントステータス更新」のイベント |
|||
連絡名 |
old_contact_name |
new_contact_name |
必須 |
Login name |
old_login_name |
new_login_name |
必須 |
ステータス |
old_status |
new_status |
|
「クライアント選択設定更新」のイベント |
|||
連絡名 |
old_contact_name |
new_contact_name |
必須 |
Login name |
old_login_name |
new_login_name |
必須 |
ページのサイズ |
old_lines_per_page |
new_lines_per_page |
|
インターフェーススキン |
old_interface_skin |
new_interface_skin |
|
「クライアントのIPプールの変更」のイベント |
|||
連絡名 |
old_contact_name |
new_contact_name |
必須 |
IPアドレス |
old_ip_address |
new_ip_address |
必須 |
ステータス |
old_status |
new_status |
|
「クライアントアカウントのディスク容量制限超過」のイベント |
|||
連絡名 |
old_contact_name |
new_contact_name |
必須 |
ディスク容量制限 |
old_maximum_disk_space |
new_maximum_disk_space |
必須 |
「クライアントアカウントのトラフィック制限超過」のイベント |
|||
連絡名 |
old_contact_name |
new_contact_name |
必須 |
トラフィック制限 |
old_maximum_traffic |
new_maximum_traffic |
|
「ドメインステータス更新」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
ドメインステータス |
old_status |
new_status |
|
「ドメインのDNSゾーン更新」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
「ドメインのディスク容量制限超過」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
ディスク容量制限 |
old_maximum_disk_space |
new_maximum_disk_space |
|
「ドメインのトラフィック制限超過」のイベント |
|||
ドメイン名 |
old_domain_name |
new_domain_name |
必須 |
トラフィック制限 |
old_maximum_traffic |
new_maximum_traffic |
|
「ライセンスキー更新」のイベント |
|||
ライセンスキー番号 |
old_license |
new_license |
必須 |
ライセンスキーのタイプ(Plesk、追加) |
old_license_type |
new_license_type |
|
ライセンスキーの名前(追加キー用) |
old_license_name |
new_license_name |
|