レコードタイプに関するコマンド

レコードタイプとカスタムテンプレートを作成および管理するためのコマンド

本ページでは、レコードタイプに関連するコマンドをご紹介します。使用例などレコードタイプの詳細については、以下のページをご参照ください。

レコードタイプの作成

コマンド

Keeperコマンドリファレンス

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

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

help <command>

レコードタイプに関連する全コマンド

コマンド説明

レコードタイプを一覧表示するか、特定のレコードタイプに関する情報を表示します

カスタムのレコードタイプを追加、編集、削除します

従来のレコードをレコードタイプ型のレコードに変換します

record-type-infoコマンド

コマンド: record-type-infoまたはrti

詳細: 使用可能なレコードタイプを一覧表示するか、または特定のレコードタイプの詳細を表示します

スイッチ:

-lr--list-record <レコードタイプかID (オプション)>

  • レコードタイプ名またはIDが指定されていない場合は、すべてのレコードタイプ名とIDが一覧表示されます

  • レコードタイプ名またはIDが指定されている場合は、レコードタイプの詳細情報とフィールドが表示されます

-lf, --list-field <FIELD NAME> 指定したフィールドタイプに関する情報を表示します。「*」を使用してすべてのフィールドを表示できます。

-e--example レコードタイプまたはフィールドのjsonサンプルを生成します。-lrまたは-lfと一緒に使用する必要があります

--syntax-help レコードタイプのパラメータに関する拡張ヘルプを表示します

--format <{csv, json, table}> 出力形式を選択します

--output <出力ファイル> 指定したファイルに結果を出力します。*表形式が使用されている場合は無視されます

例:

rti
rti -lr login
rti -lf name
rti -lf *
rti -lr passport -e
rti --syntax-help
rti --output logs/record-types.csv --format csv
  1. レコードタイプの一覧を表示します

  2. ログインレコードタイプの詳細を表示します

  3. 名前フィールドタイプの詳細を表示します

  4. すべてのフィールドタイプの詳細を表示します

  5. パスポートレコードタイプの例を表示します

  6. 構文の拡張ヘルプテキストを表示します

  7. レコードタイプ情報をCSVとしてファイルに書き込みます

record-typeコマンド

コマンド: record-typeまたはrt

詳細: カスタムのレコードタイプを追加、変更、削除します

パラメータ:

レコードタイプID (更新または削除の場合)

スイッチ:

-a--action <{add, update, remove}> 実行する操作

  • add - 新しいカスタムのレコードタイプを作成します

  • update - 既存のカスタムのレコードタイプを変更します

  • remove - 既存のカスタムのレコードタイプを削除します

--data <DATA> レコードタイプのJSON形式の定義

形式:

レコードタイプは以下の書式設定を利用します。

    { "$id": <record type name>,
     "fields": [ 
       { "$ref": <field type>},
       { "$ref": <field type>, "label": <foeld label(optional)>, required: <true/false (optional) }
      ] }

例:

{
   "$id":"My Record Type",
   "fields": [
      {
        "$ref":"login",
        "label":"AppLogin",
        "required":true
      },
      {
        "$ref":"name",
        "label":"Your name"
      },
      {
        "$ref":"address",
        "required":true
      }
    ]
}
  • すべてのフィールドタイプの一覧はこちらをご参照ください

  • 使用可能なフィールドタイプの一覧を表示するには、次のコマンドを使用します。rti -lf *

例:

rt --action add --data '{"$id":"My Record Type", "fields": [{"$ref":"login","label":"AppLogin","required":true},{"$ref":"name","label":"Your name"},{"$ref":"address","required":true}]}'
rt 102 -a update --data '{"$id":"My Record Type", "fields": [{"$ref":"login","label":"AppLogin","required":true},{"$ref":"name","label":"Your name"}]}'
rt 102 -a remove
  1. 「My Record Type」という名前の新しいレコードタイプを追加します

  2. 「My Record Type」レコードタイプ (この例ではIDが102) を更新します。 ここでは、「Address」フィールドが削除されました

  3. IDが102のレコードタイプを削除します

convertコマンド

バージョン: v16.5.9以降

コマンド: convert

詳細: 従来の (一般的なタイプ指定された、またはタイプ指定されていない) レコードをタイプ指定されたレコードに変換します。

convertコマンドは、タイプ指定されていない従来のレコードをタイプ指定されたレコードに変換するだけです。

タイプ指定されたレコードのタイプを変換するには、record-updateコマンドを使用します。

パラメータ:

現在のフォルダ内のレコードに一致するパターン。 UIDとタイトルを照合します。任意の1文字に一致する「?」と任意の数の文字に一致する「*」を使用できます

スイッチ:

-t--record-type <RECORD TYPE OR ID > レコードの変換先のタイプ

-q--quiet 一致および変換されたレコードの情報を表示しません

-u, --url <URL Pattern> 指定したパターンに一致するURLを持つレコードのみを変換します。 任意の1文字に一致する「?」と任意の数の文字に一致する「*」を使用できます

-n--dry-run レコードは一切変換せずに変換結果を表示します

-r--recursive 現在のフォルダと子フォルダのすべての一致するレコードに変換を適用します

--ignore-ownership 現在のアカウントが所有していないレコードでも変換します

例:

convert Dtvb84zwkBmZgxrUByUfpg --record-type login
convert * --record-type login --recursive --dry-run
convert * -t login -r
convert *sql* -t databaseCredentials 
convert *ssh-? -t sshKeys --recursive
  1. 指定したUIDを持つタイプ指定されていないレコードをログインレコードタイプに変換します

  2. ボルト内のすべてのレコードの変換のドライランを実行し、変換されるレコードを表示します (ルートディレクトリで実行すると、すべてのレコードに一致します)。

  3. ボルト内のタイプ指定されていないすべてのレコードをログインタイプに変換します (ルートディレクトリで実行した場合)

  4. 名前に「sql」を含むタイプ指定されていないレコードをデータベースクレデンシャルに変換します

  5. ssh-<任意の文字>で終わるすべてのレコードをsshKeyタイプのレコードに変換します

    1. 例: 「Github ssh-1」というタイトルのレコードと「Github ssh-2」というタイトルのレコードを変換します

最終更新