Skip to main content

NetBox plugin to display VitalQIP IPAM data and import IP addresses

Project description

NetBox VitalQIP Plugin

PyPI Python License

A NetBox plugin that integrates with Nokia VitalQIP IPAM to display IP address data and enable importing prefixes and IP addresses from QIP to NetBox.

Features

  • Device/VM Tabs: View VitalQIP data for any device or VM based on their assigned IP addresses
  • Prefix Import: Search VitalQIP for networks using wildcard patterns and import them as prefixes
  • IP Address Import: Look up individual IP addresses and import them with DNS names
  • Caching: Results are cached to minimize API calls to VitalQIP

Requirements

  • NetBox 4.0+
  • Python 3.10+
  • Nokia VitalQIP REST API access

Installation

pip install netbox-vitalqip

Add to NetBox configuration.py:

PLUGINS = [
    'netbox_vitalqip',
]

PLUGINS_CONFIG = {
    'netbox_vitalqip': {
        'qip_url': 'https://dhcp.example.com/api',
        'qip_username': 'your-username',
        'qip_password': 'your-password',
        'qip_organization': 'YourOrg',
        'timeout': 30,
        'cache_timeout': 300,
        'verify_ssl': False,
    },
}

Usage

Device/VM Tab

Navigate to any Device or VirtualMachine detail page. A "VitalQIP" tab shows:

  • IP address assignments in QIP
  • Object name and domain
  • Subnet information
  • Address type (Static/DHCP)

Import Prefixes

  1. Navigate to VitalQIP > Import from QIP
  2. Enter a wildcard pattern (e.g., 10.*, 172.16.*, 192.168.1.*)
  3. Review networks found in VitalQIP:
    • New: Networks not yet in NetBox (can be imported)
    • Existing: Networks already in NetBox (shown for reference)
  4. Select prefixes to import

Imported prefixes include:

  • Description from QIP network name
  • Appropriate status (Container for /16 and larger, Active for smaller)
  • Tenant assignment

Import Single IP Address

  1. Navigate to VitalQIP > Import from QIP
  2. Enter a full IP address (e.g., 192.168.1.1)
  3. Review the QIP data (object name, domain, class, subnet)
  4. Import with DNS name auto-populated from QIP

API Notes

VitalQIP uses a REST API with legacy TLS requirements. The plugin handles:

  • Token-based authentication (login returns Authentication header)
  • Legacy SSL/TLS negotiation via OpenSSL configuration
  • Response caching to minimize API calls

Endpoints Used

  • POST /api/login - Authentication
  • GET /api/v1/{org}/v4address.json - Search addresses
  • GET /api/v1/{org}/v4network.json - Get networks
  • GET /api/v1/{org}/v4subnet.json - Get subnet info

Development

cd ~/development/netbox-vitalqip
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

License

Apache 2.0

Author

sieteunoseis (jeremy.worden@gmail.com)

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

netbox_vitalqip-0.1.0.tar.gz (20.9 kB view details)

Uploaded Source

Built Distribution

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

netbox_vitalqip-0.1.0-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netbox_vitalqip-0.1.0.tar.gz
  • Upload date:
  • Size: 20.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for netbox_vitalqip-0.1.0.tar.gz
Algorithm Hash digest
SHA256 35ffeb78be2baae3ef96e837a1041886b7001ccca05e90c81b7efd6fbda077bb
MD5 58a71e2b474e3e08f28c4f535b5e0a65
BLAKE2b-256 863fa6800be82728c7a5b8dc8ce8a1419300cb3564abb4452577e6e2455c4a3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_vitalqip-0.1.0.tar.gz:

Publisher: release.yml on sieteunoseis/netbox-vitalqip

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for netbox_vitalqip-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c91075d4bab1ff0fc96a9a4f1ad39e448139ac091f20d8d287be48380b6bee4d
MD5 e4a33f2c778265a378a80f1d0a580d39
BLAKE2b-256 b2cbe7cf96319949e46b82817e8e560d30aa869872566c9eb8449ba71cd81bb0

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_vitalqip-0.1.0-py3-none-any.whl:

Publisher: release.yml on sieteunoseis/netbox-vitalqip

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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