usermacro.get

Beschrijving

integer/array usermacro.get(object parameters)

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

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen kunnen worden ingetrokken in gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

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

De methode ondersteunt de volgende parameters.

Parameter Type Omschrijving
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 uit de opgegeven hostgroepen of sjabloongroepen.
hostids string/array Retourneer alleen macro's die behoren tot de opgegeven hosts of sjablonen.
hostmacroids string/array Retourneer alleen hostmacro's met de opgegeven ID's.
inherited boolean Indien ingesteld op true, retourneer alleen gebruikersmacro's van hostprototypes die zijn overgeërfd van een sjabloon.
selectHostGroups query Retourneer hostgroepen waartoe de hostmacro behoort in de eigenschap hostgroups.

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

Alleen gebruikt bij het ophalen van hostmacro's.
selectTemplateGroups query Retourneer sjabloongroepen waartoe de sjabloonmacro behoort in de eigenschap templategroups.

Alleen gebruikt bij het ophalen van sjabloonmacro's.
selectTemplates query Retourneer sjablonen waartoe de hostmacro behoort in de eigenschap templates.

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

Mogelijke waarden: macro.
countOutput boolean Deze parameters zijn gemeenschappelijk voor alle get-methoden en worden in detail beschreven op de reference commentary pagina.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(verouderd)
query Deze parameter is verouderd, gebruik in plaats daarvan selectHostGroups of selectTemplateGroups.
Retourneer hostgroepen en sjabloongroepen waartoe de hostmacro behoort in de eigenschap groups.

Alleen gebruikt bij het ophalen van hostmacro's.

Retourwaarden

(integer/array) Retourneert ofwel:

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

Voorbeelden

Ophalen van hostmacro's voor een host

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

Aanvraag:

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

Reactie:

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

Ophalen van globale macro's

Haal alle globale macro's op.

Aanvraag:

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

Reactie:

{
           "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.