Verwaltung eines Profils.
Seitenverzeichnis:
| Inhalt |
|---|
| maxLevel | 2 |
|---|
| indent | 10px |
|---|
| style | square |
|---|
|
...
bsm.profile.read
Beschreibung
Gibt die Profil-Daten aller vorhandenen Profile, aller Profile eines Hosts oder eines angegebenen Profils zurück.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.profile.read",
"params": {
"apikey": "24174j3tqj",
"host_id": 100,
"profile_id": 2
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version | Beschreibung |
|---|
| host_id | int | ab Version 1.0 | ID des Hosts |
| profile_id | int | ab Version 1.0 | Optional: ID des Profils |
Rückgabewert
| Wert | Typ | Version |
|---|
| id | int | ab Version 1.0 |
| description | string | ab Version 1.0 |
| operation | string | ab Version 1.0 |
| operation_value | string | ab Version 1.0 |
| default_status | int | ab Version 1.0 |
| is_template | boolean | ab Version 1.0 |
| services | array | ab Version 1.0 |
| rules | array | ab Version 1.0 |
...
bsm.profile.status
Beschreibung
Gibt die Profil-Daten aller vorhandenen Profile, aller Profile eines Hosts oder eines angegebenen Profils zurück.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.profile.status",
"params": {
"apikey": "24174j3tqj",
"host_id": 100
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version | Beschreibung |
|---|
| host_id | int | ab Version 1.0 | ID des Hosts |
Rückgabewert
...
Liste mit den Profil-
...
Status des Hosts.
Ein Eintrag in der Liste enthält folgende Werte:
| Wert | Typ | Version |
|---|
| id | int | ab Version 1.0 |
| description | string | ab Version 1.0 |
| status | int | ab Version 1.0 |
| output | string | ab Version 1.0 |
...
bsm.profile.create
Beschreibung
Legt ein neues Profil an.
Beispielaufruf
| Codeblock |
|---|
|
{
"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
| Parameter | Typ | Version | Beschreibung |
|---|
| description | string | ab Version 1.0 | Name bzw. Beschreibung des Profils |
| operation | string | ab Version 1.0 | Methode zur Berechnung des Status |
| operation_value | string | ab Version 1.0 | Optional: Argument für die Methode zur Berechnung des Status |
| default_status | int | ab Version 1.0 | Standard-Status, sofern keine Regel zutrifft |
| is_template | boolean | ab Version 1.0 | Profil kann als Vorlage verwendet werden |
| services | array | ab Version 1.0 | Liste der verwendeten Dienste des Profils |
| rules | array | ab Version 1.0 | Liste der Regeln des Profils |
Rückgabewert
| Wert | Typ | Version |
|---|
| current_date | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
| message | string | ab Version 1.0 |
...
bsm.profile.
...
update
Beschreibung
...
Aktualisiert ein
...
vorhandenes Profil.
Beispielaufruf
| Codeblock |
|---|
|
{
"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
| Parameter | Typ | Version | Beschreibung |
|---|
| profile_id | int | ab Version 1.0 | ID des zu bearbeitenden Profils |
| description | string | ab Version 1.0 | Name bzw. Beschreibung des Profils |
| operation | string | ab Version 1.0 | Methode zur Berechnung des Status |
| operation_value | string | ab Version 1.0 | Optional: Argument für die Methode zur Berechnung des Status |
| default_status | int | ab Version 1.0 | Standard-Status, sofern keine Regel zutrifft |
| is_template | boolean | ab Version 1.0 | Profil kann als Vorlage verwendet werden |
| services | array | ab Version 1.0 | Liste der verwendeten Dienste des Profils |
| rules | array | ab Version 1.0 | Liste der Regeln des Profils |
Rückgabewert
| Wert | Typ | Version |
|---|
| current_date | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
| message | string | ab Version 1.0 |
...
bsm.profile.delete
Beschreibung
Löscht ein vorhandenes Profil.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.profile.delete",
"params": {
"apikey": "24174j3tqj",
"profile_id": 8
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version | Beschreibung |
|---|
| profile_id | int | ab Version 1.0 | ID des zu löschenden Profils |
Rückgabewert
| Wert | Typ | Version |
|---|
| current_date | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
| message | string | ab Version 1.0 |