8.1.4. cobbler.modules package

8.1.4.1. Subpackages

• 8.1.4.1.1. cobbler.modules.authentication package
  • 8.1.4.1.1.1. Submodules
  • 8.1.4.1.1.2. cobbler.modules.authentication.configfile module
    • authenticate()
    • hashfun()
    • register()
  • 8.1.4.1.1.3. cobbler.modules.authentication.denyall module
    • authenticate()
    • register()
  • 8.1.4.1.1.4. cobbler.modules.authentication.ldap module
    • authenticate()
    • register()
  • 8.1.4.1.1.5. cobbler.modules.authentication.pam module
    • PamConv
      • PamConv.appdata_ptr
      • PamConv.conv
    • PamHandle
      • PamHandle.handle
    • PamMessage
      • PamMessage.msg
      • PamMessage.msg_style
    • PamResponse
      • PamResponse.resp
      • PamResponse.resp_retcode
    • authenticate()
    • register()
  • 8.1.4.1.1.6. cobbler.modules.authentication.passthru module
    • authenticate()
    • register()
  • 8.1.4.1.1.7. cobbler.modules.authentication.spacewalk module
    • authenticate()
    • register()
  • 8.1.4.1.1.8. Module contents
• 8.1.4.1.2. cobbler.modules.authorization package
  • 8.1.4.1.2.1. Submodules
  • 8.1.4.1.2.2. cobbler.modules.authorization.allowall module
    • authorize()
    • register()
  • 8.1.4.1.2.3. cobbler.modules.authorization.configfile module
    • authorize()
    • register()
  • 8.1.4.1.2.4. cobbler.modules.authorization.ownership module
    • authorize()
    • register()
  • 8.1.4.1.2.5. Module contents
• 8.1.4.1.3. cobbler.modules.installation package
  • 8.1.4.1.3.1. Submodules
  • 8.1.4.1.3.2. cobbler.modules.installation.post_log module
    • register()
    • run()
  • 8.1.4.1.3.3. cobbler.modules.installation.post_power module
    • RebootSystemThread
      • RebootSystemThread.run()
    • register()
    • run()
  • 8.1.4.1.3.4. cobbler.modules.installation.post_puppet module
    • register()
    • run()
  • 8.1.4.1.3.5. cobbler.modules.installation.post_report module
    • register()
    • run()
  • 8.1.4.1.3.6. cobbler.modules.installation.pre_clear_anamon_logs module
    • register()
    • run()
  • 8.1.4.1.3.7. cobbler.modules.installation.pre_log module
    • register()
    • run()
  • 8.1.4.1.3.8. cobbler.modules.installation.pre_puppet module
    • register()
    • run()
  • 8.1.4.1.3.9. Module contents
• 8.1.4.1.4. cobbler.modules.managers package
  • 8.1.4.1.4.1. Submodules
  • 8.1.4.1.4.2. cobbler.modules.managers.bind module
    • MetadataZoneHelper
    • get_manager()
    • register()
  • 8.1.4.1.4.3. cobbler.modules.managers.dnsmasq module
    • get_manager()
    • register()
  • 8.1.4.1.4.4. cobbler.modules.managers.genders module
    • register()
    • run()
    • write_genders_file()
  • 8.1.4.1.4.5. cobbler.modules.managers.import_signatures module
    • get_import_manager()
    • import_walker()
    • register()
  • 8.1.4.1.4.6. cobbler.modules.managers.in_tftpd module
    • get_manager()
    • register()
  • 8.1.4.1.4.7. cobbler.modules.managers.isc module
    • get_manager()
    • register()
  • 8.1.4.1.4.8. cobbler.modules.managers.ndjbdns module
    • get_manager()
    • register()
  • 8.1.4.1.4.9. Module contents
    • DhcpManagerModule
      • DhcpManagerModule.sync_dhcp()
    • DnsManagerModule
      • DnsManagerModule.regen_hosts()
    • ManagerModule
      • ManagerModule.regen_ethers()
      • ManagerModule.restart_service()
      • ManagerModule.sync()
      • ManagerModule.what()
      • ManagerModule.write_configs()
    • TftpManagerModule
      • TftpManagerModule.add_single_distro()
      • TftpManagerModule.sync_single_system()
      • TftpManagerModule.sync_systems()
      • TftpManagerModule.write_boot_files()
• 8.1.4.1.5. cobbler.modules.serializers package
  • 8.1.4.1.5.1. Submodules
  • 8.1.4.1.5.2. cobbler.modules.serializers.file module
    • FileSerializer
      • FileSerializer.deserialize()
      • FileSerializer.deserialize_item()
      • FileSerializer.deserialize_raw()
      • FileSerializer.serialize()
      • FileSerializer.serialize_delete()
      • FileSerializer.serialize_item()
    • register()
    • storage_factory()
    • what()
  • 8.1.4.1.5.3. cobbler.modules.serializers.mongodb module
    • MongoDBSerializer
      • MongoDBSerializer.deserialize()
      • MongoDBSerializer.deserialize_item()
      • MongoDBSerializer.deserialize_raw()
      • MongoDBSerializer.serialize()
      • MongoDBSerializer.serialize_delete()
      • MongoDBSerializer.serialize_item()
    • register()
    • storage_factory()
    • what()
  • 8.1.4.1.5.4. Module contents
    • StorageBase
      • StorageBase.deserialize()
      • StorageBase.deserialize_item()
      • StorageBase.deserialize_raw()
      • StorageBase.serialize()
      • StorageBase.serialize_delete()
      • StorageBase.serialize_item()
    • register()
    • storage_factory()
    • what()

8.1.4.2. Submodules

8.1.4.3. cobbler.modules.nsupdate_add_system_post module

Replace (or remove) records in DNS zone for systems created (or removed) by Cobbler

cobbler.modules.nsupdate_add_system_post.nslog(msg: str) → None

Log a message to the logger.

Parameters

msg – The message to log.

cobbler.modules.nsupdate_add_system_post.register() → str

This method is the obligatory Cobbler registration hook.

Returns

The trigger name or an empty string.

cobbler.modules.nsupdate_add_system_post.run(api: CobblerAPI, args: List[Any])

This method executes the trigger, meaning in this case that it updates the dns configuration.

Parameters

• api – The api to read metadata from.

• args – Metadata to log.

Returns

“0” on success or a skipped task. If the task failed or problems occurred then an exception is raised.

8.1.4.4. cobbler.modules.nsupdate_delete_system_pre module

Replace (or remove) records in DNS zone for systems created (or removed) by Cobbler

cobbler.modules.nsupdate_delete_system_pre.nslog(msg: str) → None

Log a message to the logger.

Parameters

msg – The message to log.

cobbler.modules.nsupdate_delete_system_pre.register() → str

This method is the obligatory Cobbler registration hook.

Returns

The trigger name or an empty string.

cobbler.modules.nsupdate_delete_system_pre.run(api: CobblerAPI, args: List[Any])

This method executes the trigger, meaning in this case that it updates the dns configuration.

Parameters

• api – The api to read metadata from.

• args – Metadata to log.

Returns

“0” on success or a skipped task. If the task failed or problems occurred then an exception is raised.

8.1.4.5. cobbler.modules.scm_track module

Cobbler Trigger Module that puts the content of the Cobbler data directory under version control. Depending on scm_track_mode in the settings, this can either be git or Mercurial.

cobbler.modules.scm_track.register() → str

This pure python trigger acts as if it were a legacy shell-trigger, but is much faster. The return of this method indicates the trigger type :return: Always: /var/lib/cobbler/triggers/change/*

cobbler.modules.scm_track.run(api: CobblerAPI, args: Any)

Runs the trigger, meaning in this case track any changed which happen to a config or data file.

Parameters

• api – The api instance of the Cobbler server. Used to look up if scm_track_enabled is true.

• args – The parameter is currently unused for this trigger.

Returns

0 on success, otherwise an exception is risen.

8.1.4.6. cobbler.modules.sync_post_restart_services module

Restarts the DHCP and/or DNS after a Cobbler sync to apply changes to the configuration files.

cobbler.modules.sync_post_restart_services.register() → str

This pure python trigger acts as if it were a legacy shell-trigger, but is much faster. The return of this method indicates the trigger type

Returns

Always /var/lib/cobbler/triggers/sync/post/*

cobbler.modules.sync_post_restart_services.run(api: CobblerAPI, args: List[str]) → int

Run the trigger via this method, meaning in this case that depending on the settings dns and/or dhcp services are restarted.

Parameters

• api – The api to resolve settings.

• args – This parameter is not used currently.

Returns

The return code of the service restarts.

8.1.4.7. cobbler.modules.sync_post_wingen module

TODO

cobbler.modules.sync_post_wingen.bcdedit(orig_bcd: str, new_bcd: str, wim: str, sdi: str, startoptions: Optional[str] = None)

TODO

Parameters

• orig_bcd – TODO

• new_bcd – TODO

• wim – TODO

• sdi – TODO

• startoptions – TODO

Returns

TODO

cobbler.modules.sync_post_wingen.register() → Optional[str]

This pure python trigger acts as if it were a legacy shell-trigger, but is much faster. The return of this method indicates the trigger type :return: Always /var/lib/cobbler/triggers/sync/post/*

cobbler.modules.sync_post_wingen.run(api: CobblerAPI, args: Any)

TODO

Parameters

• api – TODO

• args – TODO

Returns

TODO

8.1.4.8. Module contents

This part of Cobbler may be utilized by any plugins which are extending Cobbler and core code which can be exchanged through the modules.conf file.

A Cobbler module is loaded if it has a method called register(). The method must return a str which represents the module category.