univention.management.console.modules.computerroom package

univention.management.console.modules.computerroom.compare_dn(a, b)

univention.management.console.modules.computerroom.check_room_access(func)

Block access to session from other users

univention.management.console.modules.computerroom.reset_room_settings(room, hosts)

class univention.management.console.modules.computerroom.IPAddressSanitizer(**kwargs)

Bases: Sanitizer

class univention.management.console.modules.computerroom.PeriodSanitizer(regex_pattern: Pattern[str] | str | None = None, re_flags: int = 0, minimum: int | None = None, maximum: int | None = None, **kwargs: Any)

Bases: StringSanitizer

class univention.management.console.modules.computerroom.ComputerSanitizer(regex_pattern: Pattern[str] | str | None = None, re_flags: int = 0, minimum: int | None = None, maximum: int | None = None, **kwargs: Any)

Bases: StringSanitizer

instance = None

class univention.management.console.modules.computerroom.ComputerRoomDNSanitizer(*args, **kwargs)

Bases: DNSanitizer

class univention.management.console.modules.computerroom.Plugin(computerroom, manager)

Bases: object

gettext_domain = 'ucs-school-umc-computerroom'

property name

button()

class univention.management.console.modules.computerroom.Instance(*args, **kwargs)

Bases: SchoolBaseModule

ATJOB_KEY = 'UMC-computerroom'

prepare(request)

this function is invoked after the module process started.

init()

this function is invoked after the module process started.

destroy()

Remove lock file when UMC module exists

lessons(request)

Returns a list of school lessons. Lessons in the past are filtered out

internetrules(request)

Returns a list of available internet rules

room_acquire(request)

Acquires the specified computerroom

rooms(request)

Returns a list of all available rooms

guess_room(request)

query(request, ldap_user_read=None)

Searches for entries. This is not allowed if the room could not be acquired.

update(request, ldap_user_read=None)

Returns an update for the computers in the selected room. Just attributes that have changed since the last call will be included in the result

lock(request, *args, **kwargs)

screenshot(request, *args, **kwargs)

settings_get(request, *args, **kwargs)

Return the current settings for a room

finish_exam(request, *args, **kwargs)

start_exam(request)

Start an exam in the current room

settings_set(request)

reload_cups()

reset_smb_connections()

demo_start(request)

demo_stop(request, *args, **kwargs)

computer_state(request)

user_logout(request, *args, **kwargs)

plugins_load(request, *args, **kwargs)

plugins_execute(request, *args, **kwargs)

Subpackages

• univention.management.console.modules.computerroom.plugins package

Submodules

univention.management.console.modules.computerroom.room_management module

exception univention.management.console.modules.computerroom.room_management.ComputerRoomError

Bases: Exception

class univention.management.console.modules.computerroom.room_management.UserInfo(ldap_dn: str, username: str, isTeacher: bool | None = False, hide_screenshot: bool | None = False)

Bases: object

class univention.management.console.modules.computerroom.room_management.UserMap(user_regex: str)

Bases: dict

validate_userstr(userstr: str) → str

class univention.management.console.modules.computerroom.room_management.LockableAttribute(initial_value: LV | None = None, locking: bool | None = True)

Bases: object

lock() → None

unlock()

property current: LV

property old: LV

property isInitialized: bool

property hasChanged: bool

reset(inital_value: LV | None = None) → None

set(value: LV, force: bool | None = False) → None

class univention.management.console.modules.computerroom.room_management.ComputerRoomManager

Bases: dict

SCHOOL = None

ROOM = None

ROOM_DN = None

VEYON_BACKEND = True

static get_screenshot_dimension()

property room

property roomDN

property school

property users

Return a list of valid domain users who are logged into the computers

property veyon_backend: bool

property veyon_client: VeyonClient

ipAddresses(students_only=True)

property isDemoActive

property demoServer

property demoClients

startDemo(demo_server, fullscreen=True)

stopDemo()

class univention.management.console.modules.computerroom.room_management.VeyonComputer

Bases: Thread

This constructor should always be called with keyword arguments. Arguments are:

group should be None; reserved for future extension when a ThreadGroup class is implemented.

target is the callable object to be invoked by the run() method. Defaults to None, meaning nothing is called.

name is the thread name. By default, a unique name is constructed of the form “Thread-N” where N is a small decimal number.

args is a list or tuple of arguments for the target invocation. Defaults to ().

kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {}.

If a subclass overrides the constructor, it must make sure to invoke the base class constructor (Thread.__init__()) before doing anything else to the thread.

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

update_paused()

property update_interval

property name: str | None

A string used for identification purposes only.

It has no semantics. Multiple threads may be given the same name. The initial name is set by the constructor.

property user

property state

property teacher

property isTeacher

property description: str | None

property configuration_ok

property ipAddress

property macAddress

property objectType

property hasChanged

screenshot(size=None)

property hide_screenshot

property flagsDict

property dict

property screenLock

property inputLock

property demoServer

property demoClient

update()

stop()

reset_state()

open()

close()

lockScreen(lock: bool) → None

lockInput(lock: bool) → None

startDemoServer(token: str) → None

stopDemoServer()

startDemoClient(server, token, full_screen=False)

stopDemoClient()

powerOff()

powerOn()

restart()

logOut()

univention.management.console.modules.computerroom.wakeonlan module

univention.management.console.modules.computerroom.wakeonlan.get_local_ip_addresses(blacklisted_interfaces: Iterable[str] | None = None, blacklisted_interface_prefixes: Iterable[str] | None = None) → Set[str]

Returns a list of local IPv4 addresses.

Parameters:

• blacklisted_interfaces (None or Iterable[str]) – iterable that returns a list of interface names that shall be ignored

• blacklisted_interface_prefixes (None or Iterable[str]) – iterable that returns a list of interface prefixes that shall be ignored

Returns:

list of IPv4 addresses

Return type:

Set[str]

univention.management.console.modules.computerroom.wakeonlan.send_wol_packet(mac_address: str, blacklisted_interfaces: Iterable[str] | None = None, blacklisted_interface_prefixes: Iterable[str] | None = None, target_broadcast_ips: Iterable[str] | None = ['255.255.255.255']) → None

Sends a WakeOnLan packet to the specified MAC address via all interfaces (that are not blacklisted).

>>> send_wol_packet(
...   '12:34:56:78:9A:BC',
...   blacklisted_interfaces=['lo'],
...   blacklisted_interface_prefixes=['tun', 'docker'])
>>>

Parameters:

• mac_address (str) – MAC address of the target host

• blacklisted_interfaces (None or Iterable[str]) – iterable that returns a list of interface names that shall be ignored

• blacklisted_interface_prefixes (None or Iterable[str]) – iterable that returns a list of interface prefixes that shall be ignored

• target_broadcast_ips (None or Iterable[str]) – iterable that returns a list of target nets which are used for broadcasting