# plbmng package

## Subpackages

- plbmng.lib package
  - Submodules
  - plbmng.lib.database module
  - plbmng.lib.full_map module
  - plbmng.lib.icmp_map module
  - plbmng.lib.lib module
  - plbmng.lib.map_one module
  - plbmng.lib.planetlab_list_creator module
  - plbmng.lib.port_scanner module
  - plbmng.lib.ssh_map module
  - Module contents

## Submodules

## plbmng.engine module

class `plbmng.engine.``Engine`

  Bases: `object`

  Class used for the interaction with the user and decision making based on user’s input.

  `VERSION` = '0.4.2'
  `about_gui`(version)

    About menu.

    Parameters

      version (str) – Current version of plbmng.

  `access_servers_gui`(checklist=False)

    Access servers menu.

    Parameters

      checklist (bool) – True if menu shows filtered option as checkboxes.

    Returns

      If checklist is True, return all chosen servers by user.

    Return type

      list

  `add_external_server_menu`()

    Add external server into the plbmng database(NOT TO THE PLANETLAB NETWORK!).

  `advanced_filtering_menu`(checklist: bool)

    Advanced filtering menu.

    Parameters

      checklist (bool) – If checklist is True, return all chosen servers by user.

  `copy_file`()

    Copy files to servers menu.

  `extras_menu`()

    Extras menu

  `filtering_options_gui`() → int

    Filtering options menu.

    Returns

      Code based on PING AND SSH values.

    Return type

      int

  `first_run_message`() → None

    First run menu.

  `get_conf_path`() → str

    Return path to the plbmng config file.

    Return type

      str

  `init_interface`() → None

    Main function of Engine class. Will show root page of plbmng.

  `last_server_menu`() → None

    Return last accessed server menu.

  `monitor_servers_gui`()

    Monitor servers menu.

  `need_to_fill_passwd_first_info`()

    Need to fill in password first menu.

  `path` = ''
  `plot_servers_on_map_gui`()

    Plot servers on map menu.

  `print_server_info`(info_about_node_dic: dict)

    Print server info menu.

    Parameters

      info_about_node_dic (dict) – Dictionary which contains all the info about node.

  `search_by_location_menu`(nodes, checklist: bool)

    Search by location menu.

    Parameters

      checklist (bool) – If checklist is True, return all chosen servers by user.

  `search_by_regex_menu`(nodes: list, option: int, checklist: bool)

    Search by regex menu.

    Parameters

      - nodes (list) – List of all available nodes.

      - option (int) – Index in the nodes list(check constants at the start of this file).

      - checklist (bool) – If checklist is True, return all chosen servers by user.

  `search_nodes_gui`(prepared_choices, checklist=False)

    Search nodes menu.

    Parameters

      - prepared_choices (list) – list of prepared choices for user.

      - checklist (bool) – If checklist is True, crate checklist instead of menu(multiple choices).

    Returns

      Selected tag(s) from :param prepared choices.

  `set_credentials_gui`() → None

    Credentials Menu.

  `stats_gui`(stats_dic: dict) → None

    Stats menu.

    Parameters

      stats_dic (dict) – Dictionary which contains number of servers in database, number of servers which responded to the ping or ssh check.

  `user_nodes` = '/database/user_servers.node'

## Module contents