Table of Contents
dcheck.get
説明
integer/array dcheck.get(object parameters)
このメソッドは、指定したパラメーターに応じたディスカバリチェックを取得できます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメーター
(object) 望ましい出力を定義するパラメーター。
このメソッドは以下のパラメーターをサポートします。
| パラメーター | タイプ | 説明 |
|---|---|---|
| dcheckids | ID/array | 指定したIDのディスカバリチェックのみを返します。 |
| druleids | ID/array | 指定したディスカバリルールに属するディスカバリチェックのみを返します。 |
| dserviceids | ID/array | 指定した検出済みサービスを検出したディスカバリチェックのみを返します。 |
| selectDRules | query | ディスカバリチェックに関連するディスカバリルールを返します。 |
| sortfield | string/array | 指定したプロパティで結果をソートします。 指定可能な値: dcheckid, druleid。 |
| countOutput | boolean | これらのパラメーターはリファレンス解説で説明されています。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメーターが使用されている場合、取得したオブジェクトの数
例
ディスカバリルールのディスカバリチェックを取得
ディスカバリルール"6"によって使用されるすべてのディスカバリチェックを取得します。
{
"jsonrpc": "2.0",
"method": "dcheck.get",
"params": {
"output": "extend",
"dcheckids": "6"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"dcheckid": "6",
"druleid": "4",
"type": "3",
"key_": "",
"snmp_community": "",
"ports": "21",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniq": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"snmpv3_contextname": "",
"host_source": "1",
"name_source": "0",
"allow_redirect": "0"
}
],
"id": 1
}ソース
CDCheck::get() in ui/include/classes/api/services/CDCheck.php.