agent_pool_update_settings

Creates, updates, deletes, gets or lists an agent_pool_update_settings resource.

Overview

Name	agent_pool_update_settings
Type	Resource
Id	okta.agentpools.agent_pool_update_settings

Fields

The following fields are returned by SELECT queries:

get_agent_pools_update_settings

Name	Datatype	Description
agentType	string	Agent types that are being monitored (AD, IWA, LDAP, MFA, OPP, RUM, Radius)
continueOnError	boolean	Continues the update even if some agents fail to update
latestVersion	string	Latest version of the agent (example: 3.20.0)
minimalSupportedVersion	string	Minimal version of the agent (example: 3.19.0)
poolId	string	ID of the agent pool that the settings apply to (example: 0oa3eu7ekG8tjbD9J5s6)
poolName	string	Pool name (example: iwa.dc)
releaseChannel	string	Release channel for auto-update (BETA, EA, GA, TEST)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agent_pools_update_settings	select	poolId, subdomain		Retrieves the current state of the agent pool update instance settings
update_agent_pools_update_settings	update	poolId, subdomain, agentType		Updates an agent pool update instance settings

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
poolId	string	ID of the agent pool for which the settings apply to
subdomain	string	(default: my-org)

SELECT examples

get_agent_pools_update_settings

Retrieves the current state of the agent pool update instance settings

SELECT
agentType,
continueOnError,
latestVersion,
minimalSupportedVersion,
poolId,
poolName,
releaseChannel
FROM okta.agentpools.agent_pool_update_settings
WHERE poolId = '{{ poolId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

UPDATE examples

update_agent_pools_update_settings

Updates an agent pool update instance settings

UPDATE okta.agentpools.agent_pool_update_settings
SET 
agentType = '{{ agentType }}',
continueOnError = {{ continueOnError }},
latestVersion = '{{ latestVersion }}',
minimalSupportedVersion = '{{ minimalSupportedVersion }}',
poolName = '{{ poolName }}',
releaseChannel = '{{ releaseChannel }}'
WHERE 
poolId = '{{ poolId }}' --required
AND subdomain = '{{ subdomain }}' --required
AND agentType = '{{ agentType }}' --required
RETURNING
agentType,
continueOnError,
latestVersion,
minimalSupportedVersion,
poolId,
poolName,
releaseChannel;