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 a0f1970fec Support 202211 (#1304)
* Carrier object implementation #909

* API keys: disabling of user account by a PeeringDB admin does not disable access via a User API key. Also no disable mech, only revoke. #1140

* Ops: django needs lightweight healthcheck route that confirms database connectivity #1284

* Ops: various indexes are needed #1285

* API requests with invalid Authentication headers should notify users in some way. #1220

* Allow user to change account username #1130

* UX to remove carriers from facilities more inline the other similar UX

* more UX fixes for removing carriers from facilities

* Cache hints are needed for optimal CDN use #970

* fixes Commandline tool "Run command" button gone #1278

* RIR status gets deleted when changes are made to the network #1279

* Improve MTU field #658

* CSRF cookie not set error from email confirmation view #1296

* expose CSP_CONNECT_SRC

* fix confirm email path checking in session middleware

* Ops: Emails to OPERATIONS_EMAIL need to be rate-limited #1282

* add website field to carrier ux

* website field on carrier optional with org fallback

* linting

* add *.google-analytics.com to CSP_CONNECT_SRC

* poetry relock

* fix issues with confirm-email reverse during session creation validation

* fix tests

* fix tests

* pin django-peeringdb to support_202211

* linting

* django ratelimit to <4

* regen docs

* fix automated net stats to only include networks with status `ok` #1283

* linting

* poetry lock

Co-authored-by: Matt Griswold <grizz@20c.com>
2023-01-18 10:32:46 -06:00

2.9 KiB

Generated from admin_commandline_tools.py on 2023-01-17 22:33:48.360745

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