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.56.tar.gz (70.4 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.56-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for netbox_entraid_tools-0.1.56.tar.gz
Algorithm Hash digest
SHA256 a1e789e782d963a6e4aedbd5c12d0fa528551a472737dabb224888439ed846a9
MD5 5bb655fc92be701b696e4f4139cde18d
BLAKE2b-256 e5158c96ffc8b525017f5aea72508aa0a4c0bb88d1803fbf350c3eddc9252860

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for netbox_entraid_tools-0.1.56-py3-none-any.whl
Algorithm Hash digest
SHA256 8b3ce664bf955408b934335d924368053103c1b0efc3dd8b829518cfe023f438
MD5 d536f53554c75fedc9b22c58c446c3ec
BLAKE2b-256 8fdc8493042b6ac702b569650c9eb60674d659d775a41a73056acd24ce45e045

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