Symantec NetBackup™ コマンドリファレンスガイド
- 概要
- 付録 A. NetBackup コマンド
名前
nbcertcmd — 証明書要求の認可に使用されるホスト ID に基づくセキュリティ証明書とトークンを要求して管理します。
概要
nbcertcmd
-cleanupToken [-server master_server_name]
nbcertcmd
-createCertRequest -requestFile request_file_name [-server master_server_name]
nbcertcmd
-createToken -name token_name [-reissue -host host_name | -hostId host_id] [-maxUses number] [-validFor numDnumHnumM] [-reason description_for_auditing] [-server master_server_name]
nbcertcmd -checkClockSkew [-server master_server_name]
nbcertcmd
-deleteToken -name token_name [-reason description_for_auditing] [-server master_server_name]
nbcertcmd
-deployCertificate -certificateFile certificate_file_name
nbcertcmd -getCACertificate [-file hash_file_name] [-cluster] [-server master_server_name]
nbcertcmd -getSecConfig -certDeployLevel [-server master_server_name]
nbcertcmd -listAllCertificates [-jks]
nbcertcmd -removeCACertificate -fingerPrint certificate_fingerprint [-cluster]
nbcertcmd
-revokeCertificate -host host_name | -hostId host_id [-reasonCode value] [-server master_server_name]
nbcertcmd -setSecConfig -certDeployLevel level [-server master_server_name]
nbcertcmd
-signCertificate -token | -file authorization_token_file -requestFile request_file_name -certificateFile certificate_file_name
UNIX システムでは、このコマンドへのディレクトリパスは /usr/openv/netbackup/bin/ です。
Windows システムでは、このコマンドへのディレクトリパスは install_path\NetBackup\bin\ です。
説明
nbcertcmd コマンドは、各 NetBackup ホスト上のホスト ID に基づくセキュリティ証明書を要求して管理するために使用されます。NetBackup ホストは、マスターサーバー、メディアサーバー、クライアントのいずれかです。
このコマンドは NetBackup ホストの証明書の要求で必要になる認証トークンの作成と管理にも使用されます。
さらにこのコマンドはセキュリティ構成属性の設定と取得のために使用されます。
権限詳細テーブルは、管理者権限が必要な操作と特別な権限が必要ない操作をリストします。
表: 権限詳細
NetBackup の管理者権限が必要なコマンド |
-cleanupToken、-createToken、-deleteToken、-displayToken、、、-listToken、-revokeCertificate、-setSecConfig メモ: これらの操作は、NetBackup 管理者権限を持つアカウントを使って、bpnbat Web ログオン (bpnbat -login -logintype WEB) を行う必要があります。 |
ホストの管理者権限が必要なコマンド |
-createCertRequest、、、-deployCertificate、、-getCACertificate、-getCertificate、、-listAllCertificates、-listCertDetails、-removeCACertificate、-renewCertificate |
特別な権限の必要ないコマンド |
-checkClockSkew、-getSecConfig、-listCACertDetails、-signCertificate |
ホスト ID に基づくセキュリティ証明書と認証トークンに関して詳しくは、『 NetBackup セキュリティおよび暗号化ガイド』を参照してください。
nbcertcmd は次の操作をサポートします。
-cleanupToken |
最大使用数に到達したか、または期限切れになっているトークンを削除します。 |
-createCertRequest |
NetBackup ホストでホスト ID に基づくセキュリティ証明書の署名要求を生成して、指定したファイルに保存します。このコマンドはマスターサーバーとの接続がない場合に NetBackup ホストで使用する必要があります。コマンドは証明書を要求する対象となる NetBackup ホストで実行する必要があります。 - server オプションを使用すると、証明書の署名要求でマスターサーバー名を指定することができます。この名前は、NetBackup ホストが証明書取得を想定するマスターサーバーです。 |
-createToken |
証明書要求を認可するためのトークンを作成します。 |
-checkClockSkew |
現在のホストとマスターサーバー間の時間の差 (秒) を表示します。 |
-deleteToken |
指定したトークンを削除します。 |
-deployCertificate |
ホストのセキュリティ証明書を指定した証明書ファイルから読み取り、NetBackup ホストに配備します。コマンドは証明書の署名要求が生成された NetBackup ホストで実行する必要があります。 |
-displayToken |
指定したトークンの属性と値を表示します。 |
-getCACertificate |
マスターサーバーに接続し、認証局 (CA) の証明書を取得します。次に証明書のフィンガープリントを表示してユーザーからの確認後にローカルのトラストストアに追加します。 |
-getCertificate | |
-getSecConfig |
指定したセキュリティ構成属性を取得します。 |
-listAllCertificates |
NetBackup ホストで利用可能なすべてのセキュリティ証明書の詳細をリストします。 |
-listCACertDetails |
NetBackup ホストのローカルトラストストアに保存される信頼される CA の証明書の詳細をリストします。 |
-listCertDetails |
NetBackup ホストで配備される各セキュリティ証明書の証明書詳細をリストします。 |
-listToken |
トークンをリストします。このオプションはトークン値を表示しません。 |
-removeCACertificate |
フィンガープリントが入力フィンガープリントと一致する CA 証明書をトラストストアから削除します。-listCACertDetails オプションを使用すると、既存の CA 証明書のフィンガープリントを表示することができます。 |
-renewCertificate |
既存の NetBackup ホスト ID に基づくセキュリティ証明書を更新します。-host オプションを使用して、ホストのプライマリ名を変更します。 |
-revokeCertificate |
ホスト ID に基づくセキュリティ証明書を無効にします。NetBackup ホストはマスターサーバーとの通信に証明書を使用できなくなりました。 |
-setSecConfig |
指定したセキュリティ構成属性を設定します。 |
-signCertificate |
指定した要求ファイルから証明書の署名要求を読み取り、署名要求にリストされるマスターサーバーに送信します。署名済みの証明書は指定した証明書ファイルに格納されます。コマンドはマスターサーバーとの接続が可能な NetBackup ホストで実行する必要があります。 |
メモ:
クラスタ化される NetBackup ホストは、ローカル証明書ストアとグローバル証明書ストアの 2 つの証明書ストアを持っています。このコマンドは、-cluster オプションが指定されない限り、デフォルトではローカル証明書ストアで動作します。
メモ:
nbcertcmd コマンドは、ユーザー定義の文字列には US ASCII 以外 (7 ビット以外の ASCII) の文字をサポートしません。
オプション
- -all
最大使用数に到達した、または有効期限切れのトークンを含むすべてのトークンを表示します。
- -certDeployLevel level
証明書配備レベルを指定します。このオプションは、-getSecConfig および -setSecConfig コマンドの両方に該当します。-setSecConfig コマンドでは、レベルを指定する必要があります。-setSecConfig パラメータの証明書配備レベルは次のとおりです。
0 - 最高 : 自動証明書配備は無効になります。
1 - 高 : 証明書は既知のホストに自動的に配備されます。
2 - 中 : 証明書は要求するすべてのホストに自動的に配備されます。
- -certificateFile certificate_file_name
証明書ファイルのパスを指定します。
- -cluster
グローバル証明書ストアで操作を実行します。
- -file file_name
認証トークン (最初の行) または CA 証明書ハッシュのいずれかを含むファイルのパスを指定します。
- -fingerPrint certificate_fingerprint
CA 証明書の指紋を指定します。
- -force
証明書がある場合はその証明書を上書きします。
- -host host_name
ホスト名を指定します。
- -hostId host_id
NetBackup ホスト ID を指定します。
- -jks
Tomcat 証明書情報を Java Keystore から表示します。 このオプションは NetBackup マスターサーバーのみで利用できます。
- -json
json
形式で複数行の出力データを生成します。- -maxUses number
トークンの最大使用数を指定します。このオプションが指定されていない場合、デフォルト値は 1 です。maxUses の最大値は 99999 です。
- -name token_name
トークン名を指定します。
- -reason description_for_auditing
この操作について監査レコードに格納されている理由を指定します。
- -reasonCode value
証明書の無効化の理由コードを指定します。表示される値は、-reasonCode 値の有効な数字のみです。
0 - 未指定、1 - 鍵危殆化、2 - CA 危殆化、3 - 内容変更、4 - 証明書更新による破棄、5 - 運用停止
- -reissue
証明書を再発行するために使うことができるトークンを作成します。このオプションは、-host オプションまたは -hostID オプションとともに使用します。
- -requestFile file_name
証明書要求ファイルのパスを指定します。
- -server master_server_name
代替マスターサーバーを指定します。デフォルトでは、このコマンドは NetBackup 構成内の最初のサーバーエントリを使用します。
- -token
認証トークンを要求に使うことを示します。ユーザーにトークンを安全に指定するように求めるメッセージを表示します。
- -validFor numDnumHnumM
トークンの有効性を指定します。この値の入力形式は、日、時、分の数になる必要があります。たとえば、12D6H30M は、12 日、6 時間、30 分の有効性を持つことになります。1 つ以上の値を指定することを選択できます。このオプションが指定されていない場合、デフォルト値は 24 時間です。トークンの有効性を 12 時間に設定したい場合は、日や分の有効性を指定する必要がないことに注意してください。12H と指定することができます。指定できる最大の有効期間は 999 日です。
例
例 1: 証明書の再発行を要求するトークンを作成します。
# nbcertcmd -createToken -name acme01_HR05 -reissue -validFor 10D -host HRfileserver.acme.com -reason "issued token on request of Alice through email dated 12/08/2016"
トークン XXXXXXXXXXXXXXXX を正常に作成しました。
例 2: トークンを使用して、指定したマスターから証明書を取得します
# nbcertcmd -getCertificate -token -server nbmaster01.acme.com
Authorization Token: Host certificate received successfully from server nbmaster01.acme.com.
例 3: マスターサーバーと接続していない NetBackup ホスト上で証明書を要求して配備します。
マスターサーバーと接続していない NetBackup ホスト上に表示されるコマンドを実行します。
# nbcertcmd -createCertRequest -requestFile /tmp/request_file_name -server master.servername
ホストの証明書要求を正常に生成しました。
/tmp/request_file_name をマスターサーバーと接続している NetBackup ホストにコピーし、その NetBackup ホストに表示されるコマンドを実行します。
# nbcertcmd -signCertificate -file authorization_token_file -requestFile /tmp/request_file_name -certificateFile /tmp/signed_certificate
Sending certificate request to server: master.servername Host certificate request signed successfully.
/tmp/signed_certificate
を要求ファイル (/tmp/request_file_name) が生成された元の NetBackup ホストにコピーし、表示されるコマンドを実行します。# nbcertcmd -deployCertificate -certificateFile /tmp/signed_certificate Deploying certificate from master server: master.servername Host certificate deployed successfully