`runzero.api.scans`#

Management of an Organization’s sites.

Module Contents#

`ScanOptions`	Options which can be set to create or modify a scan.
`Scans`	Management of runZero scans.

class runzero.api.scans.Scans(client: runzero.client.Client)[source]#

Management of runZero scans.

Scans create tasks which modify asset inventory of a single site.

Parameters:: client (runzero.client.Client) – A handle to the runzero.Client client which manages interactions with the runZero server.

Constructor method

create(org_id: uuid.UUID, scan_options: runzero.types.ScanOptions, site_id: uuid.UUID) → runzero.types.Task | None[source]#

Starts a scan to bring data into the site using provided options.

Parameters:

org_id (uuid.UUID) – The ID of the organization to operate against
scan_options (runzero.types.ScanOptions) – ScanOptions describing the scan to perform on the given site.
site_id (uuid.UUID) – The ID of the site which will have inventory modified by results of the scan.

Returns:

Task

Raises:

AuthError, ClientError, ServerError

Return type:

Optional[runzero.types.Task]