1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00
Files
peeringdb-peeringdb/docs/dev/modules/admin_commandline_tools.py.md
Stefan Pratter 2e8788b595 Support 202210 (#1286)
* Allow REALPEER to overwrite GHOSTPEER netixlan entry, if asn and IPv6/v4 addresses matches the IX-F Members Export information #983

* Lightweight user notification mechanism #758

* do not allow affiliation with a deleted organisation #953

* Improve readability when users have special permissions #659

* fix advanced search export when api-cache exist and no filters were supplied #1153

* Ops: Throttle strings with "Response size" should be renamed "Repeated request" #1168

* allow ixlan prefix to be changed / deleted regardless of existence of netixlans in the address space #924

* linting

* poetry relock

* remove debug code

* linting

* fixed Reset IX-F suggestions link non-functional #1253

* solved UI shows own email when viewing affiliation requests for an organization #1250

* Adjust "Add Facility" menu to include newly defined fields #1091

* Footer "Global System Statistics" should be cached within django instance, not updated with every page load #1283

* linting

* django-handleref to 1.1.0 and relock poetry

* GLOBAL_STATS_CACHE_DURATION default to 900 seconds

* remove vscode and idea

* remove Ctl/dev/docker-compose.debug.yml

* remove unsused variable

* rename STATS to __STATS

* linting

* regen docs
2022-11-08 11:25:32 -06:00

131 lines
2.9 KiB
Markdown

Generated from admin_commandline_tools.py on 2022-11-08 14:31:50.933987
# peeringdb_server.admin_commandline_tools
Defines CLI wrappers for django commands that should
be executable through the django-admin interface.
Extend the CommandLineToolWrapper class and call the
register_tool decorator to add support for a new django
command to exposed in this manner.
# Functions
---
## get_tool
`def get_tool(tool_id, form)`
Arguments:
tool_id (str): tool_id as it exists in COMMANDLINE_TOOLS
form (django.forms.Form): form instance
Returns:
CommandLineToolWrapper instance
---
## get_tool_from_data
`def get_tool_from_data(data)`
Arguments:
data (dict): dict containing form data, at the very least
needs to have a "tool" key containing the tool_id
Returns:
CommandLineToolWrapper instance
---
# Classes
---
## ToolIXFIXPMemberImport
```
ToolIXFIXPMemberImport(peeringdb_server.admin_commandline_tools.CommandLineToolWrapper)
```
Allows resets for various parts of the ix-f member data import protocol.
And import ix-f member data for a single Ixlan at a time.
### Instanced Attributes
These attributes / properties will be available on instances of the class
- description (`@property`): None
## ToolMergeFacilities
```
ToolMergeFacilities(peeringdb_server.admin_commandline_tools.CommandLineToolWrapper)
```
This tool runs the pdb_fac_merge command to
merge two facilities.
### Instanced Attributes
These attributes / properties will be available on instances of the class
- description (`@property`): Provide a human readable description of the command that was run.
## ToolMergeFacilitiesUndo
```
ToolMergeFacilitiesUndo(peeringdb_server.admin_commandline_tools.CommandLineToolWrapper)
```
This tool runs the pdb_fac_merge_undo command to
undo a facility merge.
### Instanced Attributes
These attributes / properties will be available on instances of the class
- description (`@property`): Provide a human readable description of the command that was run.
## ToolRenumberLans
```
ToolRenumberLans(peeringdb_server.admin_commandline_tools.CommandLineToolWrapper)
```
This tools runs the pdb_renumber_lans command to
Renumber IP Spaces in an Exchange.
### Instanced Attributes
These attributes / properties will be available on instances of the class
- description (`@property`): Provide a human readable description of the command that was run.
## ToolUndelete
```
ToolUndelete(peeringdb_server.admin_commandline_tools.CommandLineToolWrapper)
```
Allows restoration of an object object and it's child objects.
### Instanced Attributes
These attributes / properties will be available on instances of the class
- description (`@property`): None
## ToolValidateData
```
ToolValidateData(peeringdb_server.admin_commandline_tools.CommandLineToolWrapper)
```
Validate data in the database.
### Instanced Attributes
These attributes / properties will be available on instances of the class
- description (`@property`): None