agent_pool_updates

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

Overview

Name	agent_pool_updates
Type	Resource
Id	okta.agentpools.agent_pool_updates

Fields

The following fields are returned by SELECT queries:

list_agent_pools_updates

Name	Datatype	Description
id	string	ID of the agent pool update
name	string	Name of the agent pool update (example: region1A.dc)
_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.
agentType	string	Agent types that are being monitored
agents	array
enabled	boolean	Indicates if auto-update is enabled for the agent pool
notifyAdmin	boolean	Indicates if the admin is notified about the update
reason	string	Reason for the update (example: Update failed.)
schedule	object	The schedule of auto-update configured by the admin
sortOrder	integer	Specifies the sort order
status	string	Overall state for the auto-update job from the admin perspective
targetVersion	string	The agent version to update to (example: 3.20.0)

get_agent_pools_update_instance

Name	Datatype	Description
id	string	ID of the agent pool update
name	string	Name of the agent pool update (example: region1A.dc)
_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.
agentType	string	Agent types that are being monitored
agents	array
enabled	boolean	Indicates if auto-update is enabled for the agent pool
notifyAdmin	boolean	Indicates if the admin is notified about the update
reason	string	Reason for the update (example: Update failed.)
schedule	object	The schedule of auto-update configured by the admin
sortOrder	integer	Specifies the sort order
status	string	Overall state for the auto-update job from the admin perspective
targetVersion	string	The agent version to update to (example: 3.20.0)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_agent_pools_updates	select	subdomain	scheduled	Lists all agent pool updates
get_agent_pools_update_instance	select	subdomain		Retrieves an agent pool update by its updateId
create_agent_pools_update	insert	subdomain		Creates an agent pool update
update_agent_pools_update	update	subdomain		Updates an agent pool update instance and returns the latest agent pool update
delete_agent_pools_update	delete	subdomain		Deletes agent pool update
activate_agent_pools_update	exec	subdomain		Activates a scheduled agent pool update
deactivate_agent_pools_update	exec	subdomain		Deactivates scheduled agent pool update
pause_agent_pools_update	exec	subdomain		Pauses a running or queued agent pool update
resume_agent_pools_update	exec	subdomain		Resumes a running or queued agent pool update
retry_agent_pools_update	exec	subdomain		Retries an agent pool update if the update is unsuccessful or communication with Okta was interrupted during an agent auto-update
stop_agent_pools_update	exec	subdomain		Stops an agent pool update

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	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)
scheduled	boolean	Return only scheduled or ad-hoc updates. If this parameter isn't provided, Okta returns the entire list of updates.

SELECT examples

list_agent_pools_updates

Lists all agent pool updates

SELECT
id,
name,
_links,
agentType,
agents,
enabled,
notifyAdmin,
reason,
schedule,
sortOrder,
status,
targetVersion
FROM okta.agentpools.agent_pool_updates
WHERE subdomain = '{{ subdomain }}' -- required
AND scheduled = '{{ scheduled }}'
;

get_agent_pools_update_instance

Retrieves an agent pool update by its updateId

SELECT
id,
name,
_links,
agentType,
agents,
enabled,
notifyAdmin,
reason,
schedule,
sortOrder,
status,
targetVersion
FROM okta.agentpools.agent_pool_updates
WHERE subdomain = '{{ subdomain }}' -- required
;

INSERT examples

create_agent_pools_update

Creates an agent pool update

INSERT INTO okta.agentpools.agent_pool_updates (
data__agents,
data__agentType,
data__enabled,
data__name,
data__notifyAdmin,
data__reason,
data__schedule,
data__sortOrder,
data__status,
data__targetVersion,
subdomain
)
SELECT 
'{{ agents }}',
'{{ agentType }}',
{{ enabled }},
'{{ name }}',
{{ notifyAdmin }},
'{{ reason }}',
'{{ schedule }}',
{{ sortOrder }},
'{{ status }}',
'{{ targetVersion }}',
'{{ subdomain }}'
RETURNING
id,
name,
_links,
agentType,
agents,
enabled,
notifyAdmin,
reason,
schedule,
sortOrder,
status,
targetVersion
;

Manifest

# Description fields are for documentation purposes
- name: agent_pool_updates
  props:
    - name: subdomain
      value: string
      description: Required parameter for the agent_pool_updates resource.
    - name: agents
      value: array
    - name: agentType
      value: string
      description: >
        Agent types that are being monitored
        
      valid_values: ['AD', 'IWA', 'LDAP', 'MFA', 'OPP', 'RUM', 'Radius']
    - name: enabled
      value: boolean
      description: >
        Indicates if auto-update is enabled for the agent pool
        
    - name: name
      value: string
      description: >
        Name of the agent pool update
        
    - name: notifyAdmin
      value: boolean
      description: >
        Indicates if the admin is notified about the update
        
    - name: reason
      value: string
      description: >
        Reason for the update
        
    - name: schedule
      value: object
      description: >
        The schedule of auto-update configured by the admin
        
    - name: sortOrder
      value: integer
      description: >
        Specifies the sort order
        
    - name: status
      value: string
      description: >
        Overall state for the auto-update job from the admin perspective
        
      valid_values: ['Cancelled', 'Failed', 'InProgress', 'Paused', 'Scheduled', 'Success']
    - name: targetVersion
      value: string
      description: >
        The agent version to update to
        

UPDATE examples

update_agent_pools_update

Updates an agent pool update instance and returns the latest agent pool update

UPDATE okta.agentpools.agent_pool_updates
SET 
data__agents = '{{ agents }}',
data__agentType = '{{ agentType }}',
data__enabled = {{ enabled }},
data__name = '{{ name }}',
data__notifyAdmin = {{ notifyAdmin }},
data__reason = '{{ reason }}',
data__schedule = '{{ schedule }}',
data__sortOrder = {{ sortOrder }},
data__status = '{{ status }}',
data__targetVersion = '{{ targetVersion }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
id,
name,
_links,
agentType,
agents,
enabled,
notifyAdmin,
reason,
schedule,
sortOrder,
status,
targetVersion
;

DELETE examples

delete_agent_pools_update

Deletes agent pool update

DELETE FROM okta.agentpools.agent_pool_updates
WHERE subdomain = '{{ subdomain }}' --required
;

Lifecycle Methods

activate_agent_pools_update

Activates a scheduled agent pool update

EXEC okta.agentpools.agent_pool_updates.activate_agent_pools_update 
@subdomain='{{ subdomain }}' --required
;

deactivate_agent_pools_update

Deactivates scheduled agent pool update

EXEC okta.agentpools.agent_pool_updates.deactivate_agent_pools_update 
@subdomain='{{ subdomain }}' --required
;

pause_agent_pools_update

Pauses a running or queued agent pool update

EXEC okta.agentpools.agent_pool_updates.pause_agent_pools_update 
@subdomain='{{ subdomain }}' --required
;

resume_agent_pools_update

Resumes a running or queued agent pool update

EXEC okta.agentpools.agent_pool_updates.resume_agent_pools_update 
@subdomain='{{ subdomain }}' --required
;

retry_agent_pools_update

Retries an agent pool update if the update is unsuccessful or communication with Okta was interrupted during an agent auto-update

EXEC okta.agentpools.agent_pool_updates.retry_agent_pools_update 
@subdomain='{{ subdomain }}' --required
;

stop_agent_pools_update

Stops an agent pool update

EXEC okta.agentpools.agent_pool_updates.stop_agent_pools_update 
@subdomain='{{ subdomain }}' --required
;