mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2024-11-22 20:51:07 +01:00
36 lines
2.1 KiB
Markdown
36 lines
2.1 KiB
Markdown
# PC-Network-Analyze-Tools Role
|
|
|
|
## Overview
|
|
This README accompanies the `pc-network-analyze-tools` role within the `cymais` repository. This role is dedicated to installing key network analysis tools on personal computers.
|
|
|
|
## Role Contents
|
|
The `main.yml` file in the `pc-network-analyze-tools` role includes tasks for installing essential network analysis tools:
|
|
|
|
1. **Install Administrator Network Analyze Tools**:
|
|
- Utilizes the `community.general.pacman` module to install:
|
|
- `traceroute`: A network diagnostic tool for tracing the path that an IP packet follows to reach its destination.
|
|
- `wireshark-qt`: The Qt-based graphical interface for Wireshark, a network protocol analyzer.
|
|
- `wireshark-cli`: The command-line interface for Wireshark.
|
|
|
|
## Dependencies
|
|
This role relies on:
|
|
- **pc-administrator-tools**: Ensures that essential administrative tools, likely needed alongside network analysis tools, are installed.
|
|
|
|
## Purpose and Usage
|
|
The `pc-network-analyze-tools` role is tailored for network administrators, IT professionals, security analysts, and anyone who needs to analyze or troubleshoot network issues. These tools provide capabilities for detailed network packet inspection, route tracing, and understanding network performance issues.
|
|
|
|
## Prerequisites
|
|
- **Ansible**: Required to run this role.
|
|
- **Arch Linux-based System**: The role uses the `pacman` package manager, indicating it is designed for Arch Linux or similar distributions.
|
|
|
|
## Running the Role
|
|
To utilize this role:
|
|
1. Clone the `cymais` repository.
|
|
2. Navigate to the `roles/pc-network-analyze-tools` directory.
|
|
3. Run the role using Ansible, making sure you have the necessary permissions for software installation.
|
|
|
|
## Customization
|
|
You can customize this role by adding or removing network analysis tools in the `main.yml` file, based on your specific needs or preferences.
|
|
|
|
## Support and Contributions
|
|
For support, feedback, or contributions, such as adding more tools or enhancing the current setup, please open an issue or submit a pull request in the `cymais` repository. Contributions that improve the network analysis capabilities of this role are highly encouraged. |