discoveryrule.get

    The method allows to retrieve LLD rules according to the given parameters.

    This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

    Parameters

    (object) Parameters defining the desired output.

    The method supports the following parameters.

    (integer/array) Returns either:

    • an array of objects;
    • the count of retrieved objects, if the countOutput parameter has been used.

    Examples

    Retrieving discovery rules from a host

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "itemid": "27425",
    6.                    "type": "0",
    7.                    "snmp_oid": "",
    8.                    "hostid": "10202",
    9.                    "name": "Network interface discovery",
    10.                    "key_": "net.if.discovery",
    11.                    "delay": "1h",
    12.                    "state": "0",
    13.                    "status": "0",
    14.                    "trapper_hosts": "",
    15.                    "error": "",
    16.                    "templateid": "22444",
    17.                    "params": "",
    18.                    "ipmi_sensor": "",
    19.                    "authtype": "0",
    20.                    "username": "",
    21.                    "password": "",
    22.                    "publickey": "",
    23.                    "privatekey": "",
    24.                    "interfaceid": "119",
    25.                    "description": "Discovery of network interfaces as defined in global regular expression \"Network interfaces for discovery\".",
    26.                    "lifetime": "30d",
    27.                    "jmx_endpoint": "",
    28.                    "master_itemid": "0",
    29.                    "timeout": "3s",
    30.                    "url": "",
    31.                    "query_fields": [],
    32.                    "posts": "",
    33.                    "status_codes": "200",
    34.                    "follow_redirects": "1",
    35.                    "post_type": "0",
    36.                    "http_proxy": "",
    37.                    "headers": [],
    38.                    "retrieve_mode": "0",
    39.                    "request_method": "0",
    40.                    "ssl_cert_file": "",
    41.                    "ssl_key_file": "",
    42.                    "ssl_key_password": "",
    43.                    "verify_peer": "0",
    44.                    "verify_host": "0",
    45.                    "allow_traps": "0",
    46.                    "parameters": []
    47.                },
    48.                {
    49.                    "itemid": "27426",
    50.                    "type": "0",
    51.                    "snmp_oid": "",
    52.                    "hostid": "10202",
    53.                    "name": "Mounted filesystem discovery",
    54.                    "key_": "vfs.fs.discovery",
    55.                    "delay": "1h",
    56.                    "state": "0",
    57.                    "status": "0",
    58.                    "trapper_hosts": "",
    59.                    "error": "",
    60.                    "templateid": "22450",
    61.                    "params": "",
    62.                    "ipmi_sensor": "",
    63.                    "authtype": "0",
    64.                    "username": "",
    65.                    "password": "",
    66.                    "publickey": "",
    67.                    "privatekey": "",
    68.                    "interfaceid": "119",
    69.                    "description": "Discovery of file systems of different types as defined in global regular expression \"File systems for discovery\".",
    70.                    "lifetime": "30d",
    71.                    "jmx_endpoint": "",
    72.                    "master_itemid": "0",
    73.                    "timeout": "3s",
    74.                    "url": "",
    75.                    "query_fields": [],
    76.                    "posts": "",
    77.                    "status_codes": "200",
    78.                    "follow_redirects": "1",
    79.                    "post_type": "0",
    81.                    "headers": [],
    82.                    "retrieve_mode": "0",
    83.                    "request_method": "0",
    84.                    "ssl_cert_file": "",
    85.                    "ssl_key_file": "",
    86.                    "ssl_key_password": "",
    87.                    "verify_peer": "0",
    88.                    "verify_host": "0",
    89.                    "allow_traps": "0",
    90.                    "parameters": []
    91.                }
    92.            ],
    93.        }

    Retrieving filter conditions

    Retrieve the name of the LLD rule “24681” and its filter conditions. The filter uses the “and” evaluation type, so the formula property is empty and eval_formula is generated automatically.

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "itemid": "24681",
    6.                    "name": "Filtered LLD rule",
    7.                    "filter": {
    8.                        "evaltype": "1",
    9.                        "formula": "",
    10.                        "conditions": [
    11.                            {
    12.                                "macro": "{#MACRO1}",
    13.                                "value": "@regex1",
    14.                                "operator": "8",
    15.                                "formulaid": "A"
    16.                            },
    17.                            {
    18.                                "macro": "{#MACRO2}",
    19.                                "value": "@regex2",
    20.                                "operator": "9",
    21.                                "formulaid": "B"
    22.                            },
    23.                            {
    24.                                "macro": "{#MACRO3}",
    25.                                "value": "",
    26.                                "operator": "12",
    27.                                "formulaid": "C"
    28.                            },
    29.                            {
    30.                                "macro": "{#MACRO4}",
    31.                                "value": "",
    32.                                "operator": "13",
    33.                                "formulaid": "D"
    34.                            }
    35.                        ],
    36.                        "eval_formula": "A and B and C and D"
    37.                    }
    38.                }
    39.            ],
    40.            "id": 1
    41.        }

    Retrieve LLD rule by URL

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "itemid": "28336",
    6.                    "type": "19",
    7.                    "snmp_oid": "",
    8.                    "hostid": "10257",
    9.                    "name": "API HTTP agent",
    10.                    "key_": "api_discovery_rule",
    11.                    "delay": "5s",
    12.                    "history": "90d",
    13.                    "trends": "0",
    14.                    "status": "0",
    15.                    "value_type": "4",
    16.                    "trapper_hosts": "",
    17.                    "units": "",
    18.                    "error": "",
    19.                    "logtimefmt": "",
    20.                    "templateid": "0",
    21.                    "valuemapid": "0",
    22.                    "params": "",
    23.                    "ipmi_sensor": "",
    24.                    "authtype": "0",
    25.                    "username": "",
    26.                    "password": "",
    27.                    "publickey": "",
    28.                    "privatekey": "",
    29.                    "flags": "1",
    30.                    "interfaceid": "5",
    31.                    "description": "",
    32.                    "inventory_link": "0",
    33.                    "lifetime": "30d",
    34.                    "state": "0",
    35.                    "jmx_endpoint": "",
    36.                    "master_itemid": "0",
    37.                    "timeout": "3s",
    38.                    "url": "http://127.0.0.1/discoverer.php",
    39.                    "query_fields": [
    40.                        {
    41.                            "mode": "json"
    42.                        },
    43.                        {
    44.                            "elements": "2"
    45.                        }
    46.                    ],
    47.                    "posts": "",
    48.                    "status_codes": "200",
    49.                    "follow_redirects": "1",
    50.                    "post_type": "0",
    51.                    "http_proxy": "",
    52.                    "headers": {
    54.                        "Authorization": "Bearer mF_A.B5f-2.1JcM"
    55.                    },
    56.                    "retrieve_mode": "0",
    57.                    "request_method": "1",
    58.                    "ssl_cert_file": "",
    59.                    "ssl_key_file": "",
    60.                    "ssl_key_password": "",
    61.                    "verify_peer": "0",
    62.                    "verify_host": "0",
    63.                    "parameters": []
    64.                }
    65.            ],
    66.            "id": 39
    67.        }

    Retrieve LLD rule with overrides

    Retrieve one LLD rule that has various override settings.

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "name": "Discover database host"
    6.                    "overrides": [
    7.                        {
    8.                            "name": "Discover MySQL host",
    9.                            "step": "1",
    10.                            "stop": "1",
    11.                            "filter": {
    12.                                "evaltype": "2",
    13.                                "formula": "",
    14.                                "conditions": [
    15.                                    {
    16.                                        "macro": "{#UNIT.NAME}",
    17.                                        "operator": "8",
    18.                                        "value": "^mysqld\\.service$"
    19.                                        "formulaid": "A"
    20.                                    },
    21.                                    {
    22.                                        "macro": "{#UNIT.NAME}",
    23.                                        "operator": "8",
    24.                                        "value": "^mariadb\\.service$"
    25.                                        "formulaid": "B"
    26.                                    }
    27.                                ],
    28.                                "eval_formula": "A or B"
    29.                            },
    30.                            "operations": [
    31.                                {
    32.                                    "operationobject": "3",
    33.                                    "operator": "2",
    34.                                    "value": "Database host",
    35.                                    "opstatus": {
    36.                                        "status": "0"
    37.                                    },
    38.                                    "optag": [
    39.                                        {
    40.                                            "tag": "Database",
    41.                                            "value": "MySQL"
    42.                                        }
    43.                                    ],
    44.                                    "optemplate": [
    45.                                        {
    46.                                            "templateid": "10170"
    47.                                        }
    48.                                    ]
    49.                                }
    50.                            ]
    51.                        },
    52.                        {
    53.                            "name": "Discover PostgreSQL host",
    54.                            "step": "2",
    55.                            "stop": "1",
    56.                            "filter": {
    57.                                "evaltype": "0",
    58.                                "formula": "",
    59.                                "conditions": [
    60.                                    {
    61.                                        "macro": "{#UNIT.NAME}",
    62.                                        "operator": "8",
    63.                                        "value": "^postgresql\\.service$"
    64.                                        "formulaid": "A"
    65.                                    }
    66.                                ],
    67.                                "eval_formula": "A"
    68.                            },
    69.                            "operations": [
    70.                                {
    71.                                    "operationobject": "3",
    72.                                    "operator": "2",
    73.                                    "value": "Database host",
    74.                                    "opstatus": {
    75.                                        "status": "0"
    76.                                    },
    77.                                    "optag": [
    78.                                        {
    79.                                            "tag": "Database",
    80.                                            "value": "PostgreSQL"
    81.                                        }
    82.                                    ],
    83.                                    "optemplate": [
    84.                                        {
    85.                                            "templateid": "10263"
    86.                                        }
    87.                                    ]
    88.                                }
    89.                            ]
    90.                        }
    91.                    ]
    92.                }
    93.            ],
    94.            "id": 39

    Source