cterasdk.edge.taskmgr module#

class cterasdk.edge.taskmgr.Task(CTERAHost, ref, retries=10, seconds=1)#

Bases: TaskBase

get_task_status()#
class cterasdk.edge.taskmgr.Tasks(gateway)#

Bases: BaseCommand

Gateway Background Task APIs

by_name(name)#

Get background tasks by name

Parameters:

name (str) – Task name

running()#

Get all running background tasks

status(ref)#

Get background task status

Parameters:

ref (str) – Task reference

wait(ref, retries=100, seconds=1)#

Wait for background task to complete

Parameters:
  • ref (str) – Task reference

  • retries (int,optional) – Number of retries when sampling the task status, defaults to 100

  • seconds (int,optional) – Number of seconds to wait between retries, defaults to 1