A Python CLI tool to interact with Proxmox using the Proxmoxer library.

• Introduction
• Setup
  • Settings
  • Virtual Environment
• Usage
• Flags
• Examples
• Author

This command-line tool allows you to interact with Proxmox using various commands.

1. Clone this repository:

   git clone https://github.com/smithlabs/proxmox-cli.git
   cd proxmox-cli

2. Create a settings.yaml file in the root directory with your Proxmox credentials and settings: Example on a fresh out-of-the-box Proxmox install

   proxmox_host: "proxmox.smithlabs.net"
   user: "root@pam"
   password: "MySecurePassword123!"
   verify_ssl: False
   target_node: "pve"  # Specify your target node name here

   Make sure to protect the settings.yaml file to keep your credentials secure:

   chmod 600 settings.yaml

3. It's recommended to use a virtual environment for better isolation:

   # Create a virtual environment
   python -m venv venv
   
   # Activate the virtual environment
   source venv/bin/activate  # On Windows: .\venv\Scripts\activate
   
   # Install required packages
   pip install -r requirements.txt

Run the main.py script with the desired flags to interact with Proxmox.

• --users: Retrieve and display Proxmox users' information.
• --nodes: List all available nodes and display their information.
• --network-info: Retrieve and display network information for the specified target node.

• Display Proxmox users:

  python main.py --users

• List available nodes and display their information:

  python main.py --nodes

• Retrieve and display network information for the specified target node:

  python main.py --network-info

  

Sean Smith