dxlciscopxgridclient.callbacks module

class dxlciscopxgridclient.callbacks.AncApplyEndpointPolicyCallback

Bases: dxlclient.callbacks.EventCallback

Callback wrapper which invokes the on_apply_endpoint_policy() method when an apply endpoint policy event is received.

Constructor

on_apply_endpoint_policy(apply_dict)

Method invoked when an apply endpoint policy event occurs.

Parameters:apply_dict (dict) --

Payload for the event notification. For example, the value for an event sent on application of an endpoint policy should look similar to this:

{
    "ipAddress": "192.168.1.1",
    "policyName": "quarantine_policy"
}

on_event(event)

Method invoked when an apply endpoint policy event occurs. Derived classes can implement the on_apply_endpoint_policy() method instead of this method in order to process the event payload as a dict.

Parameters:event (dxlclient.message.Event) -- Message received for the event notification

class dxlciscopxgridclient.callbacks.AncClearEndpointPolicyCallback

Bases: dxlclient.callbacks.EventCallback

Callback wrapper which invokes the on_clear_endpoint_policy() method when a clear endpoint policy event is received.

Constructor

on_clear_endpoint_policy(clear_dict)

Method invoked when a clear endpoint policy event occurs.

Parameters:clear_dict (dict) --

Payload for the event notification. For example, the value for an event sent on clearing of an endpoint policy should look similar to this:

{
    "ipAddress": "192.168.1.1"
}

on_event(event)

Method invoked when a clear endpoint policy event occurs. Derived classes can implement the on_clear_endpoint_policy() method instead of this method in order to process the event payload as a dict.

Parameters:event (dxlclient.message.Event) -- Message received for the event notification

class dxlciscopxgridclient.callbacks.AncCreatePolicyCallback

Bases: dxlclient.callbacks.EventCallback

Callback wrapper which invokes the on_create_policy() method when a clear policy event is received.

Constructor

on_create_policy(create_dict)

Method invoked when a create policy event occurs.

Parameters:create_dict (dict) --

Payload for the event notification. For example, the value for an event sent on creation of a policy should look similar to this:

{
    "action": [ "Quarantine" ],
    "name": "test_policy"
}

on_event(event)

Method invoked when an create policy event occurs. Derived classes can implement the on_create_policy() method instead of this method in order to process the event payload as a dict.

Parameters:event (dxlclient.message.Event) -- Message received for the event notification

class dxlciscopxgridclient.callbacks.AncDeletePolicyCallback

Bases: dxlclient.callbacks.EventCallback

Callback wrapper which invokes the on_delete_policy() method when a delete policy event is received.

Constructor

on_delete_policy(delete_dict)

Method invoked when an delete policy event occurs.

Parameters:delete_dict (dict) --

Payload for the event notification. For example, the value for an event sent on deletion of a policy should look similar to this:

{
    "action": [ "Quarantine" ],
    "name": "test_policy"
}

on_event(event)

Method invoked when a delete policy event occurs. Derived classes can implement the on_delete_policy() method instead of this method in order to process the event payload as a dict.

Parameters:event (dxlclient.message.Event) -- Message received for the event notification

class dxlciscopxgridclient.callbacks.AncUpdatePolicyCallback

Bases: dxlclient.callbacks.EventCallback

Callback wrapper which invokes the on_update_policy() method when an update policy event is received.

Constructor

on_event(event)

Method invoked when a update policy event occurs. Derived classes can implement the on_update_policy() method instead of this method in order to process the event payload as a dict.

Parameters:event (dxlclient.message.Event) -- Message received for the event notification

on_update_policy(update_dict)

Method invoked when an update policy event occurs.

Parameters:update_dict (dict) --

Payload for the event notification. For example, the value for an event sent on update of a policy should look similar to this:

{
    "action": [ "Quarantine" ],
    "name": "test_policy"
}

class dxlciscopxgridclient.callbacks.IdentitySessionCallback

Bases: dxlclient.callbacks.EventCallback

Callback wrapper which invokes the on_session() method when a session event is received.

Constructor

on_event(event)

Method invoked when a session event occurs. Derived classes can implement the on_session() method instead of this method in order to process the event payload as a dict.

Parameters:event (dxlclient.message.Event) -- Message received for the event notification

on_session(session_dict)

Method invoked when an session event occurs.

Parameters:session_dict (dict) --

Payload for the event notification. For example, the value for an event sent on start of a session should look similar to this:

{
    "IdentitySourceFirstPort": "0",
    "IdentitySourcePortEnd": "0",
    "IdentitySourcePortStart": "0",
    "MDMEndpoint": {},
    "RADIUSAttrs": [ {
        "attrName": "Acct-Session-Id",
        "attrValue": "123"
    } ],
    "assessedPostureEvent": [ {} ],
    "attribute": [ {
        "name": "Authorization_Profiles",
        "type": "string",
        "value": "1234"
    } ],
    "endpointCheckResult": "none",
    "endpointProfile": "Microsoft-Device",
    "gid": "24703",
    "interface": {
        "deviceAttachPt": {
            "deviceMgmtIntfID": {
                "ipAddress": "192.168.1.1"
            }
        },
        "ipIntfID": [
            { "ipAddress": "192.168.1.1" }
        ],
        "macAddress": [ "00:11:22:33:44:55" ]
    },
    "lastUpdateTime": "2017-09-21T22:43:38.006Z",
    "providers": [ "None" ],
    "state": "Started",
    "user": { "name": "root" }
}

The value for the event sent on disconnection of a session should look similar to the above, except with the "state" element set to "Disconnected", rather than "Started".