maintenance.create

Beschreibung

object maintenance.create(object/array maintenances)

Diese Methode ermöglicht das Erstellen neuer Wartungen.

Diese Methode ist nur für die Benutzertypen Admin und Super admin verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object/array) Wartungen zum Erstellen.

Zusätzlich zu den standardmäßigen Wartungseigenschaften akzeptiert die Methode die folgenden Parameter.

Parameter Type Beschreibung
groups object/array Host groups, die gewartet werden.

Die Host groups dürfen nur die Eigenschaft groupid definiert haben.

Parameterverhalten:
- erforderlich, wenn hosts nicht gesetzt ist
hosts object/array Hosts, die gewartet werden.

Die Hosts dürfen nur die Eigenschaft hostid definiert haben.

Parameterverhalten:
- erforderlich, wenn groups nicht gesetzt ist
timeperiods object/array Wartungs-Zeitperioden.

Parameterverhalten:
- erforderlich
tags object/array Problem-Tags.

Definieren Sie, welche Probleme unterdrückt werden müssen.
Wenn keine Tags angegeben werden, werden alle aktiven Probleme der Hosts in Wartung unterdrückt.

Parameterverhalten:
- unterstützt, wenn maintenance_type des Maintenance object auf "with data collection" gesetzt ist
groupids
(deprecated)		 array Dieser Parameter ist veraltet, bitte verwenden Sie stattdessen groups.
IDs der Host groups, die gewartet werden.
hostids
(deprecated)		 array Dieser Parameter ist veraltet, bitte verwenden Sie stattdessen hosts.
IDs der Hosts, die gewartet werden.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der erstellten Maintenances unter der Eigenschaft maintenanceids enthält. Die Reihenfolge der zurückgegebenen IDs entspricht der Reihenfolge der übergebenen Maintenances.

Beispiele

Erstellen einer Wartung

Erstellen Sie eine Wartung mit Datensammlung für die Host-Gruppe mit der ID „2“ und mit den Problem-Tags service:mysqld und error. Sie muss vom 17.03.2026 bis zum 17.03.2027 aktiv sein, jeden Sonntag um 18:00 Uhr wirksam werden und eine Stunde dauern.

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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