ação.criar
Descrição
object action.create(object/array actions)
Este método permite criar novas ações.
Este método está disponível apenas para os tipos de usuário Admin e Super admin. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.
Parâmetros
(object/array) Ações a serem criadas.
Além das propriedades padrão da ação, o método aceita os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| filter | object | Objeto Action filter para a ação. |
| operations | array | Operações de ação a serem criadas para a ação. |
| recovery_operations | array | Operações de recuperação de ação a serem criadas para a ação. |
| update_operations | array | Operações de atualização de ação a serem criadas para a ação. |
Valores de retorno
(object) Retorna um objeto contendo os IDs das ações criadas
sob a propriedade actionids. A ordem dos IDs retornados corresponde
a ordem das ações passadas.
Exemplos
Criar uma ação de trigger
Crie uma ação de trigger que será iniciada assim que uma trigger (com a palavra "memory" em seu nome) do host "10084" entrar em estado de PROBLEMA. A ação terá 4 operações configuradas. A primeira operação, imediata, enviará uma mensagem para todos os usuários do grupo de usuários "7" via tipo de mídia "1". Se o evento não for resolvido em 30 minutos, a segunda operação executará o script "5" (script com escopo "Operação de ação") em todos os hosts do grupo "2". Se o evento for resolvido, uma operação de recuperação notificará todos os usuários que receberam qualquer mensagem sobre o problema. Se o evento for atualizado, uma operação de reconhecimento/atualização notificará (com assunto e mensagem personalizados) todos os usuários que receberam qualquer mensagem sobre o problema.
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Trigger action",
"eventsource": 0,
"esc_period": "30m",
"filter": {
"evaltype": 0,
"conditions": [
{
"conditiontype": 1,
"operator": 0,
"value": "10084"
},
{
"conditiontype": 3,
"operator": 2,
"value": "memory"
}
]
},
"operations": [
{
"operationtype": 0,
"esc_step_from": 1,
"esc_step_to": 1,
"opmessage_grp": [
{
"usrgrpid": "7"
}
],
"opmessage": {
"default_msg": 1,
"mediatypeid": "1"
}
},
{
"operationtype": 1,
"esc_step_from": 2,
"esc_step_to": 2,
"opconditions": [
{
"conditiontype": 14,
"operator": 0,
"value": "0"
}
],
"opcommand_grp": [
{
"groupid": "2"
}
],
"opcommand": {
"scriptid": "5"
}
}
],
"recovery_operations": [
{
"operationtype": "11",
"opmessage": {
"default_msg": 1
}
}
],
"update_operations": [
{
"operationtype": "12",
"opmessage": {
"default_msg": 0,
"message": "Custom update operation message body",
"subject": "Custom update operation message subject"
}
}
]
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"17"
]
},
"id": 1
}Criar uma ação de descoberta
Crie uma ação de descoberta que vincule o template "10001" aos hosts descobertos.
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Discovery action",
"eventsource": 1,
"filter": {
"evaltype": 0,
"conditions": [
{
"conditiontype": 21,
"operator": 0,
"value": "1"
},
{
"conditiontype": 10,
"operator": 0,
"value": "2"
}
]
},
"operations": [
{
"operationtype": 6,
"optemplate": [
{
"templateid": "10001"
}
]
}
]
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"18"
]
},
"id": 1
}Usando um filtro de expressão personalizada
Crie uma ação de trigger que use uma expressão personalizada - "A and (B or C)" - para avaliar as condições da ação. Uma vez que um trigger com severidade maior ou igual a "Aviso" do host "10084" ou do host "10106" entre em estado de PROBLEMA, a ação enviará uma mensagem para todos os usuários no grupo de usuários "7" via tipo de mídia "1". Os IDs de fórmula "A", "B" e "C" foram escolhidos arbitrariamente.
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Trigger action",
"eventsource": 0,
"esc_period": "15m",
"filter": {
"evaltype": 3,
"formula": "A and (B or C)",
"conditions": [
{
"conditiontype": 4,
"operator": 5,
"value": "2",
"formulaid": "A"
},
{
"conditiontype": 1,
"operator": 0,
"value": "10084",
"formulaid": "B"
},
{
"conditiontype": 1,
"operator": 0,
"value": "10106",
"formulaid": "C"
}
]
},
"operations": [
{
"operationtype": 0,
"esc_step_from": 1,
"esc_step_to": 1,
"opmessage_grp": [
{
"usrgrpid": "7"
}
],
"opmessage": {
"default_msg": 1,
"mediatypeid": "1"
}
}
]
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"actionids": [
"18"
]
},
"id": 1
}Criar regra de autorregistro de agent
Crie uma ação de autorregistro que adicione um host ao grupo de hosts "2" quando o nome do host contiver "SRV" ou os metadados contiverem "AlmaLinux".
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Register Linux servers",
"eventsource": "2",
"filter": {
"evaltype": "2",
"conditions": [
{
"conditiontype": "22",
"operator": "2",
"value": "SRV"
},
{
"conditiontype": "24",
"operator": "2",
"value": "AlmaLinux"
}
]
},
"operations": [
{
"operationtype": "4",
"opgroup": [
{
"groupid": "2"
}
]
}
]
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"actionids": [
19
]
},
"id": 1
}Criar regra de autorregistro de agent com tags de host
Crie uma ação de autorregistro que adicione um host ao grupo de hosts "2" e adicione duas tags de host.
{
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": "Register Linux servers with tags",
"eventsource": "2",
"operations": [
{
"operationtype": "4",
"opgroup": [
{
"groupid": "2"
}
]
},
{
"operationtype": "13",
"optag": [
{
"tag": "location",
"value": "office"
},
{
"tag": "city",
"value": "Riga"
}
]
}
]
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"actionids": [
20
]
},
"id": 1
}Veja também
Fonte
CAction::create() in ui/include/classes/api/services/CAction.php.