netbox-user-credentials-plugin 0.1.0__tar.gz

netbox_user_credentials_plugin-0.1.0/LICENSE

@@ -0,0 +1,13 @@
+              DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2026 Dmitry Konyushenko <konyushenko.dmitriy@gmail.com>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

netbox_user_credentials_plugin-0.1.0/MANIFEST.in

@@ -0,0 +1,11 @@
+include CONTRIBUTING.md
+include LICENSE
+include README.md
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
+
+graft templates

netbox_user_credentials_plugin-0.1.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: netbox-user-credentials-plugin
+Version: 0.1.0
+Summary: NetBox plugin for User Credentials
+Author-email: Dmitry Konyushenko <konyushenko.dmitriy@gmail.com>
+License-Expression: WTFPL
+Project-URL: Homepage, https://github.com/ilyjorsey/netbox-user-credentials-plugin
+Project-URL: Documentation, https://github.com/ilyjorsey/netbox-user-credentials-plugin/blob/main/README.md
+Project-URL: Source, https://github.com/ilyjorsey/netbox-user-credentials-plugin
+Project-URL: Tracker, https://github.com/ilyjorsey/netbox-user-credentials-plugin/issues
+Keywords: netbox,netbox-plugin
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.1
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.12.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: check-manifest==0.51; extra == "test"
+Requires-Dist: ruff==0.14.14; extra == "test"
+Requires-Dist: pre-commit==6.0.0; extra == "test"
+Requires-Dist: pytest==9.0.2; extra == "test"
+Dynamic: license-file
+
+# NetBox User Credentials Plugin
+
+NetBox plugin for managing User Credentials.
+
+The standard NetBox VM model only allows contacts to be assigned. However, if you need to keep an inventory of users associated with virtual machines, including multiple users linked to the same contact, NetBox does not provide sufficient functionality out of the box. The User Credentials plugin helps solve this problem.
+
+- Free software: WTFPL
+- Documentation: https://ilyjorsey.github.io/netbox-user-credentials-plugin/
+
+## Screenshots
+
+
+| User Credentials page |
+|:---:|
+![User Credential](docs/images/uc_view.png)
+
+| Contact page - User Credentials | Virtual Machine page - User Credentials |
+|:---:|:---:|
+| ![Contact User Credentials](docs/images/contact_uc_view.png) | ![Virtual Machine User Credentials](docs/images/vm_uc_view.png) |
+
+## Compatibility
+
+This plugin requires **NetBox 4.5** or later.
+
+| NetBox Version | Plugin Version |
+|----------------|----------------|
+|     4.5+       |      0.1.0     |
+
+For more detailed compatibility information, see [COMPATIBILITY.md](COMPATIBILITY.md).
+
+## REST API
+
+This plugin provides a REST API endpoint for managing User Credentials resources:
+
+- `/api/plugins/netbox_user_credentials_plugin/user-credentials/` - List and create plugin objects
+
+
+
+## Installing
+
+For adding to a NetBox Docker setup see
+[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
+
+Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
+ or if you use netbox-docker, your `/configuration/plugins.py` file :
+
+```python
+PLUGINS = [
+    'netbox_user_credentials_plugin'
+]
+
+PLUGINS_CONFIG = {
+    "netbox_user_credentials_plugin": {},
+}
+```
+
+## Usage
+
+For detailed usage instructions, please refer to the [documentation](https://ilyjorsey.github.io/netbox-user-credentials-plugin/).
+
+
+### Feature Requests & Reporting Bugs
+
+Feature Requests & Reporting Bugs can be submitted as [GitHub Issues](https://github.com/ilyjorsey/netbox-user-credentials-plugin/issues).

netbox_user_credentials_plugin-0.1.0/README.md

@@ -0,0 +1,64 @@
+# NetBox User Credentials Plugin
+
+NetBox plugin for managing User Credentials.
+
+The standard NetBox VM model only allows contacts to be assigned. However, if you need to keep an inventory of users associated with virtual machines, including multiple users linked to the same contact, NetBox does not provide sufficient functionality out of the box. The User Credentials plugin helps solve this problem.
+
+- Free software: WTFPL
+- Documentation: https://ilyjorsey.github.io/netbox-user-credentials-plugin/
+
+## Screenshots
+
+
+| User Credentials page |
+|:---:|
+![User Credential](docs/images/uc_view.png)
+
+| Contact page - User Credentials | Virtual Machine page - User Credentials |
+|:---:|:---:|
+| ![Contact User Credentials](docs/images/contact_uc_view.png) | ![Virtual Machine User Credentials](docs/images/vm_uc_view.png) |
+
+## Compatibility
+
+This plugin requires **NetBox 4.5** or later.
+
+| NetBox Version | Plugin Version |
+|----------------|----------------|
+|     4.5+       |      0.1.0     |
+
+For more detailed compatibility information, see [COMPATIBILITY.md](COMPATIBILITY.md).
+
+## REST API
+
+This plugin provides a REST API endpoint for managing User Credentials resources:
+
+- `/api/plugins/netbox_user_credentials_plugin/user-credentials/` - List and create plugin objects
+
+
+
+## Installing
+
+For adding to a NetBox Docker setup see
+[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
+
+Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
+ or if you use netbox-docker, your `/configuration/plugins.py` file :
+
+```python
+PLUGINS = [
+    'netbox_user_credentials_plugin'
+]
+
+PLUGINS_CONFIG = {
+    "netbox_user_credentials_plugin": {},
+}
+```
+
+## Usage
+
+For detailed usage instructions, please refer to the [documentation](https://ilyjorsey.github.io/netbox-user-credentials-plugin/).
+
+
+### Feature Requests & Reporting Bugs
+
+Feature Requests & Reporting Bugs can be submitted as [GitHub Issues](https://github.com/ilyjorsey/netbox-user-credentials-plugin/issues).

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/__init__.py

@@ -0,0 +1,16 @@
+from netbox.plugins import PluginConfig
+
+
+class UserCredentialsConfig(PluginConfig):
+    name = "netbox_user_credentials_plugin"
+    verbose_name = "NetBox User Credentials"
+    description = "NetBox plugin for managing virtual machine users credentials"
+    author = "Dmitry Konyushenko"
+    author_email = "konyushenko.dmitriy@gmail.com"
+    version = "0.1.0"
+    base_url = "netbox_user_credentials_plugin"
+    min_version = "4.5.0"
+    max_version = "4.6.2"
+
+
+config = UserCredentialsConfig

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/api/__init__.py

@@ -0,0 +1,6 @@
+"""
+REST API for NetBox User Credentials Plugin.
+
+For more information on developing NetBox REST APIs, see:
+https://docs.netbox.dev/en/stable/plugins/development/rest-api/
+"""

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/api/serializers.py

@@ -0,0 +1,38 @@
+"""
+API serializers for NetBox User Credentials Plugin.
+
+Serializers are required for NetBox event handling (webhooks, change logging).
+They also power the REST API endpoints.
+
+For more information on NetBox REST API serializers, see:
+https://docs.netbox.dev/en/stable/plugins/development/rest-api/#serializers
+
+For Django REST Framework serializers, see:
+https://www.django-rest-framework.org/api-guide/serializers/
+"""
+
+from netbox.api.serializers import NetBoxModelSerializer
+from rest_framework import serializers
+
+from ..models import UserCredentials
+
+
+class UserCredentialsSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_user_credentials_plugin-api:usercredentials-detail"
+    )
+
+    class Meta:
+        model = UserCredentials
+        fields = ("id", 
+            "url",
+            "display",
+            "username",
+            "virtual_machine",
+            "contact",
+            "password_valid_from",
+            "password_valid_to",
+            "tags", 
+            "custom_fields", 
+            "created", 
+            "last_updated")

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/api/urls.py

@@ -0,0 +1,21 @@
+"""
+API URL patterns for NetBox User Credentials Plugin.
+
+For more information on NetBox REST API routing, see:
+https://docs.netbox.dev/en/stable/plugins/development/rest-api/#routers
+
+For Django REST Framework routers, see:
+https://www.django-rest-framework.org/api-guide/routers/
+"""
+
+from netbox.api.routers import NetBoxRouter
+
+from .views import UserCredentialsViewSet
+
+app_name = "netbox_user_credentials_plugin"
+
+router = NetBoxRouter()
+router.register("user-credentials", UserCredentialsViewSet)
+
+urlpatterns = router.urls
+

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/api/views.py

@@ -0,0 +1,20 @@
+"""
+API viewsets for NetBox User Credentials Plugin.
+
+For more information on NetBox REST API viewsets, see:
+https://docs.netbox.dev/en/stable/plugins/development/rest-api/#viewsets
+
+For Django REST Framework viewsets, see:
+https://www.django-rest-framework.org/api-guide/viewsets/
+"""
+
+from netbox.api.viewsets import NetBoxModelViewSet
+
+from ..models import UserCredentials
+from .serializers import UserCredentialsSerializer
+
+
+class UserCredentialsViewSet(NetBoxModelViewSet):
+    queryset = UserCredentials.objects.all()
+    serializer_class = UserCredentialsSerializer
+

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/filtersets.py

@@ -0,0 +1,20 @@
+from netbox.filtersets import NetBoxModelFilterSet
+
+from .models import UserCredentials
+
+
+class UserCredentialsFilterSet(NetBoxModelFilterSet):
+    class Meta:
+        model = UserCredentials
+        fields = [
+            "username",
+            "virtual_machine",
+            "contact",
+            "password_valid_from",
+            "password_valid_to",
+            "last_login_at",
+            "last_login_ip",
+        ]
+
+    def search(self, queryset, username, value):
+        return queryset.filter(username__icontains=value)

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/forms.py

@@ -0,0 +1,128 @@
+from django import forms
+from netbox.forms import (
+    NetBoxModelBulkEditForm,
+    NetBoxModelFilterSetForm,
+    NetBoxModelForm,
+)
+from tenancy.models import Contact
+from utilities.forms.fields import (
+    DynamicModelChoiceField,
+    DynamicModelMultipleChoiceField,
+)
+from utilities.forms.widgets import DatePicker
+from virtualization.models import VirtualMachine
+from ipam.models import IPAddress
+
+from .models import UserCredentials
+
+
+class UserCredentialsForm(NetBoxModelForm):
+
+    class Meta:
+        model = UserCredentials
+        fields = (
+            "username",
+            "virtual_machine",
+            "contact",
+            "password_valid_from",
+            "password_valid_to",
+            "last_login_at",
+            "last_login_ip",
+            "comments",
+        )
+        widgets = {
+            "password_valid_from": DatePicker(),
+            "password_valid_to": DatePicker(),
+            "last_login_at": DatePicker(),
+        }
+
+
+class UserCredentialsFilterForm(NetBoxModelFilterSetForm):
+    model = UserCredentials
+
+    username = forms.CharField(
+        required=False,
+        label="Username",
+    )
+
+    virtual_machine = DynamicModelMultipleChoiceField(
+        queryset=VirtualMachine.objects.all(),
+        required=False,
+    )
+
+    contact = DynamicModelMultipleChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+    )
+
+    last_login_ip = DynamicModelMultipleChoiceField(
+        queryset=IPAddress.objects.all(),
+        required=False,
+    )
+
+    password_valid_from = forms.DateField(
+        required=False,
+        widget=DatePicker(),
+    )
+
+    password_valid_to = forms.DateField(
+        required=False,
+        widget=DatePicker(),
+    )
+
+    last_login_at = forms.DateField(
+        required=False,
+        widget=DatePicker(),
+    )
+
+
+class UserCredentialsBulkEditForm(NetBoxModelBulkEditForm):
+
+    username = forms.CharField(
+        required=False,
+    )
+
+    virtual_machine = DynamicModelChoiceField(
+        queryset=VirtualMachine.objects.all(),
+        required=False,
+    )
+
+    contact = DynamicModelChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+    )
+
+    password_valid_from = forms.DateField(
+        required=False,
+        widget=DatePicker(),
+    )
+
+    password_valid_to = forms.DateField(
+        required=False,
+        widget=DatePicker(),
+    )
+
+    last_login_at = forms.DateField(
+        required=False,
+        widget=DatePicker(),
+    )
+
+    last_login_ip = forms.GenericIPAddressField(
+        required=False,
+    )
+
+    comments = forms.CharField(
+        required=False,
+        widget=forms.Textarea,
+    )
+
+    model = UserCredentials
+
+    nullable_fields = (
+        "contact",
+        "password_valid_from",
+        "password_valid_to",
+        "last_login_at",
+        "last_login_ip",
+        "comments",
+    )

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/migrations/0001_initial.py

@@ -0,0 +1,34 @@
+# Generated by Django 6.0.5 on 2026-06-14 20:13
+
+import netbox.models.deletion
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('extras', '0138_customfieldchoiceset_choice_colors'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Usercredentials',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder)),
+                ('name', models.CharField(max_length=100, unique=True)),
+                ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
+            ],
+            options={
+                'verbose_name_plural': 'Usercredentialss',
+                'ordering': ('name',),
+            },
+            bases=(netbox.models.deletion.DeleteMixin, models.Model),
+        ),
+    ]

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/migrations/0002_alter_usercredentials_options_and_more.py

@@ -0,0 +1,76 @@
+# Generated by Django 6.0.5 on 2026-06-15 18:06
+
+import django.db.models.deletion
+import netbox.models.deletion
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('extras', '0138_customfieldchoiceset_choice_colors'),
+        ('netbox_user_credentials_plugin', '0001_initial'),
+        ('tenancy', '0024_default_ordering_indexes'),
+        ('virtualization', '0056_virtualmachine_render_config_permission'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='usercredentials',
+            options={'ordering': ('username',)},
+        ),
+        migrations.RenameField(
+            model_name='usercredentials',
+            old_name='name',
+            new_name='username',
+        ),
+        migrations.AddField(
+            model_name='usercredentials',
+            name='comments',
+            field=models.TextField(blank=True),
+        ),
+        migrations.AddField(
+            model_name='usercredentials',
+            name='contact',
+            field=models.ForeignKey(default=None, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='user_credentials_contact', to='tenancy.contact'),
+        ),
+        migrations.AddField(
+            model_name='usercredentials',
+            name='password_valid_from',
+            field=models.DateField(blank=True, default=None, null=True),
+        ),
+        migrations.AddField(
+            model_name='usercredentials',
+            name='password_valid_to',
+            field=models.DateField(blank=True, default=None, null=True),
+        ),
+        migrations.AddField(
+            model_name='usercredentials',
+            name='virtual_machine',
+            field=models.OneToOneField(default=1, on_delete=django.db.models.deletion.CASCADE, related_name='user_credentials_virtual_machine', to='virtualization.virtualmachine'),
+            preserve_default=False,
+        ),
+        migrations.CreateModel(
+            name='UserGroups',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder)),
+                ('name', models.CharField(max_length=100, unique=True)),
+                ('comments', models.TextField(blank=True)),
+                ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
+            ],
+            options={
+                'abstract': False,
+            },
+            bases=(netbox.models.deletion.DeleteMixin, models.Model),
+        ),
+        migrations.AddField(
+            model_name='usercredentials',
+            name='groups',
+            field=models.ManyToManyField(blank=True, related_name='user_credentials_groups', to='netbox_user_credentials_plugin.usergroups'),
+        ),
+    ]

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/migrations/0003_rename_usergroups_usercredentialgroups_and_more.py

@@ -0,0 +1,25 @@
+# Generated by Django 6.0.5 on 2026-06-16 18:40
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('extras', '0138_customfieldchoiceset_choice_colors'),
+        ('netbox_user_credentials_plugin', '0002_alter_usercredentials_options_and_more'),
+        ('tenancy', '0024_default_ordering_indexes'),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='UserGroups',
+            new_name='UserCredentialGroups',
+        ),
+        migrations.AlterField(
+            model_name='usercredentials',
+            name='contact',
+            field=models.ForeignKey(blank=True, default=None, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='user_credentials_contact', to='tenancy.contact'),
+        ),
+    ]

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/migrations/0004_remove_usercredentials_groups_and_more.py

@@ -0,0 +1,20 @@
+# Generated by Django 6.0.5 on 2026-06-17 19:35
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_user_credentials_plugin', '0003_rename_usergroups_usercredentialgroups_and_more'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='usercredentials',
+            name='groups',
+        ),
+        migrations.DeleteModel(
+            name='UserCredentialGroups',
+        ),
+    ]

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/migrations/0005_alter_usercredentials_username.py

@@ -0,0 +1,18 @@
+# Generated by Django 6.0.5 on 2026-06-17 19:41
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_user_credentials_plugin', '0004_remove_usercredentials_groups_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='usercredentials',
+            name='username',
+            field=models.CharField(max_length=101, unique=True),
+        ),
+    ]

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/migrations/0006_alter_usercredentials_virtual_machine.py

@@ -0,0 +1,20 @@
+# Generated by Django 6.0.5 on 2026-06-18 19:49
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_user_credentials_plugin', '0005_alter_usercredentials_username'),
+        ('virtualization', '0056_virtualmachine_render_config_permission'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='usercredentials',
+            name='virtual_machine',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='user_credentials_virtual_machine', to='virtualization.virtualmachine'),
+        ),
+    ]

netbox_user_credentials_plugin-0.1.0/netbox_user_credentials_plugin/migrations/0007_alter_usercredentials_username.py

@@ -0,0 +1,18 @@
+# Generated by Django 6.0.5 on 2026-06-21 10:03
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_user_credentials_plugin', '0006_alter_usercredentials_virtual_machine'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='usercredentials',
+            name='username',
+            field=models.CharField(max_length=101),
+        ),
+    ]