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
Matt Griswold 505760aa8d Support 202203 (#1144)
* Do not show objects in status "pending" on the UI #784

* Fix peeringdb.js bug introduced in #784

* 500 Error during login for 2FA enabled accounts with unverified email address #996

* Django-Admin: adding a network with existing asn fails with internal error #1035

* Some command-line-tool executions are not logged #1119

* Ops: API throttling of repeated requests #1126

* Ops: response header X-Auth-ID to augment logging #1120

* Allow rate-limiting of melissa enabled api functionality. #1124

* State / Province normalization #1079

* Log melissa requests #1122

* remove debug messages

* bump django-handleref to 1.0.2

* Need consolidated app logs #845

* pin django peeringdb to 2.13 and relock poetry

* pin django-restframework-apikey to 2.1.0

* linting

* migrations

* docs regenerate

* docs

* linting

Co-authored-by: David Poarch <dpoarch@20c.com>
Co-authored-by: Stefan Pratter <stefan@20c.com>
2022-04-12 15:39:19 -05:00

2.9 KiB

Generated from admin_commandline_tools.py on 2022-04-12 16:41:02.631987

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