Jump To Close Expand all Collapse all Table of contents API Guide 1. Introduction to Red Hat Satellite Expand section "1. Introduction to Red Hat Satellite" Collapse section "1. Introduction to Red Hat Satellite" 1.1. The Red Hat Satellite API 1.2. Using XML-RPC with the Red Hat Satellite API 1.3. Using the Read-only API Expand section "1.3. Using the Read-only API" Collapse section "1.3. Using the Read-only API" 1.3.1. Creating a Read-only User 2. Examples Expand section "2. Examples" Collapse section "2. Examples" 2.1. Python Examples 2.2. Perl Example 2.3. Ruby Example I. Methods Expand section "I. Methods" Collapse section "I. Methods" 3. actionchain Expand section "3. actionchain" Collapse section "3. actionchain" 3.1. addConfigurationDeployment 3.2. addErrataUpdate 3.3. addPackageInstall 3.4. addPackageRemoval 3.5. addPackageUpgrade 3.6. addPackageVerify 3.7. addScriptRun 3.8. addSystemReboot 3.9. createChain 3.10. deleteChain 3.11. listChainActions 3.12. listChains 3.13. removeAction 3.14. renameChain 3.15. scheduleChain 4. activationkey Expand section "4. activationkey" Collapse section "4. activationkey" 4.1. addChildChannels 4.2. addConfigChannels 4.3. addEntitlements 4.4. addPackageNames 4.5. addPackages 4.6. addServerGroups 4.7. checkConfigDeployment 4.8. clone 4.9. create 4.10. create 4.11. delete 4.12. disableConfigDeployment 4.13. enableConfigDeployment 4.14. getDetails 4.15. listActivatedSystems 4.16. listActivationKeys 4.17. listConfigChannels 4.18. removeChildChannels 4.19. removeConfigChannels 4.20. removeEntitlements 4.21. removePackageNames 4.22. removePackages 4.23. removeServerGroups 4.24. setConfigChannels 4.25. setDetails 5. api Expand section "5. api" Collapse section "5. api" 5.1. getApiCallList 5.2. getApiNamespaceCallList 5.3. getApiNamespaces 5.4. getVersion 5.5. systemVersion 6. auth Expand section "6. auth" Collapse section "6. auth" 6.1. login 6.2. login 6.3. logout 7. channel Expand section "7. channel" Collapse section "7. channel" 7.1. listAllChannels 7.2. listManageableChannels 7.3. listMyChannels 7.4. listPopularChannels 7.5. listRedHatChannels 7.6. listRetiredChannels 7.7. listSharedChannels 7.8. listSoftwareChannels 7.9. listVendorChannels 8. channel.access Expand section "8. channel.access" Collapse section "8. channel.access" 8.1. disableUserRestrictions 8.2. enableUserRestrictions 8.3. getOrgSharing 8.4. setOrgSharing 9. channel.org Expand section "9. channel.org" Collapse section "9. channel.org" 9.1. disableAccess 9.2. enableAccess 9.3. list 10. channel.software Expand section "10. channel.software" Collapse section "10. channel.software" 10.1. addPackages 10.2. addRepoFilter 10.3. associateRepo 10.4. availableEntitlements 10.5. clearRepoFilters 10.6. clone 10.7. create 10.8. create 10.9. create 10.10. createRepo 10.11. createRepo 10.12. delete 10.13. disassociateRepo 10.14. getChannelLastBuildById 10.15. getDetails 10.16. getDetails 10.17. getRepoDetails 10.18. getRepoDetails 10.19. getRepoSyncCronExpression 10.20. isGloballySubscribable 10.21. isUserManageable 10.22. isUserSubscribable 10.23. listAllPackages 10.24. listAllPackages 10.25. listAllPackages 10.26. listAllPackages 10.27. listAllPackages 10.28. listAllPackagesByDate 10.29. listAllPackagesByDate 10.30. listAllPackagesByDate 10.31. listArches 10.32. listChannelRepos 10.33. listChildren 10.34. listErrata 10.35. listErrata 10.36. listErrata 10.37. listErrata 10.38. listErrata 10.39. listErrata 10.40. listErrataByType 10.41. listErrataNeedingSync 10.42. listLatestPackages 10.43. listPackagesWithoutChannel 10.44. listRepoFilters 10.45. listSubscribedSystems 10.46. listSystemChannels 10.47. listUserRepos 10.48. mergeErrata 10.49. mergeErrata 10.50. mergeErrata 10.51. mergePackages 10.52. regenerateNeededCache 10.53. regenerateNeededCache 10.54. regenerateYumCache 10.55. removeErrata 10.56. removePackages 10.57. removeRepo 10.58. removeRepo 10.59. removeRepoFilter 10.60. setContactDetails 10.61. setDetails 10.62. setGloballySubscribable 10.63. setRepoFilters 10.64. setSystemChannels 10.65. setUserManageable 10.66. setUserSubscribable 10.67. subscribeSystem 10.68. syncErrata 10.69. syncRepo 10.70. syncRepo 10.71. syncRepo 10.72. syncRepo 10.73. updateRepo 10.74. updateRepoLabel 10.75. updateRepoLabel 10.76. updateRepoSsl 10.77. updateRepoSsl 10.78. updateRepoUrl 10.79. updateRepoUrl 11. configchannel Expand section "11. configchannel" Collapse section "11. configchannel" 11.1. channelExists 11.2. create 11.3. createOrUpdatePath 11.4. createOrUpdateSymlink 11.5. deleteChannels 11.6. deleteFileRevisions 11.7. deleteFiles 11.8. deployAllSystems 11.9. deployAllSystems 11.10. deployAllSystems 11.11. deployAllSystems 11.12. getDetails 11.13. getDetails 11.14. getEncodedFileRevision 11.15. getFileRevision 11.16. getFileRevisions 11.17. listFiles 11.18. listGlobals 11.19. listSubscribedSystems 11.20. lookupChannelInfo 11.21. lookupFileInfo 11.22. lookupFileInfo 11.23. scheduleFileComparisons 11.24. update 12. distchannel Expand section "12. distchannel" Collapse section "12. distchannel" 12.1. listDefaultMaps 12.2. listMapsForOrg 12.3. listMapsForOrg 12.4. setMapForOrg 13. errata Expand section "13. errata" Collapse section "13. errata" 13.1. addPackages 13.2. applicableToChannels 13.3. bugzillaFixes 13.4. clone 13.5. cloneAsOriginal 13.6. cloneAsOriginalAsync 13.7. cloneAsync 13.8. create 13.9. delete 13.10. findByCve 13.11. getDetails 13.12. listAffectedSystems 13.13. listByDate 13.14. listCves 13.15. listKeywords 13.16. listPackages 13.17. listUnpublishedErrata 13.18. publish 13.19. publishAsOriginal 13.20. removePackages 13.21. setDetails 14. kickstart Expand section "14. kickstart" Collapse section "14. kickstart" 14.1. cloneProfile 14.2. createProfile 14.3. createProfile 14.4. createProfileWithCustomUrl 14.5. createProfileWithCustomUrl 14.6. deleteProfile 14.7. disableProfile 14.8. findKickstartForIp 14.9. importFile 14.10. importFile 14.11. importFile 14.12. importRawFile 14.13. importRawFile 14.14. isProfileDisabled 14.15. listAllIpRanges 14.16. listKickstartableChannels 14.17. listKickstartableTreeChannels 14.18. listKickstartableTrees 14.19. listKickstarts 14.20. renameProfile 15. kickstart.filepreservation Expand section "15. kickstart.filepreservation" Collapse section "15. kickstart.filepreservation" 15.1. create 15.2. delete 15.3. getDetails 15.4. listAllFilePreservations 16. kickstart.keys Expand section "16. kickstart.keys" Collapse section "16. kickstart.keys" 16.1. create 16.2. delete 16.3. getDetails 16.4. listAllKeys 16.5. update 17. kickstart.profile.keys Expand section "17. kickstart.profile.keys" Collapse section "17. kickstart.profile.keys" 17.1. addActivationKey 17.2. getActivationKeys 17.3. removeActivationKey 18. kickstart.profile.software Expand section "18. kickstart.profile.software" Collapse section "18. kickstart.profile.software" 18.1. appendToSoftwareList 18.2. getSoftwareDetails 18.3. getSoftwareList 18.4. setSoftwareDetails 18.5. setSoftwareList 18.6. setSoftwareList 19. kickstart.profile.system Expand section "19. kickstart.profile.system" Collapse section "19. kickstart.profile.system" 19.1. addFilePreservations 19.2. addKeys 19.3. checkConfigManagement 19.4. checkRemoteCommands 19.5. disableConfigManagement 19.6. disableRemoteCommands 19.7. enableConfigManagement 19.8. enableRemoteCommands 19.9. getLocale 19.10. getPartitioningScheme 19.11. getRegistrationType 19.12. getSELinux 19.13. listFilePreservations 19.14. listKeys 19.15. removeFilePreservations 19.16. removeKeys 19.17. setLocale 19.18. setPartitioningScheme 19.19. setRegistrationType 19.20. setSELinux 20. kickstart.profile Expand section "20. kickstart.profile" Collapse section "20. kickstart.profile" 20.1. addIpRange 20.2. addScript 20.3. addScript 20.4. addScript 20.5. compareActivationKeys 20.6. compareAdvancedOptions 20.7. comparePackages 20.8. downloadKickstart 20.9. downloadRenderedKickstart 20.10. getAdvancedOptions 20.11. getAvailableRepositories 20.12. getCfgPreservation 20.13. getChildChannels 20.14. getCustomOptions 20.15. getKickstartTree 20.16. getRepositories 20.17. getUpdateType 20.18. getVariables 20.19. getVirtualizationType 20.20. listIpRanges 20.21. listScripts 20.22. orderScripts 20.23. removeIpRange 20.24. removeScript 20.25. setAdvancedOptions 20.26. setCfgPreservation 20.27. setChildChannels 20.28. setCustomOptions 20.29. setKickstartTree 20.30. setLogging 20.31. setRepositories 20.32. setUpdateType 20.33. setVariables 20.34. setVirtualizationType 21. kickstart.snippet Expand section "21. kickstart.snippet" Collapse section "21. kickstart.snippet" 21.1. createOrUpdate 21.2. delete 21.3. listAll 21.4. listCustom 21.5. listDefault 22. kickstart.tree Expand section "22. kickstart.tree" Collapse section "22. kickstart.tree" 22.1. create 22.2. delete 22.3. deleteTreeAndProfiles 22.4. getDetails 22.5. list 22.6. listInstallTypes 22.7. rename 22.8. update 23. org Expand section "23. org" Collapse section "23. org" 23.1. create 23.2. delete 23.3. getCrashFileSizeLimit 23.4. getDetails 23.5. getDetails 23.6. getPolicyForScapFileUpload 23.7. getPolicyForScapResultDeletion 23.8. isCrashReportingEnabled 23.9. isCrashfileUploadEnabled 23.10. isErrataEmailNotifsForOrg 23.11. isOrgConfigManagedByOrgAdmin 23.12. listOrgs 23.13. listSoftwareEntitlements 23.14. listSoftwareEntitlements 23.15. listSoftwareEntitlements 23.16. listSoftwareEntitlementsForOrg 23.17. listSystemEntitlements 23.18. listSystemEntitlements 23.19. listSystemEntitlements 23.20. listSystemEntitlementsForOrg 23.21. listUsers 23.22. migrateSystems 23.23. setCrashFileSizeLimit 23.24. setCrashReporting 23.25. setCrashfileUpload 23.26. setErrataEmailNotifsForOrg 23.27. setOrgConfigManagedByOrgAdmin 23.28. setPolicyForScapFileUpload 23.29. setPolicyForScapResultDeletion 23.30. setSoftwareEntitlements 23.31. setSoftwareFlexEntitlements 23.32. setSystemEntitlements 23.33. updateName 24. org.trusts Expand section "24. org.trusts" Collapse section "24. org.trusts" 24.1. addTrust 24.2. getDetails 24.3. listChannelsConsumed 24.4. listChannelsProvided 24.5. listOrgs 24.6. listSystemsAffected 24.7. listTrusts 24.8. removeTrust 25. packages Expand section "25. packages" Collapse section "25. packages" 25.1. findByNvrea 25.2. getDetails 25.3. getPackage 25.4. getPackageUrl 25.5. listChangelog 25.6. listDependencies 25.7. listFiles 25.8. listProvidingChannels 25.9. listProvidingErrata 25.10. listSourcePackages 25.11. removePackage 25.12. removeSourcePackage 26. packages.provider Expand section "26. packages.provider" Collapse section "26. packages.provider" 26.1. associateKey 26.2. list 26.3. listKeys 27. packages.search Expand section "27. packages.search" Collapse section "27. packages.search" 27.1. advanced 27.2. advancedWithActKey 27.3. advancedWithChannel 27.4. name 27.5. nameAndDescription 27.6. nameAndSummary 28. preferences.locale Expand section "28. preferences.locale" Collapse section "28. preferences.locale" 28.1. listLocales 28.2. listTimeZones 28.3. setLocale 28.4. setTimeZone 29. proxy Expand section "29. proxy" Collapse section "29. proxy" 29.1. activateProxy 29.2. createMonitoringScout 29.3. deactivateProxy 29.4. isProxy 29.5. listAvailableProxyChannels 30. satellite Expand section "30. satellite" Collapse section "30. satellite" 30.1. getCertificateExpirationDate 30.2. isMonitoringEnabled 30.3. isMonitoringEnabledBySystemId 30.4. listEntitlements 30.5. listProxies 31. schedule Expand section "31. schedule" Collapse section "31. schedule" 31.1. archiveActions 31.2. cancelActions 31.3. deleteActions 31.4. failSystemAction 31.5. failSystemAction 31.6. listAllActions 31.7. listArchivedActions 31.8. listCompletedActions 31.9. listCompletedSystems 31.10. listFailedActions 31.11. listFailedSystems 31.12. listInProgressActions 31.13. listInProgressSystems 31.14. rescheduleActions 32. sync.master Expand section "32. sync.master" Collapse section "32. sync.master" 32.1. addToMaster 32.2. create 32.3. delete 32.4. getDefaultMaster 32.5. getMaster 32.6. getMasterByLabel 32.7. getMasterOrgs 32.8. getMasters 32.9. makeDefault 32.10. mapToLocal 32.11. setCaCert 32.12. setMasterOrgs 32.13. unsetDefaultMaster 32.14. update 33. sync.slave Expand section "33. sync.slave" Collapse section "33. sync.slave" 33.1. create 33.2. delete 33.3. getAllowedOrgs 33.4. getSlave 33.5. getSlaveByName 33.6. getSlaves 33.7. setAllowedOrgs 33.8. update 34. system Expand section "34. system" Collapse section "34. system" 34.1. addEntitlements 34.2. addNote 34.3. applyErrata 34.4. comparePackageProfile 34.5. comparePackages 34.6. convertToFlexEntitlement 34.7. createPackageProfile 34.8. createSystemRecord 34.9. deleteCustomValues 34.10. deleteGuestProfiles 34.11. deleteNote 34.12. deleteNotes 34.13. deletePackageProfile 34.14. deleteSystem 34.15. deleteSystem 34.16. deleteSystems 34.17. deleteTagFromSnapshot 34.18. downloadSystemId 34.19. getConnectionPath 34.20. getCpu 34.21. getCustomValues 34.22. getDetails 34.23. getDevices 34.24. getDmi 34.25. getEntitlements 34.26. getEventHistory 34.27. getId 34.28. getMemory 34.29. getName 34.30. getNetwork 34.31. getNetworkDevices 34.32. getOsaPing 34.33. getRegistrationDate 34.34. getRelevantErrata 34.35. getRelevantErrataByType 34.36. getRunningKernel 34.37. getScriptActionDetails 34.38. getScriptResults 34.39. getSubscribedBaseChannel 34.40. getSystemCurrencyMultipliers 34.41. getSystemCurrencyScores 34.42. getUnscheduledErrata 34.43. getUuid 34.44. getVariables 34.45. isNvreInstalled 34.46. isNvreInstalled 34.47. listActivationKeys 34.48. listActiveSystems 34.49. listActiveSystemsDetails 34.50. listAdministrators 34.51. listAllInstallablePackages 34.52. listBaseChannels 34.53. listChildChannels 34.54. listDuplicatesByHostname 34.55. listDuplicatesByIp 34.56. listDuplicatesByMac 34.57. listEligibleFlexGuests 34.58. listExtraPackages 34.59. listFlexGuests 34.60. listGroups 34.61. listInactiveSystems 34.62. listInactiveSystems 34.63. listLatestAvailablePackage 34.64. listLatestInstallablePackages 34.65. listLatestUpgradablePackages 34.66. listNewerInstalledPackages 34.67. listNotes 34.68. listOlderInstalledPackages 34.69. listOutOfDateSystems 34.70. listPackageProfiles 34.71. listPackages 34.72. listPackagesFromChannel 34.73. listPhysicalSystems 34.74. listSubscribableBaseChannels 34.75. listSubscribableChildChannels 34.76. listSubscribedChildChannels 34.77. listSuggestedReboot 34.78. listSystemEvents 34.79. listSystemEvents 34.80. listSystems 34.81. listSystemsWithExtraPackages 34.82. listSystemsWithPackage 34.83. listSystemsWithPackage 34.84. listUngroupedSystems 34.85. listUserSystems 34.86. listUserSystems 34.87. listVirtualGuests 34.88. listVirtualHosts 34.89. obtainReactivationKey 34.90. obtainReactivationKey 34.91. provisionSystem 34.92. provisionSystem 34.93. provisionVirtualGuest 34.94. provisionVirtualGuest 34.95. provisionVirtualGuest 34.96. removeEntitlements 34.97. scheduleApplyErrata 34.98. scheduleApplyErrata 34.99. scheduleApplyErrata 34.100. scheduleApplyErrata 34.101. scheduleCertificateUpdate 34.102. scheduleCertificateUpdate 34.103. scheduleGuestAction 34.104. scheduleGuestAction 34.105. scheduleHardwareRefresh 34.106. schedulePackageInstall 34.107. schedulePackageInstall 34.108. schedulePackageInstallByNevra 34.109. schedulePackageInstallByNevra 34.110. schedulePackageRefresh 34.111. schedulePackageRemove 34.112. schedulePackageRemove 34.113. schedulePackageRemoveByNevra 34.114. schedulePackageRemoveByNevra 34.115. scheduleReboot 34.116. scheduleScriptRun 34.117. scheduleScriptRun 34.118. scheduleScriptRun 34.119. scheduleScriptRun 34.120. scheduleSyncPackagesWithSystem 34.121. searchByName 34.122. sendOsaPing 34.123. setBaseChannel 34.124. setBaseChannel 34.125. setChildChannels 34.126. setCustomValues 34.127. setDetails 34.128. setGroupMembership 34.129. setGuestCpus 34.130. setGuestMemory 34.131. setLockStatus 34.132. setPrimaryInterface 34.133. setProfileName 34.134. setVariables 34.135. tagLatestSnapshot 34.136. unentitle 34.137. upgradeEntitlement 34.138. whoRegistered 35. system.config Expand section "35. system.config" Collapse section "35. system.config" 35.1. addChannels 35.2. createOrUpdatePath 35.3. createOrUpdateSymlink 35.4. deleteFiles 35.5. deployAll 35.6. listChannels 35.7. listFiles 35.8. lookupFileInfo 35.9. removeChannels 35.10. setChannels 36. system.crash Expand section "36. system.crash" Collapse section "36. system.crash" 36.1. createCrashNote 36.2. deleteCrash 36.3. deleteCrashNote 36.4. getCrashCountInfo 36.5. getCrashFile 36.6. getCrashFileUrl 36.7. getCrashNotesForCrash 36.8. getCrashOverview 36.9. getCrashesByUuid 36.10. listSystemCrashFiles 36.11. listSystemCrashes 37. system.custominfo Expand section "37. system.custominfo" Collapse section "37. system.custominfo" 37.1. createKey 37.2. deleteKey 37.3. listAllKeys 37.4. updateKey 38. system.provisioning.snapshot Expand section "38. system.provisioning.snapshot" Collapse section "38. system.provisioning.snapshot" 38.1. addTagToSnapshot 38.2. deleteSnapshot 38.3. deleteSnapshots 38.4. deleteSnapshots 38.5. listSnapshotConfigFiles 38.6. listSnapshotPackages 38.7. listSnapshots 38.8. rollbackToSnapshot 38.9. rollbackToTag 38.10. rollbackToTag 39. system.scap Expand section "39. system.scap" Collapse section "39. system.scap" 39.1. deleteXccdfScan 39.2. getXccdfScanDetails 39.3. getXccdfScanRuleResults 39.4. listXccdfScans 39.5. scheduleXccdfScan 39.6. scheduleXccdfScan 39.7. scheduleXccdfScan 39.8. scheduleXccdfScan 40. system.search Expand section "40. system.search" Collapse section "40. system.search" 40.1. deviceDescription 40.2. deviceDriver 40.3. deviceId 40.4. deviceVendorId 40.5. hostname 40.6. ip 40.7. nameAndDescription 40.8. uuid 41. systemgroup Expand section "41. systemgroup" Collapse section "41. systemgroup" 41.1. addOrRemoveAdmins 41.2. addOrRemoveSystems 41.3. create 41.4. delete 41.5. getDetails 41.6. getDetails 41.7. listActiveSystemsInGroup 41.8. listAdministrators 41.9. listAllGroups 41.10. listGroupsWithNoAssociatedAdmins 41.11. listInactiveSystemsInGroup 41.12. listInactiveSystemsInGroup 41.13. listSystems 41.14. listSystemsMinimal 41.15. scheduleApplyErrataToActive 41.16. scheduleApplyErrataToActive 41.17. update 42. user.external Expand section "42. user.external" Collapse section "42. user.external" 42.1. createExternalGroupToRoleMap 42.2. createExternalGroupToSystemGroupMap 42.3. deleteExternalGroupToRoleMap 42.4. deleteExternalGroupToSystemGroupMap 42.5. getDefaultOrg 42.6. getExternalGroupToRoleMap 42.7. getExternalGroupToSystemGroupMap 42.8. getKeepTemporaryRoles 42.9. getUseOrgUnit 42.10. listExternalGroupToRoleMaps 42.11. listExternalGroupToSystemGroupMaps 42.12. setDefaultOrg 42.13. setExternalGroupRoles 42.14. setExternalGroupSystemGroups 42.15. setKeepTemporaryRoles 42.16. setUseOrgUnit 43. user Expand section "43. user" Collapse section "43. user" 43.1. addAssignedSystemGroup 43.2. addAssignedSystemGroups 43.3. addDefaultSystemGroup 43.4. addDefaultSystemGroups 43.5. addRole 43.6. create 43.7. create 43.8. delete 43.9. disable 43.10. enable 43.11. getCreateDefaultSystemGroup 43.12. getDetails 43.13. getLoggedInTime 43.14. listAssignableRoles 43.15. listAssignedSystemGroups 43.16. listDefaultSystemGroups 43.17. listRoles 43.18. listUsers 43.19. removeAssignedSystemGroup 43.20. removeAssignedSystemGroups 43.21. removeDefaultSystemGroup 43.22. removeDefaultSystemGroups 43.23. removeRole 43.24. setCreateDefaultSystemGroup 43.25. setDetails 43.26. setErrataNotifications 43.27. setReadOnly 43.28. usePamAuthentication A. Revision History Legal Notice Settings Close Language: English 日本語 Language: English 日本語 Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: English 日本語 Language: English 日本語 Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Red Hat Training A Red Hat training course is available for Red Hat Satellite 25.5. listChangelog Name listChangelog Description List the change log for a package. Parameters string sessionKey int packageId Return Value string Previous Next