Ravenports generated: 18 Feb 2024 19:59
[ravenports.git] / bucket_90 / python-netbox-inventory
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-netbox-inventory
4 VERSION=                1.5.2
5 KEYWORDS=               python
6 VARIANTS=               v11 v12
7 SDESC[v11]=             Inventory asset management in NetBox (3.11)
8 SDESC[v12]=             Inventory asset management in NetBox (3.12)
9 HOMEPAGE=               https://github.com/ArnesSI/netbox-inventory/
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/8a/bf/5945c7b0a26c11fef35e00c2b3efac494704a432c8201925c6d2d4312660
14 DISTFILE[1]=            netbox_inventory-1.5.2-py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[v11]=             single
17 SPKGS[v12]=             single
18
19 OPTIONS_AVAILABLE=      PY311 PY312
20 OPTIONS_STANDARD=       none
21 VOPTS[v11]=             PY311=ON PY312=OFF
22 VOPTS[v12]=             PY311=OFF PY312=ON
23
24 DISTNAME=               netbox_inventory-1.5.2.dist-info
25
26 GENERATED=              yes
27
28 [PY311].USES_ON=                        python:v11,wheel
29
30 [PY312].USES_ON=                        python:v12,wheel
31
32 [FILE:3208:descriptions/desc.single]
33 # NetBox Inventory Plugin
34
35 A [Netbox] plugin for hardware inventory.
36
37 ## Features
38
39 Keep track of your hardware, whether it is installed or in storage. You can
40 define assets that represent hardware that can be used as a device, module
41 or
42 inventory item in NetBox.
43
44 Each asset can have a storage location defined, when not in use. You can
45 assign
46 an asset to a device, module or inventory item. The plugin can keep serial
47 number
48 and asset tag between asset and device, module or inventory item in sync if
49 enabled in settings.
50
51 On Site and Location detail views there is a new tab Assets that can show
52 assets
53 that are stored or installed at that location or both. Rack details view
54 also has
55 a tab for installed Assets. This provides a unified view of all assets at a
56 given
57 location.
58
59 To properly support inventory items (that are used in NetBox to model SFP
60 and
61 similar modules) the plugin defines inventory item types that are
62 equivalent to
63 device types and module types. 
64
65 Inventory item types can be assigned into inventory item groups. On a group
66 detail
67 view you have an overview of the number of contained assets broken down by
68 asset
69 status or inventory item type and status. This way you can quickly see how
70 many
71 of a certain type of hardware you still have spare.
72
73 Inventory item groups can be nested, so you can for example model all
74 pluggables
75 as one top-level group with child groups for SFP+ modules, SFP28 modules
76 and so
77 on.
78
79 ### Automatic management of asset status
80
81 Each asset has a status attribute that can indicate use of the asset. These
82 statuses can be set as needed by each NetBox installation.
83
84 Two statuses can have a special meaning. One to indicate asset is in
85 storage and one
86 to indicate asset is in use.
87
88 netbox_inventory can automatically set status to the value specified in
89 `used_status_name` configuration item when an asset is assigned to a
90 device, module
91 or inventory item.
92
93 When you remove an asset from device, module or inventory item the plugin
94 will set
95 asset status to `stored_status_name` configuration item.
96
97 To disable automatically changing status, set these two config parameters
98 to `None`.
99
100 ### Prevent unwanted changes for tagged assets
101
102 With `asset_disable_editing_fields_for_tags` and
103 `asset_disable_deletion_for_tags` you can prevent changes to specified
104 asset data for assets that have certain tags attached. Changes are only
105 prevented via web interface. API modifications are allowed.
106
107 The idea is that an external system uses some assets stored in
108 netbox_inventory, and you want to prevent accidental changes to data
109 directly in NetBox web interface. Only that external system should modify
110 the data.
111
112 ## Compatibility
113
114 This plugin requires netbox version 3.5.x to work. Older versions of the
115 plugin
116 support older netbox version as per table below:
117
118 | NetBox Version | Plugin Version |
119 |----------------|----------------|
120 |       3.3      |      1.1.x     |
121 |       3.4      |      1.2.x     |
122 |       3.5      | 1.3.x & 1.4.x  |
123 |       3.6      |      1.5.x     |
124
125 ## Installing
126
127 Review [official Netbox plugin documentation] for installation
128 instructions.
129
130 You install the plugin from pypi with pip. Make sure you activate Netbox's
131 virtual
132 environment first:
133
134
135 [FILE:118:distinfo]
136 851ccb94a3ef31ce102ef8dcd458312e6f988e83bbb4a1ca4751a5565ded04d7        90214 netbox_inventory-1.5.2-py3-none-any.whl
137