Describes the data retention policy for the VMware SD-WAN Orchestrator.

SD-WAN Data Retention

SD-WAN Data System Property Default Maximum Prior to 4.0 Release

Enterprise Events

retentionWeeks.enterpriseEvents

40 weeks

1 year

40 weeks

Enterprise Alerts

N/A

40 weeks

1 year

No policy

Operator Events

retentionWeeks.operatorEvents

40 weeks

1 year

40 weeks

Enterprise Proxy Events

retentionWeeks.proxyEvents

40 weeks

1 year

40 weeks

Firewall Logs

retentionWeeks.firewallLogs

Not supported

Not supported

40 weeks

Link Stats

retention.linkstats.days

40 weeks

1 year

40 weeks

Link QoE

retention.linkquality.days

40 weeks

1 year

40 weeks

Path Stats

retention.pathstats.days

2 weeks

2 weeks

N/A

Flow Stats

retention.lowResFlows.months

retention.highResFlows.days

1 year – 1 hour rollup

2 weeks – 5 min

1 year – 1 hour rollup

3 month – 5 min

1 year with rollup

Edge Health Stats (Release 5.0 and later) retention.healthstats.days 1 year 1 year N/A

Important Notes

  • The 4.0 release flow statistics defaults will apply for the flow statistics retention post upgrade. To configure retention values for flow statistics, please follow the instructions below. The system properties pertaining to flow statistics in releases 3.3 and 3.4 will be deprecated upon upgrade to the 4.0 release.
  • Currently, as per design, the Edge Stats data is present in monthly partitions. So, if we were to truncate data older than 2 weeks, it essentially truncates data older than a month and the SD-WAN Orchestrator Monitor page displays the current and the immediate previous month's health stats data.
  • For detailed usage information regarding Edge Health Stats, see System Tab and Monitor System Information of an Edge.

Changing the Flow Stats Retention Period

Operators can change the retention period by creating new System Properties. Follow the steps below to create new System Properties for high resolution and low resolution retention periods in days and months.

High Resolution Retention Period

High resolution flow stats retention can be configured anywhere between 1 and 90 days. Follow the steps below to create a new System Property for the high resolution retention period.

  1. From the SD-WAN Orchestrator navigation panel, click System Properties.
  2. In the System Properties screen, click the New System Properties button.
  3. In the New System Property dialog box:
    1. Type retention.highResFlows.days in the Name text field.
    2. In the Data Type drop-down menu, choose Number.
    3. In the Value text field, enter the retention period in number of days.
      Note: High resolution retention period has a maximum of 90 days, and the resolution is 5 minutes.

  4. Click Save.

Low Resolution Retention Period

The low resolution flow stats can be configured to persist anywhere between 1 and 365 days. Follow the steps below to create a new System Property for the low resolution retention period.
  1. From the SD-WAN Orchestrator navigation panel, click System Properties.
  2. In the System Properties screen, click the New System Properties button.
  3. In the New System Property dialog box:
    1. In the Name text field, type retention.lowResFlows.months
    2. In the Data Type drop-down menu, choose Number.
    3. In the Value text field, enter the retention period in number of months.
      Note: The low resolution retention period has a maximum of 1 year, and the resolution is 1 hour.

  4. Click Save.

Changing the Flow Stats Query Interval

If Operators would like to view flow statistics for more than two weeks, the following system property must be enabled, session.options.maxFlowstatsRetentionDays. See the section below for instructions on how to enable this system property.

  1. From the SD-WAN Orchestrator navigation panel, click System Properties.
  2. In the System Properties screen, click the New System Properties button.
  3. In the New System Property dialog box:
    1. In the Name text field, type session.options.maxFlowstatsRetentionDays
    2. In the Data Type drop-down menu, choose Number.
    3. In the Value text field, enter the retention period in number of days.

  4. Click Save.