Skip to main content

CLI tool for interacting with the Netcup Webservice

Project description

Unofficial Netcup CLI

A simple CLI tool for interacting with the Netcup Webservice (based on netcup_webservice)

Installation

You can install the CLI tool using pip:

pip install netcup-cli

Usage

1. Setup Login Credentials

Before using any of the commands, you need to log in and save your credentials.

netcup-cli login 

If you don't provide the --user and --password arguments, the CLI will prompt you to input them.

2. Available Commands

Get Commands Use the get command to retrieve information from the Netcup Webservice. Available resources:

  • vservers: Get the list of all vServers.
  • vserver_nickname: Get the nickname of a specific vServer.
  • vserver_state: Get the state of a specific vServer (running, stopped, etc.).
  • vserver_uptime: Get the uptime of a specific vServer.
  • vserver_update_notification: Get the update notifications for a specific vServer.
  • vserver_stat_token: Get the stat token for a specific vServer.
  • vserver_traffic_of_day: Get the daily traffic usage for a specific vServer.
  • vserver_traffic_of_month: Get the monthly traffic usage for a specific vServer.
  • vserver_information: Get detailed information for a specific vServer.
  • vserver_ips: Get the IPs assigned to a specific vServer.

Example usage:

# Get the list of all vServers
netcup-cli get vservers

# Get the state of a specific vServer
netcup-cli get vserver_state --vserver_name YOUR_VSERVER_NAME

Set Commands Use the set command to update information in the Netcup Webservice. Available resources:

  • vserver_nickname: Set a new nickname for a specific vServer.
  • password: Change the user password.
  • panel_settings: Update panel settings.

Example usage:

# Set a new nickname for a specific vServer
netcup-cli set vserver_nickname --vserver_name YOUR_VSERVER_NAME --nickname NEW_NICKNAME

# Change the user password
netcup-cli set password --new_password NEW_PASSWORD

Start/Stop/Poweroff Commands You can manage the state of your vServers using the following commands:

# Start a specific vServer
netcup-cli start --vserver_name YOUR_VSERVER_NAME

# Stop a specific vServer
netcup-cli stop --vserver_name YOUR_VSERVER_NAME

# Power off a specific vServer
netcup-cli poweroff --vserver_name YOUR_VSERVER_NAME

Disclaimer

This package is not affiliated with, endorsed, or sponsored by Netcup GmbH. It is an independent project and is maintained solely by its contributors.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netcup_cli-0.1.0.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netcup_cli-0.1.0-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file netcup_cli-0.1.0.tar.gz.

File metadata

  • Download URL: netcup_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for netcup_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4f8a775e864f5b01b52df46b2e88183158719bb7256f7e6d0c8bb5c346c7bf64
MD5 a78be3e3c4ea8442c8fd1dc120b94582
BLAKE2b-256 4e58dc766b3d744d9db361360447b02d82cce3868c99029eb2a6acb7df275d7e

See more details on using hashes here.

File details

Details for the file netcup_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: netcup_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for netcup_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 83a207ed899869be96f16dce590a846ab1cc3a1d4fb65d2caea0d8cc3bcdd497
MD5 788a1f61bddb758297f75c913ede2e01
BLAKE2b-256 0175025cca6ff0033ae0a2f41b53333a18a23cd60317024a48e9e134c84c52f8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page