{"id":20732642,"url":"https://github.com/smithlabs/homelab","last_synced_at":"2025-07-31T19:05:55.874Z","repository":{"id":188093728,"uuid":"678098667","full_name":"smithlabs/homelab","owner":"smithlabs","description":"Homelab provisioned using ProxmoxAPI","archived":false,"fork":false,"pushed_at":"2023-08-14T08:04:40.000Z","size":359,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-17T05:20:49.179Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smithlabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-08-13T17:11:56.000Z","updated_at":"2023-08-13T17:21:54.000Z","dependencies_parsed_at":"2023-08-13T18:45:39.788Z","dependency_job_id":null,"html_url":"https://github.com/smithlabs/homelab","commit_stats":null,"previous_names":["smithlabs/homelab"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smithlabs%2Fhomelab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smithlabs%2Fhomelab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smithlabs%2Fhomelab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smithlabs%2Fhomelab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smithlabs","download_url":"https://codeload.github.com/smithlabs/homelab/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234448356,"owners_count":18834213,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-17T05:20:25.039Z","updated_at":"2025-01-18T00:32:24.140Z","avatar_url":"https://github.com/smithlabs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Proxmox CLI Tool\n\nA Python CLI tool to interact with Proxmox using the Proxmoxer library.\n\n## Table of Contents\n- [Introduction](#introduction)\n- [Setup](#setup)\n  - [Settings](#settings)\n  - [Virtual Environment](#virtual-environment)\n- [Usage](#usage)\n- [Flags](#flags)\n- [Examples](#examples)\n- [Author](#author)\n\n## Introduction\nThis command-line tool allows you to interact with Proxmox using various commands.\n\n## Setup\n1. Clone this repository:\n    ```bash\n    git clone https://github.com/smithlabs/proxmox-cli.git\n    cd proxmox-cli\n    ```\n\n## Settings\n2. Create a `settings.yaml` file in the root directory with your Proxmox credentials and settings:\n    Example on a fresh out-of-the-box Proxmox install\n    ```yaml\n    proxmox_host: \"proxmox.smithlabs.net\"\n    user: \"root@pam\"\n    password: \"MySecurePassword123!\"\n    verify_ssl: False\n    target_node: \"pve\"  # Specify your target node name here\n    ```\n    Make sure to protect the `settings.yaml` file to keep your credentials secure:\n    ```bash\n    chmod 600 settings.yaml\n    ```\n## Virtual Environment\n3. It's recommended to use a virtual environment for better isolation:\n    ```bash\n    # Create a virtual environment\n    python -m venv venv\n\n    # Activate the virtual environment\n    source venv/bin/activate  # On Windows: .\\venv\\Scripts\\activate\n\n    # Install required packages\n    pip install -r requirements.txt\n    ```\n\n## Usage\nRun the `main.py` script with the desired flags to interact with Proxmox.\n\n## Flags\n- `--users`: Retrieve and display Proxmox users' information.\n- `--nodes`: List all available nodes and display their information.\n- `--network-info`: Retrieve and display network information for the specified target node.\n\n## Examples\n- Display Proxmox users:\n    ```bash\n    python main.py --users\n    ```\n- List available nodes and display their information:\n    ```bash\n    python main.py --nodes\n    ```\n- Retrieve and display network information for the specified target node:\n    ```bash\n    python main.py --network-info\n    ```\n  ![python main.py --network-info screenshot](https://github.com/smithlabs/homelab/blob/main/assets/main_py_get_network_info.png?raw=true)\n\n\n## Author\nSean Smith\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmithlabs%2Fhomelab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmithlabs%2Fhomelab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmithlabs%2Fhomelab/lists"}