PowerShellモジュール

KeeperコマンダーPowerShellモジュールのインストール

最終更新 15 日前

概要

Keeperコマンダーの1つのバージョンは、.Netで開発され、PowerShellモジュールとしてPowerShell Galleryに公開されています。本ページでは、このPowerShellモジュールのインストールと使用方法について解説します。

PowerShell CLI

KeeperのPowerShellコマンドラインツール (PowerCommander) では、基本的なボルトアクセス機能と管理機能がご利用になれます。

KeeperコマンダーのPowerShell モジュールは、PowerShell Galleryにて入手できます。

PowerShell Galleryからのインストール

PowerShell GalleryからPowerCommanderをインストールするには以下を実行します。

Install-Module -Name PowerCommander

GitHubリポジトリ

PowerCommanderモジュールをソースから実行する方法については、以下のGitHubページをご参照ください。

インストールのトラブルシューティング

実行ポリシー権限を設定

PowerCommanderコマンドを実行できない場合は、実行ポリシーを設定する必要があると考えられます。以下のコマンドを実行して確認します。

PS> Get-ExecutionPolicy -List

すると、以下のようなリストが表示されます。

        Scope ExecutionPolicy
        ----- ---------------
MachinePolicy       Undefined
   UserPolicy       Undefined
      Process       Undefined
  CurrentUser       Undefined
 LocalMachine       Undefined

インストールの「Scope」が「Undefined」または「Restricted」の場合は、以下のコマンドを使用して「Unrestricted」に設定します。

PS> Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser

上の例では、CurrentUserのスコープを設定しています。

PowerCommanderのコマンド

コマンドレット

コマンドレット名	エイリアス	説明
Connect-Keeper	kc	Keeperサーバーにログインします
Sync-Keeper	ks	Keeperサーバーと同期します
Disconnect-Keeper		ログアウトしてデータを消去します
Get-KeeperLocation	kpwd	現在のKeeperフォルダを表示します
Set-KeeperLocation	kcd	Keeperフォルダを変更します
Get-KeeperChildItems	kdir	現在のKeeperフォルダのサブフォルダ名とレコード名を表示します
Get-KeeperObject	ko	UIDによってKeeperオブジェクトを取得します
Get-KeeperRecord	kr	すべてのレコードを列挙します
Get-KeeperSharedFolder	ksf	すべての共有フォルダを列挙します
Add-KeeperRecord	kadd	Keeperのレコードを追加/変更します
Remove-KeeperRecord	kdel	Keeperのレコードを削除します
Move-RecordToFolder	kmv	レコードをKeeperフォルダに移動します
Add-KeeperFolder	kmkdir	Keeperフォルダを作成します
Remove-KeeperFolder	krmdir	Keeperフォルダを削除します
Copy-KeeperToClipboard	kcc	レコードのパスワードをクリップボードにコピーします
Show-TwoFactorCode	2fa	二要素コードを表示します
Copy-KeeperFileAttachment	kda	添付ファイルをダウンロードします
Copy-KeeperFileAttachmentToStream		添付ファイルをストリームにダウンロードします
Copy-FileToKeeperRecord		添付ファイルをレコードにアップロードします
Get-KeeperInformation	kwhoami	アカウントライセンス情報を表示します
Get-KeeperDeviceSettings		現在のデバイス設定を表示します
Set-KeeperDeviceSettings	this-device	現在のデバイス設定を変更します

コマンドレット名

エイリアス

説明

Connect-Keeper

Keeperサーバーにログインします

Sync-Keeper

Keeperサーバーと同期します

Disconnect-Keeper

ログアウトしてデータを消去します

Get-KeeperLocation

kpwd

現在のKeeperフォルダを表示します

Set-KeeperLocation

kcd

Keeperフォルダを変更します

Get-KeeperChildItems

kdir

現在のKeeperフォルダのサブフォルダ名とレコード名を表示します

Get-KeeperObject

UIDによってKeeperオブジェクトを取得します

Get-KeeperRecord

すべてのレコードを列挙します

Get-KeeperSharedFolder

ksf

すべての共有フォルダを列挙します

Add-KeeperRecord

kadd

Keeperのレコードを追加/変更します

Remove-KeeperRecord

kdel

Keeperのレコードを削除します

Move-RecordToFolder

kmv

レコードをKeeperフォルダに移動します

Add-KeeperFolder

kmkdir

Keeperフォルダを作成します

Remove-KeeperFolder

krmdir

Keeperフォルダを削除します

Copy-KeeperToClipboard

kcc

レコードのパスワードをクリップボードにコピーします

Show-TwoFactorCode

2fa

二要素コードを表示します

Copy-KeeperFileAttachment

kda

添付ファイルをダウンロードします

Copy-KeeperFileAttachmentToStream

添付ファイルをストリームにダウンロードします

Copy-FileToKeeperRecord

添付ファイルをレコードにアップロードします

Get-KeeperInformation

kwhoami

アカウントライセンス情報を表示します

Get-KeeperDeviceSettings

現在のデバイス設定を表示します

Set-KeeperDeviceSettings

this-device

現在のデバイス設定を変更します

共有コマンドレット

コマンドレット名	エイリアス	説明
Show-KeeperRecordShare	kshrsh	レコード共有情報を表示します
Grant-KeeperRecordAccess	kshr	ユーザーとレコードを共有します
Revoke-KeeperRecordAccess	kushr	ユーザーからレコード共有を削除します
Move-KeeperRecordOwnership	ktr	レコードの所有権をユーザーに譲渡します
Grant-KeeperSharedFolderAccess	kshf	共有フォルダにユーザーまたはチームを追加します
Revoke-KeeperSharedFolderAccess	kushf	共有フォルダからユーザーまたはチームを削除します
Get-KeeperAvailableTeam	kat	利用可能なチームを取得します
Get-KeeperOneTimeShare	kotsg	レコードのワンタイム共有を取得します
New-KeeperOneTimeShare	kotsn	ワンタイムシェアを作成します
Remove-KeeperOneTimeShare	kotsr	ワンタイムシェアを削除します

コマンドレット名

エイリアス

説明

Show-KeeperRecordShare

kshrsh

レコード共有情報を表示します

Grant-KeeperRecordAccess

kshr

ユーザーとレコードを共有します

Revoke-KeeperRecordAccess

kushr

ユーザーからレコード共有を削除します

Move-KeeperRecordOwnership

ktr

レコードの所有権をユーザーに譲渡します

Grant-KeeperSharedFolderAccess

kshf

共有フォルダにユーザーまたはチームを追加します

Revoke-KeeperSharedFolderAccess

kushf

共有フォルダからユーザーまたはチームを削除します

Get-KeeperAvailableTeam

kat

利用可能なチームを取得します

Get-KeeperOneTimeShare

kotsg

レコードのワンタイム共有を取得します

New-KeeperOneTimeShare

kotsn

ワンタイムシェアを作成します

Remove-KeeperOneTimeShare

kotsr

ワンタイムシェアを削除します

エンタープライズコマンドレット

コマンドレット名	エイリアス	説明
Sync-KeeperEnterprise	ked	Keeperエンタープライズ情報を同期します
Get-KeeperEnterpriseNode	ken	すべてのエンタープライズノードを列挙します
Get-KeeperEnterpriseUser	keu	すべてのエンタープライズユーザーを列挙します
Get-KeeperEnterpriseTeam	ket	すべてのエンタープライズチームを列挙します
Get-KeeperEnterpriseTeamUser	ketu	チームのエンタープライズユーザーのリストを取得します
New-KeeperEnterpriseNode	kena	ノードを作成します (新規)
Add-KeeperEnterpriseUser	invite-user	ユーザーをエンタープライズに招待します (新規)
Lock-KeeperEnterpriseUser	lock-user	エンタープライズユーザーをロックします
Unlock-KeeperEnterpriseUser	unlock-user	エンタープライズユーザーのロックを解除します
Move-KeeperEnterpriseUser	transfer-user	ユーザーアカウントを別のユーザーに移管します
Remove-KeeperEnterpriseUser	delete-user	エンタープライズユーザーを削除します
Get-KeeperEnterpriseRole	ker	すべてのエンタープライズロールを列挙します (新規)
Get-KeeperMspLicenses	msp-license	MSPライセンスを返却します
Switch-KeeperMC	switch-to-mc	管理会社へ切り替えます (新規)
Switch-KeeperMSP	switch-to-msp	MSP に戻ります (新規)
Get-KeeperManagedCompany	kmc	エンタープライズ管理会社をすべて列挙します
New-KeeperManagedCompany	kamc	管理会社を作成します
Remove-KeeperManagedCompany	krmc	管理対象会社を削除します
Edit-KeeperManagedCompany	kemc	管理対象会社を編集します
Get-MspBillingReport		MSP請求レポートを実行します

コマンドレット名

エイリアス

説明

Sync-KeeperEnterprise

ked

Keeperエンタープライズ情報を同期します

Get-KeeperEnterpriseNode

ken

すべてのエンタープライズノードを列挙します

Get-KeeperEnterpriseUser

keu

すべてのエンタープライズユーザーを列挙します

Get-KeeperEnterpriseTeam

ket

すべてのエンタープライズチームを列挙します

Get-KeeperEnterpriseTeamUser

ketu

チームのエンタープライズユーザーのリストを取得します

New-KeeperEnterpriseNode

kena

ノードを作成します (新規)

Add-KeeperEnterpriseUser

invite-user

ユーザーをエンタープライズに招待します (新規)

Lock-KeeperEnterpriseUser

lock-user

エンタープライズユーザーをロックします

Unlock-KeeperEnterpriseUser

unlock-user

エンタープライズユーザーのロックを解除します

Move-KeeperEnterpriseUser

transfer-user

ユーザーアカウントを別のユーザーに移管します

Remove-KeeperEnterpriseUser

delete-user

エンタープライズユーザーを削除します

Get-KeeperEnterpriseRole

ker

すべてのエンタープライズロールを列挙します (新規)

Get-KeeperMspLicenses

msp-license

MSPライセンスを返却します

Switch-KeeperMC

switch-to-mc

管理会社へ切り替えます (新規)

Switch-KeeperMSP

switch-to-msp

MSP に戻ります (新規)

Get-KeeperManagedCompany

kmc

エンタープライズ管理会社をすべて列挙します

New-KeeperManagedCompany

kamc

管理会社を作成します

Remove-KeeperManagedCompany

krmc

管理対象会社を削除します

Edit-KeeperManagedCompany

kemc

管理対象会社を編集します

Get-MspBillingReport

MSP請求レポートを実行します

シークレットマネージャーコマンドレット

コマンドレット名	エイリアス	説明
Get-KeeperSecretManagerApp	ksm	すべてのKeeperシークレットマネージャーアプリケーションを列挙します
Add-KeeperSecretManagerApp	ksm-create	Keeperシークレットマネージャーアプリケーションを追加します
Grant-KeeperSecretManagerFolderAccess	ksm-share	KSMアプリケーションに共有フォルダを追加します
Revoke-KeeperSecretManagerFolderAccess	ksm-unshare	KSM アプリケーションから共有フォルダを削除します
Add-KeeperSecretManagerClient	ksm-addclient	KSMアプリケーションにクライアント/デバイスを追加します
Remove-KeeperSecretManagerClient	ksm-rmclient	KSMアプリケーションからクライアント/デバイスを削除します

コマンドレット名

エイリアス

説明

Get-KeeperSecretManagerApp

ksm

すべてのKeeperシークレットマネージャーアプリケーションを列挙します

Add-KeeperSecretManagerApp

ksm-create

Keeperシークレットマネージャーアプリケーションを追加します

Grant-KeeperSecretManagerFolderAccess

ksm-share

KSMアプリケーションに共有フォルダを追加します

Revoke-KeeperSecretManagerFolderAccess

ksm-unshare

KSM アプリケーションから共有フォルダを削除します

Add-KeeperSecretManagerClient

ksm-addclient

KSMアプリケーションにクライアント/デバイスを追加します

Remove-KeeperSecretManagerClient

ksm-rmclient

KSMアプリケーションからクライアント/デバイスを削除します

コマンドの追加

PowerShellモジュールにはお客様からのリクエストに応じてKeeperコマンダー (Python) の機能を追加しておりますので、すべての機能が追加されているわけではありません。ご要望などございましたら、弊社のエンジニアリングチーム (commander@keepersecurity.com) までご連絡ください。

例

Keeperアカウントに接続します。

PS > Connect-Keeper
     Keeper Username: email_address@company.com
        ...Password:

Keeperフォルダの内容を一覧表示します。

PS > kdir

    Vault Folder: \


Mode    UID                      Name
----    ---                      ----
f-----  b3TMAYfOWJqNxeLjlA6v_g   dasdasd
f----S  BvHeHGkdRJfhGaRcI-J5Ww   shared
-r-AO-  5qx_urh2EsrL0wBdi34nFw   Web
-r---S  ktY3jEBqwFDi9UYZSxmIpw   Control

f - フォルダ
r - レコード
S - 共有
A - ファイル添付
O - 所有者

現在のKeeperフォルダ内のすべてのレコードの二要素コードを表示します。

PS > kdir -ObjectType Record | Show-TwoFactorCode

ボルト内のすべてのレコードの二要素コードを表示します。

PS > kr|2fa

krはGet-KeeperRecordsのエイリアスです。
2faはShow-TwoFactorCodeのエイリアスです

レコードのパスワードをクリップボードにコピーします。

PS>'contro'|kcc

controはレコードタイトルの部分文字列です。上記のkdir 出力の最後のエントリをご参照ください。
kccはCopy-KeeperToClipboardのエイリアスです。

または

PS > 'ktY3jEBqwFDi9UYZSxmIpw' | kcc

'ktY3jEBqwFDi9UYZSxmIpw'は同じレコードのレコードUIDです。

Keeperのレコードを追加/変更します。

PS > kadd -Login email@company.com -GeneratePassword -URL https://company.com -Custom 'Name:John Doe' 'Record for John Doe'

Keeperのレガシーレコードを作成します。

PS > kadd -RecordType login -Title 'Record for John Doe' -GeneratePassword login=email@company.com url=https://company.com 'User Name=John Doe'

Keeperでloginタイプのレコードを作成します。

PS > $address = @{"street1" = "123 Main St."; "city" = "Neitherville"; "state" = "CA"; "zip" = "12345"}
PS > kadd -RecordType address -Title 'Home Address' -address $address phone.Home='(555)123-4567' name="Doe, John"

PS > kadd -Uid <RECORD UID> -GeneratePassword

既存のレコードに新しいパスワードを生成します。

レガシーレコードとタイプのあるレコードの両方でサポートされる定義済みフィールド

loginログイン
passwordパスワード
urlウェブサイトアドレス

所有レコードをフォルダにコピーします。

PS > Get-KeeperChildItem -ObjectType Record | Move-RecordToFolder 'Shared Folder'

現在のKeeperフォルダ内のすべてのレコードを「Shared Folder」という名前のフォルダにコピーします。

すべてのエンタープライズユーザーを一覧表示します。

PS > Get-KeeperEnterpriseUser

新しい管理会社を作成します。

PS> New-KeeperManagedCompany -Name "Company Name" -PlanId enterprisePlus -Allocated 5

新しい管理会社に切り替えます。

PS> switch-to-mc "Company Name"