| Name | pan-os-duplicate-finder JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A command-line tool to find duplicate address objects across PAN-OS device groups |
| upload_time | 2025-01-14 21:51:02 |
| maintainer | None |
| docs_url | None |
| author | Calvin Remsburg |
| requires_python | <4.0,>=3.10 |
| license | Apache 2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PAN-OS Duplicate Finder
[](https://pypi.org/project/pan-os-duplicate-finder/)
[](./LICENSE)
`pan-os-duplicate-finder` is a command-line tool designed to identify duplicate address objects across Palo Alto Networks firewalls and Panorama device groups. This tool helps network administrators maintain cleaner configurations by identifying redundant address objects that could be consolidated.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Basic Usage](#basic-usage)
- [Creating the Settings File](#creating-the-settings-file)
- [Finding Duplicates](#finding-duplicates)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Easy Setup**: Store credentials and preferences in a `settings.yaml` file for reuse
- **Comprehensive Search**: Scans both shared space and all device groups
- **Flexible Output**: Generate CSV reports with detailed information about duplicates
- **Rich Console Output**: Clear, colorful display of duplicate findings
- **Device Group Awareness**: Track which device groups contain duplicate objects
- **Secure Credentials**: Support for both direct credential input and settings file
## Installation
**Requirements**:
- Python 3.10 or higher
Install directly from PyPI:
```bash
pip install pan-os-duplicate-finder
```
## Basic Usage
Once installed, the primary command is `pan-os-duplicate-finder`. Running `--help` displays available options and commands:
```bash
pan-os-duplicate-finder --help
```
Available commands include:
- `find`: Find duplicate address objects
- `settings`: Create a settings file
- `version`: Show version information
## Creating the Settings File
Before scanning for duplicates, you can create a `settings.yaml` file to store your credentials and preferences:
```bash
pan-os-duplicate-finder settings
```
This will create a template `settings.yaml` file that you can edit with your specific details:
```yaml
hostname: "" # Your Panorama or firewall hostname/IP
username: "" # Your username
password: "" # Your password
logging: "INFO" # Logging level (INFO/DEBUG)
output_format: "csv" # Output format for results
```
## Finding Duplicates
With your settings configured, you can search for duplicate address objects:
```bash
# Using settings file
pan-os-duplicate-finder find
# Or provide credentials directly
pan-os-duplicate-finder find --hostname panorama.example.com --username admin
```
The tool will:
1. Connect to your device
2. Retrieve all address objects from shared space and device groups
3. Analyze for duplicates
4. Generate a CSV report
5. Display a summary in the console
Example CSV output includes:
- Object name
- Device group location
- Address value
- Address type
- Description
- Duplicate group identifier
Example console output shows:
- Total number of duplicates found
- Summary table of duplicates by type
- Device groups containing duplicates
### Additional Options
```bash
# Enable debug logging
pan-os-duplicate-finder find --debug
# Specify output file
pan-os-duplicate-finder find --output my-report.csv
# Save debug logs to file
pan-os-duplicate-finder find --debug --log-file debug.log
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
`pan-os-duplicate-finder` is licensed under the Apache 2.0 License. See the [LICENSE](./LICENSE) file for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "pan-os-duplicate-finder",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Calvin Remsburg",
"author_email": "cremsburg.dev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ba/cc/577f6449326f00c9998b25bc92c4e7f83fa3eaa36ccbde5571d34fc518bb/pan_os_duplicate_finder-0.1.0.tar.gz",
"platform": null,
"description": "# PAN-OS Duplicate Finder\n\n[](https://pypi.org/project/pan-os-duplicate-finder/)\n[](./LICENSE)\n\n`pan-os-duplicate-finder` is a command-line tool designed to identify duplicate address objects across Palo Alto Networks firewalls and Panorama device groups. This tool helps network administrators maintain cleaner configurations by identifying redundant address objects that could be consolidated.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Basic Usage](#basic-usage)\n- [Creating the Settings File](#creating-the-settings-file)\n- [Finding Duplicates](#finding-duplicates)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- **Easy Setup**: Store credentials and preferences in a `settings.yaml` file for reuse\n- **Comprehensive Search**: Scans both shared space and all device groups\n- **Flexible Output**: Generate CSV reports with detailed information about duplicates\n- **Rich Console Output**: Clear, colorful display of duplicate findings\n- **Device Group Awareness**: Track which device groups contain duplicate objects\n- **Secure Credentials**: Support for both direct credential input and settings file\n\n## Installation\n\n**Requirements**:\n\n- Python 3.10 or higher\n\nInstall directly from PyPI:\n\n```bash\npip install pan-os-duplicate-finder\n```\n\n## Basic Usage\n\nOnce installed, the primary command is `pan-os-duplicate-finder`. Running `--help` displays available options and commands:\n\n```bash\npan-os-duplicate-finder --help\n```\n\nAvailable commands include:\n- `find`: Find duplicate address objects\n- `settings`: Create a settings file\n- `version`: Show version information\n\n## Creating the Settings File\n\nBefore scanning for duplicates, you can create a `settings.yaml` file to store your credentials and preferences:\n\n```bash\npan-os-duplicate-finder settings\n```\n\nThis will create a template `settings.yaml` file that you can edit with your specific details:\n\n```yaml\nhostname: \"\" # Your Panorama or firewall hostname/IP\nusername: \"\" # Your username\npassword: \"\" # Your password\nlogging: \"INFO\" # Logging level (INFO/DEBUG)\noutput_format: \"csv\" # Output format for results\n```\n\n## Finding Duplicates\n\nWith your settings configured, you can search for duplicate address objects:\n\n```bash\n# Using settings file\npan-os-duplicate-finder find\n\n# Or provide credentials directly\npan-os-duplicate-finder find --hostname panorama.example.com --username admin\n```\n\nThe tool will:\n1. Connect to your device\n2. Retrieve all address objects from shared space and device groups\n3. Analyze for duplicates\n4. Generate a CSV report\n5. Display a summary in the console\n\nExample CSV output includes:\n- Object name\n- Device group location\n- Address value\n- Address type\n- Description\n- Duplicate group identifier\n\nExample console output shows:\n- Total number of duplicates found\n- Summary table of duplicates by type\n- Device groups containing duplicates\n\n### Additional Options\n\n```bash\n# Enable debug logging\npan-os-duplicate-finder find --debug\n\n# Specify output file\npan-os-duplicate-finder find --output my-report.csv\n\n# Save debug logs to file\npan-os-duplicate-finder find --debug --log-file debug.log\n```\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\n`pan-os-duplicate-finder` is licensed under the Apache 2.0 License. See the [LICENSE](./LICENSE) file for more details.",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "A command-line tool to find duplicate address objects across PAN-OS device groups",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4062dbb31373478dd467d66df4af63aa85409eb222961987063695e2837abae",
"md5": "9f89189d2be7c5df36bc69bf723d1c7b",
"sha256": "a62344c492af2fd800fea9393c77f100bf3b61854ca126ac111516064a54ab9f"
},
"downloads": -1,
"filename": "pan_os_duplicate_finder-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9f89189d2be7c5df36bc69bf723d1c7b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 13071,
"upload_time": "2025-01-14T21:51:00",
"upload_time_iso_8601": "2025-01-14T21:51:00.447950Z",
"url": "https://files.pythonhosted.org/packages/f4/06/2dbb31373478dd467d66df4af63aa85409eb222961987063695e2837abae/pan_os_duplicate_finder-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bacc577f6449326f00c9998b25bc92c4e7f83fa3eaa36ccbde5571d34fc518bb",
"md5": "3a61e436511dd2f5a3a1a098fe29cfb4",
"sha256": "615d1e47d8119933a119d5e9cc7bc90dff2def2fe91bd78cb20525b64fa9f403"
},
"downloads": -1,
"filename": "pan_os_duplicate_finder-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3a61e436511dd2f5a3a1a098fe29cfb4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 17347,
"upload_time": "2025-01-14T21:51:02",
"upload_time_iso_8601": "2025-01-14T21:51:02.190772Z",
"url": "https://files.pythonhosted.org/packages/ba/cc/577f6449326f00c9998b25bc92c4e7f83fa3eaa36ccbde5571d34fc518bb/pan_os_duplicate_finder-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 21:51:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pan-os-duplicate-finder"
}
