Skip to main content

Jobs and utilities for EntraID hygiene in NetBox

Project description

NetBox EntraID Tools

GitHub Python NetBox

Jobs and utilities for EntraID hygiene in NetBox.

Overview

This plugin is part of a larger ecosystem of EntraID (Azure AD) integrations with NetBox:

  1. NetBox Contacts Sync (netbox-contacts-sync) - Windows Server-based service that syncs SharePoint contact assignments to NetBox
  2. NetBox EntraID SSO - Allows NetBox admin login via EntraID
  3. Contact Cleanup Job (DeprecateContactsJob) - Identifies and handles invalid/missing contacts
  4. Contact EntraID Resolution - Allows manual contact resolution against EntraID

Installation

# Using pip
pip install netbox-entraid-tools

# Manual installation from source
git clone https://github.com/bacardi-code/techops-networking-netbox-entraid-tools /downloads/netbox-entraid-tools
pushd /downloads/netbox-entraid-tools
pip install .

Configuration

Add to your NetBox configuration.py:

PLUGINS = [
    'netbox_entraid_tools',
    # ... other plugins
]

PLUGINS_CONFIG = {
    'netbox_entraid_tools': {
        # Optional settings
        # 'job_interval_hours': 6,
        # 'auto_schedule': True,
        # 'storage_account_name': 'westeuncnetboxauto',
        # 'storage_table_name': 'ContactAssignmentDeletions',
        # 'treat_disabled_as_missing': False,
        # 'debug_mode': False,
    }
}

Run migrations:

python manage.py migrate netbox_entraid_tools

Development

  1. Clone repository
  2. Install requirements: pip install -r requirements.txt
  3. Add to NetBox configuration
  4. Run migrations

Build and Version Management

For detailed information about building the package, managing versions, and deployment processes, please see the BUILD.md file. This includes:

  • Modern build process using PEP 517
  • Version management with tools/release.py
  • Folder version management with Bump-FolderVersion.ps1
  • Deployment instructions

License

Apache License 2.0

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_entraid_tools-0.1.57.tar.gz (72.8 kB view details)

Uploaded Source

Built Distribution

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

netbox_entraid_tools-0.1.57-py3-none-any.whl (42.3 kB view details)

Uploaded Python 3

File details

Details for the file netbox_entraid_tools-0.1.57.tar.gz.

File metadata

  • Download URL: netbox_entraid_tools-0.1.57.tar.gz
  • Upload date:
  • Size: 72.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for netbox_entraid_tools-0.1.57.tar.gz
Algorithm Hash digest
SHA256 7c8acb34b333a515210556c056864b7cbbf389303781225f602e09b75abe7cdb
MD5 b4042af10a4701d820712ced59d0ad30
BLAKE2b-256 9147b7786079826c9391c704944505b864f787f193d157c34f6624358a33d9ae

See more details on using hashes here.

File details

Details for the file netbox_entraid_tools-0.1.57-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_entraid_tools-0.1.57-py3-none-any.whl
Algorithm Hash digest
SHA256 883972d40f53edb9cb39b3d121ac45e0a038158979ae556313e2b4c9d3f127d1
MD5 ec30572ae0c04da54141ac43ac95e38a
BLAKE2b-256 9e0a4367cf02193445e28ac2aee6c8d0f74dd9fad8c2d0c404278d6866dbc026

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