APIを使用すると、多くの Server & Workload Protection システム設定にアクセスできます。配置の直後に設定を自動化すると便利です。
システム設定を操作するには、次のSDKクラスを使用します。
SystemSettings
: 使用可能なすべてのシステム設定のプロパティを定義します。プロパティの名前は、対応するシステム設定に基づいて付けられます。システム設定のリストについては、を参照してください。システム設定をレファレンス/参照情報してください。SettingValue
: 単一の文字列値を格納します。使用するSettingValue
値を格納するオブジェクトSystemSettings
プロパティの種類はSettingValueです。SystemSettingsApi
: Server & Workload Protection のシステム設定を表示および変更できます (SystemSettings
オブジェクト) を使用して、特定のシステム設定の値を取得、変更、およびリセットします。
単一のシステム設定の取得、変更、またはリセット
1つまたは少数のシステム設定を使用している場合は、
SystemSettingsApi
単一のシステム設定へのアクセスを提供するクラス:- 設定を取得したり、初期設定値にリセットしたりするには、
SystemSettingsApi
クラスを選択し、describeSystemSetting
またはresetSystemSetting
メソッドまたは関数。設定名を引数として含めます。 (「システム設定設定のリストを参照してください)。 - 設定を変更するには、
SystemSettingsApi
クラスを選択し、modifySystemSetting
メソッドまたは関数を指定し、引数として設定名と設定値を含めます。値はSettingValue
オブジェクト。
システム設定を変更するには、設定の名前と
SettingValue
目的の値を含むオブジェクト。 aの値に注意してください。SettingValue
オブジェクトはString
:# value for platform_setting_agent_initiated_activation_enabled allow_value = api.SettingValue() allow_value.value = str(allow)
次に、SystemSettingsApiオブジェクトを使用して設定を変更します。
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)
例: 単一のシステム設定の変更
次の例では、Agentからのアクティベーションを許可するかどうかを制御するシステム設定の値を設定します。
# Create the setting value allow_value = api.SettingValue() allow_value.value = str(allow) # Modify system setting on Server & 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)Server & 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)
また、システム設定の変更操作については、 APIレファレンス/参照情報を参照してください。
複数のシステム設定を一覧表示または変更する
多くのシステム設定を使用している場合は、
SystemSettingsApi
1回の呼び出しですべてのシステム設定にアクセスできるようにするクラス:listSystemSettings:
Server & Workload Protectionのすべてのシステム設定に設定されている値を含む SystemSettings オブジェクトを返します。modifySystemSettings:
引数として指定されたSystemSettingsオブジェクトに従って、すべてのシステム設定を変更します。
SDKを使用してシステム設定を変更するには、次の一般的な手順を実行します。
手順
- 作成する
SettingValue
設定するすべてのシステム設定のオブジェクト。各オブジェクトの値を、対応するシステム設定で必要な値に設定します。 - 作成する
SystemSettings
オブジェクトを選択し、プロパティをSettingValue
オブジェクト。 - 作成する
SystemSettingsApi
オブジェクトを作成し、それを使用して Server & Workload Protection のシステム設定を変更します。SystemSettings
オブジェクト。
次に進む前に
SettingValue
値は文字列型です。次の例では、SettingValue
100に設定する場合:max_sessions = api.SettingValue() max_sessions.value = "100"
を使用します。
SettingValue
設定値:system_settings = api.SystemSettings() system_settings.platform_setting_active_sessions_max_num = max_sessions
最後に、 Server & Workload Protectionの設定を変更します。
settings_api = api.SystemSettingsApi(api.ApiClient(configuration)) return settings_api.modify_system_settings(system_settings, api_version)
例: 複数のシステム設定の変更
次の例では、ユーザが作成できるセッションの最大数を制御するシステム設定と、最大数を超えた場合にManagerが実行する処理の2つのシステム設定を指定します。
# 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 & Workload Protection settings_api = api.SystemSettingsApi(api.ApiClient(configuration)) return settings_api.modify_system_settings(system_settings, api_version)Server & Workload Protection settings_api = api.SystemSettingsApi(api.ApiClient(configuration)) return settings_api.modify_system_settings(system_settings, api_version)
また、システム設定の変更操作については、 APIレファレンス/参照情報を参照してください。 API呼び出しの認証の詳細については、「[Authenticate with Server & Workload Protection]」を参照してください。(../api-send-request/#authenticate)