maintenance.create

Descripción

object maintenance.create(object/array maintenances)

Este método permite crear nuevos mantenimientos.

Este método solo está disponible para los tipos de usuario Admin y Super admin. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para más información.

Parámetros

(object/array) Mantenimientos a crear.

Además de las propiedades estándar de mantenimiento, el método acepta los siguientes parámetros.

Parameter Type Description
groups object/array Grupos de host que estarán en mantenimiento.

Los grupos de host deben tener definida solo la propiedad groupid.

Comportamiento del parámetro:
- required si hosts no está definido
hosts object/array Hosts que estarán en mantenimiento.

Los hosts deben tener definida solo la propiedad hostid.

Comportamiento del parámetro:
- required si groups no está definido
timeperiods object/array Períodos de tiempo del mantenimiento.

Comportamiento del parámetro:
- required
tags object/array Etiquetas de problema.

Define qué problemas deben suprimirse.
Si no se proporcionan etiquetas, se suprimirán todos los problemas de host en mantenimiento activos.

Comportamiento del parámetro:
- supported si maintenance_type del objeto Maintenance está establecido en "with data collection"
groupids
(deprecated)		 array Este parámetro está obsoleto; use groups en su lugar.
IDs de los grupos de host que estarán en mantenimiento.
hostids
(deprecated)		 array Este parámetro está obsoleto; use hosts en su lugar.
IDs de los hosts que estarán en mantenimiento.

Valores de retorno

(object) Devuelve un objeto que contiene los IDs de los mantenimientos creados bajo la propiedad maintenanceids. El orden de los IDs devueltos coincide con el orden de los mantenimientos enviados.

Ejemplos

Crear un mantenimiento

Cree un mantenimiento con recopilación de datos para el grupo de hosts con ID "2" y con etiquetas de problema service:mysqld y error. Debe estar activo desde el 17.03.2026 hasta el 17.03.2027, entrar en vigor cada domingo a las 18:00 y durar una hora.

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "maintenance.create",
    "params": {
        "name": "Sunday maintenance",
        "active_since": 1773720240,
        "active_till": 1805256240,
        "tags_evaltype": 0,
        "groups": [
            {"groupid": "2"}
        ],
        "timeperiods": [
            {
                "period": 3600,
                "timeperiod_type": 3,
                "start_time": 64800,
                "every": 1,
                "dayofweek": 64
            }
        ],
        "tags": [
            {
                "tag": "service",
                "operator": "0",
                "value": "mysqld"
            },
            {
                "tag": "error",
                "operator": "2",
                "value": ""
            }
        ]
    },
    "id": 1
}

Respuesta:

{
    "jsonrpc": "2.0",
    "result": {
        "maintenanceids": [
            "3"
        ]
    },
    "id": 1
}

Ver también

Fuente

CMaintenance::create() en ui/include/classes/api/services/CMaintenance.php.