mirror of
https://github.com/netbox-community/netbox.git
synced 2026-04-11 11:47:08 +02:00
e9be6e4178
Merge ObjectPermissionActionsPanel and ObjectPermissionCustomActionsPanel into a single Actions panel that shows CRUD booleans and all registered actions in one table, matching the form's consolidated layout. Also fix data-object-types-selected attribute value (True -> 'true') and update plugin docs to show Meta.permissions as the primary registration approach.
52 lines
1.8 KiB
Markdown
52 lines
1.8 KiB
Markdown
# Custom Model Actions
|
|
|
|
Plugins can register custom permission actions for their models. These actions appear as checkboxes in the ObjectPermission form, making it easy for administrators to grant or restrict access to plugin-specific functionality without manually entering action names.
|
|
|
|
For example, a plugin might define a "sync" action for a model that syncs data from an external source, or a "bypass" action that allows users to bypass certain restrictions.
|
|
|
|
## Registering Model Actions
|
|
|
|
The preferred way to register custom actions is via Django's `Meta.permissions` on the model class. NetBox will automatically register these as model actions when the app is loaded:
|
|
|
|
```python
|
|
from netbox.models import NetBoxModel
|
|
|
|
class MyModel(NetBoxModel):
|
|
# ...
|
|
|
|
class Meta:
|
|
permissions = [
|
|
('sync', 'Synchronize data from external source'),
|
|
('export', 'Export data to external system'),
|
|
]
|
|
```
|
|
|
|
For dynamic registration (e.g. when actions depend on runtime state), you can call `register_model_actions()` directly, typically in your plugin's `ready()` method:
|
|
|
|
```python
|
|
# __init__.py
|
|
from netbox.plugins import PluginConfig
|
|
|
|
class MyPluginConfig(PluginConfig):
|
|
name = 'my_plugin'
|
|
# ...
|
|
|
|
def ready(self):
|
|
super().ready()
|
|
from utilities.permissions import ModelAction, register_model_actions
|
|
from .models import MyModel
|
|
|
|
register_model_actions(MyModel, [
|
|
ModelAction('sync', help_text='Synchronize data from external source'),
|
|
ModelAction('export', help_text='Export data to external system'),
|
|
])
|
|
|
|
config = MyPluginConfig
|
|
```
|
|
|
|
Once registered, these actions appear as checkboxes in a flat list when creating or editing an ObjectPermission.
|
|
|
|
::: utilities.permissions.ModelAction
|
|
|
|
::: utilities.permissions.register_model_actions
|