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
- 8.1.4.1.1.3. cobbler.modules.authentication.denyall module
- 8.1.4.1.1.4. cobbler.modules.authentication.ldap module
- 8.1.4.1.1.5. cobbler.modules.authentication.pam module
- 8.1.4.1.1.6. cobbler.modules.authentication.passthru module
- 8.1.4.1.1.7. cobbler.modules.authentication.spacewalk module
- 8.1.4.1.1.8. Module contents
- 8.1.4.1.2. cobbler.modules.authorization package
- 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
- 8.1.4.1.3.3. cobbler.modules.installation.post_power module
- 8.1.4.1.3.4. cobbler.modules.installation.post_puppet module
- 8.1.4.1.3.5. cobbler.modules.installation.post_report module
- 8.1.4.1.3.6. cobbler.modules.installation.pre_clear_anamon_logs module
- 8.1.4.1.3.7. cobbler.modules.installation.pre_log module
- 8.1.4.1.3.8. cobbler.modules.installation.pre_puppet module
- 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
- 8.1.4.1.4.3. cobbler.modules.managers.dnsmasq module
- 8.1.4.1.4.4. cobbler.modules.managers.genders module
- 8.1.4.1.4.5. cobbler.modules.managers.import_signatures module
- 8.1.4.1.4.6. cobbler.modules.managers.in_tftpd module
- 8.1.4.1.4.7. cobbler.modules.managers.isc module
- 8.1.4.1.4.8. cobbler.modules.managers.ndjbdns module
- 8.1.4.1.4.9. Module contents
- 8.1.4.1.5. cobbler.modules.serializers package
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 [source]
Log a message to the logger.
- Parameters
msg – The message to log.
- cobbler.modules.nsupdate_add_system_post.register() str [source]
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])[source]
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 [source]
Log a message to the logger.
- Parameters
msg – The message to log.
- cobbler.modules.nsupdate_delete_system_pre.register() str [source]
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])[source]
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 [source]
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)[source]
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 [source]
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 [source]
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)[source]
TODO
- Parameters
orig_bcd – TODO
new_bcd – TODO
wim – TODO
sdi – TODO
startoptions – TODO
- Returns
TODO
- cobbler.modules.sync_post_wingen.register() Optional[str] [source]
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)[source]
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.