Veritas NetBackup™ コマンドリファレンスガイド
- 概要
- 付録 A. NetBackup コマンド
名前
nbcertcmd — 証明書要求の認可に使用するホスト ID ベースのセキュリティ証明書とトークンを要求および管理します。外部証明書を NetBackup ホストに登録します。
概要
nbcertcmd -checkClockSkew [-server master_server_name]
nbcertcmd -cleanupCRLCache -expired | -issuerHash SHA-1_hash_of_CRL_issuer_name
nbcertcmd
-cleanupToken [-server master_server_name]
nbcertcmd -createCertRequest -requestFile request_file_name [-server master_server_name]
nbcertcmd -createECACertEntry -host host_name | -hostId host_ID -subject subject_name_of_the_certificate [-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 -deleteAllCertificates
nbcertcmd -deleteCertificate -hostId host_id [-cluster]
nbcertcmd -deleteECACertEntry -subject subject_name [-server master_server_name]
nbcertcmd
-deleteToken -name token_name [-reason description_for_auditing] [-server master_server_name]
nbcertcmd -deployCertificate -certificateFile certificate_file_name
nbcertcmd -displayCACertDetail [-server master_server_name] [-json | -json_compact]
nbcertcmd -displayToken -name token_name [-json | -json_compact] [-server master_server_name]
nbcertcmd-ecaHealthCheck [-trustStorePath path_to_CA_certificate_file] [-certPath path_to_certificate_file] [-privateKeyPath path_to_certificate_key_file] [-passphraseFile path_to_passphrase_file] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-crlPath path_to_CRLs] [-cluster] [-web] [-fmt details | failures_only] [-json | -json_compact]
nbcertcmd -enrollCertificate [-force] [-preCheck] [-cluster] [-server master_server_name] [-remoteHost remote_host_name]
nbcertcmd -getCACertificate [-file hash_file_name] [-cluster] [-server master_server_name]
nbcertcmd -getCertificate [-token | -envtoken environment_variable | -file authorization_token_file] [-force] [-cluster] [-server master_server_name] [-json | -json_compact]
nbcertcmd -getCRL [-server master_server_name] [-cluster]
nbcertcmd -getExternalCertDetails -certPath path_to_certificate_file [-json | -json_compact]
nbcertcmd -getSecConfig [-certDeployLevel] [-caUsage] [-server master_server_name]
nbcertcmd -hostSelfCheck [-cluster] [-server master_server_name]
nbcertcmd -listAllCertificates [-jks]
nbcertcmd -listAllDomainCertificates [-json | -json_compact] [-server master_server_name]
nbcertcmd -listCACertDetails [-json | -json_compact] [-cluster]
nbcertcmd -listCertDetails [-ECA | -NBCA] [-json | -json_compact] [-cluster]
nbcertcmd -listEnrollmentStatus [-remoteHost remote_client_name] [-cluster] [-json | -json_compact]
nbcertcmd -listToken [-all] [-json | -json_compact] [-server master_server_name]
nbcertcmd -removeCACertificate -fingerPrint certificate_fingerprint [-cluster]
nbcertcmd -removeEnrollment [-cluster] [-server master_server_name] [-remoteHost remote_client_name]
nbcertcmd -renewCertificate [-host host_name] [-cluster] [-server master_server_name]
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
nbcertcmd -updateConf
nbcertcmd -updateCRLCache
UNIX システムでは、このコマンドへのディレクトリパスは /usr/openv/netbackup/bin/ です。
Windows システムでは、このコマンドへのディレクトリパスは install_path\NetBackup\bin\ です。
説明
nbcertcmd コマンドは、各 NetBackup ホスト上のホスト ID に基づくセキュリティ証明書を要求して管理するために使用されます。NetBackup ホストは、マスターサーバー、メディアサーバー、クライアントのいずれかです。このコマンドを使用して、外部 CA が署名した証明書を NetBackup ホストに登録します。
このコマンドは NetBackup ホストの証明書の要求で必要になる認証トークンの作成と管理にも使用されます。
さらにこのコマンドはセキュリティ構成属性の設定と取得のために使用されます。
権限詳細テーブルは、管理者権限が必要な操作と特別な権限が必要ない操作をリストします。
表: 権限詳細
NetBackup の管理者権限が必要なコマンド | -cleanupToken、-createECACertEntry、-createToken、-deleteToken、-deleteECACertEntry、-displayToken、--、-listAllDomainCertificates、-listToken、-revokeCertificate、-setSecConfig メモ: これらの操作は、NetBackup 管理者権限を持つアカウントを使って、bpnbat Web ログオン (bpnbat -login -logintype WEB) を行う必要があります。 |
ホストの管理者権限が必要なコマンド | -cleanupCRLCache、-createCertRequest、-deleteAllCertificates、-deleteCertificate、-deployCertificate、-displayCACertDetail、-ecaHealthCheck、-enrollCertificate、-getCACertificate、-getCertificate、-getCRL、-hostSelfCheck、-listAllCertificates、-listCertDetails、-listEnrollmentStatus、-removeCACertificate、-removeEnrollment、、-updateCRLCache、-renewCertificate、-updateConf |
特別な権限が不要なコマンド | -checkClockSkew、-getExternalCertDetails、-getSecConfig、-listCACertDetails、-signCertificate |
ホスト ID ベースのセキュリティ証明書と認証トークンについて詳しくは、『NetBackup セキュリティおよび暗号化ガイド』を参照してください。
nbcertcmd は次の操作をサポートします。
-cleanupCRLCache | NetBackup 証明書失効リスト (CRL) のキャッシュをクリーンアップします。 このコマンドオプションは、外部 CA が署名した証明書にのみ適用できます。 |
-cleanupToken | 最大使用数に到達したか、または期限切れになっているトークンを削除します。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-createCertRequest | NetBackup ホストで NetBackup セキュリティ証明書の署名要求を生成して、指定したファイルに保存します。このコマンドはマスターサーバーとの接続がない場合に NetBackup ホストで使用する必要があります。コマンドは証明書を要求する対象となる NetBackup ホストで実行する必要があります。 - server オプションを使用すると、証明書の署名要求でマスターサーバー名を指定できます。この名前は、NetBackup ホストが証明書を要求するマスターサーバーの名前です。 |
-createECACertEntry | マスターサーバーと安全に通信するために、NetBackup データベースにホストと証明書の関連サブジェクト名のエントリを追加します。 このコマンドオプションは、外部 CA が署名した証明書にのみ適用できます。 |
-createToken | 証明書要求を認可するためのトークンを作成します。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-checkClockSkew | 現在のホストとマスターサーバー間の時間の差 (秒) を表示します。 |
-deleteAllCertificates | NetBackup ホストで利用可能なすべての NetBackup 証明書とキーを削除します。このオプションは、メディアサーバーとクライアントにのみ適用できます。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-deleteCertificate | 指定したホスト ID に関連付けられた NetBackup ホストの NetBackup 証明書を削除し、 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-deleteECACertEntry | 外部証明書とホストの関連付けを削除します。証明書エントリがデータベースから削除されます。 このコマンドオプションは、外部 CA が署名した証明書にのみ適用できます。 |
-deleteToken | 指定したトークンを削除します。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-deployCertificate | ホストのセキュリティ証明書を指定した証明書ファイルから読み取り、NetBackup ホストに配備します。コマンドは証明書の署名要求が生成された NetBackup ホストで実行する必要があります。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-displayCACertDetail | 指定したマスターサーバーの NetBackup CA 証明書の詳細を表示します。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-displayToken | 指定したトークンの属性と値を表示します。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-ecaHealthCheck | 外部 CA が署名した証明書に関する指定した詳細が、有効かどうかを確認します。 このコマンドオプションは、外部 CA が署名した証明書にのみ適用できます。 |
-enrollCertificate | 外部 CA が署名した証明書を NetBackup ドメインに登録します。この証明書はホストの通信時に使用されます。 このコマンドオプションは、外部 CA が署名した証明書にのみ適用できます。 |
-getCACertificate | マスターサーバーに接続し、NetBackup 認証局 (CA) の証明書を取得します。次に、証明書の指紋を表示してユーザーが確認した後に NetBackup トラストストアに追加します。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-getCertificate | このオプションでは、次の処理が実行されます。
このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-getCRL | マスターサーバーで NetBackup CA から最新の証明書失効リストをフェッチします。 - server オプションを使用して別のマスターサーバーを指定できます。グローバル証明書ストアから最新の CRL を取得するには、-cluster オプションを使用します。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-getExternalCertDetails | 指定した外部 CA が署名した証明書の詳細をリストします。 このコマンドオプションは、外部 CA が署名した証明書にのみ適用できます。 |
-getSecConfig | 指定したセキュリティ構成属性を取得します。 |
-hostSelfCheck | ホストの証明書が無効化されているかどうかを示します。NetBackup CA が署名した証明書の場合、CRL の情報が最新であることを確認するには、まず nbcertcmd -getCRL を実行します。外部 CA が署名した証明書の場合、CRL の情報が最新であることを確認するには、まず nbcertcmd -updateCRLCache を実行します。nbcertcmd - updateCRLCache を実行する前に、ECA_CRL_PATH 構成オプションで定義されている場所で最新の CRL を利用できることを確認します。 |
-listAllCertificates | NetBackup ホストで利用可能なすべてのセキュリティ証明書の詳細をリストします。 |
-listAllDomainCertificates | NetBackup マスターサーバーからドメインの NetBackup 証明書をすべて要求します。デフォルトでは、この操作は NetBackup 構成 ( このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-listCACertDetails | NetBackup ホストの NetBackup トラストストアに保存されている、信頼される CA 証明書の詳細をリストします。 |
-listCertDetails | NetBackup ホストで配備される各セキュリティ証明書の証明書詳細をリストします。 |
-listEnrollmentStatus | 関連付けられたマスターサーバーの登録状態を、ローカル証明書ストアから取得します。マスターサーバーの登録状態は次のいずれかになります。
|
-listToken | トークンをリストします。このオプションはトークン値を表示しません。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-removeCACertificate | 指紋が入力した指紋と一致する NetBackup CA 証明書を、安全な通信のために使用する NetBackup トラストストアから削除します。既存の CA 証明書の指紋を表示するには、-listCACertDetails オプションを使用します。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-removeEnrollment | 指定したマスターサーバーに関する外部証明書の詳細をローカル証明書ストアから削除します。証明書は、システムからも NetBackup データベースからも削除されません。 |
-renewCertificate | 既存の NetBackup 証明書を更新します。-host オプションを使用して、ホストのプライマリ名を変更します。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-revokeCertificate | NetBackup 証明書を無効にします。NetBackup ホストはマスターサーバーとの通信に該当の証明書を使用できなくなります。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-setSecConfig | 指定したセキュリティ構成属性を設定します。 |
-signCertificate | 指定した要求ファイルから証明書の署名要求を読み取り、署名要求にリストされているマスターサーバーの NetBackup CA に送信します。署名済みの証明書は指定した証明書ファイルに格納されます。コマンドはマスターサーバーとの接続が可能な NetBackup ホストで実行する必要があります。 このコマンドオプションは、NetBackup CA が署名した証明書にのみ適用できます。 |
-updateConf | ecaHealthCheck コマンドが正常に実行された後に外部証明書固有の構成オプションを更新します。 |
-updateCRLCache | ECA_CRL_PATH に存在する CRL ファイルで NetBackup CRL キャッシュを更新します。 ECA_CRL_PATH の設定は NetBackup 構成ファイルに指定されています。 ECA_CRL_PATH に存在する CRL ファイルは、キャッシュされた CRL のコピーより新しく有効な場合に使用されます。 このコマンドオプションは、外部 CA が署名した証明書にのみ適用できます。 |
メモ:
クラスタ化される NetBackup ホストは、ローカル証明書ストアとグローバル証明書ストアの 2 つの証明書ストアを持っています。このコマンドは、-cluster オプションが指定されない限り、デフォルトではローカル証明書ストアで動作します。
メモ:
nbcertcmd コマンドは、ユーザー定義の文字列には US ASCII 以外 (7 ビット以外の ASCII) の文字をサポートしません。
オプション
- -all
最大使用数に到達した、または有効期限切れのトークンを含むすべてのトークンを表示します。
- -caUsage
NetBackup ドメインがサポートする認証局 (CA) を指定します。NetBackup CA、外部 CA、またはその両方を指定できます。コマンドの出力は、次のいずれかになる可能性があります。
NBCA:ON ECA:OFF - NetBackup 認証局が署名した証明書のみを Web サーバーが使用していることを示します。
NBCA:OFF ECA:ON - 外部認証局が署名した証明書のみを Web サーバーが使用していることを示します。
NBCA:ON ECA:ON - NetBackup 認証局が署名した証明書と外部認証局が署名した証明書の両方を Web サーバーが使用していることを示します。
- -certDeployLevel level
NetBackup 証明書の配備レベルを指定します。このオプションは、-getSecConfig および -setSecConfig コマンドの両方に該当します。-setSecConfig コマンドでは、レベルを指定する必要があります。-setSecConfig パラメータの証明書配備レベルは次のとおりです。
0 - 最高 : 自動証明書配備は無効になります。
1 - 高 : 証明書は既知のホストに自動的に配備されます。
2 - 中 : 証明書は要求するすべてのホストに自動的に配備されます。
- -certPath
証明書ファイルへのパスを指定します。
- -crlCheck
ホストの外部証明書の失効の確認レベルを指定します。次の値を指定できます。
DISABLE または 0: 失効の確認を無効にします。ホストとの通信時に、CRL で証明書の失効状態は検証されません。
LEAF または 1: CRL でリーフ証明書の失効状態が検証されます。このオプションのデフォルト値は LEAF です。
CHAIN または 2: CRL で証明書チェーンの証明書すべての失効状態が検証されます。
- -crlPath
外部 CA の証明書失効リスト (CRL) が保存されているディレクトリのパスを指定します。
- -ECA
NetBackup ホストに配備されている各外部認証局が署名した証明書の詳細をリストします。このオプションが指定されていない場合、NetBackup 証明書の詳細が取得されます。
- -envtoken environment_variable
要求に使用する認証トークンを含む環境変数の名前を示します。
- -file file_name
認証トークン (最初の行) または CA 証明書ハッシュのいずれかを含むファイルのパスを指定します。
- -fingerPrint certificate_fingerprint
CA 証明書の指紋を指定します。
- -fmt details | failures_only
外部証明書固有の構成オプションについて実行された検証チェックの詳細を提供します。details オプションを指定すると、成功と失敗を含むすべての検証チェックに関するレポートが提供されます。failures_only オプションを指定すると、失敗したチェックのみに関するレポートが提供されます。
- -force
このオプションを -getCertificate オプションとともに使用すると、証明書が存在する場合は上書きされます。このオプションを -enrollCertificate オプションとともに使用すると、指定した証明書が既存の登録状態に関係なく登録されます。
- -host host_name
ホスト名を指定します。
- -hostId host_id
NetBackup ホスト ID を指定します。
- -jks
Java Keystore から取得した Web サーバー証明書情報を表示します。このオプションは NetBackup マスターサーバーのみで利用できます。
- -json
json
形式で複数行の出力データを生成します。- -json_compact
json
形式で 1 行の出力データを生成します。- -maxUses number
トークンの最大使用数を指定します。このオプションが指定されていない場合、デフォルト値は 1 です。maxUses の最大値は 99999 です。
- -name token_name
トークン名を指定します。
- -NBCA
NetBackup ホストで配備されている各 NetBackup 証明書の詳細をリストします。
- -passphrasePath
秘密鍵を復号するためのパスフレーズが格納されたパスフレーズファイルのパスを指定します。
- -privateKeyPath
証明書の秘密鍵ファイルへのパスを指定します。
- -preCheck
外部証明書を検査して、登録できるかどうかを判断します。
- -reason description_for_auditing
この操作について監査レコードに格納されている理由を指定します。
- -reasonCode value
証明書の無効化の理由コードを指定します。表示される値は、-reasonCode 値の有効な数字のみです。
0 - 未指定、1 - 鍵危殆化、2 - CA 危殆化、3 - 内容変更、4 - 証明書更新による破棄、5 - 運用停止
- -reissue
証明書を再発行するために使うことができるトークンを作成します。このオプションは、-host オプションまたは -hostID オプションとともに使用します。
- -remoteHost
-remoteHost と -removeEnrollment オプションを併用すると、指定したリモートホストの外部証明書が -server オプションで指定したマスターサーバーに登録されます。
-remoteHost と -listEnrollmentStatus オプションを併用すると、-remoteHost オプションは指定したリモートホストに関連付けられているマスターサーバーの登録状態を一覧表示します。
-remoteHost と -removeEnrollment オプションを併用すると、-remoteHost オプションは、指定したマスターサーバーに存在する、指定したリモートホストの登録を削除します。
-remoteHost オプションを実行するサーバーの名前が、リモートホストの SERVER 構成オプションにリストされていることを確認してください。
たとえば、remoteHost1 の証明書を Server1 から登録する場合、構成ファイルの remoteHost1 で SERVER = Server1 となっていることを確認します。
- -requestFile file_name
証明書要求ファイルのパスを指定します。
- -server master_server_name
代替マスターサーバーを指定します。デフォルトでは、このコマンドは NetBackup 構成内の最初のサーバーエントリを使用します。
- -token
認証トークンを要求に使うことを示します。ユーザーにトークンを安全に指定するように求めるメッセージを表示します。
- -trustStorePath
認証局バンドルファイルへのパスを指定します。
- -validFor numDnumHnumM
トークンの有効性を指定します。この値の入力形式は、日、時、分の数になる必要があります。たとえば、12D6H30M は、12 日、6 時間、30 分の有効性を持つことになります。1 つ以上の値を指定することを選択できます。このオプションが指定されていない場合、デフォルト値は 24 時間です。トークンの有効性を 12 時間に設定したい場合は、日や分の有効性を指定する必要がないことに注意してください。12H と指定できます。指定できる最大の有効期間は 999 日です。
- -web
NetBackup Web ユーザーインターフェースとの通信用に外部証明書を構成します。
例
例 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
関連項目
bpnbat(1m)を参照してください。