Cisco ターゲット アプリケーション外部 API 属性
capam344
このトピックでは、外部 API を使用して Cisco ターゲット アプリケーションおよびターゲット アカウントを追加または更新するときに使用される必須およびサポートされている属性について説明します。
2
Cisco ターゲット アプリケーション外部 API 属性
外部 API を使用して Cisco ターゲット アプリケーションを追加または更新するには、REST コールの「body」パラメータに含まれる「attributes」連想配列のメンバとして、以下のプロパティを使用します。
sshPort
SSH を使用した UNIX ホストへの接続に使用されるポートです。
必須 | デフォルト値 | 有効な値 |
いいえ | 22 | 0 ~ 65535 |
sshSessionTimeout
SSH 通信チャネルを使用する場合に、認証情報マネージャがリモート ホストの応答を待機する時間をミリ秒単位で指定します。
必須 | デフォルト値 | 有効な値 |
いいえ | 5000 | 1000 ~ 99999 |
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 |
hKeyExchangeAlgorithmsList
リモート ホストに接続する際に、使用するキー交換方法のリストを指定します。方法は、優先度の順に表示されます。
必須 | デフォルト値 | 有効な値 |
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 |
ciscoVariant
ターゲット サーバにインストールされている Cisco システムのタイプを指定します。
必須 | デフォルト値 | 有効な値 |
いいえ | IOS_12_4 | IOS_10_0、IOS_12_4 または ASA_IOS_7_0_1。 |
scriptTimeout
認証情報マネージャがリモート ホストからの予期される入力の受信を待機する時間をミリ秒単位で指定します。
必須 | デフォルト値 | 有効な値 |
いいえ | 5000 | 5000 ~ 59999 |
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.*? | 有効な正規表現の構文 |
Cisco ターゲット アカウント外部 API 属性
ターゲット コネクタを使用する Cisco ターゲット アカウントを追加するには、REST コールの「body」パラメータに含まれる「attributes」連想配列のメンバとして、以下のプロパティを使用します。
useOtherAccountToChangePassword
ターゲット アカウントを更新する際に、ターゲット アカウントまたは別のアカウントを使用するかどうかを指定します。
必須 | デフォルト値 | 有効な値 |
はい | false | true、false |
otherAccount
ターゲット アカウントを更新する際に使用する他のアカウントを指定します。
必須 | デフォルト値 | 有効な値 |
useOtherAccountToChangePassword が true の場合は「はい」。 | 該当なし | 有効なターゲット アカウント ID。 |
protocol
リモート ホストと通信するために使用するプロトコルを指定します。
必須 | デフォルト値 | 有効な値 |
useOtherAccountToChangePassword が false の場合は「はい」 | SSH2_PASSWORD_AUTH | SSH2_PASSWORD_AUTH、TELNET |
pwType
認証情報タイプがユーザまた特権(または「有効」)アカウントに関連するかどうか。
必須 | デフォルト値 | 有効な値 |
はい | user | user、privileged |
useOtherPrivilegedAccount
必須 | デフォルト値 | 有効な値 |
はい | false | true、false |
otherPrivilegedAccount
必須 | デフォルト値 | 有効な値 |
いいえ | 該当なし | 有効なターゲット アカウント ID |
changeAuxLoginPassword
必須 | デフォルト値 | 有効な値 |
いいえ | 該当なし | true、false |
changeConsoleLoginPassword
必須 | デフォルト値 | 有効な値 |
はい | 該当なし | true、false |
changeVtyLoginPassword
必須 | デフォルト値 | 有効な値 |
いいえ | 該当なし | true、false |
numVTYPorts
必須 | デフォルト値 | 有効な値 |
changeVtyLoginPassword が true の場合は「はい」 | 該当なし | 1 ~ 15 |
Cisco ターゲット アプリケーション外部 API の例
POST /api.php/v1/devices.json/{deviceId}/targetApplications { "applicationName": "CiscoApp", "applicationType": "CiscoSSH", "description1": "sample descriptor1", "description2": "sample descriptor2", "attributes": { "sshSessionTimeout": "", "instance": "", "passwordEntryPrompt": "", "sshDetectCiphersList": "", "sshClientToServerCiphersList": "", "sshClientToServerCompressionAlgorithmsList": "", "passwordChangePrompt": "", "telnetSessionTimeout": "", "useUpdateScriptType": "DEFAULT", "sshServerHostKeyAlgorithmsList": "", "sshUseDefaultCiphers": "true", "userNameEntryPrompt": "", "sshUseDefaultHashes": "true", "sshKeyExchangeAlgorithmsList": "", "telnetPort": "", "sslEnabled": "", "sshUseDefaultKeyExchangeAlgorithms": "true", "passwordConfirmationPrompt": "", "sshPort": "", "ciscoVariant": "IOS_12_4", "sshServerToClientCiphersList": "", "useVerifyScriptType": "DEFAULT", "sshKnownHostKey": "", "sshKnownHostKeyFingerprint": "", "sshUseDefaultCompressionAlgorithms": "true", "sslPort": "", "sshUseDefaultServerHostKeyAlgorithms": "true", "scriptTimeout": "", "mbean": "", "sshClientToServerHashesList": "", "port": "", "sshServerToClientHashesList": "", "sshServerToClientCompressionAlgorithmsList": "", "sshStrictHostKeyCheckingEnabled": "false" }, "passwordCompositionPolicyId": null }
Cisco ターゲット アカウント外部 API の例
POST /api.php/v1/devices.json/{deviceId}/targetApplications/{applicationId}/targetAccounts { "accountName":"CiscoAcc", "attributes": { "verifyThroughOtherAccount": "", "changeConsoleLoginPassword": "false", "useOtherPrivilegedAccount": "false", "discoveryAllowed": "f", "changeAuxLoginPassword": "false", "changeVtyLoginPassword": "false", "pwType": "user", "protocol": "SSH2_PASSWORD_AUTH", "otherAccount": "", "descriptor2": "", "discoveryGlobal": "f", "descriptor1": "", "useOtherAccountToChangePassword": "false", "numVTYPorts": "1", "otherPrivilegedAccount": "-1" }, "cacheBehavior":"useCacheFirst", "cacheDuration":"30", "password":"sample", "passwordViewPolicyId":1000, "privileged":"t", "synchronize":"f", "useAliasNameParameter":"f" }
"useOtherAccountToChangePassword": "false" false/true values only "changeConsoleLoginPassword": "false" false/true values only "useOtherPrivilegedAccount": "false" false/true values only "changeAuxLoginPassword": "false", false/true values only "changeVtyLoginPassword": "false", false/true values only