netbox-assets 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- netbox_assets/__init__.py +51 -0
- netbox_assets/api/__init__.py +0 -0
- netbox_assets/api/serializers.py +1 -0
- netbox_assets/api/serializers_/__init__.py +0 -0
- netbox_assets/api/serializers_/assets.py +185 -0
- netbox_assets/api/serializers_/nested.py +16 -0
- netbox_assets/api/urls.py +19 -0
- netbox_assets/api/views.py +80 -0
- netbox_assets/choices.py +23 -0
- netbox_assets/filtersets.py +430 -0
- netbox_assets/forms/__init__.py +8 -0
- netbox_assets/forms/assign.py +218 -0
- netbox_assets/forms/bulk_add.py +45 -0
- netbox_assets/forms/bulk_edit.py +161 -0
- netbox_assets/forms/bulk_import.py +313 -0
- netbox_assets/forms/create.py +95 -0
- netbox_assets/forms/filters.py +288 -0
- netbox_assets/forms/models.py +197 -0
- netbox_assets/forms/reassign.py +192 -0
- netbox_assets/graphql/__init__.py +7 -0
- netbox_assets/graphql/filters.py +43 -0
- netbox_assets/graphql/schema.py +20 -0
- netbox_assets/graphql/types.py +80 -0
- netbox_assets/managers.py +15 -0
- netbox_assets/migrations/0001_initial.py +339 -0
- netbox_assets/migrations/__init__.py +0 -0
- netbox_assets/models/__init__.py +2 -0
- netbox_assets/models/assets.py +404 -0
- netbox_assets/models/roles.py +57 -0
- netbox_assets/navigation.py +54 -0
- netbox_assets/search.py +32 -0
- netbox_assets/signals.py +68 -0
- netbox_assets/tables.py +374 -0
- netbox_assets/template_content.py +206 -0
- netbox_assets/templates/netbox_assets/asset.html +187 -0
- netbox_assets/templates/netbox_assets/asset_assign.html +13 -0
- netbox_assets/templates/netbox_assets/asset_bulk_add.html +20 -0
- netbox_assets/templates/netbox_assets/asset_bulk_import.html +61 -0
- netbox_assets/templates/netbox_assets/asset_create.html +10 -0
- netbox_assets/templates/netbox_assets/asset_edit.html +110 -0
- netbox_assets/templates/netbox_assets/asset_reassign.html +18 -0
- netbox_assets/templates/netbox_assets/assetrole.html +10 -0
- netbox_assets/templates/netbox_assets/inc/asset_edit_header.html +22 -0
- netbox_assets/templates/netbox_assets/inc/asset_info.html +42 -0
- netbox_assets/templates/netbox_assets/inc/asset_stats_counts.html +19 -0
- netbox_assets/templates/netbox_assets/inc/assetrole_status.html +16 -0
- netbox_assets/tests/__init__.py +0 -0
- netbox_assets/tests/asset/__init__.py +0 -0
- netbox_assets/tests/asset/test_api.py +191 -0
- netbox_assets/tests/asset/test_models.py +195 -0
- netbox_assets/tests/asset/test_views.py +198 -0
- netbox_assets/tests/asset/test_views_create.py +243 -0
- netbox_assets/tests/asset/test_views_reassign.py +295 -0
- netbox_assets/tests/asset_role/__init__.py +0 -0
- netbox_assets/tests/asset_role/test_api.py +58 -0
- netbox_assets/tests/asset_role/test_tree.py +115 -0
- netbox_assets/tests/asset_role/test_views.py +55 -0
- netbox_assets/tests/custom.py +39 -0
- netbox_assets/tests/query_counts.json +6 -0
- netbox_assets/tests/settings.py +17 -0
- netbox_assets/tests/test_load.py +46 -0
- netbox_assets/ui/__init__.py +0 -0
- netbox_assets/ui/panels.py +46 -0
- netbox_assets/urls.py +61 -0
- netbox_assets/utils.py +167 -0
- netbox_assets/version.py +1 -0
- netbox_assets/views/__init__.py +5 -0
- netbox_assets/views/asset.py +167 -0
- netbox_assets/views/asset_assign.py +21 -0
- netbox_assets/views/asset_create.py +63 -0
- netbox_assets/views/asset_reassign.py +28 -0
- netbox_assets/views/asset_role.py +127 -0
- netbox_assets-0.1.0.dist-info/METADATA +258 -0
- netbox_assets-0.1.0.dist-info/RECORD +77 -0
- netbox_assets-0.1.0.dist-info/WHEEL +5 -0
- netbox_assets-0.1.0.dist-info/licenses/LICENSE +22 -0
- netbox_assets-0.1.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
from django.apps import apps
|
|
2
|
+
from django.core.exceptions import ImproperlyConfigured
|
|
3
|
+
|
|
4
|
+
from netbox.plugins import PluginConfig
|
|
5
|
+
|
|
6
|
+
from .version import __version__
|
|
7
|
+
|
|
8
|
+
# Plugins that cannot be enabled together with netbox-assets. They define the
|
|
9
|
+
# same reverse relations on NetBox core models (e.g. Device.assigned_asset) and
|
|
10
|
+
# the same GraphQL type names, so NetBox would fail with confusing errors.
|
|
11
|
+
INCOMPATIBLE_PLUGINS = ('netbox_inventory',)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class NetBoxAssetsConfig(PluginConfig):
|
|
15
|
+
name = 'netbox_assets'
|
|
16
|
+
verbose_name = 'NetBox Assets'
|
|
17
|
+
version = __version__
|
|
18
|
+
description = (
|
|
19
|
+
'Simple asset tracking for NetBox. A stripped-down fork of netbox-inventory.'
|
|
20
|
+
)
|
|
21
|
+
author = 'Maksym Ototiuk'
|
|
22
|
+
author_email = 'pypi@masik.slmail.me'
|
|
23
|
+
base_url = 'assets'
|
|
24
|
+
min_version = '4.7.1'
|
|
25
|
+
default_settings = {
|
|
26
|
+
'used_status_name': 'used',
|
|
27
|
+
'used_additional_status_names': [],
|
|
28
|
+
'stored_status_name': 'stored',
|
|
29
|
+
'stored_additional_status_names': [
|
|
30
|
+
'retired',
|
|
31
|
+
],
|
|
32
|
+
'sync_hardware_serial_asset_tag': False,
|
|
33
|
+
'asset_import_create_device_type': False,
|
|
34
|
+
'asset_import_create_module_type': False,
|
|
35
|
+
'asset_import_create_rack_type': False,
|
|
36
|
+
'asset_import_create_tenant': False,
|
|
37
|
+
'asset_custom_fields_search_filters': {},
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
def ready(self):
|
|
41
|
+
conflicts = [name for name in INCOMPATIBLE_PLUGINS if apps.is_installed(name)]
|
|
42
|
+
if conflicts:
|
|
43
|
+
raise ImproperlyConfigured(
|
|
44
|
+
f'netbox_assets cannot be enabled together with: {", ".join(conflicts)}. '
|
|
45
|
+
f'Remove one of the plugins from PLUGINS in configuration.py.'
|
|
46
|
+
)
|
|
47
|
+
super().ready()
|
|
48
|
+
from . import signals # noqa: F401
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
config = NetBoxAssetsConfig
|
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
from .serializers_.assets import *
|
|
File without changes
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
from rest_framework import serializers
|
|
2
|
+
|
|
3
|
+
from dcim.api.serializers import (
|
|
4
|
+
DeviceSerializer,
|
|
5
|
+
DeviceTypeSerializer,
|
|
6
|
+
LocationSerializer,
|
|
7
|
+
ModuleSerializer,
|
|
8
|
+
ModuleTypeSerializer,
|
|
9
|
+
RackSerializer,
|
|
10
|
+
RackTypeSerializer,
|
|
11
|
+
)
|
|
12
|
+
from netbox.api.serializers import NestedGroupModelSerializer, PrimaryModelSerializer
|
|
13
|
+
from tenancy.api.serializers import ContactSerializer, TenantSerializer
|
|
14
|
+
|
|
15
|
+
from ...choices import HardwareKindChoices
|
|
16
|
+
from ...models import Asset, AssetRole
|
|
17
|
+
from .nested import NestedAssetRoleSerializer
|
|
18
|
+
|
|
19
|
+
__all__ = (
|
|
20
|
+
'AssetRoleSerializer',
|
|
21
|
+
'AssetSerializer',
|
|
22
|
+
)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
class AssetRoleSerializer(NestedGroupModelSerializer):
|
|
26
|
+
parent = NestedAssetRoleSerializer(required=False, allow_null=True, default=None)
|
|
27
|
+
asset_count = serializers.IntegerField(read_only=True, default=0)
|
|
28
|
+
|
|
29
|
+
class Meta:
|
|
30
|
+
model = AssetRole
|
|
31
|
+
fields = (
|
|
32
|
+
'id',
|
|
33
|
+
'url',
|
|
34
|
+
'display_url',
|
|
35
|
+
'display',
|
|
36
|
+
'name',
|
|
37
|
+
'slug',
|
|
38
|
+
'parent',
|
|
39
|
+
'color',
|
|
40
|
+
'description',
|
|
41
|
+
'owner',
|
|
42
|
+
'comments',
|
|
43
|
+
'tags',
|
|
44
|
+
'custom_fields',
|
|
45
|
+
'created',
|
|
46
|
+
'last_updated',
|
|
47
|
+
'asset_count',
|
|
48
|
+
'_depth',
|
|
49
|
+
)
|
|
50
|
+
brief_fields = (
|
|
51
|
+
'id',
|
|
52
|
+
'url',
|
|
53
|
+
'display',
|
|
54
|
+
'name',
|
|
55
|
+
'slug',
|
|
56
|
+
'description',
|
|
57
|
+
'asset_count',
|
|
58
|
+
'_depth',
|
|
59
|
+
)
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
class AssetSerializer(PrimaryModelSerializer):
|
|
63
|
+
# Read-only kind of hardware (device, module or rack), derived from the type
|
|
64
|
+
kind = serializers.ChoiceField(choices=HardwareKindChoices, read_only=True)
|
|
65
|
+
device_type = DeviceTypeSerializer(
|
|
66
|
+
nested=True,
|
|
67
|
+
required=False,
|
|
68
|
+
allow_null=True,
|
|
69
|
+
default=None,
|
|
70
|
+
)
|
|
71
|
+
device = DeviceSerializer(
|
|
72
|
+
nested=True,
|
|
73
|
+
required=False,
|
|
74
|
+
allow_null=True,
|
|
75
|
+
default=None,
|
|
76
|
+
)
|
|
77
|
+
module_type = ModuleTypeSerializer(
|
|
78
|
+
nested=True,
|
|
79
|
+
required=False,
|
|
80
|
+
allow_null=True,
|
|
81
|
+
default=None,
|
|
82
|
+
)
|
|
83
|
+
module = ModuleSerializer(
|
|
84
|
+
nested=True,
|
|
85
|
+
required=False,
|
|
86
|
+
allow_null=True,
|
|
87
|
+
default=None,
|
|
88
|
+
)
|
|
89
|
+
rack_type = RackTypeSerializer(
|
|
90
|
+
nested=True,
|
|
91
|
+
required=False,
|
|
92
|
+
allow_null=True,
|
|
93
|
+
default=None,
|
|
94
|
+
)
|
|
95
|
+
rack = RackSerializer(
|
|
96
|
+
nested=True,
|
|
97
|
+
required=False,
|
|
98
|
+
allow_null=True,
|
|
99
|
+
default=None,
|
|
100
|
+
)
|
|
101
|
+
storage_location = LocationSerializer(
|
|
102
|
+
nested=True,
|
|
103
|
+
required=False,
|
|
104
|
+
allow_null=True,
|
|
105
|
+
default=None,
|
|
106
|
+
)
|
|
107
|
+
tenant = TenantSerializer(
|
|
108
|
+
nested=True,
|
|
109
|
+
required=False,
|
|
110
|
+
allow_null=True,
|
|
111
|
+
default=None,
|
|
112
|
+
)
|
|
113
|
+
contact = ContactSerializer(
|
|
114
|
+
nested=True,
|
|
115
|
+
required=False,
|
|
116
|
+
allow_null=True,
|
|
117
|
+
default=None,
|
|
118
|
+
)
|
|
119
|
+
owning_tenant = TenantSerializer(
|
|
120
|
+
nested=True,
|
|
121
|
+
required=False,
|
|
122
|
+
allow_null=True,
|
|
123
|
+
default=None,
|
|
124
|
+
)
|
|
125
|
+
role = AssetRoleSerializer(
|
|
126
|
+
nested=True,
|
|
127
|
+
required=False,
|
|
128
|
+
allow_null=True,
|
|
129
|
+
default=None,
|
|
130
|
+
)
|
|
131
|
+
|
|
132
|
+
def to_internal_value(self, data):
|
|
133
|
+
ret = super().to_internal_value(data)
|
|
134
|
+
# store empty asset tag and serial as NULL, so that the unique
|
|
135
|
+
# constraints ignore them
|
|
136
|
+
if 'asset_tag' in ret and ret['asset_tag'] == '':
|
|
137
|
+
ret['asset_tag'] = None
|
|
138
|
+
if 'serial' in ret and ret['serial'] == '':
|
|
139
|
+
ret['serial'] = None
|
|
140
|
+
return ret
|
|
141
|
+
|
|
142
|
+
class Meta:
|
|
143
|
+
model = Asset
|
|
144
|
+
fields = (
|
|
145
|
+
'id',
|
|
146
|
+
'url',
|
|
147
|
+
'display_url',
|
|
148
|
+
'display',
|
|
149
|
+
'name',
|
|
150
|
+
'description',
|
|
151
|
+
'asset_tag',
|
|
152
|
+
'serial',
|
|
153
|
+
'status',
|
|
154
|
+
'kind',
|
|
155
|
+
'role',
|
|
156
|
+
'device_type',
|
|
157
|
+
'device',
|
|
158
|
+
'module_type',
|
|
159
|
+
'module',
|
|
160
|
+
'rack_type',
|
|
161
|
+
'rack',
|
|
162
|
+
'tenant',
|
|
163
|
+
'contact',
|
|
164
|
+
'storage_location',
|
|
165
|
+
'owning_tenant',
|
|
166
|
+
'owner',
|
|
167
|
+
'comments',
|
|
168
|
+
'tags',
|
|
169
|
+
'custom_fields',
|
|
170
|
+
'created',
|
|
171
|
+
'last_updated',
|
|
172
|
+
)
|
|
173
|
+
brief_fields = (
|
|
174
|
+
'id',
|
|
175
|
+
'url',
|
|
176
|
+
'display',
|
|
177
|
+
'serial',
|
|
178
|
+
'name',
|
|
179
|
+
'description',
|
|
180
|
+
)
|
|
181
|
+
# DRF automatically creates validators from the model's unique
|
|
182
|
+
# constraints. They don't work when some fields of a constraint may be
|
|
183
|
+
# NULL, so we remove them and rely on the model's validation instead.
|
|
184
|
+
# See https://www.django-rest-framework.org/api-guide/validators/#optional-fields
|
|
185
|
+
validators = []
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
from netbox.api.serializers import WritableNestedSerializer
|
|
2
|
+
|
|
3
|
+
from ...models import AssetRole
|
|
4
|
+
|
|
5
|
+
__all__ = ('NestedAssetRoleSerializer',)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class NestedAssetRoleSerializer(WritableNestedSerializer):
|
|
9
|
+
"""
|
|
10
|
+
Used only for the self-referencing `parent` field of AssetRoleSerializer,
|
|
11
|
+
the same way as NestedDeviceRoleSerializer in NetBox core.
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
class Meta:
|
|
15
|
+
model = AssetRole
|
|
16
|
+
fields = ('id', 'url', 'display_url', 'display', 'name')
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
from netbox.api.routers import NetBoxRouter
|
|
2
|
+
|
|
3
|
+
from . import views
|
|
4
|
+
|
|
5
|
+
app_name = 'netbox_assets'
|
|
6
|
+
|
|
7
|
+
router = NetBoxRouter()
|
|
8
|
+
router.APIRootView = views.NetBoxAssetsRootView
|
|
9
|
+
|
|
10
|
+
# Assets
|
|
11
|
+
router.register('assets', views.AssetViewSet)
|
|
12
|
+
router.register('asset-roles', views.AssetRoleViewSet)
|
|
13
|
+
|
|
14
|
+
# NetBox devices and modules with an additional has_asset_assigned filter
|
|
15
|
+
# (used by the asset assignment forms)
|
|
16
|
+
router.register('dcim/devices', views.DeviceAssetViewSet)
|
|
17
|
+
router.register('dcim/modules', views.ModuleAssetViewSet)
|
|
18
|
+
|
|
19
|
+
urlpatterns = router.urls
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
from rest_framework.routers import APIRootView
|
|
2
|
+
|
|
3
|
+
from dcim.api.views import DeviceViewSet, ModuleViewSet
|
|
4
|
+
from netbox.api.viewsets import NetBoxModelViewSet
|
|
5
|
+
|
|
6
|
+
from .. import filtersets, models
|
|
7
|
+
from .serializers import *
|
|
8
|
+
|
|
9
|
+
__all__ = (
|
|
10
|
+
'AssetRoleViewSet',
|
|
11
|
+
'AssetViewSet',
|
|
12
|
+
'DeviceAssetViewSet',
|
|
13
|
+
'ModuleAssetViewSet',
|
|
14
|
+
'NetBoxAssetsRootView',
|
|
15
|
+
)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class NetBoxAssetsRootView(APIRootView):
|
|
19
|
+
def get_view_name(self):
|
|
20
|
+
return 'Assets'
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
#
|
|
24
|
+
# Asset roles
|
|
25
|
+
#
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
class AssetRoleViewSet(NetBoxModelViewSet):
|
|
29
|
+
# Asset counts include assets of all child roles (cumulative=True)
|
|
30
|
+
queryset = models.AssetRole.objects.add_related_count(
|
|
31
|
+
models.AssetRole.objects.all(),
|
|
32
|
+
models.Asset,
|
|
33
|
+
'role',
|
|
34
|
+
'asset_count',
|
|
35
|
+
cumulative=True,
|
|
36
|
+
).prefetch_related('tags')
|
|
37
|
+
serializer_class = AssetRoleSerializer
|
|
38
|
+
filterset_class = filtersets.AssetRoleFilterSet
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
#
|
|
42
|
+
# Assets
|
|
43
|
+
#
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
class AssetViewSet(NetBoxModelViewSet):
|
|
47
|
+
queryset = models.Asset.objects.prefetch_related(
|
|
48
|
+
'device_type',
|
|
49
|
+
'device',
|
|
50
|
+
'module_type',
|
|
51
|
+
'module',
|
|
52
|
+
'rack_type',
|
|
53
|
+
'rack',
|
|
54
|
+
'role',
|
|
55
|
+
'storage_location',
|
|
56
|
+
'tags',
|
|
57
|
+
)
|
|
58
|
+
serializer_class = AssetSerializer
|
|
59
|
+
filterset_class = filtersets.AssetFilterSet
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
#
|
|
63
|
+
# NetBox devices and modules with an additional has_asset_assigned filter
|
|
64
|
+
#
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
class DeviceAssetViewSet(DeviceViewSet):
|
|
68
|
+
"""
|
|
69
|
+
Adds option to filter on asset assignment
|
|
70
|
+
"""
|
|
71
|
+
|
|
72
|
+
filterset_class = filtersets.DeviceAssetFilterSet
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
class ModuleAssetViewSet(ModuleViewSet):
|
|
76
|
+
"""
|
|
77
|
+
Adds option to filter on asset assignment
|
|
78
|
+
"""
|
|
79
|
+
|
|
80
|
+
filterset_class = filtersets.ModuleAssetFilterSet
|
netbox_assets/choices.py
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
from utilities.choices import ChoiceSet
|
|
2
|
+
|
|
3
|
+
#
|
|
4
|
+
# Assets
|
|
5
|
+
#
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class AssetStatusChoices(ChoiceSet):
|
|
9
|
+
key = 'Asset.status'
|
|
10
|
+
|
|
11
|
+
CHOICES = [
|
|
12
|
+
('stored', 'Stored', 'green'),
|
|
13
|
+
('used', 'Used', 'blue'),
|
|
14
|
+
('retired', 'Retired', 'gray'),
|
|
15
|
+
]
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class HardwareKindChoices(ChoiceSet):
|
|
19
|
+
CHOICES = [
|
|
20
|
+
('device', 'Device'),
|
|
21
|
+
('module', 'Module'),
|
|
22
|
+
('rack', 'Rack'),
|
|
23
|
+
]
|