netcupctl 0.5.0

CLI client for netcup Server Control Panel REST API

netcupctl

Manage your netcup vServers and root servers from the command line with automatic OAuth2 authentication and intuitive commands.

Disclaimer: This is an unofficial, community-developed tool and is not affiliated with, endorsed by, or supported by netcup GmbH. Use at your own risk.

Installation

Requirements

• Python 3.8 or higher
• A netcup customer account with vServer or root server products

Install

# From PyPI
pip install netcupctl

# Or from source
git clone https://github.com/DS09AT/netcupctl.git
cd netcupctl
pip install .

Quick Start

1. Login

First, authenticate with your netcup account:

netcupctl auth login

This will open your browser for authentication. After successful login, tokens are stored locally.

2. List Your Servers

netcupctl servers list

3. Get Server Details

netcupctl servers get <server-id>

4. Manage Server State

# Check server status
netcupctl servers status <server-id>

# Start a server
netcupctl servers start <server-id>

# Stop a server (graceful shutdown)
netcupctl servers stop <server-id>

# Force power off (hard shutdown)
netcupctl servers poweroff <server-id>

# Reboot a server
netcupctl servers reboot <server-id>

Available Commands

All commands support --help to show usage details and available options:

netcupctl --help                  # Show all commands
netcupctl servers --help          # Show server commands
netcupctl servers start --help    # Show command details

Overview

Authentication & Server Management

• netcupctl auth login | logout | status - OAuth2 authentication
• netcupctl servers list | get | status | start | stop | poweroff | reboot <server-id> - Server control
• netcupctl ping - API health check
• netcupctl maintenance - Maintenance status

Storage & Snapshots

• netcupctl disks list | get | drivers | set-driver | format <server-id> [disk] - Disk management
• netcupctl snapshots list | get | create | delete | revert | export | dryrun <server-id> [name] - Snapshot operations
• netcupctl storage show | optimize <server-id> - Storage optimization

Network & Firewall

• netcupctl interfaces list | get | create | update | delete <server-id> [mac] - Network interfaces
• netcupctl vlans list | get | update <vlan-id> - VLAN management
• netcupctl rdns get | set | delete <server-id> <ip> - Reverse DNS
• netcupctl failover-ips list | get | update <id> - Failover IP management
• netcupctl firewall show | set | reapply | restore <server-id> - Firewall rules
• netcupctl firewall-policies list | get | create | update | delete [id] - Firewall policies

Monitoring & Logs

• netcupctl logs <server-id> - Server logs
• netcupctl metrics cpu | disk | network | network-packets <server-id> - Resource metrics
• netcupctl tasks list | get | cancel [task-id] - Task management
• netcupctl user-logs - User activity logs

Images & ISOs

• netcupctl images list | show | install | install-custom <server-id> - OS image management
• netcupctl custom-images list | get | upload | delete [key] - Custom image upload
• netcupctl iso images | show | mount | unmount <server-id> - ISO mounting
• netcupctl custom-isos list | get | upload | delete [key] - Custom ISO upload

Security & Access

• netcupctl ssh-keys list | add | delete [key-id] - SSH key management
• netcupctl rescue show | enable | disable <server-id> - Rescue system
• netcupctl guest-agent show | enable | disable <server-id> - Guest agent control
• netcupctl users get | update - User profile management

Utilities

• netcupctl spec update | show - OpenAPI specification management

Output Formats

Use --format to control output. Default is list.

# List format (default) - human-readable key-value
netcupctl servers list

# Table format - columnar layout
netcupctl --format table servers list

# JSON format - for scripting
netcupctl --format json servers list | jq '.[] | .hostname'

# YAML format - for configuration management
netcupctl --format yaml servers list

API Documentation

• API Browser
• OpenAPI Specification
• netcup SCP REST API Forum

License

MIT License. See LICENSE.md for details.