AdminTask オブジェクトの KeySetCommands コマンド・グループ
Jython または Jacl スクリプト言語を使用すると、wsadmin ツールでセキュリティーを構成することができます。KeySetCommands グループの コマンドおよびパラメーターは、構成内の鍵セット設定の作成、削除、 および照会に使用できます。
AdminTask オブジェクトの KeySetCommands コマンド・グループには、以下のコマンドが含まれます。
createKeySet
createKeySet コマンドは、 構成に鍵セット設定を作成します。 このコマンドを使用すると、同じタイプを持つ鍵インスタンスを制御できます。
ターゲット・オブジェクト
なし。必須パラメーター
- -name
- 鍵セットを一意的に識別する名前を指定します。(ストリング、必須)
- -aliasPrefix
- 新規の鍵が生成されるときの鍵別名の接頭部を指定します。 (ストリング、必須)
- -password
- 鍵ストアで鍵を保護するパスワードを指定します。(ストリング、必須)
- -maxKeyReferences
- 対象の鍵セットの、戻された鍵からの鍵参照の最大数を指定します。(整数、必須)
- -keyStoreName
- 鍵を含む鍵ストアを指定します。(ストリング、必須)
オプション・パラメーター
- -scopeName
- 管理有効範囲の固有名を指定します。(ストリング、オプション)
- -deleteOldKeys
- 新規の鍵が生成されたときに古い鍵を削除するためには、このパラメーターの値を true に設定します。 それ以外の場合は、このパラメーターの値を false に設定します。 (ブール値、オプション)
- -keyGenerationClass
- 鍵セットで新規の鍵の生成に使用されるクラスを指定します。 (ストリング、オプション)
- -keyStoreScopeName
- 鍵ストアが置かれる管理有効範囲を指定します。(ストリング、オプション)
- -isKeyPair
- 鍵セットの鍵が鍵ペアである場合、このパラメーターの値を true に設定します。 それ以外の場合は、このパラメーターの値を false に設定します。 (ブール値、オプション)
出力例
コマンドにより、作成した鍵セット・オブジェクトの構成オブジェクト名が戻されます。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask createKeySet {-name testKeySet –aliasPrefix test –password pwd –maxKeyReferences 2 –deleteOldKeys true –keyStoreName testKeyStore –isKeyPair false}
- Jython ストリングを使用:
AdminTask.createKeySet('[-name testKeySet –aliasPrefix test –password pwd –maxKeyReferences 2 –deleteOldKeys true –keyStoreName testKeyStore –isKeyPair false]')
- Jython リストを使用:
AdminTask.createKeySet(['-name', 'testKeySet', '–aliasPrefix', 'test', '–password', 'pwd', '–maxKeyReferences', '2', '–deleteOldKeys', 'true', '–keyStoreName', 'testKeyStore', '–isKeyPair', 'false'])
対話モードの使用例:
- Jacl を使用:
$AdminTask createKeySet {-interactive}
- Jython ストリングを使用:
AdminTask.createKeySet ('[-interactive]')
- Jython リストを使用:
AdminTask.createKeySet (['-interactive'])
deleteKeySet
deleteKeySet コマンドは、 構成から鍵セットの設定を削除します。
ターゲット・オブジェクト
なし。必須パラメーター
- -name
- 鍵セットを一意的に識別する名前。(ストリング、必須)
オプション・パラメーター
- -scopeName
- 管理有効範囲の固有名を指定します。(ストリング、オプション)
出力例
このコマンドは出力を返しません。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask deleteKeySet{ -name testKeySet}
- Jython ストリングを使用:
AdminTask.deleteKeySet('[-name testKeySet]')
- Jython リストを使用:
AdminTask.deleteKeySet(['-name', 'testKeySet'])
対話モードの使用例:
- Jacl を使用:
$AdminTask deleteKeySet {-interactive}
- Jython ストリングを使用:
AdminTask.deleteKeySet ('[-interactive]')
- Jython リストを使用:
AdminTask.deleteKeySet (['-interactive'])
generateKeyForKeySet
generateKeyForKeySet コマンドは、 鍵セットで鍵の鍵を生成します。
ターゲット・オブジェクト
なし。必須パラメーター
- -keySetName
- 鍵セットの名前を指定します。(ストリング、必須)
オプション・パラメーター
- -keySetScope
- 鍵セットの有効範囲を指定します。(ストリング、オプション)
- -keySetSaveConfig
- 鍵セットの構成を保存するには、このパラメーターの値を true に設定します。 それ以外の場合は、このパラメーターの値を false に設定します。 (ブール値、オプション)
出力例
このコマンドは出力を返しません。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask generateKeyForKeySet{ -keySetName testKeySet }
- Jython ストリングを使用:
AdminTask.generateKeyForKeySet('[-keySetName testKeySet]')
- Jython リストを使用:
AdminTask.generateKeyForKeySet(['-keySetName', 'testKeySet'])
対話モードの使用例:
- Jacl を使用:
$AdminTask generateKeyForKeySet {-interactive}
- Jython ストリングを使用:
AdminTask.generateKeyForKeySet ('[-interactive]')
- Jython リストを使用:
AdminTask.generateKeyForKeySet (['-interactive'])
getKeySet
getKeySet コマンドは、特定の鍵セットの設定を表示します。
ターゲット・オブジェクト
なし。必須パラメーター
- -name
- 鍵セットを一意的に識別する名前を指定します。(ストリング、必須)
オプション・パラメーター
- -scopeName
- 管理有効範囲の固有名を指定します。(ストリング、オプション)
出力例
コマンドにより、指定された鍵セット・グループの設定が戻されます。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask getKeySet {-name testKeySet}
- Jython ストリングを使用:
AdminTask.getKeySet ('[-name testKeySet]')
- Jython リストを使用:
AdminTask.getKeySet (['-name', 'testKeySet'])
対話モードの使用例:
- Jacl を使用:
$AdminTask getKeySet {-interactive}
- Jython ストリングを使用:
AdminTask.getKeySet ('[-interactive]')
- Jython リストを使用:
AdminTask.getKeySet (['-interactive'])
listKeySets
listKeySets コマンドは、特定の有効範囲の鍵セットをリストします。
ターゲット・オブジェクト
なし。必須パラメーター
なし。オプション・パラメーター
- -scopeName
- 管理有効範囲の固有名を指定します。(ストリング、オプション)
- -displayObjectName
- 有効範囲内の鍵セット構成オブジェクトをリストするには、このパラメーターの値を true に設定します。 鍵セット・グループ名と管理有効範囲を含むストリングをリストする場合、 このパラメーターの値を false に設定します。 (ブール値、オプション)
- -all
- すべての鍵セットをリストするには、このパラメーターの値を true に指定します。 このパラメーターは、scopeName パラメーターをオーバーライドします。デフォルト値は false です。(ブール値、オプション)
出力例
コマンドにより、指定した有効範囲の鍵セットが戻されます。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask listKeySets {-displayObjectName true}
- Jython ストリングを使用:
AdminTask.listKeySets ('[-displayObjectName true]')
- Jython リストを使用:
AdminTask.listKeySets (['-displayObjectName', 'true'])
対話モードの使用例:
- Jacl を使用:
$AdminTask listKeySets {-interactive}
- Jython ストリングを使用:
AdminTask.listKeySets ('[-interactive]')
- Jython リストを使用:
AdminTask.listKeySets (['-interactive'])
modifyKeySet
modifyKeySet コマンドは、 既存の鍵セットの設定を変更します。
ターゲット・オブジェクト
なし。必須パラメーター
- -name
- 鍵セットを一意的に識別する名前を指定します。(ストリング、必須)
オプション・パラメーター
- -scopeName
- 管理有効範囲の固有名を指定します。(ストリング、オプション)
- -aliasPrefix
- 新規の鍵が生成されるときの鍵別名の接頭部を指定します。 (ストリング、オプション)
- -password
- 鍵ストアで鍵を保護するパスワードを指定します。(ストリング、オプション)
- -maxKeyReferences
- 対象の鍵セットの、戻された鍵からの鍵参照の最大数を指定します。(整数、オプション)
- -deleteOldKeys
- 新規の鍵が生成されたときに古い鍵を削除するためには、このパラメーターの値を true に設定します。 それ以外の場合は、このパラメーターの値を false に設定します。 (ブール値、オプション)
- -keyGenerationClass
- 鍵セットで新規の鍵の生成に使用されるクラスを指定します。 (ストリング、オプション)
- -keyStoreName
- 鍵を含む鍵ストアを指定します。(ストリング、オプション)
- -keyStoreScopeName
- 鍵ストアが置かれる管理有効範囲を指定します。(ストリング、オプション)
- -isKeyPair
- 鍵セットの鍵が鍵ペアである場合、このパラメーターの値を true に設定します。 それ以外の場合は、このパラメーターの値を false に設定します。 (ブール値、オプション)
出力例
このコマンドは出力を返しません。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask modifyKeySet {-name testKeySet -maxKeyReferences 3 –deleteOldKeys false}
- Jython ストリングを使用:
AdminTask.modifyKeySet ('[-name testKeySet -maxKeyReferences 3 –deleteOldKeys false]')
- Jython リストを使用:
AdminTask.modifyKeySet (['-name', 'testKeySet', '-maxKeyReferences', '3', '–deleteOldKeys', 'false'])
対話モードの使用例:
- Jacl を使用:
$AdminTask modifyKeySet {-interactive}
- Jython ストリングを使用:
AdminTask.modifyKeySet ('[-interactive]')
- Jython リストを使用:
AdminTask.modifyKeySet (['-interactive'])