https://github.com/mikej81/xc-orphan-tool
F5 XC Tool to search for and remove purged orphan objects and search for Request ID across all namespaces.
https://github.com/mikej81/xc-orphan-tool
Last synced: about 2 months ago
JSON representation
F5 XC Tool to search for and remove purged orphan objects and search for Request ID across all namespaces.
- Host: GitHub
- URL: https://github.com/mikej81/xc-orphan-tool
- Owner: Mikej81
- Created: 2023-12-21T17:17:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-16T21:38:25.000Z (about 1 year ago)
- Last Synced: 2025-02-12T17:31:56.649Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# F5 XC Node.JS Tool (Orphaned Object Cleaner & Req ID Search)
Report / Audit all application namespaces in a tenant. Delete all orphaned objects across all Application Namespaces. To use, install, configure API URL, populate token, run code.
Getting set up to use F5 Distributed Cloud APIs:
## Install
```bash
npm install
node index.js
```
## Configure
```node
const ORIGIN_URL = "https://.console.ves.volterra.io/api";
const API_TOKEN = "REPLACE WITH TOKEN";
// Configuration flags
const PURGE_ORPHANS = false; // Default value is false, can also be specified via argument.
const SHOW_ALL_NAMESPACE = false; // Default value is false, can also be specified via argument.
```
* PURGE_ORPHANS allows you to report on objects or remove them. If you just want to report on objects ensure the value is false. If you want to remove objects, set to true.
* SHOW_ALL_NAMESPACE allows you to report results even when there are no orphaned objects, useful to report on Load Balancers and Routes. If you are not interested in Load Balancer and Route Count, then set to false to only show orphaned objects.
## Usage
### Audit / Purge Orphaned Objects
There are now a few arguments that can be passed to the command.
To get a report of existing orphaned objects use the following:
```bash
node.js index.js --audit-orphans [--purge-orphans] [--show-all-namespaces] [--show-protected]
```
* --audit-orphans is required to audit / purge objects that are not currently referenced by any other objects.
* --purge-orphans is optional, and will delete all orphaned objects
* --show-all-namespaces is optional and will show all namespaces.
* --show-protected is optional and will show all loadbalancers in a namespace that have security services enabled.
Objects will not purge unless the value has been changed in the script variables or if you use the --purge-orphans argument.
### Cleans up
* App Firewalls
* Service Policies
* App Settings
* Origin Pools
### Reports
* Load Balancers
* Route Count
### Search for Request ID
To query all namespaces and load balancers for a Request ID use the following:
```bash
node.js index.js --query-req-id= [--time=h/d]
```
* --query-req-id is required, specify the request id.
* --time allows you to specify a time frame in hours or days in xxh or xxd format. You can specify up to 24h or 30d. if no time is specified the script will default to the past 1 hour.
## To Do
* clean up code and outputs