ScheduleGenericPolling

Called by the GenericPolling playbook, schedules the polling task.

python · Common Scripts

Details

IDScheduleGenericPolling
Languagepython
From Version5.0.0
Docker Imagedemisto/python3:3.12.13.10404775

README

Schedules the polling task. This script is called by the GenericPolling playbook.

Script Data


Name Description
Script Type python
Tags -
Cortex XSOAR Version 4.0.0+

Inputs


Argument Name Description
ids The list of IDs to poll.
pollingCommand The name of the polling command to run.
pollingCommandArgName The name of the argument of the polling command.
dt The DT filter for polling IDs.
playbookId The ID of the playbook that contains the manual task which will be completed once the polling is done.
interval The frequency to poll. How often the polling command should run (in minutes).
timeout The amount of time to poll before declaring a timeout and resume the playbook (in minutes).
tag The tag of the blocking manual task (“Wait For Polling Task To Finish”).
additionalPollingCommandArgNames The names of additional arguments for the polling command. For example, “arg1,arg2,…”.
additionalPollingCommandArgValues The values of the additional arguments for the polling command. For example, “value1,value2,…”.

Outputs


There are no outputs for this script.

commonfields:
  id: ScheduleGenericPolling
  version: -1
name: ScheduleGenericPolling
fromversion: 5.0.0
script: ''
type: python
subtype: python3
tags: []
comment: Called by the GenericPolling playbook, schedules the polling task.
enabled: true
args:
- name: ids
  required: true
  description: List of IDs to poll.
  isArray: true
- name: pollingCommand
  required: true
  description: Name of the polling command to run.
- name: pollingCommandArgName
  required: true
  description: Name of the argument of the polling command.
  defaultValue: ids
- name: dt
  required: true
  description: DT filter for polling IDs.
- name: playbookId
  description: The ID of the playbook that contains the manual task which will be completed once the polling is done.
- name: interval
  required: true
  description: Polling frequency - how often the polling command should run (minutes).
  defaultValue: "1"
- name: timeout
  required: true
  description: How much time to poll before declaring a timeout and resuming the playbook (minutes).
  defaultValue: "60"
- name: tag
  required: true
  description: The tag of the blocking manual task ("Wait For Polling Task To Finish").
  defaultValue: polling
- name: additionalPollingCommandArgNames
  description: Names of additional arguments for the polling command (e.g. arg1,arg2,...).
  isArray: true
- name: additionalPollingCommandArgValues
  description: Values of the additional arguments for the polling command (e.g. value1,value2,...).
  isArray: true
- name: extractMode
  description: Extraction mode for subsequent runs of the command.
scripttarget: 0
tests:
- Generic Polling Test
dockerimage: demisto/python3:3.12.13.10404775