servicetask#

Autogenerated API

argus_api.lib.eventfilters.v2.servicetask.abort_task(taskID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Abort a running or pending task (INTERNAL)

Parameters

  • taskID (str) – ID of task to abort

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.eventfilters.v2.servicetask.get_task(taskID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List status for service tasks (INTERNAL)

Parameters

  • taskID (str) – ID of task to fetch

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.eventfilters.v2.servicetask.list_tasks(state: str = None, operation: str = None, user: str = None, parentTask: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List status for service tasks (INTERNAL)

Parameters

  • state (list) – Filter results by state

  • operation (list) – Filter results by operation (service dependant)

  • user (list) – Filter results by user (id or shortname)

  • parentTask (list) – Filter results by parent task ID

  • limit (int) – Limit number of results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.eventfilters.v2.servicetask.search_tasks(limit: int = None, offset: int = None, operation: str = None, state: str = None, user: str = None, parentTask: str = None, startTimestamp: int = None, endTimestamp: int = None, timeFieldStrategy: str = None, timeMatchStrategy: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List status for service tasks (INTERNAL)

Parameters

  • limit (int) –

  • offset (int) –

  • operation (list) – Filter tasks by operation name. Valid operations are service dependant.

  • state (list) – Filter tasks by state.

  • user (list) – Filter tasks by creating user (id or shortname).

  • parentTask (list) – Filter tasks by parent task ID

  • startTimestamp (int) – Filter tasks with selected time fields after this timestamp.

  • endTimestamp (int) – Filter tasks with selected time fields before this timestamp.

  • timeFieldStrategy (list) – Select which time fields to use for time search. Defaults to ‘all’

  • timeMatchStrategy (str) – Select if any or all time fields must match time search. Defaults to ‘any’.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON