netbox-lantronix 0.5.1__tar.gz

netbox_lantronix-0.5.1/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_lantronix-0.5.1/PKG-INFO

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: netbox-lantronix
+Version: 0.5.1
+Summary: NetBox plugin that keeps NetBox current with Lantronix SLC and EMG devices managed by Percepxion
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/Lantronix/netbox-lantronix
+Project-URL: Changelog, https://github.com/Lantronix/netbox-lantronix/blob/main/CHANGELOG.md
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: requests>=2.31; extra == "dev"
+Dynamic: license-file
+
+# netbox-lantronix
+
+A NetBox plugin that keeps NetBox current with the Lantronix SLC 9000, SLC 8000 and EMG console servers managed by Percepxion. Nobody has to type console server inventory into NetBox by hand.
+
+On each sync the plugin reads Percepxion and:
+
+- creates the console server in NetBox with the right device type, so its console server ports come from the device type
+- labels each console server port with the name configured on the console server, and describes it with the hostname of the attached device
+- shows the attached device's make, model, OS and serial on the port, when the console server reports them
+- adds an **Open console** button on each port that launches an SSH session through the console server (`ssh://<console server>:<base port + port number>`)
+- lists anything it couldn't decide, such as an ambiguous model or a name conflict, as findings with a one-click fix
+
+The plugin never writes to Percepxion or to a console server. It reads from Percepxion and writes to NetBox only.
+
+## Requirements
+
+| | |
+|---|---|
+| NetBox | 4.6.0 to 4.7.x (the plugin refuses to load on other versions) |
+| Python | 3.12 or later |
+| RQ worker | A running NetBox worker (`manage.py rqworker`). Scheduled and on-demand syncs run as NetBox background jobs. |
+| Percepxion | Percepxion cloud or on-premises, and a Percepxion user with the **tenant_user** role in the organization you sync. No administrator role is needed. |
+| Device types | Lantronix SLC and EMG device types, imported before the first sync. The definitions are in [`docker/device-types`](docker/device-types). |
+
+## Install
+
+1. Install the package into the NetBox virtual environment:
+
+   ```
+   source /opt/netbox/venv/bin/activate
+   pip install netbox-lantronix
+   ```
+
+   To pin a version, install `netbox-lantronix==X.Y.Z` with a version from the [releases](https://github.com/Lantronix/netbox-lantronix/releases). For netbox-docker, follow [Docker](#docker) instead of these steps.
+
+2. Enable and configure the plugin in `configuration.py` (see [Configuration](#configuration)).
+
+3. Run the migrations and collect static files:
+
+   ```
+   cd /opt/netbox/netbox
+   python3 manage.py migrate netbox_lantronix
+   python3 manage.py collectstatic --no-input
+   ```
+
+4. Restart NetBox and the RQ worker.
+
+5. Create the NetBox user that sync changes are attributed to, for example `percepxion-sync`, and give it permissions (see [Permissions](#permissions)). It doesn't need to log in.
+
+6. Import the device types for your hardware from [`docker/device-types`](docker/device-types) through **Devices > Device Types > Import**.
+
+On the first run the plugin creates the manufacturer `Lantronix`, the platform `lantronix_itmgos` and the device custom field `percepxion_device_id` if they don't exist, and reuses them if they do. These are the same objects the `lantronix.oob` Ansible collection's NetBox playbook uses, so the two can share a NetBox.
+
+## Docker
+
+This builds a NetBox 4.6 image with the plugin, using [netbox-docker](https://github.com/netbox-community/netbox-docker). You need Docker with Compose and a Percepxion user with the **tenant_user** role.
+
+1. Clone both repositories side by side and copy in the plugin's files:
+
+   ```
+   git clone -b 5.0.2 --depth 1 https://github.com/netbox-community/netbox-docker.git
+   git clone https://github.com/Lantronix/netbox-lantronix.git
+   cd netbox-docker
+   cp ../netbox-lantronix/docker/docker-compose.override.yml .
+   cp ../netbox-lantronix/docker/plugins.py configuration/plugins.py
+   cp ../netbox-lantronix/docker/percepxion.env.example env/percepxion.env
+   ```
+
+2. Add your Percepxion username and password to `env/percepxion.env`. For on-premises Percepxion, change `PERCEPXION_URL` too.
+
+3. Build and start NetBox. The first start runs the database migrations and can take several minutes.
+
+   ```
+   docker compose build
+   docker compose up -d
+   ```
+
+4. Create your NetBox login:
+
+   ```
+   docker compose exec netbox /opt/netbox/netbox/manage.py createsuperuser
+   ```
+
+5. Import the device types and create the `percepxion-sync` user, a site and a role. Its permissions are limited to that site, and running it again changes nothing that already exists.
+
+   ```
+   docker compose exec netbox /opt/netbox/netbox/manage.py nbshell -c "exec(open('/opt/netbox-lantronix-docker/setup.py').read())"
+   ```
+
+6. Open http://localhost:8000 and follow [First sync](#first-sync), with endpoint `percepxion`, site **Console Servers** and role **Console Server**.
+
+To use another port, set `NETBOX_PORT` when you start NetBox. The stack runs as Compose project `netbox-lantronix`, so its containers and database stay separate from any other netbox-docker on the host.
+
+## Configuration
+
+Endpoints and credentials live only in `configuration.py` or the environment, never in the NetBox database.
+
+```python
+import os
+
+PLUGINS = ["netbox_lantronix"]
+
+PLUGINS_CONFIG = {
+    "netbox_lantronix": {
+        # NetBox user that change records are attributed to. Must exist.
+        "sync_user": "percepxion-sync",
+        "endpoints": {
+            # Name you pick here; a Percepxion source in the UI refers to it.
+            "percepxion-cloud": {
+                "url": "https://api.percepxion.ai/api",  # API base, including /api
+                "username": os.environ["PERCEPXION_USERNAME"],
+                "password": os.environ["PERCEPXION_PASSWORD"],
+                # Optional:
+                # "verify": True,                      # TLS verification, on by default
+                # "ca_bundle": "/etc/ssl/px-ca.pem",   # CA bundle for on-premises Percepxion
+                # "proxy": "http://proxy.example.com:3128",
+            },
+        },
+    },
+}
+```
+
+- `url` must use `https://`. The plugin won't load an endpoint that doesn't.
+- `username` and `password` are required. They're read when a sync starts and never written to the database, job data, logs or findings.
+- A missing key stops the plugin at startup with an error that names the endpoint and the key, never the value.
+- Turning `verify` off shows a warning on every source that uses the endpoint.
+- Endpoint changes take effect after a NetBox restart.
+
+## First sync
+
+1. Go to **Plugins > Lantronix > Percepxion Sources > Add**.
+2. Pick the endpoint and enter the Percepxion organization ID. Then choose the NetBox site and device role for new console servers, the sync interval in minutes (0 turns scheduling off, otherwise at least 5), and the SSH base port (3000 unless you changed it on your console servers).
+3. Save, then click **Sync now**. The job appears under the source with its counts and log.
+4. Open **Findings**. Each one names the device and the fix.
+
+To sync on events instead of waiting for the schedule, call `POST /api/plugins/lantronix/sources/<id>/sync/` with an API token whose user has the sync permission. It answers 202 with the queued job, or 409 when a run is already queued or running, which will pick up the change.
+
+### Device models
+
+Percepxion reports an SLC 9000's model as its total number of serial ports and doesn't report the Ethernet switch module or the power supply type. Several SLC 9000 SKUs therefore look the same in Percepxion. The plugin picks the device type in this order:
+
+1. **Type override** for that device, if you set one
+2. **`show sysconfig` output** stored in Percepxion: if anyone has run `show sysconfig` on the unit through Percepxion (console editor or a CLI job), the plugin reads the exact model and power supply type from that output
+3. **Model rule** on the source, matching Percepxion model plus RJ45 and USB port counts to one device type, for fleets that buy one variant
+4. A **single device type** that matches the port counts
+
+When none of these settles it, the device isn't created and an "ambiguous model" finding lists the candidate types. **Create rule** and **Override** on the finding open forms with the Percepxion values filled in and the device type choices limited to those candidates. EMG units resolve from Percepxion data alone.
+
+### What the plugin changes in NetBox
+
+| Object | Plugin writes | Plugin never changes |
+|---|---|---|
+| Console server (device) | created with name, type, site, role, platform, serial; name kept in step with Percepxion | site, role or type of an existing device |
+| Console server port | label (the port's name on the console server), description (attached device hostname) | name, cables, anything else |
+| Port facts panel | attached device make, model, OS, version, serial, last reported time | |
+
+The console server is the source of truth for port labels and descriptions. A label edited by hand in NetBox is overwritten on the next sync. Rename the port on the console server instead.
+
+The plugin matches Percepxion devices to NetBox devices by its own link, then by serial number, then by name. When a serial match is in a different site from the source, or a name match has no serial to confirm it, the link is created as **pending** and nothing is written until someone with the approve permission approves it. A run writes only objects that changed, so a sync with no changes in Percepxion records no change log entries.
+
+## Permissions
+
+| Permission | Allows |
+|---|---|
+| `netbox_lantronix.add/change/delete_percepxionsource` | manage sources |
+| `netbox_lantronix.sync_percepxionsource` | run **Sync now** or the sync API call, and schedule syncs when saving a source |
+| `netbox_lantronix.view_*` | see sources, links, rules, overrides, findings and run history |
+| `netbox_lantronix.approve_devicelink` | approve pending device adoptions |
+| `netbox_lantronix.add/change_modelrule`, `..._devicetypeoverride` | resolve ambiguous models |
+
+The sync user needs `dcim.view/add/change_device` and `dcim.view/change_consoleserverport`, plus view on device types, sites, roles and platforms. Constrain these with NetBox object permissions, for example to one site, and the plugin stays inside them. A run that would write outside them fails as a whole, with the reason on the job, and changes nothing.
+
+The **Open console** button and the facts panel are shown only to users who can view the device and its ports.
+
+## Open console
+
+The button builds `ssh://<address>:<SSH base port + port number>`. It uses the device's primary IP in NetBox, or the management address Percepxion reports when no primary IP is set. Your browser opens it with your SSH client and you sign in to the console server as yourself.
+
+On the console server, direct SSH access is off by default on every port. Turn it on for the ports you want to reach, for example `set deviceport port 1-48 sshin enable` (answer `yes` to the confirmation), or from the WebUI's device port settings with **Apply Settings** to the ports you choose.
+
+## Troubleshooting
+
+| Symptom | Check |
+|---|---|
+| Plugin doesn't load | NetBox log names the endpoint and missing key, or a NetBox version outside 4.6 to 4.7 |
+| Job stays queued | RQ worker not running |
+| Job fails with a login error | Credentials in the environment. After a rejected login, scheduled runs pause for at least 30 minutes. Fix the credentials, restart NetBox, then click **Sync now**; it retries at once only when the credentials changed. |
+| Job fails with a permission error | The sync user's object permissions don't cover the device or site named in the error |
+| Device missing after a sync | **Findings**: ambiguous model, missing device type, name conflict or pending adoption |
+| PuTTY or ssh reports "connection refused" | Direct SSH access is off on that port of the console server (see [Open console](#open-console)) |
+
+## License
+
+Apache-2.0

netbox_lantronix-0.5.1/README.md

@@ -0,0 +1,194 @@
+# netbox-lantronix
+
+A NetBox plugin that keeps NetBox current with the Lantronix SLC 9000, SLC 8000 and EMG console servers managed by Percepxion. Nobody has to type console server inventory into NetBox by hand.
+
+On each sync the plugin reads Percepxion and:
+
+- creates the console server in NetBox with the right device type, so its console server ports come from the device type
+- labels each console server port with the name configured on the console server, and describes it with the hostname of the attached device
+- shows the attached device's make, model, OS and serial on the port, when the console server reports them
+- adds an **Open console** button on each port that launches an SSH session through the console server (`ssh://<console server>:<base port + port number>`)
+- lists anything it couldn't decide, such as an ambiguous model or a name conflict, as findings with a one-click fix
+
+The plugin never writes to Percepxion or to a console server. It reads from Percepxion and writes to NetBox only.
+
+## Requirements
+
+| | |
+|---|---|
+| NetBox | 4.6.0 to 4.7.x (the plugin refuses to load on other versions) |
+| Python | 3.12 or later |
+| RQ worker | A running NetBox worker (`manage.py rqworker`). Scheduled and on-demand syncs run as NetBox background jobs. |
+| Percepxion | Percepxion cloud or on-premises, and a Percepxion user with the **tenant_user** role in the organization you sync. No administrator role is needed. |
+| Device types | Lantronix SLC and EMG device types, imported before the first sync. The definitions are in [`docker/device-types`](docker/device-types). |
+
+## Install
+
+1. Install the package into the NetBox virtual environment:
+
+   ```
+   source /opt/netbox/venv/bin/activate
+   pip install netbox-lantronix
+   ```
+
+   To pin a version, install `netbox-lantronix==X.Y.Z` with a version from the [releases](https://github.com/Lantronix/netbox-lantronix/releases). For netbox-docker, follow [Docker](#docker) instead of these steps.
+
+2. Enable and configure the plugin in `configuration.py` (see [Configuration](#configuration)).
+
+3. Run the migrations and collect static files:
+
+   ```
+   cd /opt/netbox/netbox
+   python3 manage.py migrate netbox_lantronix
+   python3 manage.py collectstatic --no-input
+   ```
+
+4. Restart NetBox and the RQ worker.
+
+5. Create the NetBox user that sync changes are attributed to, for example `percepxion-sync`, and give it permissions (see [Permissions](#permissions)). It doesn't need to log in.
+
+6. Import the device types for your hardware from [`docker/device-types`](docker/device-types) through **Devices > Device Types > Import**.
+
+On the first run the plugin creates the manufacturer `Lantronix`, the platform `lantronix_itmgos` and the device custom field `percepxion_device_id` if they don't exist, and reuses them if they do. These are the same objects the `lantronix.oob` Ansible collection's NetBox playbook uses, so the two can share a NetBox.
+
+## Docker
+
+This builds a NetBox 4.6 image with the plugin, using [netbox-docker](https://github.com/netbox-community/netbox-docker). You need Docker with Compose and a Percepxion user with the **tenant_user** role.
+
+1. Clone both repositories side by side and copy in the plugin's files:
+
+   ```
+   git clone -b 5.0.2 --depth 1 https://github.com/netbox-community/netbox-docker.git
+   git clone https://github.com/Lantronix/netbox-lantronix.git
+   cd netbox-docker
+   cp ../netbox-lantronix/docker/docker-compose.override.yml .
+   cp ../netbox-lantronix/docker/plugins.py configuration/plugins.py
+   cp ../netbox-lantronix/docker/percepxion.env.example env/percepxion.env
+   ```
+
+2. Add your Percepxion username and password to `env/percepxion.env`. For on-premises Percepxion, change `PERCEPXION_URL` too.
+
+3. Build and start NetBox. The first start runs the database migrations and can take several minutes.
+
+   ```
+   docker compose build
+   docker compose up -d
+   ```
+
+4. Create your NetBox login:
+
+   ```
+   docker compose exec netbox /opt/netbox/netbox/manage.py createsuperuser
+   ```
+
+5. Import the device types and create the `percepxion-sync` user, a site and a role. Its permissions are limited to that site, and running it again changes nothing that already exists.
+
+   ```
+   docker compose exec netbox /opt/netbox/netbox/manage.py nbshell -c "exec(open('/opt/netbox-lantronix-docker/setup.py').read())"
+   ```
+
+6. Open http://localhost:8000 and follow [First sync](#first-sync), with endpoint `percepxion`, site **Console Servers** and role **Console Server**.
+
+To use another port, set `NETBOX_PORT` when you start NetBox. The stack runs as Compose project `netbox-lantronix`, so its containers and database stay separate from any other netbox-docker on the host.
+
+## Configuration
+
+Endpoints and credentials live only in `configuration.py` or the environment, never in the NetBox database.
+
+```python
+import os
+
+PLUGINS = ["netbox_lantronix"]
+
+PLUGINS_CONFIG = {
+    "netbox_lantronix": {
+        # NetBox user that change records are attributed to. Must exist.
+        "sync_user": "percepxion-sync",
+        "endpoints": {
+            # Name you pick here; a Percepxion source in the UI refers to it.
+            "percepxion-cloud": {
+                "url": "https://api.percepxion.ai/api",  # API base, including /api
+                "username": os.environ["PERCEPXION_USERNAME"],
+                "password": os.environ["PERCEPXION_PASSWORD"],
+                # Optional:
+                # "verify": True,                      # TLS verification, on by default
+                # "ca_bundle": "/etc/ssl/px-ca.pem",   # CA bundle for on-premises Percepxion
+                # "proxy": "http://proxy.example.com:3128",
+            },
+        },
+    },
+}
+```
+
+- `url` must use `https://`. The plugin won't load an endpoint that doesn't.
+- `username` and `password` are required. They're read when a sync starts and never written to the database, job data, logs or findings.
+- A missing key stops the plugin at startup with an error that names the endpoint and the key, never the value.
+- Turning `verify` off shows a warning on every source that uses the endpoint.
+- Endpoint changes take effect after a NetBox restart.
+
+## First sync
+
+1. Go to **Plugins > Lantronix > Percepxion Sources > Add**.
+2. Pick the endpoint and enter the Percepxion organization ID. Then choose the NetBox site and device role for new console servers, the sync interval in minutes (0 turns scheduling off, otherwise at least 5), and the SSH base port (3000 unless you changed it on your console servers).
+3. Save, then click **Sync now**. The job appears under the source with its counts and log.
+4. Open **Findings**. Each one names the device and the fix.
+
+To sync on events instead of waiting for the schedule, call `POST /api/plugins/lantronix/sources/<id>/sync/` with an API token whose user has the sync permission. It answers 202 with the queued job, or 409 when a run is already queued or running, which will pick up the change.
+
+### Device models
+
+Percepxion reports an SLC 9000's model as its total number of serial ports and doesn't report the Ethernet switch module or the power supply type. Several SLC 9000 SKUs therefore look the same in Percepxion. The plugin picks the device type in this order:
+
+1. **Type override** for that device, if you set one
+2. **`show sysconfig` output** stored in Percepxion: if anyone has run `show sysconfig` on the unit through Percepxion (console editor or a CLI job), the plugin reads the exact model and power supply type from that output
+3. **Model rule** on the source, matching Percepxion model plus RJ45 and USB port counts to one device type, for fleets that buy one variant
+4. A **single device type** that matches the port counts
+
+When none of these settles it, the device isn't created and an "ambiguous model" finding lists the candidate types. **Create rule** and **Override** on the finding open forms with the Percepxion values filled in and the device type choices limited to those candidates. EMG units resolve from Percepxion data alone.
+
+### What the plugin changes in NetBox
+
+| Object | Plugin writes | Plugin never changes |
+|---|---|---|
+| Console server (device) | created with name, type, site, role, platform, serial; name kept in step with Percepxion | site, role or type of an existing device |
+| Console server port | label (the port's name on the console server), description (attached device hostname) | name, cables, anything else |
+| Port facts panel | attached device make, model, OS, version, serial, last reported time | |
+
+The console server is the source of truth for port labels and descriptions. A label edited by hand in NetBox is overwritten on the next sync. Rename the port on the console server instead.
+
+The plugin matches Percepxion devices to NetBox devices by its own link, then by serial number, then by name. When a serial match is in a different site from the source, or a name match has no serial to confirm it, the link is created as **pending** and nothing is written until someone with the approve permission approves it. A run writes only objects that changed, so a sync with no changes in Percepxion records no change log entries.
+
+## Permissions
+
+| Permission | Allows |
+|---|---|
+| `netbox_lantronix.add/change/delete_percepxionsource` | manage sources |
+| `netbox_lantronix.sync_percepxionsource` | run **Sync now** or the sync API call, and schedule syncs when saving a source |
+| `netbox_lantronix.view_*` | see sources, links, rules, overrides, findings and run history |
+| `netbox_lantronix.approve_devicelink` | approve pending device adoptions |
+| `netbox_lantronix.add/change_modelrule`, `..._devicetypeoverride` | resolve ambiguous models |
+
+The sync user needs `dcim.view/add/change_device` and `dcim.view/change_consoleserverport`, plus view on device types, sites, roles and platforms. Constrain these with NetBox object permissions, for example to one site, and the plugin stays inside them. A run that would write outside them fails as a whole, with the reason on the job, and changes nothing.
+
+The **Open console** button and the facts panel are shown only to users who can view the device and its ports.
+
+## Open console
+
+The button builds `ssh://<address>:<SSH base port + port number>`. It uses the device's primary IP in NetBox, or the management address Percepxion reports when no primary IP is set. Your browser opens it with your SSH client and you sign in to the console server as yourself.
+
+On the console server, direct SSH access is off by default on every port. Turn it on for the ports you want to reach, for example `set deviceport port 1-48 sshin enable` (answer `yes` to the confirmation), or from the WebUI's device port settings with **Apply Settings** to the ports you choose.
+
+## Troubleshooting
+
+| Symptom | Check |
+|---|---|
+| Plugin doesn't load | NetBox log names the endpoint and missing key, or a NetBox version outside 4.6 to 4.7 |
+| Job stays queued | RQ worker not running |
+| Job fails with a login error | Credentials in the environment. After a rejected login, scheduled runs pause for at least 30 minutes. Fix the credentials, restart NetBox, then click **Sync now**; it retries at once only when the credentials changed. |
+| Job fails with a permission error | The sync user's object permissions don't cover the device or site named in the error |
+| Device missing after a sync | **Findings**: ambiguous model, missing device type, name conflict or pending adoption |
+| PuTTY or ssh reports "connection refused" | Direct SSH access is off on that port of the console server (see [Open console](#open-console)) |
+
+## License
+
+Apache-2.0

netbox_lantronix-0.5.1/netbox_lantronix/__init__.py

@@ -0,0 +1,28 @@
+from netbox.plugins import PluginConfig
+
+__version__ = "0.5.1"
+
+
+class NetBoxLantronixConfig(PluginConfig):
+    name = "netbox_lantronix"
+    verbose_name = "Lantronix"
+    description = "Sync Lantronix SLC and EMG devices from Percepxion into NetBox"
+    version = __version__
+    base_url = "lantronix"
+    min_version = "4.6.0"
+    max_version = "4.7.99"
+    default_settings = {
+        "sync_user": None,
+        "endpoints": {},
+    }
+
+    def ready(self):
+        super().ready()
+        from netbox.plugins import get_plugin_config
+
+        from .endpoint_checks import validate_endpoints
+
+        validate_endpoints(get_plugin_config(self.name, "endpoints"))
+
+
+config = NetBoxLantronixConfig