Ansichten:
Die API bietet Zugriff auf viele der Server- und Workload Protection Systemeinstellungen. Sie ist nützlich, um Konfigurationen unmittelbar nach der Bereitstellung zu automatisieren.
Sie verwenden die folgenden SDK-Klassen, um mit den Systemeinstellungen zu interagieren:
  • SystemSettings: Definiert Eigenschaften für alle verfügbaren Systemeinstellungen. Die Eigenschaften sind nach der entsprechenden Systemeinstellung benannt. Eine Liste der Systemeinstellungen finden Sie unter Systemeinstellungen im Einstellungsreferenz.
  • SettingValue: Speichert einen einzelnen Zeichenfolgenwert. Verwenden Sie SettingValue-Objekte, um die Werte von SystemSettings-Eigenschaften zu speichern, die vom Typ SettingValue sind.
  • SystemSettingsApi: Ermöglicht Ihnen, Systemeinstellungen auf Server- und Workload Protection aufzulisten und zu ändern (unter Verwendung eines SystemSettings-Objekts), sowie den Wert einer bestimmten Systemeinstellung abzurufen, zu ändern und zurückzusetzen.

Abrufen, ändern oder zurücksetzen einer einzelnen Systemeinstellung Übergeordnetes Thema

Wenn Sie mit einer oder einer kleinen Anzahl von Systemeinstellungen arbeiten, verwenden Sie die Methoden oder Funktionen der SystemSettingsApi-Klasse, die Zugriff auf eine einzelne Systemeinstellung bieten:
  • Um eine Einstellung abzurufen oder auf den Standardwert zurückzusetzen, erstellen Sie eine SystemSettingsApi-Klasse und verwenden Sie die describeSystemSetting- oder resetSystemSetting-Methode oder -Funktion. Fügen Sie den Einstellungsnamen als Argument hinzu. (Siehe Systemeinstellungen für eine Liste der Einstellungen.)
  • Um eine Einstellung zu ändern, erstellen Sie eine SystemSettingsApi-Klasse und verwenden Sie die modifySystemSetting-Methode oder -Funktion, und geben Sie den Einstellungsnamen und den Einstellungswert als Argumente an. Der Wert ist ein SettingValue-Objekt.
Um eine Systemeinstellung zu ändern, benötigen Sie den Namen der Einstellung und ein SettingValue-Objekt, das den gewünschten Wert enthält. Beachten Sie, dass der Wert eines SettingValue-Objekts ein String ist:
# value for platform_setting_agent_initiated_activation_enabled
allow_value = api.SettingValue()
allow_value.value = str(allow)
Verwenden Sie dann ein SystemSettingsApi-Objekt, um die Einstellung zu ändern:
system_settings_api = api.SystemSettingsApi(api.ApiClient(configuration))

return system_settings_api.modify_system_setting(api.SystemSettings.platform_setting_agent_initiated_activation_enabled, allow_value, api_version)

Beispiel: Eine einzelne Systemeinstellung ändern Übergeordnetes Thema

Das folgende Beispiel legt den Wert der Systemeinstellung fest, die steuert, ob eine agenteninitiierte Aktivierung zulässig ist.
Quelle anzeigen
# Create the setting value
allow_value = api.SettingValue()
allow_value.value = str(allow)

# Modify system setting on Server- und Workload Protection
system_settings_api = api.SystemSettingsApi(api.ApiClient(configuration))
return system_settings_api.modify_system_setting(api.SystemSettings.platform_setting_agent_initiated_activation_enabled, allow_value, api_version)
Siehe auch den Vorgang zum Ändern einer Systemeinstellung im API-Referenzhandbuch.

Mehrere Systemeinstellungen auflisten oder ändern Übergeordnetes Thema

Wenn Sie mit vielen Systemeinstellungen arbeiten, verwenden Sie die Methoden oder Funktionen der SystemSettingsApi-Klasse, die Zugriff auf alle Systemeinstellungen in einem einzigen Aufruf bieten:
  • listSystemSettings: Gibt ein SystemSettings-Objekt zurück, das die Werte enthält, die für alle Systemeinstellungen auf Server- und Workload Protection festgelegt sind.
  • modifySystemSettings: Ändert alle Systemeinstellungen gemäß dem als Argument bereitgestellten SystemSettings-Objekt.
Verwenden Sie die folgenden allgemeinen Schritte, um ein SDK zu nutzen, um eine Systemeinstellung zu ändern:

Prozedur

  1. Erstellen Sie ein SettingValue-Objekt für jede Systemeinstellung, die Sie konfigurieren. Setzen Sie den Wert jedes Objekts auf den Wert, den Sie für die entsprechende Systemeinstellung wünschen.
  2. Erstellen Sie ein SystemSettings-Objekt und setzen Sie die Eigenschaften auf die SettingValue-Objekte.
  3. Erstellen Sie ein SystemSettingsApi-Objekt und verwenden Sie es, um die Systemeinstellungen auf Server- und Workload Protection gemäß dem SystemSettings-Objekt zu ändern.

Nächste Schritte

SettingValue-Werte sind vom Typ String. Das folgende Beispiel erstellt ein SettingValue für eine Einstellung, die Sie auf 100 setzen möchten:
max_sessions = api.SettingValue()
max_sessions.value = "100"
Verwenden Sie den SettingValue als Wert einer Einstellung:
system_settings = api.SystemSettings()
system_settings.platform_setting_active_sessions_max_num = max_sessions
Abschließend ändern Sie die Einstellung auf Server- und Workload Protection:
settings_api = api.SystemSettingsApi(api.ApiClient(configuration))
return settings_api.modify_system_settings(system_settings, api_version)

Beispiel: Mehrere Systemeinstellungen ändern Übergeordnetes Thema

Das folgende Beispiel legt zwei Systemeinstellungen fest: die Systemeinstellung, die die maximale Anzahl von Sitzungen steuert, die ein Benutzer erstellen kann, und die Aktion, die der Manager ergreift, wenn das Maximum überschritten wird.
Quelle anzeigen
# Create the SettingValue object and set the max sessions value
max_sessions = api.SettingValue()
max_sessions.value = str(max_allowed)

# Add the SettingValue object to a SystemSettings object
system_settings = api.SystemSettings()
system_settings.platform_setting_active_sessions_max_num = max_sessions

# Repeat for the platform_setting_active_sessions_max_exceeded_action
exceed_action = api.SettingValue()
exceed_action.value = action
system_settings.platform_setting_active_sessions_max_exceeded_action = exceed_action

# Modify system settings on Server- und Workload Protection
settings_api = api.SystemSettingsApi(api.ApiClient(configuration))
return settings_api.modify_system_settings(system_settings, api_version)
Siehe auch den Systemeinstellungen ändern Vorgang im API-Referenzhandbuch. Informationen zur Authentifizierung von API-Aufrufen finden Sie unter [Authentifizieren mit Server- und Workload Protection].(../api-send-request/#authenticate)