dhost.exists

Description

boolean dhost.exists(object filter)

This method checks if at least one discovered host that matches the given filter criteria exists.

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter Type Description
dhostid string/array IDs of the discovered hosts.
node string Name of the node the discovered hosts must belong to.

This will override the nodeids parameter.
nodeids string/array IDs of the nodes the discovered hosts must belong to.

Return values

(boolean) Returns true if at least one discovered host that matches the given filter criteria exists.

Examples

Check multiple discovered hosts

Check if discovered hosts with IDs "1" and "2" exists.

Request:

{
    "jsonrpc": "2.0",
    "method": "dhost.exists",
    "params": {
        "dhostid": [
            "1",
            "2"
        ]
    },
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": true,
    "id": 1
}

Source

CDHost::exists() in frontends/php/api/classes/CDHost.php.