This article defines how a Dynamic Virtual Private Network (DVPN) event can be retrieved by using an API, in addition to checking the Contrail Service Orchestration (CSO) UI logs.

A dynamic VPN event is created when an overlay tunnel is created after meeting the criteria defined for DVPN tunnel creation. An example object is given as follows:

{
    "dvpn_event": {
        "parent_uuid": "1462d227-2131-478e-8f78-a4995f73b8e9",
        "timestamp": 1597662871.821015,
        "vpn_name": "tenant_DefaultVPN",
        "parent_type": "project",
        "perms2": {
            "owner": "1462d2272131478e8f78a4995f73b8e9",
            "owner_access": 7,
            "global_access": 0,
            "share": [
                {
                    "tenant_access": 7,
                    "tenant": "45f1033764954b899cee9f6ea25a667f"
                },
                {
                    "tenant_access": 4,
                    "tenant": "share.child_projects"
                }
            ]
        },
        "display_name": "70b56ecd-9d91-4d12-ae1e-3374c500b268",
        "tunnel_count": 0,
        "name": "70b56ecd-9d91-4d12-ae1e-3374c500b268",
        "site2_id": "08dda429-3f0c-490a-8242-97fdd9ce2231",
        "fq_name": [
            "default-domain",
            "tenant",
            "70b56ecd-9d91-4d12-ae1e-3374c500b268"
        ],
        "uuid": "eac47984-c0da-4db0-9abd-87980a019f95",
        "vpn_id": "ed53d8f7-1052-4718-9bbf-75d675acd378",
        "tenant_id": "1462d2272131478e8f78a4995f73b8e9",
        "uri": "/fmpm-provider/dvpn_event/eac47984-c0da-4db0-9abd-87980a019f95",
        "tunnels_type": "STATIC",
        "site1_id": "75a0049a-178a-4a72-8c06-a98a68e397fc",
        "id_perms": {
            "enable": true,
            "uuid": {
                "uuid_mslong": 16916779711388601776,
                "uuid_lslong": 11150217339511873429
            },
            "created": "2020-08-17T11:14:32.046671",
            "description": null,
            "creator": "cspadmin",
            "user_visible": true,
            "last_modified": "2020-08-17T11:14:32.046671",
            "modifier": "cspadmin",
            "permissions": {
                "owner": "cspadmin",
                "owner_access": 7,
                "other_access": 7,
                "group": "_member_",
                "group_access": 7
            }
        },
        "details": {
            "reason": "add-wan-link"
        },
        "action": "UPDATE",
        "parent_uri": "/fmpm-provider/project/1462d227-2131-478e-8f78-a4995f73b8e9"
    }
}

When a DVPN tunnel is created or deleted, CSO generates events that can be retrieved by using the CSP API. See Dynamic Tunnel VPN Overview and Configuring Dynamic Tunnel Thresholds .

• GET /fmpm-provider/dvpn_event?detail=true&filter=((site2_id=08dda429-3f0c-490a-8242-97fdd9ce2231) or (site1_id=08dda429-3f0c-490a-8242-97fdd9ce2231))

The response format would be the same as above.

• GET /fmpm-provider/dvpn_event?detail=true&filter=((timestamp>1597662870) and (timestamp<1597662872))