cterasdk.core.antivirus module

class cterasdk.core.antivirus.Antivirus(portal)

Bases: cterasdk.core.base_command.BaseCommand

Portal Antivirus APIs

Variables

servers (cterasdk.core.antivirus.AntivirusServers) – Object holding the Portal antivirus server APIs

default = ['name', 'type']
list_servers(include=None)

List the antivirus servers

Parameters

include (list[str],optional) – List of fields to retrieve, defaults to ['name', 'type']

rescan()

Scan all files using the latest antivirus update. This may take a while

status()

Get antivirus service status

suspend()

Suspend antivirus scanning

unsuspend()

Unsuspend antivirus scanning

class cterasdk.core.antivirus.AntivirusServers(portal)

Bases: cterasdk.core.base_command.BaseCommand

add(name, vendor, url, connection_timeout=5)

Add an antivirus server

Parameters
  • name (str) – Server name

  • vendor (cterasdk.core.enum.AntivirusType) – Server type

  • url (str) – Server URL (example: http://your-antivirus.server.local:1234/signature)

  • connection_timeout (int,optional) – Server connection timeout (in seconds), defaults to 5 seconds

delete(name)

Remove an antivirus server

get(name)

Get an antivirus server’s configuration

Parameters

name (str) – Server name

suspend(name)

Suspend an antivirus server

unsuspend(name)

Unsuspend antivirus scanning