Dokumentation folgt in Kürze...Verwaltung einer BSM-Konfiguration eines Services.
Seitenverzeichnis:
| Inhalt |
|---|
| maxLevel | 2 |
|---|
| indent | 10px |
|---|
| style | square |
|---|
|
...
bsm.config.read
Beschreibung
Gibt die BSM-Konfiguration eines Services zurück.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.config.read",
"params": {
"apikey": "24174j3tqj",
"service_id": 19
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version |
|---|
| service_id | int | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|
| ownership | array | ab Version 1.0 |
| business | array | ab Version 1.0 |
| application | array | ab Version 1.0 |
| application_services | array | ab Version 1.0 |
| system | array | ab Version 1.0 |
| system_services | array | ab Version 1.0 |
| hardware | array | ab Version 1.0 |
| hardware_services | array | ab Version 1.0 |
...
bsm.config.read_by_obj_id
Beschreibung
Gibt eine Liste aller Service-IDs zurück, in denen das angegebene Objekt involviert ist.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.config.read_by_obj_id",
"params": {
"apikey": "24174j3tqj",
"obj_id": 123
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version |
|---|
| obj_id | int | ab Version 1.0 |
Rückgabewert
Liste der betroffenen Service-IDs.
...
bsm.config.status
Beschreibung
Gibt den Status eines konfigurierten Services zurück.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.config.status",
"params": {
"apikey": "24174j3tqj",
"service_id": 26
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version |
|---|
| service_id | int | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version | Beschreibung |
|---|
| status | int | ab Version 1.0 | Status des Services |
| output | string | ab Version 1.0 | Auflistung aller Knoten, welche den gleichen Status haben bzw. für diesen verantwortlich sind |
...
bsm.config.graph
Beschreibung
Gibt alle Knoten und Kanten für die Darstellung der BSM-Konfiguration als Graph zurück.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.config.graph",
"params": {
"apikey": "24174j3tqj",
"service_id": 19
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version |
|---|
| service_id | int | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|
| status | int | ab Version 1.0 |
| nodes | array | ab Version 1.0 |
| edges | array | ab Version 1.0 |
...
bsm.config.create
Beschreibung
Fügt einen Datensatz zur BSM-Konfiguration eines Services hinzu.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.config.create",
"params": {
"apikey": "24174j3tqj",
"service_id": 19,
"layer_id": 2,
"obj_id": 20,
"profile_id": 2,
"ref_obj_id": 40
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version | Beschreibung |
|---|
| service_id | int | ab Version 1.0 | ID des zu konfigurierenden Services |
| layer_id | int | ab Version 1.0 | ID der jeweiligen OBASHI-Schicht |
| obj_id | int | ab Version 1.0 | Optional: ID des Host-Objektes (für Schichten Application, System, Hardware, Infrastructure) Optional: ID des Service-Objektes (für Schicht Business) Optional: ID des Person-Objektes (für Schicht Ownership) |
| profile_id | int | ab Version 1.0 | Optional: ID des Profils zum Host, welcher unter obj_id angegeben wurde |
| ref_obj_id | int | ab Version 1.0 | Optional: ID des referenzierten Objektes, bspw. der Application (für Schichten Application, System) Optional: ID des Service-Objektes (für Schicht Business) |
| dependent_obj_id | int | ab Version 1.0 | Optional: ID eines abhängigen Services der jeweiligen Schicht |
Rückgabewert
| Wert | Typ | Version |
|---|
| message | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
| current_date | string | ab Version 1.0 |
...
bsm.config.update_profile
Beschreibung
Aktualisiert die Zuordnung eines Profils zu einem Host.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.config.update_profile",
"params": {
"apikey": "24174j3tqj",
"config_id": 8,
"profile_id": 2
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version | Beschreibung |
|---|
| config_id | int | ab Version 1.0 | ID des Konfigurationselementes. |
| profile_id | int | ab Version 1.0 | Optional: ID des neu zugeordneten Profils. Ist der Parameter nicht gesetzt, wird dem Host kein Profil zugeordnet. |
Rückgabewert
| Wert | Typ | Version |
|---|
| message | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
| current_date | string | ab Version 1.0 |
...
bsm.config.delete
Beschreibung
Löscht einen Datensatz aus der BSM-Konfiguration eines Services.
Beispielaufruf
| Codeblock |
|---|
|
{
"method": "bsm.config.delete",
"params": {
"apikey": "24174j3tqj",
"config_id": 8
},
"id": 1,
"version": "2.0"
} |
Parameter
| Parameter | Typ | Version |
|---|
| config_id | int | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|
| message | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
| current_date | string | ab Version 1.0 |