Rollen-Objekt

Die folgenden Objekte stehen in direktem Zusammenhang mit der role API.

Rolle

Das Rollenobjekt hat die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
roleid ID ID der Rolle.

Eigenschaftsverhalten:
- schreibgeschützt
- erforderlich für Aktualisierungsvorgänge
name string Name der Rolle.

Eigenschaftsverhalten:
- erforderlich für Erstellungsvorgänge
type integer Benutzertyp.

Mögliche Werte:
1 - (Standard) Benutzer;
2 - Admin;
3 - Super-Admin.

Eigenschaftsverhalten:
- erforderlich für Erstellungsvorgänge
readonly integer Gibt an, ob die Rolle schreibgeschützt ist.

Mögliche Werte:
0 - (Standard) Nein;
1 - Ja.

Eigenschaftsverhalten:
- schreibgeschützt

Rollenregeln

Das Objekt für Rollenregeln verfügt über die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
ui array Array der UI-Element-Objekte.
ui.default_access integer Gibt an, ob der Zugriff auf neue UI-Elemente aktiviert ist.

Mögliche Werte:
0 - Deaktiviert;
1 - (Standard) Aktiviert.
services.read.mode integer Schreibgeschützter Zugriff auf Services.

Mögliche Werte:
0 - Schreibgeschützter Zugriff auf die in den Eigenschaften services.read.list angegebenen oder durch services.read.tag gefundenen Services;
1 - (Standard) Schreibgeschützter Zugriff auf alle Services.
services.read.list array Array von Service-Objekten.

Für die angegebenen Services einschließlich untergeordneter Services wird der Benutzerrolle schreibgeschützter Zugriff gewährt. Der schreibgeschützte Zugriff überschreibt keinen Lese-/Schreibzugriff auf die Services.

Verhalten der Eigenschaft:
- unterstützt, wenn services.read.mode auf "0" gesetzt ist
services.read.tag object Array von Service-Tag-Objekten.

Für die durch das Tag gefundenen Services einschließlich untergeordneter Services wird der Benutzerrolle schreibgeschützter Zugriff gewährt. Der schreibgeschützte Zugriff überschreibt keinen Lese-/Schreibzugriff auf die Services.

Verhalten der Eigenschaft:
- unterstützt, wenn services.read.mode auf "0" gesetzt ist
services.write.mode integer Lese-/Schreibzugriff auf Services.

Mögliche Werte:
0 - (Standard) Lese-/Schreibzugriff auf die in den Eigenschaften services.write.list angegebenen oder durch services.write.tag gefundenen Services;
1 - Lese-/Schreibzugriff auf alle Services.
services.write.list array Array von Service-Objekten.

Für die angegebenen Services einschließlich untergeordneter Services wird der Benutzerrolle Lese-/Schreibzugriff gewährt. Der Lese-/Schreibzugriff überschreibt den schreibgeschützten Zugriff auf die Services.

Verhalten der Eigenschaft:
- unterstützt, wenn services.write.mode auf "0" gesetzt ist
services.write.tag object Array von Service-Tag-Objekten.

Für die durch das Tag gefundenen Services einschließlich untergeordneter Services wird der Benutzerrolle Lese-/Schreibzugriff gewährt. Der Lese-/Schreibzugriff überschreibt den schreibgeschützten Zugriff auf die Services.

Verhalten der Eigenschaft:
- unterstützt, wenn services.write.mode auf "0" gesetzt ist
modules array Array der Modul-Objekte.
modules.default_access integer Gibt an, ob der Zugriff auf neue Module aktiviert ist.

Mögliche Werte:
0 - Deaktiviert;
1 - (Standard) Aktiviert.
api.access integer Gibt an, ob der Zugriff auf die API aktiviert ist.

Mögliche Werte:
0 - (Standard) Deaktiviert;
1 - Aktiviert.
api.mode integer Modus für die Behandlung der in der Eigenschaft api aufgeführten API-Methoden.

Mögliche Werte:
0 - (Standard) Ausschlussliste;
1 - Positivliste.
api array Array von API-Methoden.
actions array Array der Aktion-Objekte.
actions.default_access integer Gibt an, ob der Zugriff auf neue Aktionen aktiviert ist.

Mögliche Werte:
0 - Deaktiviert;
1 - (Standard) Aktiviert.
devices.access integer Gibt an, ob der Zugriff auf die eigenen Mobilgeräte des Benutzers zur Verwendung mit der Zabbix-Mobile-App aktiviert ist.

Mögliche Werte:
0 - (Standard für Benutzer und Administrator) Deaktiviert;
1 - (Standard für Superadministrator) Aktiviert.

Verhalten der Eigenschaft:
- unterstützt, wenn EnableMobileDevices aktiviert ist
devices.actions array Array von Geräteaktions-Objekten.

Verhalten der Eigenschaft:
- unterstützt, wenn devices.access auf "1" gesetzt ist
devices.actions.default_access integer Gibt an, ob der Zugriff auf neue Geräteaktionen aktiviert ist.

Mögliche Werte:
0 - (Standard für Benutzer und Administrator) Deaktiviert;
1 - (Standard für Superadministrator) Aktiviert.

Verhalten der Eigenschaft:
- unterstützt, wenn EnableMobileDevices aktiviert ist

UI-Element

Das UI-Element-Objekt verfügt über die folgenden Eigenschaften:

Property Type Description
name string Name des UI-Elements.

Mögliche Werte, wenn type des Role-Objekts auf „User“, „Admin“ oder „Super admin“ gesetzt ist:
monitoring.dashboard - Dashboards;
monitoring.problems - Monitoring > Problems;
monitoring.hosts - Monitoring > Hosts;
monitoring.latest_data - Monitoring > Latest data;
monitoring.maps - Monitoring > Maps;
services.services - Services > Services;
services.sla_report - Services > SLA report;
inventory.overview - Inventory > Overview;
inventory.hosts - Inventory > Hosts;
reports.availability_report - Reports > Availability report;
reports.top_triggers - Reports > Triggers top 100.

Mögliche Werte, wenn type des Role-Objekts auf „Admin“ oder „Super admin“ gesetzt ist:
monitoring.discovery - Monitoring > Discovery;
services.sla - Services > SLA;
reports.scheduled_reports - Reports > Scheduled reports;
reports.notifications - Reports > Notifications;
configuration.template_groups - Data collection > Template groups;
configuration.host_groups - Data collection > Host groups;
configuration.templates - Data collection > Templates;
configuration.hosts - Data collection > Hosts;
configuration.maintenance - Data collection > Maintenance;
configuration.discovery - Data collection > Discovery;
configuration.trigger_actions - Alerts > Actions > Trigger actions;
configuration.service_actions - Alerts > Actions > Service actions;
configuration.discovery_actions - Alerts > Actions > Discovery actions;
configuration.autoregistration_actions - Alerts > Actions > Autoregistration actions;
configuration.internal_actions - Alerts > Actions > Internal actions.

Mögliche Werte, wenn type des Role-Objekts auf „Super admin“ gesetzt ist:
reports.system_info - Reports > System information;
reports.audit - Reports > Audit log;
reports.action_log - Reports > Action log;
configuration.event_correlation - Data collection > Event correlation;
administration.media_types - Alerts > Media types;
administration.scripts - Alerts > Scripts;
administration.user_groups - Users > User groups;
administration.user_roles - Users > User roles;
administration.users - Users > Users;
administration.api_tokens - Users > API tokens;
administration.authentication - Users > Authentication;
administration.linked_devices - Users > Devices;
administration.general - Administration > General;
administration.audit_log - Administration > Audit log;
administration.housekeeping - Administration > Housekeeping;
administration.proxy_groups - Administration > Proxy groups;
administration.proxies - Administration > Proxies;
administration.macros - Administration > Macros;
administration.queue - Administration > Queue.

Property behavior:
- required
status integer Gibt an, ob der Zugriff auf das UI-Element aktiviert ist.

Mögliche Werte:
0 - Deaktiviert;
1 - (default) Aktiviert.

Service

Eigenschaft Typ Beschreibung
serviceid ID ID des Service.

Verhalten der Eigenschaft:
- erforderlich

Service-Tag

Eigenschaft Typ Beschreibung
tag string Tag-Name.

Wenn eine leere Zeichenfolge angegeben wird, wird das Service-Tag nicht für den Service-Abgleich verwendet.

Verhalten der Eigenschaft:
- erforderlich
value string Tag-Wert.

Wenn kein Wert oder eine leere Zeichenfolge angegeben wird, wird nur der Tag-Name für den Service-Abgleich verwendet.

Modul

Das Modulobjekt hat die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
moduleid ID ID des Moduls.

Eigenschaftsverhalten:
- erforderlich
status integer Gibt an, ob der Zugriff auf das Modul aktiviert ist.

Mögliche Werte:
0 - Deaktiviert;
1 - (Standard) Aktiviert.

Aktion

Das Aktionsobjekt verfügt über die folgenden Eigenschaften:

Property Type Description
name string Name der Aktion.

Mögliche Werte, wenn type des Role-Objekts auf „User“, „Admin“ oder „Super admin“ gesetzt ist:
edit_dashboards - Dashboards erstellen und bearbeiten;
edit_maps - Karten erstellen und bearbeiten;
add_problem_comments - Problemkommentare hinzufügen;
change_severity - Problemschweregrad ändern;
acknowledge_problems - Probleme bestätigen;
suppress_problems - Probleme unterdrücken;
close_problems - Probleme schließen;
execute_scripts - Skripte ausführen;
manage_api_tokens - API-Token verwalten;
change_problem_ranking - Die Problemrangfolge von Ursache zu Symptom und umgekehrt ändern;
edit_own_media - Das Erstellen/Bearbeiten eigener Medien erlauben.

Mögliche Werte, wenn type des Role-Objekts auf „Admin“ oder „Super admin“ gesetzt ist:
edit_maintenance - Wartungen erstellen und bearbeiten;
manage_scheduled_reports - Geplante Berichte verwalten,
manage_sla - SLA verwalten,
select_server_for_monitoring - Das Erstellen von Hosts erlauben, die vom Server überwacht werden, sowie von Hosts, die durch vom Server ausgeführte Netzwerkerkennungsregeln erkannt werden.

Mögliche Werte, wenn type des Role-Objekts auf „User“ oder „Admin“ gesetzt ist:
invoke_execute_now - Benutzern mit ausschließlich Leseberechtigungen für einen Host erlauben, Datenpunktprüfungen auszuführen.

Mögliche Werte, wenn type des Role-Objekts auf „Super admin“ gesetzt ist:
edit_user_media - Das Erstellen/Bearbeiten von Medien für Benutzer erlauben.

Property behavior:
- required
status integer Gibt an, ob der Zugriff zum Ausführen der Aktion aktiviert ist.

Mögliche Werte:
0 - Deaktiviert;
1 - (default) Aktiviert.

Geräteaktion

Das Geräteaktionsobjekt verfügt über die folgenden Eigenschaften:

Property Type Description
name string Name der Geräteaktion.

Mögliche Werte, wenn type des Role-Objekts auf „User“, „Admin“ oder „Super admin“ gesetzt ist:
manage_own - Erlaubt das Hinzufügen oder Entfernen der eigenen Mobilgeräte des Benutzers.

Mögliche Werte, wenn type des Role-Objekts auf „Super admin“ gesetzt ist:
manage_user - Erlaubt das Hinzufügen oder Entfernen von Mobilgeräten für alle Benutzer.

Verhalten der Eigenschaft:
- erforderlich
status integer Gibt an, ob der Zugriff zum Ausführen der Aktion aktiviert ist.

Mögliche Werte:
0 - Deaktiviert;
1 - (Standard) Aktiviert.