Na tej stronie
Obiekt roli
Następujące obiekty są bezpośrednio powiązane z API role.
Rola
Obiekt roli ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| roleid | ID | ID roli. Zachowanie właściwości: - tylko do odczytu - wymagane dla operacji aktualizacji |
| name | string | Nazwa roli. Zachowanie właściwości: - wymagane dla operacji tworzenia |
| type | integer | Typ użytkownika. Możliwe wartości: 1 - (domyślnie) Użytkownik; 2 - Admin; 3 - Super admin. Zachowanie właściwości: - wymagane dla operacji tworzenia |
| readonly | integer | Czy rola jest tylko do odczytu. Możliwe wartości: 0 - (domyślnie) Nie; 1 - Tak. Zachowanie właściwości: - tylko do odczytu |
Reguły roli
Obiekt reguł roli ma następujące właściwości:
| Property | Type | Description |
|---|---|---|
| ui | array | Tablica obiektów elementów interfejsu użytkownika. |
| ui.default_access | integer | Określa, czy dostęp do nowych elementów interfejsu użytkownika jest włączony. Możliwe wartości: 0 - Wyłączony; 1 - (domyślnie) Włączony. |
| profile.redirect.enforce | integer | Określa, czy adres URL przekierowania na poziomie roli po uwierzytelnieniu jest wymuszany i nie może zostać zastąpiony przez użytkownika. Możliwe wartości: 0 - (domyślnie) Wyłączony; 1 - Włączony. |
| profile.redirect.url | string | Adres URL używany do przekierowania użytkownika po uwierzytelnieniu. |
| services.read.mode | integer | Dostęp do usług tylko do odczytu. Możliwe wartości: 0 - Dostęp tylko do odczytu do usług określonych przez właściwość services.read.list lub pasujących do właściwości services.read.tag;1 - (domyślnie) Dostęp tylko do odczytu do wszystkich usług. |
| services.read.list | array | Tablica obiektów Service. Określone usługi, w tym usługi podrzędne, otrzymają dostęp tylko do odczytu dla roli użytkownika. Dostęp tylko do odczytu nie zastąpi dostępu do usług w trybie odczytu i zapisu. Zachowanie właściwości: - obsługiwana, jeśli services.read.mode ma wartość „0”. |
| services.read.tag | object | Tablica obiektów Service tag. Usługi pasujące do tagów, w tym usługi podrzędne, otrzymają dostęp tylko do odczytu dla roli użytkownika. Dostęp tylko do odczytu nie zastąpi dostępu do usług w trybie odczytu i zapisu. Zachowanie właściwości: - obsługiwana, jeśli services.read.mode ma wartość „0”. |
| services.write.mode | integer | Dostęp do usług w trybie odczytu i zapisu. Możliwe wartości: 0 - (domyślnie) Dostęp w trybie odczytu i zapisu do usług określonych przez właściwość services.write.list lub pasujących do właściwości services.write.tag;1 - Dostęp w trybie odczytu i zapisu do wszystkich usług. |
| services.write.list | array | Tablica obiektów Service. Określone usługi, w tym usługi podrzędne, otrzymają dostęp w trybie odczytu i zapisu dla roli użytkownika. Dostęp w trybie odczytu i zapisu zastąpi dostęp tylko do odczytu do usług. Zachowanie właściwości: - obsługiwana, jeśli services.write.mode ma wartość „0”. |
| services.write.tag | object | Tablica obiektów Service tag. Usługi pasujące do tagów, w tym usługi podrzędne, otrzymają dostęp w trybie odczytu i zapisu dla roli użytkownika. Dostęp w trybie odczytu i zapisu zastąpi dostęp tylko do odczytu do usług. Zachowanie właściwości: - obsługiwana, jeśli services.write.mode ma wartość „0”. |
| modules | array | Tablica obiektów modułów. |
| modules.default_access | integer | Określa, czy dostęp do nowych modułów jest włączony. Możliwe wartości: 0 - Wyłączony; 1 - (domyślnie) Włączony. |
| api.access | integer | Określa, czy dostęp do API jest włączony. Możliwe wartości: 0 - (domyślnie) Wyłączony; 1 - Włączony. |
| api.mode | integer | Tryb obsługi metod API wymienionych we właściwości api.Możliwe wartości: 0 - (domyślnie) Lista blokowanych; 1 - Lista dozwolonych. Zachowanie właściwości: - obsługiwana, jeśli api.access ma wartość „1”. |
| api | array | Tablica metod API. Obsługiwane są symbole wieloznaczne, na przykład: * (dowolna metoda), dashboard.*, *.export.Jeśli nie określono żadnych metod, dostęp do wszystkich metod API jest zabroniony, gdy api.mode ma wartość „1” (lista dozwolonych), i dozwolony, gdy api.mode ma wartość „0” (lista blokowanych).Zachowanie właściwości: - obsługiwana, jeśli api.access ma wartość „1”. |
| actions | array | Tablica obiektów akcji. |
| actions.default_access | integer | Określa, czy dostęp do nowych akcji jest włączony. Możliwe wartości: 0 - Wyłączony; 1 - (domyślnie) Włączony. |
| devices.access | integer | Określa, czy dostęp do własnych urządzeń mobilnych użytkownika w celu korzystania z aplikacji mobilnej Zabbix jest włączony. Możliwe wartości: 0 - (domyślnie dla użytkownika i administratora) Wyłączony; 1 - (domyślnie dla superadministratora) Włączony. Zachowanie właściwości: - obsługiwana, jeśli EnableMobileDevices jest włączona |
| devices.actions | array | Tablica obiektów akcji urządzeń. Zachowanie właściwości: - obsługiwana, jeśli devices.access ma wartość „1” |
| devices.actions.default_access | integer | Określa, czy dostęp do nowych akcji urządzeń jest włączony. Możliwe wartości: 0 - (domyślnie dla użytkownika i administratora) Wyłączony; 1 - (domyślnie dla superadministratora) Włączony. Zachowanie właściwości: - obsługiwana, jeśli EnableMobileDevices jest włączona |
Element interfejsu użytkownika
Obiekt elementu interfejsu użytkownika ma następujące właściwości:
| Property | Type | Description |
|---|---|---|
| name | string | Nazwa elementu interfejsu użytkownika. Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „User”, „Admin” lub „Super admin”:monitoring.dashboard - Pulpity nawigacyjne;monitoring.problems - Monitoring > Problemy;monitoring.hosts - Monitoring > Hosty;monitoring.latest_data - Monitoring > Najnowsze dane;monitoring.maps - Monitoring > Mapy;services.services - Usługi > Usługi;services.sla_report - Usługi > Raport SLA;inventory.overview - Inwentaryzacja > Przegląd;inventory.hosts - Inwentaryzacja > Hosty;reports.availability_report - Raporty > Raport dostępności;reports.top_triggers - Raporty > 100 najważniejszych wyzwalaczy.Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „Admin” lub „Super admin”:monitoring.discovery - Monitoring > Wykrywanie;services.sla - Usługi > SLA;reports.scheduled_reports - Raporty > Raporty zaplanowane;reports.notifications - Raporty > Powiadomienia;configuration.template_groups - Gromadzenie danych > Grupy szablonów;configuration.host_groups - Gromadzenie danych > Grupy hostów;configuration.templates - Gromadzenie danych > Szablony;configuration.hosts - Gromadzenie danych > Hosty;configuration.maintenance - Gromadzenie danych > Okresy utrzymania;configuration.event_processing - Gromadzenie danych > Przetwarzanie zdarzeń;configuration.discovery - Gromadzenie danych > Wykrywanie;configuration.trigger_actions - Alerty > Działania > Działania wyzwalaczy;configuration.service_actions - Alerty > Działania > Działania usług;configuration.discovery_actions - Alerty > Działania > Działania wykrywania;configuration.autoregistration_actions - Alerty > Działania > Działania automatycznej rejestracji;configuration.internal_actions - Alerty > Działania > Działania wewnętrzne.Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „Super admin”:reports.system_info - Raporty > Informacje o systemie;reports.audit - Raporty > Dziennik audytu;reports.action_log - Raporty > Dziennik działań;administration.media_types - Alerty > Typy mediów;administration.scripts - Alerty > Skrypty;administration.user_groups - Użytkownicy > Grupy użytkowników;administration.user_roles - Użytkownicy > Role użytkowników;administration.users - Użytkownicy > Użytkownicy;administration.api_tokens - Użytkownicy > Tokeny API;administration.authentication - Użytkownicy > Uwierzytelnianie;administration.general - Administracja > Ogólne;administration.audit_log - Administracja > Dziennik audytu;administration.housekeeping - Administracja > Porządkowanie;administration.proxy_groups - Administracja > Grupy proxy;administration.proxies - Administracja > Proxy;administration.macros - Administracja > Makra;administration.queue - Administracja > Kolejka.Zachowanie właściwości: - required |
| name | string | Nazwa elementu interfejsu użytkownika. Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „User”, „Admin” lub „Super admin”:monitoring.dashboard - Pulpity nawigacyjne;monitoring.problems - Monitoring > Problemy;monitoring.hosts - Monitoring > Hosty;monitoring.latest_data - Monitoring > Najnowsze dane;monitoring.maps - Monitoring > Mapy;services.services - Usługi > Usługi;services.sla_report - Usługi > Raport SLA;inventory.overview - Inwentaryzacja > Przegląd;inventory.hosts - Inwentaryzacja > Hosty;reports.availability_report - Raporty > Raport dostępności;reports.top_triggers - Raporty > 100 najważniejszych wyzwalaczy.Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „Admin” lub „Super admin”:monitoring.discovery - Monitoring > Wykrywanie;services.sla - Usługi > SLA;reports.scheduled_reports - Raporty > Raporty zaplanowane;reports.notifications - Raporty > Powiadomienia;configuration.template_groups - Gromadzenie danych > Grupy szablonów;configuration.host_groups - Gromadzenie danych > Grupy hostów;configuration.templates - Gromadzenie danych > Szablony;configuration.hosts - Gromadzenie danych > Hosty;configuration.maintenance - Gromadzenie danych > Okresy utrzymania;configuration.discovery - Gromadzenie danych > Wykrywanie;configuration.trigger_actions - Alerty > Działania > Działania wyzwalaczy;configuration.service_actions - Alerty > Działania > Działania usług;configuration.discovery_actions - Alerty > Działania > Działania wykrywania;configuration.autoregistration_actions - Alerty > Działania > Działania automatycznej rejestracji;configuration.internal_actions - Alerty > Działania > Działania wewnętrzne.Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „Super admin”:reports.system_info - Raporty > Informacje o systemie;reports.audit - Raporty > Dziennik audytu;reports.action_log - Raporty > Dziennik działań;configuration.event_correlation - Gromadzenie danych > Korelacja zdarzeń;administration.media_types - Alerty > Typy mediów;administration.scripts - Alerty > Skrypty;administration.user_groups - Użytkownicy > Grupy użytkowników;administration.user_roles - Użytkownicy > Role użytkowników;administration.users - Użytkownicy > Użytkownicy;administration.api_tokens - Użytkownicy > Tokeny API;administration.authentication - Użytkownicy > Uwierzytelnianie;administration.linked_devices - Użytkownicy > Urządzenia;administration.general - Administracja > Ogólne;administration.audit_log - Administracja > Dziennik audytu;administration.housekeeping - Administracja > Porządkowanie;administration.proxy_groups - Administracja > Grupy proxy;administration.proxies - Administracja > Proxy;administration.macros - Administracja > Makra;administration.queue - Administracja > Kolejka.Zachowanie właściwości: - required |
| status | integer | Określa, czy dostęp do elementu interfejsu użytkownika jest włączony. Możliwe wartości: 0 - Wyłączony; 1 - (default) Włączony. |
Usługa
| Właściwość | Type | Opis |
|---|---|---|
| serviceid | ID | ID usługi. Property behavior: - wymagane |
Znacznik usługi
| Właściwość | Type | Opis |
|---|---|---|
| tag | string | Nazwa znacznika. Jeśli zostanie podany pusty ciąg znaków, znacznik usługi nie będzie używany do dopasowywania usług. Zachowanie właściwości: - wymagane |
| value | string | Wartość znacznika. Jeśli nie zostanie podana żadna wartość lub zostanie podany pusty ciąg znaków, do dopasowywania usług będzie używana tylko nazwa znacznika. |
Moduł
Obiekt modułu ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| moduleid | ID | ID modułu. Zachowanie właściwości: - wymagane |
| status | integer | Czy dostęp do modułu jest włączony. Możliwe wartości: 0 - Wyłączony; 1 - (domyślnie) Włączony. |
Działanie
Obiekt działania ma następujące właściwości:
| Property | Type | Description |
|---|---|---|
| name | string | Nazwa działania. Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „User”, „Admin” lub „Super admin”:edit_dashboards - Tworzenie i edytowanie pulpitów nawigacyjnych;edit_maps - Tworzenie i edytowanie map;add_problem_comments - Dodawanie komentarzy do problemów;change_severity - Zmienianie ważności problemu;acknowledge_problems - Potwierdzanie problemów;suppress_problems - Wyciszanie problemów;close_problems - Zamykanie problemów;execute_scripts - Wykonywanie skryptów;manage_api_tokens - Zarządzanie tokenami API;change_problem_ranking - Zmienianie klasyfikacji problemu z przyczyny na objaw i odwrotnie;edit_own_media - Zezwalanie użytkownikom na tworzenie i edytowanie własnych mediów.Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „Admin” lub „Super admin”:edit_maintenance - Tworzenie i edytowanie okresów konserwacji;manage_scheduled_reports - Zarządzanie zaplanowanymi raportami,manage_sla - Zarządzanie SLA,select_server_for_monitoring - Zezwalanie użytkownikom na tworzenie hostów monitorowanych przez serwer oraz przez reguły wykrywania sieci wykonywane przez serwer.Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „User” lub „Admin”:invoke_execute_now - Zezwalanie użytkownikom, którzy mają tylko uprawnienia do odczytu hosta, na wykonywanie kontroli pozycji.Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „Super admin”:edit_user_media - Zezwalanie użytkownikom na tworzenie i edytowanie mediów innych użytkowników.Zachowanie właściwości: - required |
| status | integer | Określa, czy dostęp do wykonywania działania jest włączony. Możliwe wartości: 0 - Wyłączone; 1 - (default) Włączone. |
Działanie dotyczące urządzenia
Obiekt działania dotyczącego urządzenia ma następujące właściwości:
| Property | Type | Description |
|---|---|---|
| name | string | Nazwa działania dotyczącego urządzenia. Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „User”, „Admin” lub „Super admin”:manage_own - Zezwalaj użytkownikom na dodawanie lub usuwanie własnych urządzeń mobilnych.Możliwe wartości, jeśli właściwość type obiektu Role jest ustawiona na „Super admin”:manage_user - Zezwalaj użytkownikom na dodawanie lub usuwanie urządzeń mobilnych wszystkich użytkowników.Zachowanie właściwości: - required |
| status | integer | Określa, czy dostęp do wykonywania działania jest włączony. Możliwe wartości: 0 - Wyłączone; 1 - (default) Włączone. |