The method allows to retrieve host prototypes 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 for more information.

    Parameters

    (object) Parameters defining the desired output.

    The method supports the following parameters.

    • an array of objects;

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

    Examples

    Retrieving host prototypes from an LLD rule

    Retrieve all host prototypes, their group links, group prototypes and tags from an LLD rule.

    Request:

    1. {
    2.     "jsonrpc": "2.0",
    3.     "result": [
    4.         {
    5.             "hostid": "10092",
    6.             "host": "{#HV.UUID}",
    8.             "status": "0",
    9.             "templateid": "0",
    10.             "discover": "0",
    11.             "custom_interfaces": "1",
    12.             "inventory_mode": "-1",
    13.             "groupLinks": [
    14.                     "group_prototypeid": "4",
    15.                     "hostid": "10092",
    16.                     "groupid": "7",
    17.                     "templateid": "0"
    18.                 }
    19.             ],
    20.             "groupPrototypes": [
    21.                 {
    22.                     "group_prototypeid": "7",
    23.                     "hostid": "10092",
    24.                     "name": "{#CLUSTER.NAME}",
    25.                     "templateid": "0"
    26.                 }
    27.             ],
    28.             "tags": [
    29.                 {
    30.                     "tag": "Datacenter",
    32.                 },
    33.                 {
    34.                     "tag": "Instance type",
    35.                     "value": "{#INSTANCE_TYPE}"
    36.             ],
    37.             "interfaces": [
    38.                 {
    39.                     "main": "1",
    40.                     "type": "2",
    41.                     "useip": "1",
    42.                     "ip": "127.0.0.1",
    43.                     "dns": "",
    44.                     "port": "161",
    45.                     "details": {
    46.                         "version": "2",
    47.                         "bulk": "1",
    48.                         "community": "{$SNMP_COMMUNITY}"
    49.                     }
    50.                 }
    51.             ]
    52.         }
    53.     ],
    54.     "id": 1

    Source

    CHostPrototype::get() in ui/include/classes/api/services/CHostPrototype.php.