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:

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 (AD, IWA, LDAP, MFA, OPP, RUM, Radius)
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 (Cancelled, Failed, InProgress, Paused, Scheduled, Success)
targetVersion	string	The agent version to update to (example: 3.20.0)

list_agent_pools_updates

Various information about agent auto-update configuration

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 (AD, IWA, LDAP, MFA, OPP, RUM, Radius)
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 (Cancelled, Failed, InProgress, Paused, Scheduled, Success)
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
get_agent_pools_update_instance	select	poolId, updateId, subdomain		Retrieves an agent pool update by its updateId
list_agent_pools_updates	select	poolId, subdomain	scheduled	Lists all agent pool updates
create_agent_pools_update	insert	poolId, subdomain		Creates an agent pool update
update_agent_pools_update	update	poolId, updateId, subdomain		Updates an agent pool update instance and returns the latest agent pool update
delete_agent_pools_update	delete	poolId, updateId, subdomain		Deletes agent pool update
activate_agent_pools_update	exec	poolId, updateId, subdomain		Activates a scheduled agent pool update
deactivate_agent_pools_update	exec	poolId, updateId, subdomain		Deactivates scheduled agent pool update
pause_agent_pools_update	exec	poolId, updateId, subdomain		Pauses a running or queued agent pool update
resume_agent_pools_update	exec	poolId, updateId, subdomain		Resumes a running or queued agent pool update
retry_agent_pools_update	exec	poolId, updateId, 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	poolId, updateId, 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
poolId	string	ID of the agent pool for which the settings apply to
subdomain	string	(default: my-org)
updateId	string	ID of the update
scheduled	string	Return only scheduled or ad-hoc updates. If this parameter isn't provided, Okta returns the entire list of updates.

SELECT examples

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 poolId = '{{ poolId }}' -- required
AND updateId = '{{ updateId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

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 poolId = '{{ poolId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND scheduled = '{{ scheduled }}'
;

INSERT examples

create_agent_pools_update

Creates an agent pool update

INSERT INTO okta.agentpools.agent_pool_updates (
agents,
agentType,
enabled,
name,
notifyAdmin,
reason,
schedule,
sortOrder,
status,
targetVersion,
poolId,
subdomain
)
SELECT 
'{{ agents }}',
'{{ agentType }}',
{{ enabled }},
'{{ name }}',
{{ notifyAdmin }},
'{{ reason }}',
'{{ schedule }}',
{{ sortOrder }},
'{{ status }}',
'{{ targetVersion }}',
'{{ poolId }}',
'{{ 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: poolId
    value: "{{ poolId }}"
    description: Required parameter for the agent_pool_updates resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the agent_pool_updates resource.
  - name: agents
    value:
      - id: "{{ id }}"
        isHidden: {{ isHidden }}
        isLatestGAedVersion: {{ isLatestGAedVersion }}
        lastConnection: {{ lastConnection }}
        name: "{{ name }}"
        operationalStatus: "{{ operationalStatus }}"
        poolId: "{{ poolId }}"
        type: "{{ type }}"
        updateMessage: "{{ updateMessage }}"
        updateStatus: "{{ updateStatus }}"
        version: "{{ version }}"
        _links:
          self:
            hints:
              allow:
                - "{{ allow }}"
            href: "{{ href }}"
            name: "{{ name }}"
            templated: {{ templated }}
            type: "{{ type }}"
  - name: agentType
    value: "{{ agentType }}"
    description: |
      Agent types that are being monitored
    valid_values: ['AD', 'IWA', 'LDAP', 'MFA', 'OPP', 'RUM', 'Radius']
  - name: enabled
    value: {{ enabled }}
    description: |
      Indicates if auto-update is enabled for the agent pool
  - name: name
    value: "{{ name }}"
    description: |
      Name of the agent pool update
  - name: notifyAdmin
    value: {{ notifyAdmin }}
    description: |
      Indicates if the admin is notified about the update
  - name: reason
    value: "{{ reason }}"
    description: |
      Reason for the update
  - name: schedule
    description: |
      The schedule of auto-update configured by the admin
    value:
      cron: "{{ cron }}"
      delay: {{ delay }}
      duration: {{ duration }}
      lastUpdated: "{{ lastUpdated }}"
      timezone: "{{ timezone }}"
  - name: sortOrder
    value: {{ sortOrder }}
    description: |
      Specifies the sort order
  - name: status
    value: "{{ status }}"
    description: |
      Overall state for the auto-update job from the admin perspective
    valid_values: ['Cancelled', 'Failed', 'InProgress', 'Paused', 'Scheduled', 'Success']
  - name: targetVersion
    value: "{{ targetVersion }}"
    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 
agents = '{{ agents }}',
agentType = '{{ agentType }}',
enabled = {{ enabled }},
name = '{{ name }}',
notifyAdmin = {{ notifyAdmin }},
reason = '{{ reason }}',
schedule = '{{ schedule }}',
sortOrder = {{ sortOrder }},
status = '{{ status }}',
targetVersion = '{{ targetVersion }}'
WHERE 
poolId = '{{ poolId }}' --required
AND updateId = '{{ updateId }}' --required
AND 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 poolId = '{{ poolId }}' --required
AND updateId = '{{ updateId }}' --required
AND 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 
@poolId='{{ poolId }}' --required, 
@updateId='{{ updateId }}' --required, 
@subdomain='{{ subdomain }}' --required
;

deactivate_agent_pools_update

Deactivates scheduled agent pool update

EXEC okta.agentpools.agent_pool_updates.deactivate_agent_pools_update 
@poolId='{{ poolId }}' --required, 
@updateId='{{ updateId }}' --required, 
@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 
@poolId='{{ poolId }}' --required, 
@updateId='{{ updateId }}' --required, 
@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 
@poolId='{{ poolId }}' --required, 
@updateId='{{ updateId }}' --required, 
@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 
@poolId='{{ poolId }}' --required, 
@updateId='{{ updateId }}' --required, 
@subdomain='{{ subdomain }}' --required
;

stop_agent_pools_update

Stops an agent pool update

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