このAPIを使用すると、多くの Workload Security システム設定にアクセスできます。配置直後に設定を自動化すると便利です。
次のSDKクラスを使用してシステム設定と対話します。
  • SystemSettings: 利用可能なすべてのシステム設定のプロパティを定義します。プロパティは、それに対応するシステム設定にちなんで名付けられています。システム設定の一覧については、設定レファレンスの システム設定 を参照してください。
  • SettingValue: 単一の文字列値を保存します。SettingValueオブジェクトを使用して、SystemSettingsプロパティの値を保存します。これらはSettingValue型です。
  • SystemSettingsApi: SystemSettingsオブジェクトを使用してWorkload Securityのシステム設定を一覧表示および変更し、特定のシステム設定の値を取得、変更、およびリセットできます。

単一のシステム設定を取得、変更、またはリセットする 親トピック

システム設定を1つまたは少数扱う場合は、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クラスのメソッドまたは関数を使用してください。
  • listSystemSettings: Workload Securityのすべてのシステム設定に設定されている値を含むSystemSettingsオブジェクトを返します。
  • modifySystemSettings: 引数として提供されるSystemSettingsオブジェクトに従って、すべてのシステム設定を変更します。
SDKを使用してシステム設定を変更するには、次の一般的な手順を使用します。

手順

  1. 構成するすべてのシステム設定に対してSettingValueオブジェクトを作成します。各オブジェクトの値を対応するシステム設定に望む値に設定します。
  2. SystemSettingsオブジェクトを作成し、プロパティをSettingValueオブジェクトに設定します。
  3. SystemSettingsApiオブジェクトを作成し、それを使用してSystemSettingsオブジェクトに従ってWorkload Securityのシステム設定を変更します。
    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での認証を参照してください。