Uyuni 2024.

03
Reference Guide
April 17 2024
Table of Contents
Reference Guide Overview 1
1. WebUI Reference 2
1.1. Home Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.1. Home Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.2. Notification Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.3. User Account Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.4. My Preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1.5. My Organization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2. Systems Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.2.1. Systems Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.2.2. System Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.2.3. Systems List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.2.4. System Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1.2.5. System Set Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1.2.6. Bootstrapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
1.2.7. Visualization Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1.2.8. Advanced Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1.2.9. Activation Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
1.2.10. Stored Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
1.2.11. Custom System Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
1.2.12. Autoinstallation Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
1.2.13. Virtual Host Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.3. Salt Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.3.1. Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.3.2. Remote Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.3.3. Formula Catalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.4. Images Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.4.1. Image List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1.4.2. Images Build. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1.4.3. Images Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
1.4.4. Images Stores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
1.5. Patches Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
1.5.1. Patch Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
1.5.2. Patch List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
1.5.3. Advanced Search for Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
1.5.4. Manage Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
1.5.5. Clone Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
1.6. Software Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
1.6.1. Channel Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
1.6.2. Channel List Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
1.6.3. Package Search. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
1.6.4. Manage Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.6.5. Distribution Channel Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.7. Content Lifecycle Management Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.7.1. Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.7.2. Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
 1.8. Audit Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.8.1. CVE Audit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.8.2. Subscription Matching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.8.3. OpenSCAP Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
1.9. Configuration Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
1.9.1. Configuration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
1.9.2. Channels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
1.9.3. Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
1.9.4. Systems Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
1.10. Schedule Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.10.1. Pending Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.10.2. Recurring Actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
1.10.3. Completed Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
1.10.4. Archived Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
1.10.5. Action Chains. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
1.10.6. Maintenance Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
1.11. Users Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
1.11.1. User Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
1.11.2. User List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
1.11.3. System Group Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
1.12. Admin Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
1.12.1. Setup Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
1.12.2. Organizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
1.12.3. Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
1.12.4. Manager Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
1.12.5. ISS Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
1.12.6. Task Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
1.12.7. Task Engine Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
1.12.8. Show Tomcat Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
1.13. Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
1.13.1. Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
1.13.2. Release Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
1.13.3. API Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
2. spacecmd Reference 69
2.1. Configuring spacecmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
2.1.1. Setup spacecmd Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
2.1.2. spacecmd Quiet Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
2.1.3. spacecmd Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
2.2. help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
2.3. history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
2.4. Troubleshooting spacecmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
2.4.1. Creating a distribution wiere spacecmd sets localhost instead of FQDN . . . . . . . 74
2.4.2. spacecmd not accepting commands or options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
2.4.3. spacecmd caching problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
2.5. spacecmd Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
2.5.1. activationkey. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
2.5.2. api . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
2.5.3. clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
2.5.4. clear_caches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
 2.5.5. configchannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
2.5.6. cryptokey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
2.5.7. custominfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
2.5.8. distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
2.5.9. errata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
2.5.10. filepreservation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
2.5.11. get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
2.5.12. group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
2.5.13. kickstart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
2.5.14. list_proxies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
2.5.15. login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
2.5.16. logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
2.5.17. org . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
2.5.18. package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
2.5.19. proxy_container_config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
2.5.20. repo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
2.5.21. report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
2.5.22. scap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
2.5.23. schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
2.5.24. snippet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
2.5.25. softwarechannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
2.5.26. ssm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
2.5.27. system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
2.5.28. toggle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
2.5.29. user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
2.5.30. whoami. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
2.5.31. whoamitalkingto. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
2.5.32. Miscellaneous Help Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
3. Command Line Tools 141
3.1. Synchronization CLI Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
3.1.1. Synchronize SCC Repositories With mgr-sync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
3.1.2. Synchronize Repositories with spacewalk-repo-sync. . . . . . . . . . . . . . . . . . . . . . . . . . . 143
3.1.3. Troubleshooting Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
3.2. Bootstrapping Command Line Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
3.3. Database CLI Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
4. GNU Free Documentation License 147
Reference Guide Overview
Updated: 2024-04-17

This document contains several sections:

• The Web UI Reference is organized to match the Uyuni Web UI. As you work with the
Web UI, you can consult the Web UI Reference to find out more about the section you are
working on. For help on setting up and using the Web UI, see Installation-and-upgrade › Webui-
setup.
• The spacecmd Reference is intended to help you work with the spacecmd command line
interface. It contains a complete list of spacecmd commands, organized alphabetically, and their
correct usage.
• The Command Line Tools section provides an overview of the various command line tools
available in Uyuni.

1 / 152 | Uyuni 2024.03

 1.1. Home Menu

Chapter 1. WebUI Reference

1.1. Home Menu
The Home section is a dashboard that contains a summary of your current Uyuni status, including tasks,
client information, and critical security updates.

For more information about setting up and using the Uyuni Web UI, see Installation-and-upgrade ›
Webui-setup.

1.1.1. Home Overview

The Home › Overview section is a dashboard that contains a summary of your current Uyuni status,
including tasks, client information, and critical security updates.

For more information about setting up and using the Uyuni Web UI, see Installation-and-upgrade ›
Webui-setup.

1.1.2. Notification Messages

The Home › Notification Messages section shows all current messages produced by Uyuni. By default,
messages will remain current for thirty days. After this period, messages are deleted whether or not they
are marked as read.

To see unread messages, navigate to the Unread Messages tab. To see all messages, navigate to the
All Messages tab.

Click [Refresh] to update the list.

Perform bulk actions by checking messages in the list. Click [Delete selected messages] to
bulk delete messages. Click [Mark selected as read] to bulk read messages.

Table 1. Notification Message Severity Statuses

Icon Description Example

 Information Client onboarding has failed.

 Warning Channel synchronization has

completed.

 Error Channel synchronization has

failed.

1.1.3. User Account Menu

The Home › User Account section allows you to change user account preferences.

2 / 152 1.1. Home Menu | Uyuni 2024.03

 1.1. Home Menu

[Link]. My Account

The Home › User Account › My Account section allows you to change user account preferences.

Modify your personal information, such as name, password, and title from the Home › User Account ›
My Account page. To modify this information, make the changes in the appropriate text fields and click
the [Update] button at the bottom.

If you forget your password or username, navigate to Web UI sign in page, click [About] , and click
[Lookup Login/Password]. Enter the username or email address, and click [Send
Password] or [Send Login] to have the missing information sent to you.

[Link]. Addresses

The Home › User Account › Addresses section allows you set your mailing, billing, and shipping
addresses, and associated phone numbers.

Click [Fill in this address] or [Edit this address] below the address to be
modified or added, make your changes, and click [Update] .

[Link]. Change Email

The Home › User Account › Change Email section allows you to set the email Uyuni sends
notifications to.

Enter your new email address and click the [Update] button. Invalid email addresses, including those
ending in @localhost are filtered and rejected.

If you would like to receive email notifications about patch alerts or daily summaries for your systems,
ensure you have checked the Receive email notifications option in Home › My
Preferences section.

[Link]. Account Deactivation

The Home › User Account › Account Deactivation section allows you to cancel your Uyuni user
account.

When you click [Deactivate Account] your user account will be deleted, you will be signed out,
and you will not be able to sign back in.

If you do this by accident, you will need to contact your Uyuni Administrator to reactivate your user
account.

 If you are the only Uyuni Administrator for your organization, you can not
deactivate your account.

3 / 152 1.1. Home Menu | Uyuni 2024.03

 1.1. Home Menu

1.1.4. My Preferences
The Home › My Preferences section allows you to configure Uyuni Web UI options.

Table 2. Home Preferences

Option Description Default

Email Notification Receive email for client and Checked

Taskomatic notifications,
including a daily summary email.

Uyuni List Page Size Maximum number of items that 25 entries

can appear in a list on a single
page.

"Overview" Start Page Select the information panes to All checked

display on the Home › Overview
page.

Time Zone Set your local timezone. System timezone

Interface Language Set the language to use in the Default language

Web UI.

Style Theme Set the style theme to use in the susemanager-light

Web UI.

CSV Files Select whether to use comma or Comma

semi-colon delimiters when
producing downloadable CSV
files.

For information about setting up and using the Uyuni Web UI, see Installation-and-upgrade › Webui-
setup. For information about changing the default preferences, see Administration › Users.

1.1.5. My Organization
The Home › My Organization section allows you to configure your current organization.

For more information about organizations, see Administration › Organizations.

[Link]. Organization Configuration

The Home › My Organization › Configuration section allows you to configure your current
organization.

Table 3. Organization Configuration Options

4 / 152 1.1. Home Menu | Uyuni 2024.03

 1.1. Home Menu

Option Description Default

Enable staging contents For clients in this organization, Unchecked

allow content staging by default.

Enable Errata E-mail For users in this organization, Checked

Notifications send email notifications when
errata (patches) are available.

Enable Upload of Detailed SCAP Allow detailed SCAP content Unchecked

Files files to be uploaded for auditing.

SCAP File Upload Size Limit The maximum SCAP file size (in 2048 MB
MB) that can be uploaded.

Allow Deletion of SCAP Results Allow SCAP results to be deleted Checked

after the audit is complete.

Allow Deletion After The number of days after an 90 days

SCAP audit is complete, that
results can be deleted.

Synchronize patches on Content Controls whether the patch Checked

Lifecycle Management build attributes and affected packages
should be synchronized to cloned
patches when building a content
Project

• For more information about content staging, see Administration › Content-staging.

• For more information about OpenSCAP, see Administration › Openscap.

• For more information about organizations, see Administration › Organizations.

• For more information about Content Lifecycle Management, see Administration › Content-
lifecycle.

[Link]. Organization Trusts

The Home › My Organization › Organization Trusts section shows the trusts that you have established
within your organization. This section also shows the channels that are available to other users through
trusts.

For more information about organization trusts, see Administration › Organizations.

[Link]. Organization Configuration Channels

The Home › My Organization › Configuration Channels section shows the configuration channels
available within your organization. Configuration channels can be created in the Uyuni Web UI by
navigating to Configuration › Channels. Apply configuration channels to your organization using the

5 / 152 1.1. Home Menu | Uyuni 2024.03

 1.2. Systems Menu

Uyuni Web UI.

For more information about organizations, see Administration › Organizations.

1.2. Systems Menu

The Systems section allows you to manage your client systems.

For more information about managing clients, see Client-configuration › Client-config-overview.

1.2.1. Systems Overview

The Systems › Overview section lists all client systems registered to the Uyuni Server. The list contains
information about the clients, including available software updates, and the base channel they are
subscribed to.

Click the name of a client to go to the System Details Overview page. For more information
about the System Details Overview page in the Web UI, see Reference › Systems.

Check a client to add it to the system set manager. For more information about the system set manager,
see Client-configuration › System-set-manager.

Click [Add Systems] to go to Systems › Bootstrapping. For more about bootstrapping new clients,
see Reference › Systems.

For more information about managing clients, see Client-configuration › Client-config-overview.

1.2.2. System Details

The System Details section allows you to manage the details for a chosen client. To get to this
section, click the name of a client anywhere throughout the Web UI to see the relevant System
Details page for the client.

The System Details section is divided into tabs and subtabs. Each tab and subtab has its own
section in this document.

The Systems › Details › Overview subtab is displayed by default. Which tabs are available is dependent
on the system type of the client you have selected.

For more information about managing clients, see Client-configuration › Client-config-overview.

[Link]. Overview

The Systems › Details › Overview section shows a summary of information about the selected client,
including the current system status. This subtab is displayed by default when you click the name of a client
anywhere throughout the Web UI.

6 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

Click [Delete System] to delete the system profile. Deleting a system profile will not destroy or
remove the client, but you will no longer be able to manage it with Uyuni. If you delete a system profile
by mistake, you can re-register the client using bootstrap.

The Systems › Details › Overview subtab is split into sections:

[Link].1. System Status

The section shows the current status of the client. If no action is required for this client, the status is
System is up to date.

If the client has new software ready for installation, the status is Software Updates Available,
along with details of updates. Apply updates by navigating to System Details › Packages.

[Link].2. System Info

This section shows general information about the client.

Table 4. System Info Columns

Column Name Description Conditions

Hostname The hostname used by the client -

with the Uyuni Server.

FQDN The fully qualified domain name Shown only if it differs from the
of the client. host name.

IP address The IPv4 IP address of the client. -

IPv6 address The IPv6 IP address of the client. -

Minion ID The minion ID of the client. Salt clients only.

Virtualization The type of virtualization used by Virtualized clients only.

the client.

UUID The universally unique identifier. -

Kernel The kernel currently in use on the -

client.

Uyuni System ID A unique identifier generated by -

Uyuni when the client is
registered.

Activation key The activation key used to register Remains blank if the client has
the client. not been activated.

Installed products Software products currently -

installed on the client.

7 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

For more information about system locks, see Client-configuration › System-locking.

[Link].3. Subscribed Channels

This section shows the base and child software channels this client is subscribed to.

Click [Alter Channel Subscriptions] to change the channel subscriptions for this client.
Click a channel name to go to the Channel Details tab.

For more information about channels, see Client-configuration › Channels.

[Link].4. System Events

This section shows the most recent system events for this client.

Table 5. System Events Columns

Column Name Description

Checked in The time that the client last successfully checked in

with the Uyuni Server.

Registered The time that the client registered with Uyuni.

Last booted The time that the client was most recently started or
rebooted.

Click [Schedule system reboot] to set a time for the client to reboot. The reboot will occur
when the client next checks in with the Uyuni Server after the scheduled time. For more on task
scheduling, see Administration › Task-schedules.

[Link].5. System Properties

This section shows further information about the client.

Table 6. System Properties Columns

Column Name Description

System types Lists the system type applied to the client. Client
type is Salt

Notifications Lists the current notification options for this client.

Contact method The method used by this client to communicate

with the Uyuni Server.

Auto patch update Indicates if the client is receiving patches

automatically.

8 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

Column Name Description

Maintenance Schedule Specifies which maintenance schedule is assigned

to this client.

System name The system name of the client. By default, this is

the host name, but it can be changed.

Description General information about the client. By default,

this is automatically gathered when the client is
registered, but it can be changed.

Location The physical location of the client.

For more information about contact methods, see Client-configuration › Contact-methods-intro.

Click [Edit These Properties] to go to System Details › Details › Properties subtab.

[Link]. Properties

The Systems › Details › Properties section allows you to edit details about the selected client, including
the system name and details.

Table 7. Edit System Details Settings

Setting Name Description Default Setting

System Name The name of the system to use The hostname of the client.
within the Uyuni Web UI.

Base System Type The type of base system used by Shown for information only, you
the client. cannot edit this.

Add-on System Types Check additional system types to Only available system types for
add features such as build hosts, this client are shown.
or monitoring.

Notifications Check to receive notifications of Checked.

updates or patches, and to include
this client in the daily summary.

Auto Patch Update Check to have available patches Unchecked.

automatically applied.

Description This field can contain any text The operating system, release, and
you want. architecture of the system when it
first registered to Uyuni.

Facility Address The physical location of the Blank

client.

9 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

[Link]. Remote Command

The Systems › Details › Remote Command section allows you to run commands remotely on the
selected client.

Before doing so, you must first configure the system to accept such commands. For more information
about using remote commands, see Administration › Actions.

[Link]. Reactivation

The Systems › Details › Reactivation section allows you to generate reactivation keys for the selected
client. Reactivation keys can be used once only to re-register the client and regain all Uyuni settings.

For more information about reactivation keys, see Client-configuration › Activation-keys.

[Link]. Hardware

The Systems › Details › Hardware section shows detailed hardware information about the selected
client, including architecture, networking, and memory.

Click [Schedule Hardware Refresh] to update this page with the latest hardware information.
To change the primary network interface on the client, select the correct interface in the Primary
Network Interface field in the Networking section. For clients with multiple fully qualified
domain names (FQDNs) configured, change the primary FQDN by selecting it in the Primary FQDN
field in the Networking section. Click [Update Properties] to save your changes.

 Refreshing hardware information happens once a month automatically when the

system-profile-refresh taskomatic job runs.

[Link]. Transfer

The Systems › Details › Transfer section allows you to move clients between organizations. Clients can
only belong to one organization at any time.


You will need to establish trust between organizations when you want to move
clients. For more information, see Administration › Organizations.

To move a client to a different organization, select the name of the organization in the Organization
Name field, and click [Migrate System] .

When you move a client to a different organization, channel assignments, system

 group membership, custom data values, configuration channels, reactivation keys,

and snapshots are deleted from the system configuration. You will need to set
these values again when the move is complete.

10 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

[Link]. Notes

The Systems › Details › Notes section lists notes about the selected client.

Click [Create Note] to create a new note. Give your note a subject, and add any details you require.
Click [Create] to save the note.

Notes are listed in the table with a time stamp of when they were last edited. Click the subject of a note to
edit or delete it.

[Link]. Custom Info

The Systems › Details › Custom Info section lists the custom system information that has been applied
to the selected client.

Click [Create Value] to apply a new custom system key to the client. Click the key label to see
more information, and to edit the value.

For more information about custom system information, see Client-configuration › Custom-info.

[Link]. Proxy

The Systems › Proxy section shows all clients connected to the selected client as a proxy. This is only
available when the selected client is registered to Uyuni as a proxy.

For more information about setting up a proxy, see Installation-and-upgrade › Install-proxy.

[Link]. Software

The Systems › Software section allows you to manage software on the selected client.

[Link]. Patches

The Systems › Software › Patches section displays a list of all patches currently available to the selected
client.

To apply a patch, check it in the list and click [Apply Patches] to schedule the installation. The
Status column in the list shows whether an update has been scheduled. Click the status for more
information about the action.

For more information about patching, see Client-configuration › Patch-management.

[Link]. Packages

The Systems › Software › Packages section allows you to manage packages on the selected client.

Click [Update Package List] to refresh the list of available packages.

11 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

The Systems › Software › Packages tab is split into subtabs:

List/Remove
Lists all packages currently installed on the selected client. Click the name of a package to see more
information. To uninstall packages, check the package in the list and click [Remove Packages] .

Upgrade
Lists packages that have newer versions available. Click the name of a package to see more
information. To upgrade packages, check the package in the list and click [Upgrade Packages] .
Any EULAs will be accepted automatically.

Install
Lists packages that are available for installation on the selected client. Click the name of a package to
see more information. To install packages, check the package in the list and click [Install
Selected Packages] . Any EULAs will be accepted automatically.

Profiles
Compare packages installed on the selected client with a stored profile, or with packages installed on
another client. When the comparison is made, you can choose to modify the selected client to match.
To compare with a stored profile, select the profile and click [Compare] . To compare with another
client, select the client name and click [Compare] .

Non Compliant
Lists packages that are installed on the selected client, but are not available in any of the subscribed
software channels.

For more information about packages, see Client-configuration › Package-management.

[Link]. Software Channels

The Systems › Software › Software Channels section allows you to manage the software channels on
the current client. For more information about software channels, see Client-configuration › Channels.

The Systems › Software › Software Channels subtab is split into sections:

[Link].1. Base Channel

This section shows the base channel the current client is subscribed to, as well as any other available base
channels.

Click the chain icon next to a base channel to see more information about the channel. Change the base
channel subscription by selecting the new base channel, and click [Next] to schedule the change.

The child channels associated with the base channel are populated in the Child Channels section.
Mandatory child channels are pre-selected. Toggle the include recommended switch to also select
recommended child channels.

12 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

By default, cloned vendor channels match the original vendor channel and
automatically select the dependencies. You can disable the automatic selection

 for cloned channels by adding the following option in /etc/rhn/[Link]:

java.cloned_channel_auto_selection = false

In general, channel pre-selection is necessary to avoid problems with missing dependencies for a given
channel but it only works flawlessly for vendor channels. For cloned channels, Uyuni relies on the channel
label to define dependencies and use it in auto selection. This heuristic sometimes lead to either selecting
unnecessary child channels or overlooking some essential ones. Users should exercise caution and pay
attention in such case that correct channels are selected.

For Salt clients, apply the highstate after changing software channels.

[Link].2. Child Channels

This section shows the software product and child channels associated with the currently selected base
channel.

Hover over the information icon next to the channel name to see channel requirements. Click the chain
icon next to a base channel to see more information about the channel.

Child channels are can be either recommended or mandatory. Mandatory child channels must be installed
for the selected client to use the associated base channel. Recommended child channels should be
installed to provide additional packages. All other child channels are optional.

Check the child channels you want to install, and click [Next] to schedule the change.

[Link]. Product Migration

The Systems › Software › Product Migration section allows you to upgrade clients to the latest service
pack of their underlying operating system. Product migration also allows you to migrate openSUSE Leap
to the corresponding SLE SP level. Check the product version you want to upgrade the client to, and click
[Select Channels] .

For more information about service pack upgrades, see Client-configuration › Client-upgrades-
product-migration.

[Link]. Configuration

The Systems › Configuration section allows you to manage the configuration files for the selected client.
Configuration files are distributed with a configuration channel.

For more information about configuration channels, see Client-configuration › Configuration-

management.

13 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

The Systems › Configuration tab is split into subtabs:

[Link].1. Overview

The Systems › Configuration › Overview subtab is split into sections:

Configuration Overview
This section contained the total number of available configuration files, and channel subscriptions.
Click the name of a configuration file or channel to see more information. Click [Subscribe to
channels] to subscribe to additional configuration channels.

Recent Events
This section shows when the configuration channels was most recently deployed on the selected
client. It also shows the most recent time that a comparison was performed.

Configuration Actions
This section allows you to deploy or to compare configuration channels on the selected client.

[Link].2. View Files

The Systems › Configuration › View Files subtab is split into subtabs for centrally managed, and locally
managed configuration files.

The Centrally-Managed Files and Locally-Managed Files subtabs both show a list of
all available configuration files. Click [View] to see details about the configuration file. Click
[Compare] to compare the configuration file to other files, or to various revisions of itself. Click the
configuration channel name to see more information about the channel that contains this configuration
file. Click the revision number to see additional details about the configuration file.

[Link].3. Deploy Files

The Systems › Configuration › Deploy Files shows a list of available configuration files that can be
deployed on the selected client.

[Link].4. Compare Files

The Systems › Configuration › Compare Files shows a list of available configuration files that can be
compared to Uyuni managed configuration files. Check the configuration file to compare and click
[Compare Files] to schedule a comparison. Click the revision number to see additional details
about the configuration file. Click the configuration channel name to see more information about the
channel that contains this configuration file.

[Link].5. Manage Configuration Channels

The Systems › Configuration › Manage Configuration subtab is split into subtabs:

14 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

List/Unsubscribe from Channels

This section shows the list of currently subscribed channels. To unsubscribe the selected client from a
configuration channel, check the channel, and click [Unsubscribe] . Click the configuration
channel name to see more information about the channel that contains this configuration file.

Subscribe to Channels
This section shows the list of configuration channels that are available for the selected client to
subscribe to. To subscribe the selected client to a configuration channel, check the channel, and click
[Continue] .

View/Modify Rankings
This section shows the currently subscribed configuration channels, in ranked order. Where settings
conflicts occur between configuration channels, channels closer to the top of the list take precedence.
To complete subscription to a configuration channel, review the rankings, adjust as necessary using
the up and down arrows, and click [Update Channel Rankings] .

[Link]. Provisioning

The Systems › Provisioning section allows you to manage provisioning for the selected client. This
includes managing and scheduling autoinstallation and booting the selected client.

The Systems › Provisioning tab is split into subtabs:

[Link].1. Autoinstallation

This section displays a list of the available autoinstallation profiles for the selected client. Select a time
and date for autoinstallation to re-install the client.

For more information about autoinstallation, see Client-configuration › Autoinst-intro.

[Link].2. Power Management

This section allows you to power on, power off, and reboot the selected client.

This feature uses either the IPMI or Redfish protocol and is managed using a Cobbler profile. The
selected client must have a power management controller supporting one of these protocols. For Redfish,
ensure you can establish a valid SSL connection between the client and the Uyuni Server.

Complete the details for the power management server, and click the appropriate button for the action to
take. Click [Get status] to determine if the client is currently running. Click [Save only] to
save the details without taking any action.

Click [Remove Cobbler System Profile] to remove the current client’s system profile from
Cobbler. For more information about unattended provisioning with Cobbler, see Client-configuration ›
Autoinst-unattended.

For more information about power management, see Client-configuration › Power-management.

15 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

[Link]. Groups

The Systems › Groups section shows the system groups the selected client is assigned to.

The Systems › Groups subtab is split into sections:

For more information about system groups, see Client-configuration › System-groups.

[Link].1. List/Leave

This section lists all groups that the selected client belongs to.

Click the group name to see more information about the system group. To remove the selected client
from a system group, check the group, and click [Leave Selected Groups] .

[Link].2. Join

This section lists all groups that are available for the selected client to subscribe to.

Click the group name to see more information about the system group. To join a system group, check the
group, and click [Join Selected Groups] .

[Link]. Virtualization

The Systems › Virtualization section allows you to manage the virtual guests registered to the selected
client. This is only available when the selected client is registered as a virtual host.

For more information about virtualization, see Client-configuration › Virtualization.

The Systems › Virtualization tab is split into subtabs:

[Link].1. Guests

This section lists the virtual guests registered to the selected client. This is only available when the
selected client is registered as a virtual host.

The list shows these columns:

Table 8. Virtual Guest List Columns

Column Description

Guest The name of the virtual guest

System The client the virtual guest is registered to

Updates Icon indicates if the guest has outstanding patches

State Indicates if the guest is running, suspended,

stopped, or crashed

16 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

Column Description

Current Memory The amount of RAM allocated to the guest

vCPUs The number of virtual processors allocated to the

guest

Base Software Channel The base software channel the guest is registered to

Action Status Any currently running action

Actions Use these buttons to start, stop, or change the guest

To perform bulk actions on multiple virtual guests, select the guests, and click the appropriate action
button above the table. For Salt clients, click [Create Guest] to configure and create a new virtual
guest.

 Virtual guests must be registered to virtual hosts. Virtual guests cannot be

registered to a virtual guest.

[Link].2. Storage

This section lists the virtual storage pools and volumes defined on the selected client. This is only
available when the selected client is registered as a Salt virtual host.

The list shows these columns:

Table 9. Virtual Storage Pools List Columns

Column Description

Name The name of the virtual storage pool or volume

State Indicates if the pool is running, suspended, stopped,

or crashed

Autostart Checked if the pool starts automatically when the

virtual host is booted

Persistent Checked if the pool persists between virtual host

reboots

Location The absolute path to the pool on the virtual host

Usage The percentage of storage in use. Displays

unknown if the pool is not running.

Actions Use these buttons to start, stop, or change the pool

Click [Create Pool] to configure and create a new virtual storage pool.

17 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

[Link].3. Networks

This section lists the virtual networks defined on the selected client. This is only available when the
selected client is registered as a Salt virtual host.

The list shows these columns:

Table 10. Virtual Networks List Columns

Name The name of the virtual network

State Indicates if the network is running, suspended,

stopped, or crashed

Autostart Checked if the network starts automatically when

the virtual host is booted

Persistent Checked if the network persists between virtual

host reboots

Bridge The name of the associated network bridge

Action Status Shows the status of any pending actions

Actions Use these buttons to stop, edit, or delete the

network

Click [Create Network] to configure and create a new virtual network.

[Link]. Audit

The Systems › Audit section displays the results of OpenSCAP scans that you have performed on the
selected client.

The Security Certification and Authorization Package (SCAP) is a standardized compliance checking
solution for enterprise-level Linux infrastructures. Uyuni uses OpenSCAP to implement the SCAP
specifications.

For more information about OpenSCAP, see Administration › Openscap.

The Systems › Audit subtab is split into sections:

[Link].1. List Scans

This section displays ther results of openSCAP scans that have been performed on the selected client.

The table columns on this page are:

Table 11. OpenSCAP Scan Results

18 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

Name Description

Xccdf Test Result The name of the test result

Diff FIXME

Completed The time that the scan was completed

Compliance The unweighted pass/fail ratio

P The number of checks that passed

F The number of checks that failed

E The number of errors that occurred

U The number of checks with an unknown status

N The number of checks that were not applicable to

the selected client

K The number of checks not run

S The number of checks that were not selected

I The number of checks that have information

available for review

X The number of checks that reported a status of

fixed

Total The total number of checks run

Click the name of a scan test result to see details about the result.

[Link].2. Schedule

This section allows you to schedule a scan for the selected client.

[Link]. States

The Systems › States section allows you to manage Salt states on the selected client. States provide
configuration templates for Salt clients. Applying the highstate applies all outstanding Salt states. This is
only available for Salt clients.

For more information about Salt states, see Specialized-guides › Salt.

The Systems › States subtab is split into sections:

19 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

[Link].1. Highstate

This section provides details of the highstate for the selected client. It includes a state summary for the
selected client, showing a list of states, formulas, and configuration channels. To schedule a time to apply
the highstate, select the date and time and click [Apply Hightstate] . Toggle the [Test mode]
switch to test the highstate before you apply it.

[Link].2. Packages

This section allows you to manage package states for the selected client. Package states determine which
packages and versions should be installed on the selected client.

Use the search tool to search for the package you want to change. To set the package state to install the
package, select Installed as the new state. To always upgrade the package to the latest version, select
latest. Click [Save] to save the changes to the state. Click [Apply changes] to apply the new
package state to the selected client.

Use the Changes subtab to see what changes will occur on the selected client when this state is applied.

[Link].3. Configuration Channels

This section allows you to manage configuration channels for the selected client.

Use the search tool to search for the configuration channel you want to manage. This section shows the
list of configuration channels that are available for the selected client to subscribe to. To subscribe the
selected client to a configuration channel, check the channel, and click [Apply] .

Use the Changes subtab to see what changes will occur on the selected client when this state is applied.

For more information about configuration channels, see Client-configuration › Configuration-

management.

[Link]. Formulas

The Systems › Formulas section allows you to manage Salt formulas on the selected client. This is only
available for Salt clients.

This section lists all currently installed formulas. Check the formulas you want to apply, and click
[Save] . When a formula is applied, it will create a new subtab. Navigate to the subtab to configure the
formula on the selected client. After most formula actions, you will need to apply the highstate to pick up
the changes.

For more information about formulas, see Specialized-guides › Salt.

[Link]. Ansible

The System Details › Ansible tab allows you to use the Ansible features on the Control Node system.

20 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

The tab is split into the following subtabs:

Control Node
Fields for defining playbook directories and paths to inventory files on your Ansible Control Node.

Playbooks
Lists all playbooks in the defined paths. You can click a playbook to display its details or to schedule
its execution.

Inventories
Lists all inventory files in the defined paths. Clicking an inventory file in the list introspects its
contents.

For more information, see Administration › Ansible-integration.

[Link]. Recurring Actions

The Systems › Recurring Actions section allows you to manage recurring actions on the selected client.
You can schedule an arbitrary set of Salt states or the highstate to be executed at desired intervals. This is
only available for Salt clients.

For more information about Salt states, see Specialized-guides › Salt.

Currently, Uyuni supports the following action types as recurring actions:

• Highstate: Execute the highstate.

• Custom state: Execute a set of custom states. A custom state can be either an internal state
provided by Uyuni, or a configuration channel created by a user.

For more information about configuration channels, see Client-configuration › Configuration-

management.

[Link].1. Creating Recurring Actions

To create new schedules, click the [Create] icon on the top right corner. Choose a supported action
type, give your recurring schedule a name, select a time and day for it to recur, and click [Create
Schedule] . Toggle the [Test mode] switch to test the highstate before you apply it.

[Link].2. Recurring Action Details

View the details about an action from the action list. In the Actions column, click the [Details]
icon for the action you are interested in.

[Link].3. Disabling Recurring Actions

Disabling an action stops the action recurring, but does not delete it. To disable a recurring action toggle
the Active switch off. Enable them again by toggling the Active switch on. Disabled recurring actions

21 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

remain in the list, but are not executed.

[Link].4. Editing Recurring Actions

In the Actions column, click the [Edit] icon for the action you want to change. On the Schedule
Recurring Action page, the existing properties are pre-filled. Make your changes, and click
[Update Schedule] .

[Link].5. Deleting Recurring Actions

Deleting an action permanently removes it. To start using the action again, you will need to create a new
action. In the Actions column, click the [Delete] icon for the action you want to delete, and
confirm the deletion.

For more information about recurring actions, see Administration › Actions.

[Link]. Events

The Systems › Events section shows past, current, and scheduled actions for the selected client.

For more information about actions, see Administration › Actions.

The Systems › Event tab is split into subtabs:

[Link].1. Pending

This section shows actions that are scheduled, but have not yet started.

Click the name of an action to see more information. To cancel an action, check the action and click
[Cancel Selected Events] .

[Link].2. History

This section shows actions that have been completed on the selected client.

Click the summary of an action to see more information.

1.2.3. Systems List

The Systems › System List section lists all clients available in your Uyuni environment.

For more information about managing clients, see Client-configuration › Client-config-overview.

The Systems › System List section is split into submenus:

22 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

[Link]. All

The Systems › System List › All section lists every client that you have permission to manage.

[Link]. Physical Systems

The Systems › System List › Physical Systems section lists every client that is installed on physical
hardware.

[Link]. Virtual Systems

The Systems › System List › Virtual Systems section lists every client that is installed on virtual
hardware. The list includes all your virtual hosts, and the virtual guests that are attached to them.

For virtual guests that are registered to the Uyuni Server, click the name of the guest to manage it. Virtual
guests that are not registered are shown, but cannot be managed in the Web UI.

For more information about virtual clients, see Client-configuration › Virtualization.

[Link]. Unprovisioned Systems

The Systems › System List › Unprovisioned Systems section lists every bare metal client that the Uyuni
Server is aware of, but has not yet been registered.

For more information about bare metal clients, see Client-configuration › Autoinst-intro.

[Link]. Out of Date

The Systems › System List › Out of Date section lists every client that has available updates.

For more information about managing client updates, see Client-configuration › Package-management.

[Link]. Requiring Reboot

The Systems › System List › Requiring Reboot section lists every client that requires rebooting.

[Link]. Non Compliant

The Systems › System List › Non Compliant section lists every client that has non-compliant packages
installed. Packages are considered non-compliant if they have been installed from a source other than
Uyuni. In the list, the Packages column shows the number of non-compliant packages on the client.

[Link]. Without System Type

The Systems › System List › Without System Type section lists every client that does not have a base
system type recorded.

23 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

For more information about system types, see Client-configuration › System-types.

[Link]. Ungrouped

The Systems › System List › Ungroups section lists every client that is not assigned to a system group.

For more information about system groups, see Client-configuration › System-groups.

[Link]. Inactive

The Systems › System List › Inactive section lists every client that has not checked in with the the Uyuni
Server in 24 hours or more.

For more information about client connections to the server, see Client-configuration › Contact-
methods-intro.

For more information on troubleshooting inactive clients, see Administration › Troubleshooting.

[Link]. Recently Registered

The Systems › System List › Recently Registered section lists every client that has registered within a
given period. Select the period to view from the View systems registered field.

[Link]. Proxy

The Systems › System List › Proxy section lists every client that is registered as a proxy.

[Link]. Duplicate Systems

The Systems › System List › Duplicate Systems section lists clients that share IP addresses, host names,
or MAC addresses. Use the tabs to compare clients.

[Link]. System Currency

The Systems › System List › System Currency section lists all clients with information about available
updates, and provides a currency score for each. You can use the currency score to determine in which
order clients should be updated. A score with a larger number indicates that a client is not current, and
might require critical updates.

[Link]. System Types

The Systems › System List › System Types section lists every client, their base system type, add-on
system type, and base channel. It also gives a count of clients of each system type.

For more information about system types, see Client-configuration › System-types.

24 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

1.2.4. System Groups

The Systems › System Groups section displays the list of system groups in your organization.

Click the name of a group to work with it, or to add or delete clients in the group.

The list shows an icon if there are updates available for any of the clients in the group. Click the icon to
see more information about the updates available.

Table 12. Update Status Icons

Icon Description Action Required

 No applicable updates All clients in this group are up to

date

 Updates available One or more clients have updates

ready to install

 Security updates needed One or more clients have security

updates that must be installed

 Status unknown Displaying status of available

updates is disabled

For more information about system groups, see Client-configuration › System-groups.

1.2.5. System Set Manager

The Systems › System Set Manager section allows you to manage clients that you have added to the
system set manager.

For more information about the system set manager, see Client-configuration › System-set-manager.

[Link]. System Set Manager Overview

The Systems › System Set Manager › Overview section allows you to manage clients that you have
added to the system set manager (SSM). You can also access this page by clicking the systems
selected icon in the top menu bar.

For more information about SSM, see Client-configuration › System-set-manager.

The Systems › Systems Set Manager menu is split into tabs:

[Link].1. Overview

This section provides quick access to all the of the SSM tabs.

25 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

[Link].2. Systems

This section lists all clients currently in the SSM. It provides information about the updates available,
when thew client last checked in, the registered base channel, and system type. Click the client name to
see more information.

[Link].3. Patches

This section lists all patches available for upgrade on clients currently in the SSM. Click the number in the
Affected column to see which clients a patch applies to. To perform upgrades, check the patches to
apply and click [Apply Patches] .

For more information about patch management, see Client-configuration › Patch-management.

[Link].4. Packages

This section is split into subtabs.

The Packages › Upgrade subtab lists all packages available for upgrade on clients currently in the SSM.
To perform upgrades, check the packages to upgrade and click [Upgrade Selected Packages] .

The Packages › Install subtab allows you to install new packages on all clients currently in the SSM. To
install packages, click the base channel that contains the package, check the packages to install, and click
[Install Selected Packages] .

The Packages › Remove subtab allows you to remove packages from all clients currently in the SSM. If
clients in the SSM have different versions of a package installed, multiple versions are available in the list.
To remove packages, select the packages to remove, and click [Remove Selected Packages] .

For more information about package management, see Client-configuration › Package-management.

[Link].5. Groups

This section lists all system groups clients currently available in your organization. Click [Create
Group] to create a new system group. For each group in the list, check Add to add all clients in the
SSM to the group, check Remove to remove all clients in the SSM from the group, or check No
Change to leave group assignments as they are. Click [Alter Membership] to change group
assignments.

For more information about system groups, see Client-configuration › System-groups.

[Link].6. Channels

This section lists all base channels clients currently subscribed to by clients currently in the SSM. You can
change all clients subscribed to a current base channel to a new base channel, by selecting the new base
channel and following the prompts.

For more information about software channels, see Client-configuration › Channels.

26 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

For more information about using the SSM to change base channels, see Client-configuration › System-
set-manager.

[Link].7. Configuration

This section is split into subtabs.

The Configuration › Deploy Files subtab lists all configuration files available for deployment. Click the
number in the Systems column to see which clients are currently subscribed to the configuration file.
To assign a configuration file to the clients currently in the SSM, check the configuration file, and click
[Schedule File Deploy] .

The Configuration › Compare Files subtab lists all configuration files available for comparison. This
compares the configuration file deployed on a client with the configuration file stored on the Uyuni
Server. Click the number in the Systems column to see which clients are currently subscribed to the
configuration file. To compare configuration files, check the configuration files to compare, and click
[Schedule File Comparison] .

The Configuration › Subscribe to Channels subtab lists all configuration channels available for
subscription. To subscribe the clients in the SSM to a new configuration channel, check the configuration
channel, click [Continue] , and follow the prompts.

The Configuration › Unsubscribe from Channels subtab lists all configuration channels clients in the
SSM are currently subscribed to. To unsubscribe the clients in the SSM from a configuration channel,
check the configuration channel and click [Unsubscribe Systems] .

The Configuration › Enable Configuration subtab lists clients in the SSM that are capable of using
configuration management, but have not yet been enabled. To enable clients in the SSM to use
configuration management, check the client and click [Enable Configuration Management] .

For more information about configuration management, see Client-configuration › Configuration-

management.

[Link].8. Provisioning

This section is split into subtabs.

The Provisioning › Autoinstallation subtab lists all clients in the SSM available for autoinstallation, with
their base channel. To schedule autoinstallation, select an autoinstallable type, click [Continue] and
follow the prompts.

The Provisioning › Power Management Configuration subtab allows you to configure power
management for the clients in the SSM. For more information about power management, see Client-
configuration › Power-management.

The Provisioning › Power Operations subtab allows you to power on, power off, or reboot the clients in
the SSM. For more information about power management, see Client-configuration › Power-

27 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

management.

For more information about autoinstallation, see Client-configuration › Autoinst-intro.

[Link].9. States

For Salt clients, the States › Highstate subtab allows you to apply the highstate to all clients in the SSM.

[Link].10. Audit

For more information about auditing, see Administration › Auditing.

[Link].11. Misc

This section is split into subtabs.

The Misc › Preferences subtab allows you to configure the custom information, system types, and system
preferences for the clients in the SSM.

The Misc › Hardware subtab allows you to schedule a hardware profile refresh for the clients in the
SSM.

The Misc › Software subtab allows you to schedule a package profile refresh for the clients in the SSM.

The Misc › Remote Command subtab allows you to schedule a remote command to be executed on the
clients in the SSM.

The Misc › Custom Values subtab allows you to set or remove custom key values for the clients in the
SSM.

The Misc › Reboot subtab allows you to schedule a reboot for the clients in the SSM.

The Misc › Transfer subtab allows you to move clients in the SSM to a new organization.

The Misc › Delete subtab allows you to delete the system profiles of clients in the SSM.

[Link]. System Set Manager Task Log

The Systems › System Set Manager › Task Log section shows all actions applied to clients that you
have added to the system set manager (SSM). The SSM Task Log lists all actions performed against
clients currently in SSM. Click an entry to see more information about the action.

This section is divided into tabs:

The All tab lists all actions that have been performed. The In Progress tab lists all actions that are
currently in progress. The Completed tab lists all actions that have been completed.

For more information about SSM, see Client-configuration › System-set-manager.

28 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

1.2.6. Bootstrapping
The Systems › Bootstrapping section allows you to register a single Salt client.

Table 13. Bootstrap Options

Option Description Default

Host The hostname of the client to be -

registered

SSH port The port on the client that allows 22

SSH access

User The user name to use to log in to root

the client

Authentication Method Choose Password for simple Password

authentication, or
SSH Private Key to use
SSH authentication.

Password The password to use to log in to -

the client

SSH Private Key Upload the SSH Private Key to -

use to log in to the client

SSH Private Key Passphrase The passphrase for the -

SSH Private Key, or leave blank
for no password.

Activation Key The activation key to use to None

register the client. Leave blank to
use the universal default
activation key, or select None for
no activation key.

Proxy The proxy to which the client None

should be registered. Leave blank
if you are not using a proxy.

Disable SSH strict host key Automatically adds the host key Checked
checking to the known hosts file

Manage system completely via Uses only the SSH contact Unchecked
SSH method

 SSH private keys are stored only for the duration of the bootstrapping process.
They are deleted from the Uyuni Server as soon as bootstrapping is complete.

29 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

When you have completed the details of the client you want to register, click [Bootstrap] . When the
client has completed registering, navigate to Systems › System List to see details.

For more information about bootstrapping, see Client-configuration › Registration-webui.

1.2.7. Visualization Menu

The Systems › Visualization section displays a visual representation of your clients, virtualized clients,
and proxies.

Click an element on any visualization to see more information about the selection. Click [Show
filters] to see additional controls and filters.

The Systems › Visualization section is split into submenus:

[Link]. Virtualization Hierarchy

The Systems › Visualization › Virtualization Hierarchy section displays a graphical representation of

your virtualized clients. It shows the virtual hosts registered to the Uyuni Server, with the clients
registered to each host.

[Link]. Proxy Hierarchy

The Systems › Visualization › Proxy Hierarchy section displays a graphical representation of your
Uyuni Proxies. It shows the proxies registered to the Uyuni Server, with the clients registered to each
proxy.

[Link]. Systems Grouping

The Systems › Visualization › Systems Grouping section displays a graphical representation of all
clients registered to the Uyuni Server.

By default, clients are shown arranged by systems groups. Click [Show filters] to change how they
are arranged.

1.2.8. Advanced Search

The Systems › Advanced Search section allows you to perform global searches within your Uyuni
environment. Searches can include network information, hardware devices, location, activity, packages,
details, DMI information, and hardware.

Type your search term in the Search For field. Select the criterion to search by, use the radio buttons
to specify whether you want to query all systems or only those in the System Set Manager, and
click the [Search] button. Check Invert Result to list only results that do not match the
specified criteria.

When you add a distribution, synchronize channels, or register a client, it can take several minutes for it to

30 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

be indexed and appear in search results. To force a rebuild of the search index, use this command at the
command prompt:

rhn-search cleanindex

1.2.9. Activation Keys

The Systems › Activation Keys section lists the current activation keys for your organization.

The universal default activation key, if set, is automatically used for all clients registered to your
organization, unless you specify a different activation key.

The list of activation keys shows the name and description for each key, and how many times the key has
been used. It also shows if the key is currently enabled for your organization. Click the key description to
see more information about the activation key.

Click [Update Activation Keys] to refresh the list with recent changes.

Click [Create Key] to create a new activation key.

For more information about activation keys, see Client-configuration › Activation-keys.

1.2.10. Stored Profiles

The Systems › Stored Profiles section lists the stored profiles for your organization. Profiles can be used
to compare packages installed on clients.

Click the name of a profile to see more information about the packages in the profile, or to edit the name
or description.

For more information about using profiles to compare packages, see Client-configuration › Package-
management.

1.2.11. Custom System Information

The Systems › Custom System Info section lists the custom system information available to clients in
your organization.

Click [Create Key] to create a new custom system key. Click the key label to see more information,
and to edit the value.

For more information about custom system information, see Client-configuration › Custom-info.

1.2.12. Autoinstallation Menu

The Systems › Autoinstallation section allows you to manage clients for autoinstallation.

31 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.2. Systems Menu

For more information about autoinstallation, see Client-configuration › Autoinst-intro.

[Link]. Autoinstallation Overview

The Systems › Autoinstallation › Overview section displays an overview of your autoinstallation

settings, including clients that are autoinstalling, or scheduled to be autoinstalled.

The Systems › Details › Overview subtab is split into sections:

Autoinstallation Summary
This section lists the AutoYaST and Kickstart profiles currently available, and the number of clients
installed with each profile.

Autoinstallation Actions
This section provides links to actions related to autoinstallation. You can also access these using the
Systems › Autoinstallation menu.

Systems Currently Autoinstalling

This section lists all clients that are currently autoinstalling, along with their status.

Systems Scheduled to be Autoinstalled

This section lists all clients that are scheduled for autoinstallation, along with their status.

Click [Create Kickstart Profile] to create a new Kickstart profile. Click [Upload
Kickstart/AutoYaST File] to upload a new autoinstallation file.

For more information about autoinstallation, see Client-configuration › Autoinst-intro.

[Link]. Autoinstallation Profiles

The Systems › Autoinstallation › Profiles section lists all profiles currently available. The list includes
information about if the profile is active, the distribution it is based on, and if it being managed with
Uyuni.

Click the name of a profile to see more information.

Click [Create Kickstart Profile] to create a new Kickstart profile. Click [Upload
Kickstart/AutoYaST File] to upload a new autoinstallation file.

For more information about autoinstallation profiles, see Client-configuration › Autoinst-profiles.

[Link]. GPG and SSL Keys

The Systems › Autoinstallation › GPG and SSL Keys section lists all GPG public keys and SSL
certificates currently available. Click the name of a key to see more information.

Click [Create Stored Key/Cert] to store a new GPG key or SSL certificate.

32 / 152 1.2. Systems Menu | Uyuni 2024.03

 1.3. Salt Menu

For more information about GPG keys and SSL certificates, see Client-configuration › Gpg-keys.

[Link]. Distributions

The Systems › Autoinstallation › Distributions section lists the available autoinstallable distributions.

Click the distribution name to see more information. Click [Create Distribution] to create a
new autoinstallable distribution.

For more information about autoinstallable distributions, see Client-configuration › Autoinst-

distributions.

[Link]. File Preservation

The Systems › Autoinstallation › File Preservation section allows you to store lists of files, to use them
in Kickstart profiles later on.

Click [Create File Preservation List] to create a new list.

For more information about Kickstart file preservation, see Client-configuration › Autoinst-profiles.

[Link]. Autoinstallation Snippets

The Systems › Autoinstallation › Autoinstallation Snippets section allows you to store code snippets, to
use them in autoinstallation profiles later on.

Click [Create Snippet] to create a new code snippet.

For more information about autoinstallation profiles using these code snippets, see Client-configuration
› Autoinst-profiles.

1.2.13. Virtual Host Managers

The Systems › Virtual Host Managers section lists the active virtual host managers (VHMs).

VHMs can be used to collect private or public cloud instances and organize them into virtualization
groups.

For more information about VHMs, see Client-configuration › Vhm.

1.3. Salt Menu

The Salt section displays details of your Salt clients. You can use this menu to perform remote
commands or define a state catalog for your Salt clients.

For more information about using Salt with Uyuni, see Specialized-guides › Salt.

33 / 152 1.3. Salt Menu | Uyuni 2024.03

 1.4. Images Menu

1.3.1. Keys
The Salt › Keys section displays the key fingerprints of your current Salt clients.

Key fingerprints are exchanged between the Uyuni Server and Salt clients to verify the identity of the
server and the client. This prevents Salt clients from connecting to the wrong server.

Click [Refresh] to update the list. Click the name of a client to go to Systems › Details for that client.

Table 14. Salt Keys List Columns

Column Description

Name Name of the Salt client.

Fingerprint Key fingerprint of the Salt client.

State The status of the key exchange: accepted

indicates that the client key has been verified by the
Uyuni Server.

Actions Click the Delete icon to delete the client key

from the server. Clients that have had their key
deleted will need to be onboarded again.

1.3.2. Remote Commands

The Salt › Remote Commands section allows you to perform remote commands on one or more of your
Salt clients. Remote commands allows you to issue commands to individual Salt clients, or to all clients
that match a search term.

For more information about remote commands, see Administration › Actions.

1.3.3. Formula Catalog

The Salt › Formula Catalog section allows you to see which formulas are currently installed on your
Uyuni Server, and are available to be used on your Salt clients. Install and configure formulas by
navigating to Systems › Details for the client you want to configure, and navigate to the
guimenuFormulas tab.

For more information about Uyuni formulas, see Specialized-guides › Salt.

1.4. Images Menu

The Images › Image List section displays your current operating system images.

For more information about images, see Administration › Image-management.

34 / 152 1.4. Images Menu | Uyuni 2024.03

 1.4. Images Menu

1.4.1. Image List

The Images › Image List section displays your current operating system images.

Click [Import] to import a new Docker image. You can only import new images created from a
Docker image using this mechanism. To import images based on Kiwi instead, see Administration ›
Image-management.

Click [Refresh] to update the list.

Perform bulk actions by checking images in the list. Click [Delete] to bulk delete images.

Table 15. Image List Columns

Column Description

Name Name of the image.

Version and Revision Version and revision of the image.

Updates Any updates that are currently available for the

image.

Patches and Packages Any patches or packages that are currently available
for the image.

Build The current status of the build: Built,

Scheduled, Building or Failed.

Last Modified The time and date the image was last modified.

For more information about images, see Administration › Image-management.

1.4.2. Images Build

The Images › Build section allows you to build operating system images for installing on clients.

Table 16. Image Build Options

Option Description Default

Image Profile Select the image profile to use. Blank.

Manage image profiles at Images
› Profiles.
Build Host Select the build host for the new Blank.
image.

Earliest Schedule the time and date for Current system time and date.
the build to begin.

35 / 152 1.4. Images Menu | Uyuni 2024.03

 1.5. Patches Menu

Option Description Default

Add to Select which action chain to add New action chain.

the build task to.

Built images are listed in Images › Image List.

For more information about images, see Administration › Image-management.

1.4.3. Images Profiles

The Images › Profiles section displays your current image profiles.

Click [Create] to create a new image profile. Click [Refresh] to update the list.

Perform bulk actions by checking profiles in the list. Click [Delete] to bulk delete profiles.

For more information about images, see Administration › Image-management.

1.4.4. Images Stores

The Images › Stores section displays your current image stores.

Click [Create] to create a new image store. Click [Refresh] to update the list.

Perform bulk actions by checking images in the list. Click [Delete] to bulk delete image stores.

For more information about images, see Administration › Image-management.

1.5. Patches Menu

The Patches menu helps you find and manage available patches for your clients.

For more information about patching, see Client-configuration › Patch-management.

1.5.1. Patch Details

The Patches › Patch List › Patch Details section displays the details of a selected patch. Click the
advisory number of a patch in the Patch List to see more information about the patch.

This section is divided into tabs.

[Link]. Details

The Details tab shows the patch report provided by SUSE.

36 / 152 1.5. Patches Menu | Uyuni 2024.03

 1.5. Patches Menu

In the Affected Channels section, all channels that contain the affected package are listed. Click
the channel name to go to Software › Channel Details.

For security patches, additional information is shown about the vulnerability, including the CVE and
OVAL details.

If available, the original advisory provided by the vendor of the patch is shown in the section Vendor
Advisory.

For more information about SUSE Update Advisories, see [Link]

[Link]. Packages

The Packages tab provides links to each of the updated packages by channel. Click the name of a
package to go to Software › Channel Details.

[Link]. Affected Systems

The Affected Systems tab provides a list of installed clients that the patch affects. You can install
updates from this tab.

Click the name of a client to go to Systems › System Details.

Each client in the list shows the current status of the patch on that client. This column identifies only the
most recent action. Click the name of a status in the list to go to the Action Details page.

Table 17. Client Update Status Icons

Description Action Required N/A

Check the status manually. Pending The client will be updated at the
next synchronization.

Picked Up The client is in the progress of Completed

updating.

The client successfully installed Failed The client attempted to install the
the patch. patch, but encountered an error.

1.5.2. Patch List

[Link]. Relevant Patches

The Patches › Patch List › Relevant section displays a list of all patches released by SUSE that apply to
your installed clients.

Each patch in the list shows a patch type, an advisory number, a short description, the number of clients in
your network affected, and the date the patch was last updated. Click the advisory number to see more

37 / 152 1.5. Patches Menu | Uyuni 2024.03

 1.5. Patches Menu

information about the patch. For more information about the Patches › Patch List › Patch Details
section, see xref:reference:patches/[Link]

Table 18. Patch Status Icons

Icon Description Action Required

 Bug fix Recommended

image:spacewalk-icon- Product enhancement advisory Optional

[Link]

 Security update Essential

 Affects package management Recommended

stack

 To receive email when new patches are available, navigate to Home › My

Preferences and check Receive email notifications.

[Link]. All Patches

The Patches › Patch List › All section displays a list of all patches released by SUSE. Not all of the
patches will apply to your clients.

Each patch in the list shows a patch type, an advisory number, a short description, the number of clients in
your network affected, and the date the patch was last updated. Click the advisory number to see more
information about the patch.

Table 19. Patch Status Icons

Icon Description Action Required

 Bug fix Recommended

Product enhancement advisory Optional

 Security update Essential

 Affects package management Recommended

stack

For more information about patching, see Client-configuration › Patch-management.

38 / 152 1.5. Patches Menu | Uyuni 2024.03

 1.5. Patches Menu

1.5.3. Advanced Search for Patches

The Patches › Advanced Search section allows you to use advanced criteria to search for patches.

You can search for patches by looking for your search term in different fields:

Table 20. Patch Advanced Search Options

Option Description Example

All Fields Search in all fields glibc

Patch Advisory Search within the name or label slessp1-glibc

fields

Package Name Search within the package name kernel

field only

CVE Search within the CVE name or CVE-2006-4535

number field only

You can also search within different types of patches, or within a range of issue dates.

For more information about patching, see Client-configuration › Patch-management.

1.5.4. Manage Patches

The Patches › Manage Patches section shows you all custom patches.

Each patch in the list shows a patch type, an advisory name, a short description, and the date the patch
was last updated. Click the advisory name to go to Patches › Patch List › Patch Details for the patch.

To create a new patch, click [Create Patch]. To delete a patch, select it in the list, and click
[Delete Patches] .

If you use Uyuni with a proxy, manage patches only on the Uyuni Server. The

 Uyuni Proxy will receive updates from the server directly. If you manage patches
on a proxy, the servers will be unable to synchronize correctly.

For more information about patching, see Client-configuration › Patch-management.

1.5.5. Clone Patches

The Patches › Clone Patches section allows you to create copies of existing patches to distribute to your
clients.

To clone a patch, the patch must apply to one of your existing software channels. If the patch was part of
a software channel that was cloned, then you can clone the patch from the cloned channel.

39 / 152 1.5. Patches Menu | Uyuni 2024.03

 1.6. Software Menu

See all patches that are available for cloning by selecting the channel name in the View patches
potentially applicable to: field, and click [View] . From the list, check the patch to clone,
and click [Clone Patch] . You need to confirm the details to perform the clone.

1.6. Software Menu

The Software section allows you to view and manage software channels, repositories, and packages.

For more information about software channels, see Client-configuration › Channels.

1.6.1. Channel Details

The Software › Channel List › Channel Details section displays the details of a selected channel. Click
the name of a channel in the Channel List to see more information about the channel.

This section is divided into tabs.

[Link]. Details

The Details tab shows the basic channel details, including a description of the channel, and the dates it
was last modified and built. This tab also provides contact information for the maintainer of the product
and the GPG key details, where available.

[Link]. Managers

The Managers tab shows which users are authorized to manage the selected channel. The list shows the
username, real name, and email address of the channel manager, as well as the current status of the user.

Organization and Channel administrators can manage any channel. Uyuni Administrators can change
roles for specific users by clicking the username.

For more information about user management, see Administration › Users.

[Link]. Patches

The Patches tab shows all available patches for packages in the selected channel. The list displays the
advisory type, names, synopsis, and the date the patch was last updated. Click the advisory name to go to
the Patch Details page.

For more information about managing patches and packages, see Client-configuration › Patch-
management.

[Link]. Packages

The Packages tab shows all packages in the selected channel. The list shows the package name,
summary, and the provider of the package. Click the package name to go to the Package Details
page.

40 / 152 1.6. Software Menu | Uyuni 2024.03

 1.6. Software Menu

For more information about managing patches and packages, see Client-configuration › Patch-
management.

[Link]. Subscribed Systems

The Subscribed Systems tab shows the clients currently subscribed to the selected channel. The
list shows the client name and type. Check a client in the list to add it to the system set manager. Click the
client name to go to the System Details page.

For more information about the system set manager, see Client-configuration › System-set-manager.

[Link]. Target Systems

The Target Systems tab shows the clients eligible for subscription to the selected channel. This tab
is only available if the selected channel is a child channel. The list shows the client name and type, and the
associated base channel.

To subscribe a client to the selected channel, check the client in the list, and click [Confirm] .

For more information about software channels, see Client-configuration › Channels.

[Link]. AppStreams

The AppStreams tab is only visible for modular channels and it shows all the available modules in the
channel. The list shows the module name and the streams available for the module. The default stream for
each module is indicated with a highlighted color.

For more information about AppStreams and how to use them, see administration:content-lifecycle-
[Link].

1.6.2. Channel List Menu

The Software › Channel List section allows you to view and manage software channels and packages on
your clients.

For more information about software channels, see Client-configuration › Channels.

The Software › Channel List › All section displays a list of all software channels that are available to
your organization.

Each software channel in the list shows a channel name, a provider, the number of packages and patches
in the channel, and the number of clients currently subscribed to the channel. Click the plus sign next to
the name of a parent channel to expand the entry and see all the related child channels. Click the channel
name to see more information about the channel.

Within the Software › Channel List section you can select which subset of channels you would like to
see by navigating to tabs, or the sub-menu items.

41 / 152 1.6. Software Menu | Uyuni 2024.03

 1.6. Software Menu

Table 21. Channel List Filters

Filter Description

All All channels available to your organization.

SUSE Channels provided by SUSE.

Popular Channels most subscribed to by clients in your

organization.

My Channels Software channels that belong to your organization,

including custom channels.

Shared Channels shared with others in the organizational

trust.

Retired Channels that have reached end-of-life and no

longer receive updates.

For more information about software channels, see Client-configuration › Channels.

1.6.3. Package Search

The Software › Package Search section allows you to search all packages.

Enter your search term in the Search For field.

Table 22. What to Search Options

Option Description

Free form Performs a general search. Use keywords with this

option to perform more specific searches.

Name only Searches only in the names of packages.

Name and Summary Searches within the name and one-line summary of
packages.

Name and Description Searches within names and long descriptions of

packages.

Check the Channels relevant to your systems option to search only channels available for
your existing clients. Check the Specific channel you have access to option to search
within a specific channel. Check the Packages of a specific architecture to search only
for a particular hardware architecture.

You can perform more specific searches by using keywords in the Search For field and selecting the
Free Form option.

42 / 152 1.6. Software Menu | Uyuni 2024.03

 1.6. Software Menu

Table 23. Keyword Search Options

Keyword Description Example

name Search package names name:SUSE

version Search for a package version version:15

filename Search within package file names filename:sles

description Search within the long description:java

description

summary Search within the one-line summary:java

summary

arch Search for a package architecture arch:x86_64

For example, if you want to search all SUSE Linux Enterprise packages that include java in the
description and the summary, use this search:

summary:java and description:java

For more information about software channels, see Client-configuration › Channels.

1.6.4. Manage Menu

The Software › Manage section allows you to manage custom channels, packages, and repositories.

For more information about custom channels, see Administration › Custom-channels.

[Link]. Manage Channels

The Software › Manage › Channels section allows you to manage custom channels.

Click [Create Channel] to create a new custom channel.

To clone an existing channel, click [Clone Channel] and select the channel to clone. You can
choose to clone channel with or without all current patches, or select specific patches for inclusion.

For more information about custom channels, see Administration › Custom-channels.

[Link]. Manage Packages

The Software › Manage › Packages section allows you to manage packages that are owned by your
organization.

Select a channel from the drop-down box to see all packages related to that channel. If you have
administration privileges within your organization, you can also delete packages.

43 / 152 1.6. Software Menu | Uyuni 2024.03

 1.7. Content Lifecycle Management Menu

For more information about custom channels, see Administration › Custom-channels.

[Link]. Manage Repositories

The Software › Manage › Repositories section allows you to manage custom or third-party package
repositories and link the repositories to an existing channel.

Click [Create Repository] to create a new repository.

For more information about custom repositories and channels, see Administration › Custom-channels.

1.6.5. Distribution Channel Mapping

The Software › Distribution Channel Mapping section lists your defined default base channels. When
you register a client for the first time, they will automatically be assigned to these software channels, in
accordance with their architecture and operating system. Default channel mappings can be edited, but not
deleted.

Click [Create Distribution Channel Mapping] to create a new channel map.

Table 24. Distribution Channel Mapping Columns

Column Description

Operating System The client operating system this mapping applies to.

Release The operating system release this mapping applies

to.

Architecture The client system architecture architecture this

mapping applies to.

Channel Label The label of the channel.

Organization Specific Checked if this mapping applies only to the current

organization.

For more information about software channels, see Client-configuration › Channels.

1.7. Content Lifecycle Management Menu

In the Content Lifecycle section, you can customize and test packages before updating production
clients.

Content lifecycle management allows you to select software channels as sources, adjust them as required
for your environment, and thoroughly test them before installing onto your production clients.

For more information about content lifecycle management, see Administration › Content-lifecycle.

44 / 152 1.7. Content Lifecycle Management Menu | Uyuni 2024.03

 1.8. Audit Menu

1.7.1. Projects
In the Content Lifecycle › Projects section, you can create new content lifecycle management projects,
and edit existing projects.

For more information about content lifecycle management, see Administration › Content-lifecycle.

1.7.2. Filters
In the Content Lifecycle › Filters section, you can create various types of filters. With the filters you
control the content that is used when a content lifecycle project is built.

For more information about content lifecycle management, see Administration › Content-lifecycle.

1.8. Audit Menu

The Audit menu provides access to features for managing security updates on your clients. Audit tasks
include finding and updating clients with the latest CVE patches, subscription matching, and managing
OpenSCAP scans.

1.8.1. CVE Audit

The Audit › CVE Audit section shows you which CVEs have been applied to your clients. A CVE
(common vulnerabilities and exposures) is a fix for a publicly known security vulnerability. It is important
that you apply CVEs to your clients as soon as they become available.

Each CVE contains an identification number, a description of the vulnerability, and links to further
information. CVE identification numbers use the form CVE-YEAR-XXXX.

Clients are listed with a patch status icon.

Table 25. Patch Status Icons

Icon Description Action Required

 Affected, patches are available in The client is affected by a

channels that are not assigned vulnerability and Uyuni has
patches for it, but the channels
offering the patches are not
assigned to the client.

 Affected, at least one patch is The client is affected by the

available in an assigned channel vulnerability and Uyuni has
patches available in a channel that
is directly assigned to the client.

 Not affected There are no available CVE

patches for this client.

45 / 152 1.8. Audit Menu | Uyuni 2024.03

 1.8. Audit Menu

Icon Description Action Required

 Patched A patch has been successfully

installed on the client.

For more information about CVE auditing, see Administration › Auditing.

1.8.2. Subscription Matching

The Audit › Subscription Matching section provides reports that match your currently installed clients
to your existing product subscriptions. Subscription matching reports provide information about clients
that do not have a subscription, and subscription start and end dates.

Table 26. Subscription Matching Options

Column Description

Part Number Identifier of the matched product

Description Description of the matched product

Policy The type of subscription matched to the product

Matched/Total The number of clients currently using the

subscription, of the total available. If the
subscription is fully matched, the quantity column
value is highlighted.

Start Date Start date of the subscription

End Date End date of the subscription

Table entries are highlighted if they are due to expire within three months. Table entries that have already
expired are shown in grayscale.

For messages relating to subscription matching, navigate to the Messages tab.

Table 27. Subscription Matching Messages

Message Type Description Action

Unsupported part Debug The detected part Call SUSE support and
number detected number is unknown or open a Service Request
unsupported. ticket to have the part
number added to the
product.

46 / 152 1.8. Audit Menu | Uyuni 2024.03

 1.8. Audit Menu

Message Type Description Action

Physical system is Debug A client is reporting as Check the client

reported as virtual guest, virtual, but could be a hardware data.
please check hardware physical client.
data

Virtual guest has Warning A virtual client has an Check the virtual host
unknown host, assuming unknown host. During manager (VHM)
it is a physical system the matching process, it configuration to ensure it
was treated as a physical is reporting correctly.
system. This might For Linux-based hosts
translate into a wrong using libvirt, check
subscription assignment. that the host is
registered, and that the
virtual host system type
is set correctly.

System has an unknown Warning Unable to determine how Schedule a hardware

number of sockets, many CPUs a client has. refresh on this client.
assuming 16 Uyuni used the default
value of 16 CPUs every
time the number was
relevant for matching a
subscription. This might
translate into a wrong
subscription assignment.

Two subscriptions with Informational Two subscriptions were No actions needed.

the same part number identified to be part of a
are in a bundle bundle and, as result,
they were merged
together during the
computation process.

Two subscriptions with Informational Two subscription shared No actions needed.

the same part number multiple common
(and other properties) properties and they were
have been merged merged together during
together the computation process.

Pinned match adjusted Informational A user defined pin was No actions needed.
due to merged updated since the chosen
subscriptions subscription was merged
with another one.

47 / 152 1.8. Audit Menu | Uyuni 2024.03

 1.8. Audit Menu

Message Type Description Action

Subscription with Informational An unknown No actions needed.

unsupported part number subscription without any
and no associated associated product has
product has been been detected and it was
ignored. ignored during the
matching process.

To pin clients to a particular subscription, navigate to the Pins tab.

Table 28. Pin Statuses

Status Description

Satisfied The client and subscription were matched correctly.

Not satisfied The client was not successfully matched with a

subscription.

Pending next run Waiting for the next matcher run.

For more information about subscription matching, see Administration › Subscription-matching.

1.8.3. OpenSCAP Menu

The Audit › OpenSCAP section displays the results of OpenSCAP scans that you have performed on
your clients.

The Security Content Automation Protocol (SCAP) is a synthesis of interoperable specifications derived
from community ideas. Uyuni uses OpenSCAP to implement the SCAP specifications.

For more information about OpenSCAP, see Administration › Openscap.

[Link]. OpenSCAP

The Audit › OpenSCAP section displays the results of OpenSCAP scans that you have performed on
your clients.

The Security Certification and Authorization Package (SCAP) is a standardized compliance checking
solution for enterprise-level Linux infrastructures. Uyuni uses OpenSCAP to implement the SCAP
specifications.

For more information about OpenSCAP, see Administration › Openscap.

[Link]. All Scans

The Audit › OpenSCAP section displays the results of OpenSCAP scans that you have performed on

48 / 152 1.8. Audit Menu | Uyuni 2024.03

 1.8. Audit Menu

your clients.

The Security Content Automation Protocol (SCAP) is a synthesis of interoperable specifications derived
from community ideas.

Table 29. OpenSCAP Scan Details

Name Description Evaluation Results

System The name of the scanned client.

XCCDF Profile The evaluated profile.

Completed The time that the scan was

completed.

Satisfied The total number of rules that A rule is satisfied if the result of
have been satisfied. the evaluation is Pass or
Fixed.

Dissatisfied The total number of rules that are A rule is dissatisfied if the result
not satisfied. of the evaluation is Fail.

Unknown The total number of rules that A rule is unknown if the result of
were not able to be evaluated. the evaluation is Error,
Unknown or Not checked.

Rules can also return other results, including Informational, Not

 Applicable, or Not Selected. Rules that return these results are not
shown in the scan results.

For more information about OpenSCAP, see Administration › Openscap.

[Link]. XCCDF Diff

The Audit › OpenSCAP › XCCDF Diff section allows you to compare two OpenSCAP XCCDF scans.

For more information about OpenSCAP, see Administration › Openscap.

[Link]. Advanced Search

The Audit › OpenSCAP › Advanced Search section allows you to search through OpenSCAP scans and
results.

For more information about OpenSCAP, see Administration › Openscap.

49 / 152 1.8. Audit Menu | Uyuni 2024.03

 1.9. Configuration Menu

1.9. Configuration Menu

The Configuration section provides access to features for managing the configuration of Uyuni
clients.

 The Configuration menu is only available if you are signed in with a

configuration administrator or Uyuni administrator account.

Within the configuration pages, you can:

• manage clients using configuration files

• configure channels offering configuration files
• manage configuration files themselves

Centrally managed files are available to multiple clients, while locally managed files are available to
individual clients only.

1.9.1. Configuration Overview

The Configuration › Overview section is a dashboard that contains a summary of the configuration files
that are managed by your organization in Uyuni. There are different panes listing files that are managed
centrally in configuration channels and files that are managed locally with individual system profiles.

For more information about managing configuration files, see Client-configuration › Configuration-
management.

Configuration Summary
Provides quick information about your configuration files. Click the blue text to the right to display:

• Systems with managed configuration files

• Configuration channels
• Centrally managed configuration files
• Locally managed configuration files

Configuration Actions
Configuration Actions offers direct access to the most common configuration management
tasks:

• View clients with managed configuration files

• View all managed configuration files
• View all managed configuration channels
• Create a new configuration channel
• Enable configuration management on clients

50 / 152 1.9. Configuration Menu | Uyuni 2024.03

 1.9. Configuration Menu

Recently Modified Configuration Files

The list shows which files have changed when and to which channel they belong. If no files have been
changed, no list appears.

Table 30. Recently Modified Configuration Files Columns

Column Description

Filename Absolute filename of the configuration file.

Configuration Channel Name of the configuration channel.

Modified The time and date the file was modified.

Click the name of a file to see its Details page. Click the channel name to see its Channel
Details page.

Recently Scheduled Configuration File Deployments

Each scheduled action is listed along with the status of the action. Any scheduled configuration task,
from enabling configuration management on a system to deploying a specific configuration file, is
displayed. Here you can quickly assess if all tasks have been successfully carried out or fix any
problems.

Table 31. Scheduled Configuration File Deployments Columns

Column Description

System Host name of the system where you want to

deploy the configuration file.

Files to be Deployed Number of files to be deployed.

Scheduled By The user who scheduled the job.

Scheduled For The time and date the file deployment will
happen.

Status Status of the deployment: Queued

Clicking the blue status text displays the System Details › Schedule page for the specified system.

1.9.2. Channels
Uyuni manages both central and local configuration channels and files. Central configuration
management allows you to deploy configuration files to multiple systems, by using state channels. When
you create a state channel, you can create or upload custom Salt states. For more information about
custom states, see Specialized-guides › Salt.

Click the name of the configuration channel to see the details page for that channel. If you click the
number of files in the channel, you are taken to the List/Remove Files page of that channel. If you

51 / 152 1.9. Configuration Menu | Uyuni 2024.03

 1.9. Configuration Menu

click the number of systems subscribed to the configuration channel, you are taken to the Configuration
Channel Details › Systems › Subscribed Systems page for that channel.

[Link]. Configuration Channel Details

Overview
The Overview page of the Configuration Channel Details page is divided into several
panels:

Channel Properties [Management]

Edit the name, label, and description of the channel by clicking [Edit Properties] .

Channel Information
Provides status information for the contents of the channel.

Configuration Actions
Provides access to the most common configuration tasks. For Salt clients, there is a link to edit the
[Link] file.

This panel allows you to deploy, compare, and add and create files. Some action are only
availalble if you have files created and clients assigned to configuration channels.

List/Remove Files
This page only appears if there are files in the configuration channel. You can remove files or copy
the latest versions into a set of local overrides or into other central configuration channels. Check the
box next to files you want to manipulate, then click the action button at the bottom.

Add Files
The Add Files page has three subtabs of its own, which allow you to Upload, Import, or
Create configuration files to be included in the channel.

Upload File
To upload a file into the configuration channel, browse for the file on your local system, populate
all fields, and click the [Upload Configuration File] button. The Filename/Path
field is the absolute path where the file will be deployed.

You can set the Ownership via the user name and group name and the Permissions
of the file when it is deployed.

If the client has SELinux enabled, you can configure SELinux contexts to enable the
required file attributes (such as user, role, and file type).

If the configuration file includes a macro (a variable in a configuration file), enter the symbol that
marks the beginning and end of the macro. For more information on using macros, see
reference:configuration/[Link].

52 / 152 1.9. Configuration Menu | Uyuni 2024.03

 1.9. Configuration Menu

Import Files
To import files from other configuration channels, including any locally managed channels, check
the box to the left of any file you want to import. Then click [Import Configuration
Files] .

A sandbox icon ( ) indicates that the listed file is currently located

 in a local sandbox. Files in a system’s sandbox are considered

experimental and could be unstable. Use caution when selecting them for
a central configuration channel.

Create File
Create a configuration file, directory, or symbolic link to be included in the configuration channel.

Deploy Files
This page only appears when there are files in the channel and a system is subscribed to the channel.
Deploy all files by clicking the [Deploy All Files] button or check selected files and click the
[Deploy Selected Files] button. Select to which systems the files should be applied. All
systems subscribed to this channel are listed. If you want to apply the file to a different system,
subscribe it to the channel first. To deploy the files, click [Confirm & Deploy to Selected
Systems] .

Systems
Manage systems subscribed to the configuration channel with two subtabs:

Subscribed Systems
All systems subscribed to the current channel are displayed. Click the name of a system to see the
System Details page. To unsubscribe a system from the configuration channel, check the
box to the left of the system name and click [Unsubscribe systems] .

Target Systems
This subtab displays a list of systems enabled for configuration management but not yet
subscribed to the channel. To add a system to the configuration channel, check the box to the left
of the system name and click [Subscribe systems] .

1.9.3. Files
This page allows you to manage your configuration files independently. Both centrally managed and
locally managed files can be reached from sub-pages.

By default, the maximum file size for configuration files is 128 KB

 (131072 bytes). SUSE supports a configuration file size up to 1 MB. Larger files
are not guaranteed to work.

The default maximum file size is set on the Uyuni Server in these files:

53 / 152 1.9. Configuration Menu | Uyuni 2024.03

 1.9. Configuration Menu

# /usr/share/rhn/config-defaults/rhn_web.conf
web.maximum_config_file_size = 131072

# /usr/share/rhn/config-defaults/rhn_server.conf
maximum_config_file_size = 131072

Copy these variables to /etc/rhn/[Link] and edit them. Values are specified in bytes, for
example:

# /etc/rhn/[Link]
web.maximum_config_file_size = 262144
server.maximum_config_file_size = 262144

Then restart spacewalk:

spacewalk-service restart

[Link]. Centrally Managed Configuration Files

Centrally managed files are available to multiple systems. Changing a file within a centrally managed
channel may result in changes to several systems. Locally managed files supersede centrally managed
files. For more information about locally managed files, see Reference › Configuration.

This page lists all files currently stored in your central configuration channel.

Table 32. Centrally Managed Files Columns

Column Description

Path Absolute filename of the configuration file.

Configuration Channel Name of the configuration channel.

Systems Subscribed Number of systems subscribed.

Systems Overriding

Click the Path of a file to see Details tab of the file. Click the name of the Configuration
Channel to see the Overview tab of the channel. Clicking Systems Subscribed shows you all
systems currently subscribed to the channel containing that file. Click Systems Overriding to see
all systems that have a local (or override) version of the configuration file. The centrally managed file will
not be deployed to those systems.

[Link]. Locally Managed Configuration Files

Locally managed configuration files apply to only one system. They may be files in the system’s sandbox
or files that can be deployed to the system at any time. Local files have higher priority than centrally
managed files. If a system is subscribed to a configuration channel with a given file and additionally has a

54 / 152 1.9. Configuration Menu | Uyuni 2024.03

 1.9. Configuration Menu

locally managed version of that file, the locally managed version will be deployed.

The list of all local (override) configuration files for your systems includes the local configuration
channels and the sandbox channel for each Provisioning-entitled system.

Click the Path of the file to see its Config File Details. Click the name of the system to which
it belongs to see its System Details › Configuration › Overview page.

For more information about configuration management, see Client-configuration › Configuration-

management.

1.9.4. Systems Menu

Displays status information about your system in relation to configuration. There are two sub-pages:
Managed Systems and Target Systems.

[Link]. Managed Systems

By default the Managed Systems page is displayed. The listed systems have been fully prepared for
configuration file deployment. The number of locally managed and centrally managed files is displayed.

Click the name of a system to show the relevant System Details › Configuration › Overview page.

Click the number of local files to show the System Details › Configuration › View/Modify Files ›
Locally Managed Files page, where you can manage which local (override) files apply to the system.

Click the number of centrally managed files to show the System Details › Configuration › Manage
Configuration Channels › List/Unsubscribe from Channels page. On this page, you can unsubscribe
from channels.

[Link]. Target Systems

This page shows the systems that are not prepared for configuration file deployment, or are not yet
subscribed to a configuration channel.

The table has three columns:

• The system name

• If the system is prepared for configuration file deployment
• The steps necessary to prepare the system.

To prepare a system, check the box to the left of the profile name then click the [Enable SUSE
Manager Configuration Management] button. All of the preparatory steps that can be
automatically performed are scheduled by Uyuni.

55 / 152 1.9. Configuration Menu | Uyuni 2024.03

 1.10. Schedule Menu

 You will need to perform some manual tasks to enable configuration file
deployment. Follow the on-screen instructions provided to assist with each step.

1.10. Schedule Menu

The Schedule section allows you to view actions and action chains.

Actions include:

• Package alterations, including installation, upgrade, removal, and rolling back of packages
• Client reboots
• Patch installation
• Configuration file alterations, including deploy, upload, and diff
• Hardware profile updates
• Package list profile updates
• Automated installation initiation
• Product migrations
• Remote commands

For more information about actions, see Administration › Actions.

1.10.1. Pending Actions

The Schedule › Pending Actions section shows actions that are in progress, or that have not yet started.
Use the Filter by Action field to search the list.

Cancel pending actions by checking the action in the list, and clicking [Cancel Actions] . If you
archive a pending action, it is not canceled, but the action item moves from the Pending Actions list
to the Archived Actions list.

Table 33. Actions List Columns

Column Description

Action Type of action to perform. Click the action to go to

Action Details.

Scheduled Time The earliest time to perform the action.

Succeeded Number of clients on which this action was

successful.

Failed Number of clients on which this action has failed.

56 / 152 1.10. Schedule Menu | Uyuni 2024.03

 1.10. Schedule Menu

Column Description

Pending Number of clients on which this action is currently

running

Total Total number of clients on which this action has

been scheduled.

For more information about actions, see Administration › Actions.

1.10.2. Recurring Actions

The Schedule › Recurring Actions section shows all recurring actions that you have permissions for.

The recurring actions list on this page is a read-only table. To modify a schedule,

 you can follow the links in the Target Name column and list the schedules of
an individual target.

Recurring Action Details

View the details about an action from the action list. In the Actions column, click the
[Details] icon for the action you are interested in.

For more information about recurring actions, see Administration › Actions.

1.10.3. Completed Actions

The Schedule › Completed Actions section shows actions that have been successfully completed. Use
the Filter by Action field to search the list. Archive completed actions by checking the action in
the list, and clicking [Archive Actions] .

Table 34. Completed Actions List Columns

Column Description

Action Type of action to perform. Click the action to go to

Action Details.

Scheduled Time The earliest time to perform the action.

Succeeded Number of clients on which this action was

successful.

Failed Number of clients on which this action has failed.

Pending Number of clients on which this action is currently

running

57 / 152 1.10. Schedule Menu | Uyuni 2024.03

 1.11. Users Menu

Column Description

Total Total number of clients on which this action has

been scheduled.

For more information about actions, see Administration › Actions.

1.10.4. Archived Actions

The Schedule › Archived Actions section shows actions that you have marked as archived. Use the
Filter by Action field to search the list. Completed or failed actions can be archived.

For more information about actions, see Administration › Actions.

1.10.5. Action Chains

The Schedule › Action Chains If you need to perform a number of sequential actions on your clients,
you can create an action chain to automate them.

For more information about action chains, see Administration › Actions.

1.10.6. Maintenance Windows

The Schedule › Maintenance Windows section allows you to manage your maintenance window
schedules. To create a maintenance schedule, you need to have an existing .ical file that contains the
calendar. Upload the calendar, create a new schedule, and assign the schedule to a client. When a schedule
is applied to a client, you are prevented from executing some actions outside of the specified period.

Navigate to Schedule › Maintenance Windows › Schedules to see a list of all current schedules. Click
[Create] to create a new schedule. Click [Edit] to change the schedule.

Navigate to Schedule › Maintenance Windows › Calendars to see a list of all current calendars. Click
[Create] to create a new calendar. Click [Edit] to change the calendar.

For more information about maintenance windows, see Administration › Maintenance-windows.

1.11. Users Menu

The Users menu provides access to grant and edit permissions for those who administer your system
groups. You can create new users, and edit user details, roles, and system groups.

 The Users menu is only available if you are signed in to Uyuni with an
administrator account.

For more information about managing users, see Administration › Users.

58 / 152 1.11. Users Menu | Uyuni 2024.03

 1.11. Users Menu

1.11.1. User Details

The User Details section provides additional details about the user account, and allows you to
manage permissions for the user. You can also deactivate or delete users from this section.

For more information about managing users, see Administration › Users.

The User Details section is split into tabs:

[Link]. Details

This tab allows you to change the name and password of the user account, and provides information about
the various permissions the user has assigned.

Use this section to assign or remove administrator roles, except for the Uyuni Administrator. To change a
user’s Uyuni Administrator role, navigate to Admin › Users and check or uncheck Uyuni Admin? as
required.

[Link]. System Groups

This tab shows the system groups the user is assigned to. Check or uncheck system groups as required.

[Link]. Systems

This tab shows the clients the user is able to administer. Use system groups to modify client access levels.

Select multiple systems from this page to add them to the system set manager (SSM). For more
information about SSM, see Client-configuration › System-set-manager.

[Link]. Channel Permissions

This tab shows the channel permissions for the user.

The Subscription subtab shows channels that the user has subscription permissions for. The
Management subtab shows channels that the user has management permissions for.

Check channels in the list to grant permissions.

[Link]. User Preferences

This tab is used to configure preference settings for users.

Table 35. User Preferences

59 / 152 1.11. Users Menu | Uyuni 2024.03

 1.11. Users Menu

Option Description Default

Email Notification Receive email for client and Checked

Taskomatic notifications,
including a daily summary email.

Uyuni List Page Size Maximum number of items that 25 entries

can appear in a list on a single
page.

"Overview" Start Page Select the information panes to All checked

display on the Home › Overview
page.

Time Zone Set your local timezone. System timezone

CSV Files Select whether to use comma or Comma

semi-colon delimiters when
producing downloadable CSV
files.

[Link]. Addresses

This tab shows the mailing addresses associated with the user. Click [Fill in this address] to
set a mailing address. Click [Edit this address] to change an existing mailing address.

1.11.2. User List

The Users › User List section provides access to the lists of users.

[Link]. Active Users

The Users › User List › Active section shows all active users in your Uyuni Server.

Each user in the list shows the username, real name, assigned roles, and the date the user last signed in.
Click btn:Create User to create a new user account. Click the username to go to the User
Details page.

For more information about managing users, see Administration › Users.

[Link]. Deactivated Users

The Users › User List › Deactivated section shows all deactivated users in your Uyuni Server.

Each user in the list shows the username, real name, assigned roles, the date the user last signed in, the
user who deactivated the account, and the date the account was deactivated. Click [Create User] to
create a new user account. Click the username to go to the User Details page.

60 / 152 1.11. Users Menu | Uyuni 2024.03

 1.12. Admin Menu

To reactivate a user, check the username in the list and click [Reactivate] .

For more information about managing users, see Administration › Users.

[Link]. All Users

The Users › User List › All section shows all activated and deactivated users in your Uyuni Server.
Deleted users are not shown in the list.

Each user in the list shows the username, real name, assigned roles, the date the user last signed in, and
the current status of the user. Click btn:Create User to create a new user account. Click the username
to go to the User Details page.

For more information about managing users, see Administration › Users.

1.11.3. System Group Configuration

The Users › System Configuration section allows you to configure system groups for your users.

System groups allow you to grant permissions to a group of users, instead of granting permissions to
individuals. This is particularly useful if you have many users.

You can also configure system groups for users that have been externally authenticated.

For more information about managing users with system groups, see Administration › Users.

1.12. Admin Menu

The Admin menu provides access to features for managing Uyuni configuration. Configuration tasks
include creating and managing organizations, users, and tasks. You can also use the setup wizard to help
configure Uyuni.

 The Admin menu is only available if you are logged in to Uyuni with an
administrator account.

1.12.1. Setup Wizard

The Admin › Setup Wizard section helps you configure Uyuni. It is the default page when you use the
Uyuni Web UI for the first time.

Table 36. Setup Wizard Options

Option Description

HTTP Proxy Configure an HTTP proxy connection.

61 / 152 1.12. Admin Menu | Uyuni 2024.03

 1.12. Admin Menu

Option Description

Organization Credentials Configure an organization for accessing SUSE

Customer Center.

Products View product entitlements and subscribe to product

channels.

For more information about the setup wizard, see Installation-and-upgrade › Setup-wizard.

1.12.2. Organizations
The Admin › Organizations section allows you to create and manage your Uyuni organizations. Click an
organization in the list to see details.

For more information about organizations, see Administration › Organizations.

1.12.3. Users
The Admin › Users section allows you to view and manage all users of the organization you are logged
in to. Every user shows the username, real name, the organization they are associated with, and whether
the user is an organization or Uyuni administrator.

To change a user’s Uyuni Administrator role, check or uncheck Uyuni Admin as required.

Click a username to modify the user account details, and change other administrator roles.

For more information, see Reference › Users.

1.12.4. Manager Configuration

The Admin › Manager Configuration section contains tabs to allow you to configure Uyuni.

Table 37. Configuration Options

Option Description

General Configure your Uyuni installation.

Bootstrap Script Generate a custom bootstrap script.

Organizations Create and configure organizations and users.

Restart Restart Uyuni. You will need to do this after

making configuration changes.

Cobbler Run a Cobbler synchronization.

62 / 152 1.12. Admin Menu | Uyuni 2024.03

 1.12. Admin Menu

Option Description

Bare-metal systems Allow bare metal clients to be provisioned in

preparation for autoinstallation.

Monitoring Enable server monitoring.

[Link]. General

On the Admin › Manager Configuration › General page you can configure your Uyuni installation.

Table 38. Bootstrap Script Options

Option Description Default

Administrator Email Address Email address of the Uyuni Pre-populated

administrator.

SUSE Manager Hostname Hostname of the Uyuni Server. Pre-populated

HTTP Proxy The hostname and port of the None

proxy, if you are using one. Use
syntax <hostname>:<port>,
for example:
<[Link]>:8080.

HTTP Proxy username The username to use on the proxy None

server, if you are using one.

HTTP Proxy password The password to use on the proxy None

server, if you are using one.

Confirm HTTP Proxy password The directory where RPM /var/spacewalk/

packages are mirrored.

RPM repository mount point The hostname of the proxy None

server, if you are using one.

Default to SSL Check to use SSL as the default Checked

value for communications.

[Link]. Bootstrap Script

In the Admin › Manager Configuration › Bootstrap Script section you can generate a custom
bootstrap script. Bootstrap scripts are used to register clients with Uyuni. The generated script will be
placed in /srv/www/htdocs/pub/bootstrap/ on your Uyuni Server.

Table 39. Bootstrap Script Options

63 / 152 1.12. Admin Menu | Uyuni 2024.03

 1.12. Admin Menu

Option Description Default

Uyuni Server hostname The hostname for the Uyuni Pre-populated

Server to register the client to

SSL cert location Location and name of the SSL Pre-populated

certificate

Bootstrap using Salt Check to bootstrap clients Checked

Enable SSL Check to use the corporate public Checked

CA certificate on the client,
uncheck to use self-managed CA
certificates.

Enable Client GPG checking Check to use GPG, uncheck to Checked

disable GPG checking

Enable Remote Configuration Check to allow configuration Unchecked

from a remote server.

Enable Remote Commands Check to allow commands from a Unchecked

remote server.

Client HTTP Proxy The hostname of the proxy Unpopulated

server, if you are using one.

Client HTTP Proxy Username The username to use on the proxy Unpopulated
server, if you are using one.

Client HTTP Proxy Password The password to use on the proxy Unpopulated
server, if you are using one.

Do not disable SSL in your bootstrap script. Ensure that Enable SSL is


checked in the Web UI, or that the setting USING_SSL=1 exists in the
bootstrap script. If you disable SSL, the registration process requires custom SSL
certificates. For more about custom certificates, see Administration › Ssl-certs.

[Link]. Configure Organizations

The Admin › Manager Configuration › Organizations section contains details about organizations in
Uyuni, and provides links to create and configure organizations and users.

For more information about organizations, see Installation-and-upgrade › Server-setup.

[Link]. Restart

The Admin › Manager Configuration › Restart section allows you to restart Uyuni. You will need to
do this after making configuration changes. It will take some time for Uyuni to become available again

64 / 152 1.12. Admin Menu | Uyuni 2024.03

 1.12. Admin Menu

after a restart.

[Link]. Cobbler

The Admin › Manager Configuration › Cobbler page allows you to run a Cobbler synchronization.
You can repair or rebuild the contents of the /srv/tftpboot/ and /srv/www/cobbler/
directories after a manual modification of the Cobbler setup.

For more information about autoinstallation powered by Cobbler, see Client-configuration › Autoinst-
intro.

 SUSE only supports Cobbler functions that are available in the Uyuni Web UI,
or through the Uyuni API. Only supported features are documented here.

[Link]. Bare Metal Systems

In the Admin › Manager Configuration › Bare-metal systems section, you can turn on the bare metal
feature. This allows you to provision bare metal clients in preparation for autoinstallation.

For more information about bare metal provisioning, see Client-configuration › Autoinst-intro.

1.12.5. ISS Configuration

The Admin › ISS Configuration section is used to configure inter-server synchronization (ISS). ISS
allows you to connect two or more Uyuni Servers and keep them up-to-date.

To set up ISS, you need to define one Uyuni Server as a master, with the other as a slave. If conflicting
configurations exist, the system will prioritize the master configuration.

For more information about ISS, see Administration › Iss.

[Link]. ISS Master Setup

The Admin › ISS Configuration › Master Setup section is used to configure an inter-server
synchronization (ISS) master.

If you are logged in to an ISS master, this page lists all slaves that can receive content from this master.

To add new slaves to the master, click [Add new slave] . You will need the slave’s Fully Qualified
Domain Name (FQDN).

Check the Allow Slave to Sync? checkbox to enable the slave to synchronize with the master.

Check the Sync All Orgs to Slave? checkbox to synchronize all organizations to this slave.

For more information about ISS, see Administration › Iss.

65 / 152 1.12. Admin Menu | Uyuni 2024.03

 1.12. Admin Menu

[Link]. ISS Slave Setup

The Admin › ISS Configuration › Slave Setup section is used to configure an inter-server
synchronization (ISS) slave.

If you are logged in to an ISS slave, this page lists all masters that the slave has previously synchronized
with.

To add a new master, click [Add new master] . You will need the master’s Fully Qualified Domain
Name (FQDN), and the full path to the CA Certificate. For example:

/etc/pki/trust/anchors

For more information about ISS, see Administration › Iss.

1.12.6. Task Schedules

The Admin › Task Schedules section lists all predefined task bunches. Tasks can be grouped together in
bunches to simplify managing them.

This page shows the schedule for each bunch of tasks. Every schedule shows how frequently it runs using
cron notation, the time it became active, and the bunch that it belongs to.

Click a schedule to change its frequency, disable, or delete it.

 Do not disable or delete a schedule if you are not certain what it does. Some
schedules are essential for Uyuni to work properly.

For more information about task schedules, see Administration › Task-schedules.

1.12.7. Task Engine Status

The Admin › Task Engine Status section shows all running tasks by the Uyuni task engine.

Navigate to the Last Execution Times tab to see the task list. Each task shows the time it was last
run, and the current status of the task.

Navigate to the Runtime Status tab to see all tasks that have run in the past five minutes. Each task
shows the start and end time, the amount of time the task ran for, and the current status. Some tasks will
also provide further data, if available.

1.12.8. Show Tomcat Logs

The Admin › Show Tomcat Logs section shows the Apache Tomcat log file. You can also view the
Tomcat log from the command prompt at /var/log/rhn/rhn_web_ui.log.

66 / 152 1.12. Admin Menu | Uyuni 2024.03

 1.13. Help Menu

 The Admin › Show Tomcat Logs section is only available if you are signed in
to Uyuni with an administrator account.

1.13. Help Menu

The Help section opens the current version of the Uyuni documentation in a new browser tab. This is
the documentation installed locally on your Uyuni Server.

For all versions and formats of the Uyuni documentation, see [Link]

 You can read EULA by going

[Link]
to

1.13.1. Documentation
The Help › Documentation 2024.03 section opens the current version of the Uyuni documentation in a
new browser tab. This is the documentation installed locally on your Uyuni Server.

For all versions and formats of the SUSE Manager documentation, including API documentation, see
[Link]

For all versions and formats of the Uyuni documentation, see [Link]
[Link].

1.13.2. Release Notes

The Help › Release Notes section opens the current version of the Uyuni Release Notes in a new browser
tab.

1.13.3. API Menu

The Help › API section contains links to the available API calls, and includes an API FAQ and sample
scripts.

[Link]. API Overview

The Help › API › Overview section provides a list of available API calls. Click the name of an API call
to see the relevant documentation.

For the full API documentation, see [Link]

[Link]. API FAQ

The Help › API › FAQ section contains frequently asked questions related to Uyuni APIs.

67 / 152 1.13. Help Menu | Uyuni 2024.03

 1.13. Help Menu

[Link]. API Sample Scripts

The Help: › API › Sample Scripts section contains example API calls for you to copy. The scripts are
written in Ruby, Perl, and Python.

68 / 152 1.13. Help Menu | Uyuni 2024.03

 2.1. Configuring spacecmd

Chapter 2. spacecmd Reference

The following section will help you become more familiar with the spacecmd command-line interface.
This interface is available for Uyuni, Satellite and Spacewalk servers. spacecmd is written in Python and
uses the XML-RPC API provided by the server.

What can spacecmd do for me?

• Manage almost all aspects of SUSE Manager from the command line with spacecmd
• Tab completion is available for all commands
• Single commands can be passed to spacecmd without entering the interactive shell (excellent for
shell scripts)
• May also be accessed and used as an interactive shell
• Advanced search methods are available for finding specific systems, thus removing the need to
create system groups (nevertheless groups are still recommended)
• Complete functionality through the Spacewalk API. Almost all commands that can be executed
from the Web UI can be performed via the spacecmd command-line

2.1. Configuring spacecmd

The following section provides configuration tips for spacecmd.

2.1.1. Setup spacecmd Credentials

Normally spacecmd prompts you for a username and password each time you attempt to login to the
interactive shell. Alternatively you can configure spacecmd with a credentials file to avoid this
requirement.

Procedure: Creating a spacecmd Credentials File

1. Create a hidden spacecmd directory in your home directory and set permissions:

mkdir ~/.spacecmd
chmod 700 ~/.spacecmd

2. Create a config file in ~/.spacecmd/ and provide proper permissions:

touch ~/.spacecmd/config
chmod 600 ~/.spacecmd/config

3. Edit the config file and add the following configuration lines. (You can use either localhost or
the FQDN of your Uyuni server):

69 / 152 2.1. Configuring spacecmd | Uyuni 2024.03

 2.1. Configuring spacecmd

[spacecmd]

server=FQDN-here

username=username-here
password=password-here

4. Check connectivity by entering spacecmd as root:

# spacecmd

2.1.2. spacecmd Quiet Mode

By default spacecmd prints server status messages during connection attempts. These messages can cause
a lot of clutter when parsing system lists. The following alias will force spacecmd to use quiet mode thus
preventing this behavior. Add the following line to your ~/.bashrc file:

alias spacecmd='spacecmd -q'

2.1.3. spacecmd Help

spacecmd help can be access by typing spacecmd -h --help

Usage: spacecmd [options] [command]

Options:
-c CONFIG, --config CONFIG
config file to use [default: ~/.spacecmd/config]
-u USERNAME, --username=USERNAME
use this username to connect to the server
-p PASSWORD, --password=PASSWORD
use this password to connect to the server
-s SERVER, --server=SERVER
connect to this server [default: local hostname]
--nossl use HTTP instead of HTTPS
--nohistory do not store command history
-y, --yes answer yes for all questions
-q, --quiet print only error messages
-d, --debug print debug messages (can be passed multiple times)
-h, --help show this help message and exit

As root you can access available functions without entering the spacecmd shell:

70 / 152 2.1. Configuring spacecmd | Uyuni 2024.03

 2.2. help

# spacecmd -- help

Documented commands (type help <topic>):

========================================
activationkey_addchildchannels org_trustdetails
activationkey_addconfigchannels package_details
activationkey_addentitlements package_listdependencies
activationkey_addgroups package_listerrata
activationkey_addpackages package_listinstalledsystems
activationkey_clone package_listorphans
activationkey_create package_remove
activationkey_delete package_removeorphans
activationkey_details package_search
activationkey_diff repo_addfilters
activationkey_disable repo_clearfilters
activationkey_disableconfigdeployment repo_create

...

2.2. help
List all available spacecmd commands with the help function.

Check for additional help on a specific function by calling for example:

user_create --help

Listing 1. Full List of Available Help Commands

Documented commands (type help <topic>):

========================================
activationkey_addchildchannels org_removetrust
activationkey_addconfigchannels org_rename
activationkey_addentitlements org_trustdetails
activationkey_addgroups package_details
activationkey_addpackages package_listdependencies
activationkey_clone package_listerrata
activationkey_create package_listinstalledsystems
activationkey_delete package_listorphans
activationkey_details package_remove
activationkey_diff package_removeorphans
activationkey_disable package_search
activationkey_disableconfigdeployment repo_addfilters
activationkey_enable repo_clearfilters
activationkey_enableconfigdeployment repo_create
activationkey_export repo_delete
activationkey_import repo_details
activationkey_list repo_list
activationkey_listbasechannel repo_listfilters
activationkey_listchildchannels repo_removefilters
activationkey_listconfigchannels repo_rename
activationkey_listentitlements repo_setfilters
activationkey_listgroups repo_updatessl
activationkey_listpackages repo_updateurl
activationkey_listsystems report_duplicates
activationkey_removechildchannels report_errata
activationkey_removeconfigchannels report_inactivesystems
activationkey_removeentitlements report_ipaddresses
activationkey_removegroups report_kernels
activationkey_removepackages report_outofdatesystems
activationkey_setbasechannel report_ungroupedsystems
activationkey_setconfigchannelorder scap_getxccdfscandetails

71 / 152 2.2. help | Uyuni 2024.03

 2.2. help

activationkey_setcontactmethod scap_getxccdfscanruleresults
activationkey_setdescription scap_listxccdfscans
activationkey_setuniversaldefault scap_schedulexccdfscan
activationkey_setusagelimit schedule_cancel
api schedule_details
clear schedule_getoutput
clear_caches schedule_list
configchannel_addfile schedule_listarchived
configchannel_backup schedule_listcompleted
configchannel_clone schedule_listfailed
configchannel_create schedule_listpending
configchannel_delete schedule_reschedule
configchannel_details snippet_create
configchannel_diff snippet_delete
configchannel_export snippet_details
configchannel_filedetails snippet_list
configchannel_forcedeploy snippet_update
configchannel_import softwarechannel_adderrata
configchannel_list softwarechannel_adderratabydate
configchannel_listfiles softwarechannel_addpackages
configchannel_listsystems softwarechannel_addrepo
configchannel_removefiles softwarechannel_clone
configchannel_sync softwarechannel_clonetree
configchannel_updatefile softwarechannel_create
configchannel_verifyfile softwarechannel_delete
cryptokey_create softwarechannel_details
cryptokey_delete softwarechannel_diff
cryptokey_details softwarechannel_errata_diff
cryptokey_list softwarechannel_errata_sync
custominfo_createkey softwarechannel_getorgaccess
custominfo_deletekey softwarechannel_list
custominfo_details softwarechannel_listallpackages
custominfo_listkeys softwarechannel_listbasechannels
custominfo_updatekey softwarechannel_listchildchannels
distribution_create softwarechannel_listerrata
distribution_delete softwarechannel_listerratabydate
distribution_details softwarechannel_listlatestpackages
distribution_list softwarechannel_listpackages
distribution_rename softwarechannel_listrepos
distribution_update softwarechannel_listsyncschedule
errata_apply softwarechannel_listsystems
errata_delete softwarechannel_mirrorpackages
errata_details softwarechannel_regenerateneededcache
errata_findbycve softwarechannel_regenerateyumcache
errata_list softwarechannel_removeerrata
errata_listaffectedsystems softwarechannel_removepackages
errata_listcves softwarechannel_removerepo
errata_publish softwarechannel_removesyncschedule
errata_search softwarechannel_setorgaccess
errata_summary softwarechannel_setsyncschedule
filepreservation_create softwarechannel_sync
filepreservation_delete softwarechannel_syncrepos
filepreservation_details ssm_add
filepreservation_list ssm_clear
get_apiversion ssm_intersect
get_certificateexpiration ssm_list
get_serverversion ssm_remove
get_session system_addchildchannels
group_addsystems system_addconfigchannels
group_backup system_addconfigfile
group_create system_addcustomvalue
group_delete system_addentitlements
group_details system_addnote
group_list system_applyerrata
group_listsystems system_comparepackageprofile
group_removesystems system_comparepackages
group_restore system_comparewithchannel
help system_createpackageprofile
history system_delete
kickstart_addactivationkeys system_deletenotes

72 / 152 2.2. help | Uyuni 2024.03

 2.2. help

kickstart_addchildchannels system_deletepackageprofile
kickstart_addcryptokeys system_deployconfigfiles
kickstart_addfilepreservations system_details
kickstart_addoption system_installpackage
kickstart_addpackages system_list
kickstart_addscript system_listbasechannel
kickstart_addvariable system_listchildchannels
kickstart_clone system_listconfigchannels
kickstart_create system_listconfigfiles
kickstart_delete system_listcustomvalues
kickstart_details system_listentitlements
kickstart_diff system_listerrata
kickstart_disableconfigmanagement system_listevents
kickstart_disableremotecommands system_listhardware
kickstart_enableconfigmanagement system_listinstalledpackages
kickstart_enablelogging system_listnotes
kickstart_enableremotecommands system_listpackageprofiles
kickstart_export system_listupgrades
kickstart_getcontents system_lock
kickstart_getsoftwaredetails system_reboot
kickstart_getupdatetype system_removechildchannels
kickstart_import system_removeconfigchannels
kickstart_import_raw system_removecustomvalues
kickstart_importjson system_removeentitlement
kickstart_list system_removepackage
kickstart_listactivationkeys system_rename
kickstart_listchildchannels system_runscript
kickstart_listcryptokeys system_schedulehardwarerefresh
kickstart_listcustomoptions system_schedulepackagerefresh
kickstart_listoptions system_search
kickstart_listpackages system_setbasechannel
kickstart_listscripts system_setconfigchannelorder
kickstart_listvariables system_setcontactmethod
kickstart_removeactivationkeys system_show_packageversion
kickstart_removechildchannels system_syncpackages
kickstart_removecryptokeys system_unlock
kickstart_removefilepreservations system_updatecustomvalue
kickstart_removeoptions system_upgradepackage
kickstart_removepackages toggle_confirmations
kickstart_removescript user_adddefaultgroup
kickstart_removevariables user_addgroup
kickstart_rename user_addrole
kickstart_setcustomoptions user_create
kickstart_setdistribution user_delete
kickstart_setlocale user_details
kickstart_setpartitions user_disable
kickstart_setselinux user_enable
kickstartsetupdatetype user_list
kickstart_updatevariable user_listavailableroles
list_proxies user_removedefaultgroup
login user_removegroup
logout user_removerole
org_addtrust user_setemail
org_create user_setfirstname
org_delete user_setlastname
org_details user_setpassword
org_list user_setprefix
org_listtrusts whoami
org_listusers whoamitalkingto

Miscellaneous help topics:

==========================
time systems ssm

73 / 152 2.2. help | Uyuni 2024.03

 2.3. history

2.3. history
List recent commands using the history command.

spacecmd {SSM:0}> history

1 help
2 api
3 exit
4 help
5 time --help
6 quit
7 clear
spacecmd {SSM:0}>

2.4. Troubleshooting spacecmd

This section provides troubleshooting solutions when working with spacecmd

2.4.1. Creating a distribution wiere spacecmd sets localhost instead of FQDN

Situation
When creating a distribution with spacecmd it will automatically set localhost as the server name
instead of the FQDN of Uyuni. This will result in the following kernel option being written:

install=[Link]

Resolution
Set the FQDN in $HOME/.spacecmd/config like the following:

test:~/.spacecmd # cat config

[spacecmd]
server=[Link]
username=admin
password=password
nossl=0

Cause
This problem may be experienced if $HOME/.spacecmd/config has been created and the
server name option was set to localhost.

2.4.2. spacecmd not accepting commands or options

When running spacecmd non-interactively:

• you must escape arguments passed to the command.

• always put -- before arguments, to avoid them being treated as global arguments.

74 / 152 2.3. history | Uyuni 2024.03

 2.5. spacecmd Functions

• make sure you escape any quotes that you pass to the functions so that they are not interpreted.

An example of a well-formed spacecmd command:

spacecmd -s server1 -- softwarechannel_create -n \'My Channel\' -l channel1

-a x86_64

2.4.3. spacecmd caching problems

The spacecmd command keeps a cache of the various systems and packages that you have installed.
Sometimes, this can result in a mismatch between the system name and the system ID.

To clear the spacecmd cache, use this command:

spacecmd clear_caches

2.5. spacecmd Functions

The following sections provide descriptions for all documented spacecmd commands. Each command is
grouped by the function prefix. Keep in mind that all commands may also be called using scripts and
passed to spacecmd as stand-alone commands.

2.5.1. activationkey
The following spacecmd commands are available for use with activation keys.

[Link]. activationkey_addchildchannels

Add child channels to an activation key.

usage: activationkey_addchildchannels KEY <CHANNEL ...>

[Link]. activationkey_addconfigchannels

Add configuration channels to an activation key.

usage: activationkey_addconfigchannels KEY <CHANNEL ...> [options]

options:
-t add channels to the top of the list
-b add channels to the bottom of the list

[Link]. activationkey_addentitlements

Add available entitlements to an activation key.

75 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: activationkey_addentitlements KEY <ENTITLEMENT ...>

In the WebUI entitlements are known as System Types. Nevertheless the

 spacecmd backend still utilizes the entitlements term. Therefore any scripts you
may be using can remain unchanged.

[Link]. activationkey_addgroups

Add existing groups to an activation key.

usage: activationkey_addgroups KEY <GROUP ...>

[Link]. activationkey_addpackages

Add packages to an activation key.

usage: activationkey_addpackages KEY <PACKAGE ...>

[Link]. activationkey_clone

Clone an existing activation key.

usage examples:
activationkey_clone foo_key -c bar_key
activationkey_clone foo_key1 foo_key2 -c prefix
activationkey_clone foo_key -x "s/foo/bar"
activationkey_clone foo_key1 foo_key2 -x "s/foo/bar"

options:
-c CLONE_NAME : Name of the resulting key, treated as a prefix for
multiple
keys
-x "s/foo/bar" : Optional regex replacement, replaces foo with bar in the
clone description, base-channel label, child-channel
labels, config-channel names

[Link]. activationkey_create

Create a new activation key.

usage: activationkey_create [options]

options:
-n NAME
-d DESCRIPTION
-b BASE_CHANNEL
-u set key as universal default
-e [enterprise_entitled,virtualization_host]

76 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. activationkey_delete

Delete an existing activation key.

usage: activationkey_delete KEY

[Link]. activationkey_details

Show details of an existing activation key.

usage: activationkey_details KEY ...

[Link]. activationkey_diff

Check the difference between two activation keys.

usage: activationkey_diff SOURCE_ACTIVATIONKEY TARGET_ACTIVATIONKEY

[Link]. activationkey_disable

Disable an existing activation key.

usage: activationkey_disable KEY [KEY ...]

[Link]. activationkey_disableconfigdeployment

Disable configuration channel deployment for an existing activation key.

usage: activationkey_disableconfigdeployment KEY

[Link]. activationkey_enable

Enable an existing activation key.

usage: activationkey_enable KEY [KEY ...]

[Link]. activationkey_enableconfigdeployment

Enable configuration channel deployment for an existing activation key.

usage: activationkey_enableconfigdeployment KEY

77 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. activationkey_export

Export activation keys to a JSON formatted file.

usage: activationkey_export [options] [<KEY> ...]

options:
-f [Link] : specify an output filename, defaults to <KEY>.json
if exporting a single key, [Link] for multiple
keys,
or akey_all.json if no KEY specified (export ALL)

Note : KEY list is optional, default is to export ALL keys

[Link]. activationkey_import

Import activation keys from JSON files

usage: activationkey_import <JSONFILE ...>

[Link]. activationkey_list

List all existing activation keys.

usage: activationkey_list

[Link]. activationkey_listbasechannel

List the base channel associated with an activation key.

usage: activationkey_listbasechannel KEY

[Link]. activationkey_listchildchannels

List child channels associated with an activation key.

usage: activationkey_listchildchannels KEY

[Link]. activationkey_listconfigchannels

List configuration channels associated with an activation key.

usage: activationkey_listconfigchannels KEY

78 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. activationkey_listentitlements

List entitlements associated with an activation key.

usage: activationkey_listentitlements KEY

[Link]. activationkey_listgroups

List groups associated with an activation key

usage: activationkey_listgroups KEY

[Link]. activationkey_listpackages

List packages associated with an activation key.

usage: activationkey_listpackages KEY

[Link]. activationkey_listsystems

List systems registered with an activation key.

usage: activationkey_listsystems KEY

[Link]. activationkey_removechildchannels

Remove child channels from an activation key.

usage: activationkey_removechildchannels KEY <CHANNEL ...>

[Link]. activationkey_removeconfigchannels

Remove configuration channels from an activation key.

usage: activationkey_removeconfigchannels KEY <CHANNEL ...>

[Link]. activationkey_removeentitlements

Remove entitlements from an activation key.

usage: activationkey_removeentitlements KEY <ENTITLEMENT ...>

79 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. activationkey_removegroups

Remove groups from an activation key.

usage: activationkey_removegroups KEY <GROUP ...>

[Link]. activationkey_removepackages

Remove packages from an activation key.

usage: activationkey_removepackages KEY <PACKAGE ...>

[Link]. activationkey_setbasechannel

Set the base channel for an activation key.

usage: activationkey_setbasechannel KEY CHANNEL

[Link]. activationkey_setconfigchannelorder

Set the ranked order of configuration channels.

usage: activationkey_setconfigchannelorder KEY

[Link]. activationkey_setcontactmethod

Set the contact method to use for systems registered with a specific key. (Use the XML-RPC API to
access the latest contact methods.)

usage: activationkey_setcontactmethod KEY CONTACT_METHOD

[Link]. activationkey_setdescription

Add a description for an activation key.

usage: activationkey_setdescription KEY DESCRIPTION

[Link]. activationkey_setuniversaldefault

Set a specific key as the universal default.

usage: activationkey_setuniversaldefault KEY

80 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

 Using a universal default key is not a Best Practice recommendation.

2.5.2. api
The following API command and its options are available for calling the XML-RPC API directly. Calling
the API directly allows you to use the latest features in SUSE Manager from the command-line using
spacecmd as a wrapper for stand-alone commands or used from within scripts.

To gain access to the latest feature additions call api [Link] from within spacecmd
to list all currently available API commands formatted in json.

[Link]. api_

Call XML-RPC API with arguments directly.

usage: api [options] API_STRING

options:
-A, --args Arguments for the API other than session id in comma separated
strings or JSON expression
-F, --format Output format
-o, --output Output file

examples:
api [Link]
api --args "sysgroup_A" [Link]
api -A "rhel-i386-server-5,2011-04-01,2011-05-01" -F "%(name)s" \
[Link]

2.5.3. clear
Clears the terminal screen.

2.5.4. clear_caches
Clear the internal caches kept for systems and packages.

usage: clear_caches

2.5.5. configchannel
The following spacecmd commands are available for use with configuration channels.

[Link]. configchannel_addfile

Creates a configuration file.

81 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: configchannel_addfile [CHANNEL] [options]

options:
-c CHANNEL
-p PATH
-r REVISION
-o OWNER [default: root]
-g GROUP [default: root]
-m MODE [defualt: 0644]
-x SELINUX_CONTEXT
-d path is a directory
-s path is a symlink
-b path is a binary (or other file which needs base64 encoding)
-t SYMLINK_TARGET
-f local path to file contents

Note re binary/base64: Some text files, notably those containing trailing

newlines, those containing ASCII escape characters (or other charaters not
allowed in XML) need to be sent as binary (-b). Some effort is made to
auto-
detect files which require this, but you may need to explicitly specify.

[Link]. configchannel_backup

Backup a configuration channel.

usage: configchannel_backup CHANNEL [OUTDIR]

OUTDIR defaults to $HOME/spacecmd-backup/configchannel/YYYY-MM-DD/CHANNEL

[Link]. configchannel_clone

Clone configuration channels.

usage examples:
configchannel_clone foo_label -c bar_label
configchannel_clone foo_label1 foo_label2 -c prefix
configchannel_clone foo_label -x "s/foo/bar"
configchannel_clone foo_label1 foo_label2 -x "s/foo/bar"

options:
-c CLONE_LABEL : name/label of the resulting cc (note does not update
description, see -x option), treated as a prefix if
multiple keys are passed
-x "s/foo/bar" : Optional regex replacement, replaces foo with bar in the
clone name, label and description
Note : If no -c or -x option is specified, interactive is assumed

[Link]. configchannel_create

Create a configuration channel.

82 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: configchannel_create [options]

options:
-n NAME
-l LABEL
-d DESCRIPTION

[Link]. configchannel_delete

Delete a configuration channel.

usage: configchannel_delete CHANNEL ...

[Link]. configchannel_details

Show the details of a configuration channel.

usage: configchannel_details CHANNEL ...

[Link]. configchannel_diff

Find differences between configuration channels.

usage: configchannel_diff SOURCE_CHANNEL TARGET_CHANNEL

[Link]. configchannel_export

Export configuration channels to a json formatted file.

usage: configchannel_export <CHANNEL>... [options]

options:
-f [Link] : specify an output filename, defaults to <CHANNEL>.json
if exporting a single channel, [Link] for multiple
channels, or cc_all.json if no CHANNEL specified
e.g (export ALL)

Note : CHANNEL list is optional, default is to export ALL

[Link]. configchannel_filedetails

Show the details of a file in a configuration channel.

usage: configchannel_filedetails CHANNEL FILE [REVISION]

83 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. configchannel_forcedeploy

Forces a redeployment of files within a channel on all subscribed systems.

usage: configchannel_forcedeploy CHANNEL

[Link]. configchannel_import

Import configuration channels from a json file.

usage: configchannel_import <JSONFILES...>

[Link]. configchannel_list

List all configuration channels.

usage: configchannel_list

[Link]. configchannel_listfiles

List all files in a configuration channel.

usage: configchannel_listfiles CHANNEL ...

[Link]. configchannel_listsystems

List all systems subscribed to a configuration channel.

usage: configchannel_listsystems CHANNEL

[Link]. configchannel_removefiles

Remove configuration files.

usage: configchannel_removefile CHANNEL <FILE ...>

[Link]. configchannel_sync

Sync configuration files between two configuration channels.

usage: configchannel_sync SOURCE_CHANNEL TARGET_CHANNEL

84 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. configchannel_updatefile

Update a configuration file.

usage: configchannel_updatefile CHANNEL FILE

[Link]. configchannel_verifyfile

Verify a configuration file.

usage: configchannel_verifyfile CHANNEL FILE <SYSTEMS>

<SYSTEMS> may be substituted with any of the following targets:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

2.5.6. cryptokey
The following spacecmd commands are available for use with cryptographic keys.

[Link]. cryptokey_create

Create a cryptographic key.

usage: cryptokey_create [options]

options:
-t GPG or SSL
-d DESCRIPTION
-f KEY_FILE

[Link]. cryptokey_delete

Delete a cryptographic key.

usage: cryptokey_delete NAME

[Link]. cryptokey_details

Show the contents of a cryptographic key.

usage: cryptokey_details KEY ...

85 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. cryptokey_list

List all cryptographic keys (SSL, GPG).

usage: cryptokey_list

2.5.7. custominfo
The following spacecmd commands are available for working with custom keys.

[Link]. custominfo_createkey

Create a custom key.

usage: custominfo_createkey [NAME] [DESCRIPTION]

[Link]. custominfo_deletekey

Delete a custom key.

usage: custominfo_deletekey KEY ...

[Link]. custominfo_details

Show the details of a custom key.

usage: custominfo_details KEY ...

[Link]. custominfo_listkeys

List all custom keys.

usage: custominfo_listkeys

[Link]. custominfo_updatekey

Update a custom key.

usage: custominfo_updatekey [NAME] [DESCRIPTION]

86 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

2.5.8. distribution
The following spacecmd commands are available for working with kickstart distributions.

[Link]. distribution_create

Create a Kickstart tree.

usage: distribution_create [options]

options:
-n NAME
-p path to tree
-b base channel to associate with
-t install type [fedora|rhel_4/5/6|suse|generic_rpm]

[Link]. distribution_delete

Delete a Kickstart tree.

usage: distribution_delete LABEL

[Link]. distribution_details

Show the details of a Kickstart tree.

usage: distribution_details LABEL

[Link]. distribution_list

List the available autoinstall trees.

usage: distribution_list

[Link]. distribution_rename

Rename a Kickstart tree.

usage: distribution_rename OLDNAME NEWNAME

[Link]. distribution_update

Update the path of a Kickstart tree.

87 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: distribution_update NAME [options]

options:
-p path to tree
-b base channel to associate with
-t install type [fedora|rhel_4/5/6|suse|generic_rpm]

2.5.9. errata
The following spacecmd commands are available for use with errata data.

[Link]. errata_apply

Apply an patch to all affected systems.

usage: errata_apply ERRATA|search:XXX ...

[Link]. errata_delete

Delete an patch.

usage: errata_delete ERRATA|search:XXX ...

[Link]. errata_details

Show the details of an patch.

usage: errata_details ERRATA|search:XXX ...

[Link]. errata_findbycve

List errata addressing a CVE.

usage: errata_findbycve CVE-YYYY-NNNN ...

[Link]. errata_list

List all patches.

usage: errata_list

88 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. errata_listaffectedsystems

List of systems affected by an patch.

usage: errata_listaffectedsystems ERRATA|search:XXX ...

[Link]. errata_listcves

List of CVEs addressed by an patch.

usage: errata_listcves ERRATA|search:XXX ...

[Link]. errata_publish

Publish a patch to a channel.

usage: errata_publish ERRATA|search:XXX <CHANNEL ...>

[Link]. errata_search

List patches that meet user provided criteria

usage: errata_search CVE|RHSA|RHBA|RHEA|CLA ...

Example:
> errata_search CVE-2009:1674
> errata_search RHSA-2009:1674

[Link]. errata_summary

Print a summary of all errata.

usage: errata_summary

2.5.10. filepreservation
The following spacecmd commands are available for working with kickstart file preservation lists.

[Link]. filepreservation_create

Create a file preservation list.

usage: filepreservation_create [NAME] [FILE ...]

89 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. filepreservation_delete

Delete a file preservation list.

filepreservation_delete NAME

[Link]. filepreservation_details

Show the details of a file preservation list.

usage: filepreservation_details NAME

[Link]. filepreservation_list

List all file preservations.

usage: filepreservation_list

2.5.11. get
The following spacecmd commands are available for use with get.

[Link]. get_apiversion

Display the API version of the server.

usage: get_apiversion

[Link]. get_certificateexpiration

Print the expiration date of the server’s entitlement certificate.

usage: get_certificateexpiration

[Link]. get_serverversion

Display SUSE Manager server version.

usage: get_serverversion

90 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. get_session

Show the current session string.

usage: get_session

2.5.12. group

[Link]. group_addsystems

Add systems to a group.

usage: group_addsystems GROUP <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. group_backup

Backup a system group.

usage: group_backup NAME [OUTDIR]

OUTDIR defaults to $HOME/spacecmd-backup/group/YYYY-MM-DD/NAME

[Link]. group_create

Create a system group.

usage: group_create [NAME] [DESCRIPTION]

[Link]. group_delete

Delete a system group.

usage: group_delete NAME ...

[Link]. group_details

Show the details of a system group.

91 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: group_details GROUP ...

[Link]. group_list

List available system groups.

usage: group_list

[Link]. group_listsystems

List the members of a group.

usage: group_listsystems GROUP

[Link]. group_removesystems

Remove systems from a group.

usage: group_removesystems GROUP <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. group_restore

Restore a system group.

usage: group_backup INPUTDIR [NAME] ...

2.5.13. kickstart
The following spacecmd functions are available for use with kickstart.

[Link]. kickstart_addactivationkeys

Add activation keys to a Kickstart profile.

usage: kickstart_addactivationkeys PROFILE <KEY ...>

92 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. kickstart_addchildchannels

Add a child channels to a Kickstart profile.

usage: kickstart_addchildchannels PROFILE <CHANNEL ...>

[Link]. kickstart_addcryptokeys

Add cryptography keys to a Kickstart profile.

usage: kickstart_addcryptokeys PROFILE <KEY ...>

[Link]. kickstart_addfilepreservations

Add file preservations to a Kickstart profile.

usage: kickstart_addfilepreservations PROFILE <FILELIST ...>

[Link]. kickstart_addoption

Set an option for a Kickstart profile.

usage: kickstart_addoption PROFILE KEY [VALUE]

[Link]. kickstart_addpackages

Add packages to a Kickstart profile.

usage: kickstart_addpackages PROFILE <PACKAGE ...>

[Link]. kickstart_addscript

Add a script to a Kickstart profile.

usage: kickstart_addscript PROFILE [options]

options:
-p PROFILE
-e EXECUTION_TIME ['pre', 'post']
-i INTERPRETER
-f FILE
-c execute in a chroot environment
-t ENABLING_TEMPLATING

93 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. kickstart_addvariable

Add a variable to a Kickstart profile.

usage: kickstart_addvariable PROFILE KEY VALUE

[Link]. kickstart_clone

Clone a Kickstart profile.

usage: kickstart_clone [options]

options:
-n NAME
-c CLONE_NAME

[Link]. kickstart_create

Create a Kickstart profile.

usage: kickstart_create [options]

options:
-n NAME
-d DISTRIBUTION
-p ROOT_PASSWORD
-v VIRT_TYPE ['none', 'para_host', 'qemu', 'xenfv', 'xenpv']

[Link]. kickstart_delete

Delete kickstart profiles.

usage: kickstart_delete PROFILE

usage: kickstart_delete PROFILE1 PROFILE2
usage: kickstart_delete "PROF*"

[Link]. kickstart_details

Show the details of a Kickstart profile.

usage: kickstart_details PROFILE

[Link]. kickstart_diff

List differences between two kickstart files.

94 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: kickstart_diff SOURCE_CHANNEL TARGET_CHANNEL

[Link]. kickstart_disableconfigmanagement

Disable configuration management on a Kickstart profile.

usage: kickstart_disableconfigmanagement PROFILE

[Link]. kickstart_disableremotecommands

Disable remote commands on a Kickstart profile.

usage: kickstart_disableremotecommands PROFILE

[Link]. kickstart_enableconfigmanagement

Enable configuration management on a Kickstart profile.

usage: kickstart_enableconfigmanagement PROFILE

[Link]. kickstart_enablelogging

Enable logging for a Kickstart profile.

usage: kickstart_enablelogging PROFILE

[Link]. kickstart_enableremotecommands

Enable remote commands on a Kickstart profile.

usage: kickstart_enableremotecommands PROFILE

[Link]. kickstart_export

Export kickstart profiles to json formatted file.

95 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: kickstart_export <KSPROFILE>... [options]

options:
-f [Link] : specify an output filename, defaults to
<KSPROFILE>.json
if exporting a single kickstart, [Link] for
multiple
kickstarts, or ks_all.json if no KSPROFILE specified
e.g (export ALL)

Note : KSPROFILE list is optional, default is to export ALL

[Link]. kickstart_getcontents

Show the contents of a Kickstart profile as they would be presented to a client.

usage: kickstart_getcontents LABEL

[Link]. kickstart_getsoftwaredetails

Gets kickstart profile software details.

usage: kickstart_getsoftwaredetails KS_LABEL

usage: kickstart_getsoftwaredetails KS_LABEL KS_LABEL2 ...

[Link]. kickstart_getupdatetype

Get the update type for a kickstart profiles.

usage: kickstart_getupdatetype PROFILE

usage: kickstart_getupdatetype PROFILE1 PROFILE2
usage: kickstart_getupdatetype "PROF*"

[Link]. kickstart_import

Import a Kickstart profile from a file.

usage: kickstart_import [options]

options:
-f FILE
-n NAME
-d DISTRIBUTION
-v VIRT_TYPE ['none', 'para_host', 'qemu', 'xenfv', 'xenpv']

[Link]. kickstart_import_raw

Import a raw Kickstart or AutoYaST profile from a file.

96 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: kickstart_import_raw [options]

options:
-f FILE
-n NAME
-d DISTRIBUTION
-v VIRT_TYPE ['none', 'para_host', 'qemu', 'xenfv', 'xenpv']

[Link]. kickstart_importjson

Import kickstart profiles from json file.

usage: kickstart_import <JSONFILES...>

[Link]. kickstart_list

List the available Kickstart profiles.

usage: kickstart_list

[Link]. kickstart_listactivationkeys

List the activation keys associated with a Kickstart profile.

usage: kickstart_listactivationkeys PROFILE

[Link]. kickstart_listchildchannels

List the child channels of a Kickstart profile.

usage: kickstart_listchildchannels PROFILE

[Link]. kickstart_listcryptokeys

List the crypto keys associated with a Kickstart profile.

usage: kickstart_listcryptokeys PROFILE

[Link]. kickstart_listcustomoptions

List the custom options of a Kickstart profile.

usage: kickstart_listcustomoptions PROFILE

97 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. kickstart_listoptions

List the options of a Kickstart profile.

usage: kickstart_listoptions PROFILE

[Link]. kickstart_listpackages

List the packages for a Kickstart profile.

usage: kickstart_listpackages PROFILE

[Link]. kickstart_listscripts

List the scripts for a Kickstart profile.

usage: kickstart_listscripts PROFILE

[Link]. kickstart_listvariables

List the variables of a Kickstart profile.

usage: kickstart_listvariables PROFILE

[Link]. kickstart_removeactivationkeys

Remove activation keys from a Kickstart profile.

usage: kickstart_removeactivationkeys PROFILE <KEY ...>

[Link]. kickstart_removechildchannels

Remove child channels from a Kickstart profile.

usage: kickstart_removechildchannels PROFILE <CHANNEL ...>

[Link]. kickstart_removecryptokeys

Remove crypto keys from a Kickstart profile.

usage: kickstart_removecryptokeys PROFILE <KEY ...>

98 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. kickstart_removefilepreservations

Remove file preservations from a Kickstart profile.

usage: kickstart_removefilepreservations PROFILE <FILE ...>

[Link]. kickstart_removeoptions

Remove options from a Kickstart profile.

usage: kickstart_removeoptions PROFILE <OPTION ...>

[Link]. kickstart_removepackages

Remove packages from a Kickstart profile.

usage: kickstart_removepackages PROFILE <PACKAGE ...>

[Link]. kickstart_removescript

Add a script to a Kickstart profile.

usage: kickstart_removescript PROFILE [ID]

[Link]. kickstart_removevariables

Remove variables from a Kickstart profile.

usage: kickstart_removevariables PROFILE <KEY ...>

[Link]. kickstart_rename

Rename a Kickstart profile

usage: kickstart_rename OLDNAME NEWNAME

[Link]. kickstart_setcustomoptions

Set custom options for a Kickstart profile.

usage: kickstart_setcustomoptions PROFILE

99 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. kickstart_setdistribution

Set the distribution for a Kickstart profile.

usage: kickstart_setdistribution PROFILE DISTRIBUTION

[Link]. kickstart_setlocale

Set the locale for a Kickstart profile.

usage: kickstart_setlocale PROFILE LOCALE

[Link]. kickstart_setpartitions

Set the partitioning scheme for a Kickstart profile.

usage: kickstart_setpartitions PROFILE

[Link]. kickstart_setselinux

Set the SELinux mode for a Kickstart profile.

usage: kickstart_setselinux PROFILE MODE

[Link]. kickstartsetupdatetype

Set the update type for a kickstart profiles.

usage: kickstartsetupdatetype [options] KS_LABEL

options:
-u UPDATE_TYPE ['red_hat', 'all', 'none']

[Link]. kickstart_updatevariable

Update a variable in a Kickstart profile.

usage: kickstart_updatevariable PROFILE KEY VALUE

2.5.14. list_proxies
The following spacecmd function is available for listing proxies.

100 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. list_proxies

List the proxies within the user’s organization.

usage: list_proxies

2.5.15. login
Connect as a specific user to the SUSE manager server.

# spacecmd -- login <USERNAME>

2.5.16. logout
Logout from server as the current user.

# spacecmd -- logout

2.5.17. org
The following spacecmd functions are available for use with organizations.

[Link]. org_addtrust

Add a trust between two organizations

usage: org_addtrust YOUR_ORG ORG_TO_TRUST

[Link]. org_create

Create an organization.

usage: org_create [options]

options:
-n ORG_NAME
-u USERNAME
-P PREFIX (Dr., Mr., Miss, Mrs., Ms.)
-f FIRST_NAME
-l LAST_NAME
-e EMAIL
-p PASSWORD
--pam enable PAM authentication

101 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. org_createfirst

Create the initial organization and admin user after completing the installation.

usage: org_createfirst [options]

options:
-n ORG_NAME
-u USERNAME
-f FIRST_NAME
-l LAST_NAME
-e EMAIL
-p PASSWORD

[Link]. org_delete

Delete an organization.

usage: org_delete NAME

[Link]. org_details

Show the details of an organization.

usage: org_details NAME

[Link]. org_list

List all organizations.

usage: org_list

[Link]. org_listtrusts

List an organization’s trusts.

org_listtrusts NAME

[Link]. org_listusers

List an organization’s users.

org_listusers NAME

102 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. org_removetrust

Remove a trust between two organizations.

usage: org_removetrust YOUR_ORG TRUSTED_ORG

[Link]. org_rename

Rename an organization.

usage: org_rename OLDNAME NEWNAME

[Link]. org_trustdetails

Show the details of an organizational trust.

usage: org_trustdetails TRUSTED_ORG

2.5.18. package
The following spacecmd functions are available for working with packages.

[Link]. package_details

Show the details of a software package.

usage: package_details PACKAGE ...

[Link]. package_listdependencies

List the dependencies for a package.

usage: package_listdependencies PACKAGE

[Link]. package_listerrata

List the errata that provide this package.

usage: package_listerrata PACKAGE ...

103 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. package_listinstalledsystems

List the systems with a package installed.

usage: package_listinstalledsystems PACKAGE ...

[Link]. package_listorphans

List packages that are not in a channel.

usage: package_listorphans

[Link]. package_remove

Remove a package from SUSE Manager/Satellite

usage: package_remove PACKAGE ...

[Link]. package_removeorphans

Remove packages that are not in a channel.

usage: package_removeorphans

[Link]. package_search

Find packages that meet the given criteria.

usage: package_search NAME|QUERY

Example: package_search kernel

Advanced Search

Available Fields: name, epoch, version, release, arch, description, summary

Example: name:kernel AND version:2.6.18 AND -description:devel

2.5.19. proxy_container_config
The following spacecmd functions are available for use with proxy container configuration

104 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. proxy_container_config_generate_cert

Create Uyuni Proxy container configuration and generate new SSL server certificate for it.

usage: proxy_container_config_generate_cert PROXY_FQDN PARENT_FQDN MAX_CACHE

EMAIL

parameters:
PROXY_FQDN the fully qualified domain name of the proxy to create.
PARENT_FQDN the fully qualified domain name of the server or another proxy
to connect to.
MAX_CACHE the maximum cache size in MB. 60% of the storage is a good
value.
EMAIL the email of the proxy administrator

options:
-o, --output Path where to create the generated configuration. Default:
'[Link]'
-p, --ssh-port SSH port the proxy listens one. Default: 22
--ca-crt path to the certificate of the CA to use to generate a new proxy
certificate.
Using /root/ssl-build/RHN-ORG-TRUSTED-SSL-CERT by default.
--ca-key path to the private key of the CA to use to generate a new proxy
certificate.
Using /root/ssl-build/RHN-ORG-PRIVATE-SSL-KEY by default.
--ca-pass path to a file containing the password of the CA private key,
will be prompted if not passed.
--ssl-cname alternate name of the proxy to set in the certificate. Can be
provided multiple times
--ssl-country country code to set in the certificate. If omitted, default
values from mgr-ssl-tool will be used.
--ssl-state state name to set in the certificate. If omitted, default
values from mgr-ssl-tool will be used.
--ssl-city the city name to set in the certificate. If omitted, default
values from mgr-ssl-tool will be used.
--ssl-org the organization name to set in the certificate. If omitted,
default values from mgr-ssl-tool will be used.
--ssl-org-unit the organization unit name to set in the certificate. If
omitted, default values from mgr-ssl-tool will be used.
--ssl-email the email to set in the certificate. If omitted, default values
from mgr-ssl-tool will be used.

[Link]. proxy_container_config

Create Uyuni Proxy container configuration and use already existing SSL server certificate.

105 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: proxy_container_config [options] PROXY_FQDN PARENT_FQDN MAX_CACHE

EMAIL ROOT_CA CRT KEY

parameters:
PROXY_FQDN the fully qualified domain name of the proxy to create.
PARENT_FQDN the fully qualified domain name of the server or another proxy
to connect to.
MAX_CACHE the maximum cache size in MB. 60% of the storage is a good
value.
EMAIL the email of the proxy administrator
CA path to the root CA used to sign the proxy certificate in PEM
format
CRT path to the proxy certificate in PEM format
KEY path to the proxy certificate private key in PEM format

options:
-o, --output Path where to create the generated configuration. Default:
'[Link]'
-p, --ssh-port SSH port the proxy listens one. Default: 22
-i, --intermediate-ca Path to an intermediate CA used to sign the proxy
certicate in PEM format. May be provided multiple times.

2.5.20. repo
The following spacecmd functions are available for working with repositories.

[Link]. repo_addfilters

Add filters for a user repository.

usage: repo_addfilters repo <filter ...>

[Link]. repo_clearfilters

Clears the filters for a user repository.

usage: repo_clearfilters repo

[Link]. repo_create

Create a user repository.

usage: repo_create <options>

options:
-n, --name name of repository
-u, --url url of repository

--ca SSL CA certificate (not required)

--cert SSL Client certificate (not required)
--key SSL Client key (not required)

106 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. repo_delete

Delete a user repository.

usage: repo_delete <repo ...>

[Link]. repo_details

Show the details of a user repository.

usage: repo_details <repo ...>

[Link]. repo_list

List all available user repository.

usage: repo_list

[Link]. repo_listfilters

Show the filters for a user repository.

usage: repo_listfilters repo

===repo_removefilters

Remove filters from a user repository.

usage: repo_removefilters repo <filter ...>

[Link]. repo_rename

Rename a user repository.

usage: repo_rename OLDNAME NEWNAME

[Link]. repo_setfilters

Set the filters for a user repo.

usage: repo_setfilters repo <filter ...>

107 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. repo_updatessl

Change the SSL certificates of a user repository.

usage: repo_updatessl <options>

options:
--ca SSL CA certificate (not required)
--cert SSL Client certificate (not required)
--key SSL Client key (not required)

[Link]. repo_updateurl

Change the URL of a user repository.

usage: repo_updateurl <repo> <url>

2.5.21. report
The following spacecmd functions are available for working with reports.

[Link]. report_duplicates

List duplicate system profiles.

usage: report_duplicates

[Link]. report_errata

List all errata and how many systems they affect.

usage: report_errata [ERRATA|search:XXX ...]

[Link].1. report_inactivesystems

List all inactive systems.

usage: report_inactivesystems [DAYS]

[Link]. report_ipaddresses

List the hostname and IP of each system.

108 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: report_network [<SYSTEMS>]

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. report_kernels

List the running kernel of each system.

usage: report_kernels [<SYSTEMS>]

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. report_outofdatesystems

List all out-of-date systems.

usage: report_outofdatesystems

[Link]. report_ungroupedsystems

List all ungrouped systems.

usage: report_ungroupedsystems

2.5.22. scap
The following spacecmd functions are available for working with OpenSCAP.

[Link]. scap_getxccdfscandetails

Get details of given OpenSCAP XCCDF scan.

usage: scap_getxccdfscandetails <XID>

[Link]. scap_getxccdfscanruleresults

Return a full list of RuleResults for given OpenSCAP XCCDF scan.

109 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: scap_getxccdfscanruleresults <XID>

[Link]. scap_listxccdfscans

Return a list of finished OpenSCAP scans for given systems.

usage: scap_listxccdfscans <SYSTEMS>

[Link]. scap_schedulexccdfscan

Schedule Scap XCCDF scan.

usage: scap_schedulexccdfscan PATH_TO_XCCDF_FILE XCCDF_OPTIONS SYSTEMS

Example:
> scap_schedulexccdfscan '/usr/share/openscap/[Link]'
'profile Web-Default' \
[Link]

2.5.23. schedule
The following spacecmd functions are available for working with scheduling.

[Link]. schedule_cancel

Cancel a scheduled action.

usage: schedule_cancel ID|* ...

[Link]. schedule_details

Show the details of a scheduled action.

usage: schedule_details ID

[Link]. schedule_getoutput

Show the output from an action.

usage: schedule_getoutput ID

110 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. schedule_list

List all actions.

usage: schedule_list [BEGINDATE] [ENDDATE]

Dates can be any of the following:

Explicit Dates:
Dates can be expressed as explicit date strings in the YYYYMMDD[HHMM] format.
The year, month and day are required, while the hours and minutes are not;
the hours and minutes will default to 0000 if no values are provided.

Deltas:
Dates can be expressed as delta values. For example, '2h' would mean 2 hours
in the future. You can also use negative values to express times in the past
(e.g., -7d would be one week ago).

Units:
s -> seconds
m -> minutes
h -> hours
d -> days

[Link]. schedule_listarchived

List archived actions.

usage: schedule_listarchived [BEGINDATE] [ENDDATE]

Dates can be any of the following:

Explicit Dates:
Dates can be expressed as explicit date strings in the YYYYMMDD[HHMM] format.
The year, month and day are required, while the hours and minutes are not;
the hours and minutes will default to 0000 if no values are provided.

Deltas:
Dates can be expressed as delta values. For example, '2h' would mean 2 hours
in the future. You can also use negative values to express times in the past
(e.g., -7d would be one week ago).

Units:
s -> seconds
m -> minutes
h -> hours
d -> days

[Link]. schedule_listcompleted

List completed actions.

111 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

Dates can be any of the following:

Explicit Dates:
Dates can be expressed as explicit date strings in the YYYYMMDD[HHMM] format.
The year, month and day are required, while the hours and minutes are not;
the hours and minutes will default to 0000 if no values are provided.

Deltas:
Dates can be expressed as delta values. For example, '2h' would mean 2 hours
in the future. You can also use negative values to express times in the past
(e.g., -7d would be one week ago).

Units:
s -> seconds
m -> minutes
h -> hours
d -> days

[Link]. schedule_listfailed

List failed actions.

usage: schedule_listfailed [BEGINDATE] [ENDDATE]

Dates can be any of the following:

Explicit Dates:
Dates can be expressed as explicit date strings in the YYYYMMDD[HHMM] format.
The year, month and day are required, while the hours and minutes are not;
the hours and minutes will default to 0000 if no values are provided.

Deltas:
Dates can be expressed as delta values. For example, '2h' would mean 2 hours
in the future. You can also use negative values to express times in the past
(e.g., -7d would be one week ago).

Units:
s -> seconds
m -> minutes
h -> hours
d -> days

[Link]. schedule_listpending

List pending actions.

112 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: schedule_listpending [BEGINDATE] [ENDDATE]

Dates can be any of the following:

Explicit Dates:
Dates can be expressed as explicit date strings in the YYYYMMDD[HHMM] format.
The year, month and day are required, while the hours and minutes are not;
the hours and minutes will default to 0000 if no values are provided.

Deltas:
Dates can be expressed as delta values. For example, '2h' would mean 2 hours
in the future. You can also use negative values to express times in the past
(e.g., -7d would be one week ago).

Units:
s -> seconds
m -> minutes
h -> hours
d -> days

[Link]. schedule_reschedule::

Reschedule failed actions.

usage: schedule_reschedule ID|* ...

2.5.24. snippet
The following spacecmd functions are available for working with Kickstart snippets.

[Link]. snippet_create

Create a Kickstart snippet

usage: snippet_create [options]

options:
-n NAME
-f FILE

[Link]. snippet_delete

Delete a Kickstart snippet.

usage: snippet_removefile NAME

[Link]. snippet_details

Show the contents of a snippet.

usage: snippet_details SNIPPET ...

113 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. snippet_list

List the available Kickstart snippets.

usage: snippet_list

[Link]. snippet_update

Update a Kickstart snippet.

usage: snippet_update NAME

2.5.25. softwarechannel
The following spacecmd functions are available for working with software channels.

[Link]. softwarechannel_adderrata

Add patches from one channel into another channel.

usage: softwarechannel_adderrata SOURCE DEST <ERRATA|search:XXX ...>

Options:
-q/--quick : Don't display list of packages (slightly faster)
-s/--skip : Skip errata which appear to exist already in DEST

[Link]. softwarechannel_adderratabydate

Add errata from one channel into another channel based on a date range.

usage: softwarechannel_adderratabydate [options] SOURCE DEST BEGINDATE

ENDDATE
Date format : YYYYMMDD
Options:
-p/--publish : Publish errata to the channel (don't clone)

[Link]. softwarechannel_addpackages

Add packages to a software channel.

usage: softwarechannel_addpackages CHANNEL <PACKAGE ...>

[Link]. softwarechannel_addrepo

Add a repo to a software channel.

114 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: softwarechannel_addrepo CHANNEL REPO

[Link]. softwarechannel_clone

Clone a software channel.

usage: softwarechannel_clone [options]

options:
-s SOURCE_CHANNEL
-n NAME
-l LABEL
-p PARENT_CHANNEL
--gpg-copy/-g (copy SOURCE_CHANNEL GPG details)
--gpg-url GPG_URL
--gpg-id GPG_ID
--gpg-fingerprint GPG_FINGERPRINT
-o do not clone any patches
--regex/-x "s/foo/bar" : Optional regex replacement,
replaces foo with bar in the clone name and label

[Link]. softwarechannel_clonetree

Clone a software channel and its child channels.

usage: softwarechannel_clonetree [options]A

e.g softwarechannel_clonetree foobasechannel -p "my_"
softwarechannel_clonetree foobasechannel -x "s/foo/bar"
softwarechannel_clonetree foobasechannel -x "s/^/my_"

options:
-s/--source-channel SOURCE_CHANNEL
-p/--prefix PREFIX (is prepended to the label and name of all channels)
--gpg-copy/-g (copy GPG details for correspondoing source channel))
--gpg-url GPG_URL (applied to all channels)
--gpg-id GPG_ID (applied to all channels)
--gpg-fingerprint GPG_FINGERPRINT (applied to all channels)
-o do not clone any errata
--regex/-x "s/foo/bar" : Optional regex replacement,
replaces foo with bar in the clone name, label and description

[Link]. softwarechannel_create

Create a software channel.

115 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: softwarechannel_create [options]

options:
-n NAME
-l LABEL
-p PARENT_CHANNEL
-a ARCHITECTURE ['ia32', 'ia64', 'x86_64', 'ppc',
'i386-sun-solaris', 'sparc-sun-solaris']
-c CHECKSUM ['sha1', 'sha256', 'sha384', 'sha512']
-u GPG_URL
-i GPG_ID
-f GPG_FINGERPRINT

[Link]. softwarechannel_delete

Delete a software channel.

usage: softwarechannel_delete <CHANNEL ...>

[Link]. softwarechannel_details

Show the details of a software channel.

usage: softwarechannel_details <CHANNEL ...>

[Link]. softwarechannel_diff

Check the difference between software channels.

usage: softwarechannel_diff SOURCE_CHANNEL TARGET_CHANNEL

[Link]. softwarechannel_errata_diff

Check the difference between software channel files.

usage: softwarechannel_errata_diff SOURCE_CHANNEL TARGET_CHANNEL

[Link]. softwarechannel_errata_sync

Sync errata of two software channels.

usage: softwarechannel_errata_sync SOURCE_CHANNEL TARGET_CHANNEL

116 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. softwarechannel_getorgaccess

Get the org-access for the software channel.

usage : softwarechannel_getorgaccess : get org access for all channels

usage : softwarechannel_getorgaccess <channel_label(s)> : get org access for
specific channel(s)

[Link]. softwarechannel_list

List all available software channels.

usage: softwarechannel_list [options]'

options:
-v verbose (display label and summary)
-t tree view (pretty-print child-channels)

[Link]. softwarechannel_listallpackages

List all packages in a channel.

usage: softwarechannel_listallpackages CHANNEL

[Link]. softwarechannel_listbasechannels

List all base software channels.

usage: softwarechannel_listbasechannels [options]

options:
-v verbose (display label and summary)

[Link]. softwarechannel_listchildchannels

List child software channels.

usage:
softwarechannel_listchildchannels [options]
softwarechannel_listchildchannels : List all child channels
softwarechannel_listchildchannels CHANNEL : List children for a specific base
channel
options:
-v verbose (display label and summary)

[Link]. softwarechannel_listerrata

List the errata associated with a software channel.

117 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: softwarechannel_listerrata <CHANNEL ...> [from=yyyymmdd [to=yyyymmdd]]

[Link]. softwarechannel_listerratabydate

List errata from channelbased on a date range.

usage: softwarechannel_listerratabydate CHANNEL BEGINDATE ENDDATE

Date format : YYYYMMDD

[Link]. softwarechannel_listlatestpackages

List the newest version of all packages in a channel.

usage: softwarechannel_listlatestpackages CHANNEL

[Link]. softwarechannel_listpackages

List the most recent packages available from a software channel.

usage: softwarechannel_listpackages CHANNEL

[Link]. softwarechannel_listrepos

List the repos for a software channel.

usage: softwarechannel_listrepos CHANNEL

[Link]. softwarechannel_listsyncschedule

List sync schedules for all software channels.

usage: softwarechannel_listsyncschedule : List all channels

[Link]. softwarechannel_listsystems

List all systems subscribed to a software channel.

usage: softwarechannel_listsystems CHANNEL

118 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. softwarechannel_mirrorpackages

Download packages of a given channel.

usage: softwarechannel_mirrorpackages CHANNEL

Options:
-l/--latest : Only mirror latest package version

[Link]. softwarechannel_regenerateneededcache

Regenerate the needed errata and package cache for all systems.

usage: softwarechannel_regenerateneededcache

[Link]. softwarechannel_regenerateyumcache

Regenerate the YUM cache for a software channel.

usage: softwarechannel_regenerateyumcache <CHANNEL ...>

[Link]. softwarechannel_removeerrata

Remove patches from a software channel.

usage: softwarechannel_removeerrata CHANNEL <ERRATA:search:XXX ...>

[Link]. softwarechannel_removepackages

Remove packages from a software channel.

usage: softwarechannel_removepackages CHANNEL <PACKAGE ...>

[Link]. softwarechannel_removerepo

Remove a repo from a software channel.

usage: softwarechannel_removerepo CHANNEL REPO

[Link]. softwarechannel_removesyncschedule

Removes the repo sync schedule for a software channel.

119 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: softwarechannel_setsyncschedule <CHANNEL>

[Link]. softwarechannel_setorgaccess

Set the org-access for the software channel.

usage : softwarechannel_setorgaccess <channel_label> [options]

-d,--disable : disable org access (private, no org sharing)
-e,--enable : enable org access (public access to all trusted orgs)

[Link]. softwarechannel_setsyncschedule

Sets the repo sync schedule for a software channel.

usage: softwarechannel_setsyncschedule <CHANNEL> <SCHEDULE>

The schedule is specified in Quartz CronTrigger format without enclosing

quotes.
For example, to set a schedule of every day at 1am, <SCHEDULE> would be 0 0 1
* * ?

[Link]. softwarechannel_sync

Sync the packages of two software channels.

usage: softwarechannel_sync SOURCE_CHANNEL TARGET_CHANNEL

[Link]. softwarechannel_syncrepos

Sync users repos for a software channel.

usage: softwarechannel_syncrepos <CHANNEL ...>

2.5.26. ssm
The following spacecmd functions are available for use with the system set manager (SSM).

[Link]. ssm_add

Add systems to the SSM.

120 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: ssm_add <SYSTEMS>

see 'help ssm' for more details

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. ssm_clear

Remove all systems from the SSM.

usage: ssm_clear

[Link]. ssm_intersect

Replace the current SSM with the intersection of the current list of systems and the list of systems passed
as arguments.

usage: ssm_intersect <SYSTEMS>

see 'help ssm' for more details

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNE

[Link]. ssm_list

List the systems currently in the SSM.

usage: ssm_list

see 'help ssm' for more details

[Link]. ssm_remove

Remove systems from the SSM.

121 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: ssm_remove <SYSTEMS>

see 'help ssm' for more details

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

2.5.27. system
The following spacecmd functions are available for use with systems.

[Link]. system_addchildchannels

Add child channels to a system.

usage: system_addchildchannels <SYSTEMS> <CHANNEL ...>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_addconfigchannels

Add config channels to a system.

usage: system_addconfigchannels <SYSTEMS> <CHANNEL ...> [options]

options:
-t add channels to the top of the list
-b add channels to the bottom of the list

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_addconfigfile

Create a configuration file.

122 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

Note this is only for system sandbox or locally-managed files

Centrally managed files should be created via configchannel_addfile
usage: system_addconfigfile [SYSTEM] [options]

options:
-S/--sandbox : list only system-sandbox files
-L/--local : list only locally managed files
-p PATH
-r REVISION
-o OWNER [default: root]
-g GROUP [default: root]
-m MODE [defualt: 0644]
-x SELINUX_CONTEXT
-d path is a directory
-s path is a symlink
-b path is a binary (or other file which needs base64 encoding)
-t SYMLINK_TARGET
-f local path to file contents

Note re binary/base64: Some text files, notably those containing trailing

newlines, those containing ASCII escape characters (or other charaters not
allowed in XML) need to be sent as binary (-b). Some effort is made to
auto-
detect files which require this, but you may need to explicitly specify.

[Link]. system_addcustomvalue

Set a custom value for a system.

usage: system_addcustomvalue KEY VALUE <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_addentitlements

Add entitlements to a system.

usage: system_addentitlements <SYSTEMS> ENTITLEMENT

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_addnote

Set a note for a system.

123 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: system_addnote <SYSTEM> [options]

options:
-s SUBJECT
-b BODY

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_applyerrata

Apply errata to a system.

usage: system_applyerrata <SYSTEMS> [ERRATA|search:XXX ...]

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_comparepackageprofile

Compare a system against a package profile.

usage: system_comparepackageprofile <SYSTEMS> PROFILE

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_comparepackages

Compare the packages between two systems.

usage: system_comparepackages SOME_SYSTEM ANOTHER_SYSTEM

[Link]. system_comparewithchannel

Compare the installed packages on a system with those in the channels it is registered to, or optionally
some other channel.

124 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: system_comparewithchannel <SYSTEMS> [options]

options:
-c/--channel : Specific channel to compare against,
default is those subscribed to, including
child channels

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_createpackageprofile

Create a package profile.

usage: system_createpackageprofile SYSTEM [options]

options:
-n NAME
-d DESCRIPTION

[Link]. system_delete

Delete a system profile.

usage: system_delete <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_deletenotes

Delete notes from a system.

usage: system_deletenotes <SYSTEM> <ID|*>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_deletepackageprofile

Delete a package profile.

125 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: system_deletepackageprofile PROFILE

[Link]. system_deployconfigfiles\

Deploy all configuration files for a system.

usage: system_deployconfigfiles <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_details

Show the details of a system profile.

usage: system_details <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_getcrashfiles

Download all files for a crash record.

usage: system_getcrashfiles -c crash_id [--verbose]

usage: system_getcrashfiles -c crash_id [--dest_folder=/tmp/crash_files] [--
verbose]

[Link]. system_installpackage

Install a package on a system.

usage: system_installpackage <SYSTEMS> <PACKAGE ...>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

126 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. system_list

List all system profiles.

usage: system_list

[Link]. system_listbasechannel

List the base channel for a system.

usage: system_listbasechannel <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_listchildchannels

List the child channels for a system.

usage: system_listchildchannels <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_listconfigchannels

List the config channels of a system.

usage: system_listconfigchannels <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_listconfigfiles

List the managed config files of a system.

127 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: system_listconfigfiles <SYSTEMS>'

options:
-s/--sandbox : list only system-sandbox files
-l/--local : list only locally managed files
-c/--central : list only centrally managed files
-q/--quiet : quiet mode (omits the header)

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_listcrashesbysystem

List all reported crashes for a system.

usage: system_listcrashesbysystem -i sys_id

[Link]. system_listcustomvalues

List the custom values for a system.

usage: system_listcustomvalues <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_listentitlements

List the entitlements for a system.

usage: system_listentitlements <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_listerrata

List available errata for a system.

128 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: system_listerrata <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_listevents

List the event history for a system.

usage: system_listevents <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_listhardware

List the hardware details of a system.

usage: system_listhardware <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_listinstalledpackages

List the installed packages on a system.

usage: system_listinstalledpackages <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_listnotes

List the available notes for a system.

129 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: system_listnotes <SYSTEM>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_listpackageprofiles

List all package profiles.

usage: system_listpackageprofiles

[Link]. system_listupgrades

List the available upgrades for a system.

usage: system_listupgrades <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_lock

Lock a system.

usage: system_lock <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_reboot

Reboot a system.

130 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: system_reboot <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_removechildchannels

Remove child channels from a system.

usage: system_removechildchannels <SYSTEMS> <CHANNEL ...>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_removeconfigchannels

Remove config channels from a system.

usage: system_removeconfigchannels <SYSTEMS> <CHANNEL ...>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_removecustomvalues

Remove a custom value for a system.

usage: system_removecustomvalues <SYSTEMS> <KEY ...>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_removeentitlement

Remove an entitlement from a system.

131 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: system_removeentitlement <SYSTEMS> ENTITLEMENT

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_removepackage

Remove a package from a system.

usage: system_removepackage <SYSTEMS> <PACKAGE ...>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_rename

Rename a system profile.

usage: system_rename OLDNAME NEWNAME

[Link]. system_runscript

Schedule a script to run on the list of systems provided.

132 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: system_runscript <SYSTEMS> [options]

options:
-u USER
-g GROUP
-t TIMEOUT
-s START_TIME
-l LABEL
-f FILE

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

Dates can be any of the following:

Explicit Dates:
Dates can be expressed as explicit date strings in the YYYYMMDD[HHMM]
format. The year, month and day are required, while the hours and
minutes are not; the hours and minutes will default to 0000 if no
values are provided.

Deltas:
Dates can be expressed as delta values. For example, '2h' would
mean 2 hours in the future. You can also use negative values to
express times in the past (e.g., -7d would be one week ago).

Units:
s -> seconds
m -> minutes
h -> hours
d -> days

[Link]. system_schedulehardwarerefresh

Schedule a hardware refresh for a system.

usage: system_schedulehardwarerefresh <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_schedulepackagerefresh

Schedule a software package refresh for a system.

133 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: system_schedulepackagerefresh <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_search

List systems that match the given criteria.

usage: system_search QUERY

Available Fields:
id
name
ip
hostname
device
vendor
driver
uuid

Examples:
> system_search device:vmware
> system_search ip:192.168.82

[Link]. system_setbasechannel

Set a system’s base software channel.

usage: system_setbasechannel <SYSTEMS> CHANNEL

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_setconfigchannelorder

Set the ranked order of configuration channels.

usage: system_setconfigchannelorder <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

134 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. system_setcontactmethod

Set the contact method for a given system.

Available contact methods: ['default', 'ssh-push', 'ssh-push-tunnel']

usage: system_setcontactmethod <SYSTEMS> <CONTACT_METHOD>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_show_packageversion

Shows version of installed package on a given system.

usage: system_show_packageversion <SYSTEM> <PACKAGE>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_syncpackages

Sync packages between two systems.

usage: system_syncpackages SOURCE TARGET

system_unlock
Unlock a system.

usage: system_unlock <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_updatecustomvalue

Update a custom value for a system.

135 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

usage: system_updatecustomvalue KEY VALUE <SYSTEMS>

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. system_upgradepackage

Upgrade a package on a system.

usage: system_upgradepackage <SYSTEMS> <PACKAGE ...>|*

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

2.5.28. toggle
The following spacecmd functions are available to toggle functions on and off.

[Link]. toggle_confirmations

Toggle confirmation messages on/off.

usage: toggle_confirmations

2.5.29. user
The following spacecmd functions are available managing users.

[Link]. user_adddefaultgroup

Add a default group to an user account.

usage: user_adddefaultgroup USER <GROUP ...>

[Link]. user_addgroup

Add a group to an user account.

usage: user_addgroup USER <GROUP ...>

136 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. user_addrole

Add a role to an user account.

usage: user_addrole USER ROLE

[Link]. user_create

Create an user.

usage: user_create [options]

options:
-u USERNAME
-f FIRST_NAME
-l LAST_NAME
-e EMAIL
-p PASSWORD
--pam enable PAM authentication

[Link]. user_delete

Delete an user.

usage: user_delete NAME

[Link]. user_details

Show the details of an user.

usage: user_details USER ...

[Link]. user_disable

Disable an user account.

usage: user_disable NAME

[Link]. user_enable

Enable an user account.

usage: user_enable NAME

137 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. user_list

List all users.

usage: user_list

[Link]. user_listavailableroles

List all available roles for users.

usage: user_listavailableroles

[Link]. user_removedefaultgroup

Remove a default group from an user account.

usage: user_removedefaultgroup USER <GROUP ...>

[Link]. user_removegroup

Remove a group to an user account.

usage: user_removegroup USER <GROUP ...>

[Link]. user_removerole

Remove a role from an user account.

usage: user_removerole USER ROLE

[Link]. user_setemail

Set an user accounts email field.

usage: user_setemail USER EMAIL

[Link]. user_setfirstname

Set an user accounts first name field.

usage: user_setfirstname USER FIRST_NAME

138 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. user_setlastname

Set an user accounts last name field.

usage: user_setlastname USER LAST_NAME

[Link]. user_setpassword

Set an user accounts name prefix field.

usage: user_setpassword USER PASSWORD

[Link]. user_setprefix

Set an user accounts name prefix field.

usage: user_setprefix USER PREFIX

2.5.30. whoami
The following command is available for returning the currently logged spacecmd username.

[Link]. whoami

Print the currently logged spacecmd user.

spacecmd {SSM:0}> whoami

admin

2.5.31. whoamitalkingto
The following spacecmd function is available for returning the server hostname.

[Link]. whoamitalkingto

Return the server hostname that spacecmd is connected with.

spacecmd {SSM:0}> whoamitalkingto

MGR_SERVER_HOSTNAME

2.5.32. Miscellaneous Help Topics

The following help topics are printed with all functions requiring the relevant information.

139 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 2.5. spacecmd Functions

[Link]. time

Dates can be any of the following:

Explicit Dates:
Dates can be expressed as explicit date strings in the YYYYMMDD[HHMM] format.
The year, month and day are required, while the hours and minutes are not;
the hours and minutes will default to 0000 if no values are provided.

Deltas:
Dates can be expressed as delta values.
For example, '2h' would mean 2 hours in the future.
You can also use negative values to express times in the past (e.g., -7d
would be one week ago).

Units:
s -> seconds
m -> minutes
h -> hours
d -> days

[Link]. systems

<SYSTEMS> can be any of the following:

name
ssm (see 'help ssm')
search:QUERY (see 'help system_search')
group:GROUP
channel:CHANNEL

[Link]. ssm

The System Set Manager (SSM) is a group of systems that you can perform tasks on as a group.

Adding Systems:
> ssm_add group:rhel5-x86_64
> ssm_add channel:rhel-x86_64-server-5
> ssm_add search:device:vmware
> ssm_add [Link]

Intersections:
> ssm_add group:rhel5-x86_64
> ssm_intersect group:web-servers

Using the SSM:

> system_installpackage ssm zsh
> system_runscript ssm

140 / 152 2.5. spacecmd Functions | Uyuni 2024.03

 3.1. Synchronization CLI Tools

Chapter 3. Command Line Tools

There are several command line tools available in Uyuni. Every action that can be completed using the
Web UI can be performed at a command prompt instead. Additionally, there are some actions that can
only be performed at the command prompt.

Manage package and channel synchronization with:

• spacewalk-repo-sync
• mgr-sync

Manage bootstrapping with:

• mgr-create-bootstrap-repo

Manage the database with:

• smdba

Some of these command line tools are installed by default. To install a command line tool, you can use
the Uyuni Web UI, or use your package manager at the command prompt.

Procedure: Installing Command Line Tools with the WebUI

1. In the Uyuni Web UI, navigate to Systems › System List, select the client to install the tool on,
and navigate to the Software › Packages › Install sub-tab.
2. Use the search tool to search for the command line tool you want to install.
3. Check the package to install, and click [Install Selected Packages] .
4. Click [Confirm] to begin installation.

Procedure: Installing Command Line Tools from the Command Prompt

1. On the client that you want to install the packages on, at the command prompt, as root, use zypper
to install the package:

zypper in <CLI_TOOL_NAME>

3.1. Synchronization CLI Tools

There are two tools for synchronizing clients to the server. For clients that are connected to the SUSE
Customer Center, use mgr-sync. For all other clients, use spacewalk-repo-sync.

3.1.1. Synchronize SCC Repositories With mgr-sync

The primary use of mgr-sync is to connect to the SUSE Customer Center, retrieve product and package
information, and prepare channels for synchronization with the Uyuni Server.

141 / 152 3.1. Synchronization CLI Tools | Uyuni 2024.03

 3.1. Synchronization CLI Tools

This tool is designed for use with a SUSE support subscription. It is not required for open source
distributions, including openSUSE, CentOS, and Ubuntu.

The available commands and arguments for mgr-sync are listed in this table. Use this syntax for mgr-
sync commands:

mgr-sync [-h] [--version] [-v] [-s] [-d {1,2,3}] {list,add,refresh,delete}

Table 40. mgr-sync Commands

Command Description Example Use

list List channels, organization mgr-sync list channels

credentials, or products

add Add channels, organization mgr-sync add channel

credentials, or products <channel_name>

refresh Refresh the local copy of mgr-sync refresh

products, channels, and
subscriptions

delete Delete existing SCC organization mgr-sync delete

credentials from the local system credentials

sync Synchronize specified channel or mgr-sync sync channel

ask for it when left blank <channel_name>

To see the full list of options specific to a command, use this command:

mgr-sync <command> --help

Table 41. mgr-sync Optional Arguments

Option Abbreviated option Description Example Use

help h Display the command mgr-sync --help

usage and options

version N/A Display the currently mgr-sync

installed version of --version
mgr-sync

verbose v Provide verbose output mgr-sync

--verbose
refresh

store-credentials s Store credentials a local mgr-sync --store

hidden file -credentials

142 / 152 3.1. Synchronization CLI Tools | Uyuni 2024.03

 3.1. Synchronization CLI Tools

Option Abbreviated option Description Example Use

debug d Log additional mgr-sync -d 3

debugging information. refresh
Requires a level of 1, 2,
3. 3 provides the highest
amnount of debugging
information

no-sync N/A Use with the add mgr-sync --no

command to add -sync add
products or channels <channel_name>
without beginning a
synchronization

Logs for mgr-sync are located in:

• /var/log/rhn/[Link]
• /var/log/rhn/rhn_web_api.log

3.1.2. Synchronize Repositories with spacewalk-repo-sync

The spacewalk-repo-sync tool synchronizes software repositories into Uyuni channels. In most
cases, this happens automatically, but you can use the tool to run it manually if required.

The spacewalk-repo-sync tool has these primary commands:

Table 42. spacewalk-repo-sync Options

Option Description Example Use

list List all custom channels and the spacewalk-repo-sync

repositories assigned to them. --list

channel Synchronize a single channel to spacewalk-repo-sync

all repositories assigned to it. --channel <custom-
channel>

deep-verify ignore cached package spacewalk-repo-sync

checksums. --deep-verify

force-all-errata force re-importing all the patches. spacewalk-repo-sync

--deep-verify

no-packages excludes packages from the spacewalk-repo-sync

operation. --deep-verify --no
-packages

For a complete list of options, see the spacewalk-repo-sync manpage:

143 / 152 3.1. Synchronization CLI Tools | Uyuni 2024.03

 3.1. Synchronization CLI Tools

man spacewalk-repo-sync

3.1.3. Troubleshooting Synchronization

If you are having trouble synchronizing with spacewalk-repo-sync you can find out more by
watching the HTTP log as the command runs.

Procedure: Troubleshooting Synchronization Problems

1. Log the HTTP output into /var/log/[Link]:

ZYPP_MEDIA_CURL_DEBUG=2 spacewalk-repo-sync --channel <channel-label>

2. Export the setting:

export URLGRABBER_DEBUG=DEBUG

3. Start the synchronization:

/usr/bin/spacewalk-repo-sync --channel <channel-label> --type yum

You can increase the debug level, by adding the [option]``-vvv`` option
to the command.

4. When the complete completes, or fails, disable debug mode:

unset URLGRABBER_DEBUG

[Link]. Add Custom Extra HTTP Headers

You can add custom HTTP headers to the requests made by spacewalk-repo-sync at the time of
synchronization. The custom HTTP headers are defined in the /etc/rhn/spacewalk-repo-
sync/extra_headers.conf configuration file. The headers can be defined by repository name or
channel label. You can also define global headers by putting them in the main section. For example:

[testchannel]
X-MY-HEADER-1=VALUE
X-MY-HEADER-2=VALUE

[mychannel]
X-MY-HEADER-3=VALUE
X-MY-HEADER-4=VALUE

[main]
X-MYGLOBAL-HEADER=VALUE

144 / 152 3.1. Synchronization CLI Tools | Uyuni 2024.03

 3.2. Bootstrapping Command Line Tools

This can be particularly useful when dealing with Red Hat Update Infrastructure (RHUI) repositories in
the public cloud.

3.2. Bootstrapping Command Line Tools

The mgr-create-bootstrap-repo tool allows you to create a bootstrap repository.

Use the mgr-create-bootstrap-repo command on the Uyuni Server to create a new bootstrap
repository. The -l option lists all available repositories:

mgr-create-bootstrap-repo -l

Give the repository name to create the bootstrap repository you require:

mgr-create-bootstrap-repo <repo-name>

You can also create a new bootstrap repository from a custom channel, with the --with-custom
-channels option:

mgr-create-bootstrap-repo --with-custom-channels

If you create a bootstrap repository that contains custom channels, and later attempt to rebuild with the
mgr-create-bootstrap-repo command, the custom channel information will remain in the
bootstrap repository. To remove custom channel information from your bootstrap repository, use the
--flush option when you rebuild:

mgr-create-bootstrap-repo --flush

3.3. Database CLI Tool

The smdba tool allows you to manage the installed PostgreSQL database. It allows you to backup and
restore the database, as well as administration tasks like creating, verifying, and restarting the database.
The tool works on local databases only.

 The smdba tool replaces the older db-control tool. The db-control
tool is now unsupported.

After you stop or restart the database, you need to restart the Uyuni services.

Table 43. Database Options

145 / 152 3.2. Bootstrapping Command Line Tools | Uyuni 2024.03

 3.3. Database CLI Tool

Option Description

backup-hot Enable continuous archiving backup

backup-restore Restore the database from backup.

backup-status Show backup status.

db-start Start the database.

db-status Show database status.

db-stop Stop the database.

space-overview Show database space report.

space-reclaim Free disk space from unused objects in tables and

indexes.

space-tables Show space report for each table.

system-check Perform a back-end health check.

help Show help message and exit.

Each option has additional help available. See the help using this syntax:

smdba <OPTION> --help

146 / 152 3.3. Database CLI Tool | Uyuni 2024.03

Chapter 4. GNU Free Documentation License
Copyright © 2000, 2001, 2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA
02110-1301 USA. Everyone is permitted to copy and distribute verbatim copies of this license document,
but changing it is not allowed.

0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other functional and useful document
"free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with
or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for
the author and publisher a way to get credit for their work, while not being considered responsible for
modifications made by others.

This License is a kind of "copyleft", which means that derivative works of the document must themselves
be free in the same sense. It complements the GNU General Public License, which is a copyleft license
designed for free software.

We have designed this License in order to use it for manuals for free software, because free software
needs free documentation: a free program should come with manuals providing the same freedoms that
the software does. But this License is not limited to software manuals; it can be used for any textual work,
regardless of subject matter or whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.

1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, that contains a notice placed by the
copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-
wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The
"Document", below, refers to any such manual or work. Any member of the public is a licensee, and is
addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring
permission under copyright law.

A "Modified Version" of the Document means any work containing the Document or a portion of it,
either copied verbatim, or with modifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section of the Document that deals
exclusively with the relationship of the publishers or authors of the Document to the Document’s overall
subject (or to related matters) and contains nothing that could fall directly within that overall subject.
(Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any
mathematics.) The relationship could be a matter of historical connection with the subject or with related
matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of
Invariant Sections, in the notice that says that the Document is released under this License. If a section
does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The
Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections

147 / 152 Chapter 4. GNU Free Documentation License | Uyuni 2024.03

then there are none.

The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover
Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose
specification is available to the general public, that is suitable for revising the document straightforwardly
with generic text editors or (for images composed of pixels) generic paint programs or (for drawings)
some widely available drawing editor, and that is suitable for input to text formatters or for automatic
translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise
Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage
subsequent modification by readers is not Transparent. An image format is not Transparent if used for any
substantial amount of text. A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input
format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming
simple HTML, PostScript or PDF designed for human modification. Examples of transparent image
formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and
edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools
are not generally available, and the machine-generated HTML, PostScript or PDF produced by some
word processors for output purposes only.

The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed
to hold, legibly, the material this License requires to appear in the title page. For works in formats which
do not have any title page as such, "Title Page" means the text near the most prominent appearance of the
work’s title, preceding the beginning of the body of the text.

A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or
contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands
for a specific section name mentioned below, such as "Acknowledgements", "Dedications",
"Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document
means that it remains a section "Entitled XYZ" according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies
to the Document. These Warranty Disclaimers are considered to be included by reference in this License,
but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may
have is void and has no effect on the meaning of this License.

2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or noncommercially,
provided that this License, the copyright notices, and the license notice saying this License applies to the
Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this
License. You may not use technical measures to obstruct or control the reading or further copying of the
copies you make or distribute. However, you may accept compensation in exchange for copies. If you
distribute a large enough number of copies you must also follow the conditions in section 3.

148 / 152 Chapter 4. GNU Free Documentation License | Uyuni 2024.03

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of the Document,
numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover,
and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the
publisher of these copies. The front cover must present the full title with all words of the title equally
prominent and visible. You may add other material on the covers in addition. Copying with changes
limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can
be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed
(as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either
include a machine-readable Transparent copy along with each Opaque copy, or state in or with each
Opaque copy a computer-network location from which the general network-using public has access to
download using public-standard network protocols a complete Transparent copy of the Document, free of
added material. If you use the latter option, you must take reasonably prudent steps, when you begin
distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible
at the stated location until at least one year after the last time you distribute an Opaque copy (directly or
through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing
any large number of copies, to give them a chance to provide you with an updated version of the
Document.

4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and
3 above, provided that you release the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution and modification of the Modified
Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and
from those of previous versions (which should, if there were any, be listed in the History section of
the Document). You may use the same title as a previous version if the original publisher of that
version gives permission.
B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the
modifications in the Modified Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five), unless they release you from this
requirement.
C. State on the Title page the name of the publisher of the Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.

149 / 152 Chapter 4. GNU Free Documentation License | Uyuni 2024.03

 E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
F. Include, immediately after the copyright notices, a license notice giving the public permission to
use the Modified Version under the terms of this License, in the form shown in the Addendum
below.
G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in
the Document’s license notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the
title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is
no section Entitled "History" in the Document, create one stating the title, year, authors, and
publisher of the Document as given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for public access to a Transparent
copy of the Document, and likewise the network locations given in the Document for previous
versions it was based on. These may be placed in the "History" section. You may omit a network
location for a work that was published at least four years before the Document itself, or if the
original publisher of the version it refers to gives permission.
K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section,
and preserve in the section all the substance and tone of each of the contributor acknowledgements
and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles.
Section numbers or the equivalent are not considered part of the section titles.
M. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified
Version.
N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any
Invariant Section.
O. Preserve any Warranty Disclaimers.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary
Sections and contain no material copied from the Document, you may at your option designate some or
all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the
Modified Version’s license notice. These titles must be distinct from any other section titles.

You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your
Modified Version by various parties—for example, statements of peer review or that the text has been
approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a
Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any
one entity. If the Document already includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of, you may not add another; but you
may replace the old one, on explicit permission from the previous publisher that added the old one.

150 / 152 Chapter 4. GNU Free Documentation License | Uyuni 2024.03

The author(s) and publisher(s) of the Document do not by this License give permission to use their names
for publicity for or to assert or imply endorsement of any Modified Version.

5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License, under the terms
defined in section 4 above for modified versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of
your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections
may be replaced with a single copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by adding at the end of it, in parentheses, the
name of the original author or publisher of that section if known, or else a unique number. Make the same
adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History" in the various original documents,
forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and
any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".

6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under this License,
and replace the individual copies of this License in the various documents with a single copy that is
included in the collection, provided that you follow the rules of this License for verbatim copying of each
of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this
License, provided you insert a copy of this License into the extracted document, and follow this License
in all other respects regarding verbatim copying of that document.

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or
works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright
resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what
the individual works permit. When the Document is included in an aggregate, this License does not apply
to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the
Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the
Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole
aggregate.

8. TRANSLATION

151 / 152 Chapter 4. GNU Free Documentation License | Uyuni 2024.03

Translation is considered a kind of modification, so you may distribute translations of the Document
under the terms of section 4. Replacing Invariant Sections with translations requires special permission
from their copyright holders, but you may include translations of some or all Invariant Sections in
addition to the original versions of these Invariant Sections. You may include a translation of this License,
and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include
the original English version of this License and the original versions of those notices and disclaimers. In
case of a disagreement between the translation and the original version of this License or a notice or
disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the

requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under
this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License. However, parties who have received copies, or
rights, from you under this License will not have their licenses terminated so long as such parties remain
in full compliance.

10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation
License from time to time. Such new versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See [Link]

Each version of the License is given a distinguishing version number. If the Document specifies that a
particular numbered version of this License "or any later version" applies to it, you have the option of
following the terms and conditions either of that specified version or of any later version that has been
published (not as a draft) by the Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not as a draft) by the Free Software
Foundation.

ADDENDUM: How to use this License for your documents

Copyright (c) YEAR YOUR NAME.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".

152 / 152 Chapter 4. GNU Free Documentation License | Uyuni 2024.03