UNIX ターゲット コネクタ外部 API の設定

capam344
このトピックでは、外部 API を使用して UNIX (別名 UNIXII)ターゲット アプリケーションを追加または更新するときに使用される必須およびサポートされている属性について説明します。

UNIX ターゲット アプリケーション外部 API 属性

外部 API を使用して UNIX ターゲット アプリケーションを追加または更新するには、REST コールの「body」パラメータに含まれる「attributes」連想配列のメンバとして、以下のプロパティを使用します。
extensionType
必須
デフォルト値
有効な値
いいえ
該当なし
unixII
sshPort
SSH を使用した UNIX ホストへの接続に使用されるポートです。
必須
デフォルト値
有効な値
いいえ
22
0 ~ 65535
sshSessionTimeout
SSH 通信チャネルを使用する場合に、認証情報マネージャがリモート ホストの応答を待機する時間をミリ秒単位で指定します。
必須
デフォルト値
有効な値
いいえ
5000
1000 ~ 99999
sshKeyPairPolicyID
キーの生成方法、つまり、キーのタイプ(ECDSA、RSA または DSA)と長さを制御する SSH キー ポリシー ID を指定します。
必須
デフォルト値
有効な値
いいえ
該当なし
0 ~ 9
sshStrictHostKeyCheckingEnabled
厳密なホスト キーの確認を有効または無効にします。このパラメータを有効にすると、認証情報マネージャによってリモート ホストからの公開キーが
sshKnownHostKey
属性に保存されている公開キーと比較された後に、接続が確立します。キーが一致しない場合、接続の試行はキャンセルされます。
必須
デフォルト値
有効な値
いいえ
false
true、false
sshKnownHostKey
base-64 でエンコードされて、ターゲット サーバに関連付けられたパブリック ホスト キーを含みます。
必須
デフォルト値
有効な値
sshStrictHostKeyCheckingEnabled
が true の場合は「はい」
該当なし
base-64 でエンコードされた SSH パブリック ホスト キー
sshKnownHostKeyFingerprint
sshKnownHostKey
属性に含まれるパブリック ホスト キーのフィンガープリントが含まれます。フィンガープリントは、表示専用です。これを使用すると、1 つのキーを別のキーと比較することが容易にできるようになります。指定されたフィンガープリントは、指定されたパブリック ホスト キーに対応する必要があります。
必須
デフォルト値
有効な値
いいえ
該当なし
パブリック キーのフィンガープリント
sshUseDefaultCiphers
認証情報マネージャがリモート ホストへの SSH 接続を行う際に、デフォルトの暗号を使用するかどうかを指定します。
必須
デフォルト値
有効な値
いいえ
true
true、false
sshServerToClientCiphersList
リモート ホストからの受信データ ストリームで、受け入れる暗号のリストを指定します。暗号は、優先度の順に表示されます。
必須
デフォルト値
有効な値
sshUseDefaultCiphers
が false の場合は「はい」
aes128-ctr、aes128-cbc、3des-ctr、3des-cbc、blowfish-cbc、aes192-cbc、aes256-cbc
以下の値を 1 つ以上含むカンマ区切りのリスト: aes256-ctr、aes192-ctr、aes128-ctr、aes256-cbc、aes192-cbc、aes128-cbc、3des-ctr、arcfour、arcfour128、arcfour256。リストではスペースを使用しないでください。
sshClientToServerCiphersList
リモート ホストへの送信データ ストリームで、使用する暗号のリストを指定します。暗号は、優先度の順に表示されます。
必須
デフォルト値
有効な値
sshUseDefaultCiphers
が false の場合は「はい」
aes128-ctr、aes128-cbc、3des-ctr、3des-cbc、blowfish-cbc、aes192-cbc、aes256-cbc
以下の値を 1 つ以上含むカンマ区切りのリスト: aes256-ctr、aes192-ctr、aes128-ctr、aes256-cbc、aes192-cbc、aes128-cbc、3des-ctr、arcfour、arcfour128、arcfour256。リストではスペースを使用しないでください。
sshDetectCiphersList
リモート ホストに接続する際に、検出する暗号のリストを指定します。認証情報マネージャは、受信や送信の暗号として使用することが指定されている場合でも、使用不可能な暗号は使用しません。暗号は、優先度の順に表示されます。
必須
デフォルト値
有効な値
sshUseDefaultCiphers
が false の場合は「はい」
aes128-ctr、aes128-cbc、3des-ctr、3des-cbc、blowfish-cbc、aes192-cbc、aes256-cbc
以下の値を 1 つ以上含むカンマ区切りのリスト: aes256-ctr、aes192-ctr、aes128-ctr、aes256-cbc、aes192-cbc、aes128-cbc、3des-ctr、arcfour、arcfour128、arcfour256。リストではスペースを使用しないでください。
sshUseDefaultHashes
認証情報マネージャがリモート ホストへの SSH 接続を行う際に、デフォルトのハッシュを使用するかどうかを指定します。
必須
デフォルト値
有効な値
いいえ
true
true、false
sshServerToClientHashesList
リモート ホストからの受信データ ストリームで、受け入れるハッシュのリストを指定します。ハッシュは、優先度の順に表示されます。
必須
デフォルト値
有効な値
sshUseDefaultHashes
が false の場合は「はい」
hmac-md5、hmac-sha1、hmac-sha1-96、hmac-md5-96
以下の値を 1 つ以上含むカンマ区切りのリスト: hmac-md5、hmac-sha1、hmac-sha1-96、hmac-md5-96。リストではスペースを使用しないでください。
sshClientToServerHashesList
リモート ホストからの送信データ ストリームで、受け入れるハッシュのリストを指定します。ハッシュは、優先度の順に表示されます。
必須
デフォルト値
有効な値
sshUseDefaultHashes
が false の場合は「はい」
hmac-md5、hmac-sha1、hmac-sha1-96、hmac-md5-96
以下の値を 1 つ以上含むカンマ区切りのリスト: hmac-md5、hmac-sha1、hmac-sha1-96、hmac-md5-96。リストではスペースを使用しないでください。
sshUseDefaultKeyExchangeAlgorithms
認証情報マネージャがリモート ホストへの SSH 接続を行う際に、デフォルトのキー交換方法を使用するかどうかを指定します。
必須
デフォルト値
有効な値
いいえ
true
true、false
sshKeyExchangeAlgorithmsList
リモート ホストに接続する際に、使用するキー交換方法のリストを指定します。方法は、優先度の順に表示されます。
必須
デフォルト値
有効な値
sshUseDefaultKeyExchangeAlgorithms
が false の場合は「はい」
diffie-hellman-group1-sha1、diffie-hellman-group14-sha1、diffie-hellman-group-exchange-sha1
以下の値を 1 つ以上含むカンマ区切りのリスト: diffie-hellman-group1-sha1、diffie-hellman-group14-sha1、diffie-hellman-group-exchange-sha1。リストではスペースを使用しないでください。
sshUseDefaultCompressionAlgorithms
認証情報マネージャがリモート ホストへの SSH 接続を行う際に、デフォルトの圧縮方法を使用するかどうかを指定します。
必須
デフォルト値
有効な値
いいえ
true
true、false
sshServerToClientCompressionAlgorithmsList
リモート ホストからの受信データ ストリームで、受け入れる圧縮方法のリストを指定します。方法は、優先度の順に表示されます。
必須
デフォルト値
有効な値
sshUseDefaultCompressionAlgorithms
が false の場合は「はい」
該当なし。圧縮を使用しない
次の値を 1 つ以上含むカンマ区切りのリスト: zlib、[email protected]。リストではスペースを使用しないでください。
sshClientToServerCompressionAlgorithmsList
リモート ホストからの送信データ ストリームで、使用する圧縮方法のリストを指定します。方法は、優先度の順に表示されます。
必須
デフォルト値
有効な値
sshUseDefaultCompressionAlgorithms
が false の場合は「はい」
該当なし(圧縮を使用しない)
次の値を 1 つ以上含むカンマ区切りのリスト: zlib、[email protected]。リストではスペースを使用しないでください。
sshUseDefaultServerHostKeyAlgorithms
認証情報マネージャがリモート ホストへの SSH 接続を行う際に、デフォルトのホスト キー タイプを受け入れて、使用するかどうかを指定します。
必須
デフォルト値
有効な値
いいえ
true
true、false
sshServerHostKeyAlgorithmsList
認証情報マネージャがリモート ホストに接続する際に、受け入れるホスト キー タイプのリストを指定します。
必須
デフォルト値
有効な値
sshUseDefaultServerHostKeyAlgorithms
が false の場合は「はい」
ssh-rsa、ssh-dss
以下の値を 1 つ以上含むカンマ区切りのリスト: ssh-rsa、ssh-dss。リストではスペースを使用しないでください。
telnetSessionTimeout
Telnet 通信チャネルを使用する場合に、認証情報マネージャがリモート ホストの応答を待機する時間をミリ秒単位で指定します。
必須
デフォルト値
有効な値
いいえ
5000
1000 ~ 99999
telnetPort
Telnet を使用した UNIX ホストへの接続に使用されるポートです。
必須
デフォルト値
有効な値
いいえ
23
0 ~ 65536
scriptTimeout
認証情報マネージャがリモート ホストからの予期される入力の受信を待機する時間をミリ秒単位で指定します。
必須
デフォルト値
有効な値
いいえ
5000
5000 ~ 59999
unixVariant
ターゲット サーバにインストールされている UNIX システムのタイプを指定します。
必須
デフォルト値
有効な値
いいえ
GENERIC
AIX、GENERIC、HPUX、LINUX、SOLARIS、または OTHER。
useUpdateScriptType
デフォルト、改訂または置換更新スクリプトを使用するかどうかを指定します。改訂スクリプトが必要な場合は、デフォルト スクリプトを使用し、CA Services にお問い合わせください。
必須
デフォルト値
有効な値
いいえ
'DEFAULT'
'DEFAULT'、'REVISED' または 'REPLACEMENT'
revisedUpdateScriptFilename
改訂された更新スクリプトを含むファイルの名前を指定します。ファイルの内容は改訂スクリプトとして使用されます。デフォルト スクリプトを使用し、改訂スクリプトが必要な場合には CA Services に問い合わせることをお勧めします。
必須
デフォルト値
有効な値
いいえ
該当なし
ファイル名
useVerifyScriptType
デフォルト、改訂または置換検証スクリプトを使用するかどうかを指定します。改訂スクリプトが必要な場合は、デフォルト スクリプトを使用し、CA Services にお問い合わせください。
必須
デフォルト値
有効な値
いいえ
'DEFAULT'
'DEFAULT'、'REVISED' または 'REPLACEMENT'
revisedVerifyScriptFilename
改訂された検証スクリプトが含まれるファイルの名前を指定します。ファイルの内容は改訂スクリプトとして使用されます。デフォルト スクリプトを使用し、改訂スクリプトが必要な場合には CA Services に問い合わせることをお勧めします。
必須
デフォルト値
有効な値
いいえ
該当なし
ファイル名
userNameEntryPrompt
ユーザ名をリクエストするときに、リモート ホストのプロンプトと照合する正規表現です。
必須
デフォルト値
有効な値
いいえ
(?si).*?(login|username):.*?
有効な正規表現の構文
passwordEntryPrompt
パスワードをリクエストするときに、リモート ホストのプロンプトと照合する正規表現です。
必須
デフォルト値
有効な値
いいえ
(?si)(.*?password(\sfor|:).*?)
有効な正規表現の構文
passwordConfirmationPrompt
パスワードの確認をリクエストするときに、リモート ホストからのプロンプトと照合する正規表現です。
必須
デフォルト値
有効な値
いいえ
AIX: (?si).*?new password.*?
その他のすべてのプラットフォーム: (?si).*?password:.*?)
有効な正規表現の構文
passwordChangePrompt
期限切れによりパスワードを変更することをリクエストするときに、リモート ホストのプロンプトと照合する正規表現です。
必須
デフォルト値
有効な値
いいえ
(?si).*?change your password.*?
有効な正規表現の構文
changePasswordCommand
パスワードの変更に使用される、リモート ホスト上のコマンドです。
必須
デフォルト値
有効な値
いいえ
passwd
リモート ホストに依存
elevatePrivilegeCommand
ユーザの権限レベルを昇格させるために使用される、リモート ホスト上のコマンドです。
必須
デフォルト値
有効な値
いいえ
sudo
リモート ホストに依存
substituteUserCommand
別のユーザとしてのアクションに使用される、リモート ホスト上のコマンドです。
必須
デフォルト値
有効な値
いいえ
su
リモート ホストに依存
echoCommand
標準出力、つまりコンソールへの一連の文字の繰り返しに使用される、リモート ホスト上のコマンドです。
必須
デフォルト値
有効な値
いいえ
echo
リモート ホストに依存
patternMatchingCommand
パターンに一致する行を出力する、リモート ホスト上のコマンドです。
必須
デフォルト値
有効な値
いいえ
grep
リモート ホストに依存
policyManagementCommand
ポリシーの管理に使用される、リモート ホスト上のコマンドです。
必須
デフォルト値
有効な値
いいえ
AIX: pwdadm
その他のすべてのプラットフォーム: 該当なし
リモート ホストに依存
whoAmICommand
現在ログインしているユーザの実効 ID の取得に使用される、リモート ホスト上のコマンドです。
必須
デフォルト値
有効な値
いいえ
whoami
リモート ホストに依存
changeFilePermissionsCommand
ファイルに対する権限の変更に使用される、リモート ホスト上のコマンドです。
必須
デフォルト値
有効な値
いいえ
chmod
リモート ホストに依存

UNIX ターゲット アカウント外部 API 属性

ターゲット コネクタを使用する UNIX ターゲット アカウントを追加するには、REST コールの「body」パラメータに含まれる「attributes」連想配列のメンバとして、以下のプロパティを使用します。
useOtherAccountToChangePassword
ターゲット アカウントを更新する際に、ターゲット アカウントまたは別のアカウントを使用するかどうかを指定します。
必須
デフォルト値
有効な値
はい
false
true、false
otherAccount
ターゲット アカウントを更新する際に使用する他のアカウントを指定します。
必須
デフォルト値
有効な値
useOtherAccountToChangePassword
が true の場合は「はい」。
該当なし
有効なターゲット アカウント ID。
verifyThroughOtherAccount
ターゲット アカウントを検証する際に、リモート ホストに対する認証に、2 番目のターゲット アカウントの認証情報を使用するかどうかを指定します。
必須
デフォルト値
有効な値
useOtherAccountToChangePassword
が true の場合は「はい」。
false
true、false
passwordChangeMethod
パスワードを更新する際に使用する方法を指定します。認証されたユーザに対し、リモート ホスト上のポリシー(最短のパスワード更新間隔など)に影響されることなく昇格された権限を取得することを可能にする方法を選択することが必要になる場合があります。
必須
デフォルト値
有効な値
useOtherAccountToChangePassword
が false の場合は「はい」。
DO_NOT_USE_SUDO
DO_NOT_USE_SUDO、USE_SUDO、IS_ROOT_ACCOUNT、USE_AUTHENTICATED_SUDO
protocol
リモート ホストと通信するために使用するプロトコルを指定します。
必須
デフォルト値
有効な値
useOtherAccountToChangePassword
が false の場合は「はい」
SSH2_PASSWORD_AUTH
SSH2_PASSWORD_AUTH、SSH2_PUBLIC_KEY_AUTH、TELNET
passphrase
秘密キーを保護するパスフレーズ。
必須
デフォルト値
有効な値
いいえ
該当なし
文字列
publicKey
ターゲット アカウントの秘密キーに対応する公開キーを指定します。秘密キーは、そのパスワードとして格納されます。
必須
デフォルト値
有効な値
選択したプロトコルが
SSH2_PUBLIC_KEY_AUTH
の場合は「はい」
該当なし
OpenSSH 形式のパブリック キー
keyOptions
OpenSSH のドキュメントで説明されている authorized_keys ファイル形式からオプションのカンマ区切りの仕様のリストを指定します。
必須
デフォルト値
有効な値
いいえ
該当なし
OpenSSH キー オプションのカンマ区切りのリスト

UNIX (UNIXII)ターゲット アプリケーション外部 API の例

POST /api.php/v1/devices.json/{deviceId}/targetApplications { "applicationName": "UnixApp", "applicationType": "unixII", "description1": "sample descriptor1", "description2": "sample descriptor2", "attributes": { "passwordEntryPrompt": "", "sshSessionTimeout": "", "echoCommand": "", "telnetSessionTimeout": "", "useUpdateScriptType": "DEFAULT", "substituteUserCommand": "", "acctDiscGidValue": "", "acctDiscUidRangeLow": "", "acctDiscGidRangeLow": "", "sshUseDefaultKeyExchangeAlgorithms": "true", "sshKeyPairPolicyID": "", "acctDiscUidValue": "", "passwordConfirmationPrompt": "", "changeFilePermissionsCommand": "", "sshPort": "", "changePasswordCommand": "", "useVerifyScriptType": "DEFAULT", "sshServerToClientCiphersList": "", "elevatePrivilegeCommand": "", "sshKnownHostKey": "", "sshKnownHostKeyFingerprint": "", "exitStatusOfLastCommand": "", "sshServerToClientCompressionAlgorithmsList": "", "extensionType": "unixII", "systemInfoCommand": "", "patternMatchingCommand": "", "acctDiscGidRangeHigh": "", "acctDiscGidType": "", "sshDetectCiphersList": "", "sshClientToServerCiphersList": "", "sshClientToServerCompressionAlgorithmsList": "", "passwordChangePrompt": "", "acctDiscUidType": "", "acctDiscUidRangeHigh": "", "sshUseDefaultCiphers": "true", "sshServerHostKeyAlgorithmsList": "", "userNameEntryPrompt": "", "sshUseDefaultHashes": "true", "unixVariant": "GENERIC", "whoAmICommand": "", "telnetPort": "", "sshKeyExchangeAlgorithmsList": "", "policyManagementCommand": "", "sshUseDefaultCompressionAlgorithms": "true", "acctDiscUseUid": "f", "sshUseDefaultServerHostKeyAlgorithms": "true", "scriptTimeout": "", "sshClientToServerHashesList": "", "sshServerToClientHashesList": "", "sshStrictHostKeyCheckingEnabled": "false", "acctDiscUseGid": "false" }, "passwordCompositionPolicyId": null }

UNIX (UNIXII)ターゲット アカウント外部 API の例

POST /api.php/v1/devices.json/{deviceId}/targetApplications/{applicationId}/targetAccounts { "accountName":"UnixAcc", "attributes": { "keyOptions": "", "verifyThroughOtherAccount": "false", "discoveryAllowed": "f", "privateKey": "", "protocol": "SSH2_PASSWORD_AUTH", "otherAccount": "", "descriptor2": "", "discoveryGlobal": "f", "descriptor1": "", "useOtherAccountToChangePassword": "false", "passwordChangeMethod": "DO_NOT_USE_SUDO" }, "cacheBehavior":"useCacheFirst", "cacheDuration":"30", "password":"sample", "passwordViewPolicyId":1000, "privileged":"t", "synchronize":"f", "useAliasNameParameter":"f" }