Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

Gibt die Profil-Daten aller vorhandenen Profile, aller Profile eines Hosts oder eines angegebenen Profils zurück.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
    "method": "bsm.profile.read",
    "params": {
        "apikey": "24174j3tqj",
        "host_id": 100,
        "profile_id": 2
    },
    "id": 1,
    "version": "2.0"
}

Parameter

ParameterTypVersionBeschreibung
host_idintab Version 1.0ID des Hosts
profile_idintab Version 1.0Optional: ID des Profils

Rückgabewert

...

Gibt die Profil-Daten aller vorhandenen Profile, aller Profile eines Hosts oder eines angegebenen Profils zurück.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
    "method": "bsm.profile.status",
    "params": {
        "apikey": "24174j3tqj",
        "host_id": 100
    },
    "id": 1,
    "version": "2.0"
}

Parameter

ParameterTypVersionBeschreibung
host_idintab Version 1.0ID des Hosts

...

Ein Eintrag in der Liste enthält folgende Werte:

WertTypVersion
idintab Version 1.0
descriptionstringab Version 1.0
statusintab Version 1.0
outputstringab Version 1.0


...

bsm.profile.create

Beschreibung

Legt ein neues Profil an.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
    "method": "bsm.profile.create",
    "params": {
        "apikey": "24174j3tqj",
        "description": "myProfile",
        "operation": "min_available",
        "operation_value": 2,
        "default_status": 0,
        "is_template": 0,
        "services": [],
        "rules": []
    },
    "id": 1,
    "version": "2.0"
}

Parameter

ParameterTypVersionBeschreibung
descriptionstringab Version 1.0Name bzw. Beschreibung des Profils
operationstringab Version 1.0Methode zur Berechnung des Status
operation_valuestringab Version 1.0Optional: Argument für die Methode zur Berechnung des Status
default_statusintab Version 1.0Standard-Status, sofern keine Regel zutrifft
is_templatebooleanab Version 1.0Profil kann als Vorlage verwendet werden
servicesarrayab Version 1.0Liste der verwendeten Dienste des Profils
rulesarrayab Version 1.0Liste der Regeln des Profils

...

Aktualisiert ein vorhandenes Profil.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
    "method": "bsm.profile.update",
    "params": {
        "apikey": "24174j3tqj",
        "profile_id": 8,
        "description": "myProfile",
        "operation": "min_available",
        "operation_value": 2,
        "default_status": 0,
        "is_template": 0,
        "services": [],
        "rules": []
    },
    "id": 1,
    "version": "2.0"
}

Parameter

ParameterTypVersionBeschreibung
profile_idintab Version 1.0ID des zu bearbeitenden Profils
descriptionstringab Version 1.0Name bzw. Beschreibung des Profils
operationstringab Version 1.0Methode zur Berechnung des Status
operation_valuestringab Version 1.0Optional: Argument für die Methode zur Berechnung des Status
default_statusintab Version 1.0Standard-Status, sofern keine Regel zutrifft
is_templatebooleanab Version 1.0Profil kann als Vorlage verwendet werden
servicesarrayab Version 1.0Liste der verwendeten Dienste des Profils
rulesarrayab Version 1.0Liste der Regeln des Profils

...

Löscht ein vorhandenes Profil.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
    "method": "bsm.profile.delete",
    "params": {
        "apikey": "24174j3tqj",
        "profile_id": 8
    },
    "id": 1,
    "version": "2.0"
}

Parameter

ParameterTypVersionBeschreibung
profile_idintab Version 1.0ID des zu löschenden Profils

...