integer/array usermacro.get(object parameters)
El método permite recuperar macros de equipo y globales de acuerdo con los parámetros dados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se puede revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener más información.
(object)
Parameters defining the desired output.
The method supports the following parameters.
Parameter | Type | Description |
---|---|---|
globalmacro | flag | Return global macros instead of host macros. |
globalmacroids | string/array | Return only global macros with the given IDs. |
groupids | string/array | Return only host macros that belong to hosts or templates from the given host groups. |
hostids | string/array | Return only macros that belong to the given hosts or templates. |
hostmacroids | string/array | Return only host macros with the given IDs. |
inherited | boolean | If set to true return only host prototype user macros inherited from a template. |
selectGroups | query | Return host groups that the host macro belongs to in the groups property. Used only when retrieving host macros. |
selectHosts | query | Return hosts that the host macro belongs to in the hosts property. Used only when retrieving host macros. |
selectTemplates | query | Return templates that the host macro belongs to in the templates property. Used only when retrieving host macros. |
sortfield | string/array | Sort the result by the given properties. Possible value: macro . |
countOutput | boolean | These parameters being common for all get methods are described in detail in the reference commentary page. |
editable | boolean | |
excludeSearch | boolean | |
filter | object | |
limit | integer | |
output | query | |
preservekeys | boolean | |
search | object | |
searchByAny | boolean | |
searchWildcardsEnabled | boolean | |
sortorder | string/array | |
startSearch | boolean |
(entero/matriz)
Devuelve:
countOutput
ha sido usado.Retrieve all host macros defined for host "10198".
Request:
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"hostids": "10198"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Response:
{
"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
}
Recupera todas las macros globales.
Solicitud:
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"globalmacro": true
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"globalmacroid": "6",
"macro": "{$SNMP_COMMUNITY}",
"value": "public",
"description": "",
"type": "0"
}
],
"id": 1
}
CUserMacro::get() en ui/include/classes/api/services/CUserMacro.php.