agent_pools

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

Overview

Name	agent_pools
Type	Resource
Id	okta.agentpools.agent_pools

Fields

The following fields are returned by SELECT queries:

list_agent_pools

An agent pool is a collection of agents that serve a common purpose. An agent pool has a unique ID within an org, and contains a collection of agents disjoint to every other agent pool, meaning that no two agent pools share an agent.

Name	Datatype	Description
id	string	Agent pool ID
name	string	Agent pool name
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
agents	array
disruptedAgents	integer	Number of agents in the pool that are in a disrupted state
inactiveAgents	integer	Number of agents in the pool that are in an inactive state
operationalStatus	string	Operational status of a given agent (DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL)
type	string	Agent types that are being monitored (AD, IWA, LDAP, MFA, OPP, RUM, Radius)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_agent_pools	select	subdomain	limitPerPoolType, poolType, after	Lists all agent pools with pagination support

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
subdomain	string	(default: my-org)
after	string	The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination and Link header.
limitPerPoolType	integer	Maximum number of agent pools returned
poolType	string	Agent type to search for

SELECT examples

list_agent_pools

Lists all agent pools with pagination support

SELECT
id,
name,
_links,
agents,
disruptedAgents,
inactiveAgents,
operationalStatus,
type
FROM okta.agentpools.agent_pools
WHERE subdomain = '{{ subdomain }}' -- required
AND limitPerPoolType = '{{ limitPerPoolType }}'
AND poolType = '{{ poolType }}'
AND after = '{{ after }}'
;