Workload Security システム設定を構成する

このAPIを使用すると、多くの Workload Security システム設定にアクセスできます。配置直後に設定を自動化すると便利です。

次のSDKクラスを使用してシステム設定と対話します。

  • SystemSettings:利用可能なすべてのシステム設定のプロパティを定義します。プロパティは、対応するシステム設定の名前に基づいています。システム設定のリストについては、設定のレファレンス/参照情報に システム設定 を参照してください。
  • SettingValue:単一の文字列値を格納します。 SettingValue オブジェクトを使用して、SettingValueタイプの SystemSettings プロパティの値を格納します。
  • SystemSettingsApi: Workload Security でシステム設定を指定および変更できます( SystemSettings オブジェクト), を使用して、特定のシステム設定の値を取得、変更、およびリセットできます)。

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

1つまたは少数のシステム設定で作業している場合は、 SystemSettingsApi クラスのメソッドまたは関数を使用して、単一のシステム設定にアクセスできます。

  • 設定を取得するか、初期設定値にリセットするには、 SystemSettingsApi クラスを作成し、 describeSystemSetting または resetSystemSetting のメソッドまたは関数を使用します。設定名を引数に含めます。(設定のリストについては、 System Settings を参照してください。)
  • 設定を変更するには、 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)

例:単一のシステム設定を変更する

次の例では、エージェントが開始するアクティベーションを許可するかどうかを制御するシステム設定の値を設定します。

ソースを表示

# 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を使用してシステム設定を変更するには、次の一般的な手順を使用します。

  1. 設定しているすべてのシステム設定に対して、 SettingValue オブジェクトを作成します。各オブジェクトの値を、対応するシステム設定の値に設定します。
  2. SystemSettings オブジェクトを作成し、プロパティを SettingValue オブジェクトに設定します。
  3. 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)

例:複数のシステム設定を変更する

次の例では、ユーザが作成できる最大セッション数を制御するシステム設定と、最大値を超えたときにマネージャが実行する処理の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による認証]を参照してください。(../api-send-request/#authenticate)