{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":44197,"path":"security-management/sbom-core/vr-sbom-run-cleanup.md","title":"Configure rules and run an SBOM cleanup job","bundle":null,"doc_type":null,"release":"australia","body":"\n# Configure rules and run an SBOM cleanup job\n\nCreate and run a one-time cleanup rule to permanently purge older SBOM records that match the conditions you specify.\n\n## Before you begin\n\nThe SBOM Response application is required to access the SBOM cleanup module.\n\n**Warning:**\n\nPause all SBOM uploads and any data imports before you run a cleanup job to avoid potential conflicts.\n\nRole required: sn\\_sbom\\_core.admin\n\n## About this task\n\n## Procedure\n\n1. Navigate to **SBOM Workspace** > **Configuration** > **SBOM cleanup**.\n\n2. Select **Create cleanup run** if this is the first cleanup rule for your instance, or **New Cleanup run** if one or more cleanup runs already exist.\n\n Only one cleanup can run at a time. If you submit a new cleanup while another is in progress, the new cleanup is queued and runs after the current one completes.\n\n3. In the SBOM cleanup dialog, fill out the fields to you want to use to define the cleanup scope.\n\n\n
\n\nField\n\n\n\nDescription\n\n
\n\n**Delete SBOMs older than \\***\n\n\n\nSelect the minimum age of the records to delete: **90 days**, **180 days**, **1 year**, or **2 year**. Record age is calculated using the SBOM creation date.\n\n
\n\n**Include all associated Product models and Business applications in the cleanup**\n\n\n\nSelected by default. When selected, all product models and business applications that match your age condition are included in the cleanup.\n\n Deselect the **Product models to exclude** and **Business applications to exclude** fields to preserve specific product models or business applications.\n\n
\n\n**Product models to exclude**\n\n\n\nAvailable when **Include all associated Product models and Business applications in the cleanup** is deselected. Add one or more product models, for example `glibc`, to preserve from the cleanup.\n\n
\n\n**Business applications to exclude**\n\n\n\nAvailable when **Include all associated Product models and Business applications in the cleanup** is deselected. Add one or more business applications, for example `production-api`, `payments-core`, or `HR Portal`, to preserve from the cleanup.\n\n
4. Select **Run cleanup**.\n\n5. On the Review cleanup details modal, review the cleanup summary, including the age threshold, cleanup scope, and any excluded product models or business applications.\n\n Select **Back** to return to the previous dialog and modify the scope, or **Cancel** to exit without running the cleanup.\n\n **Danger**\n\n Cleanup runs are permanent and can't be undone. Deleted SBOM records can't be restored. Review the cleanup scope and exclusions carefully before running a cleanup.\n\n6. Select **Run cleanup** to submit the cleanup run.\n\n A confirmation modal indicates that your cleanup run was submitted. The cleanup run is queued and runs in the background. Completion time varies based on the number of records being processed. Select **Ok, got it** to close the dialog.\n\n You can monitor the progress of your cleanup run in the **Cleanup runs** table on the SBOM cleanup page. The table includes the following information.\n\n\n
\n\nColumn\n\n\n\nDescription\n\n
\n\nCreated on\n\n\n\nDate and time the cleanup run was submitted.\n\n
\n\nCreated by\n\n\n\nUser who submitted the cleanup run.\n\n
\n\nDelete SBOMs older than\n\n\n\nAge threshold specified for the cleanup run.\n\n
\n\nCleanup scope\n\n\n\nActivated by default. When selected, all product models and business applications that match your age setting are removed.\n\n Deselect the check box and list the product models and business applications that fall within your age setting that you want skipped during the cleanup.\n\n
\n\nStatus\n\n\n\nCurrent state of the cleanup run, for example `In progress`\n\n **Note:** If you select **New cleanup run** in the Review cleanup details modal while a run is currently in process, your new run is displayed with the `Queued` state.\n\n
\n\nSBOM deleted\n\n\n\nNumber of SBOM records deleted so far out of the total number of records matched by the cleanup conditions, for example `20/2500`.\n\n
While a cleanup run is queued, you can select **Cancel queued run** to cancel it before it starts.\n\n7. To cancel a queued cleanup run, select a run in the `Queued` state from the list at **SBOM Workspace** > **Configuration** > **SBOM cleanup** and select **Cancel queued cleanup run**.\n\n The cleanup run transitions from `Queued` to `Cancelled`. You can cancel a scheduled job while another job is running.\n\n\n"}}