SUSE Manager API Documentation - SUSE Manager 4...21.1 addIpRange 190 21.2 addScript 190 21.3...

SUSE Manager APIDocumentation

SUSE Manager 4.0

SUSE Manager API Documentation

SUSE Manager 4.0

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

Publication Date: 09/25/2019

SUSE LLC10 Canal Park DriveSuite 200Cambridge MA 02141USA

https://www.suse.com/documentation

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://www.suse.com/documentation

Contents

Sample Scripts xxxviii

Frequently Asked Questions xli

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 10

2.5 addPackages 11

2.6 addServerGroups 11

2.7 checkConfigDeployment 12

2.8 clone 12

2.9 create 13

2.10 create 13

2.11 delete 14

2.12 disableConfigDeployment 14

2.13 enableConfigDeployment 15

2.14 getDetails 15

2.15 listActivatedSystems 16

2.16 listActivationKeys 17

2.17 listChannels 18

2.18 listConfigChannels 18

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 api 243.1 getApiCallList 24

3.2 getApiNamespaceCallList 24

3.3 getApiNamespaces 25

3.4 getVersion 25

3.5 systemVersion 25

4 audit 274.1 listImagesByPatchStatus 27

4.2 listImagesByPatchStatus 28

4.3 listSystemsByPatchStatus 29

4.4 listSystemsByPatchStatus 30

5 auth 325.1 login 32

5.2 login 32

5.3 logout 33

6 channel 346.1 listAllChannels 34

6.2 listManageableChannels 34

6.3 listMyChannels 35

6.4 listPopularChannels 35

6.5 listRedHatChannels 36

v SUSE Manager API Documentation

6.6 listRetiredChannels 37

6.7 listSharedChannels 37

6.8 listSoftwareChannels 38

6.9 listVendorChannels 38

7 channel.access 407.1 disableUserRestrictions 40

7.2 enableUserRestrictions 40

7.3 getOrgSharing 40

7.4 setOrgSharing 41

8 channel.org 428.1 disableAccess 42

8.2 enableAccess 42

8.3 list 43

9 channel.software 449.1 addPackages 44

9.2 addRepoFilter 44

9.3 applyChannelState 45

9.4 associateRepo 45

9.5 clearRepoFilters 46

9.6 clone 47

9.7 create 47

9.8 create 48

9.9 create 49

9.10 create 50

vi SUSE Manager API Documentation

9.11 createRepo 50

9.12 createRepo 51

9.13 createRepo 52

9.14 delete 53

9.15 disassociateRepo 53

9.16 getChannelLastBuildById 54

9.17 getDetails 55

9.18 getDetails 56

9.19 getRepoDetails 57

9.20 getRepoDetails 58

9.21 getRepoSyncCronExpression 58

9.22 getTaskomaticApi 59

9.23 isGloballySubscribable 59

9.24 isUserManageable 59

9.25 isUserSubscribable 60

9.26 listAllPackages 60





9.31 listAllPackagesByDate 64



9.34 listArches 66

vii SUSE Manager API Documentation

9.35 listChannelRepos 67

9.36 listChildren 67

9.37 listErrata 69

9.38 listErrata 69

9.39 listErrata 70

9.40 listErrata 71

9.41 listErrata 71

9.42 listErrata 72

9.43 listErrataByType 73

9.44 listErrataNeedingSync 74

9.45 listLatestPackages 74

9.46 listPackagesWithoutChannel 75

9.47 listRepoFilters 76

9.48 listSubscribedSystems 76

9.49 listSystemChannels 77

9.50 listUserRepos 77

9.51 mergeErrata 78

9.52 mergeErrata 78

9.53 mergeErrata 79

9.54 mergePackages 80

9.55 regenerateNeededCache 80

9.56 regenerateNeededCache 81

9.57 regenerateYumCache 81

9.58 removeErrata 82

viii SUSE Manager API Documentation


9.60 removeRepo 83

9.61 removeRepo 83

9.62 removeRepoFilter 83

9.63 setContactDetails 84

9.64 setDetails 84

9.65 setDetails 85

9.66 setGloballySubscribable 86

9.67 setRepoFilters 86

9.68 setSystemChannels 87

9.69 setUserManageable 87

9.70 setUserSubscribable 88

9.71 subscribeSystem 88

9.72 syncErrata 89

9.73 syncRepo 89

9.74 syncRepo 90

9.75 syncRepo 90

9.76 syncRepo 91

9.77 syncRepo 91

9.78 unsubscribeChannels 92

9.79 updateRepo 92

9.80 updateRepoLabel 93

9.81 updateRepoLabel 94

9.82 updateRepoSsl 94

ix SUSE Manager API Documentation

9.83 updateRepoSsl 95

9.84 updateRepoUrl 96

9.85 updateRepoUrl 97

10 configchannel 9810.1 channelExists 98

10.2 create 98

10.3 create 99

10.4 createOrUpdatePath 100

10.5 createOrUpdateSymlink 101

10.6 deleteChannels 103

10.7 deleteFileRevisions 103

10.8 deleteFiles 104

10.9 deployAllSystems 104




10.13 getDetails 106


10.15 getEncodedFileRevision 107

10.16 getFileRevision 108

10.17 getFileRevisions 110

10.18 listFiles 111

10.19 listGlobals 112

10.20 listSubscribedSystems 112

x SUSE Manager API Documentation

10.21 lookupChannelInfo 113

10.22 lookupFileInfo 114


10.24 scheduleFileComparisons 116

10.25 update 117

10.26 updateInitSls 117

11 contentmgmt 12011.1 attachFilter 120

11.2 attachSource 120

11.3 attachSource 121

11.4 buildProject 122

11.5 buildProject 122

11.6 createEnvironment 122

11.7 createFilter 123

11.8 createProject 124

11.9 detachFilter 125

11.10 detachSource 125

11.11 listFilters 125

11.12 listProjectEnvironments 126

11.13 listProjectFilters 127

11.14 listProjectSources 128

11.15 listProjects 128

11.16 lookupEnvironment 129

11.17 lookupFilter 130

xi SUSE Manager API Documentation

11.18 lookupProject 130

11.19 lookupSource 131

11.20 promoteProject 131

11.21 removeEnvironment 132

11.22 removeFilter 132

11.23 removeProject 133

11.24 updateEnvironment 133

11.25 updateFilter 134

11.26 updateProject 135

12 distchannel 13612.1 listDefaultMaps 136

12.2 listMapsForOrg 136

12.3 listMapsForOrg 137

12.4 setMapForOrg 137

13 errata 13913.1 addPackages 139

13.2 applicableToChannels 139

13.3 bugzillaFixes 140

13.4 clone 140

13.5 cloneAsOriginal 141

13.6 cloneAsOriginalAsync 142

13.7 cloneAsync 142

13.8 create 143

13.9 delete 144

xii SUSE Manager API Documentation

13.10 findByCve 145


13.12 listAffectedSystems 146

13.13 listByDate 147

13.14 listCves 147

13.15 listKeywords 148

13.16 listPackages 148

13.17 listUnpublishedErrata 149

13.18 publish 150

13.19 publishAsOriginal 151


13.21 setDetails 152

14 formula 15414.1 getCombinedFormulasByServerId 154

14.2 getFormulasByGroupId 154

14.3 getFormulasByServerId 155

14.4 getGroupFormulaData 155

14.5 getSystemFormulaData 155

14.6 listFormulas 156

14.7 setFormulasOfGroup 156

14.8 setFormulasOfServer 157

14.9 setGroupFormulaData 157

14.10 setSystemFormulaData 157

xiii SUSE Manager API Documentation

15 image 15915.1 delete 159

15.2 getCustomValues 159

15.3 getDetails 159

15.4 getRelevantErrata 161

15.5 importImage 161

15.6 listImages 162


15.8 scheduleImageBuild 163

16 image.profile 16416.1 create 164

16.2 delete 164

16.3 deleteCustomValues 165


16.5 getDetails 166

16.6 listImageProfileTypes 166

16.7 listImageProfiles 167

16.8 setCustomValues 167

16.9 setDetails 168

17 image.store 16917.1 create 169

17.2 delete 169

17.3 getDetails 170

17.4 listImageStoreTypes 170

xiv SUSE Manager API Documentation

17.5 listImageStores 171

17.6 setDetails 171

18 kickstart 17318.1 cloneProfile 173

18.2 createProfile 173

18.3 createProfile 174

18.4 createProfileWithCustomUrl 174

18.5 createProfileWithCustomUrl 175

18.6 deleteProfile 175

18.7 disableProfile 176

18.8 findKickstartForIp 176

18.9 importFile 176

18.10 importFile 177

18.11 importFile 177

18.12 importRawFile 178

18.13 importRawFile 179

18.14 isProfileDisabled 179

18.15 listAllIpRanges 180

18.16 listAutoinstallableChannels 180

18.17 listKickstartableChannels 181

18.18 listKickstartableTrees 182

18.19 listKickstarts 183

18.20 renameProfile 184

xv SUSE Manager API Documentation

19 kickstart.filepreservation 18519.1 create 185

19.2 delete 185

19.3 getDetails 185

19.4 listAllFilePreservations 186

20 kickstart.keys 18720.1 create 187

20.2 delete 187

20.3 getDetails 187

20.4 listAllKeys 188

20.5 update 188

21 kickstart.profile 19021.1 addIpRange 190

21.2 addScript 190

21.3 addScript 191

21.4 addScript 191

21.5 compareActivationKeys 192

21.6 compareAdvancedOptions 194

21.7 comparePackages 195

21.8 downloadKickstart 196

21.9 downloadRenderedKickstart 196

21.10 getAdvancedOptions 197

21.11 getAvailableRepositories 197

21.12 getCfgPreservation 198

xvi SUSE Manager API Documentation

21.13 getChildChannels 198

21.14 getCustomOptions 198

21.15 getKickstartTree 199

21.16 getRepositories 199

21.17 getUpdateType 200

21.18 getVariables 200

21.19 getVirtualizationType 200

21.20 listIpRanges 201

21.21 listScripts 201

21.22 orderScripts 202

21.23 removeIpRange 203

21.24 removeScript 203

21.25 setAdvancedOptions 204

21.26 setCfgPreservation 205

21.27 setChildChannels 205

21.28 setCustomOptions 205

21.29 setKickstartTree 206

21.30 setLogging 206

21.31 setRepositories 207

21.32 setUpdateType 207

21.33 setVariables 207

21.34 setVirtualizationType 208

22 kickstart.profile.keys 20922.1 addActivationKey 209

xvii SUSE Manager API Documentation

22.2 getActivationKeys 209

22.3 removeActivationKey 210

23 kickstart.profile.software 21223.1 appendToSoftwareList 212

23.2 getSoftwareDetails 212

23.3 getSoftwareList 213

23.4 setSoftwareDetails 213

23.5 setSoftwareList 214

23.6 setSoftwareList 214

24 kickstart.profile.system 21524.1 addFilePreservations 215

24.2 addKeys 215

24.3 checkConfigManagement 216

24.4 checkRemoteCommands 216

24.5 disableConfigManagement 216

24.6 disableRemoteCommands 217

24.7 enableConfigManagement 217

24.8 enableRemoteCommands 218

24.9 getLocale 218

24.10 getPartitioningScheme 219

24.11 getRegistrationType 219

24.12 getSELinux 220

24.13 listFilePreservations 220

24.14 listKeys 221

xviii SUSE Manager API Documentation

24.15 removeFilePreservations 221

24.16 removeKeys 222

24.17 setLocale 222

24.18 setPartitioningScheme 223

24.19 setRegistrationType 223

24.20 setSELinux 224

25 kickstart.snippet 22525.1 createOrUpdate 225

25.2 delete 225

25.3 listAll 226

25.4 listCustom 226

25.5 listDefault 227

26 kickstart.tree 22826.1 create 228

26.2 delete 228

26.3 deleteTreeAndProfiles 229

26.4 getDetails 229

26.5 list 230

26.6 listInstallTypes 230

26.7 rename 231

26.8 update 231

27 org 23227.1 create 232

27.2 delete 233

xix SUSE Manager API Documentation

27.3 getCrashFileSizeLimit 233

27.4 getDetails 233

27.5 getDetails 234

27.6 getPolicyForScapFileUpload 235

27.7 getPolicyForScapResultDeletion 235

27.8 isContentStagingEnabled 236

27.9 isCrashReportingEnabled 236

27.10 isCrashfileUploadEnabled 237

27.11 isErrataEmailNotifsForOrg 237

27.12 isOrgConfigManagedByOrgAdmin 237

27.13 listOrgs 238

27.14 listUsers 239

27.15 migrateSystems 239

27.16 setContentStaging 240

27.17 setCrashFileSizeLimit 240

27.18 setCrashReporting 241

27.19 setCrashfileUpload 241

27.20 setErrataEmailNotifsForOrg 241

27.21 setOrgConfigManagedByOrgAdmin 242

27.22 setPolicyForScapFileUpload 242

27.23 setPolicyForScapResultDeletion 243

27.24 updateName 243

28 org.trusts 24528.1 addTrust 245

xx SUSE Manager API Documentation

28.2 getDetails 245

28.3 listChannelsConsumed 246

28.4 listChannelsProvided 246

28.5 listOrgs 247

28.6 listSystemsAffected 247

28.7 listTrusts 248

28.8 removeTrust 248

29 packages 25029.1 findByNvrea 250

29.2 getDetails 251

29.3 getPackage 252

29.4 getPackageUrl 252

29.5 listChangelog 252

29.6 listDependencies 253

29.7 listFiles 254

29.8 listProvidingChannels 254

29.9 listProvidingErrata 255

29.10 listSourcePackages 255

29.11 removePackage 256

29.12 removeSourcePackage 256

30 packages.provider 25730.1 associateKey 257

30.2 list 257

30.3 listKeys 258

xxi SUSE Manager API Documentation

31 packages.search 25931.1 advanced 259

31.2 advancedWithActKey 259

31.3 advancedWithChannel 260

31.4 name 261

31.5 nameAndDescription 262

31.6 nameAndSummary 263

32 preferences.locale 26432.1 listLocales 264

32.2 listTimeZones 264

32.3 setLocale 265

32.4 setTimeZone 265

33 proxy 26633.1 activateProxy 266

33.2 createMonitoringScout 266

33.3 deactivateProxy 266

33.4 isProxy 267

33.5 listAvailableProxyChannels 267

34 satellite 26834.1 isMonitoringEnabled 268

34.2 isMonitoringEnabledBySystemId 268

34.3 listProxies 268

35 schedule 27035.1 archiveActions 270

xxii SUSE Manager API Documentation

35.2 cancelActions 270

35.3 deleteActions 271

35.4 failSystemAction 271

35.5 failSystemAction 271

35.6 listAllActions 272

35.7 listArchivedActions 273

35.8 listCompletedActions 273

35.9 listCompletedSystems 274

35.10 listFailedActions 275

35.11 listFailedSystems 275

35.12 listInProgressActions 276

35.13 listInProgressSystems 277

35.14 rescheduleActions 277

36 subscriptionmatching.pinnedsubscription 27936.1 create 279

36.2 delete 279

36.3 list 280

37 sync.content 28137.1 addChannel 281

37.2 addChannels 281

37.3 addCredentials 282

37.4 deleteCredentials 282


37.6 listCredentials 283

xxiii SUSE Manager API Documentation

37.7 listProducts 284

37.8 synchronizeChannelFamilies 285

37.9 synchronizeChannels 286

37.10 synchronizeProductChannels 286

37.11 synchronizeProducts 287

37.12 synchronizeRepositories 287

37.13 synchronizeSubscriptions 287

38 sync.master 28938.1 addToMaster 289

38.2 create 289

38.3 delete 290

38.4 getDefaultMaster 290

38.5 getMaster 291

38.6 getMasterByLabel 291

38.7 getMasterOrgs 292

38.8 getMasters 292

38.9 hasMaster 293

38.10 makeDefault 293

38.11 mapToLocal 293

38.12 setCaCert 294

38.13 setMasterOrgs 294

38.14 unsetDefaultMaster 295

38.15 update 295

xxiv SUSE Manager API Documentation

39 sync.slave 29739.1 create 297

39.2 delete 297

39.3 getAllowedOrgs 298

39.4 getSlave 298

39.5 getSlaveByName 299

39.6 getSlaves 299

39.7 setAllowedOrgs 300

39.8 update 300

40 system 30240.1 addEntitlements 302

40.2 addNote 302

40.3 applyErrata 303

40.4 bootstrap 303

40.5 bootstrap 304

40.6 comparePackageProfile 304

40.7 comparePackages 305

40.8 createPackageProfile 306

40.9 createSystemProfile 306

40.10 createSystemRecord 307

40.11 createSystemRecord 307

40.12 deleteCustomValues 308

40.13 deleteGuestProfiles 308

40.14 deleteNote 309

xxv SUSE Manager API Documentation

40.15 deleteNotes 309

40.16 deletePackageProfile 310

40.17 deleteSystem 310



40.20 deleteSystems 311

40.21 deleteSystems 312

40.22 deleteTagFromSnapshot 312

40.23 downloadSystemId 313

40.24 getConnectionPath 313

40.25 getCpu 314



40.28 getDevices 316

40.29 getDmi 317

40.30 getEntitlements 317

40.31 getEventHistory 318

40.32 getId 318

40.33 getInstalledProducts 319

40.34 getKernelLivePatch 320

40.35 getMemory 320

40.36 getName 321

40.37 getNetwork 321

40.38 getNetworkDevices 322

xxvi SUSE Manager API Documentation

40.39 getOsaPing 323

40.40 getRegistrationDate 323

40.41 getRelevantErrata 324

40.42 getRelevantErrataByType 324

40.43 getRunningKernel 325

40.44 getScriptActionDetails 325

40.45 getScriptResults 326

40.46 getSubscribedBaseChannel 327

40.47 getSystemCurrencyMultipliers 328

40.48 getSystemCurrencyScores 328

40.49 getTaskomaticApi 329

40.50 getUnscheduledErrata 329

40.51 getUuid 330

40.52 getVariables 330

40.53 isNvreInstalled 331

40.54 isNvreInstalled 331

40.55 listActivationKeys 332

40.56 listActiveSystems 332

40.57 listActiveSystemsDetails 333

40.58 listAdministrators 335

40.59 listAllInstallablePackages 336

40.60 listBaseChannels 336

40.61 listChildChannels 337

40.62 listDuplicatesByHostname 337

xxvii SUSE Manager API Documentation

40.63 listDuplicatesByIp 338

40.64 listDuplicatesByMac 339

40.65 listEmptySystemProfiles 339

40.66 listExtraPackages 340

40.67 listFqdns 341

40.68 listGroups 341

40.69 listInactiveSystems 342

40.70 listInactiveSystems 342

40.71 listLatestAvailablePackage 343

40.72 listLatestInstallablePackages 344

40.73 listLatestUpgradablePackages 344

40.74 listMigrationTargets 345

40.75 listNewerInstalledPackages 345

40.76 listNotes 346

40.77 listOlderInstalledPackages 347

40.78 listOutOfDateSystems 347

40.79 listPackageProfiles 348


40.81 listPackagesFromChannel 349

40.82 listPhysicalSystems 350

40.83 listSubscribableBaseChannels 350

40.84 listSubscribableChildChannels 351

40.85 listSubscribedChildChannels 352

40.86 listSuggestedReboot 353

xxviii SUSE Manager API Documentation

40.87 listSystemEvents 353

40.88 listSystemEvents 355

40.89 listSystems 357

40.90 listSystemsWithExtraPackages 358

40.91 listSystemsWithPackage 358

40.92 listSystemsWithPackage 359

40.93 listUngroupedSystems 360

40.94 listUserSystems 360

40.95 listUserSystems 361

40.96 listVirtualGuests 362

40.97 listVirtualHosts 362

40.98 obtainReactivationKey 363

40.99 obtainReactivationKey 363

40.100 provisionSystem 364

40.101 provisionSystem 364

40.102 provisionVirtualGuest 364



40.105 removeEntitlements 366

40.106 scheduleApplyErrata 366





xxix SUSE Manager API Documentation




40.114 scheduleApplyHighstate 371

40.115 scheduleCertificateUpdate 372

40.116 scheduleCertificateUpdate 372

40.117 scheduleChangeChannels 372

40.118 scheduleDistUpgrade 373

40.119 scheduleGuestAction 374

40.120 scheduleGuestAction 374

40.121 scheduleHardwareRefresh 374

40.122 schedulePackageInstall 375




40.126 schedulePackageInstallByNevra 377




40.130 schedulePackageRefresh 380

40.131 schedulePackageRemove 380




xxx SUSE Manager API Documentation

40.135 schedulePackageRemoveByNevra 383




40.139 scheduleReboot 386

40.140 scheduleSPMigration 386

40.141 scheduleSPMigration 387

40.142 scheduleScriptRun 387




40.146 scheduleSyncPackagesWithSystem 390

40.147 searchByName 390

40.148 sendOsaPing 391

40.149 setBaseChannel 391

40.150 setBaseChannel 392

40.151 setChildChannels 392

40.152 setCustomValues 393


40.154 setGroupMembership 394

40.155 setGuestCpus 395

40.156 setGuestMemory 395

40.157 setLockStatus 396

40.158 setPrimaryInterface 396

xxxi SUSE Manager API Documentation

40.159 setProfileName 396

40.160 setVariables 397

40.161 tagLatestSnapshot 397

40.162 unentitle 398

40.163 upgradeEntitlement 398

40.164 whoRegistered 399

41 system.config 40041.1 addChannels 400

41.2 createOrUpdatePath 400

41.3 createOrUpdateSymlink 402

41.4 deleteFiles 404

41.5 deployAll 404


41.7 listFiles 406


41.9 removeChannels 408

41.10 scheduleApplyConfigChannel 409

41.11 setChannels 409

42 system.crash 41042.1 createCrashNote 410

42.2 deleteCrash 410

42.3 deleteCrashNote 410

42.4 getCrashCountInfo 411

42.5 getCrashFile 411

xxxii SUSE Manager API Documentation

42.6 getCrashFileUrl 412

42.7 getCrashNotesForCrash 412

42.8 getCrashOverview 413

42.9 getCrashesByUuid 413

42.10 listSystemCrashFiles 414

42.11 listSystemCrashes 414

43 system.custominfo 41643.1 createKey 416

43.2 deleteKey 416

43.3 listAllKeys 416

43.4 updateKey 417

44 system.provisioning.snapshot 41844.1 addTagToSnapshot 418

44.2 deleteSnapshot 418

44.3 deleteSnapshots 418

44.4 deleteSnapshots 419

44.5 listSnapshotConfigFiles 420

44.6 listSnapshotPackages 421

44.7 listSnapshots 422

44.8 rollbackToSnapshot 423

44.9 rollbackToTag 423

44.10 rollbackToTag 424

45 system.scap 42545.1 deleteXccdfScan 425

xxxiii SUSE Manager API Documentation

45.2 getXccdfScanDetails 425

45.3 getXccdfScanRuleResults 426

45.4 listXccdfScans 426

45.5 scheduleXccdfScan 427




46 system.search 43046.1 deviceDescription 430

46.2 deviceDriver 430

46.3 deviceId 431

46.4 deviceVendorId 432

46.5 hostname 432

46.6 ip 433

46.7 nameAndDescription 434

46.8 uuid 434

47 systemgroup 43647.1 addOrRemoveAdmins 436

47.2 addOrRemoveSystems 436

47.3 create 437

47.4 delete 437

47.5 getDetails 438

47.6 getDetails 438

47.7 listActiveSystemsInGroup 439

xxxiv SUSE Manager API Documentation

47.8 listAdministrators 439

47.9 listAllGroups 440

47.10 listGroupsWithNoAssociatedAdmins 440

47.11 listInactiveSystemsInGroup 441

47.12 listInactiveSystemsInGroup 441

47.13 listSystems 442

47.14 listSystemsMinimal 443

47.15 scheduleApplyErrataToActive 444

47.16 scheduleApplyErrataToActive 444

47.17 update 445

48 user 44648.1 addAssignedSystemGroup 446

48.2 addAssignedSystemGroups 446

48.3 addDefaultSystemGroup 447

48.4 addDefaultSystemGroups 447

48.5 addRole 447

48.6 create 448

48.7 create 448

48.8 delete 449

48.9 disable 449

48.10 enable 450

48.11 getCreateDefaultSystemGroup 450


48.13 getLoggedInTime 451

xxxv SUSE Manager API Documentation

48.14 listAssignableRoles 452

48.15 listAssignedSystemGroups 452

48.16 listDefaultSystemGroups 453

48.17 listRoles 453

48.18 listUsers 454

48.19 removeAssignedSystemGroup 454

48.20 removeAssignedSystemGroups 455

48.21 removeDefaultSystemGroup 455

48.22 removeDefaultSystemGroups 456

48.23 removeRole 456

48.24 setCreateDefaultSystemGroup 456


48.26 setErrataNotifications 458

48.27 setReadOnly 458

48.28 usePamAuthentication 458

49 user.external 46049.1 createExternalGroupToRoleMap 460

49.2 createExternalGroupToSystemGroupMap 460

49.3 deleteExternalGroupToRoleMap 461

49.4 deleteExternalGroupToSystemGroupMap 461

49.5 getDefaultOrg 462

49.6 getExternalGroupToRoleMap 462

49.7 getExternalGroupToSystemGroupMap 463

49.8 getKeepTemporaryRoles 463

xxxvi SUSE Manager API Documentation

49.9 getUseOrgUnit 464

49.10 listExternalGroupToRoleMaps 464

49.11 listExternalGroupToSystemGroupMaps 465

49.12 setDefaultOrg 465

49.13 setExternalGroupRoles 466

49.14 setExternalGroupSystemGroups 466

49.15 setKeepTemporaryRoles 467

49.16 setUseOrgUnit 467

50 virtualhostmanager 46850.1 create 468

50.2 delete 468

50.3 getDetail 468

50.4 getModuleParameters 469

50.5 listAvailableVirtualHostGathererModules 469

50.6 listVirtualHostManagers 470

xxxvii SUSE Manager API Documentation

Sample Scripts

EXAMPLE 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 schedule im-mediate installation of package rhnlib-2.5.22.9.el6.noarch to system with id 1000000001.

xxxviii SUSE Manager 4.0

#!/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

xxxix SUSE Manager 4.0

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)

xl SUSE Manager 4.0

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 Manag-er API. 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.

xli SUSE Manager 4.0

1 actionchain

Provides the namespace for the Action Chain methods.

1.1 addConfigurationDeployment

Description

Adds an action to deploy a configuration 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 - config revision specifier

string "channelLabel" - Channel label

string "lePath" - Path of the configuration 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 4.0

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 4.0

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 4.0


1.7 addScriptRunDescription

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 systemint timeout - Timeoutstring scriptBodyBase64 - Base64 encoded script body

Return Value


1.8 addScriptRunDescription

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 systemint timeout - Timeoutstring scriptBodyBase64 - Base64 encoded script body

4 addScriptRun SUSE Manager 4.0

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

Delete action chain by label.

5 addSystemReboot SUSE Manager 4.0

Parameters



Return Value


1.12 listChainActions

Description

List all actions in the particular Action Chain.

Parameters



Return Value

array:

struct - entry

int "id" - Action ID

string "label" - Label of an Action

string "created" - Created date/time

string "earliest" - Earliest scheduled date/time

string "type" - Type of the action

string "modified" - Modified date/time

string "cuid" - Creator UID

1.13 listChains

Description

List currently available action chains.

6 listChainActions SUSE Manager 4.0

Parameters


Return Value

array:

struct - chain

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

1.14 removeAction

Description

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 renameChain

Description

Rename an Action Chain.

Parameters

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

7 removeAction SUSE Manager 4.0

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 4.0

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 configuration channels, this method adds given config-uration channels to either the top or the bottom (whichever you specify) of an activationkey's configuration channels list. The ordering of the configuration channels provided inthe add list is maintained while adding. If one of the configuration channels in the 'add'list already exists in an activation key, the configuration channel will be re-ranked to theappropriate place.

Parameters

9 addChildChannels SUSE Manager 4.0

string sessionKeyarray:

string - activationKeyarray:

string - List of configuration channel labels in the ranked order.boolean addToTop

true - To prepend the given channels to the beginning of the activation key'sconfig channel listfalse - To append the given channels to the end of the activation key's configchannel list

Return Value


2.3 addEntitlementsDescription

Add entitlements to an activation key. Currently only virtualization_host add-on entitle-ment is permitted.

Parameters

string sessionKeystring keyarray string - entitlement label

virtualization_host

Return Value


2.4 addPackageNamesDescription

10 addEntitlements SUSE Manager 4.0

Add packages to an activation key using package name only.Deprecated - being replaced by addPackages(string sessionKey, string key, array[pack-ages])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


2.6 addServerGroupsDescription

11 addPackages SUSE Manager 4.0

Add server groups to an activation key.

Parameters


int - serverGroupId

Return Value


2.7 checkConfigDeploymentDescription

Check configuration le deployment status for the activation key specified.

Parameters

string sessionKeystring key

Return Value

1 if enabled, 0 if disabled, exception thrown otherwise.

2.8 cloneDescription

Clone an existing activation key.

Parameters

string sessionKeystring key - Key to be cloned.string cloneDescription - Description of the cloned key.

Return Value

12 checkConfigDeployment SUSE Manager 4.0

string - The new activation key.

2.9 create

Description

Create a new activation key. The activation key parameter passed in will be prefixed 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 sessionKeystring key - Leave empty to have new key autogenerated.string descriptionstring 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 entitlement label to associate with the key.

virtualization_hostboolean universalDefault

Return Value


2.10 create

Description

Create a new activation key with unlimited usage. The activation key parameter passed inwill be prefixed 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".

13 create SUSE Manager 4.0

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 delete

Description

Delete an activation key.

Parameters


Return Value


2.12 disableConfigDeployment

Description

Disable configuration le deployment for the specified activation key.

Parameters


14 delete SUSE Manager 4.0

Return Value


2.13 enableConfigDeployment

Description

Enable configuration le deployment for the specified activation key.

Parameters


Return Value


2.14 getDetails

Description

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

Parameters


Return Value

struct - activation key

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

15 enableConfigDeployment SUSE Manager 4.0


array "entitlements"

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.15 listActivatedSystems

Description

List the systems activated with the key provided.

Parameters

string sessionKey

string key

Return Value

array:

struct - system structure

16 listActivatedSystems SUSE Manager 4.0

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"

string - entitlementLabelarray "server_group_ids"

string - serverGroupIdarray "package_names"

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

struct - package

17 listActivationKeys SUSE Manager 4.0

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

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

defaultssh-pushssh-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 specific password.

Parameters

string minionId - The id of the minion to authenticate with.string machinePassword - password specific to a machine.string activationKey - activation key to use channels from.

Return Value

array:

struct - channelInfo

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

2.18 listConfigChannels

Description

List configuration channels associated to an activation key.

18 listChannels SUSE Manager 4.0

Parameters

string sessionKey

string key

Return Value

array:

struct - Configuration Channel information

int "id"

int "orgId"

string "label"

string "name"

string "description"

struct "configChannelType"

struct - Configuration Channel Type information

int "id"

string "label"

string "name"

int "priority"

2.19 removeChildChannels

Description

Remove child channels from an activation key.

Parameters

string sessionKey

string key

array:


Return Value

19 removeChildChannels SUSE Manager 4.0


2.20 removeConfigChannels

Description

Remove configuration channels from the given activation keys.

Parameters

string sessionKey

array:

string - activationKey

array:

string - configChannelLabel

Return Value


2.21 removeEntitlements

Description

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

Parameters

string sessionKey

string key

array string - entitlement label

virtualization_host

Return Value

20 removeConfigChannels SUSE Manager 4.0


2.22 removePackageNamesDescription

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

Parameters


string - packageName

Return Value


2.23 removePackagesDescription

Remove package names from an activation key.

Parameters


struct - packages

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

Return Value

21 removePackageNames SUSE Manager 4.0


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 configuration channels on the given activation keys. Channelsare ranked by their order in the array.

Parameters

string sessionKey

array:

string - activationKey

array:

string - configChannelLabel

Return Value

22 removeServerGroups SUSE Manager 4.0


2.26 setDetails

Description

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 4.0

3 api

Methods providing information about the API.

3.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

3.2 getApiNamespaceCallListDescription

Lists all available api calls for the specified namespace

Parameters

string sessionKeystring namespace

Return Value

struct - method_info

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

24 getApiCallList SUSE Manager 4.0

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

3.3 getApiNamespacesDescription

Lists available API namespaces

Parameters

string sessionKey

Return Value

struct - namespace

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

3.4 getVersionDescription

Returns the version of the API. Since Spacewalk 0.4 (Satellite 5.3) it is no more relatedto server version.

Parameters

None

Return Value

string

3.5 systemVersionDescription

Returns the server version.

25 getApiNamespaces SUSE Manager 4.0

Parameters

None

Return Value

string

26 systemVersion SUSE Manager 4.0

4 audit

Methods to audit systems.

4.1 listImagesByPatchStatus

Description

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

Parameters

string sessionKey

string cveIdentifier

Return Value

array:

struct - cve_audit_image

int "image_id"

string "patch_status"

AFFECTED_PATCH_INAPPLICABLE - Affected, patch available inunassigned channel

AFFECTED_PATCH_APPLICABLE - Affected, patch available in as-signed channel

NOT_AFFECTED - Not affected

PATCHED - Patched

array "string"

channel_labels - Labels of channels that contain an unapplied patch

array "string"

27 listImagesByPatchStatus SUSE Manager 4.0

errata_advisories - Advisories of erratas that patch the specified vul-nerability

4.2 listImagesByPatchStatus

Description

List visible images with their patch status regarding a given CVE identifier. 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


array:

string - patchStatusLabel

AFFECTED_PATCH_INAPPLICABLE - Affected, patch available in unassignedchannel

AFFECTED_PATCH_APPLICABLE - Affected, patch available in assigned channel


PATCHED - Patched

Return Value

array:

struct - cve_audit_image

int "image_id"





PATCHED - Patched

28 listImagesByPatchStatus SUSE Manager 4.0

array "string"


array "string"


4.3 listSystemsByPatchStatus

Description

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

Parameters

string sessionKey


Return Value

array:

struct - cve_audit_system

int "system_id"





PATCHED - Patched

array "string"


array "string"

29 listSystemsByPatchStatus SUSE Manager 4.0


4.4 listSystemsByPatchStatus

Description

List visible systems with their patch status regarding a given CVE identifier. 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


array:

string - patchStatusLabel

AFFECTED_PATCH_INAPPLICABLE - Affected, patch available in unassignedchannel

AFFECTED_PATCH_APPLICABLE - Affected, 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"



5 auth

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

5.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

5.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

32 login SUSE Manager 4.0

string sessionKey

5.3 logout

Description

Logout the user with the given session key.

Parameters

string sessionKey

Return Value


33 logout SUSE Manager 4.0

6 channel

Provides method to get back a list of Software Channels.

6.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"

6.2 listManageableChannels

Description

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

Parameters

string sessionKey

Return Value

34 listAllChannels SUSE Manager 4.0

array:



6.3 listMyChannelsDescription

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

Parameters

string sessionKey

Return Value

array:



6.4 listPopularChannelsDescription

35 listMyChannels SUSE Manager 4.0

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

Parameters

string sessionKeyint popularityCount

Return Value

array:



6.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"

36 listRedHatChannels SUSE Manager 4.0

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

6.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:



6.7 listSharedChannelsDescription

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

Parameters

string sessionKey

Return Value

37 listRetiredChannels SUSE Manager 4.0

array:


int "id"

string "label"

string "name"

string "provider_name"

int "packages"

int "systems"

string "arch_name"

6.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"

6.9 listVendorChannels

Description

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

38 listSoftwareChannels SUSE Manager 4.0

Parameters

string sessionKey

Return Value

array:



39 listVendorChannels SUSE Manager 4.0

7 channel.access

Provides methods to retrieve and alter channel access restrictions.

7.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


7.2 enableUserRestrictionsDescription

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

Parameters


Return Value


7.3 getOrgSharingDescription

40 disableUserRestrictions SUSE Manager 4.0

Get organization sharing access control.

Parameters


Return Value

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

7.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


41 setOrgSharing SUSE Manager 4.0

8 channel.org

Provides methods to retrieve and alter organization trust relationships for a chan-nel.

8.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


8.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

42 disableAccess SUSE Manager 4.0


8.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"

43 list SUSE Manager 4.0

9 channel.software

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

9.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


9.2 addRepoFilter

Description

Adds a filter for a given repo.

Parameters

string sessionKey

string label - repository label

struct - filter_map

string "filter" - string to filter on

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

Return Value

44 addPackages SUSE Manager 4.0

int sort order for new filter

9.3 applyChannelState

Description

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

Parameters

string sessionKeyarray:

int - serverId

Return Value

array:

int - actionId

9.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"

45 applyChannelState SUSE Manager 4.0

string "arch_name"

string "arch_label"

string "summary"


string "checksum_label"

dateTime.iso8601 "last_modified"

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"

9.5 clearRepoFilters

Description

Removes the filters for a repo

Parameters

string sessionKey

string label - repository label

Return Value

46 clearRepoFilters SUSE Manager 4.0


9.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_fingerprint might be used as wellstring "gpg_check" - (optional)string "description" - (optional)string "checksum" - either sha1 or sha256

boolean original_state

Return Value

int the cloned channel ID

9.7 create

Description

Creates a software channelAvailable since API version: 10.9

47 clone SUSE Manager 4.0

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, run chan-nel.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 repository meta-data generation

sha1 - Offers widest compatibility with clientssha256 - Offers 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 "fingerprint" - GPG key Fingerprint

boolean gpgCheck - true if the GPG check should be enabled by default, false oth-erwise

Return Value

int - 1 if the creation operation succeeded, 0 otherwise

9.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, run chan-nel.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 repository meta-data generation

sha1 - Offers widest compatibility with clientssha256 - Offers 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 "fingerprint" - GPG key Fingerprint

Return Value


9.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, run chan-nel.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 repository meta-data generation

sha1 - Offers widest compatibility with clients

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

Return Value


9.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, run chan-nel.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


9.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"

9.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

51 createRepo SUSE Manager 4.0

struct - channel




9.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, false oth-erwise

Return Value

struct - channel

int "id"string "label"

52 createRepo SUSE Manager 4.0

string "sourceUrl"

string "type"

boolean "hasSignedMetadata"

array "sslContentSources" -


string "sslCaDesc"

string "sslCertDesc"

string "sslKeyDesc"

9.14 delete

Description

Deletes a custom software channel

Parameters

string sessionKey

string channelLabel - channel to delete

Return Value


9.15 disassociateRepo

Description

Disassociates a repository from a channel

Parameters

string sessionKey

string channelLabel - channel label

string repoLabel - repository label

Return Value

53 delete SUSE Manager 4.0

struct - channel

int "id"string "name"string "label"string "arch_name"string "arch_label"string "summary"string "description"string "checksum_label"dateTime.iso8601 "last_modified"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"

9.16 getChannelLastBuildByIdDescription

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

Parameters

54 getChannelLastBuildById SUSE Manager 4.0

string sessionKeyint id - id of channel wanted

Return Value

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

9.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_modified"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)

55 getDetails SUSE Manager 4.0

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



9.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_modified"string "maintainer_name"string "maintainer_email"string "maintainer_phone"

56 getDetails SUSE Manager 4.0

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:



9.19 getRepoDetailsDescription

Returns details of the given repository

Parameters

string sessionKeystring repoLabel - repo to query

Return Value

struct - channel



57 getRepoDetails SUSE Manager 4.0


9.20 getRepoDetailsDescription

Returns details of the given repository

Parameters

string sessionKeyint id - repository id

Return Value

struct - channel




9.21 getRepoSyncCronExpressionDescription

Returns repo synchronization cron expression

Parameters

58 getRepoDetails SUSE Manager 4.0

string sessionKeystring channelLabel - channel label

Return Value

string quartz expression

9.22 getTaskomaticApi

Description

$call.doc

Parameters

None

Return Value

null

9.23 isGloballySubscribable

Description

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

Parameters


Return Value

int - 1 if true, 0 otherwise

9.24 isUserManageable

Description

59 getTaskomaticApi SUSE Manager 4.0

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 - 1 if manageable, 0 if not

9.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 - 1 if subscribable, 0 if not

9.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

60 isUserSubscribable SUSE Manager 4.0

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_modified_date"string "last_modified" - (Deprecated)

9.27 listAllPackagesDescription

Lists all packages in the channel, regardless of version whose last modified 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"

61 listAllPackages SUSE Manager 4.0

string "checksum"string "checksum_type"int "id"string "arch_label"string "last_modified_date"string "last_modified" - (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


9.30 listAllPackages

Description

Lists all packages in the channel, regardless of version whose last modified 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_modified_date"

string "last_modified" - (Deprecated)

9.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

64 listAllPackagesByDate SUSE Manager 4.0

array:

struct - package

string "name"

string "version"

string "release"

string "epoch"

string "id"

string "arch_label"

string "last_modified"

9.32 listAllPackagesByDate

Description

Lists all packages in the channel, regardless of the package version, whose last modifieddate 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_modified"

9.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_modified"

9.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"

9.35 listChannelReposDescription

Lists associated repos with the given channel

Parameters

string sessionKeystring channelLabel - channel label

Return Value

array:

struct - channel




9.36 listChildrenDescription

67 listChannelRepos SUSE Manager 4.0

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 "checksum_label"

dateTime.iso8601 "last_modified"

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"

68 listChildren SUSE Manager 4.0

string "sourceUrl"

string "type"

9.37 listErrata

Description

List the errata applicable to a channel after given startDate

Parameters

string sessionKey


dateTime.iso8601 startDate

Return Value

array:

struct - errata

int "id" - Errata ID.

string "date" - Date erratum was created.

string "update_date" - Date erratum was updated.

string "advisory_synopsis" - Summary of the erratum.

string "advisory_type" - Type label such as Security, Bug Fix

string "advisory_name" - Name such as RHSA, etc

9.38 listErrata

Description

List the errata applicable to a channel between startDate and endDate.

Parameters

string sessionKey


69 listErrata SUSE Manager 4.0

dateTime.iso8601 startDatedateTime.iso8601 endDate

Return Value

array:

struct - errata

int "id" - Errata ID.string "date" - Date erratum was created.string "update_date" - Date erratum was updated.string "advisory_synopsis" - Summary of the erratum.string "advisory_type" - Type label such as Security, Bug Fixstring "advisory_name" - Name such as RHSA, etc

9.39 listErrata

Description

List the errata applicable to a channel between startDate and endDate.

Parameters

string sessionKeystring channelLabel - channel to querydateTime.iso8601 startDatedateTime.iso8601 endDateboolean lastModified - select by last modified or not

Return Value

array:

struct - errata

int "id" - Errata ID.string "date" - Date erratum was created.string "update_date" - Date erratum was updated.string "advisory_synopsis" - Summary of the erratum.




9.40 listErrata

Description

List the errata applicable to a channel

Parameters

string sessionKey


Return Value

array:

struct - errata

int "id" - Errata Id

string "advisory_synopsis" - Summary of the erratum.



string "advisory" - name of the advisory (Deprecated)

string "issue_date" - date format follows YYYY-MM-DD HH24:MI:SS (Dep-recated)

string "update_date" - date format follows YYYY-MM-DD HH24:MI:SS(Deprecated)

string "synopsis (Deprecated)"

string "last_modified_date" - date format follows YYYY-MM-DDHH24:MI:SS (Deprecated)

9.41 listErrata

Description

List the errata applicable to a channel after given startDate


Deprecated - being replaced by listErrata(string sessionKey, string channelLabel, date-Time.iso8601 startDate)

Parameters

string sessionKey


string startDate

Return Value

array:

struct - errata

string "advisory" - name of the advisory

string "issue_date" - date format follows YYYY-MM-DD HH24:MI:SS

string "update_date" - date format follows YYYY-MM-DD HH24:MI:SS

string "synopsis"

string "advisory_type"

string "last_modified_date" - date format follows Y

SUSE Manager API Documentation - SUSE Manager 4...21.1 addIpRange 190 21.2 addScript 190 21.3...

Documents

Transcript of SUSE Manager API Documentation - SUSE Manager 4...21.1 addIpRange 190 21.2 addScript 190 21.3...