各種コマンド

コマンド

Keeperコマンドリファレンス

対話型シェル、CLI、JSON設定ファイルのいずれを使用する場合でも、以下のコマンドがサポートされており、各コマンドでは追加のパラメータとオプションがご利用になれます。

特定のコマンドのヘルプを表示するには、次のコマンドを実行します。

help <command>

this-deviceコマンド

コマンド: this-device

詳細: デバイスのログアウトと永続ログインのユーザー設定を指定します

パラメータ:

なし

スイッチ:

rename <デバイス名>:デバイスの名前を変更します

register 永続的なログインセッションを利用するために、ユーザーのデータキーをデバイスの公開鍵で暗号化します

persistent-login <ON|OFF> アカウントの「ログイン状態を維持」設定をONまたはOFFにします

ip-auto-approve <ON|OFF> アカウントのIPアドレスデバイスの自動承認に関するセキュリティ設定を制御します

no-yubikey-pin <ON|OFF> セキュリティキー (Webauthn) デバイスのPINの使用をONまたはOFFにします

timeout 自動ログアウトまでの無操作状態の時間を設定します。デフォルトの単位は分です (それぞれ「h」または「d」を追加することで時間または日に設定できます)。

例:

this-device
this-device rename "My MacOS CLI"
this-device persistent-login ON
this-device register
this-device ip-auto-approve ON
this-device timeout 10
this-device timeout 24h

1. 使用可能なオプションを表示します

2. アクセスログに表示されるデバイスの名前を変更します

3. アカウントの「ログイン状態を維持」を有効にします

4. 永続的なログインセッションで使用するために、ユーザーの「暗号化されたデータキー」をサーバーに登録します

5. IPアドレスの自動承認を有効にします (マスターパスワードによるログインにのみ適用)

6. 無操作タイムアウトを10分に設定します

7. 無操作タイムアウトを24時間に設定します

loginコマンド

コマンド: login

詳細: Keeperにログインします

パラメータ:

ログインするアカウントのメールアドレス

スイッチ:

-p、--password Keeperアカウントのパスワード

スイッチでパスワードを指定していない場合は、入力を求められます

例:

login john.doe@keepersecurity.com
login jane.doe@keepersecurity.com -p BhR!jeL4*2_zQ

1. John DoeのKeeperアカウントにログインします。 パスワードの入力を求められます

2. 指定したパスワードでJane DoeのKeeperアカウントにログインします

whoamiコマンド

コマンド: whoami

詳細: 現在ログイン中のユーザー情報を表示します。

スイッチ:

-v、--verbose 現在のデータセンターとコマンダーの環境を追加表示します

例:

whoami
whoami -v

1. 詳細なユーザー情報を表示します

2. 現在のデータセンターと環境を含む詳細なユーザー情報を表示します

出力例:

My Vault> whoami
        Logged in as: jane.doe@keepersecurity.com

             Account                 Type:Enterprise
                             Renewal Date:Jul 29, 2021
             Storage             Capacity:1000GB
                                    Usage:0%
                             Renewal Date:Jul 29, 2021

logoutコマンド

コマンド: logout

詳細: Keeperからログアウトします

例:

logout

1. Keeperからログアウトします

helpコマンド

コマンド: help

詳細: 指定したコマンダーのコマンドに関する情報を表示します

パラメータ:

情報を表示するコマンダーのコマンド

例:

help add
help sync-down
help

1. addコマンドの詳細情報を表示します

2. sync-downコマンドの詳細情報を表示します

3. 使用できるコマンドのすべてを表示します

create-accountコマンド

コマンド: create-account

詳細: Keeperアカウントを作成します。 アカウントのパスワードメールの認証コードの入力を求められます。

パラメータ:

アカウントに使用するメールアドレス。

例:

create-account example@keepersecurity.com

sync-downコマンド

コマンド: sync-downまたはd

詳細: ボルトをダウンロード、同期、復号化します

例:

sync-down

1. ボルトを同期します

2. ボルトを同期します

versionコマンド

コマンド: versionまたはv

詳細: コマンダーのバージョンとパス情報を表示します

スイッチ:

-v 基盤となるSDK、OS、作業ディレクトリ、設定ファイルに関する情報を表示します

例:

version
v -v

1. 現在のコマンダーのバージョンを表示します

2. 現在のコマンダーのバージョンとSDKのバージョン、OS、作業ディレクトリ、設定ファイルを表示します

clearコマンド

コマンド: clearまたはc

詳細: 画面からすべての行を消去します

例:

clear

1. 画面からすべての行を消去します

run-batchコマンド

コマンド: run-batchまたはrun

詳細: 指定したファイルからコマンドを順次実行します。

スイッチ:

-d [seconds] コマンド間の遅延時間をこの秒数で指定します。これは、バックエンドでのスロットリングの回避に有効です。

-q Quietモード

-nまたは--dry-run 実際には実行せずにコマンドの動作をプレビューします。

例:

run-batch -d 10 "C:\path\to\commands.txt"

run-batch -d 2 "/path/on/linux/to/commands.txt"

run-batch --dry-run -d 1 commands.txt

generateコマンド

Commander v16.5.10以降

コマンド: generate

詳細: 安全なパスワードを生成します

スイッチ:

-ccまたは--clipboard-copy 作成されたパスワードをクリップボードにコピーします

-nbまたは--no-breachwatch Breachwatchの照合を省略します

-f <{table, json}>または--format <{table, json}> 生成されたパスワードの出力方法を選択します

• Commander v16.5.11以降必須

-i <数>または--json-indent <数> json形式の場合

• 0は、プレーンなjson出力です

• 0より大きい数字で、出力を読みやすくするインデントを選択します

• Commander v16.5.11以降必須

-n <数>または--number <数> 指定した数のパスワードを作成します

-c <長さ>または--count <長さ> パスワードの長さ

-s <記号の数>または--symbols <記号の数> パスワードに含める特殊記号の最小数

-d <数字の数>または--digits <数字の数> パスワードに含める数字の最小数

-u <大文字の数>または--uppercase <大文字の数> パスワードに含める大文字の最小数

-l <小文字の数>または--lowercase <小文字の数> パスワードに含める小文字の最小数

-dr <サイコロを振る回数>または--dice-rolls <サイコロを振る回数>

例:

generate
generate -cc -c 12 -u 2 -s 2
generate --format json -i 0
generate --dice-rolls=6 --number=10 --no-breachwatch

1. 安全なパスワードを生成します

2. 2つ以上の大文字と2つ以上の記号を含む12文字の安全なパスワードを生成して、システムのクリップボードにコピーします

3. パスワードを生成し、パスワード強度とBreachwatchの結果をプレーンなjson形式で表示します

4. 6つの単語からなるランダムなパスワードを10個生成します

generate dice-rollコマンド

コマンダー v16.7.6以降

コマンド: generate --dice-rolls

詳細: サイコロを振ってランダムな単語で構成される安全なパスワードを生成します

スイッチ:

-drまたは--dice-rolls <生成単語数> 生成する単語数を指定し、サイコロを振ってパスワードを生成します

--word-list <単語リストファイル名> オプションで、単語リストとして使用する単語のファイルを指定します

例:

generate --dice-rolls 6
generate --dice-roll 5 --word-list "words.txt"

1. 6つのランダムな単語からなるパスワードを生成します

2. 指定した単語ファイルから5つのランダムな単語を選んでパスワードを生成します

verify-recordsコマンド

コマンド: verify-records

詳細: レコード形式の完全性を確認し、レコード構造で必要な修復を行います。フィールドの問題がKeeperサポートに報告される際には、このコマンドにエッジケースが追加されます。

例:

verify-records

There are 23 record(s) to be corrected
Do you want to proceed? [y/n]: y

verify-shared-foldersコマンド

コマンド: verify-shared-folders

パラメータ

確認する共有フォルダの名前またはUID。すべて確認する場合は、空白のままにします

詳細: 共有フォルダに正しい共有データキーが設定されていないレコードがないか確認し、必要に応じて正しいキーを追加します

例:

verify-shared-folders

There are 2 record key(s) to be corrected
 x4qAxrfilDryCbNCoTqZ8A  MyRecord
 D9QWFSNliXJU86-VI3zyMw  Twitter Login
Do you want to proceed? [y/n]:

reset-passwordコマンド

コマンド: reset-password

詳細: アカウントのマスターパスワードをリセットします

スイッチ:

--delete-sso SSOマスターパスワードを削除します

--current 現在のマスターパスワード

--new マスターパスワードとして設定する新しいパスワード

例:

reset-password --current MyOldPassword --new lTo@KjCitMPs+R[16HX

sync-security-dataコマンド

コマンド: sync-security-dataまたはssd

詳細: ユーザーのボルトでユーザーが所有するすべてのパスワードレコードのセキュリティデータを計算および更新します。ボルト内でユーザーと企業の管理者に (管理コンソールを使用するか、またはコマンダーでsecurity-audit-reportを呼び出すかのいずれかで) 表示された、サマリーセキュリティ監査スコアの食い違いを修正するために使用されます

パラメータ:

同期するレコードの名前、パス、またはUID (1つまたは複数)。このオプションパラメータを省略すると、対象となるすべてのレコードのセキュリティデータが同期されます。--hardオプションが指定されている場合は無視されます (ハード同期では、対象となるすべてのボルトのレコードが強制的に同期されます)

スイッチ:

--hard、-hs セキュリティデータの「ハード同期」を実行します (管理者側でサマリーセキュリティスコアのリセットと再計算を強制します)

--quiet、-q 最小限の画面出力でコマンドを実行します

例:

sync-security-data
sync-security-data --hard
sync-security-data oY5F-KAdtqOloUanBb7dxQ Team1/Shares/Login-Record
sync-security-data --hard -q

1. ユーザーのセキュリティデータの「ソフト同期」を実行します (セキュリティデータは更新しますが、管理者側でサマリースコアのリセットはしません)

2. ユーザーのセキュリティデータの「ハード同期」を実行します (詳細は、上記の--hardスイッチ/フラグのドキュメントを参照)

3. UIDが_oY5F-KAdtqOloUanBb7dxQで、フォルダのパスがTeam1/Shares/Login-Recordのレコードに対して「ソフト同期」を実行します

4. 画面出力を最小限に抑えながら、対象となるすべてのレコードの「ハード同期」を実行します

sleepコマンド

コマンド: sleep

詳細:バッチコマンド間に遅延時間 (秒) を追加します

スイッチ:

バッチコマンド間に追加する遅延 (秒数)

例:

sleep 5

1. 5秒待機します

keeper-fillコマンド

コマンド: keeper-fill

詳細: KeeperFill設定を表示または管理します。特定のKeeperレコードの「自動入力」および「自動送信」設定を表示/変更できます。

keeper-fill command [--options]

Command    Description
---------  -------------------------------------
list       Displays KeeperFill settings.
set        Sets KeeperFill settings.

コマンドのヘルプが必要な際は以下を実行します。

My Vault> keeper-fill <command> -h

「set」に対して使用できる値は「none」、「off」、「on」となります。

「none」に設定した場合はユーザーの設定に従います (KeeperFillの一般設定画面)。値が「on」または「off」に設定されている場合はレコードの設定に従います。

例:

My Vault> keeper-fill list / --recursive
My Vault> keeper-fill set / --recursive --auto-fill=none
My Vault> keeper-fill set <RECORD_UID> --auto-submit=off
My Vault> keeper-fill set <RECORD_UID> --auto-fill=on

2faコマンド

コマンド: 2fa

詳細: 2FA設定を表示、追加、削除します。

2fa command [--options]

Command    Description
---------  ------------------------------
list       Displays a list of 2FA methods
add        Add 2FA method
delete     Delete 2FA method

コマンドのヘルプが必要な際は以下を実行します。

My Vault> 2fa <command> -h

例:

My Vault> 2fa list 
2FA authentication expires: Never

  #  Method        Channel UID             Name         Created              Phone Number
---  ------------  ----------------------  -----------  -------------------  --------------
  1  TOTP          scbqsym0rRAWhDFZqfClY                2021-09-20 16:07:01
  2  Backup Codes  I2KObaAfoQpfDJVjDKNFB   Backup Code  2022-02-11 14:18:12
  

My Vault> 2fa delete scbqsym0rRAWhDFZqfClY
My Vault> 2fa add --method=totp --name="Google Authenticator"
My Vault> 2fa add --method=key --key-pin --name="Yubikey"