ap config コマンド
ap config コマンドを使用して、アラート・ルール、SMTP またはその他の構成パラメーターを構成できます。
使用法
ap config [--host <address>] [-h] [--user <user>] [--password <password>] [--from-file <file_path>]
export [<filename>]
import <filename> [--force]
--set alerts_rules --type (action|to|add_to) [--scope <alert_type>|<alert_reason_code>] --value (<action_int>|<email_list>)
--del alerts_rules --type (action|to|add_to) [--scope <alert_type>|<alert_reason_code>]
--test alerts_rules --reason_code <reason_code>
--list alerts_rules
--set smtp option <value> [option <value> [option <value> ...]]
if any of the options below are provided, all of them must be:
--mail_server_name
--mail_server_port
--sender_name
--sender_address
other options (all of the options below must be provided if username or password is):
--login_method
--login_username
--login_password (may be provided without value, user will be interactively prompted for password in such case)
other:
--smtp_encryption
--set snmp option <value> [option <value> [option <value> ...]]
--snmp_ip_address
--snmp_port
--snmp_security_name
--snmp_security_level
--snmp_auth_key
--snmp_auth_protocol
--snmp_enc_key
--snmp_enc_protocol
--snmp_engine_id
--list snmp
--list smtp
--set params [<param>=<value> [<param>=<value> [...]]]
--list params
--force
オプションの引数
- -h|--help
-
コマンドのヘルプを表示します。
- -v|--verbose
-
ログからの追加情報を表示します。
- --host <address>
- システムのアドレスを指定します。デフォルト値は
localhostです。デフォルト値以外を指定する場合は、ユーザーとパスワードも指定する必要があります。 - --user <user>
- ホストにアクセスするユーザー名。
- --password <password>
- ホストにアクセスするためのパスワード。
- --from-file <file_path>
-
ホスト名、ユーザーおよびパスワードをロードするために指定のファイルを使用します。オプションとして指定された値は、ファイルの値を指定変更します。
- -f|--force
- アクションを実行する前に確認しません。
現在の構成のインポートおよびエクスポート
ap config コマンドを使用して設定した構成 (アラート・ルール、SMTP 構成、追加の構成パラメーター) は、バックアップのためにファイルにエクスポートしてから、同じマシンまたは別のマシンにインポートできます。- export [<filename>]
- 構成設定をファイルにエクスポートします。ファイル名を指定できます。指定しない場合、ファイルは現行ディレクトリーに pm_export_YYYY-MM-DD-HH-mm-ss.dat という名前で保存されます。
- import <filename> [--force]
- 指定されたファイルから構成設定をインポートします。--force フラグを指定した場合、確認は求められません。インポート後、変更を有効にするためにプラットフォーム管理を再始動する必要があります。
アラート・ルールを設定するパラメーター
- --list alerts_rules
- アラート・ルールをリストします。
- --test alerts_rules --reason_code <reason_code>
- 指定の理由コードに対して実行されたアクションを確認できます。
- --set alerts_rules --type (action|to|add_to) [--scope <alert_type>|<alert_reason_code>] --value (<action_int>|<email_list>)
- 指定のアラート・ルールに対するパラメーターを設定できます。
- --type
- ルール・タイプを指定します。
- action: 実行するアクションを決定します。
- to: E メールの送信先の E メール・リストを決定します。
- add_to: 既存のリストに追加する E メール・リストを決定します。
- --scope
- ルールのレベルを指定します。有効範囲について詳しくは、アラート・ルールを参照してください。
- --value (<action_int>|<email_list>)
- アラート・ルールに対して実行するアクションの新しい値を指定します。アラート・タイプに応じて、コンマ区切りの E メール・リスト
'mail_1@example.com, mail_2@example.com, mail_3@example.com'または実行するアクションを表す整数のいずれかの値を指定できます。- 0 - 何もしません
- 1 - E メールを送信します
- 2 - PMR をオープンします
- 4 - SNMP トラップを送信します
- 5 - E メールと SNMP トラップを送信します
- 6 - SNMP トラップを送信し、PMR をオープンします
- --del alerts_rules --type (action|to|add_to) [--scope <alert_type>|<alert_reason_code>]
- 選択されたルールを削除します。パラメーターの説明については、上記を参照してください。
サンプル・コマンド出力:
ap config --list alerts_rules
Action rules
+----------------------+----------------+----------+
| Scope | Value | Built-in |
+----------------------+----------------+----------+
| default | 1 (send email) | YES |
| ACTION_FAILED | 0 (do nothing) | YES |
| APPLIANCE_EVENT | 0 (do nothing) | YES |
| HW_SERVICE_REQUESTED | 2 (open PMR) | YES |
| STARTUP_FAILED | 0 (do nothing) | YES |
+----------------------+----------------+----------+
Email rules
+-------+------+-------+
| Scope | Mode | Value |
+-------+------+-------+
+-------+------+-------+
SMTP を設定するパラメーター
- --set smtp option <value> [option <value> [option <value> ...]]
- SMTP の詳細を設定します。
- 以下のいずれかのオプションを指定する場合は、このリストにあるすべてのオプションを指定しなければなりません。
- --mail_server_name <server_name>
- メール・サーバー名
- --mail_server_port <port>
- メール・サーバーのポート
- --sender_name <sender_name>
- 通知 E メールの最後に表示する送信者の署名 (
Yours, Adamなど) - --sender_address <email>
- 送信者の E メール・アドレス
- その他のオプション (
login_usernameまたはlogin_passwordを指定する場合は、他のすべてのオプションも指定しなければなりません)。- --login_method <value>
- 使用するログイン方式。以下の値がサポートされています。
0 - ログインなし
1 - cram-md5
2 - ログイン
3 - プレーン - --login_username <username>
- ユーザー・ログイン。
- --login_password <password>
- ユーザー・パスワード。
--login_passwordパラメーターを値なしで指定することもできます。その場合は、ユーザーが対話式でパスワードを指定するためのプロンプトが表示されます。
- 以下のいずれかのオプションを指定する場合は、このリストにあるすべてのオプションを指定しなければなりません。
- --smtp_encryption <smtp_encryption>
- 使用する SMTP 暗号化方式。以下の値がサポートされています。
0 - 暗号化なし
1 - STARTTLS
2 - SSL/TLS 接続 - --list smtp
- SMTP 構成をリストします。
[root@node0101 ~]# ap config --set smtp --login_method 2 --login_password 123 --login_username test
Updated successfully
[root@node0101 ~]# ap config --list smtp
Mail Server Name : localhost
Mail Server Port : 25
Sender Name : Yours, Admin
Sender Address : admin@company.com
Login Method : login
Login Username : test
Login Password : ***SNMP を設定するパラメーター
- --set snmp option <value> [option <value> [option <value> ...]]
- SNMP の詳細を設定します。
- --snmp_ip_address <snmp_ip_address>
- IP アドレス。
- --snmp_port <snmp_port>
- SNMP ポート。
- --snmp_security_name <snmp_security_name>
- SNMP セキュリティー名。
- --snmp_security_level <snmp_security_level>
- 使用するセキュリティー・レベル。以下の値がサポートされています。
0 - noAuthNoPriv
1 - authNoPriv
2 - authPriv
- --snmp_auth_key <snmp_auth_key>
- 認証鍵の名前。
- --snmp_auth_protocol <snmp_auth_protocol>
- SNMP 認証プロトコル。以下のいずれかの値をとります。
0 - なし
1 - MD5
2 - SHA
- --snmp_enc_key <snmp_enc_key>
- 暗号鍵。
- --snmp_enc_protocol <snmp_enc_protocol>
- 暗号化プロトコル。サポートされる以下の値のいずれかです。0 - 暗号化なし
1 - DES
2 - AES
- --snmp_engine_id <snmp_engine_id>
- SNMP エンジン ID。
- --list snmp
- SNMP 構成をリストします。
追加パラメーター
- --set params [<param>=<value> [<param>=<value> [...]]]
- 指定されたパラメーターのデフォルトの設定値を変更します。複数のパラメーターを指定する場合は、スペース区切りのリストを使用します。
- --list params
- デフォルト以外の値を持つパラメーターをリストします。
ap config --set params suspend_unreachable_nodes=true
Updated successfully. Changes will be effective after platform manager restart. ap config --list params
User config
+---------------------------+-------+
| Param | Value |
+---------------------------+-------+
| suspend_unreachable_nodes | True |
+---------------------------+-------+