usermacro.get

Beschrijving

integer/array usermacro.get(objectparameters)

De methode maakt het mogelijk om host- en globale macro's op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
globalmacro flag Retourneer globale macro's in plaats van hostmacro's.
globalmacroids string/array Retourneer alleen globale macro's met de opgegeven ID's.
groupids string/array Retourneer alleen hostmacro's die behoren tot hosts of sjablonen van de opgegeven hostgroepen.
hostids string/array Retourneer alleen macro's die bij de opgegeven hosts of sjablonen horen.
hostmacroids string/array Retourneer alleen hostmacro's met de opgegeven ID's.
inherited boolean Indien ingesteld op true, worden alleen host-prototype-gebruikersmacro's geretourneerd die zijn overgenomen van een sjabloon.
selectGroups query Retourneer hostgroepen waartoe de hostmacro behoort in de eigenschap groups.

Alleen gebruikt bij het ophalen van hostmacro's.
selectHosts query Retourneert hosts waartoe de hostmacro behoort in de eigenschap hosts.

Alleen gebruikt bij het ophalen van hostmacro's.
selectTemplates query Sjablonen retourneren waartoe de hostmacro behoort in de eigenschap templates.

Alleen gebruikt bij het ophalen van hostmacro's.
sortfield string/array Sorteer het resultaat op de gegeven eigenschappen.

Mogelijke waarde: macro.
countOutput boolean Deze parameters gelden voor alle get-methoden en worden in detail beschreven op de pagina referentiecommentaar.
editable booleaans
excludeSearch boolean
filter object
limiet geheel getal
uitvoer query
preservekeys boolean
zoeken object
searchByAny boolean
searchWildcardsIngeschakeld boolean
sortorde string/array
startZoeken booleaans

Retourwaarden

(integer/array) Retourneert ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Hostmacro's voor een host ophalen

Haal alle hostmacro's op die zijn gedefinieerd voor host "10198".

Verzoek:

{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "hostids": "10198"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Antwoord:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostmacroid": "9",
            "hostid": "10198",
            "macro": "{$INTERFACE}",
            "value": "eth0",
            "description": "",
            "type": "0"
        },
        {
            "hostmacroid": "11",
            "hostid": "10198",
            "macro": "{$SNMP_COMMUNITY}",
            "value": "public",
            "description": "",
            "type": "0"
        }
    ],
    "id": 1
}

Ophalen van globale macro's

Haal alle globale macro's op.

Verzoek:

{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "globalmacro": true
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Antwoord:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "globalmacroid": "6",
            "macro": "{$SNMP_COMMUNITY}",
            "value": "public",
            "description": "",
            "type": "0"
        }
    ],
    "id": 1
}

Bron

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