netbox-idrac-inventory 0.2.0__tar.gz

netbox_idrac_inventory-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

netbox_idrac_inventory-0.2.0/PKG-INFO

@@ -0,0 +1,360 @@
+Metadata-Version: 2.4
+Name: netbox-idrac-inventory
+Version: 0.2.0
+Summary: NetBox plugin to synchronize Dell servers with NetBox via iDRAC Redfish
+Author-email: Thomas Le Gentil <thomas.legentil@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/kifeo/netbox-idrac-inventory
+Keywords: netbox,netbox-plugin,dell,idrac,redfish
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sushy>=5.0.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-django; extra == "test"
+Requires-Dist: responses; extra == "test"
+Dynamic: license-file
+
+# NetBox iDRAC Inventory Plugin
+
+A [NetBox](https://netbox.dev) plugin that synchronizes Dell PowerEdge server
+hardware inventory into NetBox by querying each server's iDRAC management
+interface via the Redfish API.
+
+---
+
+## Features
+
+- **One-to-one Dell server record** linked to a NetBox Device. Adding a Dell
+  server creates the Device for you (its name defaults to the host part of the
+  iDRAC FQDN); the record stores the iDRAC address, service tag, BIOS version
+  and iDRAC firmware. The device type is set from the iDRAC-reported model on
+  the first sync.
+- **Hardware component inventory** — CPUs, DIMMs, disks, storage controllers
+  and power supplies are discovered and stored as `DellComponent` objects.
+- **Health status** — the iDRAC `Status.Health` of the server (rolled up) and
+  of each component is mapped to a colored `health` badge (OK / Warning /
+  Critical), so a failed PSU or disk is visible at a glance and filterable.
+- **iDRAC management IP** — the iDRAC's own NIC is modelled as a mgmt-only
+  `iDRAC` interface (with its MAC), the iDRAC IPv4 is created in IPAM and set
+  as the device's **out-of-band IP** (`oob_ip`).
+- **Native network modelling** — each physical network adapter is created as a
+  NetBox `Module` (with a matching `ModuleType`) installed in a `ModuleBay` on
+  the device, and each physical port becomes an `Interface` with its MAC
+  address and link speed.
+- **LLDP discovery** — the LLDP neighbour reported by iDRAC for each connected
+  port (remote switch + remote port) is stored in the `lldp_remote_chassis`
+  and `lldp_remote_port` custom fields on the interface. These custom fields
+  are created automatically on first migrate.
+- **Firmware inventory** — the Redfish `UpdateService/FirmwareInventory` is
+  read on each sync and the installed version is written to matching
+  components (by FQDD), covering parts whose own resource omits a version.
+- **Sync-on-demand** — trigger a sync from the NetBox UI (single server or a
+  bulk *Sync from iDRAC* action on the server list) or via the REST API
+  (`POST .../servers/<id>/sync/`); sync runs as a background job.
+- **Scheduled sync** — set `sync_interval_minutes` > 0 to register a recurring
+  system job that fans out one sync job per Dell server, so the RQ workers
+  run them in parallel and one unreachable iDRAC never stalls the fleet.
+- **Network discovery** — define a **Scan Range** (CIDR / range / hosts); a
+  discovery job probes each iDRAC and imports it, attaching to an existing
+  device with the same service tag when one exists (no duplicate) or creating
+  a new one.
+- **Full REST API** at `/api/plugins/idrac-inventory/` (servers + components).
+- **GraphQL** queries `dell_server` / `dell_server_list` /
+  `dell_component` / `dell_component_list` exposed through NetBox's Strawberry
+  schema.
+- **Credentials** — a global iDRAC password comes from `PLUGINS_CONFIG` /
+  environment; an optional **per-device password** (when machines differ) is
+  stored **encrypted at rest** (Fernet, keyed on NetBox `SECRET_KEY`) and is
+  never returned by the API.
+
+---
+
+## Compatibility
+
+| Plugin version | NetBox version |
+|----------------|---------------|
+| 0.2.x          | 4.1 – 4.6     |
+| 0.1.x          | 4.1 or later  |
+
+NetBox 4.6+ requires `API_TOKEN_PEPPERS` in your NetBox configuration (a
+core NetBox requirement, not a plugin one).
+
+Requires Python 3.10+.
+
+---
+
+## Installation
+
+### 1. Install the package
+
+```bash
+pip install netbox-idrac-inventory
+```
+
+### 2. Add to `configuration.py`
+
+```python
+PLUGINS = [
+    "netbox_idrac_inventory",
+]
+
+PLUGINS_CONFIG = {
+    "netbox_idrac_inventory": {
+        # iDRAC credentials used when a DellServer has no per-device username set.
+        "idrac_default_username": "root",
+        # Prefer setting the password via an environment variable rather than
+        # committing it to the config file.  The plugin checks the env var
+        # IDRAC_DEFAULT_PASSWORD before falling back to this value.
+        "idrac_default_password": "",
+        # Set to True (and provide a valid CA bundle) in production.
+        "idrac_verify_ssl": False,
+        # HTTP request timeout in seconds for iDRAC Redfish calls.
+        "idrac_timeout": 30,
+        # When True, the sync writes the iDRAC service tag to Device.serial
+        # in NetBox so the physical device record stays up to date.
+        "update_device_serial": True,
+        # When True, the sync creates a mgmt-only "iDRAC" interface with the
+        # iDRAC IP and sets it as the device's out-of-band IP.
+        "manage_idrac_interface": True,
+        # Minutes between automatic syncs of every Dell server (0 = disabled,
+        # sync stays manual). Read at worker startup — restart the RQ worker
+        # after changing it.
+        "sync_interval_minutes": 0,
+        # Optional list of prefixes that iDRAC addresses and scan targets
+        # must fall within, e.g. ["10.116.0.0/16"]. Empty = no restriction.
+        # Strongly recommended: see "Credentials and security" below.
+        "allowed_networks": [],
+    }
+}
+```
+
+### 3. Apply database migrations
+
+```bash
+python manage.py migrate
+```
+
+---
+
+## Usage
+
+### Add a Dell server
+
+Two ways:
+
+- **From scratch** — go to **Plugins → iDRAC Inventory → Dell Servers → Add**.
+  Enter the iDRAC address, a device **name** (left blank, it defaults to the
+  host part of the iDRAC FQDN, e.g. `host01.ipmi.example.com` → `host01`), a
+  **site** and a **role**. The plugin creates the Device (with a placeholder
+  device type, replaced by the real model on the first sync) and links it.
+- **From an existing device** — on a Device page, use the **iDRAC Inventory**
+  panel's *Add* button; the new record is attached to that device instead of
+  creating a new one.
+
+Optionally set a per-device iDRAC username; otherwise the plugin default is
+used.
+
+### Trigger a sync
+
+- **UI**: open the DellServer (or its Device) page and click **Sync from
+  iDRAC**. The sync runs as a NetBox background job; refresh to see the result
+  in `sync_status` / `sync_message`.
+- **REST API**:
+
+  ```bash
+  curl -X POST \
+    -H "Authorization: Token <your-token>" \
+    https://netbox.example.com/api/plugins/idrac-inventory/servers/42/sync/
+  ```
+
+  Returns `HTTP 202` with the background job ID:
+
+  ```json
+  {
+    "job_id": 123,
+    "job_url": "https://netbox.example.com/api/core/jobs/123/",
+    "message": "Sync job enqueued for my-server-01 (SVC00042)."
+  }
+  ```
+
+  Triggering a sync requires the *change* permission on Dell servers (on
+  top of NetBox's standard POST-to-add API permission mapping).
+
+### Discover servers from a range
+
+Under **Plugins → iDRAC Inventory → Scan Ranges → Add**, define one or more
+targets (one per line or comma-separated): a CIDR (`10.0.0.0/24`), a range
+(`10.0.0.10-20`) or single hosts, plus the site and role for created devices.
+Click **Run scan** (or `POST .../scan-ranges/<id>/run/`). For each reachable
+iDRAC the discovery attaches to an existing device with the same service tag,
+or creates one, then syncs it.
+
+### REST API overview
+
+Base path: `/api/plugins/idrac-inventory/`
+
+| Method | Endpoint                          | Description                 |
+|--------|-----------------------------------|-----------------------------|
+| GET    | `/servers/`                       | List all Dell servers       |
+| POST   | `/servers/`                       | Create a Dell server record |
+| GET    | `/servers/<id>/`                  | Retrieve a Dell server      |
+| PATCH  | `/servers/<id>/`                  | Update a Dell server        |
+| DELETE | `/servers/<id>/`                  | Delete a Dell server        |
+| POST   | `/servers/<id>/sync/`             | Enqueue an iDRAC sync job   |
+| GET    | `/components/`                    | List all components         |
+| GET    | `/components/<id>/`               | Retrieve a component        |
+| GET/POST | `/scan-ranges/`                 | List / create scan ranges   |
+| POST   | `/scan-ranges/<id>/run/`          | Enqueue a discovery job     |
+
+The per-device / per-range `idrac_password` can be **set** via POST/PATCH; it
+is write-only (encrypted before storage, never present in any response) and a
+blank or absent value keeps the stored one.
+
+Full OpenAPI schema is available at `/api/schema/` in your NetBox instance.
+
+### GraphQL
+
+```graphql
+query {
+  dell_server_list {
+    id
+    service_tag
+    model
+    sync_status
+    device { name }
+  }
+}
+
+query {
+  dell_server(id: 42) {
+    bios_version
+    idrac_firmware
+    last_synced
+  }
+}
+```
+
+---
+
+## Credentials and security
+
+- At sync time the plugin resolves the password in this order:
+  1. The **per-device** `idrac_password` (or a scan range's), when set.
+  2. Environment variable `IDRAC_DEFAULT_PASSWORD` (recommended default for
+     production — set it in your process manager / secrets manager).
+  3. `PLUGINS_CONFIG["netbox_idrac_inventory"]["idrac_default_password"]`.
+- **Per-device password** — when servers don't share one password, set it on
+  the DellServer (or scan range). It is **encrypted at rest** with a key
+  derived from NetBox's `SECRET_KEY` (Fernet), is write-only in the form and
+  the API, and is never returned by the REST or GraphQL API. If you only have
+  one shared password, leave these blank and use the global default above.
+- **`SECRET_KEY` rotation** — rotate per Django's documented procedure (put
+  the old key in `SECRET_KEY_FALLBACKS`) and stored passwords keep working.
+  If a stored password can no longer be decrypted, the sync **fails with a
+  clear message** instead of silently retrying with the global default (which
+  could trip the iDRAC's account lockout); re-enter the password to recover.
+- The per-device `idrac_username` overrides `idrac_default_username` likewise.
+- In production, set `idrac_verify_ssl: true` and provide a trusted CA bundle
+  so TLS certificates are validated.
+
+### Restricting where syncs may connect
+
+Anyone with *change* permission on Dell servers or scan ranges chooses which
+address the plugin connects to — and the sync presents the configured iDRAC
+credentials to that address. A malicious or compromised account could point a
+record at a host it controls and capture the global default password. To
+contain this:
+
+- set `allowed_networks` to the management prefixes your iDRACs live in;
+  syncs and scans to any address (or DNS name resolving) outside them are
+  refused;
+- grant `change_dellserver` / `change_dellscanrange` sparingly, like any
+  credential-bearing automation;
+- enable `idrac_verify_ssl` so credentials are never sent over unverified
+  TLS.
+
+---
+
+## Development
+
+### Quick start with Docker
+
+A self-contained NetBox stack (NetBox + worker + Postgres + Redis) with the
+plugin pre-installed lives under [`dev/`](dev/). See [`dev/README.md`](dev/README.md):
+
+```bash
+cd dev
+cp .env.example .env      # set IDRAC_USERNAME / IDRAC_PASSWORD
+docker compose up --build # NetBox at http://localhost:8000 (admin / admin)
+```
+
+### Migrations
+
+The plugin **ships its schema migration** (`migrations/0001_initial.py`), so a
+plain `python manage.py migrate` is all that is needed. The LLDP custom fields
+on `dcim.Interface` are **not** a migration — they are created idempotently by
+a `post_migrate` signal (see `signals.py`) so they stay correct across NetBox
+versions. If you change the models, regenerate with
+`python manage.py makemigrations netbox_idrac_inventory` and commit the result.
+
+### Running tests
+
+Tests must run inside the NetBox Django environment:
+
+```bash
+# From the NetBox source root with the plugin installed:
+python manage.py test netbox_idrac_inventory
+# or, with the dev stack running:
+docker compose exec netbox \
+  /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py test netbox_idrac_inventory
+```
+
+### Project layout
+
+```
+netbox_idrac_inventory/
+  api/
+    serializers.py     # NetBoxModelSerializer subclasses
+    views.py           # NetBoxModelViewSet subclasses + sync action
+    urls.py            # NetBoxRouter registration
+  graphql/
+    types.py           # Strawberry-django type definitions
+    schema.py          # Root query class + schema list
+  idrac/
+    client.py          # IdracClient — Redfish wrapper (sushy), plain dicts
+    sync.py            # sync_server() — iDRAC -> NetBox reconcile logic
+    discovery.py       # discover_range() — scan a range and import iDRACs
+  migrations/
+    0001_initial.py    # DellServer / DellComponent schema
+  templates/netbox_idrac_inventory/   # detail pages + Device-page panel
+  tests/
+    test_models.py     # Model unit tests
+    test_idrac.py      # Sync engine + network/LLDP tests (fake client)
+    test_api.py        # REST API tests (NetBox APIViewTestCases)
+    test_forms.py      # Device-creating form + password handling
+    test_discovery.py  # Target expansion + discovery engine
+    test_utils.py      # Address helpers + encryption fail-closed
+    test_views.py      # Bulk sync action
+  __init__.py          # PluginConfig (settings) + post_migrate hook
+  choices.py           # SyncStatusChoices, ComponentTypeChoices
+  models.py            # DellServer, DellComponent, DellScanRange
+  forms.py             # Forms (DellServerForm creates/links the Device)
+  tables.py            # DellServerTable, DellComponentTable
+  filtersets.py        # DellServerFilterSet, DellComponentFilterSet
+  views.py             # CRUD views + DellServerSyncView
+  urls.py              # UI URL routes
+  navigation.py        # Plugin menu
+  template_content.py  # Dell panel on the Device page
+  jobs.py              # DellSyncJob + enqueue_sync()
+  signals.py           # post_migrate: create LLDP custom fields
+  utils.py             # default_device_name(), get_or_create_manufacturer()
+```