SUSE Manager API Documentation - SUSE Manager 24 · 2021. 2. 11. · 8.3 getOrgSharing 42 8.4 setOrgSharing 43 9 channel.org44 9.1 disableAccess 44 9.2 enableAccess 44 9.3 list 45

SUSE Manager APIDocumentation

SUSE Manager 24

SUSE Manager API Documentation

SUSE Manager 24

Welcome to the SUSE Manager API. By using the included API calls, you can easilyautomate many of the tasks you perform everyday. All API calls are grouped bycommon functionality.

Publication Date: 01/15/2021

SUSE LLC10 Canal Park DriveSuite 200Cambridge MA 02141USA

https://documentation.suse.com

Copyright (c) 2014 Red Hat, Inc.

Copyright (c) 2019 SUSE LLC

This software is licensed to you under the GNU General Public License, version 2 (GPLv2). There is NO

WARRANTY for this software, express or implied, including the implied warranties of MERCHANTABILITY

or FITNESS FOR A PARTICULAR PURPOSE. You should have received a copy of GPLv2 along with this

software; if not, see http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.

Red Hat trademarks are not licensed under GPLv2. No permission is granted to use or replicate Red Hat

trademarks that are incorporated in this software or its documentation.

https://documentation.suse.com

Contents

Sample Scripts xli

Frequently Asked Questions xliv

1 actionchain 11.1 addConfigurationDeployment 1

1.2 addErrataUpdate 1

1.3 addPackageInstall 2

1.4 addPackageRemoval 2

1.5 addPackageUpgrade 3

1.6 addPackageVerify 3

1.7 addScriptRun 4

1.8 addScriptRun 4

1.9 addSystemReboot 5

1.10 createChain 5

1.11 deleteChain 5

1.12 listChainActions 6

1.13 listChains 6

1.14 removeAction 7

1.15 renameChain 7

1.16 scheduleChain 8

iii SUSE Manager API Documentation

2 activationkey 92.1 addChildChannels 9

2.2 addConfigChannels 9

2.3 addEntitlements 10

2.4 addPackageNames 11

2.5 addPackages 11

2.6 addServerGroups 12

2.7 checkConfigDeployment 12

2.8 clone 12

2.9 create 13

2.10 create 14

2.11 delete 14

2.12 disableConfigDeployment 15

2.13 enableConfigDeployment 15

2.14 getDetails 15

2.15 listActivatedSystems 16

2.16 listActivationKeys 17

2.17 listChannels 18

2.18 listConfigChannels 19

2.19 removeChildChannels 19

2.20 removeConfigChannels 20

2.21 removeEntitlements 20

2.22 removePackageNames 21

2.23 removePackages 21

iv SUSE Manager API Documentation

2.24 removeServerGroups 22

2.25 setConfigChannels 22

2.26 setDetails 23

3 admin.monitoring 243.1 disable 24

3.2 enable 24

3.3 getStatus 25

4 api 264.1 getApiCallList 26

4.2 getApiNamespaceCallList 26

4.3 getApiNamespaces 27

4.4 getVersion 27

4.5 systemVersion 27

5 audit 295.1 listImagesByPatchStatus 29

5.2 listImagesByPatchStatus 30

5.3 listSystemsByPatchStatus 31

5.4 listSystemsByPatchStatus 32

6 auth 346.1 login 34

6.2 login 34

6.3 logout 35

7 channel 367.1 listAllChannels 36

v SUSE Manager API Documentation

7.2 listManageableChannels 36

7.3 listMyChannels 37

7.4 listPopularChannels 37

7.5 listRedHatChannels 38

7.6 listRetiredChannels 39

7.7 listSharedChannels 39

7.8 listSoftwareChannels 40

7.9 listVendorChannels 40

8 channel.access 428.1 disableUserRestrictions 42

8.2 enableUserRestrictions 42

8.3 getOrgSharing 42

8.4 setOrgSharing 43

9 channel.org 449.1 disableAccess 44

9.2 enableAccess 44

9.3 list 45

10 channel.software 4610.1 addPackages 46

10.2 addRepoFilter 46

10.3 applyChannelState 47

10.4 associateRepo 47

10.5 clearRepoFilters 48

10.6 clone 49

vi SUSE Manager API Documentation

10.7 create 49

10.8 create 50

10.9 create 51

10.10 create 52

10.11 createRepo 52

10.12 createRepo 53

10.13 createRepo 54

10.14 delete 55

10.15 disassociateRepo 55

10.16 getChannelLastBuildById 56

10.17 getDetails 57

10.18 getDetails 58

10.19 getRepoDetails 59

10.20 getRepoDetails 60

10.21 getRepoSyncCronExpression 60

10.22 isExisting 61

10.23 isGloballySubscribable 61

10.24 isUserManageable 61

10.25 isUserSubscribable 62

10.26 listAllPackages 62





vii SUSE Manager API Documentation

10.31 listAllPackagesByDate 66



10.34 listArches 68

10.35 listChannelRepos 69

10.36 listChildren 69

10.37 listErrata 71

10.38 listErrata 71

10.39 listErrata 72

10.40 listErrata 73

10.41 listErrata 73

10.42 listErrata 74

10.43 listErrataByType 75

10.44 listErrataNeedingSync 76

10.45 listLatestPackages 76

10.46 listPackagesWithoutChannel 77

10.47 listRepoFilters 78

10.48 listSubscribedSystems 78

10.49 listSystemChannels 79

10.50 listUserRepos 79

10.51 mergeErrata 80



10.54 mergePackages 82

viii SUSE Manager API Documentation

10.55 regenerateNeededCache 82

10.56 regenerateNeededCache 83

10.57 regenerateYumCache 83

10.58 removeErrata 84


10.60 removeRepo 85

10.61 removeRepo 85

10.62 removeRepoFilter 85

10.63 setContactDetails 86

10.64 setDetails 86

10.65 setDetails 87

10.66 setGloballySubscribable 88

10.67 setRepoFilters 88

10.68 setSystemChannels 89

10.69 setUserManageable 89

10.70 setUserSubscribable 90

10.71 subscribeSystem 90

10.72 syncErrata 91

10.73 syncRepo 91

10.74 syncRepo 92

10.75 syncRepo 92

10.76 syncRepo 93

10.77 syncRepo 93

10.78 unsubscribeChannels 94

ix SUSE Manager API Documentation

10.79 updateRepo 94

10.80 updateRepoLabel 95

10.81 updateRepoLabel 96

10.82 updateRepoSsl 96

10.83 updateRepoSsl 97

10.84 updateRepoUrl 98

10.85 updateRepoUrl 99

11 cluster 10011.1 addCluster 100

11.2 deleteCluster 100

11.3 listClusterNodes 101

11.4 listClusters 101

11.5 scheduleJoinNodeToCluster 101

11.6 scheduleRemoveNodeFromCluster 102

11.7 scheduleUpgradeCluster 102

12 configchannel 10412.1 channelExists 104

12.2 create 104

12.3 create 105

12.4 createOrUpdatePath 106

12.5 createOrUpdateSymlink 107

12.6 deleteChannels 109

12.7 deleteFileRevisions 109

12.8 deleteFiles 110

x SUSE Manager API Documentation

12.9 deployAllSystems 110




12.13 getDetails 112


12.15 getEncodedFileRevision 113

12.16 getFileRevision 114

12.17 getFileRevisions 116

12.18 listFiles 117

12.19 listGlobals 118

12.20 listSubscribedSystems 118

12.21 lookupChannelInfo 119

12.22 lookupFileInfo 120


12.24 scheduleFileComparisons 122

12.25 update 123

12.26 updateInitSls 123

13 contentmanagement 12613.1 attachFilter 126

13.2 attachSource 126

13.3 attachSource 127

13.4 buildProject 128

13.5 buildProject 128

xi SUSE Manager API Documentation

13.6 createEnvironment 128

13.7 createFilter 129

13.8 createProject 131

13.9 detachFilter 131

13.10 detachSource 132

13.11 listFilterCriteria 132

13.12 listFilters 133

13.13 listProjectEnvironments 133

13.14 listProjectFilters 134

13.15 listProjectSources 135

13.16 listProjects 135

13.17 lookupEnvironment 136

13.18 lookupFilter 137

13.19 lookupProject 137

13.20 lookupSource 138

13.21 promoteProject 138

13.22 removeEnvironment 139

13.23 removeFilter 139

13.24 removeProject 140

13.25 updateEnvironment 140

13.26 updateFilter 141

13.27 updateProject 142

14 distchannel 14314.1 listDefaultMaps 143

xii SUSE Manager API Documentation

14.2 listMapsForOrg 143

14.3 listMapsForOrg 144

14.4 setMapForOrg 144

15 errata 14615.1 addPackages 146

15.2 applicableToChannels 146

15.3 bugzillaFixes 147

15.4 clone 147

15.5 cloneAsOriginal 148

15.6 cloneAsOriginalAsync 149

15.7 cloneAsync 149

15.8 create 150

15.9 delete 151

15.10 findByCve 152


15.12 listAffectedSystems 153

15.13 listByDate 154

15.14 listCves 154

15.15 listKeywords 155

15.16 listPackages 155

15.17 publish 156

15.18 publishAsOriginal 157


15.20 setDetails 158

xiii SUSE Manager API Documentation

16 formula 16016.1 getCombinedFormulaDataByServerIds 160

16.2 getCombinedFormulasByServerId 160

16.3 getFormulasByGroupId 161

16.4 getFormulasByServerId 161

16.5 getGroupFormulaData 161

16.6 getSystemFormulaData 162

16.7 listFormulas 162

16.8 setFormulasOfGroup 163

16.9 setFormulasOfServer 163

16.10 setGroupFormulaData 164

16.11 setSystemFormulaData 164

17 image 16517.1 delete 165

17.2 getCustomValues 165

17.3 getDetails 165

17.4 getRelevantErrata 167

17.5 importImage 167

17.6 listImages 168


17.8 scheduleImageBuild 169

18 image.profile 17018.1 create 170

18.2 delete 170

xiv SUSE Manager API Documentation

18.3 deleteCustomValues 171


18.5 getDetails 172

18.6 listImageProfileTypes 172

18.7 listImageProfiles 173

18.8 setCustomValues 173

18.9 setDetails 174

19 image.store 17519.1 create 175

19.2 delete 175

19.3 getDetails 176

19.4 listImageStoreTypes 176

19.5 listImageStores 177

19.6 setDetails 177

20 kickstart 17920.1 cloneProfile 179

20.2 createProfile 179

20.3 createProfile 180

20.4 createProfileWithCustomUrl 180

20.5 createProfileWithCustomUrl 181

20.6 deleteProfile 181

20.7 disableProfile 182

20.8 findKickstartForIp 182

20.9 importFile 182

xv SUSE Manager API Documentation

20.10 importFile 183

20.11 importFile 183

20.12 importRawFile 184

20.13 importRawFile 185

20.14 isProfileDisabled 185

20.15 listAllIpRanges 186

20.16 listAutoinstallableChannels 186

20.17 listKickstartableChannels 187

20.18 listKickstartableTrees 188

20.19 listKickstarts 189

20.20 renameProfile 190

21 kickstart.filepreservation 19121.1 create 191

21.2 delete 191

21.3 getDetails 191

21.4 listAllFilePreservations 192

22 kickstart.keys 19322.1 create 193

22.2 delete 193

22.3 getDetails 193

22.4 listAllKeys 194

22.5 update 194

23 kickstart.profile 19623.1 addIpRange 196

xvi SUSE Manager API Documentation

23.2 addScript 196

23.3 addScript 197

23.4 addScript 197

23.5 compareActivationKeys 198

23.6 compareAdvancedOptions 200

23.7 comparePackages 201

23.8 downloadKickstart 202

23.9 downloadRenderedKickstart 202

23.10 getAdvancedOptions 203

23.11 getAvailableRepositories 203

23.12 getCfgPreservation 204

23.13 getChildChannels 204

23.14 getCustomOptions 204

23.15 getKickstartTree 205

23.16 getRepositories 205

23.17 getUpdateType 206

23.18 getVariables 206

23.19 getVirtualizationType 206

23.20 listIpRanges 207

23.21 listScripts 207

23.22 orderScripts 208

23.23 removeIpRange 209

23.24 removeScript 209

23.25 setAdvancedOptions 210

xvii SUSE Manager API Documentation

23.26 setCfgPreservation 211

23.27 setChildChannels 211

23.28 setCustomOptions 211

23.29 setKickstartTree 212

23.30 setLogging 212

23.31 setRepositories 213

23.32 setUpdateType 213

23.33 setVariables 213

23.34 setVirtualizationType 214

24 kickstart.profile.keys 21524.1 addActivationKey 215

24.2 getActivationKeys 215

24.3 removeActivationKey 216

25 kickstart.profile.software 21825.1 appendToSoftwareList 218

25.2 getSoftwareDetails 218

25.3 getSoftwareList 219

25.4 setSoftwareDetails 219

25.5 setSoftwareList 220

25.6 setSoftwareList 220

26 kickstart.profile.system 22126.1 addFilePreservations 221

26.2 addKeys 221

26.3 checkConfigManagement 222

xviii SUSE Manager API Documentation

26.4 checkRemoteCommands 222

26.5 disableConfigManagement 222

26.6 disableRemoteCommands 223

26.7 enableConfigManagement 223

26.8 enableRemoteCommands 224

26.9 getLocale 224

26.10 getPartitioningScheme 225

26.11 getRegistrationType 225

26.12 getSELinux 226

26.13 listFilePreservations 226

26.14 listKeys 227

26.15 removeFilePreservations 227

26.16 removeKeys 228

26.17 setLocale 228

26.18 setPartitioningScheme 229

26.19 setRegistrationType 229

26.20 setSELinux 230

27 kickstart.snippet 23127.1 createOrUpdate 231

27.2 delete 231

27.3 listAll 232

27.4 listCustom 232

27.5 listDefault 233

xix SUSE Manager API Documentation

28 kickstart.tree 23428.1 create 234

28.2 delete 234

28.3 deleteTreeAndProfiles 235

28.4 getDetails 235

28.5 list 236

28.6 listInstallTypes 236

28.7 rename 237

28.8 update 237

29 maintenance 23829.1 assignScheduleToSystems 238

29.2 createCalendar 238

29.3 createCalendarWithUrl 239

29.4 createSchedule 240

29.5 createSchedule 240

29.6 deleteCalendar 241

29.7 deleteSchedule 242

29.8 getCalendarDetails 243

29.9 getScheduleDetails 243

29.10 listCalendarLabels 244

29.11 listScheduleNames 244

29.12 listSystemsWithSchedule 245

29.13 refreshCalendar 245

29.14 retractScheduleFromSystems 246

xx SUSE Manager API Documentation

29.15 updateCalendar 247

29.16 updateSchedule 248

30 org 25030.1 create 250

30.2 delete 251

30.3 getCrashFileSizeLimit 251

30.4 getDetails 251

30.5 getDetails 252

30.6 getPolicyForScapFileUpload 253

30.7 getPolicyForScapResultDeletion 253

30.8 isContentStagingEnabled 254

30.9 isCrashReportingEnabled 254

30.10 isCrashfileUploadEnabled 255

30.11 isErrataEmailNotifsForOrg 255

30.12 isOrgConfigManagedByOrgAdmin 255

30.13 listOrgs 256

30.14 listUsers 257

30.15 migrateSystems 257

30.16 setContentStaging 258

30.17 setCrashFileSizeLimit 258

30.18 setCrashReporting 259

30.19 setCrashfileUpload 259

30.20 setErrataEmailNotifsForOrg 259

30.21 setOrgConfigManagedByOrgAdmin 260

xxi SUSE Manager API Documentation

30.22 setPolicyForScapFileUpload 260

30.23 setPolicyForScapResultDeletion 261

30.24 updateName 261

31 org.trusts 26331.1 addTrust 263

31.2 getDetails 263

31.3 listChannelsConsumed 264

31.4 listChannelsProvided 264

31.5 listOrgs 265

31.6 listSystemsAffected 265

31.7 listTrusts 266

31.8 removeTrust 266

32 packages 26832.1 findByNvrea 268

32.2 getDetails 269

32.3 getPackage 270

32.4 getPackageUrl 270

32.5 listChangelog 271

32.6 listDependencies 271

32.7 listFiles 272

32.8 listProvidingChannels 272

32.9 listProvidingErrata 273

32.10 listSourcePackages 273

32.11 removePackage 274

xxii SUSE Manager API Documentation

32.12 removeSourcePackage 274

33 packages.provider 27633.1 associateKey 276

33.2 list 276

33.3 listKeys 277

34 packages.search 27834.1 advanced 278

34.2 advancedWithActKey 278

34.3 advancedWithChannel 279

34.4 name 280

34.5 nameAndDescription 281

34.6 nameAndSummary 281

35 preferences.locale 28335.1 listLocales 283

35.2 listTimeZones 283

35.3 setLocale 284

35.4 setTimeZone 284

36 proxy 28536.1 activateProxy 285

36.2 createMonitoringScout 285

36.3 deactivateProxy 285

36.4 isProxy 286

36.5 listAvailableProxyChannels 286

36.6 listProxies 286

xxiii SUSE Manager API Documentation

36.7 listProxyClients 287

37 recurringaction 28837.1 create 288

37.2 delete 288

37.3 listByEntity 289

37.4 lookupById 289

37.5 update 290

38 saltkey 29138.1 delete 291

39 satellite 29239.1 isMonitoringEnabled 292

39.2 isMonitoringEnabledBySystemId 292

39.3 listProxies 292

40 schedule 29440.1 archiveActions 294

40.2 cancelActions 294

40.3 deleteActions 295

40.4 failSystemAction 295

40.5 failSystemAction 295

40.6 listAllActions 296

40.7 listArchivedActions 297

40.8 listCompletedActions 297

40.9 listCompletedSystems 298

40.10 listFailedActions 299

xxiv SUSE Manager API Documentation

40.11 listFailedSystems 299

40.12 listInProgressActions 300

40.13 listInProgressSystems 301

40.14 rescheduleActions 301

41 subscriptionmatching.pinnedsubscription 30341.1 create 303

41.2 delete 303

41.3 list 304

42 sync.content 30542.1 addChannel 305

42.2 addChannels 305

42.3 addCredentials 306

42.4 deleteCredentials 306


42.6 listCredentials 307

42.7 listProducts 308

42.8 synchronizeChannelFamilies 309

42.9 synchronizeChannels 310

42.10 synchronizeProductChannels 310

42.11 synchronizeProducts 311

42.12 synchronizeRepositories 311

42.13 synchronizeSubscriptions 311

43 sync.master 31343.1 addToMaster 313

xxv SUSE Manager API Documentation

43.2 create 313

43.3 delete 314

43.4 getDefaultMaster 314

43.5 getMaster 315

43.6 getMasterByLabel 315

43.7 getMasterOrgs 316

43.8 getMasters 316

43.9 hasMaster 317

43.10 makeDefault 317

43.11 mapToLocal 317

43.12 setCaCert 318

43.13 setMasterOrgs 318

43.14 unsetDefaultMaster 319

43.15 update 319

44 sync.slave 32144.1 create 321

44.2 delete 321

44.3 getAllowedOrgs 322

44.4 getSlave 322

44.5 getSlaveByName 323

44.6 getSlaves 323

44.7 setAllowedOrgs 324

44.8 update 324

xxvi SUSE Manager API Documentation

45 system 32645.1 addEntitlements 326

45.2 addNote 326

45.3 applyErrata 327

45.4 bootstrap 327

45.5 bootstrap 328

45.6 bootstrapWithPrivateSshKey 328

45.7 bootstrapWithPrivateSshKey 329

45.8 comparePackageProfile 329

45.9 comparePackages 330

45.10 createPackageProfile 331

45.11 createSystemProfile 332

45.12 createSystemRecord 332

45.13 createSystemRecord 333

45.14 deleteCustomValues 333

45.15 deleteGuestProfiles 334

45.16 deleteNote 334

45.17 deleteNotes 335

45.18 deletePackageProfile 335

45.19 deleteSystem 335



45.22 deleteSystems 337

45.23 deleteSystems 337

xxvii SUSE Manager API Documentation

45.24 deleteTagFromSnapshot 338

45.25 downloadSystemId 338

45.26 getConnectionPath 338

45.27 getCpu 339



45.30 getDevices 341

45.31 getDmi 342

45.32 getEntitlements 342

45.33 getEventHistory 343

45.34 getId 343

45.35 getInstalledProducts 344

45.36 getKernelLivePatch 345

45.37 getMemory 345

45.38 getMinionIdMap 346

45.39 getName 346

45.40 getNetwork 347

45.41 getNetworkDevices 347

45.42 getNetworkForSystems 348

45.43 getOsaPing 349

45.44 getRegistrationDate 349

45.45 getRelevantErrata 350

45.46 getRelevantErrataByType 350

45.47 getRunningKernel 351

xxviii SUSE Manager API Documentation

45.48 getScriptActionDetails 351

45.49 getScriptResults 352

45.50 getSubscribedBaseChannel 353

45.51 getSystemCurrencyMultipliers 354

45.52 getSystemCurrencyScores 354

45.53 getUnscheduledErrata 355

45.54 getUuid 355

45.55 getVariables 356

45.56 isNvreInstalled 356

45.57 isNvreInstalled 357

45.58 listActivationKeys 357

45.59 listActiveSystems 358

45.60 listActiveSystemsDetails 358

45.61 listAdministrators 361

45.62 listAllInstallablePackages 361

45.63 listBaseChannels 362

45.64 listChildChannels 363

45.65 listDuplicatesByHostname 363

45.66 listDuplicatesByIp 364

45.67 listDuplicatesByMac 365

45.68 listEmptySystemProfiles 365

45.69 listExtraPackages 366

45.70 listFqdns 367

45.71 listGroups 367

xxix SUSE Manager API Documentation

45.72 listInactiveSystems 368

45.73 listInactiveSystems 368

45.74 listInstalledPackages 369

45.75 listLatestAvailablePackage 369

45.76 listLatestInstallablePackages 370

45.77 listLatestUpgradablePackages 371

45.78 listMigrationTargets 371

45.79 listNewerInstalledPackages 372

45.80 listNotes 373

45.81 listOlderInstalledPackages 373

45.82 listOutOfDateSystems 374

45.83 listPackageProfiles 375

45.84 listPackageState 375


45.86 listPackagesFromChannel 376

45.87 listPhysicalSystems 377

45.88 listSubscribableBaseChannels 378

45.89 listSubscribableChildChannels 378

45.90 listSubscribedChildChannels 379

45.91 listSuggestedReboot 380

45.92 listSystemEvents 381

45.93 listSystemEvents 383

45.94 listSystemGroupsForSystemsWithEntitlement 384

45.95 listSystems 385

xxx SUSE Manager API Documentation

45.96 listSystemsWithExtraPackages 386

45.97 listSystemsWithPackage 386

45.98 listSystemsWithPackage 387

45.99 listUngroupedSystems 387

45.100 listUserSystems 388

45.101 listUserSystems 389

45.102 listVirtualGuests 389

45.103 listVirtualHosts 390

45.104 obtainReactivationKey 390

45.105 obtainReactivationKey 391

45.106 provisionSystem 391

45.107 provisionSystem 391

45.108 provisionVirtualGuest 392



45.111 removeEntitlements 393

45.112 scheduleApplyErrata 394








xxxi SUSE Manager API Documentation

45.120 scheduleApplyHighstate 399

45.121 scheduleCertificateUpdate 399

45.122 scheduleCertificateUpdate 399

45.123 scheduleChangeChannels 400

45.124 scheduleChangeChannels 400

45.125 scheduleDistUpgrade 401

45.126 scheduleDistUpgrade 402

45.127 scheduleGuestAction 402

45.128 scheduleGuestAction 403

45.129 scheduleHardwareRefresh 403

45.130 schedulePackageInstall 404




45.134 schedulePackageInstallByNevra 406




45.138 schedulePackageRefresh 409

45.139 schedulePackageRemove 409




45.143 schedulePackageRemoveByNevra 411

xxxii SUSE Manager API Documentation




45.147 scheduleReboot 414

45.148 scheduleSPMigration 415




45.152 scheduleScriptRun 417




45.156 scheduleSyncPackagesWithSystem 420

45.157 searchByName 420

45.158 sendOsaPing 421

45.159 setBaseChannel 421

45.160 setBaseChannel 422

45.161 setChildChannels 422

45.162 setCustomValues 423


45.164 setGroupMembership 424

45.165 setGuestCpus 425

45.166 setGuestMemory 425

45.167 setLockStatus 425

xxxiii SUSE Manager API Documentation

45.168 setPrimaryInterface 426

45.169 setProfileName 426

45.170 setVariables 427

45.171 tagLatestSnapshot 427

45.172 unentitle 428

45.173 updatePackageState 428

45.174 upgradeEntitlement 428

45.175 whoRegistered 429

46 system.config 43046.1 addChannels 430

46.2 createOrUpdatePath 430

46.3 createOrUpdateSymlink 432

46.4 deleteFiles 434

46.5 deployAll 434


46.7 listFiles 436


46.9 removeChannels 438

46.10 scheduleApplyConfigChannel 439

46.11 setChannels 439

47 system.crash 44047.1 createCrashNote 440

47.2 deleteCrash 440

47.3 deleteCrashNote 440

xxxiv SUSE Manager API Documentation

47.4 getCrashCountInfo 441

47.5 getCrashFile 441

47.6 getCrashFileUrl 442

47.7 getCrashNotesForCrash 442

47.8 getCrashOverview 443

47.9 getCrashesByUuid 443

47.10 listSystemCrashFiles 444

47.11 listSystemCrashes 444

48 system.custominfo 44648.1 createKey 446

48.2 deleteKey 446

48.3 listAllKeys 446

48.4 updateKey 447

49 system.provisioning.powermanagement 44849.1 getDetails 448

49.2 getDetails 448

49.3 getStatus 449

49.4 getStatus 449

49.5 listTypes 450

49.6 powerOff 450

49.7 powerOff 450

49.8 powerOn 451

49.9 powerOn 451

49.10 reboot 451

xxxv SUSE Manager API Documentation

49.11 reboot 452



50 system.provisioning.snapshot 45450.1 addTagToSnapshot 454

50.2 deleteSnapshot 454

50.3 deleteSnapshots 454

50.4 deleteSnapshots 455

50.5 listSnapshotConfigFiles 456

50.6 listSnapshotPackages 457

50.7 listSnapshots 457

50.8 rollbackToSnapshot 459

50.9 rollbackToTag 459

50.10 rollbackToTag 459

51 system.scap 46151.1 deleteXccdfScan 461

51.2 getXccdfScanDetails 461

51.3 getXccdfScanRuleResults 462

51.4 listXccdfScans 462

51.5 scheduleXccdfScan 463




xxxvi SUSE Manager API Documentation

52 system.search 46652.1 deviceDescription 466

52.2 deviceDriver 466

52.3 deviceId 467

52.4 deviceVendorId 468

52.5 hostname 468

52.6 ip 469

52.7 nameAndDescription 470

52.8 uuid 470

53 systemgroup 47253.1 addOrRemoveAdmins 472

53.2 addOrRemoveSystems 472

53.3 create 473

53.4 delete 473

53.5 getDetails 474

53.6 getDetails 474

53.7 listActiveSystemsInGroup 475

53.8 listAdministrators 475

53.9 listAllGroups 476

53.10 listGroupsWithNoAssociatedAdmins 476

53.11 listInactiveSystemsInGroup 477

53.12 listInactiveSystemsInGroup 477

53.13 listSystems 478

53.14 listSystemsMinimal 479

xxxvii SUSE Manager API Documentation

53.15 scheduleApplyErrataToActive 480

53.16 scheduleApplyErrataToActive 480

53.17 update 481

54 user 48254.1 addAssignedSystemGroup 482

54.2 addAssignedSystemGroups 482

54.3 addDefaultSystemGroup 483

54.4 addDefaultSystemGroups 483

54.5 addRole 483

54.6 create 484

54.7 create 484

54.8 delete 485

54.9 disable 485

54.10 enable 486

54.11 getCreateDefaultSystemGroup 486


54.13 getLoggedInTime 487

54.14 listAssignableRoles 488

54.15 listAssignedSystemGroups 488

54.16 listDefaultSystemGroups 489

54.17 listRoles 489

54.18 listUsers 490

54.19 removeAssignedSystemGroup 490

54.20 removeAssignedSystemGroups 491

xxxviii SUSE Manager API Documentation

54.21 removeDefaultSystemGroup 491

54.22 removeDefaultSystemGroups 492

54.23 removeRole 492

54.24 setCreateDefaultSystemGroup 492


54.26 setErrataNotifications 494

54.27 setReadOnly 494

54.28 usePamAuthentication 494

55 user.external 49655.1 createExternalGroupToRoleMap 496

55.2 createExternalGroupToSystemGroupMap 496

55.3 deleteExternalGroupToRoleMap 497

55.4 deleteExternalGroupToSystemGroupMap 497

55.5 getDefaultOrg 498

55.6 getExternalGroupToRoleMap 498

55.7 getExternalGroupToSystemGroupMap 499

55.8 getKeepTemporaryRoles 499

55.9 getUseOrgUnit 500

55.10 listExternalGroupToRoleMaps 500

55.11 listExternalGroupToSystemGroupMaps 501

55.12 setDefaultOrg 501

55.13 setExternalGroupRoles 502

55.14 setExternalGroupSystemGroups 502

55.15 setKeepTemporaryRoles 503

xxxix SUSE Manager API Documentation

55.16 setUseOrgUnit 503

56 virtualhostmanager 50456.1 create 504

56.2 delete 504

56.3 getDetail 504

56.4 getModuleParameters 505

56.5 listAvailableVirtualHostGathererModules 505

56.6 listVirtualHostManagers 506

xl SUSE Manager API Documentation

Sample ScriptsEXAMPLE 1: PERL EXAMPLE

This Perl example shows the system.listUserSystems call being used to get a list ofsystems a user has access to. In the example below, the name of each system will be printed.

#!/usr/bin/perluse Frontier::Client;

my $HOST = 'manager.example.com';my $user = 'username';my $pass = 'password';

my $client = new Frontier::Client(url => "http://$HOST/rpc/api");my $session = $client->call('auth.login',$user, $pass);

my $systems = $client->call('system.listUserSystems', $session);foreach my $system (@$systems) { print $system->{'name'}."\n";}$client->call('auth.logout', $session);

EXAMPLE 2: PYTHON 2 EXAMPLE

Below is an example of the user.listUsers call being used. Only the login of each useris printed.

#!/usr/bin/pythonimport xmlrpclib

MANAGER_URL = "http://manager.example.com/rpc/api"MANAGER_LOGIN = "username"MANAGER_PASSWORD = "password"

client = xmlrpclib.Server(MANAGER_URL, verbose=0)

key = client.auth.login(MANAGER_LOGIN, MANAGER_PASSWORD)list = client.user.list_users(key)for user in list: print user.get('login')

client.auth.logout(key)

The following code shows how to use date-time parameters. This code will scheduleimmediate installation of package rhnlib-2.5.22.9.el6.noarch to system with id1000000001.

xli SUSE Manager 24

#!/usr/bin/pythonfrom datetime import datetimeimport timeimport xmlrpclib


client = xmlrpclib.Server(MANAGER_URL, verbose=0)

key = client.auth.login(MANAGER_LOGIN, MANAGER_PASSWORD)package_list = client.packages.findByNvrea(key, 'rhnlib', '2.5.22', '9.el6', '', 'noarch')today = datetime.today()earliest_occurrence = xmlrpclib.DateTime(today)client.system.schedulePackageInstall(key, 1000000001, package_list[0]['id'], earliest_occurrence)


EXAMPLE 3: PYTHON 3 WITH SSL EXAMPLE

Below is an example of the user.listUsers call being called.

#!/usr/bin/env python3from xmlrpc.client import ServerProxyimport ssl

MANAGER_URL = "https://manager.example.com/rpc/api"MANAGER_LOGIN = "username"MANAGER_PASSWORD = "password"

# You might need to set to set other options depending on your# server SSL configuartion and your local SSL configurationcontext = ssl.create_default_context()client = ServerProxy(MANAGER_URL, context=context)key = client.auth.login(MANAGER_LOGIN, MANAGER_PASSWORD)

print(client.user.list_users(key))


EXAMPLE 4: PYTHON 3 EXAMPLE

Below is an example of the user.listUsers call being called.

#!/usr/bin/env python3

xlii SUSE Manager 24

from xmlrpc.client import ServerProxy


client = ServerProxy(MANAGER_URL)key = client.auth.login(MANAGER_LOGIN, MANAGER_PASSWORD)

print(client.user.list_users(key))


EXAMPLE 5: RUBY EXAMPLE

Below is an example of the channel.listAllChannels API call. List of channel labelsis printed.

#!/usr/bin/rubyrequire "xmlrpc/client"

@MANAGER_URL = "http://manager.example.com/rpc/api"@MANAGER_LOGIN = "username"@MANAGER_PASSWORD = "password"

@client = XMLRPC::Client.new2(@MANAGER_URL)

@key = @client.call('auth.login', @MANAGER_LOGIN, @MANAGER_PASSWORD)channels = @client.call('channel.listAllChannels', @key)for channel in channels do p channel["label"]end

@client.call('auth.logout', @key)

xliii SUSE Manager 24

Frequently Asked Questions

1. What programming languages are supported by the SUSE Manager API?

Any language that provides an XMLRPC client interface will work with the SUSE ManagerAPI. While Perl and Python are two of the most commonly used, an XMLRPC clientimplementation is available for every common language.

2. When trying to call a specific function, the error “Fault returned from XML RPC Server, fault code

-1: Could not find method METHOD in class...” is given. What is wrong?

Typically this is seen when either a function name is being called that doesn't exist,the number of parameters for a particular function is incorrect, or the type of a passedparameter is incorrect (Such as an array is expected, but a String is passed). Check allof these things.

3. Should I call an API method using the naming scheme “methodName” or “method_name”?

Both of these are valid names for the same method, so use whichever you prefer.

xliv SUSE Manager 24

1 actionchain

Provides the namespace for the Action Chain methods.

1.1 addConfigurationDeployment

Description

Adds an action to deploy a conguration le to an Action Chain.

Parameters

string sessionKey - Session token, issued at login

string chainLabel - Label of the chain

int System ID - System ID

array:

struct - cong revision specier

string "channelLabel" - Channel label

string "lePath" - Path of the conguration le

int "revision" - Revision number

Return Value

int - 1 on success, exception thrown otherwise.

1.2 addErrataUpdate

Description

Adds Errata update to an Action Chain.

Parameters


int serverId - System ID

1 addConfigurationDeployment SUSE Manager 24

array:

int - Errata IDstring chainLabel - Label of the chain

Return Value

int actionId - The action id of the scheduled action

1.3 addPackageInstallDescription

Adds package installation action to an Action Chain.

Parameters

string sessionKey - Session token, issued at loginint serverId - System IDarray:

int - Package IDstring chainLabel

Return Value


1.4 addPackageRemovalDescription

Adds an action to remove installed packages on the system to an Action Chain.

Parameters

string sessionKey - Session token, issued at loginint serverId - System IDarray:

int - Package IDstring chainLabel - Label of the chain

2 addPackageInstall SUSE Manager 24

Return Value

int actionId - The action id of the scheduled action or exception

1.5 addPackageUpgrade

Description

Adds an action to upgrade installed packages on the system to an Action Chain.

Parameters



array:

int - packageId


Return Value

int actionId - The id of the action or throw an exception

1.6 addPackageVerify

Description

Adds an action to verify installed packages on the system to an Action Chain.

Parameters



array:

int - packageId


Return Value

3 addPackageUpgrade SUSE Manager 24


1.7 addScriptRun

Description

Add an action with label to run a script to an Action Chain. NOTE: The script body mustbe Base64 encoded!

Parameters

string sessionKey - Session token, issued at loginint serverId - System IDstring chainLabel - Label of the chainstring scriptLabel - Label of the scriptstring uid - User ID on the particular systemstring gid - Group ID on the particular systemint timeout - Timeoutstring scriptBodyBase64 - Base64 encoded script body

Return Value


1.8 addScriptRun

Description

Add an action to run a script to an Action Chain. NOTE: The script body must be Base64encoded!

Parameters

string sessionKey - Session token, issued at loginint serverId - System IDstring chainLabel - Label of the chainstring uid - User ID on the particular systemstring gid - Group ID on the particular system

4 addScriptRun SUSE Manager 24

int timeout - Timeoutstring scriptBodyBase64 - Base64 encoded script body

Return Value


1.9 addSystemRebootDescription

Add system reboot to an Action Chain.

Parameters

string sessionKey - Session token, issued at loginint serverIdstring chainLabel - Label of the chain

Return Value

int actionId - The action id of the scheduled action

1.10 createChainDescription

Create an Action Chain.

Parameters

string sessionKey - Session token, issued at loginstring chainLabel - Label of the chain

Return Value

int actionId - The ID of the created action chain

1.11 deleteChainDescription

5 addSystemReboot SUSE Manager 24

Delete action chain by label.

Parameters


Return Value


1.12 listChainActions

Description

List all actions in the particular Action Chain.

Parameters


Return Value

array:

struct - entry

int "id" - Action IDstring "label" - Label of an Actionstring "created" - Created date/timestring "earliest" - Earliest scheduled date/timestring "type" - Type of the actionstring "modied" - Modied date/timestring "cuid" - Creator UID

1.13 listChains

Description

6 listChainActions SUSE Manager 24

List currently available action chains.

Parameters


Return Value

array:

struct - chain

string "label" - Label of an Action Chainstring "entrycount" - Number of entries in the Action Chain

1.14 removeActionDescription

Remove an action from an Action Chain.

Parameters

string sessionKey - Session token, issued at loginstring chainLabel - Label of the chainint actionId - Action ID

Return Value


1.15 renameChainDescription

Rename an Action Chain.

Parameters

string sessionKey - Session token, issued at loginstring previousLabel - Previous chain labelstring newLabel - New chain label

7 removeAction SUSE Manager 24

Return Value


1.16 scheduleChain

Description

Schedule the Action Chain so that its actions will actually occur.

Parameters

string sessionKey - Session token, issued at loginstring chainLabel - Label of the chaindateTime.iso8601 Earliest date

Return Value


8 scheduleChain SUSE Manager 24

2 activationkey

Contains methods to access common activation key functions available from theweb interface.

2.1 addChildChannels

Description

Add child channels to an activation key.

Parameters

string sessionKey

string key

array:

string - childChannelLabel

Return Value


2.2 addConfigChannels

Description

Given a list of activation keys and conguration channels, this method adds givenconguration channels to either the top or the bottom (whichever you specify) of anactivation key's conguration channels list. The ordering of the conguration channelsprovided in the add list is maintained while adding. If one of the conguration channelsin the 'add' list already exists in an activation key, the conguration channel will be re-ranked to the appropriate place.

Parameters

9 addChildChannels SUSE Manager 24

string sessionKey

array:

string - activationKey

array:

string - List of conguration channel labels in the ranked order.

boolean addToTop

true - To prepend the given channels to the beginning of the activation key'scong channel list

false - To append the given channels to the end of the activation key's congchannel list

Return Value


2.3 addEntitlements

Description

Add add-on System Types to an activation key.

Parameters

string sessionKey

string key

array string - Add-on system type labels to associate with the key.

container_build_host

monitoring_entitled

osimage_build_host

virtualization_host

Return Value

10 addEntitlements SUSE Manager 24


2.4 addPackageNamesDescription

Add packages to an activation key using package name only.Deprecated - being replaced by addPackages(string sessionKey, string key,array[packages])Available since API version: 10.2

Parameters

string sessionKeystring keyarray:

string - packageName

Return Value


2.5 addPackagesDescription

Add packages to an activation key.

Parameters


struct - packages

string "name" - Package namestring "arch" - Arch label - Optional

Return Value

11 addPackageNames SUSE Manager 24


2.6 addServerGroups

Description

Add server groups to an activation key.

Parameters

string sessionKey

string key

array:

int - serverGroupId

Return Value


2.7 checkConfigDeployment

Description

Check conguration le deployment status for the activation key specied.

Parameters

string sessionKey

string key

Return Value

int status - 1 if enabled, 0 if disabled, exception thrown otherwise

2.8 clone

Description

12 addServerGroups SUSE Manager 24

Clone an existing activation key.

Parameters

string sessionKey

string key - Key to be cloned.

string cloneDescription - Description of the cloned key.

Return Value

string The new activation key

2.9 create

Description

Create a new activation key. The activation key parameter passed in will be prexed withthe organization ID, and this value will be returned from the create call. Eg. If the callerpasses in the key "foo" and belong to an organization with the ID 100, the actual activationkey will be "100-foo". This call allows for the setting of a usage limit on this activationkey. If unlimited usage is desired see the similarly named API method with no usage limitargument.

Parameters

string sessionKey

string key - Leave empty to have new key autogenerated.

string description

string baseChannelLabel - Leave empty to accept default.

int usageLimit - If unlimited usage is desired, use the create API that does not includethe parameter.

array string - Add-on system type labels to associate with the key.

container_build_host

monitoring_entitled

osimage_build_host

virtualization_host

boolean universalDefault

13 create SUSE Manager 24

Return Value


2.10 createDescription

Create a new activation key with unlimited usage. The activation key parameter passed inwill be prexed with the organization ID, and this value will be returned from the createcall. Eg. If the caller passes in the key "foo" and belong to an organization with the ID 100,the actual activation key will be "100-foo".

Parameters

string sessionKeystring key - Leave empty to have new key autogenerated.string descriptionstring baseChannelLabel - Leave empty to accept default.array string - Add-on entitlement label to associate with the key.

virtualization_hostboolean universalDefault

Return Value


2.11 deleteDescription

Delete an activation key.

Parameters

string sessionKeystring key

Return Value



2.12 disableConfigDeployment

Description

Disable conguration le deployment for the specied activation key.

Parameters


Return Value


2.13 enableConfigDeployment

Description

Enable conguration le deployment for the specied activation key.

Parameters


Return Value


2.14 getDetails

Description

Lookup an activation key's details.Available since API version: 10.2

Parameters

15 disableConfigDeployment SUSE Manager 24


Return Value

struct - activation key

string "key"string "description"int "usage_limit"string "base_channel_label"array "child_channel_labels"

string - childChannelLabelarray "entitlements"

string - entitlementLabelarray "server_group_ids"

string - serverGroupIdarray "package_names"

string - packageName - (deprecated by packages)array "packages"

struct - package

string "name" - packageNamestring "arch" - archLabel - optional

boolean "universal_default"boolean "disabled"string "contact_method" - One of the following:

defaultssh-pushssh-push-tunnel

2.15 listActivatedSystemsDescription

16 listActivatedSystems SUSE Manager 24

List the systems activated with the key provided.

Parameters


Return Value

array:

struct - system structure

int "id" - System idstring "hostname"dateTime.iso8601 "last_checkin" - Last time server successfully checked in

2.16 listActivationKeysDescription

List activation keys that are visible to the user.Available since API version: 10.2

Parameters

string sessionKey

Return Value

array:

struct - activation key

string "key"string "description"int "usage_limit"string "base_channel_label"array "child_channel_labels"

string - childChannelLabelarray "entitlements"

17 listActivationKeys SUSE Manager 24

string - entitlementLabel

array "server_group_ids"

string - serverGroupId

array "package_names"

string - packageName - (deprecated by packages)

array "packages"

struct - package

string "name" - packageName

string "arch" - archLabel - optional

boolean "universal_default"

boolean "disabled"

string "contact_method" - One of the following:

default

ssh-push

ssh-push-tunnel

2.17 listChannels

Description

List the channels for the given activation key with temporary authentication tokens toaccess them. Authentication is done via a machine specic password.

Parameters

string minionId - The id of the minion to authenticate with.

string machinePassword - password specic to a machine.

string activationKey - activation key to use channels from.

Return Value

array:

struct - channelInfo

18 listChannels SUSE Manager 24

string "label" - Channel labelstring "name" - Channel namestring "url" - Channel urlstring "token" - Channel access token

2.18 listConfigChannelsDescription

List conguration channels associated to an activation key.

Parameters


Return Value

array:

struct - Conguration Channel information

int "id"int "orgId"string "label"string "name"string "description"struct "congChannelType"struct - Conguration Channel Type information

int "id"string "label"string "name"int "priority"

2.19 removeChildChannelsDescription

19 listConfigChannels SUSE Manager 24

Remove child channels from an activation key.

Parameters


string - childChannelLabel

Return Value


2.20 removeConfigChannels

Description

Remove conguration channels from the given activation keys.

Parameters

string sessionKeyarray:

string - activationKeyarray:

string - congChannelLabel

Return Value


2.21 removeEntitlements

Description

Remove entitlements (by label) from an activation key. Currently only virtualization_hostadd-on entitlement is permitted.

20 removeConfigChannels SUSE Manager 24

Parameters

string sessionKeystring keyarray string - entitlement label

virtualization_host

Return Value


2.22 removePackageNames

Description

Remove package names from an activation key.Deprecated - being replaced by removePackages(string sessionKey, string key,array[packages])Available since API version: 10.2

Parameters


string - packageName

Return Value


2.23 removePackages

Description

Remove package names from an activation key.

Parameters

21 removePackageNames SUSE Manager 24

string sessionKey

string key

array:

struct - packages

string "name" - Package name

string "arch" - Arch label - Optional

Return Value


2.24 removeServerGroups

Description

Remove server groups from an activation key.

Parameters

string sessionKey

string key

array:

int - serverGroupId

Return Value


2.25 setConfigChannels

Description

Replace the existing set of conguration channels on the given activation keys. Channelsare ranked by their order in the array.

Parameters

22 removeServerGroups SUSE Manager 24


string - activationKeyarray:

string - congChannelLabel

Return Value


2.26 setDetailsDescription

Update the details of an activation key.

Parameters

string sessionKeystring keystruct - activation key

string "description" - optionalstring "base_channel_label" - optional - to set default base channel set to emptystring or 'none'int "usage_limit" - optionalboolean "unlimited_usage_limit" - Set true for unlimited usage and to overrideusage_limitboolean "universal_default" - optionalboolean "disabled" - optionalstring "contact_method" - One of the following:

defaultssh-pushssh-push-tunnel

Return Value


23 setDetails SUSE Manager 24

3 admin.monitoring

Provides methods to manage the monitoring of the SUSE Manager server.

3.1 disableDescription

Disable monitoring.

Parameters

string sessionKey

Return Value

array:

struct - Exporters

string "node"string "tomcat"string "taskomatic"string "postgres"string "self_monitoring"

3.2 enableDescription

Enable monitoring.

Parameters

string sessionKey

Return Value

array:

struct - Exporters

24 disable SUSE Manager 24


3.3 getStatus

Description

Get the status of each Prometheus exporter.

Parameters

string sessionKey

Return Value

array:

struct - Exporters


25 getStatus SUSE Manager 24

4 api

Methods providing information about the API.

4.1 getApiCallListDescription

Lists all available api calls grouped by namespace

Parameters

string sessionKey

Return Value

struct - method_info

string "name" - method namestring "parameters" - method parametersstring "exceptions" - method exceptionsstring "return" - method return type

4.2 getApiNamespaceCallListDescription

Lists all available api calls for the specied namespace

Parameters

string sessionKeystring namespace

Return Value

struct - method_info

string "name" - method namestring "parameters" - method parameters

26 getApiCallList SUSE Manager 24

string "exceptions" - method exceptionsstring "return" - method return type

4.3 getApiNamespacesDescription

Lists available API namespaces

Parameters

string sessionKey

Return Value

struct - namespace

string "namespace" - API namespacestring "handler" - API Handler

4.4 getVersionDescription

Returns the version of the API.

Parameters

None

Return Value

string version

4.5 systemVersionDescription

Returns the server version.

Parameters

27 getApiNamespaces SUSE Manager 24

None

Return Value

string version

28 systemVersion SUSE Manager 24

5 audit

Methods to audit systems.

5.1 listImagesByPatchStatus

Description

List visible images with their patch status regarding a given CVE identier. Please note thatthe query code relies on data that is pre-generated by the 'cve-server-channels' taskomaticjob.

Parameters

string sessionKey

string cveIdentier

Return Value

array:

struct - cve_audit_image

int "image_id"

string "patch_status"

AFFECTED_PATCH_INAPPLICABLE - Aected, patch available inunassigned channel

AFFECTED_PATCH_APPLICABLE - Aected, patch available inassigned channel

NOT_AFFECTED - Not aected

PATCHED - Patched

array "string"

channel_labels - Labels of channels that contain an unapplied patch

array "string"

29 listImagesByPatchStatus SUSE Manager 24

errata_advisories - Advisories of erratas that patch the speciedvulnerability

5.2 listImagesByPatchStatus

Description

List visible images with their patch status regarding a given CVE identier. Filter the resultsby passing in a list of patch status labels. Please note that the query code relies on datathat is pre-generated by the 'cve-server-channels' taskomatic job.

Parameters

string sessionKey

string cveIdentier

array:

string - patchStatusLabel

AFFECTED_PATCH_INAPPLICABLE - Aected, patch available in unassignedchannel

AFFECTED_PATCH_APPLICABLE - Aected, patch available in assigned channel


PATCHED - Patched

Return Value

array:

struct - cve_audit_image

int "image_id"





PATCHED - Patched

30 listImagesByPatchStatus SUSE Manager 24

array "string"


array "string"


5.3 listSystemsByPatchStatus

Description

List visible systems with their patch status regarding a given CVE identier. Please note thatthe query code relies on data that is pre-generated by the 'cve-server-channels' taskomaticjob.

Parameters

string sessionKey

string cveIdentier

Return Value

array:

struct - cve_audit_system

int "system_id"





PATCHED - Patched

array "string"


array "string"

31 listSystemsByPatchStatus SUSE Manager 24


5.4 listSystemsByPatchStatus

Description

List visible systems with their patch status regarding a given CVE identier. Filter theresults by passing in a list of patch status labels. Please note that the query code relies ondata that is pre-generated by the 'cve-server-channels' taskomatic job.

Parameters

string sessionKey

string cveIdentier

array:

string - patchStatusLabel

AFFECTED_PATCH_INAPPLICABLE - Aected, patch available in unassignedchannel

AFFECTED_PATCH_APPLICABLE - Aected, patch available in assigned channel


PATCHED - Patched

Return Value

array:

struct - cve_audit_system

int "system_id"





PATCHED - Patched


array "string"

channel_labels - Labels of channels that contain an unapplied patcharray "string"



6 auth

This namespace provides methods to authenticate with the system's managementserver.

6.1 login

Description

Login using a username and password. Returns the session key used by most other APImethods.

Parameters

string username

string password

Return Value

string sessionKey

6.2 login

Description

Login using a username and password. Returns the session key used by other methods.

Parameters

string username

string password

int duration - Length of session.

Return Value

34 login SUSE Manager 24

string sessionKey

6.3 logout

Description

Logout the user with the given session key.

Parameters

string sessionKey

Return Value


35 logout SUSE Manager 24

7 channel

Provides method to get back a list of Software Channels.

7.1 listAllChannels

Description

List all software channels that the user's organization is entitled to.

Parameters

string sessionKey

Return Value

array:

struct - channel info

int "id"string "label"string "name"string "provider_name"int "packages"int "systems"string "arch_name"

7.2 listManageableChannels

Description

List all software channels that the user is entitled to manage.

Parameters

string sessionKey

Return Value

36 listAllChannels SUSE Manager 24

array:



7.3 listMyChannelsDescription

List all software channels that belong to the user's organization.

Parameters

string sessionKey

Return Value

array:



7.4 listPopularChannelsDescription

37 listMyChannels SUSE Manager 24

List the most popular software channels. Channels that have at least the number of systemssubscribed as specied by the popularity count will be returned.

Parameters

string sessionKeyint popularityCount

Return Value

array:



7.5 listRedHatChannelsDescription

List all Red Hat software channels that the user's organization is entitled to.Deprecated - being replaced by listVendorChannels(String sessionKey)

Parameters

string sessionKey

Return Value

array:


int "id"string "label"string "name"

38 listRedHatChannels SUSE Manager 24

string "provider_name"int "packages"int "systems"string "arch_name"

7.6 listRetiredChannelsDescription

List all retired software channels. These are channels that the user's organization is entitledto, but are no longer supported because they have reached their 'end-of-life' date.

Parameters

string sessionKey

Return Value

array:



7.7 listSharedChannelsDescription

List all software channels that may be shared by the user's organization.

Parameters

string sessionKey

Return Value

39 listRetiredChannels SUSE Manager 24

array:


int "id"

string "label"

string "name"

string "provider_name"

int "packages"

int "systems"

string "arch_name"

7.8 listSoftwareChannels

Description

List all visible software channels.

Parameters

string sessionKey

Return Value

array:

struct - channel

string "label"

string "name"

string "parent_label"

string "end_of_life"

string "arch"

7.9 listVendorChannels

Description

Lists all the vendor software channels that the user's organization is entitled to.

40 listSoftwareChannels SUSE Manager 24

Parameters

string sessionKey

Return Value

array:



41 listVendorChannels SUSE Manager 24

8 channel.access

Provides methods to retrieve and alter channel access restrictions.

8.1 disableUserRestrictionsDescription

Disable user restrictions for the given channel. If disabled, all users within the organizationmay subscribe to the channel.

Parameters

string sessionKeystring channelLabel - label of the channel

Return Value


8.2 enableUserRestrictionsDescription

Enable user restrictions for the given channel. If enabled, only selected users within theorganization may subscribe to the channel.

Parameters


Return Value


8.3 getOrgSharingDescription

42 disableUserRestrictions SUSE Manager 24

Get organization sharing access control.

Parameters


Return Value

string access - The access value (one of the following: 'public', 'private', or 'protected'

8.4 setOrgSharing

Description

Set organization sharing access control.

Parameters

string sessionKeystring channelLabel - label of the channelstring access - Access (one of the following: 'public', 'private', or 'protected'

Return Value


43 setOrgSharing SUSE Manager 24

9 channel.org

Provides methods to retrieve and alter organization trust relationships for achannel.

9.1 disableAccess

Description

Disable access to the channel for the given organization.

Parameters

string sessionKey

string channelLabel - label of the channel

int orgId - id of org being removed access

Return Value


9.2 enableAccess

Description

Enable access to the channel for the given organization.

Parameters

string sessionKey

string channelLabel - label of the channel

int orgId - id of org being granted access

Return Value

44 disableAccess SUSE Manager 24


9.3 list

Description

List the organizations associated with the given channel that may be trusted.

Parameters


Return Value

array:

struct - org

int "org_id"string "org_name"boolean "access_enabled"

45 list SUSE Manager 24

10 channel.software

Provides methods to access and modify many aspects of a channel.

10.1 addPackages

Description

Adds a given list of packages to the given channel.

Parameters

string sessionKey

string channelLabel - target channel.

array:

int - packageId - id of a package to add to the channel.

Return Value


10.2 addRepoFilter

Description

Adds a lter for a given repo.

Parameters

string sessionKey

string label - repository label

struct - lter_map

string "lter" - string to lter on

string "ag" - + for include, - for exclude

Return Value

46 addPackages SUSE Manager 24

int order - sort order for new lter

10.3 applyChannelState

Description

Refresh pillar data and then schedule channels state on the provided systems

Parameters


int - serverId

Return Value

array:

int - actionId

10.4 associateRepo

Description

Associates a repository with a channel

Parameters

string sessionKeystring channelLabel - channel labelstring repoLabel - repository label

Return Value

struct - channel

int "id"string "name"string "label"

47 applyChannelState SUSE Manager 24

string "arch_name"

string "arch_label"

string "summary"

string "description"

string "checksum_label"

dateTime.iso8601 "last_modied"

string "maintainer_name"

string "maintainer_email"

string "maintainer_phone"

string "support_policy"

string "gpg_key_url"

string "gpg_key_id"

string "gpg_key_fp"

dateTime.iso8601 "yumrepo_last_sync" - (optional)


string "parent_channel_label"

string "clone_original"

array:

struct - contentSources

int "id"

string "label"

string "sourceUrl"

string "type"

10.5 clearRepoFilters

Description

Removes the lters for a repo

Parameters

string sessionKey

string label - repository label

Return Value

48 clearRepoFilters SUSE Manager 24


10.6 clone

Description

Clone a channel. If arch_label is omitted, the arch label of the original channel will be used.If parent_label is omitted, the clone will be a base channel.

Parameters

string sessionKeystring original_labelstruct - channel details

string "name"string "label"string "summary"string "parent_label" - (optional)string "arch_label" - (optional)string "gpg_key_url" - (optional), gpg_url might be used as wellstring "gpg_key_id" - (optional), gpg_id might be used as wellstring "gpg_key_fp" - (optional), gpg_ngerprint might be used as wellstring "gpg_check" - (optional)string "description" - (optional)string "checksum" - either sha1 or sha256

boolean original_state

Return Value

int id - the cloned channel ID

10.7 create

Description

Creates a software channelAvailable since API version: 10.9

49 clone SUSE Manager 24

Parameters

string sessionKeystring label - label of the new channelstring name - name of the new channelstring summary - summary of the channelstring archLabel - the label of the architecture the channel corresponds to, runchannel.software.listArches API for complete listingstring parentLabel - label of the parent of this channel, an empty string if it doesnot have onestring checksumType - checksum type for this channel, used for yum repositorymetadata generation

sha1 - Oers widest compatibility with clientssha256 - Oers highest security, but is compatible only with newer clients:Fedora 11 and newer, or Enterprise Linux 6 and newer.

struct - gpgKey

string "url" - GPG key URLstring "id" - GPG key IDstring "ngerprint" - GPG key Fingerprint

boolean gpgCheck - true if the GPG check should be enabled by default, falseotherwise

Return Value

int status - 1 if the creation operation succeeded, 0 otherwise

10.8 create

Description


Parameters

string sessionKeystring label - label of the new channel


string name - name of the new channelstring summary - summary of the channelstring archLabel - the label of the architecture the channel corresponds to, runchannel.software.listArches API for complete listingstring parentLabel - label of the parent of this channel, an empty string if it doesnot have onestring checksumType - checksum type for this channel, used for yum repositorymetadata generation

sha1 - Oers widest compatibility with clientssha256 - Oers highest security, but is compatible only with newer clients:Fedora 11 and newer, or Enterprise Linux 6 and newer.

struct - gpgKey

string "url" - GPG key URLstring "id" - GPG key IDstring "ngerprint" - GPG key Fingerprint

Return Value


10.9 create

Description


Parameters

string sessionKeystring label - label of the new channelstring name - name of the new channelstring summary - summary of the channelstring archLabel - the label of the architecture the channel corresponds to, runchannel.software.listArches API for complete listingstring parentLabel - label of the parent of this channel, an empty string if it doesnot have one


string checksumType - checksum type for this channel, used for yum repositorymetadata generation

sha1 - Oers widest compatibility with clients

sha256 - Oers highest security, but is compatible only with newer clients:Fedora 11 and newer, or Enterprise Linux 6 and newer.

Return Value


10.10 create

Description

Creates a software channel

Parameters

string sessionKey

string label - label of the new channel

string name - name of the new channel

string summary - summary of the channel

string archLabel - the label of the architecture the channel corresponds to, runchannel.software.listArches API for complete listing

string parentLabel - label of the parent of this channel, an empty string if it doesnot have one

Return Value


10.11 createRepo

Description

Creates a repository

Parameters


string sessionKeystring label - repository labelstring type - repository type (yum, uln...)string url - repository url

Return Value

struct - channel

int "id"string "label"string "sourceUrl"string "type"boolean "hasSignedMetadata"array "sslContentSources" -

struct - contentsourcessl

string "sslCaDesc"string "sslCertDesc"string "sslKeyDesc"

10.12 createRepo

Description


Parameters

string sessionKeystring label - repository labelstring type - repository type (yum, uln...)string url - repository urlstring sslCaCert - SSL CA cert descriptionstring sslCliCert - SSL Client cert descriptionstring sslCliKey - SSL Client key description

Return Value

53 createRepo SUSE Manager 24

struct - channel




10.13 createRepo

Description


Parameters

string sessionKeystring label - repository labelstring type - repository type (only YUM is supported)string url - repository urlstring sslCaCert - SSL CA cert description, or an empty stringstring sslCliCert - SSL Client cert description, or an empty stringstring sslCliKey - SSL Client key description, or an empty stringboolean hasSignedMetadata - true if the repository has signed metadata, falseotherwise

Return Value

struct - channel

int "id"string "label"

54 createRepo SUSE Manager 24

string "sourceUrl"

string "type"

boolean "hasSignedMetadata"

array "sslContentSources" -


string "sslCaDesc"

string "sslCertDesc"

string "sslKeyDesc"

10.14 delete

Description

Deletes a custom software channel

Parameters

string sessionKey

string channelLabel - channel to delete

Return Value


10.15 disassociateRepo

Description

Disassociates a repository from a channel

Parameters

string sessionKey

string channelLabel - channel label

string repoLabel - repository label

Return Value

55 delete SUSE Manager 24

struct - channel

int "id"string "name"string "label"string "arch_name"string "arch_label"string "summary"string "description"string "checksum_label"dateTime.iso8601 "last_modied"string "maintainer_name"string "maintainer_email"string "maintainer_phone"string "support_policy"string "gpg_key_url"string "gpg_key_id"string "gpg_key_fp"dateTime.iso8601 "yumrepo_last_sync" - (optional)string "end_of_life"string "parent_channel_label"string "clone_original"array:


int "id"string "label"string "sourceUrl"string "type"

10.16 getChannelLastBuildByIdDescription

Returns the last build date of the repomd.xml le for the given channel as a localised string.

Parameters

56 getChannelLastBuildById SUSE Manager 24

string sessionKeyint id - id of channel wanted

Return Value

date date - the last build date of the repomd.xml le as a localised string

10.17 getDetails

Description

Returns details of the given channel as a map

Parameters

string sessionKeystring channelLabel - channel to query

Return Value

struct - channel

int "id"string "name"string "label"string "arch_name"string "arch_label"string "summary"string "description"string "checksum_label"dateTime.iso8601 "last_modied"string "maintainer_name"string "maintainer_email"string "maintainer_phone"string "support_policy"string "gpg_key_url"string "gpg_key_id"string "gpg_key_fp"dateTime.iso8601 "yumrepo_last_sync" - (optional)

57 getDetails SUSE Manager 24

string "end_of_life"string "parent_channel_label"string "clone_original"array:



10.18 getDetails

Description

Returns details of the given channel as a map

Parameters

string sessionKeyint id - channel to query

Return Value

struct - channel

int "id"string "name"string "label"string "arch_name"string "arch_label"string "summary"string "description"string "checksum_label"dateTime.iso8601 "last_modied"string "maintainer_name"string "maintainer_email"string "maintainer_phone"

58 getDetails SUSE Manager 24

string "support_policy"string "gpg_key_url"string "gpg_key_id"string "gpg_key_fp"dateTime.iso8601 "yumrepo_last_sync" - (optional)string "end_of_life"string "parent_channel_label"string "clone_original"array:



10.19 getRepoDetailsDescription

Returns details of the given repository

Parameters

string sessionKeystring repoLabel - repo to query

Return Value

struct - channel



59 getRepoDetails SUSE Manager 24


10.20 getRepoDetailsDescription

Returns details of the given repository

Parameters

string sessionKeyint id - repository id

Return Value

struct - channel




10.21 getRepoSyncCronExpressionDescription

Returns repo synchronization cron expression

Parameters

60 getRepoDetails SUSE Manager 24

string sessionKeystring channelLabel - channel label

Return Value

string expression - quartz expression

10.22 isExistingDescription

Returns whether is existing

Parameters


Return Value

boolean result - True if the channel exists

10.23 isGloballySubscribableDescription

Returns whether the channel is subscribable by any user in the organization

Parameters


Return Value

int subscribable - 1 if true, 0 otherwise

10.24 isUserManageableDescription

61 isExisting SUSE Manager 24

Returns whether the channel may be managed by the given user.

Parameters

string sessionKeystring channelLabel - label of the channelstring login - login of the target user

Return Value

int status - 1 if manageable, 0 if not

10.25 isUserSubscribable

Description

Returns whether the channel may be subscribed to by the given user.

Parameters

string sessionKeystring channelLabel - label of the channelstring login - login of the target user

Return Value

int status - 1 if subscribable, 0 if not

10.26 listAllPackages

Description

Lists all packages in the channel, regardless of package version, between the given dates.

Parameters

string sessionKeystring channelLabel - channel to querydateTime.iso8601 startDatedateTime.iso8601 endDate

62 isUserSubscribable SUSE Manager 24

Return Value

array:

struct - package

string "name"string "version"string "release"string "epoch"string "checksum"string "checksum_type"int "id"string "arch_label"string "last_modied_date"string "last_modied" - (Deprecated)

10.27 listAllPackagesDescription

Lists all packages in the channel, regardless of version whose last modied date is greaterthan given date.

Parameters

string sessionKeystring channelLabel - channel to querydateTime.iso8601 startDate

Return Value

array:

struct - package

string "name"string "version"string "release"string "epoch"

63 listAllPackages SUSE Manager 24

string "checksum"string "checksum_type"int "id"string "arch_label"string "last_modied_date"string "last_modied" - (Deprecated)


Lists all packages in the channel, regardless of the package version

Parameters


Return Value

array:

struct - package




Lists all packages in the channel, regardless of package version, between the given dates.Example Date: '2008-08-20 08:00:00'Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel,dateTime.iso8601 startDate, dateTime.iso8601 endDate)

Parameters

string sessionKeystring channelLabel - channel to querystring startDatestring endDate

Return Value

array:

struct - package


10.30 listAllPackages

Description

Lists all packages in the channel, regardless of version whose last modied date is greaterthan given date. Example Date: '2008-08-20 08:00:00'Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel,dateTime.iso8601 startDate)

Parameters


string sessionKey

string channelLabel - channel to query

string startDate

Return Value

array:

struct - package

string "name"

string "version"

string "release"

string "epoch"

string "checksum"

string "checksum_type"

int "id"

string "arch_label"

string "last_modied_date"

string "last_modied" - (Deprecated)

10.31 listAllPackagesByDate

Description

Lists all packages in the channel, regardless of the package version, between the givendates. Example Date: '2008-08-20 08:00:00'Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel,dateTime.iso8601 startDate, dateTime.iso8601 endDate)

Parameters

string sessionKey


string startDate

string endDate

Return Value

66 listAllPackagesByDate SUSE Manager 24

array:

struct - package

string "name"

string "version"

string "release"

string "epoch"

string "id"

string "arch_label"

string "last_modied"

10.32 listAllPackagesByDate

Description

Lists all packages in the channel, regardless of the package version, whose last modieddate is greater than given date. Example Date: '2008-08-20 08:00:00'Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel,dateTime.iso8601 startDate)

Parameters

string sessionKey


string startDate

Return Value

array:

struct - package

string "name"

string "version"

string "release"

string "epoch"

string "id"


string "arch_label"string "last_modied"

10.33 listAllPackagesByDateDescription

Lists all packages in the channel, regardless of the package versionDeprecated - being replaced by listAllPackages(string sessionKey, string channelLabel)

Parameters


Return Value

array:

struct - package

string "name"string "version"string "release"string "epoch"string "id"string "arch_label"string "last_modied"

10.34 listArchesDescription

Lists the potential software channel architectures that can be created

Parameters

string sessionKey

Return Value


array:

struct - channel arch

string "name"string "label"

10.35 listChannelReposDescription

Lists associated repos with the given channel

Parameters

string sessionKeystring channelLabel - channel label

Return Value

array:

struct - channel




10.36 listChildrenDescription

69 listChannelRepos SUSE Manager 24

List the children of a channel

Parameters

string sessionKey

string channelLabel - the label of the channel

Return Value

array:

struct - channel

int "id"

string "name"

string "label"

string "arch_name"

string "arch_label"

string "summary"

string "description"

string "checksum_label"

dateTime.iso8601 "last_modied"

string "maintainer_name"

string "maintainer_email"

string "maintainer_phone"

string "support_policy"

string "gpg_key_url"

string "gpg_key_id"

string "gpg_key_fp"

dateTime.iso8601 "yumrepo_last_sync" - (optional)


string "parent_channel_label"

string "clone_original"

array:


int "id"

string "label"

70 listChildren SUSE Manager 24

string "sourceUrl"

string "type"

10.37 listErrata

Description

List the errata applicable to a channel after given startDate

Parameters

string sessionKey


dateTime.iso8601 startDate

Return Value

array:

struct -

Documents

SUSE Manager API Documentation - SUSE Manager 24 · 2021. 2. 11. · 8.3 getOrgSharing 42 8.4 setOrgSharing 43 9 channel.org44 9.1 disableAccess 44 9.2 enableAccess 44 9.3 list 45