Workload Security システム設定を構成する
このAPIを使用すると、多くの Workload Security システム設定にアクセスできます。配置直後に設定を自動化すると便利です。
次のSDKクラスを使用してシステム設定と対話します。
SystemSettings
:利用可能なすべてのシステム設定のプロパティを定義します。プロパティは、対応するシステム設定の名前に基づいています。システム設定のリストについては、設定の参照のシステム設定を参照してください。SettingValue
:単一の文字列値を格納します。SettingValue
オブジェクトを使用して、SettingValueタイプのSystemSettings
プロパティの値を格納します。SystemSettingsApi
: (SystemSettings
オブジェクトを使用して) Workload Securityのシステム設定をリストおよび変更したり、特定のシステム設定の値を取得、変更、およびリセットできます。
単一のシステム設定を取得、変更、またはリセットする
1つまたは少数のシステム設定で作業している場合は、 SystemSettingsApi
クラスのメソッドまたは関数を使用して、単一のシステム設定にアクセスできます。
- 設定を取得する、または初期値にリセットするには、
SystemSettingsApi
クラスを作成し、describeSystemSetting
またはresetSystemSetting
のメソッドまたは関数を使用します。設定名を引数として含めます。設定のリストについては、システム設定を参照してください。 - 設定を変更するには、
SystemSettingsApi
クラスを作成し、modifySystemSetting
メソッドまたは関数を使用し、設定名と設定値を引数として指定します。値はSettingValue
オブジェクトです。
システム設定を変更するには、設定の名前と目的の値を含む SettingValue
オブジェクトが必要です。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 Workload Security
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:
Workload Securityのすべてのシステム設定に設定されている値を含むSystemSettings
オブジェクトを返します。modifySystemSettings:
引数として指定されたSystemSettings
オブジェクトに従って、すべてのシステム設定を変更します。
SDKを使用してシステム設定を変更するには、次の一般的な手順を使用します。
- 設定しているすべてのシステム設定に対して、
SettingValue
オブジェクトを作成します。各オブジェクトの値を、対応するシステム設定の値に設定します。 SystemSettings
オブジェクトを作成し、プロパティをSettingValue
オブジェクトに設定します。SystemSettingsApi
オブジェクトを作成し、それを使用して Workload Security のシステム設定をSystemSettings
オブジェクトに従って変更します。
SettingValue
の値の型は String
です。次の例では、100に設定する設定の SettingValue
を作成します。
max_sessions = api.SettingValue()
max_sessions.value = "100"
SettingValue
を設定の値として使用します。
system_settings = api.SystemSettings()
system_settings.platform_setting_active_sessions_max_num = max_sessions
最後に、 Workload Securityの設定を変更します。
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 Workload Security
settings_api = api.SystemSettingsApi(api.ApiClient(configuration))
return settings_api.modify_system_settings(system_settings, api_version)
『APIレファレンス/参照情報』 の システム設定の変更 操作も参照してください。 API呼び出しの認証の詳細については、「Workload Securityによる認証」を参照してください。