Skip to main content

vLab IPAM API

This service replaces the existing static gateway used in vLab.

The goal of this service is to make it easier for users to access their lab by removing the need for the jumpbox. This is achieved by exposing a RESTful API on the gateway that can dynamically port-forward through the NAT firewall that runs on the gateway. Additionally, vLab clients can leverage this API to programmically connect users to a given resource. For example the vLab CLI client can potentially:

  1. Expose an interface like vlab connect windows --name <name of instance> --protocol=RDP

  2. Call the main vLab server to get the IP of the gateway

  3. Call the API on the gateway to get the port that maps to the specific component and protocol

  4. Evoke an application on the user’s machine that understands the specific protocol, and pre-populate the connection information.

Clients can also programmically create the port forwarding rules upon component creation. This would remove the need for users to manually port forwarding rules, but clients should not prevent users from inputting their own port forwarding rules.

Background Services

The IPAM service has two background processes:

vlab-worker

Periodically pings IPs stored in the IPAM database. This allows the service to identify “bad records” and relay that information to the user.

vlab-log-sender

Forwards firewall logs to a remote server. The default iptables config will log every time a package is FORWARDed. By forwarding the logs for remote processing, admins of vLab can answer business questions like, “Do they use that resource?”

vlab-ddns-updater

Runs on a regular cycle to send Dynamic DNS updates to the vLab DNS service.

Metadata

Release files for vlab-ipam-api 2019.7.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for vlab-ipam-api 2019.7.3
File Interpreter ABI Platform
vlab_ipam_api-2019.7.3-py3-none-any.whl Python 3 none any Details

Release files / vlab_ipam_api-2019.7.3-py3-none-any.whl

Download URL vlab_ipam_api-2019.7.3-py3-none-any.whl
Size 40.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
41c262f0cb633de0e6fb2b8a5ce091ffbee87c52ff1a8f3f40c1da3444783966
BLAKE2b-256 checksum
How to use checksums
bf4fcf2a8af183596f36f13c067ca69c74ee320a73d083fa8f24a36f29dc234c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/3.6.6
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page