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.1.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.1-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netbox_vitalqip-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 ed2e88669d24f54f5d169a3003f410a41a7e481245e1b66d34087c45731e157f
MD5 0f554c50580e76338835b01633b7702c
BLAKE2b-256 a34fe72ca75d09cbffbf344c9461c4c590440cd8acedcce6b1f23d067b9113b5

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_vitalqip-0.1.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_vitalqip-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6a862fe18ef8732a2e8c754fc19ded7cf126f91ef77761e020d93a53895b8399
MD5 0893469848d5ae2becbaff28c27bc659
BLAKE2b-256 82f3c834da8dc31affb116972f83cf28b1fcf75048d54586f919608c3749f947

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_vitalqip-0.1.1-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