Reporting & events

Reporting

Jobs

class illumio.reporting.Job

Represents an async job in the PCE.

Jobs are read-only and track the status of async operations.

Reports

class illumio.reporting.Report

Represents a report in the PCE.

Report Schedules

class illumio.reporting.ReportSchedule

Represents a report schedule in the PCE.

Report Templates

class illumio.reporting.ReportTemplate

Represents a report template in the PCE.

Read-only. Templates define the structure and parameters for reports.

Core Service Types

class illumio.reporting.CoreServiceType

Represents a core service type in the PCE.

Detected Core Services

class illumio.reporting.DetectedCoreService

Represents a detected core service in the PCE.

Support Bundle Requests

class illumio.reporting.SupportBundleRequest

Represents a support bundle request in the PCE.

System Events

class illumio.reporting.SystemEvent

Represents a system event in the PCE.

System events are global (not scoped to an org) and read-only.

Events

class illumio.Event

Represents an event object in the PCE.

NOTE: Events are read-only via the PCE API.

See https://docs.illumio.com/core/21.5/Content/Guides/rest-api/pce-management/events.htm

Usage:

>>> import illumio
>>> pce = illumio.PolicyComputeEngine('pce.company.com', port=443, org_id=1)
>>> pce.set_credentials('api_key', 'api_secret')
>>> events = pce.events.get(params={'max_results': 5})
>>> events
[
    Event(
        href="/orgs/1/events/3764a636-4846-492f-a090-ae96cf33bddf",
        event_type="system_task.expire_service_account_api_keys",
        timestamp="2022-08-17T22:12:37.410Z",
        pce_fqdn="pce.company.com",
        severity="critical",
        status="success",
        created_by={"system": {}},
        action=ActionEvent(
            uuid="1ebad14e-bd87-42b1-ae9a-22433951fbd3",
            src_ip="FILTERED",
            ...
        ),
        resource_changes=[],
        notifications=[],
    ),
    ...
]