vent.menus package

Submodules

vent.menus.add module

class vent.menus.add.AddForm(name=None, parentApp=None, framed=None, help=None, color='FORMDEFAULT', widget_list=None, cycle_widgets=False, *args, **keywords)

Bases: npyscreen.fmActionForm.ActionForm

For for adding a new repo

create()

Create widgets for AddForm

default_repo = 'https://github.com/cyberreboot/vent-plugins'

on_cancel()

When user clicks cancel, will return to MAIN

on_ok()

Add the repository

quit(*args, **kwargs)

Overridden to switch back to MAIN form

vent.menus.add_options module

class vent.menus.add_options.AddOptionsForm(name=None, parentApp=None, framed=None, help=None, color='FORMDEFAULT', widget_list=None, cycle_widgets=False, *args, **keywords)

Bases: npyscreen.fmActionForm.ActionForm

For specifying options when adding a repo

branch_cb = {}

branches = []

build_tc = {}

commit_tc = {}

commits = {}

create()

Update with current branches and commits

error = None

on_cancel()

on_ok()

Take the branch, commit, and build selection and add them as plugins

quit(*args, **kwargs)

repo_values()

Set the appropriate repo dir and get the branches and commits of it

vent.menus.backup module

class vent.menus.backup.BackupForm(*args, **keywords)

Bases: npyscreen.fmActionForm.ActionForm

Form that can be used to select a backup file to restore

create()

Add backup files to select from

on_cancel()

When user clicks cancel, will return to MAIN

on_ok()

Perform restoration on the backup file selected

quit(*args, **kwargs)

vent.menus.choose_tools module

class vent.menus.choose_tools.ChooseToolsForm(name=None, parentApp=None, framed=None, help=None, color='FORMDEFAULT', widget_list=None, cycle_widgets=False, *args, **keywords)

Bases: npyscreen.fmActionForm.ActionForm

For picking which tools to add

create()

Update with current tools for each branch at the version chosen

on_cancel()

on_ok()

Take the tool selections and add them as plugins

quit(*args, **kwargs)

repo_tools(branch)

Set the appropriate repo dir and get the tools available of it

tools_tc = {}

vent.menus.del_instances module

class vent.menus.del_instances.DeleteForm(*args, **keywords)

Bases: npyscreen.fmActionForm.ActionForm

A form for selecting instances to delete and deleting them

change_screens()

Change to the next tool to edit or back to MAIN form

create()

Creates the necessary display for this form

on_cancel()

Exits the form without performing any action

on_ok()

Delete the instances that the user chose to delete

quit(*args, **kargs)

Quit without making any changes to the tool

class vent.menus.del_instances.InstanceSelect(*args, **kargs)

Bases: npyscreen.wgmultiselect.MultiSelect

A widget class for selecting an exact amount of instances to perform actions on

safe_to_exit(*args, **kargs)

Overrided to prevent user from exiting selection until they have selected the right amount of instances

when_value_edited(*args, **kargs)

Overrided to prevent user from selecting too many instances

vent.menus.editor module

class vent.menus.editor.EditorForm(repo='', tool_name='', branch='', version='', next_tool=None, just_downloaded=False, vent_cfg=False, from_registry=False, new_instance=False, *args, **keywords)

Bases: npyscreen.fmActionForm.ActionForm

Form that can be used as a pseudo text editor in npyscreen

change_screens()

Change to the next tool to edit or back to MAIN form

create()

Create multi-line widget for editing

on_cancel()

Don’t save changes made to vent.template

on_ok()

Save changes made to vent.template

static valid_input(val)

Ensure the input the user gave is of a valid format

vent.menus.help module

class vent.menus.help.HelpForm(*args, **keywords)

Bases: npyscreen.fmFormWithMenus.ActionFormWithMenus

Help form for the Vent CLI

change_forms(*args, **keywords)

Checks which form is currently displayed and toggles to the other one

create()

Override method for creating FormBaseNew form

exit(*args, **keywords)

on_cancel()

on_ok()

static switch(page)

vent.menus.inventory module

class vent.menus.inventory.InventoryForm(action=None, logger=None, *args, **keywords)

Bases: npyscreen.fmForm.FormBaseNew

Inventory form for the Vent CLI

create()

Override method for creating FormBaseNew form

quit(*args, **kwargs)

Overridden to switch back to MAIN form

toggle_view(*args, **kwargs)

vent.menus.inventory_forms module

class vent.menus.inventory_forms.BaseInventoryForm(action_dict=None, action_name=None, *args, **keywords)

Bases: vent.menus.inventory.InventoryForm

Base form to inherit from

class vent.menus.inventory_forms.InventoryCoreToolsForm(*args, **keywords)

Bases: vent.menus.inventory_forms.BaseInventoryForm

Inventory Core Tools form for the Vent CLI

class vent.menus.inventory_forms.InventoryToolsForm(*args, **keywords)

Bases: vent.menus.inventory_forms.BaseInventoryForm

Inventory Tools form for the Vent CLI

vent.menus.logs module

class vent.menus.logs.LogsForm(name=None, parentApp=None, framed=None, help=None, color='FORMDEFAULT', widget_list=None, cycle_widgets=False, *args, **keywords)

Bases: npyscreen.fmForm.FormBaseNew

Logs form for the Vent CLI

create()

Override method for creating FormBaseNew form

quit(*args, **kwargs)

Overridden to switch back to MAIN form

vent.menus.main module

class vent.menus.main.MainForm(*args, **keywords)

Bases: npyscreen.fmFormWithMenus.FormBaseNewWithMenus

Main information landing form for the Vent CLI

add_form(form, form_name, form_args)

Add new form and switch to it

static core_tools(action)

Perform actions for core tools

create()

Override method for creating FormBaseNewWithMenu form

static exit(*args, **kwargs)

help_form(*args, **keywords)

Toggles to help

perform_action(action)

Perform actions in the api from the CLI

remove_forms(form_names)

Remove all forms supplied

switch_tutorial(action)

Tutorial forms

system_commands(action)

Perform system commands

static t_status(core)

Get status of tools for either plugins or core

while_waiting()

Update fields periodically if nothing is happening

vent.menus.ntap module

class vent.menus.ntap.ActionNTap(n_action=None, *args, **kwargs)

Bases: npyscreen.fmActionForm.ActionForm

Base class to inherit from.

create()

Programmers should over-ride this in derived classes, creating widgets here

on_cancel()

When user cancels, return to MAIN

on_ok()

quit(*args, **kwargs)

Overriden to switch back to MAIN form

class vent.menus.ntap.CreateNTap(name=None, parentApp=None, framed=None, help=None, color='FORMDEFAULT', widget_list=None, cycle_widgets=False, *args, **keywords)

Bases: npyscreen.fmActionForm.ActionForm

For creating a new network tap container

create()

Programmers should over-ride this in derived classes, creating widgets here

on_cancel()

When user cancels, return to MAIN

on_ok()

quit(*args, **kwargs)

Overriden to switch back to MAIN form

class vent.menus.ntap.DeleteNTap(*args, **kwargs)

Bases: vent.menus.ntap.ActionNTap

Delete inheritance

class vent.menus.ntap.ListNTap(name=None, parentApp=None, framed=None, help=None, color='FORMDEFAULT', widget_list=None, cycle_widgets=False, *args, **keywords)

Bases: npyscreen.fmActionForm.ActionForm

For listing all network tap capture containers

create()

Programmers should over-ride this in derived classes, creating widgets here

on_cancel()

When user cancels, return to MAIN

on_ok()

quit(*args, **kwargs)

Overriden to switch back to MAIN form

class vent.menus.ntap.NICsNTap(name=None, parentApp=None, framed=None, help=None, color='FORMDEFAULT', widget_list=None, cycle_widgets=False, *args, **keywords)

Bases: npyscreen.fmActionForm.ActionForm

For listing all available network interfaces

create()

Programmers should over-ride this in derived classes, creating widgets here

on_cancel()

When user cancels, return to MAIN

on_ok()

quit(*args, **kwargs)

Overriden to switch back to MAIN form

class vent.menus.ntap.StartNTap(*args, **kwargs)

Bases: vent.menus.ntap.ActionNTap

Delete inheritance

class vent.menus.ntap.StopNTap(*args, **kwargs)

Bases: vent.menus.ntap.ActionNTap

Delete inheritance

vent.menus.services module

class vent.menus.services.ServicesForm(*args, **keywords)

Bases: npyscreen.fmForm.FormBaseNew

Services form for the Vent CLI

create()

Override method for creating FormBaseNew form

quit(*args, **kwargs)

Overridden to switch back to MAIN form

vent.menus.tools module

class vent.menus.tools.ToolForm(*args, **keywords)

Bases: npyscreen.fmActionForm.ActionForm

Tools form for the Vent CLI

create(group_view=False)

Update with current tools

on_cancel()

When user clicks cancel, will return to MAIN

on_ok()

Take the tool selections and perform the provided action on them

quit(*args, **kwargs)

Overridden to switch back to MAIN form

toggle_view(*args, **kwargs)

Toggles the view between different groups

vent.menus.tutorial_forms module

class vent.menus.tutorial_forms.TutorialAddingFilesForm(*args, **keywords)

Bases: vent.menus.tutorials.TutorialForm

Tutorial Adding Files form for the Vent CLI

class vent.menus.tutorial_forms.TutorialAddingPluginsForm(*args, **keywords)

Bases: vent.menus.tutorials.TutorialForm

Tutorial Adding Plugins form for the Vent CLI

class vent.menus.tutorial_forms.TutorialBackgroundForm(*args, **keywords)

Bases: vent.menus.tutorials.TutorialForm

Tutorial Background form for the Vent CLI

class vent.menus.tutorial_forms.TutorialBuildingCoresForm(*args, **keywords)

Bases: vent.menus.tutorials.TutorialForm

Tutorial Building Cores form for the Vent CLI

class vent.menus.tutorial_forms.TutorialGettingSetupForm(*args, **keywords)

Bases: vent.menus.tutorials.TutorialForm

Tutorial Getting Setup form for the Vent CLI

class vent.menus.tutorial_forms.TutorialIntroForm(*args, **keywords)

Bases: vent.menus.tutorials.TutorialForm

Tutorial introduction landing form for the Vent CLI

class vent.menus.tutorial_forms.TutorialStartingCoresForm(*args, **keywords)

Bases: vent.menus.tutorials.TutorialForm

Tutorial Starting Cores form for the Vent CLI

class vent.menus.tutorial_forms.TutorialTerminologyForm(*args, **keywords)

Bases: vent.menus.tutorials.TutorialForm

Tutorial terminology form for the Vent CLI

class vent.menus.tutorial_forms.TutorialTroubleshootingForm(*args, **keywords)

Bases: vent.menus.tutorials.TutorialForm

Tutorial troubleshooting form for the Vent CLI

vent.menus.tutorials module

class vent.menus.tutorials.TutorialForm(title='', text='', next_tutorial='', *args, **keywords)

Bases: npyscreen.fmFormWithMenus.ActionFormWithMenus

Tutorial form for the Vent CLI

create()

Overridden to add handlers and content

on_cancel()

When user clicks cancel, will return to MAIN

on_ok()

When user clicks ok, will proceed to next tutorial

quit(*args, **kwargs)

Overridden to switch back to MAIN form

switch(name)

Wrapper that switches to provided form

Module contents