suse manager api documentation - suse manager 24€¦ · 2.24 removeservergroups 22 2.25...
TRANSCRIPT
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: 06/28/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.
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 9
2.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 24
3.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 34
6.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 42
8.1 disableUserRestrictions 42
8.2 enableUserRestrictions 42
8.3 getOrgSharing 42
8.4 setOrgSharing 43
9 channel.org 44
9.1 disableAccess 44
9.2 enableAccess 44
9.3 list 45
10 channel.software 46
10.1 addPackages 46
10.2 addRepoFilter 46
10.3 alignMetadata 47
10.4 applyChannelState 47
10.5 associateRepo 48
10.6 clearRepoFilters 49
vi SUSE Manager API Documentation
10.7 clone 49
10.8 create 50
10.9 create 51
10.10 create 52
10.11 create 52
10.12 createRepo 53
10.13 createRepo 54
10.14 createRepo 55
10.15 delete 56
10.16 disassociateRepo 56
10.17 getChannelLastBuildById 57
10.18 getDetails 58
10.19 getDetails 59
10.20 getRepoDetails 60
10.21 getRepoDetails 61
10.22 getRepoSyncCronExpression 61
10.23 isExisting 62
10.24 isGloballySubscribable 62
10.25 isUserManageable 62
10.26 isUserSubscribable 63
10.27 listAllPackages 63
10.28 listAllPackages 64
10.29 listAllPackages 65
10.30 listAllPackages 65
vii SUSE Manager API Documentation
10.31 listAllPackages 66
10.32 listAllPackagesByDate 67
10.33 listAllPackagesByDate 68
10.34 listAllPackagesByDate 69
10.35 listArches 69
10.36 listChannelRepos 70
10.37 listChildren 70
10.38 listErrata 72
10.39 listErrata 72
10.40 listErrata 73
10.41 listErrata 74
10.42 listErrata 74
10.43 listErrata 75
10.44 listErrataByType 76
10.45 listErrataNeedingSync 76
10.46 listLatestPackages 77
10.47 listPackagesWithoutChannel 78
10.48 listRepoFilters 79
10.49 listSubscribedSystems 79
10.50 listSystemChannels 80
10.51 listUserRepos 80
10.52 mergeErrata 81
10.53 mergeErrata 81
10.54 mergeErrata 82
viii SUSE Manager API Documentation
10.55 mergePackages 83
10.56 mergePackages 83
10.57 regenerateNeededCache 84
10.58 regenerateNeededCache 85
10.59 regenerateYumCache 85
10.60 removeErrata 85
10.61 removePackages 86
10.62 removeRepo 86
10.63 removeRepo 87
10.64 removeRepoFilter 87
10.65 setContactDetails 87
10.66 setDetails 88
10.67 setDetails 89
10.68 setGloballySubscribable 89
10.69 setRepoFilters 90
10.70 setSystemChannels 90
10.71 setUserManageable 91
10.72 setUserSubscribable 91
10.73 subscribeSystem 92
10.74 syncErrata 92
10.75 syncRepo 93
10.76 syncRepo 93
10.77 syncRepo 94
10.78 syncRepo 94
ix SUSE Manager API Documentation
10.79 syncRepo 95
10.80 unsubscribeChannels 95
10.81 updateRepo 96
10.82 updateRepoLabel 97
10.83 updateRepoLabel 97
10.84 updateRepoSsl 98
10.85 updateRepoSsl 99
10.86 updateRepoUrl 100
10.87 updateRepoUrl 100
11 cluster 10211.1 addCluster 102
11.2 deleteCluster 102
11.3 listClusterNodes 103
11.4 listClusters 103
11.5 scheduleJoinNodeToCluster 103
11.6 scheduleRemoveNodeFromCluster 104
11.7 scheduleUpgradeCluster 104
12 configchannel 10612.1 channelExists 106
12.2 create 106
12.3 create 107
12.4 create 108
12.5 createOrUpdatePath 109
12.6 createOrUpdateSymlink 110
x SUSE Manager API Documentation
12.7 deleteChannels 112
12.8 deleteFileRevisions 112
12.9 deleteFiles 113
12.10 deployAllSystems 113
12.11 deployAllSystems 113
12.12 deployAllSystems 114
12.13 deployAllSystems 114
12.14 getDetails 115
12.15 getDetails 115
12.16 getEncodedFileRevision 116
12.17 getFileRevision 117
12.18 getFileRevisions 119
12.19 listFiles 120
12.20 listGlobals 121
12.21 listSubscribedSystems 121
12.22 lookupChannelInfo 122
12.23 lookupFileInfo 123
12.24 lookupFileInfo 124
12.25 scheduleFileComparisons 125
12.26 update 126
12.27 updateInitSls 126
13 contentmanagement 12913.1 attachFilter 129
13.2 attachSource 129
xi SUSE Manager API Documentation
13.3 attachSource 130
13.4 buildProject 131
13.5 buildProject 131
13.6 createEnvironment 131
13.7 createFilter 132
13.8 createProject 134
13.9 detachFilter 134
13.10 detachSource 135
13.11 listFilterCriteria 135
13.12 listFilters 136
13.13 listProjectEnvironments 136
13.14 listProjectFilters 137
13.15 listProjectSources 138
13.16 listProjects 138
13.17 lookupEnvironment 139
13.18 lookupFilter 140
13.19 lookupProject 140
13.20 lookupSource 141
13.21 promoteProject 141
13.22 removeEnvironment 142
13.23 removeFilter 142
13.24 removeProject 143
13.25 updateEnvironment 143
13.26 updateFilter 144
xii SUSE Manager API Documentation
13.27 updateProject 145
14 distchannel 14614.1 listDefaultMaps 146
14.2 listMapsForOrg 146
14.3 listMapsForOrg 147
14.4 setMapForOrg 147
15 errata 149
15.1 addPackages 149
15.2 applicableToChannels 149
15.3 bugzillaFixes 150
15.4 clone 150
15.5 cloneAsOriginal 151
15.6 cloneAsOriginalAsync 152
15.7 cloneAsync 152
15.8 create 153
15.9 delete 154
15.10 findByCve 155
15.11 getDetails 155
15.12 listAffectedSystems 156
15.13 listByDate 157
15.14 listCves 157
15.15 listKeywords 158
15.16 listPackages 158
15.17 publish 159
xiii SUSE Manager API Documentation
15.18 publishAsOriginal 160
15.19 removePackages 161
15.20 setDetails 161
16 formula 163
16.1 getCombinedFormulaDataByServerIds 163
16.2 getCombinedFormulasByServerId 163
16.3 getFormulasByGroupId 164
16.4 getFormulasByServerId 164
16.5 getGroupFormulaData 164
16.6 getSystemFormulaData 165
16.7 listFormulas 165
16.8 setFormulasOfGroup 166
16.9 setFormulasOfServer 166
16.10 setGroupFormulaData 167
16.11 setSystemFormulaData 167
17 image 168
17.1 delete 168
17.2 getCustomValues 168
17.3 getDetails 168
17.4 getRelevantErrata 170
17.5 importImage 170
17.6 listImages 171
17.7 listPackages 171
17.8 scheduleImageBuild 172
xiv SUSE Manager API Documentation
18 image.profile 173
18.1 create 173
18.2 delete 173
18.3 deleteCustomValues 174
18.4 getCustomValues 174
18.5 getDetails 175
18.6 listImageProfileTypes 175
18.7 listImageProfiles 176
18.8 setCustomValues 176
18.9 setDetails 177
19 image.store 178
19.1 create 178
19.2 delete 178
19.3 getDetails 179
19.4 listImageStoreTypes 179
19.5 listImageStores 180
19.6 setDetails 180
20 kickstart 18220.1 cloneProfile 182
20.2 createProfile 182
20.3 createProfile 183
20.4 createProfileWithCustomUrl 183
20.5 createProfileWithCustomUrl 184
20.6 deleteProfile 184
xv SUSE Manager API Documentation
20.7 disableProfile 185
20.8 findKickstartForIp 185
20.9 importFile 185
20.10 importFile 186
20.11 importFile 186
20.12 importRawFile 187
20.13 importRawFile 188
20.14 isProfileDisabled 188
20.15 listAllIpRanges 189
20.16 listAutoinstallableChannels 189
20.17 listKickstartableChannels 190
20.18 listKickstartableTrees 191
20.19 listKickstarts 192
20.20 renameProfile 193
21 kickstart.filepreservation 194
21.1 create 194
21.2 delete 194
21.3 getDetails 194
21.4 listAllFilePreservations 195
22 kickstart.keys 196
22.1 create 196
22.2 delete 196
22.3 getDetails 196
22.4 listAllKeys 197
xvi SUSE Manager API Documentation
22.5 update 197
23 kickstart.profile 199
23.1 addIpRange 199
23.2 addScript 199
23.3 addScript 200
23.4 addScript 200
23.5 compareActivationKeys 201
23.6 compareAdvancedOptions 203
23.7 comparePackages 204
23.8 downloadKickstart 205
23.9 downloadRenderedKickstart 205
23.10 getAdvancedOptions 206
23.11 getAvailableRepositories 206
23.12 getCfgPreservation 207
23.13 getChildChannels 207
23.14 getCustomOptions 207
23.15 getKickstartTree 208
23.16 getRepositories 208
23.17 getUpdateType 209
23.18 getVariables 209
23.19 getVirtualizationType 209
23.20 listIpRanges 210
23.21 listScripts 210
23.22 orderScripts 211
xvii SUSE Manager API Documentation
23.23 removeIpRange 212
23.24 removeScript 212
23.25 setAdvancedOptions 213
23.26 setCfgPreservation 214
23.27 setChildChannels 214
23.28 setCustomOptions 214
23.29 setKickstartTree 215
23.30 setLogging 215
23.31 setRepositories 216
23.32 setUpdateType 216
23.33 setVariables 216
23.34 setVirtualizationType 217
24 kickstart.profile.keys 218
24.1 addActivationKey 218
24.2 getActivationKeys 218
24.3 removeActivationKey 219
25 kickstart.profile.software 221
25.1 appendToSoftwareList 221
25.2 getSoftwareDetails 221
25.3 getSoftwareList 222
25.4 setSoftwareDetails 222
25.5 setSoftwareList 223
25.6 setSoftwareList 223
xviii SUSE Manager API Documentation
26 kickstart.profile.system 224
26.1 addFilePreservations 224
26.2 addKeys 224
26.3 checkConfigManagement 225
26.4 checkRemoteCommands 225
26.5 disableConfigManagement 225
26.6 disableRemoteCommands 226
26.7 enableConfigManagement 226
26.8 enableRemoteCommands 227
26.9 getLocale 227
26.10 getPartitioningScheme 228
26.11 getRegistrationType 228
26.12 getSELinux 229
26.13 listFilePreservations 229
26.14 listKeys 230
26.15 removeFilePreservations 230
26.16 removeKeys 231
26.17 setLocale 231
26.18 setPartitioningScheme 232
26.19 setRegistrationType 232
26.20 setSELinux 233
27 kickstart.snippet 23427.1 createOrUpdate 234
27.2 delete 234
xix SUSE Manager API Documentation
27.3 listAll 235
27.4 listCustom 235
27.5 listDefault 236
28 kickstart.tree 237
28.1 create 237
28.2 delete 237
28.3 deleteTreeAndProfiles 238
28.4 getDetails 238
28.5 list 239
28.6 listInstallTypes 239
28.7 rename 240
28.8 update 240
29 maintenance 241
29.1 assignScheduleToSystems 241
29.2 createCalendar 241
29.3 createCalendarWithUrl 242
29.4 createSchedule 243
29.5 createSchedule 243
29.6 deleteCalendar 244
29.7 deleteSchedule 245
29.8 getCalendarDetails 246
29.9 getScheduleDetails 246
29.10 listCalendarLabels 247
29.11 listScheduleNames 247
xx SUSE Manager API Documentation
29.12 listSystemsWithSchedule 248
29.13 refreshCalendar 248
29.14 retractScheduleFromSystems 249
29.15 updateCalendar 250
29.16 updateSchedule 251
30 org 253
30.1 create 253
30.2 delete 254
30.3 getClmSyncPatchesConfig 254
30.4 getCrashFileSizeLimit 254
30.5 getDetails 255
30.6 getDetails 256
30.7 getPolicyForScapFileUpload 256
30.8 getPolicyForScapResultDeletion 257
30.9 isContentStagingEnabled 257
30.10 isCrashReportingEnabled 258
30.11 isCrashfileUploadEnabled 258
30.12 isErrataEmailNotifsForOrg 258
30.13 isOrgConfigManagedByOrgAdmin 259
30.14 listOrgs 259
30.15 listUsers 260
30.16 migrateSystems 261
30.17 setClmSyncPatchesConfig 261
30.18 setContentStaging 262
xxi SUSE Manager API Documentation
30.19 setCrashFileSizeLimit 262
30.20 setCrashReporting 262
30.21 setCrashfileUpload 263
30.22 setErrataEmailNotifsForOrg 263
30.23 setOrgConfigManagedByOrgAdmin 264
30.24 setPolicyForScapFileUpload 264
30.25 setPolicyForScapResultDeletion 265
30.26 updateName 265
31 org.trusts 267
31.1 addTrust 267
31.2 getDetails 267
31.3 listChannelsConsumed 268
31.4 listChannelsProvided 268
31.5 listOrgs 269
31.6 listSystemsAffected 269
31.7 listTrusts 270
31.8 removeTrust 270
32 packages 272
32.1 findByNvrea 272
32.2 getDetails 273
32.3 getPackage 274
32.4 getPackageUrl 274
32.5 listChangelog 275
32.6 listDependencies 275
xxii SUSE Manager API Documentation
32.7 listFiles 276
32.8 listProvidingChannels 276
32.9 listProvidingErrata 277
32.10 listSourcePackages 277
32.11 removePackage 278
32.12 removeSourcePackage 278
33 packages.provider 28033.1 associateKey 280
33.2 list 280
33.3 listKeys 281
34 packages.search 282
34.1 advanced 282
34.2 advancedWithActKey 282
34.3 advancedWithChannel 283
34.4 name 284
34.5 nameAndDescription 285
34.6 nameAndSummary 285
35 preferences.locale 287
35.1 listLocales 287
35.2 listTimeZones 287
35.3 setLocale 288
35.4 setTimeZone 288
36 proxy 289
36.1 activateProxy 289
xxiii SUSE Manager API Documentation
36.2 createMonitoringScout 289
36.3 deactivateProxy 289
36.4 isProxy 290
36.5 listAvailableProxyChannels 290
36.6 listProxies 290
36.7 listProxyClients 291
37 recurringaction 292
37.1 create 292
37.2 delete 292
37.3 listByEntity 293
37.4 lookupById 293
37.5 update 294
38 saltkey 295
38.1 delete 295
39 satellite 296
39.1 isMonitoringEnabled 296
39.2 isMonitoringEnabledBySystemId 296
39.3 listProxies 296
40 schedule 298
40.1 archiveActions 298
40.2 cancelActions 298
40.3 deleteActions 299
40.4 failSystemAction 299
40.5 failSystemAction 299
xxiv SUSE Manager API Documentation
40.6 listAllActions 300
40.7 listArchivedActions 301
40.8 listCompletedActions 301
40.9 listCompletedSystems 302
40.10 listFailedActions 303
40.11 listFailedSystems 303
40.12 listInProgressActions 304
40.13 listInProgressSystems 305
40.14 rescheduleActions 305
41 subscriptionmatching.pinnedsubscription 307
41.1 create 307
41.2 delete 307
41.3 list 308
42 sync.content 30942.1 addChannel 309
42.2 addChannels 309
42.3 addCredentials 310
42.4 deleteCredentials 310
42.5 listChannels 310
42.6 listCredentials 311
42.7 listProducts 312
42.8 synchronizeChannelFamilies 313
42.9 synchronizeChannels 314
42.10 synchronizeProductChannels 314
xxv SUSE Manager API Documentation
42.11 synchronizeProducts 315
42.12 synchronizeRepositories 315
42.13 synchronizeSubscriptions 315
43 sync.master 31743.1 addToMaster 317
43.2 create 317
43.3 delete 318
43.4 getDefaultMaster 318
43.5 getMaster 319
43.6 getMasterByLabel 319
43.7 getMasterOrgs 320
43.8 getMasters 320
43.9 hasMaster 321
43.10 makeDefault 321
43.11 mapToLocal 321
43.12 setCaCert 322
43.13 setMasterOrgs 322
43.14 unsetDefaultMaster 323
43.15 update 323
44 sync.slave 325
44.1 create 325
44.2 delete 325
44.3 getAllowedOrgs 326
44.4 getSlave 326
xxvi SUSE Manager API Documentation
44.5 getSlaveByName 327
44.6 getSlaves 327
44.7 setAllowedOrgs 328
44.8 update 328
45 system 330
45.1 addEntitlements 330
45.2 addNote 330
45.3 applyErrata 331
45.4 bootstrap 331
45.5 bootstrap 332
45.6 bootstrapWithPrivateSshKey 332
45.7 bootstrapWithPrivateSshKey 333
45.8 comparePackageProfile 333
45.9 comparePackages 334
45.10 createPackageProfile 335
45.11 createSystemProfile 336
45.12 createSystemRecord 336
45.13 createSystemRecord 337
45.14 deleteCustomValues 337
45.15 deleteGuestProfiles 338
45.16 deleteNote 338
45.17 deleteNotes 339
45.18 deletePackageProfile 339
45.19 deleteSystem 339
xxvii SUSE Manager API Documentation
45.20 deleteSystem 340
45.21 deleteSystem 340
45.22 deleteSystems 341
45.23 deleteSystems 341
45.24 deleteTagFromSnapshot 342
45.25 downloadSystemId 342
45.26 getConnectionPath 342
45.27 getCpu 343
45.28 getCustomValues 344
45.29 getDetails 344
45.30 getDevices 345
45.31 getDmi 346
45.32 getEntitlements 346
45.33 getEventHistory 347
45.34 getId 347
45.35 getInstalledProducts 348
45.36 getKernelLivePatch 349
45.37 getMemory 349
45.38 getMinionIdMap 350
45.39 getName 350
45.40 getNetwork 351
45.41 getNetworkDevices 351
45.42 getNetworkForSystems 352
45.43 getOsaPing 353
xxviii SUSE Manager API Documentation
45.44 getRegistrationDate 353
45.45 getRelevantErrata 354
45.46 getRelevantErrataByType 354
45.47 getRunningKernel 355
45.48 getScriptActionDetails 355
45.49 getScriptResults 356
45.50 getSubscribedBaseChannel 357
45.51 getSystemCurrencyMultipliers 358
45.52 getSystemCurrencyScores 358
45.53 getUnscheduledErrata 359
45.54 getUuid 360
45.55 getVariables 360
45.56 isNvreInstalled 361
45.57 isNvreInstalled 361
45.58 listActivationKeys 362
45.59 listActiveSystems 362
45.60 listActiveSystemsDetails 363
45.61 listAdministrators 365
45.62 listAllInstallablePackages 366
45.63 listBaseChannels 366
45.64 listChildChannels 367
45.65 listDuplicatesByHostname 367
45.66 listDuplicatesByIp 368
45.67 listDuplicatesByMac 369
xxix SUSE Manager API Documentation
45.68 listEmptySystemProfiles 369
45.69 listExtraPackages 370
45.70 listFqdns 371
45.71 listGroups 371
45.72 listInactiveSystems 372
45.73 listInactiveSystems 372
45.74 listInstalledPackages 373
45.75 listLatestAvailablePackage 373
45.76 listLatestInstallablePackages 374
45.77 listLatestUpgradablePackages 375
45.78 listMigrationTargets 375
45.79 listNewerInstalledPackages 376
45.80 listNotes 377
45.81 listOlderInstalledPackages 377
45.82 listOutOfDateSystems 378
45.83 listPackageProfiles 379
45.84 listPackageState 379
45.85 listPackages 380
45.86 listPackagesFromChannel 380
45.87 listPhysicalSystems 381
45.88 listSubscribableBaseChannels 382
45.89 listSubscribableChildChannels 382
45.90 listSubscribedChildChannels 383
45.91 listSuggestedReboot 384
xxx SUSE Manager API Documentation
45.92 listSystemEvents 385
45.93 listSystemEvents 387
45.94 listSystemGroupsForSystemsWithEntitlement 388
45.95 listSystems 389
45.96 listSystemsWithExtraPackages 390
45.97 listSystemsWithPackage 390
45.98 listSystemsWithPackage 391
45.99 listUngroupedSystems 391
45.100 listUserSystems 392
45.101 listUserSystems 393
45.102 listVirtualGuests 393
45.103 listVirtualHosts 394
45.104 obtainReactivationKey 394
45.105 obtainReactivationKey 395
45.106 provisionSystem 395
45.107 provisionSystem 395
45.108 provisionVirtualGuest 396
45.109 provisionVirtualGuest 396
45.110 provisionVirtualGuest 397
45.111 removeEntitlements 397
45.112 scheduleApplyErrata 398
45.113 scheduleApplyErrata 398
45.114 scheduleApplyErrata 399
45.115 scheduleApplyErrata 400
xxxi SUSE Manager API Documentation
45.116 scheduleApplyErrata 400
45.117 scheduleApplyErrata 401
45.118 scheduleApplyErrata 402
45.119 scheduleApplyErrata 402
45.120 scheduleApplyErrata 403
45.121 scheduleApplyHighstate 403
45.122 scheduleCertificateUpdate 404
45.123 scheduleCertificateUpdate 404
45.124 scheduleChangeChannels 404
45.125 scheduleChangeChannels 405
45.126 scheduleDistUpgrade 406
45.127 scheduleDistUpgrade 406
45.128 scheduleGuestAction 407
45.129 scheduleGuestAction 407
45.130 scheduleHardwareRefresh 408
45.131 schedulePackageInstall 408
45.132 schedulePackageInstall 409
45.133 schedulePackageInstall 410
45.134 schedulePackageInstall 410
45.135 schedulePackageInstallByNevra 411
45.136 schedulePackageInstallByNevra 411
45.137 schedulePackageInstallByNevra 412
45.138 schedulePackageInstallByNevra 413
45.139 schedulePackageRefresh 413
xxxii SUSE Manager API Documentation
45.140 schedulePackageRemove 414
45.141 schedulePackageRemove 414
45.142 schedulePackageRemove 415
45.143 schedulePackageRemove 415
45.144 schedulePackageRemoveByNevra 416
45.145 schedulePackageRemoveByNevra 417
45.146 schedulePackageRemoveByNevra 417
45.147 schedulePackageRemoveByNevra 418
45.148 scheduleReboot 419
45.149 scheduleSPMigration 419
45.150 scheduleSPMigration 420
45.151 scheduleSPMigration 420
45.152 scheduleSPMigration 421
45.153 scheduleScriptRun 422
45.154 scheduleScriptRun 422
45.155 scheduleScriptRun 423
45.156 scheduleScriptRun 424
45.157 scheduleSyncPackagesWithSystem 424
45.158 searchByName 425
45.159 sendOsaPing 425
45.160 setBaseChannel 426
45.161 setBaseChannel 426
45.162 setChildChannels 427
45.163 setCustomValues 427
xxxiii SUSE Manager API Documentation
45.164 setDetails 428
45.165 setGroupMembership 429
45.166 setGuestCpus 429
45.167 setGuestMemory 430
45.168 setLockStatus 430
45.169 setPrimaryInterface 430
45.170 setProfileName 431
45.171 setVariables 431
45.172 tagLatestSnapshot 432
45.173 unentitle 432
45.174 updatePackageState 433
45.175 upgradeEntitlement 433
45.176 whoRegistered 433
46 system.config 435
46.1 addChannels 435
46.2 createOrUpdatePath 435
46.3 createOrUpdateSymlink 437
46.4 deleteFiles 439
46.5 deployAll 439
46.6 listChannels 440
46.7 listFiles 441
46.8 lookupFileInfo 442
46.9 removeChannels 443
46.10 scheduleApplyConfigChannel 444
xxxiv SUSE Manager API Documentation
46.11 setChannels 444
47 system.crash 445
47.1 createCrashNote 445
47.2 deleteCrash 445
47.3 deleteCrashNote 445
47.4 getCrashCountInfo 446
47.5 getCrashFile 446
47.6 getCrashFileUrl 447
47.7 getCrashNotesForCrash 447
47.8 getCrashOverview 448
47.9 getCrashesByUuid 448
47.10 listSystemCrashFiles 449
47.11 listSystemCrashes 449
48 system.custominfo 451
48.1 createKey 451
48.2 deleteKey 451
48.3 listAllKeys 451
48.4 updateKey 452
49 system.provisioning.powermanagement 45349.1 getDetails 453
49.2 getDetails 453
49.3 getStatus 454
49.4 getStatus 454
49.5 listTypes 455
xxxv SUSE Manager API Documentation
49.6 powerOff 455
49.7 powerOff 455
49.8 powerOn 456
49.9 powerOn 456
49.10 reboot 456
49.11 reboot 457
49.12 setDetails 457
49.13 setDetails 458
50 system.provisioning.snapshot 45950.1 addTagToSnapshot 459
50.2 deleteSnapshot 459
50.3 deleteSnapshots 459
50.4 deleteSnapshots 460
50.5 listSnapshotConfigFiles 461
50.6 listSnapshotPackages 462
50.7 listSnapshots 462
50.8 rollbackToSnapshot 464
50.9 rollbackToTag 464
50.10 rollbackToTag 464
51 system.scap 466
51.1 deleteXccdfScan 466
51.2 getXccdfScanDetails 466
51.3 getXccdfScanRuleResults 467
51.4 listXccdfScans 467
xxxvi SUSE Manager API Documentation
51.5 scheduleXccdfScan 468
51.6 scheduleXccdfScan 468
51.7 scheduleXccdfScan 469
51.8 scheduleXccdfScan 469
52 system.search 471
52.1 deviceDescription 471
52.2 deviceDriver 471
52.3 deviceId 472
52.4 deviceVendorId 473
52.5 hostname 473
52.6 ip 474
52.7 nameAndDescription 475
52.8 uuid 475
53 systemgroup 477
53.1 addOrRemoveAdmins 477
53.2 addOrRemoveSystems 477
53.3 create 478
53.4 delete 478
53.5 getDetails 479
53.6 getDetails 479
53.7 listActiveSystemsInGroup 480
53.8 listAdministrators 480
53.9 listAllGroups 481
53.10 listGroupsWithNoAssociatedAdmins 481
xxxvii SUSE Manager API Documentation
53.11 listInactiveSystemsInGroup 482
53.12 listInactiveSystemsInGroup 482
53.13 listSystems 483
53.14 listSystemsMinimal 484
53.15 scheduleApplyErrataToActive 485
53.16 scheduleApplyErrataToActive 485
53.17 scheduleApplyErrataToActive 486
53.18 update 486
54 user 48854.1 addAssignedSystemGroup 488
54.2 addAssignedSystemGroups 488
54.3 addDefaultSystemGroup 489
54.4 addDefaultSystemGroups 489
54.5 addRole 489
54.6 create 490
54.7 create 490
54.8 delete 491
54.9 disable 491
54.10 enable 492
54.11 getCreateDefaultSystemGroup 492
54.12 getDetails 492
54.13 getLoggedInTime 493
54.14 listAssignableRoles 494
54.15 listAssignedSystemGroups 494
xxxviii SUSE Manager API Documentation
54.16 listDefaultSystemGroups 495
54.17 listRoles 495
54.18 listUsers 496
54.19 removeAssignedSystemGroup 496
54.20 removeAssignedSystemGroups 497
54.21 removeDefaultSystemGroup 497
54.22 removeDefaultSystemGroups 498
54.23 removeRole 498
54.24 setCreateDefaultSystemGroup 498
54.25 setDetails 499
54.26 setErrataNotifications 500
54.27 setReadOnly 500
54.28 usePamAuthentication 500
55 user.external 50255.1 createExternalGroupToRoleMap 502
55.2 createExternalGroupToSystemGroupMap 502
55.3 deleteExternalGroupToRoleMap 503
55.4 deleteExternalGroupToSystemGroupMap 503
55.5 getDefaultOrg 504
55.6 getExternalGroupToRoleMap 504
55.7 getExternalGroupToSystemGroupMap 505
55.8 getKeepTemporaryRoles 505
55.9 getUseOrgUnit 506
55.10 listExternalGroupToRoleMaps 506
xxxix SUSE Manager API Documentation
55.11 listExternalGroupToSystemGroupMaps 507
55.12 setDefaultOrg 507
55.13 setExternalGroupRoles 508
55.14 setExternalGroupSystemGroups 508
55.15 setKeepTemporaryRoles 509
55.16 setUseOrgUnit 509
56 virtualhostmanager 51056.1 create 510
56.2 delete 510
56.3 getDetail 510
56.4 getModuleParameters 511
56.5 listAvailableVirtualHostGathererModules 511
56.6 listVirtualHostManagers 512
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
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)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)
client.auth.logout(key)
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))
client.auth.logout(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
MANAGER_URL = "http://manager.example.com/rpc/api"MANAGER_LOGIN = "username"MANAGER_PASSWORD = "password"
client = ServerProxy(MANAGER_URL)key = client.auth.login(MANAGER_LOGIN, MANAGER_PASSWORD)
print(client.user.list_users(key))
client.auth.logout(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
string sessionKey - Session token, issued at login
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
int - 1 on success, exception thrown otherwise.
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
string sessionKey - Session token, issued at login
int serverId - System ID
array:
int - packageId
string chainLabel - Label of the chain
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
string sessionKey - Session token, issued at login
int serverId - System ID
array:
int - packageId
string chainLabel - Label of the chain
Return Value
3 addPackageUpgrade SUSE Manager 24
int - 1 on success, exception thrown otherwise.
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
int actionId - The id of the action or throw an exception
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
int actionId - The id of the action or throw an exception
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
string sessionKey - Session token, issued at loginstring chainLabel - Label of the chain
Return Value
int - 1 on success, exception thrown otherwise.
1.12 listChainActions
Description
List all actions in the particular Action Chain.
Parameters
string sessionKey - Session token, issued at loginstring chainLabel - Label of the chain
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
string sessionKey - Session token, issued at login
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
int - 1 on success, exception thrown otherwise.
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
int - 1 on success, exception thrown otherwise.
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
int - 1 on success, exception thrown otherwise.
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
int - 1 on success, exception thrown otherwise.
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
int - 1 on success, exception thrown otherwise.
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
int - 1 on success, exception thrown otherwise.
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
int - 1 on success, exception thrown otherwise.
2.5 addPackagesDescription
Add packages to an activation key.
Parameters
string sessionKeystring keyarray:
struct - packages
string "name" - Package namestring "arch" - Arch label - Optional
Return Value
11 addPackageNames SUSE Manager 24
int - 1 on success, exception thrown otherwise.
2.6 addServerGroups
Description
Add server groups to an activation key.
Parameters
string sessionKey
string key
array:
int - serverGroupId
Return Value
int - 1 on success, exception thrown otherwise.
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
string The new activation key
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
string The new activation key
2.11 deleteDescription
Delete an activation key.
Parameters
string sessionKeystring key
Return Value
14 create SUSE Manager 24
int - 1 on success, exception thrown otherwise.
2.12 disableConfigDeployment
Description
Disable conguration le deployment for the specied activation key.
Parameters
string sessionKeystring key
Return Value
int - 1 on success, exception thrown otherwise.
2.13 enableConfigDeployment
Description
Enable conguration le deployment for the specied activation key.
Parameters
string sessionKeystring key
Return Value
int - 1 on success, exception thrown otherwise.
2.14 getDetails
Description
Lookup an activation key's details.Available since API version: 10.2
Parameters
15 disableConfigDeployment SUSE Manager 24
string sessionKeystring key
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
string sessionKeystring key
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
string sessionKeystring key
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 sessionKeystring keyarray:
string - childChannelLabel
Return Value
int - 1 on success, exception thrown otherwise.
2.20 removeConfigChannels
Description
Remove conguration channels from the given activation keys.
Parameters
string sessionKeyarray:
string - activationKeyarray:
string - congChannelLabel
Return Value
int - 1 on success, exception thrown otherwise.
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
int - 1 on success, exception thrown otherwise.
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 sessionKeystring keyarray:
string - packageName
Return Value
int - 1 on success, exception thrown otherwise.
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
int - 1 on success, exception thrown otherwise.
2.24 removeServerGroups
Description
Remove server groups from an activation key.
Parameters
string sessionKey
string key
array:
int - serverGroupId
Return Value
int - 1 on success, exception thrown otherwise.
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 sessionKeyarray:
string - activationKeyarray:
string - congChannelLabel
Return Value
int - 1 on success, exception thrown otherwise.
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
int - 1 on success, exception thrown otherwise.
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
string "node"string "tomcat"string "taskomatic"string "postgres"string "self_monitoring"
3.3 getStatus
Description
Get the status of each Prometheus exporter.
Parameters
string sessionKey
Return Value
array:
struct - Exporters
string "node"string "tomcat"string "taskomatic"string "postgres"string "self_monitoring"
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
NOT_AFFECTED - Not aected
PATCHED - Patched
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
30 listImagesByPatchStatus SUSE Manager 24
array "string"
channel_labels - Labels of channels that contain an unapplied patch
array "string"
errata_advisories - Advisories of erratas that patch the speciedvulnerability
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"
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"
31 listSystemsByPatchStatus SUSE Manager 24
errata_advisories - Advisories of erratas that patch the speciedvulnerability
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
NOT_AFFECTED - Not aected
PATCHED - Patched
Return Value
array:
struct - cve_audit_system
int "system_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
32 listSystemsByPatchStatus SUSE Manager 24
array "string"
channel_labels - Labels of channels that contain an unapplied patcharray "string"
errata_advisories - Advisories of erratas that patch the speciedvulnerability
33 listSystemsByPatchStatus SUSE Manager 24
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
int - 1 on success, exception thrown otherwise.
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:
struct - channel info
int "id"string "label"string "name"string "provider_name"int "packages"int "systems"string "arch_name"
7.3 listMyChannelsDescription
List all software channels that belong to the user's organization.
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.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:
struct - channel info
int "id"string "label"string "name"string "provider_name"int "packages"int "systems"string "arch_name"
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:
struct - channel info
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:
struct - channel info
int "id"string "label"string "name"string "provider_name"int "packages"int "systems"string "arch_name"
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:
struct - channel info
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:
struct - channel info
int "id"string "label"string "name"string "provider_name"int "packages"int "systems"string "arch_name"
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
int - 1 on success, exception thrown otherwise.
8.2 enableUserRestrictionsDescription
Enable user restrictions for the given channel. If enabled, only selected users within theorganization may subscribe to the channel.
Parameters
string sessionKeystring channelLabel - label of the channel
Return Value
int - 1 on success, exception thrown otherwise.
8.3 getOrgSharingDescription
42 disableUserRestrictions SUSE Manager 24
Get organization sharing access control.
Parameters
string sessionKeystring channelLabel - label of the channel
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
int - 1 on success, exception thrown otherwise.
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
int - 1 on success, exception thrown otherwise.
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
int - 1 on success, exception thrown otherwise.
9.3 list
Description
List the organizations associated with the given channel that may be trusted.
Parameters
string sessionKeystring channelLabel - label of the channel
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
int - 1 on success, exception thrown otherwise.
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 alignMetadata
Description
Align the metadata of a channel to another channel.
Parameters
string sessionKey
string channelFromLabel - the label of the source channel
string channelToLabel - the label of the target channel
string metadataType - the metadata type. Only 'modules' supported currently.
Return Value
int result code - 1 when metadata has been aligned, 0 otherwise
10.4 applyChannelState
Description
Refresh pillar data and then schedule channels state on the provided systems
Parameters
string sessionKey
array:
int - serverId
Return Value
47 alignMetadata SUSE Manager 24
array:
int - actionId
10.5 associateRepoDescription
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"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"
48 associateRepo SUSE Manager 24
string "clone_original"array:
struct - contentSources
int "id"string "label"string "sourceUrl"string "type"
10.6 clearRepoFiltersDescription
Removes the lters for a repo
Parameters
string sessionKeystring label - repository label
Return Value
int - 1 on success, exception thrown otherwise.
10.7 cloneDescription
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"
49 clearRepoFilters SUSE Manager 24
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.8 createDescription
Creates a software channelAvailable since API version: 10.9
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
50 create SUSE Manager 24
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.9 create
Description
Creates a software channelAvailable since API version: 10.9
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
51 create SUSE Manager 24
Return Value
int status - 1 if the creation operation succeeded, 0 otherwise
10.10 create
Description
Creates a software channelAvailable since API version: 10.9
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.
Return Value
int status - 1 if the creation operation succeeded, 0 otherwise
10.11 create
Description
Creates a software channel
Parameters
52 create SUSE Manager 24
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
int status - 1 if the creation operation succeeded, 0 otherwise
10.12 createRepo
Description
Creates a repository
Parameters
string sessionKey
string label - repository label
string 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
53 createRepo SUSE Manager 24
string "sslCaDesc"
string "sslCertDesc"
string "sslKeyDesc"
10.13 createRepo
Description
Creates a repository
Parameters
string sessionKey
string label - repository label
string type - repository type (yum, uln...)
string url - repository url
string sslCaCert - SSL CA cert description
string sslCliCert - SSL Client cert description
string sslCliKey - SSL Client key description
Return Value
struct - channel
int "id"
string "label"
string "sourceUrl"
string "type"
boolean "hasSignedMetadata"
array "sslContentSources" -
struct - contentsourcessl
54 createRepo SUSE Manager 24
string "sslCaDesc"
string "sslCertDesc"
string "sslKeyDesc"
10.14 createRepo
Description
Creates a repository
Parameters
string sessionKey
string label - repository label
string type - repository type (only YUM is supported)
string url - repository url
string sslCaCert - SSL CA cert description, or an empty string
string sslCliCert - SSL Client cert description, or an empty string
string sslCliKey - SSL Client key description, or an empty string
boolean hasSignedMetadata - true if the repository has signed metadata, falseotherwise
Return Value
struct - channel
int "id"
string "label"
string "sourceUrl"
string "type"
boolean "hasSignedMetadata"
array "sslContentSources" -
struct - contentsourcessl
55 createRepo SUSE Manager 24
string "sslCaDesc"
string "sslCertDesc"
string "sslKeyDesc"
10.15 delete
Description
Deletes a custom software channel
Parameters
string sessionKey
string channelLabel - channel to delete
Return Value
int - 1 on success, exception thrown otherwise.
10.16 disassociateRepo
Description
Disassociates a repository from a channel
Parameters
string sessionKey
string channelLabel - channel label
string repoLabel - repository label
Return Value
struct - channel
int "id"
string "name"
string "label"
56 delete 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 "end_of_life"
string "parent_channel_label"
string "clone_original"
array:
struct - contentSources
int "id"
string "label"
string "sourceUrl"
string "type"
10.17 getChannelLastBuildById
Description
Returns the last build date of the repomd.xml le for the given channel as a localised string.
Parameters
string sessionKey
int id - id of channel wanted
Return Value
57 getChannelLastBuildById SUSE Manager 24
date date - the last build date of the repomd.xml le as a localised string
10.18 getDetails
Description
Returns details of the given channel as a map
Parameters
string sessionKey
string 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)
string "end_of_life"
string "parent_channel_label"
58 getDetails SUSE Manager 24
string "clone_original"array:
struct - contentSources
int "id"string "label"string "sourceUrl"string "type"
10.19 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"string "support_policy"string "gpg_key_url"
59 getDetails SUSE Manager 24
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:
struct - contentSources
int "id"
string "label"
string "sourceUrl"
string "type"
10.20 getRepoDetails
Description
Returns details of the given repository
Parameters
string sessionKey
string repoLabel - repo to query
Return Value
struct - channel
int "id"
string "label"
string "sourceUrl"
string "type"
boolean "hasSignedMetadata"
array "sslContentSources" -
struct - contentsourcessl
60 getRepoDetails SUSE Manager 24
string "sslCaDesc"string "sslCertDesc"string "sslKeyDesc"
10.21 getRepoDetailsDescription
Returns details of the given repository
Parameters
string sessionKeyint id - repository id
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.22 getRepoSyncCronExpressionDescription
Returns repo synchronization cron expression
Parameters
61 getRepoDetails SUSE Manager 24
string sessionKeystring channelLabel - channel label
Return Value
string expression - quartz expression
10.23 isExistingDescription
Returns whether is existing
Parameters
string sessionKeystring channelLabel - label of the channel
Return Value
boolean result - True if the channel exists
10.24 isGloballySubscribableDescription
Returns whether the channel is subscribable by any user in the organization
Parameters
string sessionKeystring channelLabel - channel to query
Return Value
int subscribable - 1 if true, 0 otherwise
10.25 isUserManageableDescription
62 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.26 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.27 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
63 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.28 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"
64 listAllPackages SUSE Manager 24
string "checksum"string "checksum_type"int "id"string "arch_label"string "last_modied_date"string "last_modied" - (Deprecated)
10.29 listAllPackagesDescription
Lists all packages in the channel, regardless of the package version
Parameters
string sessionKeystring channelLabel - channel to query
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.30 listAllPackagesDescription
65 listAllPackages SUSE Manager 24
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
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 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
66 listAllPackages SUSE Manager 24
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.32 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 channelLabel - channel to query
string startDate
string endDate
Return Value
67 listAllPackagesByDate SUSE Manager 24
array:
struct - package
string "name"
string "version"
string "release"
string "epoch"
string "id"
string "arch_label"
string "last_modied"
10.33 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 channelLabel - channel to query
string startDate
Return Value
array:
struct - package
string "name"
string "version"
string "release"
string "epoch"
string "id"
68 listAllPackagesByDate SUSE Manager 24
string "arch_label"string "last_modied"
10.34 listAllPackagesByDateDescription
Lists all packages in the channel, regardless of the package versionDeprecated - being replaced by listAllPackages(string sessionKey, string channelLabel)
Parameters
string sessionKeystring channelLabel - channel to query
Return Value
array:
struct - package
string "name"string "version"string "release"string "epoch"string "id"string "arch_label"string "last_modied"
10.35 listArchesDescription
Lists the potential software channel architectures that can be created
Parameters
string sessionKey
Return Value
69 listAllPackagesByDate SUSE Manager 24
array:
struct - channel arch
string "name"string "label"
10.36 listChannelReposDescription
Lists associated repos with the given channel
Parameters
string sessionKeystring channelLabel - channel label
Return Value
array:
struct - channel
int "id"string "label"string "sourceUrl"string "type"boolean "hasSignedMetadata"array "sslContentSources" -
struct - contentsourcessl
string "sslCaDesc"string "sslCertDesc"string "sslKeyDesc"
10.37 listChildrenDescription
70 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 "end_of_life"
string "parent_channel_label"
string "clone_original"
array:
struct - contentSources
int "id"
string "label"
71 listChildren SUSE Manager 24
string "sourceUrl"string "type"
10.38 listErrataDescription
List the errata applicable to a channel after given startDate
Parameters
string sessionKeystring channelLabel - channel to querydateTime.iso8601 startDate
Return Value
array:
struct - errata
int "id" - Errata ID.string "issue_date" - Date erratum was updated. (Deprecated)string "date" - Date erratum was created. (Deprecated)string "update_date" - Date erratum was updated. (Deprecated)string "advisory_synopsis" - Summary of the erratum.string "advisory_type" - Type label such as Security, Bug Fixstring "advisory_status" - Status label such as nal, testing, retractedstring "advisory_name" - Name such as RHSA, etc
10.39 listErrataDescription
List the errata applicable to a channel between startDate and endDate.
Parameters
string sessionKeystring channelLabel - channel to query
72 listErrata SUSE Manager 24
dateTime.iso8601 startDatedateTime.iso8601 endDate
Return Value
array:
struct - errata
int "id" - Errata ID.string "issue_date" - Date erratum was updated. (Deprecated)string "date" - Date erratum was created. (Deprecated)string "update_date" - Date erratum was updated. (Deprecated)string "advisory_synopsis" - Summary of the erratum.string "advisory_type" - Type label such as Security, Bug Fixstring "advisory_status" - Status label such as nal, testing, retractedstring "advisory_name" - Name such as RHSA, etc
10.40 listErrataDescription
List the errata applicable to a channel between startDate and endDate.
Parameters
string sessionKeystring channelLabel - channel to querydateTime.iso8601 startDatedateTime.iso8601 endDateboolean lastModied - select by last modied or not
Return Value
array:
struct - errata
int "id" - Errata ID.string "issue_date" - Date erratum was updated. (Deprecated)string "date" - Date erratum was created. (Deprecated)
73 listErrata SUSE Manager 24
string "update_date" - Date erratum was updated. (Deprecated)string "advisory_synopsis" - Summary of the erratum.string "advisory_type" - Type label such as Security, Bug Fixstring "advisory_status" - Status label such as nal, testing, retractedstring "advisory_name" - Name such as RHSA, etc
10.41 listErrataDescription
List the errata applicable to a channel
Parameters
string sessionKeystring channelLabel - channel to query
Return Value
array:
struct - errata
int "id" - Errata ID.string "issue_date" - Date erratum was updated. (Deprecated)string "date" - Date erratum was created. (Deprecated)string "update_date" - Date erratum was updated. (Deprecated)string "advisory_synopsis" - Summary of the erratum.string "advisory_type" - Type label such as Security, Bug Fixstring "advisory_status" - Status label such as nal, testing, retractedstring "advisory_name" - Name such as RHSA, etc
10.42 listErrataDescription
List the errata applicable to a channel after given startDateDeprecated - being replaced by listErrata(string sessionKey, string channelLabel,dateTime.iso8601 startDate)
74 listErrata SUSE Manager 24
Parameters
string sessionKeystring channelLabel - channel to querystring startDate
Return Value
array:
struct - errata
string "advisory" - name of the advisorystring "issue_date" - date format follows YYYY-MM-DD HH24:MI:SSstring "update_date" - date format follows YYYY-MM-DD HH24:MI:SSstring "synopsis"string "advisory_type"string "last_modied_date" - date format follows YYYY-MM-DDHH24:MI:SS
10.43 listErrata
Description
List the errata applicable to a channel between startDate and endDate.Deprecated - being replaced by listErrata(string sessionKey, string channelLabel,dateTime.iso8601 startDate, dateTime.iso8601)
Parameters
string sessionKeystring channelLabel - channel to querystring startDatestring endDate
Return Value
array:
struct - errata
75 listErrata SUSE Manager 24
string "advisory" - name of the advisorystring "issue_date" - date format follows YYYY-MM-DD HH24:MI:SSstring "update_date" - date format follows YYYY-MM-DD HH24:MI:SSstring "synopsis"string "advisory_type"string "last_modied_date" - date format follows YYYY-MM-DDHH24:MI:SS
10.44 listErrataByTypeDescription
List the errata of a specic type that are applicable to a channel
Parameters
string sessionKeystring channelLabel - channel to querystring advisoryType - type of advisory (one of of the following: 'Security Advisory','Product Enhancement Advisory', 'Bug Fix Advisory'
Return Value
array:
struct - errata
string "advisory" - name of the advisorystring "issue_date" - date format follows YYYY-MM-DD HH24:MI:SSstring "update_date" - date format follows YYYY-MM-DD HH24:MI:SSstring "synopsis"string "advisory_type"string "last_modied_date" - date format follows YYYY-MM-DDHH24:MI:SS
10.45 listErrataNeedingSyncDescription
76 listErrataByType SUSE Manager 24
If you have synced a new channel then patches will have been updated with the packagesthat are in the newly synced channel. A cloned erratum will not have been automaticallyupdated however. If you cloned a channel that includes those cloned errata and shouldinclude the new packages, they will not be included when they should. This method liststhe errata that will be updated if you run the syncErrata method.
Parameters
string sessionKey
string channelLabel - channel to update
Return Value
array:
struct - errata
int "id" - Errata ID.
string "issue_date" - Date erratum was updated. (Deprecated)
string "date" - Date erratum was created. (Deprecated)
string "update_date" - Date erratum was updated. (Deprecated)
string "advisory_synopsis" - Summary of the erratum.
string "advisory_type" - Type label such as Security, Bug Fix
string "advisory_status" - Status label such as nal, testing, retracted
string "advisory_name" - Name such as RHSA, etc
10.46 listLatestPackages
Description
Lists the packages with the latest version (including release and epoch) for the givenchannel
Parameters
string sessionKey
string channelLabel - channel to query
Return Value
77 listLatestPackages SUSE Manager 24
array:
struct - package
string "name"
string "version"
string "release"
string "epoch"
int "id"
string "arch_label"
10.47 listPackagesWithoutChannel
Description
Lists all packages that are not associated with a channel. Typically these are custompackages.
Parameters
string sessionKey
Return Value
array:
struct - package
string "name"
string "version"
string "release"
string "epoch"
int "id"
string "arch_label"
dateTime.iso8601 "last_modied"
78 listPackagesWithoutChannel SUSE Manager 24
string "path" - The path on that le system that the package residesstring "provider" - The provider of the package, determined by the gpgkey it was signed with.
10.48 listRepoFiltersDescription
Lists the lters for a repo
Parameters
string sessionKeystring label - repository label
Return Value
array:
struct - lter
int "sortOrder"string "lter"string "ag"
10.49 listSubscribedSystemsDescription
Returns list of subscribed systems for the given channel label
Parameters
string sessionKeystring channelLabel - channel to query
Return Value
array:
struct - system
79 listRepoFilters SUSE Manager 24
int "id"
string "name"
10.50 listSystemChannels
Description
Returns a list of channels that a system is subscribed to for the given system id
Parameters
string sessionKey
int serverId
Return Value
array:
struct - channel
string "id"
string "label"
string "name"
10.51 listUserRepos
Description
Returns a list of ContentSource (repos) that the user can see
Parameters
string sessionKey
Return Value
array:
struct - map
80 listSystemChannels SUSE Manager 24
long "id" - ID of the repostring "label" - label of the repostring "sourceUrl" - URL of the repo
10.52 mergeErrataDescription
Merges all errata from one channel into another
Parameters
string sessionKeystring mergeFromLabel - the label of the channel to pull errata fromstring mergeToLabel - the label to push the errata into
Return Value
array:
struct - errata
int "id" - Errata Idstring "date" - Date erratum was created.string "advisory_type" - Type of the advisory.string "advisory_status" - Status of the advisory.string "advisory_name" - Name of the advisory.string "advisory_synopsis" - Summary of the erratum.
10.53 mergeErrataDescription
Merges all errata from one channel into another based upon a given start/end date.
Parameters
string sessionKeystring mergeFromLabel - the label of the channel to pull errata from
81 mergeErrata SUSE Manager 24
string mergeToLabel - the label to push the errata intostring startDatestring endDate
Return Value
array:
struct - errata
int "id" - Errata Idstring "date" - Date erratum was created.string "advisory_type" - Type of the advisory.string "advisory_status" - Status of the advisory.string "advisory_name" - Name of the advisory.string "advisory_synopsis" - Summary of the erratum.
10.54 mergeErrata
Description
Merges a list of errata from one channel into another
Parameters
string sessionKeystring mergeFromLabel - the label of the channel to pull errata fromstring mergeToLabel - the label to push the errata intoarray:
string - advisory - The advisory name of the errata to merge
Return Value
array:
struct - errata
int "id" - Errata Idstring "date" - Date erratum was created.
82 mergeErrata SUSE Manager 24
string "advisory_type" - Type of the advisory.string "advisory_status" - Status of the advisory.string "advisory_name" - Name of the advisory.string "advisory_synopsis" - Summary of the erratum.
10.55 mergePackagesDescription
Merges all packages from one channel into another
Parameters
string sessionKeystring mergeFromLabel - the label of the channel to pull packages fromstring mergeToLabel - the label to push the packages into
Return Value
array:
struct - package
string "name"string "version"string "release"string "epoch"int "id"string "arch_label"dateTime.iso8601 "last_modied"string "path" - The path on that le system that the package residesstring "provider" - The provider of the package, determined by the gpgkey it was signed with.
10.56 mergePackagesDescription
Merges all packages from one channel into another
83 mergePackages SUSE Manager 24
Parameters
string sessionKeystring mergeFromLabel - the label of the channel to pull packages fromstring mergeToLabel - the label to push the packages intoboolean alignModules - align modular data of the target channel to the source channel(RHEL8 and higher)
Return Value
array:
struct - package
string "name"string "version"string "release"string "epoch"int "id"string "arch_label"dateTime.iso8601 "last_modied"string "path" - The path on that le system that the package residesstring "provider" - The provider of the package, determined by the gpgkey it was signed with.
10.57 regenerateNeededCacheDescription
Completely clear and regenerate the needed Errata and Package cache for all systemssubscribed to the specied channel. This should be used only if you believe your cache isincorrect for all the systems in a given channel. This will schedule an asynchronous actionto actually do the processing.
Parameters
string sessionKeystring channelLabel - the label of the channel
Return Value
84 regenerateNeededCache SUSE Manager 24
int - 1 on success, exception thrown otherwise.
10.58 regenerateNeededCacheDescription
Completely clear and regenerate the needed Errata and Package cache for all systemssubscribed. You must be a SUSE Manager Admin to perform this action. This will schedulean asynchronous action to actually do the processing.
Parameters
string sessionKey
Return Value
int - 1 on success, exception thrown otherwise.
10.59 regenerateYumCacheDescription
Regenerate yum cache for the specied channel.
Parameters
string sessionKeystring channelLabel - the label of the channelboolean force - force cache regeneration
Return Value
int - 1 on success, exception thrown otherwise.
10.60 removeErrataDescription
Removes a given list of errata from the given channel.
Parameters
85 regenerateNeededCache SUSE Manager 24
string sessionKeystring channelLabel - target channel.array:
string - advisoryName - name of an erratum to removeboolean removePackages - True to remove packages from the channel
Return Value
int - 1 on success, exception thrown otherwise.
10.61 removePackagesDescription
Removes a given list of packages from the given channel.
Parameters
string sessionKeystring channelLabel - target channel.array:
int - packageId - id of a package to remove from the channel.
Return Value
int - 1 on success, exception thrown otherwise.
10.62 removeRepoDescription
Removes a repository
Parameters
string sessionKeylong id - ID of repo to be removed
Return Value
86 removePackages SUSE Manager 24
int - 1 on success, exception thrown otherwise.
10.63 removeRepoDescription
Removes a repository
Parameters
string sessionKeystring label - label of repo to be removed
Return Value
int - 1 on success, exception thrown otherwise.
10.64 removeRepoFilterDescription
Removes a lter for a given repo.
Parameters
string sessionKeystring label - repository labelstruct - lter_map
string "lter" - string to lter onstring "ag" - + for include, - for exclude
Return Value
int - 1 on success, exception thrown otherwise.
10.65 setContactDetailsDescription
87 removeRepo SUSE Manager 24
Set contact/support information for given channel.
Parameters
string sessionKey
string channelLabel - label of the channel
string maintainerName - name of the channel maintainer
string maintainerEmail - email of the channel maintainer
string maintainerPhone - phone number of the channel maintainer
string supportPolicy - channel support policy
Return Value
int - 1 on success, exception thrown otherwise.
10.66 setDetails
Description
Allows to modify channel attributes
Parameters
string sessionKey
int channelId - channel id
struct - channel_map
string "checksum_label" - new channel repository checksum label (optional)
string "name" - new channel name (optional)
string "summary" - new channel summary (optional)
string "description" - new channel description (optional)
string "maintainer_name" - new channel maintainer name (optional)
string "maintainer_email" - new channel email address (optional)
string "maintainer_phone" - new channel phone number (optional)
string "gpg_key_url" - new channel gpg key url (optional)
string "gpg_key_id" - new channel gpg key id (optional)
string "gpg_key_fp" - new channel gpg key ngerprint (optional)
string "gpg_check" - enable/disable gpg check (optional)
88 setDetails SUSE Manager 24
Return Value
int - 1 on success, exception thrown otherwise.
10.67 setDetails
Description
Allows to modify channel attributes
Parameters
string sessionKeyint channelId - channel idstruct - channel_map
string "checksum_label" - new channel repository checksum label (optional)string "name" - new channel name (optional)string "summary" - new channel summary (optional)string "description" - new channel description (optional)string "maintainer_name" - new channel maintainer name (optional)string "maintainer_email" - new channel email address (optional)string "maintainer_phone" - new channel phone number (optional)string "gpg_key_url" - new channel gpg key url (optional)string "gpg_key_id" - new channel gpg key id (optional)string "gpg_key_fp" - new channel gpg key ngerprint (optional)string "gpg_check" - enable/disable gpg check (optional)
Return Value
int - 1 on success, exception thrown otherwise.
10.68 setGloballySubscribable
Description
Set globally subscribable attribute for given channel.
Parameters
89 setDetails SUSE Manager 24
string sessionKeystring channelLabel - label of the channelboolean subscribable - true if the channel is to be globally subscribable. Falseotherwise.
Return Value
int - 1 on success, exception thrown otherwise.
10.69 setRepoFilters
Description
Replaces the existing set of lters for a given repo. Filters are ranked by their order inthe array.
Parameters
string sessionKeystring label - repository labelarray:
struct - lter_map
string "lter" - string to lter onstring "ag" - + for include, - for exclude
Return Value
int - 1 on success, exception thrown otherwise.
10.70 setSystemChannels
Description
Change a systems subscribed channels to the list of channels passed in.Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId,string channelLabel) and system.setChildChannels(string sessionKey, int serverId,array[string channelLabel])
90 setRepoFilters SUSE Manager 24
Parameters
string sessionKey
int serverId
array:
string - channelLabel - labels of the channels to subscribe the system to.
Return Value
int - 1 on success, exception thrown otherwise.
10.71 setUserManageable
Description
Set the manageable ag for a given channel and user. If value is set to 'true', this methodwill give the user manage permissions to the channel. Otherwise, that privilege is revoked.
Parameters
string sessionKey
string channelLabel - label of the channel
string login - login of the target user
boolean value - value of the ag to set
Return Value
int - 1 on success, exception thrown otherwise.
10.72 setUserSubscribable
Description
Set the subscribable ag for a given channel and user. If value is set to 'true', thismethod will give the user subscribe permissions to the channel. Otherwise, that privilegeis revoked.
Parameters
91 setUserManageable SUSE Manager 24
string sessionKeystring channelLabel - label of the channelstring login - login of the target userboolean value - value of the ag to set
Return Value
int - 1 on success, exception thrown otherwise.
10.73 subscribeSystemDescription
Subscribes a system to a list of channels. If a base channel is included, that is set beforesetting child channels. When setting child channels the current child channel subscriptionsare cleared. To fully unsubscribe the system from all channels, simply provide an emptylist of channel labels.Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId,string channelLabel) and system.setChildChannels(string sessionKey, int serverId,array[string channelLabel])
Parameters
string sessionKeyint serverIdarray:
string - label - channel label to subscribe the system to.
Return Value
int - 1 on success, exception thrown otherwise.
10.74 syncErrataDescription
If you have synced a new channel then patches will have been updated with the packagesthat are in the newly synced channel. A cloned erratum will not have been automaticallyupdated however. If you cloned a channel that includes those cloned errata and should
92 subscribeSystem SUSE Manager 24
include the new packages, they will not be included when they should. This methodupdates all the errata in the given cloned channel with packages that have recently beenadded, and ensures that all the packages you expect are in the channel. It also updatescloned errata attributes like advisoryStatus.
Parameters
string sessionKeystring channelLabel - channel to update
Return Value
int - 1 on success, exception thrown otherwise.
10.75 syncRepoDescription
Trigger immediate repo synchronization
Parameters
string sessionKeyarray:
string - channelLabels
Return Value
int - 1 on success, exception thrown otherwise.
10.76 syncRepoDescription
Trigger immediate repo synchronization
Parameters
string sessionKeystring channelLabel - channel label
93 syncRepo SUSE Manager 24
Return Value
int - 1 on success, exception thrown otherwise.
10.77 syncRepo
Description
Trigger immediate repo synchronization
Parameters
string sessionKey
string channelLabel - channel label
struct - params_map
boolean "sync-kickstart" - Create kickstartable tree - Optional
boolean "no-errata" - Do not sync errata - Optional
boolean "fail" - Terminate upon any error - Optional
boolean "latest" - Only download latest packages - Optional
Return Value
int - 1 on success, exception thrown otherwise.
10.78 syncRepo
Description
Schedule periodic repo synchronization
Parameters
string sessionKey
string channelLabel - channel label
string cron expression - if empty all periodic schedules will be disabled
Return Value
94 syncRepo SUSE Manager 24
int - 1 on success, exception thrown otherwise.
10.79 syncRepo
Description
Schedule periodic repo synchronization
Parameters
string sessionKey
string channelLabel - channel label
string cron expression - if empty all periodic schedules will be disabled
struct - params_map
boolean "sync-kickstart" - Create kickstartable tree - Optional
boolean "no-errata" - Do not sync errata - Optional
boolean "fail" - Terminate upon any error - Optional
boolean "latest" - Only download latest packages - Optional
Return Value
int - 1 on success, exception thrown otherwise.
10.80 unsubscribeChannels
Description
Unsubscribe channels from the specied minions, trigger immediate channels update stateDeprecated - being replaced by refreshSystemsChannelInfo
Parameters
95 syncRepo SUSE Manager 24
string sessionKeyarray:
int - serverIdstring baseChannelLabelarray:
string - childLabels
Return Value
array:
int - actionId
10.81 updateRepo
Description
Updates a ContentSource (repo)
Parameters
string sessionKeyint id - repository idstring label - new repository labelstring url - new repository URL
Return Value
struct - channel
int "id"string "label"string "sourceUrl"string "type"boolean "hasSignedMetadata"array "sslContentSources" -
struct - contentsourcessl
96 updateRepo SUSE Manager 24
string "sslCaDesc"string "sslCertDesc"string "sslKeyDesc"
10.82 updateRepoLabel
Description
Updates repository label
Parameters
string sessionKeyint id - repository idstring label - new repository label
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.83 updateRepoLabel
Description
Updates repository label
97 updateRepoLabel SUSE Manager 24
Parameters
string sessionKeystring label - repository labelstring newLabel - new repository label
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.84 updateRepoSsl
Description
Updates repository SSL certicates
Parameters
string sessionKeyint id - repository idstring sslCaCert - SSL CA cert descriptionstring sslCliCert - SSL Client cert descriptionstring sslCliKey - SSL Client key description
Return Value
struct - channel
98 updateRepoSsl SUSE Manager 24
int "id"string "label"string "sourceUrl"string "type"boolean "hasSignedMetadata"array "sslContentSources" -
struct - contentsourcessl
string "sslCaDesc"string "sslCertDesc"string "sslKeyDesc"
10.85 updateRepoSslDescription
Updates repository SSL certicates
Parameters
string sessionKeystring label - repository labelstring sslCaCert - SSL CA cert descriptionstring sslCliCert - SSL Client cert descriptionstring sslCliKey - SSL Client key description
Return Value
struct - channel
int "id"string "label"string "sourceUrl"string "type"boolean "hasSignedMetadata"array "sslContentSources" -
struct - contentsourcessl
99 updateRepoSsl SUSE Manager 24
string "sslCaDesc"string "sslCertDesc"string "sslKeyDesc"
10.86 updateRepoUrl
Description
Updates repository source URL
Parameters
string sessionKeyint id - repository idstring url - new 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.87 updateRepoUrl
Description
Updates repository source URL
100 updateRepoUrl SUSE Manager 24
Parameters
string sessionKeystring label - repository labelstring url - new 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"
101 updateRepoUrl SUSE Manager 24
11 cluster
Provides methods to access and modify clusters.
11.1 addCluster
Description
Add a cluster
Parameters
string sessionKey
string name
string description
integer management node id
string cluster provider
struct containing the values for each eld in the form
Return Value
int - 1 on success, exception thrown otherwise.
11.2 deleteCluster
Description
Delete a cluster given the ID
Parameters
string sessionKey
int clusterId
Return Value
102 addCluster SUSE Manager 24
int - 1 on success, exception thrown otherwise.
11.3 listClusterNodesDescription
Lists the nodes of a cluster.
Parameters
string sessionKeyint clusterId
Return Value
array:
string - hostname
11.4 listClustersDescription
List all clusters for the user's org
Parameters
string sessionKey
Return Value
array:
struct - cluster_id
string "cluster_name"
11.5 scheduleJoinNodeToClusterDescription
103 listClusterNodes SUSE Manager 24
Schedule the execution of a node join the cluster
Parameters
string sessionKeyint clusterIdarray:
integer - systemIdsstruct containing the values for each eld in the formdateTime.iso8601 earliestOccurrence - earliest the action can run
Return Value
int - 1 on success, exception thrown otherwise.
11.6 scheduleRemoveNodeFromCluster
Description
Schedule the execution of a node join the cluster
Parameters
string sessionKeyint clusterIdarray:
integer - systemIdsstruct containing the values for each eld in the formdateTime.iso8601 earliestOccurrence - earliest the action can run
Return Value
int - 1 on success, exception thrown otherwise.
11.7 scheduleUpgradeCluster
Description
104 scheduleRemoveNodeFromCluster SUSE Manager 24
Schedule the execution of a cluster upgrade
Parameters
string sessionKeyint clusterIdstruct containing the values for each eld in the formdateTime.iso8601 earliestOccurrence - earliest the action can run
Return Value
int - 1 on success, exception thrown otherwise.
105 scheduleUpgradeCluster SUSE Manager 24
12 configchannel
Provides methods to access and modify many aspects of conguration channels.
12.1 channelExistsDescription
Check for the existence of the cong channel provided.
Parameters
string sessionKeystring channelLabel - Channel to check for.
Return Value
int existence - 1 if exists, 0 otherwise
12.2 createDescription
Create a new global cong channel. Caller must be at least a cong admin or anorganization admin.
Parameters
string sessionKeystring channelLabelstring channelNamestring channelDescription
Return Value
struct - Conguration Channel information
int "id"int "orgId"string "label"
106 channelExists SUSE Manager 24
string "name"string "description"struct "congChannelType"struct - Conguration Channel Type information
int "id"string "label"string "name"int "priority"
12.3 create
Description
Create a new global cong channel. Caller must be at least a cong admin or anorganization admin.
Parameters
string sessionKeystring channelLabelstring channelNamestring channelDescriptionstring channelType - The channel type either 'normal' or 'state'.
Return Value
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"
107 create SUSE Manager 24
string "name"
int "priority"
12.4 create
Description
Create a new global cong channel. Caller must be at least a cong admin or anorganization admin.
Parameters
string sessionKey
string channelLabel
string channelName
string channelDescription
string channelType - The channel type either 'normal' or 'state'.
struct - path info
string "contents" - Contents of the init.sls le
boolean "contents_enc64" - Identies base64 encoded content(default: disabled)
Return Value
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"
108 create SUSE Manager 24
string "name"
int "priority"
12.5 createOrUpdatePath
Description
Create a new le or directory with the given path, or update an existing path.Available since API version: 10.2
Parameters
string sessionKey
string congChannelLabel
string path
boolean isDir - True if the path is a directory, False if it is a le.
struct - path info
string "contents" - Contents of the le (text or base64 encoded if binary or wantto preserve control characters like LF, CR etc.)(only for non-directories)
boolean "contents_enc64" - Identies base64 encoded content (default: disabled,only for non-directories)
string "owner" - Owner of the le/directory.
string "group" - Group name of the le/directory.
string "permissions" - Octal le/directory permissions (eg: 644)
string "selinux_ctx" - SELinux Security context (optional)
string "macro-start-delimiter" - Cong le macro start delimiter. Use null orempty string to accept the default. (only for non-directories)
string "macro-end-delimiter" - Cong le macro end delimiter. Use null or emptystring to accept the default. (only for non-directories)
int "revision" - next revision number, auto increment for null
boolean "binary" - mark the binary content, if True, base64 encoded content isexpected (only for non-directories)
Return Value
struct - Conguration Revision information
109 createOrUpdatePath SUSE Manager 24
string "type"
le
directory
symlink
string "path" - File Path
string "target_path" - Symbolic link Target File Path. Present for Symbolic linksonly.
string "channel" - Channel Name
string "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)
boolean "contents_enc64" - Identies base64 encoded content
int "revision" - File Revision
dateTime.iso8601 "creation" - Creation Date
dateTime.iso8601 "modied" - Last Modied Date
string "owner" - File Owner. Present for les or directories only.
string "group" - File Group. Present for les or directories only.
int "permissions" - File Permissions (Deprecated). Present for les or directoriesonly.
string "permissions_mode" - File Permissions. Present for les or directories only.
string "selinux_ctx" - SELinux Context (optional).
boolean "binary" - true/false , Present for les only.
string "sha256" - File's sha256 signature. Present for les only.
string "macro-start-delimiter" - Macro start delimiter for a cong le. Presentfor text les only.
string "macro-end-delimiter" - Macro end delimiter for a cong le. Present fortext les only.
12.6 createOrUpdateSymlink
Description
Create a new symbolic link with the given path, or update an existing path in cong channelof 'normal' type.Available since API version: 10.2
Parameters
110 createOrUpdateSymlink SUSE Manager 24
string sessionKey
string congChannelLabel
string path
struct - path info
string "target_path" - The target path for the symbolic link
string "selinux_ctx" - SELinux Security context (optional)
int "revision" - next revision number, skip this eld for automatic revisionnumber assignment
Return Value
struct - Conguration Revision information
string "type"
le
directory
symlink
string "path" - File Path
string "target_path" - Symbolic link Target File Path. Present for Symbolic linksonly.
string "channel" - Channel Name
string "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)
boolean "contents_enc64" - Identies base64 encoded content
int "revision" - File Revision
dateTime.iso8601 "creation" - Creation Date
dateTime.iso8601 "modied" - Last Modied Date
string "owner" - File Owner. Present for les or directories only.
string "group" - File Group. Present for les or directories only.
int "permissions" - File Permissions (Deprecated). Present for les or directoriesonly.
string "permissions_mode" - File Permissions. Present for les or directories only.
string "selinux_ctx" - SELinux Context (optional).
boolean "binary" - true/false , Present for les only.
string "sha256" - File's sha256 signature. Present for les only.
111 createOrUpdateSymlink SUSE Manager 24
string "macro-start-delimiter" - Macro start delimiter for a cong le. Presentfor text les only.
string "macro-end-delimiter" - Macro end delimiter for a cong le. Present fortext les only.
12.7 deleteChannels
Description
Delete a list of global cong channels. Caller must be a cong admin.
Parameters
string sessionKey
array:
string - conguration channel labels to delete.
Return Value
int - 1 on success, exception thrown otherwise.
12.8 deleteFileRevisions
Description
Delete specied revisions of a given conguration le
Parameters
string sessionKey
string channelLabel - Label of cong channel to lookup on.
string lePath - Conguration le path.
array:
int - List of revisions to delete
Return Value
112 deleteChannels SUSE Manager 24
int - 1 on success, exception thrown otherwise.
12.9 deleteFilesDescription
Remove le paths from a global channel.
Parameters
string sessionKeystring channelLabel - Channel to remove the les from.array:
string - le paths to remove.
Return Value
int - 1 on success, exception thrown otherwise.
12.10 deployAllSystemsDescription
Schedule an immediate conguration deployment for all systems subscribed to a particularconguration channel.
Parameters
string sessionKeystring channelLabel - The conguration channel's label.
Return Value
int - 1 on success, exception thrown otherwise.
12.11 deployAllSystemsDescription
113 deleteFiles SUSE Manager 24
Schedule a conguration deployment for all systems subscribed to a particularconguration channel.
Parameters
string sessionKeystring channelLabel - The conguration channel's label.dateTime.iso8601 date - The date to schedule the action
Return Value
int - 1 on success, exception thrown otherwise.
12.12 deployAllSystemsDescription
Schedule a conguration deployment of a certain le for all systems subscribed to aparticular conguration channel.
Parameters
string sessionKeystring channelLabel - The conguration channel's label.string lePath - The conguration le path.
Return Value
int - 1 on success, exception thrown otherwise.
12.13 deployAllSystemsDescription
Schedule a conguration deployment of a certain le for all systems subscribed to aparticular conguration channel.
Parameters
string sessionKeystring channelLabel - The conguration channel's label.
114 deployAllSystems SUSE Manager 24
string lePath - The conguration le path.dateTime.iso8601 date - The date to schedule the action
Return Value
int - 1 on success, exception thrown otherwise.
12.14 getDetails
Description
Lookup cong channel details.
Parameters
string sessionKeystring channelLabel
Return Value
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"
12.15 getDetails
Description
115 getDetails SUSE Manager 24
Lookup cong channel details.
Parameters
string sessionKeyint channelId
Return Value
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"
12.16 getEncodedFileRevision
Description
Get revision of the specied conguration le and transmit the contents as base64 encoded.
Parameters
string sessionKeystring congChannelLabel - label of cong channel to lookup onstring lePath - cong le path to examineint revision - cong le revision to examine
Return Value
struct - Conguration Revision information
116 getEncodedFileRevision SUSE Manager 24
string "type"ledirectorysymlink
string "path" - File Pathstring "target_path" - Symbolic link Target File Path. Present for Symbolic linksonly.string "channel" - Channel Namestring "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)boolean "contents_enc64" - Identies base64 encoded contentint "revision" - File RevisiondateTime.iso8601 "creation" - Creation DatedateTime.iso8601 "modied" - Last Modied Datestring "owner" - File Owner. Present for les or directories only.string "group" - File Group. Present for les or directories only.int "permissions" - File Permissions (Deprecated). Present for les or directoriesonly.string "permissions_mode" - File Permissions. Present for les or directories only.string "selinux_ctx" - SELinux Context (optional).boolean "binary" - true/false , Present for les only.string "sha256" - File's sha256 signature. Present for les only.string "macro-start-delimiter" - Macro start delimiter for a cong le. Presentfor text les only.string "macro-end-delimiter" - Macro end delimiter for a cong le. Present fortext les only.
12.17 getFileRevisionDescription
Get revision of the specied cong le
Parameters
string sessionKeystring congChannelLabel - label of cong channel to lookup on
117 getFileRevision SUSE Manager 24
string lePath - cong le path to examine
int revision - cong le revision to examine
Return Value
struct - Conguration Revision information
string "type"
le
directory
symlink
string "path" - File Path
string "target_path" - Symbolic link Target File Path. Present for Symbolic linksonly.
string "channel" - Channel Name
string "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)
boolean "contents_enc64" - Identies base64 encoded content
int "revision" - File Revision
dateTime.iso8601 "creation" - Creation Date
dateTime.iso8601 "modied" - Last Modied Date
string "owner" - File Owner. Present for les or directories only.
string "group" - File Group. Present for les or directories only.
int "permissions" - File Permissions (Deprecated). Present for les or directoriesonly.
string "permissions_mode" - File Permissions. Present for les or directories only.
string "selinux_ctx" - SELinux Context (optional).
boolean "binary" - true/false , Present for les only.
string "sha256" - File's sha256 signature. Present for les only.
118 getFileRevision SUSE Manager 24
string "macro-start-delimiter" - Macro start delimiter for a cong le. Presentfor text les only.
string "macro-end-delimiter" - Macro end delimiter for a cong le. Present fortext les only.
12.18 getFileRevisions
Description
Get list of revisions for specied cong le
Parameters
string sessionKey
string channelLabel - label of cong channel to lookup on
string lePath - cong le path to examine
Return Value
array:
struct - Conguration Revision information
string "type"
le
directory
symlink
string "path" - File Path
string "target_path" - Symbolic link Target File Path. Present for Symboliclinks only.
string "channel" - Channel Name
string "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)
boolean "contents_enc64" - Identies base64 encoded content
int "revision" - File Revision
dateTime.iso8601 "creation" - Creation Date
dateTime.iso8601 "modied" - Last Modied Date
string "owner" - File Owner. Present for les or directories only.
119 getFileRevisions SUSE Manager 24
string "group" - File Group. Present for les or directories only.
int "permissions" - File Permissions (Deprecated). Present for les ordirectories only.
string "permissions_mode" - File Permissions. Present for les or directoriesonly.
string "selinux_ctx" - SELinux Context (optional).
boolean "binary" - true/false , Present for les only.
string "sha256" - File's sha256 signature. Present for les only.
string "macro-start-delimiter" - Macro start delimiter for a cong le.Present for text les only.
string "macro-end-delimiter" - Macro end delimiter for a cong le.Present for text les only.
12.19 listFiles
Description
Return a list of les in a channel.
Parameters
string sessionKey
string channelLabel - label of cong channel to list les on.
Return Value
array:
struct - Conguration File information
string "type"
le
directory
symlink
120 listFiles SUSE Manager 24
string "path" - File PathdateTime.iso8601 "last_modied" - Last Modied Date
12.20 listGlobalsDescription
List all the global cong channels accessible to the logged-in user.
Parameters
string sessionKey
Return Value
array:
struct - Conguration Channel information
int "id"int "orgId"string "label"string "name"string "description"string "type"struct "congChannelType"struct - Conguration Channel Type information
int "id"string "label"string "name"int "priority"
12.21 listSubscribedSystemsDescription
Return a list of systems subscribed to a conguration channel
Parameters
121 listGlobals SUSE Manager 24
string sessionKeystring channelLabel - label of cong channel to list subscribed systems.
Return Value
array:
struct - system
int "id"string "name"
12.22 lookupChannelInfoDescription
Lists details on a list channels given their channel labels.
Parameters
string sessionKeyarray:
string - conguration channel label
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"
122 lookupChannelInfo SUSE Manager 24
string "name"int "priority"
12.23 lookupFileInfo
Description
Given a list of paths and a channel, returns details about the latest revisions of the paths.Available since API version: 10.2
Parameters
string sessionKeystring channelLabel - label of cong channel to lookup onarray:
string - List of paths to examine.
Return Value
array:
struct - Conguration Revision information
string "type"ledirectorysymlink
string "path" - File Pathstring "target_path" - Symbolic link Target File Path. Present for Symboliclinks only.string "channel" - Channel Namestring "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)boolean "contents_enc64" - Identies base64 encoded contentint "revision" - File RevisiondateTime.iso8601 "creation" - Creation DatedateTime.iso8601 "modied" - Last Modied Datestring "owner" - File Owner. Present for les or directories only.
123 lookupFileInfo SUSE Manager 24
string "group" - File Group. Present for les or directories only.int "permissions" - File Permissions (Deprecated). Present for les ordirectories only.string "permissions_mode" - File Permissions. Present for les or directoriesonly.string "selinux_ctx" - SELinux Context (optional).boolean "binary" - true/false , Present for les only.string "sha256" - File's sha256 signature. Present for les only.string "macro-start-delimiter" - Macro start delimiter for a cong le.Present for text les only.string "macro-end-delimiter" - Macro end delimiter for a cong le.Present for text les only.
12.24 lookupFileInfoDescription
Given a path, revision number, and a channel, returns details about the latest revisionsof the paths.Available since API version: 10.12
Parameters
string sessionKeystring channelLabel - label of cong channel to lookup onstring path - path of le/directoryint revsion - The revision number.
Return Value
struct - Conguration Revision information
string "type"ledirectorysymlink
string "path" - File Pathstring "target_path" - Symbolic link Target File Path. Present for Symbolic linksonly.
124 lookupFileInfo SUSE Manager 24
string "channel" - Channel Name
string "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)
boolean "contents_enc64" - Identies base64 encoded content
int "revision" - File Revision
dateTime.iso8601 "creation" - Creation Date
dateTime.iso8601 "modied" - Last Modied Date
string "owner" - File Owner. Present for les or directories only.
string "group" - File Group. Present for les or directories only.
int "permissions" - File Permissions (Deprecated). Present for les or directoriesonly.
string "permissions_mode" - File Permissions. Present for les or directories only.
string "selinux_ctx" - SELinux Context (optional).
boolean "binary" - true/false , Present for les only.
string "sha256" - File's sha256 signature. Present for les only.
string "macro-start-delimiter" - Macro start delimiter for a cong le. Presentfor text les only.
string "macro-end-delimiter" - Macro end delimiter for a cong le. Present fortext les only.
12.25 scheduleFileComparisons
Description
Schedule a comparison of the latest revision of a le against the version deployed on alist of systems.
Parameters
string sessionKey
string channelLabel - Label of cong channel
string path - File path
array:
long - The list of server id that the comparison will be performed on
Return Value
125 scheduleFileComparisons SUSE Manager 24
int actionId - The action id of the scheduled action
12.26 updateDescription
Update a global cong channel. Caller must be at least a cong admin or an organizationadmin, or have access to a system containing this cong channel.
Parameters
string sessionKeystring channelLabelstring channelNamestring description
Return Value
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"
12.27 updateInitSlsDescription
Update the init.sls le for the given state channel. User can only update contents, nothingelse.
126 update SUSE Manager 24
Parameters
string sessionKey
string congChannelLabel
struct - path info
string "contents" - Contents of the init.sls le
boolean "contents_enc64" - Identies base64 encoded content(default: disabled)
int "revision" - next revision number, auto increment for null
Return Value
struct - Conguration Revision information
string "type"
le
directory
symlink
string "path" - File Path
string "target_path" - Symbolic link Target File Path. Present for Symbolic linksonly.
string "channel" - Channel Name
string "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)
boolean "contents_enc64" - Identies base64 encoded content
int "revision" - File Revision
dateTime.iso8601 "creation" - Creation Date
dateTime.iso8601 "modied" - Last Modied Date
string "owner" - File Owner. Present for les or directories only.
string "group" - File Group. Present for les or directories only.
int "permissions" - File Permissions (Deprecated). Present for les or directoriesonly.
string "permissions_mode" - File Permissions. Present for les or directories only.
string "selinux_ctx" - SELinux Context (optional).
boolean "binary" - true/false , Present for les only.
string "sha256" - File's sha256 signature. Present for les only.
127 updateInitSls SUSE Manager 24
string "macro-start-delimiter" - Macro start delimiter for a cong le. Presentfor text les only.string "macro-end-delimiter" - Macro end delimiter for a cong le. Present fortext les only.
128 updateInitSls SUSE Manager 24
13 contentmanagement
Provides methods to access and modify Content Lifecycle Management relatedentities (Projects, Environments, Filters, Sources).
13.1 attachFilter
Description
Attach a Filter to a Project
Parameters
string sessionKey
string projectLabel - Project label
int id - Filter id to attach
Return Value
struct - Content Filter information
int "id"
string "name"
int "orgId"
entityType "Entity type (e.g. 'package')"
rule "Rule (e.g. 'deny')"
struct - criteria
string "matcher" - The matcher type of the lter (e.g. 'contains')
string "eld" - The entity eld to match (e.g. 'name'
string "value" - The eld value to match (e.g. 'kernel')
13.2 attachSource
Description
Attach a Source to a Project
129 attachFilter SUSE Manager 24
Parameters
string sessionKey
string projectLabel - Content Project label
string sourceType - Project Source type, e.g. 'software'
string sourceLabel - Project Source label
int sourcePosition - Project Source position
Return Value
struct - Content Project Source information
string "contentProjectLabel"
string "type"
string "state"
string "channelLabel" - (If type is SW_CHANNEL) The label of channel associatedwith the source
13.3 attachSource
Description
Attach a Source to a Project
Parameters
string sessionKey
string projectLabel - Content Project label
string sourceType - Project Source type, e.g. 'software'
string sourceLabel - Project Source label
Return Value
struct - Content Project Source information
string "contentProjectLabel"
string "type"
130 attachSource SUSE Manager 24
string "state"string "channelLabel" - (If type is SW_CHANNEL) The label of channel associatedwith the source
13.4 buildProject
Description
Build a Project
Parameters
string sessionKeystring projectLabel - Project label
Return Value
int - 1 on success, exception thrown otherwise.
13.5 buildProject
Description
Build a Project
Parameters
string sessionKeystring projectLabel - Project labelstring message - Log message to be assigned to the build
Return Value
int - 1 on success, exception thrown otherwise.
13.6 createEnvironment
Description
131 buildProject SUSE Manager 24
Create a Content Environment and appends it behind given Content Environment
Parameters
string sessionKeystring projectLabel - Content Project labelstring predecessorLabel - Predecessor Environment labelstring label - new Content Environment labelstring name - new Content Environment namestring description - new Content Environment description
Return Value
struct - Content Environment information
int "id"string "label"string "name"string "description"int "version"string "status"string "contentProjectLabel"string "previousEnvironmentLabel"string "nextEnvironmentLabel"
13.7 createFilter
Description
Create a Content FilterThe following lters are available (you can get the list in machine-readable format usingthe listFilterCriteria() endpoint):Package ltering:
by name - eld: name; matchers: contains or matchesby name, epoch, version, release and architecture - eld: nevr or nevra; matcher:equals
Errata/Patch ltering:
132 createFilter SUSE Manager 24
by advisory name - eld: advisory_name; matcher: equals or matches
by type - eld: advisory_type (e.g. 'Security Advisory'); matcher: equals
by synopsis - eld: synopsis; matcher: equals, contains or matches
by keyword - eld: keyword; matcher: contains
by date - eld: issue_date; matcher: greater or greatereq
by aected package name - eld: package_name; matcher: contains_pkg_name ormatches_pkg_name
by aected package with version - eld: package_nevr; matcher: contains_pkg_lt_evr,contains_pkg_le_evr, contains_pkg_eq_evr, contains_pkg_ge_evr or contains_pkg_gt_evr
Appstream module/stream ltering:
by module name, stream - eld: module_stream; matcher: equals; value:modulaneme:stream
Note: Only 'allow' rule is supported for appstream lters.Note: The 'matches' matcher works on Java regular expressions.
Parameters
string sessionKey
string name - Filter name
string rule - Filter rule ('deny' or 'allow')
string entityType - Filter entityType ('package' or 'erratum')
struct - criteria
string "matcher" - The matcher type of the lter (e.g. 'contains')
string "eld" - The entity eld to match (e.g. 'name'
string "value" - The eld value to match (e.g. 'kernel')
Return Value
struct - Content Filter information
int "id"
string "name"
int "orgId"
entityType "Entity type (e.g. 'package')"
133 createFilter SUSE Manager 24
rule "Rule (e.g. 'deny')"
struct - criteria
string "matcher" - The matcher type of the lter (e.g. 'contains')
string "eld" - The entity eld to match (e.g. 'name'
string "value" - The eld value to match (e.g. 'kernel')
13.8 createProject
Description
Create Content Project
Parameters
string sessionKey
string label - Content Project label
string name - Content Project name
string description - Content Project description
Return Value
struct - Content Project information
int "id"
string "label"
string "name"
string "description"
int "orgId"
string "rstEnvironment label"
13.9 detachFilter
Description
Detach a Filter from a Project
Parameters
134 createProject SUSE Manager 24
string sessionKeystring projectLabel - Project labelint id - Filter id to detach
Return Value
int - 1 on success, exception thrown otherwise.
13.10 detachSource
Description
Detach a Source from a Project
Parameters
string sessionKeystring projectLabel - Content Project labelstring sourceType - Project Source type, e.g. 'software'string sourceLabel - Project Source label
Return Value
int - 1 on success, exception thrown otherwise.
13.11 listFilterCriteria
Description
List of available lter criteria
Parameters
string sessionKey
Return Value
array:
struct - Filter Criteria
135 detachSource SUSE Manager 24
string "type"
string "matcher"
string "eld"
13.12 listFilters
Description
List all Content Filters visible to given user
Parameters
string sessionKey
Return Value
array:
struct - Content Filter information
int "id"
string "name"
int "orgId"
entityType "Entity type (e.g. 'package')"
rule "Rule (e.g. 'deny')"
struct - criteria
string "matcher" - The matcher type of the lter (e.g. 'contains')
string "eld" - The entity eld to match (e.g. 'name'
string "value" - The eld value to match (e.g. 'kernel')
13.13 listProjectEnvironments
Description
List Environments in a Content Project with the respect to their ordering
Parameters
136 listFilters SUSE Manager 24
string sessionKeystring projectLabel - Content Project label
Return Value
array:
struct - Content Environment information
int "id"string "label"string "name"string "description"int "version"string "status"string "contentProjectLabel"string "previousEnvironmentLabel"string "nextEnvironmentLabel"
13.14 listProjectFiltersDescription
List all Filters associated with a Project
Parameters
string sessionKeystring projectLabel - Project label
Return Value
array:
struct - Assigned Content Filter information
string "state"struct - Content Filter information
int "id"string "name"
137 listProjectFilters SUSE Manager 24
int "orgId"
entityType "Entity type (e.g. 'package')"
rule "Rule (e.g. 'deny')"
struct - criteria
string "matcher" - The matcher type of the lter (e.g. 'contains')
string "eld" - The entity eld to match (e.g. 'name'
string "value" - The eld value to match (e.g. 'kernel')
13.15 listProjectSources
Description
List Content Project Sources
Parameters
string sessionKey
string projectLabel - Content Project label
Return Value
array:
struct - Content Project Source information
string "contentProjectLabel"
string "type"
string "state"
string "channelLabel" - (If type is SW_CHANNEL) The label of channelassociated with the source
13.16 listProjects
Description
List Content Projects visible to user
Parameters
138 listProjectSources SUSE Manager 24
string sessionKey
Return Value
array:
struct - Content Project information
int "id"
string "label"
string "name"
string "description"
int "orgId"
string "rstEnvironment label"
13.17 lookupEnvironment
Description
Look up Content Environment based on Content Project and Content Environment label
Parameters
string sessionKey
string projectLabel - Content Project label
string envLabel - Content Environment label
Return Value
struct - Content Environment information
int "id"
string "label"
string "name"
string "description"
int "version"
string "status"
string "contentProjectLabel"
139 lookupEnvironment SUSE Manager 24
string "previousEnvironmentLabel"string "nextEnvironmentLabel"
13.18 lookupFilter
Description
Lookup a Content Filter by id
Parameters
string sessionKeyint id - Filter id
Return Value
struct - Content Filter information
int "id"string "name"int "orgId"entityType "Entity type (e.g. 'package')"rule "Rule (e.g. 'deny')"struct - criteria
string "matcher" - The matcher type of the lter (e.g. 'contains')string "eld" - The entity eld to match (e.g. 'name'string "value" - The eld value to match (e.g. 'kernel')
13.19 lookupProject
Description
Look up Content Project with given label
Parameters
string sessionKeystring label - Content Project label
140 lookupFilter SUSE Manager 24
Return Value
struct - Content Project information
int "id"
string "label"
string "name"
string "description"
int "orgId"
string "rstEnvironment label"
13.20 lookupSource
Description
Look up Content Project Source
Parameters
string sessionKey
string projectLabel - Content Project label
string sourceType - Project Source type, e.g. 'software'
string sourceLabel - Project Source label
Return Value
struct - Content Project Source information
string "contentProjectLabel"
string "type"
string "state"
string "channelLabel" - (If type is SW_CHANNEL) The label of channel associatedwith the source
13.21 promoteProject
Description
141 lookupSource SUSE Manager 24
Promote an Environment in a Project
Parameters
string sessionKeystring projectLabel - Project labelstring envLabel - Environment label
Return Value
int - 1 on success, exception thrown otherwise.
13.22 removeEnvironment
Description
Remove a Content Environment
Parameters
string sessionKeystring projectLabel - Content Project labelstring envLabel - Content Environment label
Return Value
int - 1 on success, exception thrown otherwise.
13.23 removeFilter
Description
Remove a Content Filter
Parameters
string sessionKeyint id - Filter id
Return Value
142 removeEnvironment SUSE Manager 24
int - 1 on success, exception thrown otherwise.
13.24 removeProject
Description
Remove Content Project
Parameters
string sessionKey
string label - Content Project label
Return Value
int - 1 on success, exception thrown otherwise.
13.25 updateEnvironment
Description
Update Content Environment with given label
Parameters
string sessionKey
string projectLabel - Content Project label
string envLabel - Content Environment label
struct - data
string "name" - Content Environment name
string "description" - Content Environment description
Return Value
struct - Content Environment information
int "id"
string "label"
143 removeProject SUSE Manager 24
string "name"
string "description"
int "version"
string "status"
string "contentProjectLabel"
string "previousEnvironmentLabel"
string "nextEnvironmentLabel"
13.26 updateFilter
Description
Update a Content FilterSee also: createFilter(), listFilterCriteria()
Parameters
string sessionKey
int lterId - Filter id
string name - New lter name
string rule - New lter rule ('deny' or 'allow')
struct - criteria
string "matcher" - The matcher type of the lter (e.g. 'contains')
string "eld" - The entity eld to match (e.g. 'name'
string "value" - The eld value to match (e.g. 'kernel')
Return Value
struct - Content Filter information
int "id"
string "name"
int "orgId"
entityType "Entity type (e.g. 'package')"
rule "Rule (e.g. 'deny')"
struct - criteria
144 updateFilter SUSE Manager 24
string "matcher" - The matcher type of the lter (e.g. 'contains')string "eld" - The entity eld to match (e.g. 'name'string "value" - The eld value to match (e.g. 'kernel')
13.27 updateProject
Description
Update Content Project with given label
Parameters
string sessionKeystring label - Content Project labelstruct - data
string "name" - Content Project namestring "description" - Content Project description
Return Value
struct - Content Project information
int "id"string "label"string "name"string "description"int "orgId"string "rstEnvironment label"
145 updateProject SUSE Manager 24
14 distchannel
Provides methods to access and modify distribution channel information
14.1 listDefaultMapsDescription
Lists the default distribution channel maps
Parameters
string sessionKey
Return Value
array:
struct - distChannelMap
string "os" - Operationg Systemstring "release" - OS Relasestring "arch_name" - Channel architecturestring "channel_label" - Channel labelstring "org_specic" - 'Y' organization specic, 'N' default
14.2 listMapsForOrgDescription
Lists distribution channel maps valid for the user's organization
Parameters
string sessionKey
Return Value
array:
struct - distChannelMap
146 listDefaultMaps SUSE Manager 24
string "os" - Operationg System
string "release" - OS Relase
string "arch_name" - Channel architecture
string "channel_label" - Channel label
string "org_specic" - 'Y' organization specic, 'N' default
14.3 listMapsForOrg
Description
Lists distribution channel maps valid for an organization, SUSE Manager admin rightsneeded.
Parameters
string sessionKey
int orgId
Return Value
array:
struct - distChannelMap
string "os" - Operationg System
string "release" - OS Relase
string "arch_name" - Channel architecture
string "channel_label" - Channel label
string "org_specic" - 'Y' organization specic, 'N' default
14.4 setMapForOrg
Description
Sets, overrides (/removes if channelLabel empty) a distribution channel map within anorganization
Parameters
147 listMapsForOrg SUSE Manager 24
string sessionKeystring osstring releasestring archNamestring channelLabel
Return Value
int - 1 on success, exception thrown otherwise.
148 setMapForOrg SUSE Manager 24
15 errata
Provides methods to access and modify errata.
15.1 addPackagesDescription
Add a set of packages to an erratum with the given advisory name. This method will onlyallow for modication of custom errata created either through the UI or API.
Parameters
string sessionKeystring advisoryNamearray:
int - packageId
Return Value
int count - representing the number of packages added, exception otherwise
15.2 applicableToChannelsDescription
Returns a list of channels applicable to the errata with the given advisory name. For thoseerrata that are present in both vendor and user organizations under the same advisoryname, this method retrieves the list of channels applicable of both of them.
Parameters
string sessionKeystring advisoryName
Return Value
array:
struct - channel
149 addPackages SUSE Manager 24
int "channel_id"
string "label"
string "name"
string "parent_channel_label"
15.3 bugzillaFixes
Description
Get the Bugzilla xes for an erratum matching the given advisoryName. The bugs will bereturned in a struct where the bug id is the key. i.e. 208144="errata.bugzillaFixes MethodReturns dierent results than docs say" For those errata that are present in both vendorand user organizations under the same advisory name, this method retrieves the list ofBugzilla xes of both of them.
Parameters
string sessionKey
string advisoryName
Return Value
struct - Bugzilla info
string "bugzilla_id" - actual bug number is the key into the struct
string "bug_summary" - summary who's key is the bug id
15.4 clone
Description
Clone a list of errata into the specied channel.
Parameters
150 bugzillaFixes SUSE Manager 24
string sessionKeystring channel_labelarray:
string - advisory - The advisory name of the errata to clone.
Return Value
array:
struct - errata
int "id" - Errata Idstring "date" - Date erratum was created.string "advisory_type" - Type of the advisory.string "advisory_status" - Status of the advisory.string "advisory_name" - Name of the advisory.string "advisory_synopsis" - Summary of the erratum.
15.5 cloneAsOriginalDescription
Clones a list of errata into a specied cloned channel according the original erratas.
Parameters
string sessionKeystring channel_labelarray:
string - advisory - The advisory name of the errata to clone.
Return Value
array:
struct - errata
int "id" - Errata Idstring "date" - Date erratum was created.
151 cloneAsOriginal SUSE Manager 24
string "advisory_type" - Type of the advisory.
string "advisory_status" - Status of the advisory.
string "advisory_name" - Name of the advisory.
string "advisory_synopsis" - Summary of the erratum.
15.6 cloneAsOriginalAsync
Description
Asynchronously clones a list of errata into a specied cloned channel according the originalerratas
Parameters
string sessionKey
string channel_label
array:
string - advisory - The advisory name of the errata to clone.
Return Value
int - 1 on success, exception thrown otherwise.
15.7 cloneAsync
Description
Asynchronously clone a list of errata into the specied channel.
Parameters
string sessionKey
string channel_label
array:
string - advisory - The advisory name of the errata to clone.
Return Value
152 cloneAsOriginalAsync SUSE Manager 24
int - 1 on success, exception thrown otherwise.
15.8 create
Description
Create a custom errata
Parameters
string sessionKey
struct - errata info
string "synopsis"
string "advisory_name"
int "advisory_release"
string "advisory_type" - Type of advisory (one of the following: 'SecurityAdvisory', 'Product Enhancement Advisory', or 'Bug Fix Advisory'
string "advisory_status" - Status of advisory (one of the following: 'nal', 'testing','stable' or 'retracted'
string "product"
string "errataFrom"
string "topic"
string "description"
string "references"
string "notes"
string "solution"
string "severity" - Severity of advisory (one of the following: 'Low', 'Moderate','Important', 'Critical' or 'Unspecied'
array:
struct - bug
153 create SUSE Manager 24
int "id" - Bug Id
string "summary"
string "url"
array:
string - keyword - List of keywords to associate with the errata.
array:
int - packageId
array:
string - channelLabel - list of channels the errata should be published to
Return Value
struct - errata
int "id" - Errata Id
string "date" - Date erratum was created.
string "advisory_type" - Type of the advisory.
string "advisory_status" - Status of the advisory.
string "advisory_name" - Name of the advisory.
string "advisory_synopsis" - Summary of the erratum.
15.9 delete
Description
Delete an erratum. This method will only allow for deletion of custom errata created eitherthrough the UI or API.
Parameters
string sessionKey
string advisoryName
Return Value
154 delete SUSE Manager 24
int - 1 on success, exception thrown otherwise.
15.10 findByCve
Description
Lookup the details for errata associated with the given CVE (e.g. CVE-2008-3270)
Parameters
string sessionKeystring cveName
Return Value
array:
struct - errata
int "id" - Errata Idstring "date" - Date erratum was created.string "advisory_type" - Type of the advisory.string "advisory_status" - Status of the advisory.string "advisory_name" - Name of the advisory.string "advisory_synopsis" - Summary of the erratum.
15.11 getDetails
Description
Retrieves the details for the erratum matching the given advisory name.
Parameters
string sessionKeystring advisoryName
Return Value
struct - erratum
155 findByCve SUSE Manager 24
int "id"string "issue_date"string "update_date"string "last_modied_date" - last time the erratum was modied.string "synopsis"int "release"string "advisory_status"string "type"string "product"string "errataFrom"string "topic"string "description"string "references"string "notes"string "solution"
15.12 listAffectedSystems
Description
Return the list of systems aected by the errata with the given advisory name. For thoseerrata that are present in both vendor and user organizations under the same advisoryname, this method retrieves the aected systems by both of them.
Parameters
string sessionKeystring advisoryName
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked in
156 listAffectedSystems SUSE Manager 24
dateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot timeint "extra_pkg_count" - Number of packages not belonging to any assignedchannelint "outdated_pkg_count" - Number of out-of-date packages
15.13 listByDateDescription
List errata that have been applied to a particular channel by date.Deprecated - being replaced by channel.software.listErrata(User LoggedInUser, stringchannelLabel)
Parameters
string sessionKeystring channelLabel
Return Value
array:
struct - errata
int "id" - Errata Idstring "date" - Date erratum was created.string "advisory_type" - Type of the advisory.string "advisory_status" - Status of the advisory.string "advisory_name" - Name of the advisory.string "advisory_synopsis" - Summary of the erratum.
15.14 listCvesDescription
Returns a list of CVEs applicable to the errata with the given advisory name. For thoseerrata that are present in both vendor and user organizations under the same advisoryname, this method retrieves the list of CVEs of both of them.
157 listByDate SUSE Manager 24
Parameters
string sessionKey
string advisoryName
Return Value
array:
string - cveName
15.15 listKeywords
Description
Get the keywords associated with an erratum matching the given advisory name. For thoseerrata that are present in both vendor and user organizations under the same advisoryname, this method retrieves the keywords of both of them.
Parameters
string sessionKey
string advisoryName
Return Value
array:
string - Keyword associated with erratum.
15.16 listPackages
Description
Returns a list of the packages aected by the errata with the given advisory name. For thoseerrata that are present in both vendor and user organizations under the same advisoryname, this method retrieves the packages of both of them.
Parameters
158 listKeywords SUSE Manager 24
string sessionKeystring advisoryName
Return Value
array:
struct - package
int "id"string "name"string "epoch"string "version"string "release"string "arch_label"array "providing_channels"
string - - Channel label providing this package.string "build_host"string "description"string "checksum"string "checksum_type"string "vendor"string "summary"string "cookie"string "license"string "path"string "le"string "build_date"string "last_modied_date"string "size"string "payload_size"
15.17 publish
Description
Publish an existing errata to a set of channels.
159 publish SUSE Manager 24
Parameters
string sessionKeystring advisoryNamearray:
string - channelLabel - list of channel labels to publish to
Return Value
struct - errata
int "id" - Errata Idstring "date" - Date erratum was created.string "advisory_type" - Type of the advisory.string "advisory_status" - Status of the advisory.string "advisory_name" - Name of the advisory.string "advisory_synopsis" - Summary of the erratum.
15.18 publishAsOriginal
Description
Publishes an existing cloned errata to a set of cloned channels according to its originalerratum
Parameters
string sessionKeystring advisoryNamearray:
string - channelLabel - list of channel labels to publish to
Return Value
struct - errata
int "id" - Errata Idstring "date" - Date erratum was created.
160 publishAsOriginal SUSE Manager 24
string "advisory_type" - Type of the advisory.string "advisory_status" - Status of the advisory.string "advisory_name" - Name of the advisory.string "advisory_synopsis" - Summary of the erratum.
15.19 removePackagesDescription
Remove a set of packages from an erratum with the given advisory name. This methodwill only allow for modication of custom errata created either through the UI or API.
Parameters
string sessionKeystring advisoryNamearray:
int - packageId
Return Value
int count - representing the number of packages removed, exception otherwise
15.20 setDetailsDescription
Set erratum details. All arguments are optional and will only be modied if included inthe struct. This method will only allow for modication of custom errata created eitherthrough the UI or API.
Parameters
string sessionKeystring advisoryNamestruct - errata details
string "synopsis"string "advisory_name"
161 removePackages SUSE Manager 24
int "advisory_release"string "advisory_type" - Type of advisory (one of the following: 'SecurityAdvisory', 'Product Enhancement Advisory', or 'Bug Fix Advisory'string "product"dateTime.iso8601 "issue_date"dateTime.iso8601 "update_date"string "errataFrom"string "topic"string "description"string "references"string "notes"string "solution"string "severity" - Severity of advisory (one of the following: 'Low', 'Moderate','Important', 'Critical' or 'Unspecied'array "bugs" - 'bugs' is the key into the structarray:
struct - bug
int "id" - Bug Idstring "summary"string "url"
array "keywords" - 'keywords' is the key into the structarray:
string - keyword - List of keywords to associate with the errata.array "CVEs" - 'cves' is the key into the structarray:
string - cves - List of CVEs to associate with the errata
Return Value
int - 1 on success, exception thrown otherwise.
162 setDetails SUSE Manager 24
16 formula
Provides methods to access and modify formulas.
16.1 getCombinedFormulaDataByServerIdsDescription
Return the list of formulas a server and all his groups have.
Parameters
string sessionKeystring formulaNamearray:
int - systemID
Return Value
array:
struct - formula_data
int "system_id"string "minion_id"struct with saved formula values "formula_values"
16.2 getCombinedFormulasByServerIdDescription
Return the list of formulas a server and all his groups have.
Parameters
string sessionKeyint systemId
Return Value
163 getCombinedFormulaDataByServerIds SUSE Manager 24
array:
string - (formulas)
16.3 getFormulasByGroupIdDescription
Return the list of formulas a server group has.
Parameters
string sessionKeyint systemGroupId
Return Value
array:
string - (formulas)
16.4 getFormulasByServerIdDescription
Return the list of formulas directly applied to a server.
Parameters
string sessionKeyint systemId
Return Value
array:
string - (formulas)
16.5 getGroupFormulaDataDescription
164 getFormulasByGroupId SUSE Manager 24
Get the saved data for the specic formula against specic group
Parameters
string sessionKey
int groupId
string formulaName
Return Value
struct with saved formula data
16.6 getSystemFormulaData
Description
Get the saved data for the specic formula against specic server
Parameters
string sessionKey
int systemId
string formulaName
Return Value
struct with saved formula data
16.7 listFormulas
Description
Return the list of formulas currently installed.
Parameters
string sessionKey
Return Value
165 getSystemFormulaData SUSE Manager 24
array:
string - (formulas)
16.8 setFormulasOfGroup
Description
Set the formulas of a server group.
Parameters
string sessionKey
int systemGroupId
array:
string - formulaName
Return Value
int - 1 on success, exception thrown otherwise.
16.9 setFormulasOfServer
Description
Set the formulas of a server.
Parameters
string sessionKey
int systemId
array:
string - formulaName
Return Value
166 setFormulasOfGroup SUSE Manager 24
int - 1 on success, exception thrown otherwise.
16.10 setGroupFormulaData
Description
Set the formula form for the specied group.
Parameters
string sessionKeyint groupIdstring formulaNamestruct containing the values for each eld in the form
Return Value
int - 1 on success, exception thrown otherwise.
16.11 setSystemFormulaData
Description
Set the formula form for the specied server.
Parameters
string sessionKeyint systemIdstring formulaNamestruct content with the values for each eld in the form
Return Value
int - 1 on success, exception thrown otherwise.
167 setGroupFormulaData SUSE Manager 24
17 image
Provides methods to access and modify images.
17.1 deleteDescription
Delete an Image
Parameters
string sessionKeyint imageId
Return Value
int - 1 on success, exception thrown otherwise.
17.2 getCustomValuesDescription
Get the custom data values dened for the Image.
Parameters
string sessionKeyint imageId
Return Value
struct - Map of custom labels to custom values
string "custom info label"string "value"
17.3 getDetailsDescription
168 delete SUSE Manager 24
Get details of an Image
Parameters
string sessionKey
int imageId
Return Value
struct - Image Overview information
int "id"
string "name" - image name
string "version" - image tag/version
int "revision" - image build revision number
string "arch" - image architecture
boolean "external" - true if the image is built externally, false otherwise
string "checksum"
string "proleLabel"
string "buildStatus" - One of:
queued
picked up
completed
failed
string "inspectStatus" - Available if the build is successful. One of:
queued
picked up
completed
failed
int "buildServerId"
int "securityErrata"
int "bugErrata"
int "enhancementErrata"
169 getDetails SUSE Manager 24
int "outdatedPackages"int "installedPackages"
17.4 getRelevantErrata
Description
Returns a list of all errata that are relevant for the image
Parameters
string sessionKeyint imageId
Return Value
array:
struct - errata
int "id" - Errata ID.string "issue_date" - Date erratum was updated. (Deprecated)string "date" - Date erratum was created. (Deprecated)string "update_date" - Date erratum was updated. (Deprecated)string "advisory_synopsis" - Summary of the erratum.string "advisory_type" - Type label such as Security, Bug Fixstring "advisory_status" - Status label such as nal, testing, retractedstring "advisory_name" - Name such as RHSA, etc
17.5 importImage
Description
Import an image and schedule an inspect afterwards
Parameters
string sessionKeystring name - image name as specied in the store
170 getRelevantErrata SUSE Manager 24
string version - version to import or emptyint buildHostId - system ID of the build hoststring storeLabelstring activationKey - activation key to get the channel data fromdateTime.iso8601 earliestOccurrence - earliest the following inspect can run
Return Value
int id - ID of the inspect action created
17.6 listImages
Description
List available Images
Parameters
string sessionKey
Return Value
array:
struct - Image information
int "id"string "name" - image namestring "version" - image tag/versionint "revision" - image build revision numberstring "arch" - image architectureboolean "external" - true if the image is built externally, false otherwisestring "storeLabel"string "checksum"
17.7 listPackages
Description
171 listImages SUSE Manager 24
List the installed packages on the given image.
Parameters
string sessionKeyint imageId
Return Value
array:
struct - package
string "name"string "version"string "release"string "epoch"string "arch"
17.8 scheduleImageBuild
Description
Schedule an image build
Parameters
string sessionKeystring proleLabelstring version - version to build or emptyint buildHostId - system id of the build hostdateTime.iso8601 earliestOccurrence - earliest the build can run.
Return Value
int id - ID of the build action created
172 scheduleImageBuild SUSE Manager 24
18 image.profile
Provides methods to access and modify image proles.
18.1 create
Description
Create a new Image Prole
Parameters
string sessionKey
string label
string type
string storeLabel
string path
string activationKey - Optional
Return Value
int - 1 on success, exception thrown otherwise.
18.2 delete
Description
Delete an Image Prole
Parameters
string sessionKey
string label
Return Value
173 create SUSE Manager 24
int - 1 on success, exception thrown otherwise.
18.3 deleteCustomValues
Description
Delete the custom values dened for the specied Image Prole. (Note: Attempt to deletevalues of non-existing keys throws exception. Attempt to delete value of existing key whichhas assigned no values doesn't throw exception.)
Parameters
string sessionKey
string label
array:
string - customDataKeys
Return Value
int - 1 on success, exception thrown otherwise.
18.4 getCustomValues
Description
Get the custom data values dened for the Image Prole.
Parameters
string sessionKey
string label
Return Value
struct - Map of custom labels to custom values
174 deleteCustomValues SUSE Manager 24
string "custom info label"
string "value"
18.5 getDetails
Description
Get details of an Image Prole
Parameters
string sessionKey
string label
Return Value
struct - Image Prole information
string "label"
string "imageType"
string "imageStore"
string "activationKey"
string "path" - in case type support path
18.6 listImageProfileTypes
Description
List available Image Store Types
Parameters
string sessionKey
Return Value
175 getDetails SUSE Manager 24
array:
string - imageProleTypes
18.7 listImageProfiles
Description
List available Image Proles
Parameters
string sessionKey
Return Value
array:
struct - Image Prole information
string "label"string "imageType"string "imageStore"string "activationKey"string "path" - in case type support path
18.8 setCustomValues
Description
Set custom values for the specied Image Prole.
Parameters
string sessionKeystring labelstruct - Map of custom labels to custom values
string "custom info label"string "value"
176 listImageProfiles SUSE Manager 24
Return Value
int - 1 on success, exception thrown otherwise.
18.9 setDetails
Description
Set details of an Image Prole
Parameters
string sessionKeystring labelstruct - image prole details
string "storeLabel"string "path"string "activationKey" - set empty string to unset
Return Value
int - 1 on success, exception thrown otherwise.
177 setDetails SUSE Manager 24
19 image.store
Provides methods to access and modify image stores.
19.1 create
Description
Create a new Image Store
Parameters
string sessionKey
string label
string uri
string storeType
struct - credentials optional
string "username"
string "password"
Return Value
int - 1 on success, exception thrown otherwise.
19.2 delete
Description
Delete an Image Store
Parameters
string sessionKey
string label
Return Value
178 create SUSE Manager 24
int - 1 on success, exception thrown otherwise.
19.3 getDetails
Description
Get details of an Image Store
Parameters
string sessionKey
string label
Return Value
struct - Image Store information
string "label"
string "uri"
string "storetype"
boolean "hasCredentials"
string "username"
19.4 listImageStoreTypes
Description
List available Image Store Types
Parameters
string sessionKey
Return Value
array:
struct - Image Store Type information
179 getDetails SUSE Manager 24
int "id"
string "label"
string "name"
19.5 listImageStores
Description
List available Image Stores
Parameters
string sessionKey
Return Value
array:
struct - Image Store information
string "label"
string "uri"
string "storetype"
boolean "hasCredentials"
string "username"
19.6 setDetails
Description
Set details of an Image Store
Parameters
string sessionKey
string label
struct - image store details
180 listImageStores SUSE Manager 24
string "uri"string "username" - pass empty string to unset credentialsstring "password"
Return Value
int - 1 on success, exception thrown otherwise.
181 setDetails SUSE Manager 24
20 kickstart
Provides methods to create kickstart les
20.1 cloneProfileDescription
Clone a Kickstart Prole
Parameters
string sessionKeystring ksLabelToClone - Label of the kickstart prole to clonestring newKsLabel - label of the cloned prole
Return Value
int - 1 on success, exception thrown otherwise.
20.2 createProfileDescription
Create a kickstart prole.
Parameters
string sessionKeystring proleLabel - Label for the new kickstart prole.string virtualizationType - none, para_host, qemu, xenfv or xenpv.string kickstartableTreeLabel - Label of a kickstartable tree to associate the newprole with.string kickstartHost - Kickstart hostname (of a SUSE Manager server or proxy) usedto construct the default download URL for the new kickstart prole.string rootPassword - Root password.string updateType - Should the prole update itself to use the newest tree available?Possible values are: none (default) or all (includes custom Kickstart Trees).
Return Value
182 cloneProfile SUSE Manager 24
int - 1 on success, exception thrown otherwise.
20.3 createProfileDescription
Create a kickstart prole.
Parameters
string sessionKeystring proleLabel - Label for the new kickstart prole.string virtualizationType - none, para_host, qemu, xenfv or xenpv.string kickstartableTreeLabel - Label of a kickstartable tree to associate the newprole with.string kickstartHost - Kickstart hostname (of a SUSE Manager server or proxy) usedto construct the default download URL for the new kickstart prole.string rootPassword - Root password.
Return Value
int - 1 on success, exception thrown otherwise.
20.4 createProfileWithCustomUrlDescription
Create a kickstart prole.
Parameters
string sessionKeystring proleLabel - Label for the new kickstart prole.string virtualizationType - none, para_host, qemu, xenfv or xenpv.string kickstartableTreeLabel - Label of a kickstartable tree to associate the newprole with.boolean downloadUrl - Download URL, or 'default' to use the kickstart tree's defaultURL.string rootPassword - Root password.
183 createProfile SUSE Manager 24
Return Value
int - 1 on success, exception thrown otherwise.
20.5 createProfileWithCustomUrl
Description
Create a kickstart prole.
Parameters
string sessionKeystring proleLabel - Label for the new kickstart prole.string virtualizationType - none, para_host, qemu, xenfv or xenpv.string kickstartableTreeLabel - Label of a kickstartable tree to associate the newprole with.boolean downloadUrl - Download URL, or 'default' to use the kickstart tree's defaultURL.string rootPassword - Root password.string updateType - Should the prole update itself to use the newest tree available?Possible values are: none (default) or all (includes custom Kickstart Trees).
Return Value
int - 1 on success, exception thrown otherwise.
20.6 deleteProfile
Description
Delete a kickstart prole
Parameters
string sessionKeystring ksLabel - The label of the kickstart prole you want to remove
Return Value
184 createProfileWithCustomUrl SUSE Manager 24
int - 1 on success, exception thrown otherwise.
20.7 disableProfile
Description
Enable/Disable a Kickstart Prole
Parameters
string sessionKeystring proleLabel - Label for the kickstart tree you want to en/disablestring disabled - true to disable the prole
Return Value
int - 1 on success, exception thrown otherwise.
20.8 findKickstartForIp
Description
Find an associated kickstart for a given ip address.
Parameters
string sessionKeystring ipAddress - The ip address to search for (i.e. 192.168.0.1)
Return Value
string label - label of the kickstart. Empty string if not found
20.9 importFile
Description
Import a kickstart prole.
Parameters
185 disableProfile SUSE Manager 24
string sessionKeystring proleLabel - Label for the new kickstart prole.string virtualizationType - none, para_host, qemu, xenfv or xenpv.string kickstartableTreeLabel - Label of a kickstartable tree to associate the newprole with.string kickstartFileContents - Contents of the kickstart le to import.
Return Value
int - 1 on success, exception thrown otherwise.
20.10 importFile
Description
Import a kickstart prole.
Parameters
string sessionKeystring proleLabel - Label for the new kickstart prole.string virtualizationType - none, para_host, qemu, xenfv or xenpv.string kickstartableTreeLabel - Label of a kickstartable tree to associate the newprole with.string kickstartHost - Kickstart hostname (of a SUSE Manager server or proxy) usedto construct the default download URL for the new kickstart prole. Using this optionsignies that this default URL will be used instead of any url/nfs/cdrom/harddrivecommands in the kickstart le itself.string kickstartFileContents - Contents of the kickstart le to import.
Return Value
int - 1 on success, exception thrown otherwise.
20.11 importFile
Description
186 importFile SUSE Manager 24
Import a kickstart prole.
Parameters
string sessionKey
string proleLabel - Label for the new kickstart prole.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
string kickstartableTreeLabel - Label of a kickstartable tree to associate the newprole with.
string kickstartHost - Kickstart hostname (of a SUSE Manager server or proxy) usedto construct the default download URL for the new kickstart prole. Using this optionsignies that this default URL will be used instead of any url/nfs/cdrom/harddrivecommands in the kickstart le itself.
string kickstartFileContents - Contents of the kickstart le to import.
string updateType - Should the prole update itself to use the newest tree available?Possible values are: none (default) or all (includes custom Kickstart Trees).
Return Value
int - 1 on success, exception thrown otherwise.
20.12 importRawFile
Description
Import a raw kickstart le into SUSE Manager.
Parameters
string sessionKey
string proleLabel - Label for the new kickstart prole.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
string kickstartableTreeLabel - Label of a kickstartable tree to associate the newprole with.
string kickstartFileContents - Contents of the kickstart le to import.
Return Value
187 importRawFile SUSE Manager 24
int - 1 on success, exception thrown otherwise.
20.13 importRawFile
Description
Import a raw kickstart le into SUSE Manager.
Parameters
string sessionKey
string proleLabel - Label for the new kickstart prole.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
string kickstartableTreeLabel - Label of a kickstartable tree to associate the newprole with.
string kickstartFileContents - Contents of the kickstart le to import.
string updateType - Should the prole update itself to use the newest tree available?Possible values are: none (default) or all (includes custom Kickstart Trees).
Return Value
int - 1 on success, exception thrown otherwise.
20.14 isProfileDisabled
Description
Returns whether a kickstart prole is disabled
Parameters
string sessionKey
string proleLabel - kickstart prole label
Return Value
188 importRawFile SUSE Manager 24
boolean disabled - true if prole is disabled
20.15 listAllIpRanges
Description
List all Ip Ranges and their associated kickstarts available in the user's org.
Parameters
string sessionKey
Return Value
array:
struct - Kickstart Ip Range
string "ksLabel" - The kickstart label associated with the ip range
string "max" - The max ip of the range
string "min" - The min ip of the range
20.16 listAutoinstallableChannels
Description
List autoinstallable channels for the logged in user.
Parameters
string sessionKey
Return Value
array:
struct - channel
int "id"
string "name"
189 listAllIpRanges SUSE Manager 24
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:
struct - contentSources
int "id"
string "label"
string "sourceUrl"
string "type"
20.17 listKickstartableChannels
Description
List kickstartable channels for the logged in user.
Parameters
string sessionKey
Return Value
190 listKickstartableChannels SUSE Manager 24
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 "end_of_life"string "parent_channel_label"string "clone_original"array:
struct - contentSources
int "id"string "label"string "sourceUrl"string "type"
20.18 listKickstartableTreesDescription
List the available kickstartable trees for the given channel.
191 listKickstartableTrees SUSE Manager 24
Deprecated - being replaced by kickstart.tree.list(string sessionKey, string channelLabel)
Parameters
string sessionKey
string channelLabel - Label of channel to search.
Return Value
array:
struct - kickstartable tree
int "id"
string "label"
string "base_path"
int "channel_id"
20.19 listKickstarts
Description
Provides a list of kickstart proles visible to the user's org
Parameters
string sessionKey
Return Value
array:
struct - kickstart
string "label"
string "tree_label"
string "name"
boolean "advanced_mode"
boolean "org_default"
192 listKickstarts SUSE Manager 24
boolean "active"string "update_type"
20.20 renameProfile
Description
Rename a kickstart prole in SUSE Manager.
Parameters
string sessionKeystring originalLabel - Label for the kickstart prole you want to renamestring newLabel - new label to change to
Return Value
int - 1 on success, exception thrown otherwise.
193 renameProfile SUSE Manager 24
21 kickstart.filepreservation
Provides methods to retrieve and manipulate kickstart le preservation lists.
21.1 createDescription
Create a new le preservation list.
Parameters
string session_keystring name - name of the le list to createarray:
string - name - le names to include
Return Value
int - 1 on success, exception thrown otherwise.
21.2 deleteDescription
Delete a le preservation list.
Parameters
string session_keystring name - name of the le list to delete
Return Value
int - 1 on success, exception thrown otherwise.
21.3 getDetailsDescription
194 create SUSE Manager 24
Returns all of the data associated with the given le preservation list.
Parameters
string session_keystring name - name of the le list to retrieve details for
Return Value
struct - le list
string "name"array "le_names"
string - name
21.4 listAllFilePreservations
Description
List all le preservation lists for the organization associated with the user logged into thegiven session
Parameters
string sessionKey
Return Value
array:
struct - le preservation
int "id"string "name"dateTime.iso8601 "created"dateTime.iso8601 "last_modied"
195 listAllFilePreservations SUSE Manager 24
22 kickstart.keys
Provides methods to manipulate kickstart keys.
22.1 createDescription
creates a new key with the given parameters
Parameters
string session_keystring descriptionstring type - valid values are GPG or SSLstring content
Return Value
int - 1 on success, exception thrown otherwise.
22.2 deleteDescription
deletes the key identied by the given parameters
Parameters
string session_keystring description
Return Value
int - 1 on success, exception thrown otherwise.
22.3 getDetailsDescription
196 create SUSE Manager 24
returns all of the data associated with the given key
Parameters
string session_keystring description
Return Value
struct - key
string "description"string "type"string "content"
22.4 listAllKeys
Description
list all keys for the org associated with the user logged into the given session
Parameters
string sessionKey
Return Value
array:
struct - key
string "description"string "type"
22.5 update
Description
Updates type and content of the key identied by the description
Parameters
197 listAllKeys SUSE Manager 24
string session_keystring descriptionstring type - valid values are GPG or SSLstring content
Return Value
int - 1 on success, exception thrown otherwise.
198 update SUSE Manager 24
23 kickstart.profile
Provides methods to access and modify many aspects of a kickstart prole.
23.1 addIpRangeDescription
Add an ip range to a kickstart prole.
Parameters
string sessionKeystring label - The label of the kickstartstring min - The ip address making up the minimum of the range (i.e. 192.168.0.1)string max - The ip address making up the maximum of the range (i.e. 192.168.0.254)
Return Value
int - 1 on success, exception thrown otherwise.
23.2 addScriptDescription
Add a pre/post script to a kickstart prole.
Parameters
string sessionKeystring ksLabel - The kickstart label to add the script to.string name - The kickstart script name.string contents - The full script to add.string interpreter - The path to the interpreter to use (i.e. /bin/bash). An empty stringwill use the kickstart default interpreter.string type - The type of script (either 'pre' or 'post').boolean chroot - Whether to run the script in the chrooted install location(recommended) or not.
Return Value
199 addIpRange SUSE Manager 24
int id - the id of the added script
23.3 addScriptDescription
Add a pre/post script to a kickstart prole.
Parameters
string sessionKeystring ksLabel - The kickstart label to add the script to.string name - The kickstart script name.string contents - The full script to add.string interpreter - The path to the interpreter to use (i.e. /bin/bash). An empty stringwill use the kickstart default interpreter.string type - The type of script (either 'pre' or 'post').boolean chroot - Whether to run the script in the chrooted install location(recommended) or not.boolean template - Enable templating using cobbler.
Return Value
int id - the id of the added script
23.4 addScriptDescription
Add a pre/post script to a kickstart prole.
Parameters
string sessionKeystring ksLabel - The kickstart label to add the script to.string name - The kickstart script name.string contents - The full script to add.string interpreter - The path to the interpreter to use (i.e. /bin/bash). An empty stringwill use the kickstart default interpreter.
200 addScript SUSE Manager 24
string type - The type of script (either 'pre' or 'post').boolean chroot - Whether to run the script in the chrooted install location(recommended) or not.boolean template - Enable templating using cobbler.boolean erroronfail - Whether to throw an error if the script fails or not
Return Value
int id - the id of the added script
23.5 compareActivationKeysDescription
Returns a list for each kickstart prole; each list will contain activation keys not presenton the other prole.
Parameters
string sessionKeystring kickstartLabel1string kickstartLabel2
Return Value
struct - Comparison Info
array "kickstartLabel1" - Actual label of the rst kickstart prole is the key intothe structarray:
struct - activation key
string "key"string "description"int "usage_limit"string "base_channel_label"array "child_channel_labels"
string - childChannelLabelarray "entitlements"
201 compareActivationKeys 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
array "kickstartLabel2" - Actual label of the second kickstart prole is the keyinto the struct
array:
struct - activation key
string "key"
string "description"
int "usage_limit"
string "base_channel_label"
array "child_channel_labels"
string - childChannelLabel
array "entitlements"
string - entitlementLabel
array "server_group_ids"
string - serverGroupId
array "package_names"
202 compareActivationKeys SUSE Manager 24
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
23.6 compareAdvancedOptions
Description
Returns a list for each kickstart prole; each list will contain the properties that dierbetween the proles and their values for that specic prole .
Parameters
string sessionKey
string kickstartLabel1
string kickstartLabel2
Return Value
struct - Comparison Info
array "kickstartLabel1" - Actual label of the rst kickstart prole is the key intothe struct
array:
struct - value
203 compareAdvancedOptions SUSE Manager 24
string "name"
string "value"
boolean "enabled"
array "kickstartLabel2" - Actual label of the second kickstart prole is the keyinto the struct
array:
struct - value
string "name"
string "value"
boolean "enabled"
23.7 comparePackages
Description
Returns a list for each kickstart prole; each list will contain package names not presenton the other prole.
Parameters
string sessionKey
string kickstartLabel1
string kickstartLabel2
Return Value
struct - Comparison Info
204 comparePackages SUSE Manager 24
array "kickstartLabel1" - Actual label of the rst kickstart prole is the key intothe structarray:
string - package namearray "kickstartLabel2" - Actual label of the second kickstart prole is the keyinto the structarray:
string - package name
23.8 downloadKickstartDescription
Download the full contents of a kickstart le.
Parameters
string sessionKeystring ksLabel - The label of the kickstart to download.string host - The host to use when referring to the SUSE Manager server. Usually thisshould be the FQDN, but could be the ip address or shortname as well.
Return Value
string ks - The contents of the kickstart le. Note: if an activation key is not associatedwith the kickstart le, registration will not occur in the generated %post section. Ifone is associated, it will be used for registration
23.9 downloadRenderedKickstartDescription
Downloads the Cobbler-rendered Kickstart le.
Parameters
string sessionKeystring ksLabel - The label of the kickstart to download.
205 downloadKickstart SUSE Manager 24
Return Value
string ks - The contents of the kickstart le
23.10 getAdvancedOptions
Description
Get advanced options for a kickstart prole.
Parameters
string sessionKey
string ksLabel - Label of kickstart prole to be changed.
Return Value
array:
struct - option
string "name"
string "arguments"
23.11 getAvailableRepositories
Description
Lists available OS repositories to associate with the provided kickstart prole.
Parameters
string sessionKey
string ksLabel
Return Value
206 getAdvancedOptions SUSE Manager 24
array:
string - repositoryLabel
23.12 getCfgPreservationDescription
Get ks.cfg preservation option for a kickstart prole.
Parameters
string sessionKeystring kslabel - Label of kickstart prole to be changed.
Return Value
boolean preserve - The value of the option. True means that ks.cfg will be copied to /root, false means that it will not
23.13 getChildChannelsDescription
Get the child channels for a kickstart prole.
Parameters
string sessionKeystring kslabel - Label of kickstart prole.
Return Value
array:
string - channelLabel
23.14 getCustomOptionsDescription
207 getCfgPreservation SUSE Manager 24
Get custom options for a kickstart prole.
Parameters
string sessionKeystring ksLabel
Return Value
array:
struct - option
int "id"string "arguments"
23.15 getKickstartTreeDescription
Get the kickstart tree for a kickstart prole.
Parameters
string sessionKeystring kslabel - Label of kickstart prole to be changed.
Return Value
string kstreeLabel - Label of the kickstart tree.
23.16 getRepositoriesDescription
Lists all OS repositories associated with provided kickstart prole.
Parameters
string sessionKeystring ksLabel
Return Value
208 getKickstartTree SUSE Manager 24
array:
string - repositoryLabel
23.17 getUpdateTypeDescription
Get the update type for a kickstart prole.
Parameters
string sessionKeystring kslabel - Label of kickstart prole.
Return Value
string update_type - Update type for this Kickstart Prole.
23.18 getVariablesDescription
Returns a list of variables associated with the specied kickstart prole
Parameters
string sessionKeystring ksLabel
Return Value
struct - kickstart variable
string "key"string or int "value"
23.19 getVirtualizationTypeDescription
209 getUpdateType SUSE Manager 24
For given kickstart prole label returns label of virtualization type it's using
Parameters
string sessionKey
string ksLabel
Return Value
string virtLabel - Label of virtualization type.
23.20 listIpRanges
Description
List all ip ranges for a kickstart prole.
Parameters
string sessionKey
string label - The label of the kickstart
Return Value
array:
struct - Kickstart Ip Range
string "ksLabel" - The kickstart label associated with the ip range
string "max" - The max ip of the range
string "min" - The min ip of the range
23.21 listScripts
Description
List the pre and post scripts for a kickstart prole in the order they will run during thekickstart.
Parameters
210 listIpRanges SUSE Manager 24
string sessionKey
string ksLabel - The label of the kickstart
Return Value
array:
struct - kickstart script
int "id"
string "name"
string "contents"
string "script_type" - Which type of script ('pre' or 'post').
string "interpreter" - The scripting language interpreter to use for thisscript. An empty string indicates the default kickstart shell.
boolean "chroot" - True if the script will be executed within the chrootenvironment.
boolean "erroronfail" - True if the script will throw an error if it fails.
boolean "template" - True if templating using cobbler is enabled
boolean "beforeRegistration" - True if script will run before the serverregisters and performs server actions.
23.22 orderScripts
Description
Change the order that kickstart scripts will run for this kickstart prole. Scripts will run inthe order they appear in the array. There are three arrays, one for all pre scripts, one forthe post scripts that run before registration and server actions happen, and one for postscripts that run after registration and server actions. All scripts must be included in oneof these lists, as appropriate.
Parameters
string sessionKey
string ksLabel - The label of the kickstart
211 orderScripts SUSE Manager 24
array:
int - IDs of the ordered pre scripts
array:
int - IDs of the ordered post scripts that will run before registration
array:
int - IDs of the ordered post scripts that will run after registration
Return Value
int - 1 on success, exception thrown otherwise.
23.23 removeIpRange
Description
Remove an ip range from a kickstart prole.
Parameters
string sessionKey
string ksLabel - The kickstart label of the ip range you want to remove
string ip_address - An Ip Address that falls within the range that you are wanting toremove. The min or max of the range will work.
Return Value
int status - 1 on successful removal, 0 if range wasn't found for the specied kickstart,exception otherwise
23.24 removeScript
Description
Remove a script from a kickstart prole.
Parameters
212 removeIpRange SUSE Manager 24
string sessionKey
string ksLabel - The kickstart from which to remove the script from.
int scriptId - The id of the script to remove.
Return Value
int - 1 on success, exception thrown otherwise.
23.25 setAdvancedOptions
Description
Set advanced options for a kickstart prole. If 'md5_crypt_rootpw' is set to 'True', 'root_pw'is taken as plaintext and will md5 encrypted on server side, otherwise a hash encodedpassword (according to the auth option) is expected
Parameters
string sessionKey
string ksLabel
array:
struct - advanced options
string "name" - Name of the advanced option. Valid Option names:autostep, interactive, install, upgrade, text, network, cdrom, harddrive,nfs, url, lang, langsupport keyboard, mouse, device, deviceprobe,zerombr, clearpart, bootloader, timezone, auth, rootpw, selinux, reboot,rewall, xcong, skipx, key, ignoredisk, autopart, cmdline, rstboot,graphical, iscsi, iscsiname, logging, monitor, multipath, powero, halt,services, shutdown, user, vnc, zfcp, driverdisk, md5_crypt_rootpw
string "arguments" - Arguments of the option
Return Value
213 setAdvancedOptions SUSE Manager 24
int - 1 on success, exception thrown otherwise.
23.26 setCfgPreservationDescription
Set ks.cfg preservation option for a kickstart prole.
Parameters
string sessionKeystring kslabel - Label of kickstart prole to be changed.boolean preserve - whether or not ks.cfg and all %include fragments will be copiedto /root.
Return Value
int - 1 on success, exception thrown otherwise.
23.27 setChildChannelsDescription
Set the child channels for a kickstart prole.
Parameters
string sessionKeystring kslabel - Label of kickstart prole to be changed.string[] channelLabels - List of labels of child channels
Return Value
int - 1 on success, exception thrown otherwise.
23.28 setCustomOptionsDescription
Set custom options for a kickstart prole.
214 setCfgPreservation SUSE Manager 24
Parameters
string sessionKeystring ksLabelstring[] options
Return Value
int - 1 on success, exception thrown otherwise.
23.29 setKickstartTree
Description
Set the kickstart tree for a kickstart prole.
Parameters
string sessionKeystring kslabel - Label of kickstart prole to be changed.string kstreeLabel - Label of new kickstart tree.
Return Value
int - 1 on success, exception thrown otherwise.
23.30 setLogging
Description
Set logging options for a kickstart prole.
Parameters
string sessionKeystring kslabel - Label of kickstart prole to be changed.boolean pre - whether or not to log the pre section of a kickstart to /root/ks-pre.logboolean post - whether or not to log the post section of a kickstart to /root/ks-post.log
Return Value
215 setKickstartTree SUSE Manager 24
int - 1 on success, exception thrown otherwise.
23.31 setRepositoriesDescription
Associates OS repository to a kickstart prole.
Parameters
string sessionKeystring ksLabelarray:
string - repositoryLabel
Return Value
int - 1 on success, exception thrown otherwise.
23.32 setUpdateTypeDescription
Set the update typefor a kickstart prole.
Parameters
string sessionKeystring kslabel - Label of kickstart prole to be changed.string updateType - The new update type to set. Possible values are 'all' and 'none'.
Return Value
int - 1 on success, exception thrown otherwise.
23.33 setVariablesDescription
216 setRepositories SUSE Manager 24
Associates list of kickstart variables with the specied kickstart prole
Parameters
string sessionKeystring ksLabelstruct - kickstart variable
string "key"string or int "value"
Return Value
int - 1 on success, exception thrown otherwise.
23.34 setVirtualizationType
Description
For given kickstart prole label sets its virtualization type.
Parameters
string sessionKeystring ksLabelstring typeLabel - One of the following: 'none', 'qemu', 'para_host', 'xenpv', 'xenfv'
Return Value
int - 1 on success, exception thrown otherwise.
217 setVirtualizationType SUSE Manager 24
24 kickstart.profile.keys
Provides methods to access and modify the list of activation keys associated with akickstart prole.
24.1 addActivationKeyDescription
Add an activation key association to the kickstart prole
Parameters
string sessionKeystring ksLabel - the kickstart prole labelstring key - the activation key
Return Value
int - 1 on success, exception thrown otherwise.
24.2 getActivationKeysDescription
Lookup the activation keys associated with the kickstart prole.
Parameters
string sessionKeystring ksLabel - the kickstart prole label
Return Value
array:
struct - activation key
string "key"string "description"
218 addActivationKey SUSE Manager 24
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
24.3 removeActivationKeyDescription
Remove an activation key association from the kickstart prole
Parameters
string sessionKeystring ksLabel - the kickstart prole labelstring key - the activation key
Return Value
219 removeActivationKey SUSE Manager 24
int - 1 on success, exception thrown otherwise.
220 removeActivationKey SUSE Manager 24
25 kickstart.profile.software
Provides methods to access and modify the software list associated with a kickstartprole.
25.1 appendToSoftwareList
Description
Append the list of software packages to a kickstart prole. Duplicate packages will beignored.
Parameters
string sessionKey
string ksLabel - The label of a kickstart prole.
string[] packageList - A list of package names to be added to the prole.
Return Value
int - 1 on success, exception thrown otherwise.
25.2 getSoftwareDetails
Description
Gets kickstart prole software details.
Parameters
string sessionKey
string ksLabel - Label of the kickstart prole
Return Value
struct - Kickstart packages info
221 appendToSoftwareList SUSE Manager 24
string "noBase" - Install @Base package group
string "ignoreMissing" - Ignore missing packages
25.3 getSoftwareList
Description
Get a list of a kickstart prole's software packages.
Parameters
string sessionKey
string ksLabel - The label of a kickstart prole.
Return Value
array:
string - Get a list of a kickstart prole's software packages
25.4 setSoftwareDetails
Description
Sets kickstart prole software details.
Parameters
string sessionKey
string ksLabel - Label of the kickstart prole
struct - Kickstart packages info
string "noBase" - Install @Base package group
string "ignoreMissing" - Ignore missing packages
Return Value
222 getSoftwareList SUSE Manager 24
int - 1 on success, exception thrown otherwise.
25.5 setSoftwareList
Description
Set the list of software packages for a kickstart prole.
Parameters
string sessionKeystring ksLabel - The label of a kickstart prole.string[] packageList - A list of package names to be set on the prole.
Return Value
int - 1 on success, exception thrown otherwise.
25.6 setSoftwareList
Description
Set the list of software packages for a kickstart prole.
Parameters
string sessionKeystring ksLabel - The label of a kickstart prole.string[] packageList - A list of package names to be set on the prole.boolean ignoremissing - Ignore missing packages if trueboolean nobase - Don't install @Base package group if true
Return Value
int - 1 on success, exception thrown otherwise.
223 setSoftwareList SUSE Manager 24
26 kickstart.profile.system
Provides methods to set various properties of a kickstart prole.
26.1 addFilePreservations
Description
Adds the given list of le preservations to the specied kickstart prole.
Parameters
string sessionKey
string kickstartLabel
array:
string - lePreservations
Return Value
int - 1 on success, exception thrown otherwise.
26.2 addKeys
Description
Adds the given list of keys to the specied kickstart prole.
Parameters
string sessionKey
string kickstartLabel
array:
string - keyDescription
Return Value
224 addFilePreservations SUSE Manager 24
int - 1 on success, exception thrown otherwise.
26.3 checkConfigManagement
Description
Check the conguration management status for a kickstart prole.
Parameters
string sessionKeystring ksLabel - the kickstart prole label
Return Value
boolean enabled - true if conguration management is enabled; otherwise, false
26.4 checkRemoteCommands
Description
Check the remote commands status ag for a kickstart prole.
Parameters
string sessionKeystring ksLabel - the kickstart prole label
Return Value
boolean enabled - true if remote commands support is enabled; otherwise, false
26.5 disableConfigManagement
Description
Disables the conguration management ag in a kickstart prole so that a system createdusing this prole will be NOT be conguration capable.
Parameters
225 checkConfigManagement SUSE Manager 24
string sessionKey
string ksLabel - the kickstart prole label
Return Value
int - 1 on success, exception thrown otherwise.
26.6 disableRemoteCommands
Description
Disables the remote command ag in a kickstart prole so that a system created using thisprole will be capable of running remote commands
Parameters
string sessionKey
string ksLabel - the kickstart prole label
Return Value
int - 1 on success, exception thrown otherwise.
26.7 enableConfigManagement
Description
Enables the conguration management ag in a kickstart prole so that a system createdusing this prole will be conguration capable.
Parameters
string sessionKey
string ksLabel - the kickstart prole label
Return Value
226 disableRemoteCommands SUSE Manager 24
int - 1 on success, exception thrown otherwise.
26.8 enableRemoteCommands
Description
Enables the remote command ag in a kickstart prole so that a system created using thisprole will be capable of running remote commands
Parameters
string sessionKey
string ksLabel - the kickstart prole label
Return Value
int - 1 on success, exception thrown otherwise.
26.9 getLocale
Description
Retrieves the locale for a kickstart prole.
Parameters
string sessionKey
string ksLabel - the kickstart prole label
Return Value
struct - locale info
227 enableRemoteCommands SUSE Manager 24
string "locale"
boolean "useUtc"
true - the hardware clock uses UTC
false - the hardware clock does not use UTC
26.10 getPartitioningScheme
Description
Get the partitioning scheme for a kickstart prole.
Parameters
string sessionKey
string ksLabel - The label of a kickstart prole.
Return Value
array:
string - A list of partitioning commands used to setup the partitions, logicalvolumes and volume groups
26.11 getRegistrationType
Description
returns the registration type of a given kickstart prole. Registration Type can be one ofreactivation/deletion/none These types determine the behaviour of the registration whenusing this prole for reprovisioning.
Parameters
string sessionKey
string kickstartLabel
Return Value
228 getPartitioningScheme SUSE Manager 24
string registrationType
reactivation
deletion
none
26.12 getSELinux
Description
Retrieves the SELinux enforcing mode property of a kickstart prole.
Parameters
string sessionKey
string ksLabel - the kickstart prole label
Return Value
string enforcingMode
enforcing
permissive
disabled
26.13 listFilePreservations
Description
Returns the set of all le preservations associated with the given kickstart prole.
Parameters
string sessionKey
string kickstartLabel
Return Value
array:
struct - le list
229 getSELinux SUSE Manager 24
string "name"array "le_names"
string - name
26.14 listKeysDescription
Returns the set of all keys associated with the given kickstart prole.
Parameters
string sessionKeystring kickstartLabel
Return Value
array:
struct - key
string "description"string "type"string "content"
26.15 removeFilePreservationsDescription
Removes the given list of le preservations from the specied kickstart prole.
Parameters
string sessionKeystring kickstartLabelarray:
string - lePreservations
Return Value
230 listKeys SUSE Manager 24
int - 1 on success, exception thrown otherwise.
26.16 removeKeys
Description
Removes the given list of keys from the specied kickstart prole.
Parameters
string sessionKey
string kickstartLabel
array:
string - keyDescription
Return Value
int - 1 on success, exception thrown otherwise.
26.17 setLocale
Description
Sets the locale for a kickstart prole.
Parameters
string sessionKey
string ksLabel - the kickstart prole label
string locale - the locale
boolean useUtc
true - the hardware clock uses UTC
false - the hardware clock does not use UTC
Return Value
231 removeKeys SUSE Manager 24
int - 1 on success, exception thrown otherwise.
26.18 setPartitioningScheme
Description
Set the partitioning scheme for a kickstart prole.
Parameters
string sessionKey
string ksLabel - The label of the kickstart prole to update.
string[] scheme - The partitioning scheme is a list of partitioning command stringsused to setup the partitions, volume groups and logical volumes.
Return Value
int - 1 on success, exception thrown otherwise.
26.19 setRegistrationType
Description
Sets the registration type of a given kickstart prole. Registration Type can be one ofreactivation/deletion/none These types determine the behaviour of the re registrationwhen using this prole.
Parameters
string sessionKey
string kickstartLabel
string registrationType
reactivation - to try and generate a reactivation key and use that to register thesystem when reprovisioning a system.
deletion - to try and delete the existing system prole and reregister the systembeing reprovisioned as new
none - to preserve the status quo and leave the current system as a duplicateon a reprovision.
232 setPartitioningScheme SUSE Manager 24
Return Value
int - 1 on success, exception thrown otherwise.
26.20 setSELinux
Description
Sets the SELinux enforcing mode property of a kickstart prole so that a system createdusing this prole will be have the appropriate SELinux enforcing mode.
Parameters
string sessionKeystring ksLabel - the kickstart prole labelstring enforcingMode - the selinux enforcing mode
enforcingpermissivedisabled
Return Value
int - 1 on success, exception thrown otherwise.
233 setSELinux SUSE Manager 24
27 kickstart.snippet
Provides methods to create kickstart les
27.1 createOrUpdate
Description
Will create a snippet with the given name and contents if it doesn't exist. If it does exist,the existing snippet will be updated.
Parameters
string sessionKeystring namestring contents
Return Value
struct - snippet
string "name"string "contents"string "fragment" - The string to include in a kickstart le that will generatethis snippet.string "le" - The local path to the le containing this snippet.
27.2 delete
Description
Delete the specied snippet. If the snippet is not found, 0 is returned.
Parameters
string sessionKeystring name
Return Value
234 createOrUpdate SUSE Manager 24
int - 1 on success, exception thrown otherwise.
27.3 listAllDescription
List all cobbler snippets for the logged in user
Parameters
string sessionKey
Return Value
array:
struct - snippet
string "name"string "contents"string "fragment" - The string to include in a kickstart le that will generatethis snippet.string "le" - The local path to the le containing this snippet.
27.4 listCustomDescription
List only custom snippets for the logged in user. These snipppets are editable.
Parameters
string sessionKey
Return Value
array:
struct - snippet
string "name"string "contents"
235 listAll SUSE Manager 24
string "fragment" - The string to include in a kickstart le that will generatethis snippet.string "le" - The local path to the le containing this snippet.
27.5 listDefault
Description
List only pre-made default snippets for the logged in user. These snipppets are not editable.
Parameters
string sessionKey
Return Value
array:
struct - snippet
string "name"string "contents"string "fragment" - The string to include in a kickstart le that will generatethis snippet.string "le" - The local path to the le containing this snippet.
236 listDefault SUSE Manager 24
28 kickstart.tree
Provides methods to access and modify the kickstart trees.
28.1 create
Description
Create a Kickstart Tree (Distribution) in SUSE Manager.
Parameters
string sessionKey
string treeLabel - The new kickstart tree label.
string basePath - Path to the base or root of the kickstart tree.
string channelLabel - Label of channel to associate with the kickstart tree.
string installType - Label for KickstartInstallType (rhel_2.1, rhel_3, rhel_4, rhel_5,fedora_9).
Return Value
int - 1 on success, exception thrown otherwise.
28.2 delete
Description
Delete a Kickstart Tree (Distribution) from SUSE Manager.
Parameters
string sessionKey
string treeLabel - Label for the kickstart tree to delete.
Return Value
237 create SUSE Manager 24
int - 1 on success, exception thrown otherwise.
28.3 deleteTreeAndProfiles
Description
Delete a kickstarttree and any proles associated with this kickstart tree. WARNING: Thiswill delete all proles associated with this kickstart tree!
Parameters
string sessionKey
string treeLabel - Label for the kickstart tree to delete.
Return Value
int - 1 on success, exception thrown otherwise.
28.4 getDetails
Description
The detailed information about a kickstartable tree given the tree name.
Parameters
string sessionKey
string treeLabel - Label of kickstartable tree to search.
Return Value
struct - kickstartable tree
int "id"
string "label"
string "abs_path"
int "channel_id"
struct - kickstart install type
238 deleteTreeAndProfiles SUSE Manager 24
int "id"string "label"string "name"
28.5 listDescription
List the available kickstartable trees for the given channel.
Parameters
string sessionKeystring channelLabel - Label of channel to search.
Return Value
array:
struct - kickstartable tree
int "id"string "label"string "base_path"int "channel_id"
28.6 listInstallTypesDescription
List the available kickstartable install types (rhel2,3,4,5 and fedora9+).
Parameters
string sessionKey
Return Value
array:
struct - kickstart install type
239 list SUSE Manager 24
int "id"string "label"string "name"
28.7 rename
Description
Rename a Kickstart Tree (Distribution) in SUSE Manager.
Parameters
string sessionKeystring originalLabel - Label for the kickstart tree to rename.string newLabel - The kickstart tree's new label.
Return Value
int - 1 on success, exception thrown otherwise.
28.8 update
Description
Edit a Kickstart Tree (Distribution) in SUSE Manager.
Parameters
string sessionKeystring treeLabel - Label for the kickstart tree.string basePath - Path to the base or root of the kickstart tree.string channelLabel - Label of channel to associate with kickstart tree.string installType - Label for KickstartInstallType (rhel_2.1, rhel_3, rhel_4, rhel_5,fedora_9).
Return Value
int - 1 on success, exception thrown otherwise.
240 rename SUSE Manager 24
29 maintenance
Provides methods to access and modify Maintenance Schedules related entities
29.1 assignScheduleToSystems
Description
Assign schedule with given name to systems with given IDs. Throws aPermissionCheckFailureException when some of the systems are not accessible by the user.Throws a InvalidParameterException when some of the systems have pending actions thatare not allowed in the maintenance mode.
Parameters
string sessionKey
string scheduleName - The schedule name
array:
int - system IDs
array:
string "rescheduleStrategy" - Available:
Cancel - Cancel actions which are outside of the maintenance windows
Fail - Let assignment fail. No operation will be performed
Return Value
array:
int - number of involved systems
29.2 createCalendar
Description
Create a new Maintenance Calendar
241 assignScheduleToSystems SUSE Manager 24
Parameters
string sessionKey
string label - Maintenance Calendar Label
string ical - ICal Calendar Data
Return Value
array:
struct - Maintenance Calendar information
int "id"
int "orgId"
string "label"
string "url" - calendar url if present
string "ical"
29.3 createCalendarWithUrl
Description
Create a new Maintenance Calendar
Parameters
string sessionKey
string label - Maintenance Calendar Label
string url - download URL for ICal Calendar Data
Return Value
array:
struct - Maintenance Calendar information
int "id"
int "orgId"
string "label"
242 createCalendarWithUrl SUSE Manager 24
string "url" - calendar url if presentstring "ical"
29.4 createScheduleDescription
Create a new Maintenance Schedule
Parameters
string sessionKeystring name - Maintenance Schedule Namestring type - Schedule type: single, multi
Return Value
array:
struct - Maintenance Schedule information
int "id"int "orgId"string "name"string "type"struct - Maintenance Calendar information
int "id"int "orgId"string "label"string "url" - calendar url if presentstring "ical"
29.5 createScheduleDescription
Create a new Maintenance Schedule
Parameters
243 createSchedule SUSE Manager 24
string sessionKeystring name - Maintenance Schedule Namestring type - Schedule type: single, multistring calendar - Maintenance Calendar Label
Return Value
array:
struct - Maintenance Schedule information
int "id"int "orgId"string "name"string "type"struct - Maintenance Calendar information
int "id"int "orgId"string "label"string "url" - calendar url if presentstring "ical"
29.6 deleteCalendar
Description
Remove a Maintenance Calendar
Parameters
string sessionKeystring label - Maintenance Calendar Labelboolean cancelScheduledActions - Cancel Actions of aected Schedules
Return Value
array:
struct - Reschedule information
244 deleteCalendar SUSE Manager 24
string "strategy" - selected strategy
string "for_schedule_name"
boolean "status"
string "message"
array "actions"
struct - Action information
int "id" - Action Id.
string "name" - Action name.
string "type" - Action type.
string "scheduler" - The user that scheduled the action.(optional)
dateTime.iso8601 "earliest" - The earliest date and time theaction will be performed
int "prerequisite" - ID of the prerequisite Action (optional)
array "aected_system_ids"
int - aected System Ids
string "details" - Action details string
29.7 deleteSchedule
Description
Remove a Maintenance Schedule
Parameters
string sessionKey
string name - Maintenance Schedule Name
Return Value
245 deleteSchedule SUSE Manager 24
int - 1 on success, exception thrown otherwise.
29.8 getCalendarDetailsDescription
Lookup a specic Maintenance Schedule
Parameters
string sessionKeystring label - Maintenance Calendar Label
Return Value
array:
struct - Maintenance Calendar information
int "id"int "orgId"string "label"string "url" - calendar url if presentstring "ical"
29.9 getScheduleDetailsDescription
Lookup a specic Maintenance Schedule
Parameters
string sessionKeystring name - Maintenance Schedule Name
Return Value
array:
struct - Maintenance Schedule information
246 getCalendarDetails SUSE Manager 24
int "id"int "orgId"string "name"string "type"struct - Maintenance Calendar information
int "id"int "orgId"string "label"string "url" - calendar url if presentstring "ical"
29.10 listCalendarLabels
Description
List Schedule Names visible to user
Parameters
string sessionKey
Return Value
array:
string - maintenance calendar labels
29.11 listScheduleNames
Description
List Schedule Names visible to user
Parameters
string sessionKey
Return Value
247 listCalendarLabels SUSE Manager 24
array:
string - maintenance schedule names
29.12 listSystemsWithSchedule
Description
List IDs of systems that have given schedule assigned Throws aPermissionCheckFailureException when some of the systems are not accessible by the user.
Parameters
string sessionKey
string scheduleName - The schedule name
Return Value
array:
int - system IDs
29.13 refreshCalendar
Description
Refresh Maintenance Calendar Data using the congured URL
Parameters
string sessionKey
string label - Maintenance Calendar Label
array:
string "rescheduleStrategy" - Available:
Cancel - Cancel actions which are outside of the maintenance windows
Fail - Let update fail. The calendar stay untouched
Return Value
248 listSystemsWithSchedule SUSE Manager 24
array:
struct - Reschedule information
string "strategy" - selected strategystring "for_schedule_name"boolean "status"string "message"array "actions"
struct - Action information
int "id" - Action Id.string "name" - Action name.string "type" - Action type.string "scheduler" - The user that scheduled the action.(optional)dateTime.iso8601 "earliest" - The earliest date and time theaction will be performedint "prerequisite" - ID of the prerequisite Action (optional)array "aected_system_ids"
int - aected System Idsstring "details" - Action details string
29.14 retractScheduleFromSystemsDescription
Retract schedule with given name from systems with given IDs Throws aPermissionCheckFailureException when some of the systems are not accessible by the user.
Parameters
string sessionKeyarray:
int - system IDs
Return Value
249 retractScheduleFromSystems SUSE Manager 24
array:
int - number of involved systems
29.15 updateCalendar
Description
Update a Maintenance Calendar
Parameters
string sessionKey
string label - Maintenance Calendar Label
struct - Maintenance Calendar Details
string "ical" - new ical Calendar data
string "url" - new Calendar URL
array:
string "rescheduleStrategy" - Available:
Cancel - Cancel actions which are outside of the maintenance windows
Fail - Let update fail. The calendar stay untouched
Return Value
array:
struct - Reschedule information
string "strategy" - selected strategy
string "for_schedule_name"
boolean "status"
string "message"
array "actions"
struct - Action information
int "id" - Action Id.
string "name" - Action name.
250 updateCalendar SUSE Manager 24
string "type" - Action type.
string "scheduler" - The user that scheduled the action.(optional)
dateTime.iso8601 "earliest" - The earliest date and time theaction will be performed
int "prerequisite" - ID of the prerequisite Action (optional)
array "aected_system_ids"
int - aected System Ids
string "details" - Action details string
29.16 updateSchedule
Description
Update a Maintenance Schedule
Parameters
string sessionKey
string name - Maintenance Schedule Name
struct - Maintenance Schedule Details
string "type" - new Schedule Type
single
multi
string "calendar" - new calendar label
array:
string "rescheduleStrategy" - Available:
Cancel - Cancel actions which are outside of the maintenance windows
Fail - Let update fail. The calendar stay untouched
Return Value
struct - Reschedule information
string "strategy" - selected strategy
string "for_schedule_name"
251 updateSchedule SUSE Manager 24
boolean "status"string "message"array "actions"
struct - Action information
int "id" - Action Id.string "name" - Action name.string "type" - Action type.string "scheduler" - The user that scheduled the action. (optional)dateTime.iso8601 "earliest" - The earliest date and time the actionwill be performedint "prerequisite" - ID of the prerequisite Action (optional)array "aected_system_ids"
int - aected System Idsstring "details" - Action details string
252 updateSchedule SUSE Manager 24
30 org
Contains methods to access common organization management functions availablefrom the web interface.
30.1 createDescription
Create a new organization and associated administrator account.
Parameters
string sessionKeystring orgName - Organization name. Must meet same criteria as in the web UI.string adminLogin - New administrator login name.string adminPassword - New administrator password.string prex - New administrator's prex. Must match one of the values available inthe web UI. (i.e. Dr., Mr., Mrs., Sr., etc.)string rstName - New administrator's rst name.string lastName - New administrator's rst name.string email - New administrator's e-mail.boolean usePamAuth - True if PAM authentication should be used for the newadministrator account.
Return Value
struct - organization info
int "id"string "name"int "active_users" - Number of active users in the organization.int "systems" - Number of systems in the organization.int "trusts" - Number of trusted organizations.int "system_groups" - Number of system groups in the organization. (optional)int "activation_keys" - Number of activation keys in the organization. (optional)int "kickstart_proles" - Number of kickstart proles in the organization.(optional)
253 create SUSE Manager 24
int "conguration_channels" - Number of conguration channels in theorganization. (optional)boolean "staging_content_enabled" - Is staging content enabled in organization.(optional)
30.2 delete
Description
Delete an organization. The default organization (i.e. orgId=1) cannot be deleted.
Parameters
string sessionKeyint orgId
Return Value
int - 1 on success, exception thrown otherwise.
30.3 getClmSyncPatchesConfig
Description
Reads the content lifecycle management patch synchronization cong option.
Parameters
string sessionKeyint orgId
Return Value
boolean status - Get the cong option value
30.4 getCrashFileSizeLimit
Description
254 delete SUSE Manager 24
Get the organization wide crash le size limit. The limit value must be a non-negativenumber, zero means no limit.
Parameters
string sessionKey
int orgId
Return Value
int limit - Crash le size limit
30.5 getDetails
Description
The detailed information about an organization given the organization ID.
Parameters
string sessionKey
int orgId
Return Value
struct - organization info
int "id"
string "name"
int "active_users" - Number of active users in the organization.
int "systems" - Number of systems in the organization.
int "trusts" - Number of trusted organizations.
int "system_groups" - Number of system groups in the organization. (optional)
int "activation_keys" - Number of activation keys in the organization. (optional)
int "kickstart_proles" - Number of kickstart proles in the organization.(optional)
255 getDetails SUSE Manager 24
int "conguration_channels" - Number of conguration channels in theorganization. (optional)boolean "staging_content_enabled" - Is staging content enabled in organization.(optional)
30.6 getDetailsDescription
The detailed information about an organization given the organization name.
Parameters
string sessionKeystring name
Return Value
struct - organization info
int "id"string "name"int "active_users" - Number of active users in the organization.int "systems" - Number of systems in the organization.int "trusts" - Number of trusted organizations.int "system_groups" - Number of system groups in the organization. (optional)int "activation_keys" - Number of activation keys in the organization. (optional)int "kickstart_proles" - Number of kickstart proles in the organization.(optional)int "conguration_channels" - Number of conguration channels in theorganization. (optional)boolean "staging_content_enabled" - Is staging content enabled in organization.(optional)
30.7 getPolicyForScapFileUploadDescription
Get the status of SCAP detailed result le upload settings for the given organization.
256 getDetails SUSE Manager 24
Parameters
string sessionKeyint orgId
Return Value
struct - scap_upload_info
boolean "enabled" - Aggregation of detailed SCAP results is enabled.int "size_limit" - Limit (in Bytes) for a single SCAP le upload.
30.8 getPolicyForScapResultDeletionDescription
Get the status of SCAP result deletion settings for the given organization.
Parameters
string sessionKeyint orgId
Return Value
struct - scap_deletion_info
boolean "enabled" - Deletion of SCAP results is enabledint "retention_period" - Period (in days) after which a scan can be deleted (ifenabled).
30.9 isContentStagingEnabledDescription
Get the status of content staging settings for the given organization. Returns true if enabled,false otherwise.
Parameters
string sessionKeyint orgId
257 getPolicyForScapResultDeletion SUSE Manager 24
Return Value
boolean status - Get the status of content staging settings
30.10 isCrashReportingEnabledDescription
Get the status of crash reporting settings for the given organization. Returns true if enabled,false otherwise.
Parameters
string sessionKeyint orgId
Return Value
boolean status - Get the status of crash reporting settings
30.11 isCrashfileUploadEnabledDescription
Get the status of crash le upload settings for the given organization. Returns true ifenabled, false otherwise.
Parameters
string sessionKeyint orgId
Return Value
boolean status - Get the status of crash le upload settings
30.12 isErrataEmailNotifsForOrgDescription
258 isCrashReportingEnabled SUSE Manager 24
Returns whether errata e-mail notications are enabled for the organization
Parameters
string sessionKey
int orgId
Return Value
boolean status - Returns the status of the errata e-mail notication setting for theorganization
30.13 isOrgConfigManagedByOrgAdmin
Description
Returns whether Organization Administrator is able to manage his organizationconguration. This may have a high impact on general SUSE Manager performance.
Parameters
string sessionKey
int orgId
Return Value
boolean status - Returns the status org admin management setting
30.14 listOrgs
Description
Returns the list of organizations.
Parameters
string sessionKey
Return Value
259 isOrgConfigManagedByOrgAdmin SUSE Manager 24
array:
struct - organization info
int "id"string "name"int "active_users" - Number of active users in the organization.int "systems" - Number of systems in the organization.int "trusts" - Number of trusted organizations.int "system_groups" - Number of system groups in the organization.(optional)int "activation_keys" - Number of activation keys in the organization.(optional)int "kickstart_proles" - Number of kickstart proles in the organization.(optional)int "conguration_channels" - Number of conguration channels in theorganization. (optional)boolean "staging_content_enabled" - Is staging content enabled inorganization. (optional)
30.15 listUsersDescription
Returns the list of users in a given organization.
Parameters
string sessionKeyint orgId
Return Value
array:
struct - user
string "login"string "login_uc"string "name"
260 listUsers SUSE Manager 24
string "email"boolean "is_org_admin"
30.16 migrateSystemsDescription
Migrate systems from one organization to another. If executed by a SUSE Manageradministrator, the systems will be migrated from their current organization to theorganization specied by the toOrgId. If executed by an organization administrator, thesystems must exist in the same organization as that administrator and the systems will bemigrated to the organization specied by the toOrgId. In any scenario, the origination anddestination organizations must be dened in a trust.
Parameters
string sessionKeyint toOrgId - ID of the organization where the system(s) will be migrated to.array:
int - systemId
Return Value
array:
int - serverIdMigrated
30.17 setClmSyncPatchesConfigDescription
Sets the content lifecycle management patch synchronization cong option.
Parameters
string sessionKeyint orgIdboolean value - The cong option value
Return Value
261 migrateSystems SUSE Manager 24
int - 1 on success, exception thrown otherwise.
30.18 setContentStagingDescription
Set the status of content staging for the given organization.
Parameters
string sessionKeyint orgIdboolean enable - Use true/false to enable/disable
Return Value
int - 1 on success, exception thrown otherwise.
30.19 setCrashFileSizeLimitDescription
Set the organization wide crash le size limit. The limit value must be non-negative, zeromeans no limit.
Parameters
string sessionKeyint orgIdint limit - The limit to set (non-negative value).
Return Value
int - 1 on success, exception thrown otherwise.
30.20 setCrashReportingDescription
Set the status of crash reporting settings for the given organization. Disabling crashreporting will automatically disable crash le upload.
262 setContentStaging SUSE Manager 24
Parameters
string sessionKeyint orgIdboolean enable - Use true/false to enable/disable
Return Value
int - 1 on success, exception thrown otherwise.
30.21 setCrashfileUpload
Description
Set the status of crash le upload settings for the given organization. Modifying the settingsis possible as long as crash reporting is enabled.
Parameters
string sessionKeyint orgIdboolean enable - Use true/false to enable/disable
Return Value
int - 1 on success, exception thrown otherwise.
30.22 setErrataEmailNotifsForOrg
Description
Dis/enables errata e-mail notications for the organization
Parameters
string sessionKeyint orgIdboolean enable - Use true/false to enable/disable
Return Value
263 setCrashfileUpload SUSE Manager 24
int - 1 on success, exception thrown otherwise.
30.23 setOrgConfigManagedByOrgAdmin
Description
Sets whether Organization Administrator can manage his organization conguration. Thismay have a high impact on general SUSE Manager performance.
Parameters
string sessionKey
int orgId
boolean enable - Use true/false to enable/disable
Return Value
int - 1 on success, exception thrown otherwise.
30.24 setPolicyForScapFileUpload
Description
Set the status of SCAP detailed result le upload settings for the given organization.
Parameters
string sessionKey
int orgId
struct - scap_upload_info
boolean "enabled" - Aggregation of detailed SCAP results is enabled.
int "size_limit" - Limit (in Bytes) for a single SCAP le upload.
Return Value
264 setOrgConfigManagedByOrgAdmin SUSE Manager 24
int - 1 on success, exception thrown otherwise.
30.25 setPolicyForScapResultDeletion
Description
Set the status of SCAP result deletion settins for the given organization.
Parameters
string sessionKeyint orgIdstruct - scap_deletion_info
boolean "enabled" - Deletion of SCAP results is enabledint "retention_period" - Period (in days) after which a scan can be deleted (ifenabled).
Return Value
int - 1 on success, exception thrown otherwise.
30.26 updateName
Description
Updates the name of an organization
Parameters
string sessionKeyint orgIdstring name - Organization name. Must meet same criteria as in the web UI.
Return Value
struct - organization info
int "id"string "name"
265 setPolicyForScapResultDeletion SUSE Manager 24
int "active_users" - Number of active users in the organization.int "systems" - Number of systems in the organization.int "trusts" - Number of trusted organizations.int "system_groups" - Number of system groups in the organization. (optional)int "activation_keys" - Number of activation keys in the organization. (optional)int "kickstart_proles" - Number of kickstart proles in the organization.(optional)int "conguration_channels" - Number of conguration channels in theorganization. (optional)boolean "staging_content_enabled" - Is staging content enabled in organization.(optional)
266 updateName SUSE Manager 24
31 org.trusts
Contains methods to access common organization trust information available fromthe web interface.
31.1 addTrustDescription
Add an organization to the list of trusted organizations.
Parameters
string sessionKeyint orgIdint trustOrgId
Return Value
int - 1 on success, exception thrown otherwise.
31.2 getDetailsDescription
The trust details about an organization given the organization's ID.
Parameters
string sessionKeyint trustOrgId - Id of the trusted organization
Return Value
struct - org trust details
dateTime.iso8601 "created" - Date the organization was createddateTime.iso8601 "trusted_since" - Date the organization was dened as trustedint "channels_provided" - Number of channels provided by the organization.int "channels_consumed" - Number of channels consumed by the organization.
267 addTrust SUSE Manager 24
int "systems_migrated_to" - Number of systems migrated to the organization.int "systems_migrated_from" - Number of systems migrated from theorganization.
31.3 listChannelsConsumedDescription
Lists all software channels that the organization given may consume from the user'sorganization.
Parameters
string sessionKeyint trustOrgId - Id of the trusted organization
Return Value
array:
struct - channel info
int "channel_id"string "channel_name"int "packages"int "systems"
31.4 listChannelsProvidedDescription
Lists all software channels that the organization given is providing to the user'sorganization.
Parameters
string sessionKeyint trustOrgId - Id of the trusted organization
Return Value
268 listChannelsConsumed SUSE Manager 24
array:
struct - channel info
int "channel_id"string "channel_name"int "packages"int "systems"
31.5 listOrgsDescription
List all organanizations trusted by the user's organization.
Parameters
string sessionKey
Return Value
array:
struct - trusted organizations
int "org_id"string "org_name"int "shared_channels"
31.6 listSystemsAffectedDescription
Get a list of systems within the trusted organization that would be aected if the trustrelationship was removed. This basically lists systems that are sharing at least (1) package.
Parameters
string sessionKeyint orgIdstring trustOrgId
269 listOrgs SUSE Manager 24
Return Value
array:
struct - aected systems
int "systemId"string "systemName"
31.7 listTrustsDescription
Returns the list of trusted organizations.
Parameters
string sessionKeyint orgId
Return Value
array:
struct - trusted organizations
int "orgId"string "orgName"boolean "trustEnabled"
31.8 removeTrustDescription
Remove an organization to the list of trusted organizations.
Parameters
string sessionKeyint orgIdint trustOrgId
270 listTrusts SUSE Manager 24
Return Value
int - 1 on success, exception thrown otherwise.
271 removeTrust SUSE Manager 24
32 packages
Methods to retrieve information about the Packages contained within this server.
32.1 findByNvrea
Description
Lookup the details for packages with the given name, version, release, architecture label,and (optionally) epoch.
Parameters
string sessionKey
string name
string version
string release
string epoch - If set to something other than empty string, strict matching will beused and the epoch string must be correct. If set to an empty string, if the epochis null or there is only one NVRA combination, it will be returned. (Empty string isrecommended.)
string archLabel
Return Value
array:
struct - package
string "name"
string "version"
string "release"
string "epoch"
int "id"
string "arch_label"
dateTime.iso8601 "last_modied"
272 findByNvrea SUSE Manager 24
string "path" - The path on that le system that the package resides
string "provider" - The provider of the package, determined by the gpgkey it was signed with.
32.2 getDetails
Description
Retrieve details for the package with the ID.
Parameters
string sessionKey
int packageId
Return Value
struct - package
int "id"
string "name"
string "epoch"
string "version"
string "release"
string "arch_label"
array "providing_channels"
string - Channel label providing this package.
string "build_host"
string "description"
string "checksum"
string "checksum_type"
string "vendor"
string "summary"
string "cookie"
string "license"
string "le"
string "build_date"
273 getDetails SUSE Manager 24
string "last_modied_date"
string "size"
string "path" - The path on the SUSE Manager server's le system that thepackage resides.
string "payload_size"
32.3 getPackage
Description
Retrieve the package le associated with a package. (Consider usingpackages.getPackageUrl for larger les.)
Parameters
string sessionKey
int package_id
Return Value
array:
byte - binary object - package le
32.4 getPackageUrl
Description
Retrieve the url that can be used to download a package. This will expire after a certaintime period.
Parameters
string sessionKey
int package_id
Return Value
274 getPackage SUSE Manager 24
string - the download url
32.5 listChangelogDescription
List the change log for a package.
Parameters
string sessionKeyint packageId
Return Value
string
32.6 listDependenciesDescription
List the dependencies for a package.
Parameters
string sessionKeyint packageId
Return Value
array:
struct - dependency
string "dependency"string "dependency_type" - One of the following:
requiresconictsobsoletesprovidesrecommends
275 listChangelog SUSE Manager 24
suggestssupplementsenhancespredependsbreaks
string "dependency_modier"
32.7 listFiles
Description
List the les associated with a package.
Parameters
string sessionKeyint packageId
Return Value
array:
struct - le info
string "path"string "type"string "last_modied_date"string "checksum"string "checksum_type"int "size"string "linkto"
32.8 listProvidingChannels
Description
List the channels that provide the a package.
Parameters
276 listFiles SUSE Manager 24
string sessionKeyint packageId
Return Value
array:
struct - channel
string "label"string "parent_label"string "name"
32.9 listProvidingErrataDescription
List the errata providing the a package.
Parameters
string sessionKeyint packageId
Return Value
array:
struct - errata
string "advisory"string "issue_date"string "last_modied_date"string "update_date"string "synopsis"string "type"
32.10 listSourcePackagesDescription
277 listProvidingErrata SUSE Manager 24
List all source packages in user's organization.
Parameters
string sessionKey
Return Value
array:
struct - source_package
int "id"string "name"
32.11 removePackageDescription
Remove a package from SUSE Manager.
Parameters
string sessionKeyint packageId
Return Value
int - 1 on success, exception thrown otherwise.
32.12 removeSourcePackageDescription
Remove a source package.
Parameters
string sessionKeyint packageSourceId
Return Value
278 removePackage SUSE Manager 24
int - 1 on success, exception thrown otherwise.
279 removeSourcePackage SUSE Manager 24
33 packages.provider
Methods to retrieve information about Package Providers associated with packages.
33.1 associateKey
Description
Associate a package security key and with the package provider. If the provider orkey doesn't exist, it is created. User executing the request must be a SUSE Manageradministrator.
Parameters
string sessionKeystring providerName - The provider namestring key - The actual keystring type - The type of the key. Currently, only 'gpg' is supported
Return Value
int - 1 on success, exception thrown otherwise.
33.2 list
Description
List all Package Providers. User executing the request must be a SUSE Manageradministrator.
Parameters
string sessionKey
Return Value
array:
struct - package provider
280 associateKey SUSE Manager 24
string "name"array "keys"
struct - package security key
string "key"string "type"
33.3 listKeys
Description
List all security keys associated with a package provider. User executing the request mustbe a SUSE Manager administrator.
Parameters
string sessionKeystring providerName - The provider name
Return Value
array:
struct - package security key
string "key"string "type"
281 listKeys SUSE Manager 24
34 packages.search
Methods to interface to package search capabilities in search server..
34.1 advanced
Description
Advanced method to search lucene indexes with a passed in query written in LuceneQuery Parser syntax. Lucene Query Parser syntax is dened at lucene.apache.org. Fieldssearchable for Packages: name, epoch, version, release, arch, description, summary LuceneQuery Example: "name:kernel AND version:2.6.18 AND -description:devel"
Parameters
string sessionKeystring luceneQuery - a query written in the form of Lucene QueryParser Syntax
Return Value
array:
struct - package overview
int "id"string "name"string "summary"string "description"string "version"string "release"string "arch"string "epoch"string "provider"
34.2 advancedWithActKey
Description
282 advanced SUSE Manager 24
Advanced method to search lucene indexes with a passed in query written in Lucene QueryParser syntax, additionally this method will limit results to those which are associated witha given activation key. Lucene Query Parser syntax is dened at lucene.apache.org. Fieldssearchable for Packages: name, epoch, version, release, arch, description, summary LuceneQuery Example: "name:kernel AND version:2.6.18 AND -description:devel"
Parameters
string sessionKeystring luceneQuery - a query written in the form of Lucene QueryParser Syntaxstring actKey - activation key to look for packages in
Return Value
array:
struct - package overview
int "id"string "name"string "summary"string "description"string "version"string "release"string "arch"string "epoch"string "provider"
34.3 advancedWithChannel
Description
Advanced method to search lucene indexes with a passed in query written in LuceneQuery Parser syntax, additionally this method will limit results to those which are in thepassed in channel label. Lucene Query Parser syntax is dened at lucene.apache.org. Fieldssearchable for Packages: name, epoch, version, release, arch, description, summary LuceneQuery Example: "name:kernel AND version:2.6.18 AND -description:devel"
Parameters
283 advancedWithChannel SUSE Manager 24
string sessionKeystring luceneQuery - a query written in the form of Lucene QueryParser Syntaxstring channelLabel - Channel Label
Return Value
array:
struct - package overview
int "id"string "name"string "summary"string "description"string "version"string "release"string "arch"string "epoch"string "provider"
34.4 name
Description
Search the lucene package indexes for all packages which match the given name.
Parameters
string sessionKeystring name - package name to search for
Return Value
array:
struct - package overview
int "id"string "name"string "summary"
284 name SUSE Manager 24
string "description"string "version"string "release"string "arch"string "epoch"string "provider"
34.5 nameAndDescriptionDescription
Search the lucene package indexes for all packages which match the given query in nameor description
Parameters
string sessionKeystring query - text to match in package name or description
Return Value
array:
struct - package overview
int "id"string "name"string "summary"string "description"string "version"string "release"string "arch"string "epoch"string "provider"
34.6 nameAndSummaryDescription
285 nameAndDescription SUSE Manager 24
Search the lucene package indexes for all packages which match the given query in nameor summary.
Parameters
string sessionKeystring query - text to match in package name or summary
Return Value
array:
struct - package overview
int "id"string "name"string "summary"string "description"string "version"string "release"string "arch"string "epoch"string "provider"
286 nameAndSummary SUSE Manager 24
35 preferences.locale
Provides methods to access and modify user locale information
35.1 listLocales
Description
Returns a list of all understood locales. Can be used as input to setLocale.
Parameters
None
Return Value
array:
string - Locale code.
35.2 listTimeZones
Description
Returns a list of all understood timezones. Results can be used as input to setTimeZone.
Parameters
None
Return Value
array:
struct - timezone
287 listLocales SUSE Manager 24
int "time_zone_id" - Unique identier for timezone.string "olson_name" - Name as identied by the Olson database.
35.3 setLocale
Description
Set a user's locale.
Parameters
string sessionKeystring login - User's login name.string locale - Locale to set. (from listLocales)
Return Value
int - 1 on success, exception thrown otherwise.
35.4 setTimeZone
Description
Set a user's timezone.
Parameters
string sessionKeystring login - User's login name.int tzid - Timezone ID. (from listTimeZones)
Return Value
int - 1 on success, exception thrown otherwise.
288 setLocale SUSE Manager 24
36 proxy
Provides methods to activate/deactivate a proxy server.
36.1 activateProxyDescription
Activates the proxy identied by the given client certicate i.e. systemid le.
Parameters
string systemid - systemid lestring version - Version of proxy to be registered.
Return Value
int - 1 on success, exception thrown otherwise.
36.2 createMonitoringScoutDescription
Create Monitoring Scout for proxy.Available since API version: 10.7
Parameters
string systemid - systemid le
Return Value
string
36.3 deactivateProxyDescription
Deactivates the proxy identied by the given client certicate i.e. systemid le.
Parameters
289 activateProxy SUSE Manager 24
string systemid - systemid le
Return Value
int - 1 on success, exception thrown otherwise.
36.4 isProxyDescription
Test, if the system identied by the given client certicate i.e. systemid le, is proxy.
Parameters
string systemid - systemid le
Return Value
int - 1 on success, exception thrown otherwise.
36.5 listAvailableProxyChannelsDescription
List available version of proxy channel for system identied by the given client certicatei.e. systemid le.Available since API version: 10.5
Parameters
string systemid - systemid le
Return Value
array:
string - version
36.6 listProxiesDescription
290 isProxy SUSE Manager 24
List the proxies within the user's organization.
Parameters
string sessionKey
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked indateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot timeint "extra_pkg_count" - Number of packages not belonging to any assignedchannelint "outdated_pkg_count" - Number of out-of-date packages
36.7 listProxyClients
Description
List the clients directly connected to a given Proxy.
Parameters
string sessionKeyint proxyId
Return Value
array:
int - clientId
291 listProxyClients SUSE Manager 24
37 recurringaction
Provides methods to handle Recurring Actions for Minions, Groups andOrganizations.
37.1 createDescription
Create a new recurring action.
Parameters
string sessionKeystruct - actionProps
string "entity_type" - The type of the target entity. One of the following:MINIONGROUPORG
int "entity_id" - The id of the target entitystring "name" - The name of the actionstring "cron_expr" - The execution frequency of the actionboolean "test" - Whether the action should be executed in test mode (optional)
Return Value
int id - The id of the recurring action
37.2 deleteDescription
Delete recurring action with given action id.
Parameters
string sessionKeyint actionId - Id of the action
292 create SUSE Manager 24
Return Value
int id - The id of the recurring action
37.3 listByEntity
Description
Return a list of recurring actions for a given entity.
Parameters
string sessionKeystring entityType - Type of the target entity. Can be MINION, GROUP or ORG.int entityId - Id of the target entity
Return Value
array:
struct - Recurring Action information
int "id"string "name"int "entity_id"string "entity_type"string "cron_expr"dateTime.iso8601 "created"string "creator"boolean "test"boolean "active"
37.4 lookupById
Description
Return recurring action with given action id.
Parameters
293 listByEntity SUSE Manager 24
string sessionKeyint actionId - Id of the action
Return Value
struct - Recurring Action information
int "id"string "name"int "entity_id"string "entity_type"string "cron_expr"dateTime.iso8601 "created"string "creator"boolean "test"boolean "active"
37.5 update
Description
Update a recurring action.
Parameters
string sessionKeystruct - actionProps
int "id" - The id of the action to updatestring "name" - The name of the action (optional)string "cron_expr" - The execution frequency of the action (optional)boolean "test" - Whether the action should be executed in test mode (optional)boolean "active" - Whether the action should be active (optional)
Return Value
int id - The id of the recurring action
294 update SUSE Manager 24
38 saltkey
Provides methods to manage salt keys
38.1 delete
Description
Delete a minion key
Parameters
string sessionKeystring minionId
Return Value
int - 1 on success, exception thrown otherwise.
295 delete SUSE Manager 24
39 satellite
Provides methods to obtain details on the Satellite.
39.1 isMonitoringEnabled
Description
Indicates if monitoring is enabled on the satelliteDeprecated - deprecated unused method. See new namespace admin.monitoring.
Parameters
string sessionKey
Return Value
boolean True if monitoring is enabled
39.2 isMonitoringEnabledBySystemId
Description
Indicates if monitoring is enabled on the satelliteDeprecated - deprecated unused method. See new namespace admin.monitoring.
Parameters
string systemid - systemid le
Return Value
boolean True if monitoring is enabled
39.3 listProxies
Description
List the proxies within the user's organization.
296 isMonitoringEnabled SUSE Manager 24
Deprecated - moved to proxy.listProxies
Parameters
string sessionKey
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked indateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot timeint "extra_pkg_count" - Number of packages not belonging to any assignedchannelint "outdated_pkg_count" - Number of out-of-date packages
297 listProxies SUSE Manager 24
40 schedule
Methods to retrieve information about scheduled actions.
40.1 archiveActions
Description
Archive all actions in the given list.
Parameters
string sessionKey
array:
int - action id
Return Value
int - 1 on success, exception thrown otherwise.
40.2 cancelActions
Description
Cancel all actions in given list. If an invalid action is provided, none of the actions givenwill canceled.
Parameters
string sessionKey
array:
int - action id
Return Value
298 archiveActions SUSE Manager 24
int - 1 on success, exception thrown otherwise.
40.3 deleteActions
Description
Delete all archived actions in the given list.
Parameters
string sessionKey
array:
int - action id
Return Value
int - 1 on success, exception thrown otherwise.
40.4 failSystemAction
Description
Fail specic event on specied system
Parameters
string sessionKey
int serverId
int actionId
Return Value
int - 1 on success, exception thrown otherwise.
40.5 failSystemAction
Description
299 deleteActions SUSE Manager 24
Fail specic event on specied system
Parameters
string sessionKey
int serverId
int actionId
string message
Return Value
int - 1 on success, exception thrown otherwise.
40.6 listAllActions
Description
Returns a list of all actions. This includes completed, in progress, failed and archivedactions.
Parameters
string sessionKey
Return Value
array:
struct - action
int "id" - Action Id.
string "name" - Action name.
string "type" - Action type.
string "scheduler" - The user that scheduled the action. (optional)
dateTime.iso8601 "earliest" - The earliest date and time the action will beperformed
int "prerequisite" - ID of the prerequisite Action (optional)
int "completedSystems" - Number of systems that completed the action.
300 listAllActions SUSE Manager 24
int "failedSystems" - Number of systems that failed the action.int "inProgressSystems" - Number of systems that are in progress.
40.7 listArchivedActionsDescription
Returns a list of actions that have been archived.
Parameters
string sessionKey
Return Value
array:
struct - action
int "id" - Action Id.string "name" - Action name.string "type" - Action type.string "scheduler" - The user that scheduled the action. (optional)dateTime.iso8601 "earliest" - The earliest date and time the action will beperformedint "prerequisite" - ID of the prerequisite Action (optional)int "completedSystems" - Number of systems that completed the action.int "failedSystems" - Number of systems that failed the action.int "inProgressSystems" - Number of systems that are in progress.
40.8 listCompletedActionsDescription
Returns a list of actions that have completed successfully.
Parameters
string sessionKey
Return Value
301 listArchivedActions SUSE Manager 24
array:
struct - action
int "id" - Action Id.
string "name" - Action name.
string "type" - Action type.
string "scheduler" - The user that scheduled the action. (optional)
dateTime.iso8601 "earliest" - The earliest date and time the action will beperformed
int "prerequisite" - ID of the prerequisite Action (optional)
int "completedSystems" - Number of systems that completed the action.
int "failedSystems" - Number of systems that failed the action.
int "inProgressSystems" - Number of systems that are in progress.
40.9 listCompletedSystems
Description
Returns a list of systems that have completed a specic action.
Parameters
string sessionKey
int actionId
Return Value
array:
struct - system
int "server_id"
string "server_name" - Server name.
string "base_channel" - Base channel used by the server.
302 listCompletedSystems SUSE Manager 24
dateTime.iso8601 "timestamp" - The time the action was completedstring "message" - Optional message containing details on the execution ofthe action. For example, if the action failed, this will contain the failuretext.
40.10 listFailedActions
Description
Returns a list of actions that have failed.
Parameters
string sessionKey
Return Value
array:
struct - action
int "id" - Action Id.string "name" - Action name.string "type" - Action type.string "scheduler" - The user that scheduled the action. (optional)dateTime.iso8601 "earliest" - The earliest date and time the action will beperformedint "prerequisite" - ID of the prerequisite Action (optional)int "completedSystems" - Number of systems that completed the action.int "failedSystems" - Number of systems that failed the action.int "inProgressSystems" - Number of systems that are in progress.
40.11 listFailedSystems
Description
Returns a list of systems that have failed a specic action.
Parameters
303 listFailedActions SUSE Manager 24
string sessionKeyint actionId
Return Value
array:
struct - system
int "server_id"string "server_name" - Server name.string "base_channel" - Base channel used by the server.dateTime.iso8601 "timestamp" - The time the action was completedstring "message" - Optional message containing details on the execution ofthe action. For example, if the action failed, this will contain the failuretext.
40.12 listInProgressActionsDescription
Returns a list of actions that are in progress.
Parameters
string sessionKey
Return Value
array:
struct - action
int "id" - Action Id.string "name" - Action name.string "type" - Action type.string "scheduler" - The user that scheduled the action. (optional)dateTime.iso8601 "earliest" - The earliest date and time the action will beperformedint "prerequisite" - ID of the prerequisite Action (optional)int "completedSystems" - Number of systems that completed the action.
304 listInProgressActions SUSE Manager 24
int "failedSystems" - Number of systems that failed the action.int "inProgressSystems" - Number of systems that are in progress.
40.13 listInProgressSystemsDescription
Returns a list of systems that have a specic action in progress.
Parameters
string sessionKeyint actionId
Return Value
array:
struct - system
int "server_id"string "server_name" - Server name.string "base_channel" - Base channel used by the server.dateTime.iso8601 "timestamp" - The time the action was completedstring "message" - Optional message containing details on the execution ofthe action. For example, if the action failed, this will contain the failuretext.
40.14 rescheduleActionsDescription
Reschedule all actions in the given list.
Parameters
string sessionKeyarray:
int - action idboolean onlyFailed - True to only reschedule failed actions, False to reschedule all
305 listInProgressSystems SUSE Manager 24
Return Value
int - 1 on success, exception thrown otherwise.
306 rescheduleActions SUSE Manager 24
41 subscriptionmatching.pinnedsubscription
Provides the namespace for operations on Pinned Subscriptions
41.1 create
Description
Creates a Pinned Subscription based on given subscription and system
Parameters
string sessionKey - Session token, issued at login
int subscriptionId - Subscription Id
int systemId - System Id
Return Value
struct - pinned subscription
int "id"
int "subscription_id"
int "system_id"
41.2 delete
Description
Deletes Pinned Subscription with given id
Parameters
string sessionKey - Session token, issued at login
int pinnedSubscriptionId - Pinned Subscription id
Return Value
307 create SUSE Manager 24
int - 1 on success, exception thrown otherwise.
41.3 list
Description
Lists all PinnedSubscriptions
Parameters
string sessionKey - Session token, issued at login
Return Value
array:
struct - pinned subscription
int "id"int "subscription_id"int "system_id"
308 list SUSE Manager 24
42 sync.content
Provides the namespace for the content synchronization methods.
42.1 addChannel
Description
Add a new channel to the SUSE Manager database
Parameters
string sessionKey - Session token, issued at login
string channelLabel - Label of the channel to add
string mirrorUrl - Sync from mirror temporarily
Return Value
int - 1 on success, exception thrown otherwise.
42.2 addChannels
Description
Add a new channel to the SUSE Manager database
Parameters
string sessionKey - Session token, issued at login
string channelLabel - Label of the channel to add
string mirrorUrl - Sync from mirror temporarily
Return Value
309 addChannel SUSE Manager 24
array:
string - enabled channel labels
42.3 addCredentialsDescription
Add organization credentials (mirror credentials) to SUSE Manager.
Parameters
string sessionKey - Session token, issued at loginstring username - Organization credentials (Mirror credentials) usernamestring password - Organization credentials (Mirror credentials) passwordboolean primary - Make this the primary credentials
Return Value
int - 1 on success, exception thrown otherwise.
42.4 deleteCredentialsDescription
Delete organization credentials (mirror credentials) from SUSE Manager.
Parameters
string sessionKey - Session token, issued at loginstring username - Username of credentials to delete
Return Value
int - 1 on success, exception thrown otherwise.
42.5 listChannelsDescription
List all accessible channels.
310 addCredentials SUSE Manager 24
Parameters
string sessionKey - Session token, issued at login
Return Value
array:
struct - channel
string "arch" - Architecture of the channelstring "description" - Description of the channelstring "family" - Channel family labelboolean "is_signed" - Channel has signed metadatastring "label" - Label of the channelstring "name" - Name of the channelboolean "optional" - Channel is optionalstring "parent" - The label of the parent channelstring "product_name" - Product namestring "product_version" - Product versionstring "source_url" - Repository source URLstring "status" - Status: available, unavailable or installedstring "summary" - Channel summarystring "update_tag" - Update tagboolean "installer_updates" - is an installer update channel
42.6 listCredentialsDescription
List organization credentials (mirror credentials) available in SUSE Manager.
Parameters
string sessionKey - Session token, issued at login
Return Value
array:
struct - credentials
311 listCredentials SUSE Manager 24
int "id" - ID of the credentialsstring "user" - usernameboolean "isPrimary" - primary
42.7 listProductsDescription
List all accessible products.
Parameters
string sessionKey - Session token, issued at login
Return Value
array:
struct - product
string "friendly_name" - Friendly name of the productstring "arch" - Architecturestring "status" - 'available', 'unavailable' or 'installed'array:
struct - channel
string "arch" - Architecture of the channelstring "description" - Description of the channelstring "family" - Channel family labelboolean "is_signed" - Channel has signed metadatastring "label" - Label of the channelstring "name" - Name of the channelboolean "optional" - Channel is optionalstring "parent" - The label of the parent channelstring "product_name" - Product namestring "product_version" - Product versionstring "source_url" - Repository source URLstring "status" - Status: available, unavailable or installed
312 listProducts SUSE Manager 24
string "summary" - Channel summary
string "update_tag" - Update tag
boolean "installer_updates" - is an installer update channel
array:
struct - extension product
string "friendly_name" - Friendly name of extension product
string "arch" - Architecture
string "status" - 'available', 'unavailable' or 'installed'
array:
struct - channel
string "arch" - Architecture of the channel
string "description" - Description of the channel
string "family" - Channel family label
boolean "is_signed" - Channel has signed metadata
string "label" - Label of the channel
string "name" - Name of the channel
boolean "optional" - Channel is optional
string "parent" - The label of the parent channel
string "product_name" - Product name
string "product_version" - Product version
string "source_url" - Repository source URL
string "status" - Status: available, unavailable orinstalled
string "summary" - Channel summary
string "update_tag" - Update tag
boolean "installer_updates" - is an installer updatechannel
boolean "recommended" - Recommended
42.8 synchronizeChannelFamilies
Description
313 synchronizeChannelFamilies SUSE Manager 24
Synchronize channel families between the Customer Center and the SUSE Managerdatabase.
Parameters
string sessionKey - Session token, issued at login
Return Value
int - 1 on success, exception thrown otherwise.
42.9 synchronizeChannelsDescription
(Deprecated) Synchronize channels between the Customer Center and the SUSE Managerdatabase.
Parameters
string sessionKey - Session token, issued at loginstring mirrorUrl - Sync from mirror temporarily
Return Value
int - 1 on success, exception thrown otherwise.
42.10 synchronizeProductChannelsDescription
(Deprecated) Synchronize SUSE product channels between the Customer Center and theSUSE Manager database.Deprecated - Synchronize SUSE product channels between the Customer Center and theSUSE Manager database. This method is one step of the whole refresh cycle.
Parameters
string sessionKey - Session token, issued at login
Return Value
314 synchronizeChannels SUSE Manager 24
int - 1 on success, exception thrown otherwise.
42.11 synchronizeProductsDescription
Synchronize SUSE products between the Customer Center and the SUSE Manager database.
Parameters
string sessionKey - Session token, issued at login
Return Value
int - 1 on success, exception thrown otherwise.
42.12 synchronizeRepositoriesDescription
Synchronize repositories between the Customer Center and the SUSE Manager database.
Parameters
string sessionKey - Session token, issued at loginstring mirrorUrl - Optional mirror url or null
Return Value
int - 1 on success, exception thrown otherwise.
42.13 synchronizeSubscriptionsDescription
Synchronize subscriptions between the Customer Center and the SUSE Manager database.
Parameters
string sessionKey - Session token, issued at login
Return Value
315 synchronizeProducts SUSE Manager 24
int - 1 on success, exception thrown otherwise.
316 synchronizeSubscriptions SUSE Manager 24
43 sync.master
Contains methods to set up information about known-"masters", for use on the"slave" side of ISS
43.1 addToMaster
Description
Add a single organizations to the list of those the specied Master has exported to this Slave
Parameters
string sessionKeyint id - Id of the desired Masterstruct - master-org details
int "masterOrgId"string "masterOrgName"int "localOrgId"
Return Value
int - 1 on success, exception thrown otherwise.
43.2 create
Description
Create a new Master, known to this Slave.
Parameters
string sessionKeystring label - Master's fully-qualied domain name
Return Value
struct - IssMaster info
317 addToMaster SUSE Manager 24
int "id"
string "label"
string "caCert"
boolean "isCurrentMaster"
43.3 delete
Description
Remove the specied Master
Parameters
string sessionKey
int id - Id of the Master to remove
Return Value
int - 1 on success, exception thrown otherwise.
43.4 getDefaultMaster
Description
Return the current default-Master for this Slave
Parameters
string sessionKey
Return Value
struct - IssMaster info
int "id"
string "label"
318 delete SUSE Manager 24
string "caCert"boolean "isCurrentMaster"
43.5 getMaster
Description
Find a Master by specifying its ID
Parameters
string sessionKeyint id - Id of the desired Master
Return Value
struct - IssMaster info
int "id"string "label"string "caCert"boolean "isCurrentMaster"
43.6 getMasterByLabel
Description
Find a Master by specifying its label
Parameters
string sessionKeystring label - Label of the desired Master
Return Value
struct - IssMaster info
int "id"string "label"
319 getMaster SUSE Manager 24
string "caCert"boolean "isCurrentMaster"
43.7 getMasterOrgsDescription
List all organizations the specied Master has exported to this Slave
Parameters
string sessionKeyint id - Id of the desired Master
Return Value
array:
struct - IssMasterOrg info
int "masterOrgId"string "masterOrgName"int "localOrgId"
43.8 getMastersDescription
Get all the Masters this Slave knows about
Parameters
string sessionKey
Return Value
array:
struct - IssMaster info
int "id"string "label"
320 getMasterOrgs SUSE Manager 24
string "caCert"
boolean "isCurrentMaster"
43.9 hasMaster
Description
Check if this host is reading conguration from an ISS master.
Parameters
None
Return Value
boolean master - True if has an ISS master, false otherwise
43.10 makeDefault
Description
Make the specied Master the default for this Slave's inter-server-sync
Parameters
string sessionKey
int id - Id of the Master to make the default
Return Value
int - 1 on success, exception thrown otherwise.
43.11 mapToLocal
Description
Add a single organizations to the list of those the specied Master has exported to this Slave
Parameters
321 hasMaster SUSE Manager 24
string sessionKey
int masterId - Id of the desired Master
int masterOrgId - Id of the desired Master
int localOrgId - Id of the desired Master
Return Value
int - 1 on success, exception thrown otherwise.
43.12 setCaCert
Description
Set the CA-CERT lename for specied Master on this Slave
Parameters
string sessionKey
int id - Id of the Master to aect
string caCertFilename - path to specied Master's CA cert
Return Value
int - 1 on success, exception thrown otherwise.
43.13 setMasterOrgs
Description
Reset all organizations the specied Master has exported to this Slave
Parameters
string sessionKey
int id - Id of the desired Master
array:
struct - master-org details
322 setCaCert SUSE Manager 24
int "masterOrgId"string "masterOrgName"int "localOrgId"
Return Value
int - 1 on success, exception thrown otherwise.
43.14 unsetDefaultMaster
Description
Make this slave have no default Master for inter-server-sync
Parameters
string sessionKey
Return Value
int - 1 on success, exception thrown otherwise.
43.15 update
Description
Updates the label of the specied Master
Parameters
string sessionKeyint id - Id of the Master to updatestring label - Desired new label
Return Value
struct - IssMaster info
int "id"string "label"
323 unsetDefaultMaster SUSE Manager 24
string "caCert"boolean "isCurrentMaster"
324 update SUSE Manager 24
44 sync.slave
Contains methods to set up information about allowed-"slaves", for use on the"master" side of ISS
44.1 create
Description
Create a new Slave, known to this Master.
Parameters
string sessionKey
string slave - Slave's fully-qualied domain name
boolean enabled - Let this slave talk to us?
boolean allowAllOrgs - Export all our orgs to this slave?
Return Value
struct - IssSlave info
int "id"
string "slave"
boolean "enabled"
boolean "allowAllOrgs"
44.2 delete
Description
Remove the specied Slave
Parameters
string sessionKey
int id - Id of the Slave to remove
325 create SUSE Manager 24
Return Value
int - 1 on success, exception thrown otherwise.
44.3 getAllowedOrgs
Description
Get all orgs this Master is willing to export to the specied Slave
Parameters
string sessionKey
int id - Id of the desired Slave
Return Value
array:
int - ids of allowed organizations
44.4 getSlave
Description
Find a Slave by specifying its ID
Parameters
string sessionKey
int id - Id of the desired Slave
Return Value
struct - IssSlave info
int "id"
string "slave"
326 getAllowedOrgs SUSE Manager 24
boolean "enabled"boolean "allowAllOrgs"
44.5 getSlaveByNameDescription
Find a Slave by specifying its Fully-Qualied Domain Name
Parameters
string sessionKeystring fqdn - Domain-name of the desired Slave
Return Value
struct - IssSlave info
int "id"string "slave"boolean "enabled"boolean "allowAllOrgs"
44.6 getSlavesDescription
Get all the Slaves this Master knows about
Parameters
string sessionKey
Return Value
array:
struct - IssSlave info
int "id"string "slave"
327 getSlaveByName SUSE Manager 24
boolean "enabled"boolean "allowAllOrgs"
44.7 setAllowedOrgsDescription
Set the orgs this Master is willing to export to the specied Slave
Parameters
string sessionKeyint id - Id of the desired Slavearray:
int - List of org-ids we're willing to export
Return Value
int - 1 on success, exception thrown otherwise.
44.8 updateDescription
Updates attributes of the specied Slave
Parameters
string sessionKeyint id - Id of the Slave to updatestring slave - Slave's fully-qualied domain nameboolean enabled - Let this slave talk to us?boolean allowAllOrgs - Export all our orgs to this Slave?
Return Value
struct - IssSlave info
int "id"string "slave"
328 setAllowedOrgs SUSE Manager 24
boolean "enabled"boolean "allowAllOrgs"
329 update SUSE Manager 24
45 system
Provides methods to access and modify registered system.
45.1 addEntitlements
Description
Add entitlements to a server. Entitlements a server already has are quietly ignored.
Parameters
string sessionKey
int serverId
array:
string - entitlementLabel - one of following: virtualization_host,enterprise_entitled
Return Value
int - 1 on success, exception thrown otherwise.
45.2 addNote
Description
Add a new note to the given server.
Parameters
string sessionKey
int serverId
string subject - What the note is about.
string body - Content of the note.
Return Value
330 addEntitlements SUSE Manager 24
int - 1 on success, exception thrown otherwise.
45.3 applyErrata
Description
Schedules an action to apply errata updates to a system.Deprecated - being replaced by system.scheduleApplyErrata(string sessionKey, intserverId, array[int errataId])
Parameters
string sessionKeyint serverIdarray:
int - errataId
Return Value
int - 1 on success, exception thrown otherwise.
45.4 bootstrap
Description
Bootstrap a system for management via either Salt or Salt SSH.
Parameters
string sessionKeystring host - Hostname or IP address of targetint sshPort - SSH port on target machinestring sshUser - SSH user on target machinestring sshPassword - SSH password of given userstring activationKey - Activation keyboolean saltSSH - Manage system with Salt SSH
Return Value
331 applyErrata SUSE Manager 24
int - 1 on success, exception thrown otherwise.
45.5 bootstrapDescription
Bootstrap a system for management via either Salt or Salt SSH.
Parameters
string sessionKeystring host - Hostname or IP address of targetint sshPort - SSH port on target machinestring sshUser - SSH user on target machinestring sshPassword - SSH password of given userstring activationKey - Activation keyint proxyId - System ID of proxy to useboolean saltSSH - Manage system with Salt SSH
Return Value
int - 1 on success, exception thrown otherwise.
45.6 bootstrapWithPrivateSshKeyDescription
Bootstrap a system for management via either Salt or Salt SSH. Use SSH private key forauthentication.
Parameters
string sessionKeystring host - Hostname or IP address of targetint sshPort - SSH port on target machinestring sshUser - SSH user on target machinestring sshPrivKey - SSH private key as a string in PEM formatstring sshPrivKeyPass - SSH passphrase for the key (use empty string for nopassphrase)
332 bootstrap SUSE Manager 24
string activationKey - Activation keyboolean saltSSH - Manage system with Salt SSH
Return Value
int - 1 on success, exception thrown otherwise.
45.7 bootstrapWithPrivateSshKey
Description
Bootstrap a system for management via either Salt or Salt SSH. Use SSH private key forauthentication.
Parameters
string sessionKeystring host - Hostname or IP address of targetint sshPort - SSH port on target machinestring sshUser - SSH user on target machinestring sshPrivKey - SSH private key as a string in PEM formatstring sshPrivKeyPass - SSH passphrase for the key (use empty string for nopassphrase)string activationKey - Activation keyint proxyId - System ID of proxy to useboolean saltSSH - Manage system with Salt SSH
Return Value
int - 1 on success, exception thrown otherwise.
45.8 comparePackageProfile
Description
Compare a system's packages against a package prole. In the result returned, 'this_system'represents the server provided as an input and 'other_system' represents the proleprovided as an input.
333 bootstrapWithPrivateSshKey SUSE Manager 24
Parameters
string sessionKey
int serverId
string proleLabel
Return Value
array:
struct - Package Metadata
int "package_name_id"
string "package_name"
string "package_epoch"
string "package_version"
string "package_release"
string "package_arch"
string "this_system" - Version of package on this system.
string "other_system" - Version of package on the other system.
int "comparison"
0 - No dierence.
1 - Package on this system only.
2 - Newer package version on this system.
3 - Package on other system only.
4 - Newer package version on other system.
45.9 comparePackages
Description
Compares the packages installed on two systems.
Parameters
string sessionKey
int thisServerId
int otherServerId
334 comparePackages SUSE Manager 24
Return Value
array:
struct - Package Metadata
int "package_name_id"
string "package_name"
string "package_epoch"
string "package_version"
string "package_release"
string "package_arch"
string "this_system" - Version of package on this system.
string "other_system" - Version of package on the other system.
int "comparison"
0 - No dierence.
1 - Package on this system only.
2 - Newer package version on this system.
3 - Package on other system only.
4 - Newer package version on other system.
45.10 createPackageProfile
Description
Create a new stored Package Prole from a systems installed package list.
Parameters
string sessionKey
int serverId
string proleLabel
string description
Return Value
335 createPackageProfile SUSE Manager 24
int - 1 on success, exception thrown otherwise.
45.11 createSystemProfile
Description
Creates a system record in database for a system that is not registered. Either "hwAddress"or "hostname" prop must be specied in the "data" struct. If a system(s) matching givendata exists, a SystemsExistFaultException is thrown which contains matching system IDsin its message.
Parameters
string sessionKey
string systemName - System name
struct - data
string "hwAddress" - The HW address of the network interface (MAC)
string "hostname" - The hostname of the prole
Return Value
int systemId - The id of the created system
45.12 createSystemRecord
Description
Creates a cobbler system record with the specied kickstart label
Parameters
string sessionKey
int serverId
string ksLabel
Return Value
336 createSystemProfile SUSE Manager 24
int - 1 on success, exception thrown otherwise.
45.13 createSystemRecord
Description
Creates a cobbler system record for a system that is not registered.
Parameters
string sessionKey
string sysName
string ksLabel
string kOptions
string comment
array:
struct - network device
string "name"
string "mac"
string "ip"
string "dnsname"
Return Value
int - 1 on success, exception thrown otherwise.
45.14 deleteCustomValues
Description
Delete the custom values dened for the custom system information keys provided fromthe given system. (Note: Attempt to delete values of non-existing keys throws exception.Attempt to delete value of existing key which has assigned no values doesn't throwexception.)
Parameters
337 createSystemRecord SUSE Manager 24
string sessionKey
int serverId
array:
string - customInfoLabel
Return Value
int - 1 on success, exception thrown otherwise.
45.15 deleteGuestProfiles
Description
Delete the specied list of guest proles for a given host
Parameters
string sessionKey
int hostId
array:
string - guestNames
Return Value
int - 1 on success, exception thrown otherwise.
45.16 deleteNote
Description
Deletes the given note from the server.
Parameters
string sessionKey
int serverId
int noteId
338 deleteGuestProfiles SUSE Manager 24
Return Value
int - 1 on success, exception thrown otherwise.
45.17 deleteNotes
Description
Deletes all notes from the server.
Parameters
string sessionKey
int serverId
Return Value
int - 1 on success, exception thrown otherwise.
45.18 deletePackageProfile
Description
Delete a package prole
Parameters
string sessionKey
int proleId
Return Value
int - 1 on success, exception thrown otherwise.
45.19 deleteSystem
Description
Delete a system given its client certicate.
339 deleteNotes SUSE Manager 24
Available since API version: 10.10
Parameters
string systemid - systemid le
Return Value
int - 1 on success, exception thrown otherwise.
45.20 deleteSystem
Description
Delete a system given its server id synchronously without cleanup
Parameters
string sessionKeyint serverId
Return Value
int - 1 on success, exception thrown otherwise.
45.21 deleteSystem
Description
Delete a system given its server id synchronously
Parameters
string sessionKeyint serverIdstring cleanupType - Possible values: 'FAIL_ON_CLEANUP_ERR' - fail in case ofcleanup error, 'NO_CLEANUP' - do not cleanup, just delete, 'FORCE_DELETE' - Trycleanup rst but delete server anyway in case of error
Return Value
340 deleteSystem SUSE Manager 24
int - 1 on success, exception thrown otherwise.
45.22 deleteSystems
Description
Delete systems given a list of system ids asynchronously.
Parameters
string sessionKey
array:
int - serverId
Return Value
int - 1 on success, exception thrown otherwise.
45.23 deleteSystems
Description
Delete systems given a list of system ids asynchronously.
Parameters
string sessionKey
array:
int - serverId
string cleanupType - Possible values: 'FAIL_ON_CLEANUP_ERR' - fail in case ofcleanup error, 'NO_CLEANUP' - do not cleanup, just delete, 'FORCE_DELETE' - Trycleanup rst but delete server anyway in case of error
Return Value
341 deleteSystems SUSE Manager 24
int - 1 on success, exception thrown otherwise.
45.24 deleteTagFromSnapshot
Description
Deletes tag from system snapshot
Parameters
string sessionKey
int serverId
string tagName
Return Value
int - 1 on success, exception thrown otherwise.
45.25 downloadSystemId
Description
Get the system ID le for a given server.
Parameters
string sessionKey
int serverId
Return Value
string id
45.26 getConnectionPath
Description
Get the list of proxies that the given system connects through in order to reach the server.
342 deleteTagFromSnapshot SUSE Manager 24
Parameters
string sessionKey
int serverId
Return Value
array:
struct - proxy connection path details
int "position" - Position of proxy in chain. The proxy that the systemconnects directly to is listed in position 1.
int "id" - Proxy system id
string "hostname" - Proxy host name
45.27 getCpu
Description
Gets the CPU information of a system.
Parameters
string sessionKey
int serverId
Return Value
struct - CPU
string "cache"
string "family"
string "mhz"
string "ags"
string "model"
string "vendor"
string "arch"
string "stepping"
343 getCpu SUSE Manager 24
string "count"int "socket_count (if available)"
45.28 getCustomValues
Description
Get the custom data values dened for the server.
Parameters
string sessionKeyint serverId
Return Value
struct - custom value
string "custom info label"
45.29 getDetails
Description
Get system details.
Parameters
string sessionKeyint serverId
Return Value
struct - server details
int "id" - System idstring "prole_name"string "machine_id"string "minion_id"string "base_entitlement" - System's base entitlement label
344 getCustomValues SUSE Manager 24
array "string"
addon_entitlements - System's addon entitlements labels, currently only'virtualization_host'
boolean "auto_update" - True if system has auto errata updates enabled.string "release" - The Operating System release (i.e. 4AS, 5Serverstring "address1"string "address2"string "city"string "state"string "country"string "building"string "room"string "rack"string "description"string "hostname"dateTime.iso8601 "last_boot"string "osa_status" - Either 'unknown', 'oine', or 'online'.boolean "lock_status" - True indicates that the system is locked. False indicatesthat the system is unlocked.string "virtualization" - Virtualization type - for virtual guests only (optional)string "contact_method" - One of the following:
defaultssh-pushssh-push-tunnel
45.30 getDevicesDescription
Gets a list of devices for a system.
Parameters
string sessionKeyint serverId
Return Value
345 getDevices SUSE Manager 24
array:
struct - device
string "device" - optionalstring "device_class" - Includes CDROM, FIREWIRE, HD, USB, VIDEO,OTHER, etc.string "driver"string "description"string "bus"string "pcitype"
45.31 getDmiDescription
Gets the DMI information of a system.
Parameters
string sessionKeyint serverId
Return Value
struct - DMI
string "vendor"string "system"string "product"string "asset"string "board"string "bios_release" - (optional)string "bios_vendor" - (optional)string "bios_version" - (optional)
45.32 getEntitlementsDescription
346 getDmi SUSE Manager 24
Gets the entitlements for a given server.
Parameters
string sessionKeyint serverId
Return Value
array:
string - entitlement_label
45.33 getEventHistoryDescription
Returns a list history items associated with the system, ordered from newest tooldest. Note that the details may be empty for events that were scheduled againstthe system (as compared to instant). For more information on such events, see thesystem.listSystemEvents operation.
Parameters
string sessionKeyint serverId
Return Value
array:
struct - History Event
dateTime.iso8601 "completed" - Date that the event occurred (optional)string "summary" - Summary of the eventstring "details" - Details of the event
45.34 getIdDescription
347 getEventHistory SUSE Manager 24
Get system IDs and last check in information for the given system name.
Parameters
string sessionKeystring systemName
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked indateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot timeint "extra_pkg_count" - Number of packages not belonging to any assignedchannelint "outdated_pkg_count" - Number of out-of-date packages
45.35 getInstalledProducts
Description
Get a list of installed products for given system
Parameters
User loggedInUserint serverId
Return Value
array:
struct - installed product
string "name"boolean "isBaseProduct"
348 getInstalledProducts SUSE Manager 24
string "version" - returned only if applies
string "arch" - returned only if applies
string "release" - returned only if applies
string "friendlyName" - returned only if available
45.36 getKernelLivePatch
Description
Returns the currently active kernel live patching version relative to the running kernelversion of the system, or empty string if live patching feature is not in use for the givensystem.
Parameters
string sessionKey
int serverId
Return Value
string
45.37 getMemory
Description
Gets the memory information for a system.
Parameters
string sessionKey
int serverId
Return Value
struct - memory
349 getKernelLivePatch SUSE Manager 24
int "ram" - The amount of physical memory in MB.
int "swap" - The amount of swap space in MB.
45.38 getMinionIdMap
Description
Return a map from Salt minion IDs to System IDs. Map entries are limited to systems thatare visible by the current user.
Parameters
string sessionKey
Return Value
map id_map - minion IDs to system IDs
45.39 getName
Description
Get system name and last check in information for the given system ID.
Parameters
string sessionKey
string serverId
Return Value
struct - name info
350 getMinionIdMap SUSE Manager 24
int "id" - Server idstring "name" - Server namedateTime.iso8601 "last_checkin" - Last time server successfully checked in
45.40 getNetwork
Description
Get the addresses and hostname for a given server.
Parameters
string sessionKeyint serverId
Return Value
struct - network info
string "ip" - IPv4 address of serverstring "ip6" - IPv6 address of serverstring "hostname" - Hostname of server
45.41 getNetworkDevices
Description
Returns the network devices for the given server.
Parameters
string sessionKeyint serverId
Return Value
array:
struct - network device
351 getNetwork SUSE Manager 24
string "ip" - IP address assigned to this network device
string "interface" - Network interface assigned to device e.g. eth0
string "netmask" - Network mask assigned to device
string "hardware_address" - Hardware Address of device.
string "module" - Network driver used for this device.
string "broadcast" - Broadcast address for device.
array "ipv6" - List of IPv6 addresses
array:
struct - ipv6 address
string "address" - IPv6 address of this network device
string "netmask" - IPv6 netmask of this network device
string "scope" - IPv6 address scope
array "ipv4" - List of IPv4 addresses
array:
struct - ipv4 address
string "address" - IPv4 address of this network device
string "netmask" - IPv4 netmask of this network device
string "broadcast" - IPv4 broadcast address of this networkdevice
45.42 getNetworkForSystems
Description
Get the addresses and hostname for a given list of systems.
Parameters
string sessionKey
array:
int - systemIDs
Return Value
352 getNetworkForSystems SUSE Manager 24
array:
struct - network info
int "system_id" - ID of the systemstring "ip" - IPv4 address of systemstring "ip6" - IPv6 address of systemstring "hostname" - Hostname of system
45.43 getOsaPingDescription
get details about a ping sent to a system using OSA
Parameters
User loggedInUserint serverId
Return Value
struct - osaPing
string "state" - state of the system (unknown, online, oine)dateTime.iso8601 "lastMessageTime" - time of the last received response(1970/01/01 00:00:00 if never received a response)dateTime.iso8601 "lastPingTime" - time of the last sent ping (1970/01/0100:00:00 if no ping is pending
45.44 getRegistrationDateDescription
Returns the date the system was registered.
Parameters
string sessionKeyint serverId
353 getOsaPing SUSE Manager 24
Return Value
dateTime.iso8601 date - The date the system was registered, in local time
45.45 getRelevantErrata
Description
Returns a list of all errata that are relevant to the system.
Parameters
string sessionKey
int serverId
Return Value
array:
struct - errata
int "id" - Errata ID.
string "issue_date" - Date erratum was updated. (Deprecated)
string "date" - Date erratum was created. (Deprecated)
string "update_date" - Date erratum was updated. (Deprecated)
string "advisory_synopsis" - Summary of the erratum.
string "advisory_type" - Type label such as Security, Bug Fix
string "advisory_status" - Status label such as nal, testing, retracted
string "advisory_name" - Name such as RHSA, etc
45.46 getRelevantErrataByType
Description
Returns a list of all errata of the specied type that are relevant to the system.
Parameters
354 getRelevantErrata SUSE Manager 24
string sessionKeyint serverIdstring advisoryType - type of advisory (one of of the following: 'Security Advisory','Product Enhancement Advisory', 'Bug Fix Advisory'
Return Value
array:
struct - errata
int "id" - Errata ID.string "issue_date" - Date erratum was updated. (Deprecated)string "date" - Date erratum was created. (Deprecated)string "update_date" - Date erratum was updated. (Deprecated)string "advisory_synopsis" - Summary of the erratum.string "advisory_type" - Type label such as Security, Bug Fixstring "advisory_status" - Status label such as nal, testing, retractedstring "advisory_name" - Name such as RHSA, etc
45.47 getRunningKernel
Description
Returns the running kernel of the given system.
Parameters
string sessionKeyint serverId
Return Value
string kernel
45.48 getScriptActionDetails
Description
355 getRunningKernel SUSE Manager 24
Returns script details for script run actions
Parameters
string sessionKeyint actionId - ID of the script run action.
Return Value
struct - Script details
int "id" - action idstring "content" - script contentstring "run_as_user" - Run as userstring "run_as_group" - Run as groupint "timeout" - Timeout in secondsarray:
struct - script result
int "serverId" - ID of the server the script runs on.dateTime.iso8601 "startDate" - Time script began execution.dateTime.iso8601 "stopDate" - Time script stopped execution.int "returnCode" - Script execution return code.string "output" - Output of the script (base64 encoded according tothe output_enc64 attribute)boolean "output_enc64" - Identies base64 encoded output
45.49 getScriptResults
Description
Fetch results from a script execution. Returns an empty array if no results are yet available.
Parameters
string sessionKeyint actionId - ID of the script run action.
Return Value
356 getScriptResults SUSE Manager 24
array:
struct - script result
int "serverId" - ID of the server the script runs on.dateTime.iso8601 "startDate" - Time script began execution.dateTime.iso8601 "stopDate" - Time script stopped execution.int "returnCode" - Script execution return code.string "output" - Output of the script (base64 encoded according to theoutput_enc64 attribute)boolean "output_enc64" - Identies base64 encoded output
45.50 getSubscribedBaseChannel
Description
Provides the base channel of a given system
Parameters
string sessionKeyint serverId
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"
357 getSubscribedBaseChannel 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:
struct - contentSources
int "id"
string "label"
string "sourceUrl"
string "type"
45.51 getSystemCurrencyMultipliers
Description
Get the System Currency score multipliers
Parameters
string sessionKey
Return Value
map multipliers - Map of score multipliers
45.52 getSystemCurrencyScores
Description
Get the System Currency scores for all servers the user has access to
Parameters
358 getSystemCurrencyMultipliers SUSE Manager 24
string sessionKey
Return Value
array:
struct - system currency
int "sid"
int "critical security errata count"
int "important security errata count"
int "moderate security errata count"
int "low security errata count"
int "bug x errata count"
int "enhancement errata count"
int "system currency score"
45.53 getUnscheduledErrata
Description
Provides an array of errata that are applicable to a given system.
Parameters
string sessionKey
int serverId
Return Value
array:
struct - errata
int "id" - Errata Id
string "date" - Date erratum was created.
string "advisory_type" - Type of the advisory.
string "advisory_status" - Status of the advisory.
359 getUnscheduledErrata SUSE Manager 24
string "advisory_name" - Name of the advisory.string "advisory_synopsis" - Summary of the erratum.
45.54 getUuidDescription
Get the UUID from the given system ID.
Parameters
string sessionKeyint serverId
Return Value
string uuid
45.55 getVariablesDescription
Lists kickstart variables set in the system record for the specied server. Note: Thiscall assumes that a system record exists in cobbler for the given system and will raisean XMLRPC fault if that is not the case. To create a system record over xmlrpc usesystem.createSystemRecord To create a system record in the Web UI please go to System-> <Specied System> -> Provisioning -> Select a Kickstart prole -> Create CobblerSystem Record.
Parameters
string sessionKeyint serverId
Return Value
struct - System kickstart variables
boolean "netboot" - netboot enabledarray "kickstart variables"
360 getUuid SUSE Manager 24
struct - kickstart variable
string "key"
string or int "value"
45.56 isNvreInstalled
Description
Check if the package with the given NVRE is installed on given system.
Parameters
string sessionKey
int serverId
string name - Package name.
string version - Package version.
string release - Package release.
Return Value
int status - 1 if package exists, 0 if not, exception is thrown if an error occurs
45.57 isNvreInstalled
Description
Is the package with the given NVRE installed on given system.
Parameters
string sessionKey
int serverId
string name - Package name.
string version - Package version.
string release - Package release.
string epoch - Package epoch.
361 isNvreInstalled SUSE Manager 24
Return Value
int status - 1 if package exists, 0 if not, exception is thrown if an error occurs
45.58 listActivationKeys
Description
List the activation keys the system was registered with. An empty list will be returned ifan activation key was not used during registration.
Parameters
string sessionKeyint serverId
Return Value
array:
string - key
45.59 listActiveSystems
Description
Returns a list of active servers visible to the user.
Parameters
string sessionKey
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked in
362 listActivationKeys SUSE Manager 24
dateTime.iso8601 "created" - Server registration time
dateTime.iso8601 "last_boot" - Last server boot time
45.60 listActiveSystemsDetails
Description
Given a list of server ids, returns a list of active servers' details visible to the user.
Parameters
string sessionKey
array:
int - serverIds
Return Value
array:
struct - server details
int "id" - The server's id
string "name" - The server's name
string "minion_id" - The server's minion id, in case it is a salt minion client
dateTime.iso8601 "last_checkin" - Last time server successfully checked in(in UTC)
int "ram" - The amount of physical memory in MB.
int "swap" - The amount of swap space in MB.
struct "network_devices" - The server's network devices
struct - network device
string "ip" - IP address assigned to this network device
string "interface" - Network interface assigned to device e.g. eth0
string "netmask" - Network mask assigned to device
string "hardware_address" - Hardware Address of device.
string "module" - Network driver used for this device.
string "broadcast" - Broadcast address for device.
array "ipv6" - List of IPv6 addresses
363 listActiveSystemsDetails SUSE Manager 24
array:
struct - ipv6 address
string "address" - IPv6 address of this network device
string "netmask" - IPv6 netmask of this network device
string "scope" - IPv6 address scope
array "ipv4" - List of IPv4 addresses
array:
struct - ipv4 address
string "address" - IPv4 address of this network device
string "netmask" - IPv4 netmask of this network device
string "broadcast" - IPv4 broadcast address of this networkdevice
struct "dmi_info" - The server's dmi info
struct - DMI
string "vendor"
string "system"
string "product"
string "asset"
string "board"
string "bios_release" - (optional)
string "bios_vendor" - (optional)
string "bios_version" - (optional)
struct "cpu_info" - The server's cpu info
struct - CPU
string "cache"
string "family"
string "mhz"
string "ags"
string "model"
string "vendor"
string "arch"
string "stepping"
364 listActiveSystemsDetails SUSE Manager 24
string "count"
int "socket_count (if available)"
array "subscribed_channels" - List of subscribed channels
array:
struct - channel
int "channel_id" - The channel id.
string "channel_label" - The channel label.
array "active_guest_system_ids" - List of virtual guest system ids for activeguests
array:
int "guest_id" - The guest's system id.
45.61 listAdministrators
Description
Returns a list of users which can administer the system.
Parameters
string sessionKey
int serverId
Return Value
array:
struct - user
int "id"
string "login"
365 listAdministrators SUSE Manager 24
string "login_uc" - upper case version of the loginboolean "enabled" - true if user is enabled, false if the user is disabled
45.62 listAllInstallablePackagesDescription
Get the list of all installable packages for a given system.
Parameters
string sessionKeyint serverId
Return Value
array:
struct - package
string "name"string "version"string "release"string "epoch"int "id"string "arch_label"
45.63 listBaseChannelsDescription
Returns a list of subscribable base channels.Deprecated - being replaced by listSubscribableBaseChannels(string sessionKey, intserverId)
Parameters
string sessionKeyint serverId
Return Value
366 listAllInstallablePackages SUSE Manager 24
array:
struct - channel
int "id" - Base Channel ID.string "name" - Name of channel.string "label" - Label of Channelint "current_base" - 1 indicates it is the current base channel
45.64 listChildChannelsDescription
Returns a list of subscribable child channels. This only shows channels the system is *not*currently subscribed to.Deprecated - being replaced by listSubscribableChildChannels(string sessionKey, intserverId)
Parameters
string sessionKeyint serverId
Return Value
array:
struct - child channel
int "id"string "name"string "label"string "summary"string "has_license"string "gpg_key_url"
45.65 listDuplicatesByHostnameDescription
367 listChildChannels SUSE Manager 24
List duplicate systems by Hostname.
Parameters
string sessionKey
Return Value
array:
struct - Duplicate Group
string "hostname"array "systems"
struct - system
int "systemId"string "systemName"dateTime.iso8601 "last_checkin" - Last time server successfullychecked in
45.66 listDuplicatesByIp
Description
List duplicate systems by IP Address.
Parameters
string sessionKey
Return Value
array:
struct - Duplicate Group
string "ip"array "systems"
struct - system
368 listDuplicatesByIp SUSE Manager 24
int "systemId"string "systemName"dateTime.iso8601 "last_checkin" - Last time server successfullychecked in
45.67 listDuplicatesByMac
Description
List duplicate systems by Mac Address.
Parameters
string sessionKey
Return Value
array:
struct - Duplicate Group
string "mac"array "systems"
struct - system
int "systemId"string "systemName"dateTime.iso8601 "last_checkin" - Last time server successfullychecked in
45.68 listEmptySystemProfiles
Description
Returns a list of empty system proles visible to user (created by the createSystemProlemethod).
Parameters
369 listDuplicatesByMac SUSE Manager 24
string sessionKey
Return Value
array:
struct - system
int "id"
string "name"
dateTime.iso8601 "created" - Server creation time
array "hw_addresses" - HW addresses
array:
string - HW address
45.69 listExtraPackages
Description
List extra packages for a system
Parameters
string sessionKey
int serverId
Return Value
array:
struct - package
string "name"
string "version"
string "release"
string "epoch" - returned only if non-zero
370 listExtraPackages SUSE Manager 24
string "arch"date "installtime" - returned only if known
45.70 listFqdns
Description
Provides a list of FQDNs associated with a system.
Parameters
string sessionKeyint serverId
Return Value
array:
string - fqdn
45.71 listGroups
Description
List the available groups for a given system.
Parameters
string sessionKeyint serverId
Return Value
array:
struct - system group
int "id" - server group idint "subscribed" - 1 if the given server is subscribed to this server group,0 otherwise
371 listFqdns SUSE Manager 24
string "system_group_name" - Name of the server groupstring "sgid" - server group id (Deprecated)
45.72 listInactiveSystemsDescription
Lists systems that have been inactive for the default period of inactivity
Parameters
string sessionKey
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked indateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot time
45.73 listInactiveSystemsDescription
Lists systems that have been inactive for the specied number of days..
Parameters
string sessionKeyint days
Return Value
array:
struct - system
372 listInactiveSystems SUSE Manager 24
int "id"
string "name"
dateTime.iso8601 "last_checkin" - Last time server successfully checked in
dateTime.iso8601 "created" - Server registration time
dateTime.iso8601 "last_boot" - Last server boot time
45.74 listInstalledPackages
Description
List the installed packages for a given system.
Parameters
string sessionKey
int serverId
Return Value
array:
struct - package
string "name"
string "version"
string "release"
string "epoch"
string "arch" - architecture label
date "installtime" - returned only if known
45.75 listLatestAvailablePackage
Description
Get the latest available version of a package for each system
Parameters
373 listInstalledPackages SUSE Manager 24
string sessionKey
array:
int - serverId
string packageName
Return Value
array:
struct - system
int "id" - server ID
string "name" - server name
struct "package" - package structure
struct - package
int "id"
string "name"
string "version"
string "release"
string "epoch"
string "arch"
45.76 listLatestInstallablePackages
Description
Get the list of latest installable packages for a given system.
Parameters
string sessionKey
int serverId
Return Value
array:
struct - package
374 listLatestInstallablePackages SUSE Manager 24
string "name"string "version"string "release"string "epoch"int "id"string "arch_label"
45.77 listLatestUpgradablePackages
Description
Get the list of latest upgradable packages for a given system.
Parameters
string sessionKeyint serverId
Return Value
array:
struct - package
string "name"string "arch"string "from_version"string "from_release"string "from_epoch"string "to_version"string "to_release"string "to_epoch"string "to_package_id"
45.78 listMigrationTargets
Description
375 listLatestUpgradablePackages SUSE Manager 24
List possible migration targets for a system
Parameters
string sessionKey
int serverId
Return Value
array:
struct - migrationtarget
string "ident"
string "friendly"
45.79 listNewerInstalledPackages
Description
Given a package name, version, release, and epoch, returns the list of packages installedon the system w/ the same name that are newer.
Parameters
string sessionKey
int serverId
string name - Package name.
string version - Package version.
string release - Package release.
string epoch - Package epoch.
Return Value
array:
struct - package
string "name"
string "version"
376 listNewerInstalledPackages SUSE Manager 24
string "release"string "epoch"
45.80 listNotes
Description
Provides a list of notes associated with a system.
Parameters
string sessionKeyint serverId
Return Value
array:
struct - note details
int "id"string "subject" - Subject of the notestring "note" - Contents of the noteint "system_id" - The id of the system associated with the notestring "creator" - Creator of the note if exists (optional)date "updated" - Date of the last note update
45.81 listOlderInstalledPackages
Description
Given a package name, version, release, and epoch, returns the list of packages installedon the system with the same name that are older.
Parameters
string sessionKeyint serverIdstring name - Package name.
377 listNotes SUSE Manager 24
string version - Package version.
string release - Package release.
string epoch - Package epoch.
Return Value
array:
struct - package
string "name"
string "version"
string "release"
string "epoch"
45.82 listOutOfDateSystems
Description
Returns list of systems needing package updates.
Parameters
string sessionKey
Return Value
array:
struct - system
int "id"
string "name"
dateTime.iso8601 "last_checkin" - Last time server successfully checked in
dateTime.iso8601 "created" - Server registration time
dateTime.iso8601 "last_boot" - Last server boot time
378 listOutOfDateSystems SUSE Manager 24
int "extra_pkg_count" - Number of packages not belonging to any assignedchannel
int "outdated_pkg_count" - Number of out-of-date packages
45.83 listPackageProfiles
Description
List the package proles in this organization
Parameters
string sessionKey
Return Value
array:
struct - package prole
int "id"
string "name"
string "channel"
45.84 listPackageState
Description
List possible migration targets for a system
Parameters
string sessionKey
int serverId
Return Value
array:
struct - packagestate
379 listPackageProfiles SUSE Manager 24
int "id"string "name"int "state_revision_id" - State revision Idstring "package_state_type_id" - INSTALLED or REMOVEDstring "version_constraint_id" - LATEST or ANY
45.85 listPackages
Description
List the installed packages for a given system. Usage of listInstalledPackages is preferred,as it returns architecture label (not name).Deprecated - This is here for backwards compatibility: The method returns architecturename, whereas the other endpoints return/accept architecture label. Instead of thismethod, use listInstalledPackages preferably.
Parameters
string sessionKeyint serverId
Return Value
array:
struct - package
string "name"string "version"string "release"string "epoch"string "arch" - Architecture namedate "installtime" - returned only if known
45.86 listPackagesFromChannel
Description
380 listPackages SUSE Manager 24
Provides a list of packages installed on a system that are also contained in the givenchannel. The installed package list did not include arch information before RHEL 5, so it isarch unaware. RHEL 5 systems do upload the arch information, and thus are arch aware.
Parameters
string sessionKey
int serverId
string channelLabel
Return Value
array:
struct - package
string "name"
string "version"
string "release"
string "epoch"
int "id"
string "arch_label"
dateTime.iso8601 "last_modied"
string "path" - The path on that le system that the package resides
string "provider" - The provider of the package, determined by the gpgkey it was signed with.
45.87 listPhysicalSystems
Description
Returns a list of all Physical servers visible to the user.
Parameters
string sessionKey
Return Value
381 listPhysicalSystems SUSE Manager 24
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked indateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot timeint "extra_pkg_count" - Number of packages not belonging to any assignedchannelint "outdated_pkg_count" - Number of out-of-date packages
45.88 listSubscribableBaseChannels
Description
Returns a list of subscribable base channels.
Parameters
string sessionKeyint serverId
Return Value
array:
struct - channel
int "id" - Base Channel ID.string "name" - Name of channel.string "label" - Label of Channelint "current_base" - 1 indicates it is the current base channel
45.89 listSubscribableChildChannels
Description
382 listSubscribableBaseChannels SUSE Manager 24
Returns a list of subscribable child channels. This only shows channels the system is *not*currently subscribed to.
Parameters
string sessionKey
int serverId
Return Value
array:
struct - child channel
int "id"
string "name"
string "label"
string "summary"
string "has_license"
string "gpg_key_url"
45.90 listSubscribedChildChannels
Description
Returns a list of subscribed child channels.
Parameters
string sessionKey
int serverId
Return Value
array:
struct - channel
int "id"
string "name"
383 listSubscribedChildChannels SUSE Manager 24
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:
struct - contentSources
int "id"
string "label"
string "sourceUrl"
string "type"
45.91 listSuggestedReboot
Description
List systems that require reboot.
Parameters
string sessionKey
Return Value
384 listSuggestedReboot SUSE Manager 24
array:
struct - system
int "id"
string "name"
45.92 listSystemEvents
Description
List system actions of the specied type that were *scheduled* against the given server."actionType" should be exactly the string returned in the action_type eld from thelistSystemEvents(sessionKey, serverId) method. For example, 'Package Install' or 'Initiate akickstart for a virtual guest.' Note: see also system.getEventHistory method which returnsa history of all events.Available since API version: 10.8
Parameters
string sessionKey
int serverId - ID of system.
string actionType - Type of the action.
Return Value
array:
struct - action
int "failed_count" - Number of times action failed.
string "modied" - Date modied. (Deprecated by modied_date)
dateTime.iso8601 "modied_date" - Date modied.
string "created" - Date created. (Deprecated by created_date)
dateTime.iso8601 "created_date" - Date created.
string "action_type"
int "successful_count" - Number of times action was successful.
string "earliest_action" - Earliest date this action will occur.
int "archived" - If this action is archived. (1 or 0)
385 listSystemEvents SUSE Manager 24
string "scheduler_user" - available only if concrete user has scheduled theaction
string "prerequisite" - Pre-requisite action. (optional)
string "name" - Name of this action.
int "id" - Id of this action.
string "version" - Version of action.
string "completion_time" - The date/time the event was completed. Format->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional)(Deprecated by completed_date)
dateTime.iso8601 "completed_date" - The date/time the event wascompleted. (optional)
string "pickup_time" - The date/time the action was picked up. Format->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional)(Deprecated by pickup_date)
dateTime.iso8601 "pickup_date" - The date/time the action was picked up.(optional)
string "result_msg" - The result string after the action executes at the clientmachine. (optional)
array "additional_info" - This array contains additional information for theevent, if available.
struct - info
string "detail" - The detail provided depends on the specicevent. For example, for a package event, this will be thepackage name, for an errata event, this will be the advisoryname and synopsis, for a cong le event, this will be path andoptional revision information...etc.
string "result" - The result (if included) depends on the specicevent. For example, for a package or errata event, no result isincluded, for a cong le event, the result might include an
386 listSystemEvents SUSE Manager 24
error (if one occurred, such as the le was missing) or in thecase of a cong le comparison it might include the dierenesfound.
45.93 listSystemEvents
Description
List all system actions that were *scheduled* against the given server. This may requirethe caller to lter the result to fetch actions with a specic action type or to use theoverloaded system.listSystemEvents method with actionType as a parameter. Note: seealso system.getEventHistory method which returns a history of all events.Available since API version: 10.8
Parameters
string sessionKey
int serverId - ID of system.
Return Value
array:
struct - action
int "failed_count" - Number of times action failed.
string "modied" - Date modied. (Deprecated by modied_date)
dateTime.iso8601 "modied_date" - Date modied.
string "created" - Date created. (Deprecated by created_date)
dateTime.iso8601 "created_date" - Date created.
string "action_type"
int "successful_count" - Number of times action was successful.
string "earliest_action" - Earliest date this action will occur.
int "archived" - If this action is archived. (1 or 0)
string "scheduler_user" - available only if concrete user has scheduled theaction
string "prerequisite" - Pre-requisite action. (optional)
string "name" - Name of this action.
387 listSystemEvents SUSE Manager 24
int "id" - Id of this action.string "version" - Version of action.string "completion_time" - The date/time the event was completed. Format->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional)(Deprecated by completed_date)dateTime.iso8601 "completed_date" - The date/time the event wascompleted. (optional)string "pickup_time" - The date/time the action was picked up. Format->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional)(Deprecated by pickup_date)dateTime.iso8601 "pickup_date" - The date/time the action was picked up.(optional)string "result_msg" - The result string after the action executes at the clientmachine. (optional)array "additional_info" - This array contains additional information for theevent, if available.
struct - info
string "detail" - The detail provided depends on the specicevent. For example, for a package event, this will be thepackage name, for an errata event, this will be the advisoryname and synopsis, for a cong le event, this will be path andoptional revision information...etc.string "result" - The result (if included) depends on the specicevent. For example, for a package or errata event, no result isincluded, for a cong le event, the result might include anerror (if one occurred, such as the le was missing) or in thecase of a cong le comparison it might include the dierenesfound.
45.94 listSystemGroupsForSystemsWithEntitlement
Description
Returns the groups information a system is member of, for all the systems visible to thepassed user and that are entitled with the passed entitlement.
388 listSystemGroupsForSystemsWithEntitlement SUSE Manager 24
Parameters
string sessionKey
string entitlement
Return Value
array:
struct - system
int "id" - system ID
array "system_groups"
struct - system_group
int "id" - system group ID
string "name" - system group name
45.95 listSystems
Description
Returns a list of all servers visible to the user.
Parameters
string sessionKey
Return Value
array:
struct - system
int "id"
string "name"
dateTime.iso8601 "last_checkin" - Last time server successfully checked in
389 listSystems SUSE Manager 24
dateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot time
45.96 listSystemsWithExtraPackagesDescription
List systems with extra packages
Parameters
string sessionKey
Return Value
array:
struct - system
int "id" - System IDstring "name" - System prole nameint "extra_pkg_count" - Extra packages count
45.97 listSystemsWithPackageDescription
Lists the systems that have the given installed package
Parameters
string sessionKeyint pid - the package id
Return Value
array:
struct - system
int "id"string "name"
390 listSystemsWithExtraPackages SUSE Manager 24
dateTime.iso8601 "last_checkin" - Last time server successfully checked indateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot timeint "extra_pkg_count" - Number of packages not belonging to any assignedchannelint "outdated_pkg_count" - Number of out-of-date packages
45.98 listSystemsWithPackageDescription
Lists the systems that have the given installed package
Parameters
string sessionKeystring name - the package namestring version - the package versionstring release - the package release
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked indateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot timeint "extra_pkg_count" - Number of packages not belonging to any assignedchannelint "outdated_pkg_count" - Number of out-of-date packages
45.99 listUngroupedSystemsDescription
391 listSystemsWithPackage SUSE Manager 24
List systems that are not associated with any system groups.
Parameters
string sessionKey
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked indateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot timeint "extra_pkg_count" - Number of packages not belonging to any assignedchannelint "outdated_pkg_count" - Number of out-of-date packages
45.100 listUserSystems
Description
List systems for a given user.
Parameters
string sessionKeystring login - User's login name.
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked in
392 listUserSystems SUSE Manager 24
dateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot time
45.101 listUserSystemsDescription
List systems for the logged in user.
Parameters
string sessionKey
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked indateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot time
45.102 listVirtualGuestsDescription
Lists the virtual guests for a given virtual host
Parameters
string sessionKeyint sid - the virtual host's id
Return Value
array:
struct - virtual system
393 listUserSystems SUSE Manager 24
int "id"string "name"string "guest_name" - The virtual guest name as provided by the virtualhostdateTime.iso8601 "last_checkin" - Last time server successfully checked in.string "uuid"
45.103 listVirtualHostsDescription
Lists the virtual hosts visible to the user
Parameters
string sessionKey
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked indateTime.iso8601 "created" - Server registration timedateTime.iso8601 "last_boot" - Last server boot timeint "extra_pkg_count" - Number of packages not belonging to any assignedchannelint "outdated_pkg_count" - Number of out-of-date packages
45.104 obtainReactivationKeyDescription
Obtains a reactivation key for this server.
Parameters
394 listVirtualHosts SUSE Manager 24
string sessionKeyint serverId
Return Value
string key
45.105 obtainReactivationKeyDescription
Obtains a reactivation key for this server.Available since API version: 10.10
Parameters
string systemid - systemid le
Return Value
string key
45.106 provisionSystemDescription
Provision a system using the specied kickstart/autoinstallation prole.
Parameters
string sessionKeyint serverId - ID of the system to be provisioned.string proleName - Prole to use.
Return Value
int id - ID of the action scheduled, otherwise exception thrown on error
45.107 provisionSystemDescription
395 obtainReactivationKey SUSE Manager 24
Provision a system using the specied kickstart/autoinstallation prole.
Parameters
string sessionKeyint serverId - ID of the system to be provisioned.string proleName - Prole to use.dateTime.iso8601 earliestDate
Return Value
int id - ID of the action scheduled, otherwise exception thrown on error
45.108 provisionVirtualGuest
Description
Provision a guest on the host specied. Defaults to: memory=512MB, vcpu=1,storage=3GB, mac_address=random.
Parameters
string sessionKeyint serverId - ID of host to provision guest on.string guestNamestring proleName - Kickstart prole to use.
Return Value
int - 1 on success, exception thrown otherwise.
45.109 provisionVirtualGuest
Description
Provision a guest on the host specied. This schedules the guest for creation and willbegin the provisioning process when the host checks in or if OSAD is enabled will beginimmediately. Defaults to mac_address=random.
Parameters
396 provisionVirtualGuest SUSE Manager 24
string sessionKeyint serverId - ID of host to provision guest on.string guestNamestring proleName - Kickstart Prole to use.int memoryMb - Memory to allocate to the guestint vcpus - Number of virtual CPUs to allocate to the guest.int storageGb - Size of the guests disk image.
Return Value
int - 1 on success, exception thrown otherwise.
45.110 provisionVirtualGuestDescription
Provision a guest on the host specied. This schedules the guest for creation and willbegin the provisioning process when the host checks in or if OSAD is enabled will beginimmediately.
Parameters
string sessionKeyint serverId - ID of host to provision guest on.string guestNamestring proleName - Kickstart Prole to use.int memoryMb - Memory to allocate to the guestint vcpus - Number of virtual CPUs to allocate to the guest.int storageGb - Size of the guests disk image.string macAddress - macAddress to give the guest's virtual networking hardware.
Return Value
int - 1 on success, exception thrown otherwise.
45.111 removeEntitlementsDescription
397 provisionVirtualGuest SUSE Manager 24
Remove addon entitlements from a server. Entitlements a server does not have are quietlyignored.
Parameters
string sessionKeyint serverIdarray:
string - entitlement_label
Return Value
int - 1 on success, exception thrown otherwise.
45.112 scheduleApplyErrataDescription
Schedules an action to apply errata updates to multiple systems.Available since API version: 13.0
Parameters
string sessionKeyarray:
int - serverIdarray:
int - errataId
Return Value
array:
int - actionId
45.113 scheduleApplyErrataDescription
398 scheduleApplyErrata SUSE Manager 24
Schedules an action to apply errata updates to multiple systems.Available since API version: 21
Parameters
string sessionKey
array:
int - serverId
array:
int - errataId
boolean allowModules - Allow this API call, despite modular content being present
Return Value
array:
int - actionId
45.114 scheduleApplyErrata
Description
Schedules an action to apply errata updates to multiple systems at a given date/time.Available since API version: 13.0
Parameters
string sessionKey
array:
int - serverId
array:
int - errataId
dateTime.iso8601 earliestOccurrence
Return Value
399 scheduleApplyErrata SUSE Manager 24
array:
int - actionId
45.115 scheduleApplyErrata
Description
Schedules an action to apply errata updates to multiple systems at a given date/time.Available since API version: 21
Parameters
string sessionKey
array:
int - serverId
array:
int - errataId
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present
Return Value
array:
int - actionId
45.116 scheduleApplyErrata
Description
Schedules an action to apply errata updates to multiple systems at a given date/time.Available since API version: 24
Parameters
400 scheduleApplyErrata SUSE Manager 24
string sessionKey
array:
int - serverId
array:
int - errataId
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present
boolean onlyRelevant - If true not all erratas are applied to all systems. Systems getonly the erratas relevant for them.
Return Value
array:
int - actionId
45.117 scheduleApplyErrata
Description
Schedules an action to apply errata updates to a system.Available since API version: 13.0
Parameters
string sessionKey
int serverId
array:
int - errataId
Return Value
401 scheduleApplyErrata SUSE Manager 24
array:
int - actionId
45.118 scheduleApplyErrataDescription
Schedules an action to apply errata updates to a system.Available since API version: 21
Parameters
string sessionKeyint serverIdarray:
int - errataIdboolean allowModules - Allow this API call, despite modular content being present
Return Value
array:
int - actionId
45.119 scheduleApplyErrataDescription
Schedules an action to apply errata updates to a system at a given date/time.Available since API version: 13.0
Parameters
string sessionKeyint serverIdarray:
int - errataIddateTime.iso8601 earliestOccurrence
402 scheduleApplyErrata SUSE Manager 24
Return Value
array:
int - actionId
45.120 scheduleApplyErrataDescription
Schedules an action to apply errata updates to a system at a given date/time.Available since API version: 21
Parameters
string sessionKeyint serverIdarray:
int - errataIddateTime.iso8601 earliestOccurrenceboolean allowModules - Allow this API call, despite modular content being present
Return Value
array:
int - actionId
45.121 scheduleApplyHighstateDescription
Schedule highstate application for a given system.
Parameters
string sessionKeyint serverIddateTime.iso8601 earliestOccurrenceboolean test - Run states in test-only mode
403 scheduleApplyErrata SUSE Manager 24
Return Value
int actionId
45.122 scheduleCertificateUpdate
Description
Schedule update of client certicate
Parameters
string sessionKey
int serverId
Return Value
int actionId - The action id of the scheduled action
45.123 scheduleCertificateUpdate
Description
Schedule update of client certicate at given date and time
Parameters
string sessionKey
int serverId
dateTime.iso860 date
Return Value
int actionId - The action id of the scheduled action
45.124 scheduleChangeChannels
Description
404 scheduleCertificateUpdate SUSE Manager 24
Schedule an action to change the channels of the given system. Works for both traditionaland Salt systems. This method accepts labels for the base and child channels. If the userprovides an empty string for the channelLabel, the current base channel and all childchannels will be removed from the system.Available since API version: 19.0
Parameters
string sessionKeyint serverIdstring baseChannelLabelarray:
string - channelLabeldateTime.iso8601 date - the time/date to schedule the action
Return Value
int id - ID of the action scheduled, otherwise exception thrown on error
45.125 scheduleChangeChannels
Description
Schedule an action to change the channels of the given system. Works for both traditionaland Salt systems. This method accepts labels for the base and child channels. If the userprovides an empty string for the channelLabel, the current base channel and all childchannels will be removed from the system.Available since API version: 19.0
Parameters
string sessionKeyint serverIdstring baseChannelLabelarray:
string - channelLabeldateTime.iso8601 date - the time/date to schedule the action
405 scheduleChangeChannels SUSE Manager 24
Return Value
array:
long - actionIds
45.126 scheduleDistUpgrade
Description
Schedule a dist upgrade for a system. This call takes a list of channel labels that the systemwill be subscribed to before performing the dist upgrade. Note: You can seriously damageyour system with this call, use it only if you really know what you are doing! Make surethat the list of channel labels is complete and in any case do a dry run before schedulingan actual dist upgrade.
Parameters
string sessionKeyint serverIdarray:
string - channelsboolean dryRundateTime.iso8601 earliest
Return Value
int actionId
45.127 scheduleDistUpgrade
Description
Schedule a dist upgrade for a system. This call takes a list of channel labels that the systemwill be subscribed to before performing the dist upgrade. Note: You can seriously damageyour system with this call, use it only if you really know what you are doing! Make surethat the list of channel labels is complete and in any case do a dry run before schedulingan actual dist upgrade.
406 scheduleDistUpgrade SUSE Manager 24
Parameters
string sessionKey
int serverId
array:
string - channels
boolean dryRun
boolean allowVendorChange
dateTime.iso8601 earliest
Return Value
int actionId
45.128 scheduleGuestAction
Description
Schedules a guest action for the specied virtual guest for a given date/time.
Parameters
string sessionKey
int sid - the system Id of the guest
string state - One of the following actions 'start', 'suspend', 'resume', 'restart','shutdown'.
dateTime.iso8601 date - the time/date to schedule the action
Return Value
int actionId - The action id of the scheduled action
45.129 scheduleGuestAction
Description
407 scheduleGuestAction SUSE Manager 24
Schedules a guest action for the specied virtual guest for the current time.
Parameters
string sessionKey
int sid - the system Id of the guest
string state - One of the following actions 'start', 'suspend', 'resume', 'restart','shutdown'.
Return Value
int actionId - The action id of the scheduled action
45.130 scheduleHardwareRefresh
Description
Schedule a hardware refresh for a system.Available since API version: 13.0
Parameters
string sessionKey
int serverId
dateTime.iso8601 earliestOccurrence
Return Value
int actionId - The action id of the scheduled action
45.131 schedulePackageInstall
Description
Schedule package installation for several systems.
Parameters
408 scheduleHardwareRefresh SUSE Manager 24
string sessionKey
array:
int - serverId
array:
int - packageId
dateTime.iso8601 earliestOccurrence
Return Value
array:
int - actionId
45.132 schedulePackageInstall
Description
Schedule package installation for several systems.Available since API version: 21
Parameters
string sessionKey
array:
int - serverId
array:
int - packageId
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present
Return Value
409 schedulePackageInstall SUSE Manager 24
array:
int - actionId
45.133 schedulePackageInstallDescription
Schedule package installation for a system.Available since API version: 13.0
Parameters
string sessionKeyint serverIdarray:
int - packageIddateTime.iso8601 earliestOccurrence
Return Value
int actionId - The action id of the scheduled action
45.134 schedulePackageInstallDescription
Schedule package installation for a system.Available since API version: 21
Parameters
string sessionKeyint serverIdarray:
int - packageIddateTime.iso8601 earliestOccurrenceboolean allowModules - Allow this API call, despite modular content being present
410 schedulePackageInstall SUSE Manager 24
Return Value
int actionId - The action id of the scheduled action
45.135 schedulePackageInstallByNevra
Description
Schedule package installation for several systems.
Parameters
string sessionKey
array:
int - serverId
array:
struct - Package nevra
string "package_name"
string "package_epoch"
string "package_version"
string "package_release"
string "package_arch"
dateTime.iso8601 earliestOccurrence
Return Value
array:
int - actionId
45.136 schedulePackageInstallByNevra
Description
Schedule package installation for several systems.Available since API version: 21
411 schedulePackageInstallByNevra SUSE Manager 24
Parameters
string sessionKeyarray:
int - serverIdarray:
struct - Package nevra
string "package_name"string "package_epoch"string "package_version"string "package_release"string "package_arch"
dateTime.iso8601 earliestOccurrenceboolean allowModules - Allow this API call, despite modular content being present
Return Value
array:
int - actionId
45.137 schedulePackageInstallByNevra
Description
Schedule package installation for a system.
Parameters
string sessionKeyint serverIdarray:
struct - Package nevra
string "package_name"string "package_epoch"
412 schedulePackageInstallByNevra SUSE Manager 24
string "package_version"string "package_release"string "package_arch"
dateTime.iso8601 earliestOccurrence
Return Value
int actionId - The action id of the scheduled action
45.138 schedulePackageInstallByNevraDescription
Schedule package installation for a system.Available since API version: 21
Parameters
string sessionKeyint serverIdarray:
struct - Package nevra
string "package_name"string "package_epoch"string "package_version"string "package_release"string "package_arch"
dateTime.iso8601 earliestOccurrenceboolean allowModules - Allow this API call, despite modular content being present
Return Value
int actionId - The action id of the scheduled action
45.139 schedulePackageRefreshDescription
413 schedulePackageInstallByNevra SUSE Manager 24
Schedule a package list refresh for a system.
Parameters
string sessionKeyint serverIddateTime.iso8601 earliestOccurrence
Return Value
int id - ID of the action scheduled, otherwise exception thrown on error
45.140 schedulePackageRemoveDescription
Schedule package removal for several systems.
Parameters
string sessionKeyarray:
int - serverIdarray:
int - packageIddateTime.iso8601 earliestOccurrence
Return Value
array:
int - actionId
45.141 schedulePackageRemoveDescription
Schedule package removal for several systems.Available since API version: 21
414 schedulePackageRemove SUSE Manager 24
Parameters
string sessionKeyarray:
int - serverIdarray:
int - packageIddateTime.iso8601 earliestOccurrenceboolean allowModules - Allow this API call, despite modular content being present
Return Value
array:
int - actionId
45.142 schedulePackageRemoveDescription
Schedule package removal for a system.
Parameters
string sessionKeyint serverIdarray:
int - packageIddateTime.iso8601 earliestOccurrence
Return Value
int actionId - The action id of the scheduled action
45.143 schedulePackageRemoveDescription
415 schedulePackageRemove SUSE Manager 24
Schedule package removal for a system.Available since API version: 21
Parameters
string sessionKeyint serverIdarray:
int - packageIddateTime.iso8601 earliestOccurrenceboolean allowModules - Allow this API call, despite modular content being present
Return Value
int actionId - The action id of the scheduled action
45.144 schedulePackageRemoveByNevraDescription
Schedule package removal for several systems.
Parameters
string sessionKeyarray:
int - serverIdarray:
struct - Package nevra
string "package_name"string "package_epoch"string "package_version"string "package_release"string "package_arch"
dateTime.iso8601 earliestOccurrence
Return Value
416 schedulePackageRemoveByNevra SUSE Manager 24
array:
int - actionId
45.145 schedulePackageRemoveByNevra
Description
Schedule package removal for several systems.Available since API version: 21
Parameters
string sessionKey
array:
int - serverId
array:
struct - Package nevra
string "package_name"
string "package_epoch"
string "package_version"
string "package_release"
string "package_arch"
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present
Return Value
array:
int - actionId
45.146 schedulePackageRemoveByNevra
Description
417 schedulePackageRemoveByNevra SUSE Manager 24
Schedule package removal for a system.
Parameters
string sessionKeyint serverIdarray:
struct - Package nevra
string "package_name"string "package_epoch"string "package_version"string "package_release"string "package_arch"
dateTime.iso8601 earliestOccurrence
Return Value
array:
int - actionId
45.147 schedulePackageRemoveByNevraDescription
Schedule package removal for a system.Available since API version: 21
Parameters
string sessionKeyint serverIdarray:
struct - Package nevra
string "package_name"string "package_epoch"string "package_version"
418 schedulePackageRemoveByNevra SUSE Manager 24
string "package_release"string "package_arch"
dateTime.iso8601 earliestOccurrenceboolean allowModules - Allow this API call, despite modular content being present
Return Value
array:
int - actionId
45.148 scheduleRebootDescription
Schedule a reboot for a system.Available since API version: 13.0
Parameters
string sessionKeyint serverIddateTime.iso860 earliestOccurrence
Return Value
int actionId - The action id of the scheduled action
45.149 scheduleSPMigrationDescription
Schedule a Service Pack migration for a system. This call is the recommended andsupported way of migrating a system to the next Service Pack. It will automatically nd allmandatory product channels below a given target base channel and subscribe the systemaccordingly. Any additional optional channels can be subscribed by providing their labels.
Parameters
string sessionKeyint serverId
419 scheduleReboot SUSE Manager 24
string baseChannelLabelarray:
string - optionalChildChannelsboolean dryRundateTime.iso8601 earliest
Return Value
int actionId - The action id of the scheduled action
45.150 scheduleSPMigrationDescription
Schedule a Service Pack migration for a system. This call is the recommended andsupported way of migrating a system to the next Service Pack. It will automatically nd allmandatory product channels below a given target base channel and subscribe the systemaccordingly. Any additional optional channels can be subscribed by providing their labels.
Parameters
string sessionKeyint serverIdstring baseChannelLabelarray:
string - optionalChildChannelsboolean dryRunboolean allowVendorChangedateTime.iso8601 earliest
Return Value
int actionId - The action id of the scheduled action
45.151 scheduleSPMigrationDescription
420 scheduleSPMigration SUSE Manager 24
Schedule a Service Pack migration for a system. This call is the recommended andsupported way of migrating a system to the next Service Pack. It will automatically nd allmandatory product channels below a given target base channel and subscribe the systemaccordingly. Any additional optional channels can be subscribed by providing their labels.
Parameters
string sessionKeyint serverIdstring targetIdentstring baseChannelLabelarray:
string - optionalChildChannelsboolean dryRundateTime.iso8601 earliest
Return Value
int actionId - The action id of the scheduled action
45.152 scheduleSPMigrationDescription
Schedule a Service Pack migration for a system. This call is the recommended andsupported way of migrating a system to the next Service Pack. It will automatically nd allmandatory product channels below a given target base channel and subscribe the systemaccordingly. Any additional optional channels can be subscribed by providing their labels.
Parameters
string sessionKeyint serverIdstring targetIdentstring baseChannelLabelarray:
string - optionalChildChannelsboolean dryRun
421 scheduleSPMigration SUSE Manager 24
boolean allowVendorChangedateTime.iso8601 earliest
Return Value
int actionId - The action id of the scheduled action
45.153 scheduleScriptRun
Description
Schedule a script to run.
Parameters
string sessionKeystring labelarray:
int - System IDs of the servers to run the script on.string username - User to run script as.string groupname - Group to run script as.int timeout - Seconds to allow the script to run before timing out.string script - Contents of the script to run. Must start with a shebang (e.g. #!/bin/bash)dateTime.iso8601 earliestOccurrence - Earliest the script can run.
Return Value
int id - ID of the script run action created. Can be used to fetch results withsystem.getScriptResults
45.154 scheduleScriptRun
Description
Schedule a script to run.
Parameters
422 scheduleScriptRun SUSE Manager 24
string sessionKey
array:
int - System IDs of the servers to run the script on.
string username - User to run script as.
string groupname - Group to run script as.
int timeout - Seconds to allow the script to run before timing out.
string script - Contents of the script to run. Must start with a shebang (e.g. #!/bin/bash)
dateTime.iso8601 earliestOccurrence - Earliest the script can run.
Return Value
int id - ID of the script run action created. Can be used to fetch results withsystem.getScriptResults
45.155 scheduleScriptRun
Description
Schedule a script to run.
Parameters
string sessionKey
int serverId - ID of the server to run the script on.
string username - User to run script as.
string groupname - Group to run script as.
int timeout - Seconds to allow the script to run before timing out.
string script - Contents of the script to run. Must start with a shebang (e.g. #!/bin/bash)
dateTime.iso8601 earliestOccurrence - Earliest the script can run.
Return Value
423 scheduleScriptRun SUSE Manager 24
int id - ID of the script run action created. Can be used to fetch results withsystem.getScriptResults
45.156 scheduleScriptRun
Description
Schedule a script to run.
Parameters
string sessionKey
string label
int serverId - ID of the server to run the script on.
string username - User to run script as.
string groupname - Group to run script as.
int timeout - Seconds to allow the script to run before timing out.
string script - Contents of the script to run. Must start with a shebang (e.g. #!/bin/bash)
dateTime.iso8601 earliestOccurrence - Earliest the script can run.
Return Value
int id - ID of the script run action created. Can be used to fetch results withsystem.getScriptResults
45.157 scheduleSyncPackagesWithSystem
Description
Sync packages from a source system to a target.Available since API version: 13.0
Parameters
string sessionKey
int targetServerId - Target system to apply package changes to.
424 scheduleScriptRun SUSE Manager 24
int sourceServerId - Source system to retrieve package state from.
array:
int - packageId - Package IDs to be synced.
dateTime.iso8601 date - Date to schedule action for
Return Value
int actionId - The action id of the scheduled action
45.158 searchByName
Description
Returns a list of system IDs whose name matches the supplied regular expression(denedby Java representation of regular expressions)
Parameters
string sessionKey
string regexp - A regular expression
Return Value
array:
struct - system
int "id"
string "name"
dateTime.iso8601 "last_checkin" - Last time server successfully checked in
dateTime.iso8601 "created" - Server registration time
dateTime.iso8601 "last_boot" - Last server boot time
45.159 sendOsaPing
Description
send a ping to a system using OSA
425 searchByName SUSE Manager 24
Parameters
string sessionKey
int serverId
Return Value
int - 1 on success, exception thrown otherwise.
45.160 setBaseChannel
Description
Assigns the server to a new baseChannel.Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId,string channelLabel)
Parameters
string sessionKey
int serverId
int channelId
Return Value
int - 1 on success, exception thrown otherwise.
45.161 setBaseChannel
Description
Assigns the server to a new base channel. If the user provides an empty string for thechannelLabel, the current base channel and all child channels will be removed from thesystem.Deprecated - being replaced by system.scheduleChangeChannels(string sessionKey, intserverId, String baseChannelLabel, array_single channelLabels, date earliestOccurrence).
Parameters
426 setBaseChannel SUSE Manager 24
string sessionKey
int serverId
string channelLabel
Return Value
int - 1 on success, exception thrown otherwise.
45.162 setChildChannels
Description
Subscribe the given server to the child channels provided. This method will unsubscribethe server from any child channels that the server is currently subscribed to, but that arenot included in the list. The user may provide either a list of channel ids (int) or a list ofchannel labels (string) as input. Changes to channel assignments on salt managed systemswill take eect at next highstate application.Deprecated - being replaced by system.scheduleChangeChannels(string sessionKey, intserverId, String baseChannelLabel, array_single channelLabels, date earliestOccurrence).This method will schedule an action for changing the child channels immediately.
Parameters
string sessionKey
int serverId
array:
int (deprecated) or string - channelId (deprecated) or channelLabel
Return Value
int - 1 on success, exception thrown otherwise.
45.163 setCustomValues
Description
Set custom values for the specied server.
427 setChildChannels SUSE Manager 24
Parameters
string sessionKeyint serverIdstruct - Map of custom labels to custom values
string "custom info label"string "value"
Return Value
int - 1 on success, exception thrown otherwise.
45.164 setDetails
Description
Set server details. All arguments are optional and will only be modied if included in thestruct.
Parameters
string sessionKeyint serverId - ID of server to lookup details for.struct - server details
string "prole_name" - System's prole namestring "base_entitlement" - System's base entitlement label. (enterprise_entitledor unentitle)boolean "auto_errata_update" - True if system has auto errata updates enabledstring "description" - System descriptionstring "address1" - System's address line 1.string "address2" - System's address line 2.string "city"string "state"string "country"string "building"string "room"string "rack"
428 setDetails SUSE Manager 24
string "contact_method" - One of the following:defaultssh-pushssh-push-tunnel
Return Value
int - 1 on success, exception thrown otherwise.
45.165 setGroupMembershipDescription
Set a servers membership in a given group.
Parameters
string sessionKeyint serverIdint serverGroupIdboolean member - '1' to assign the given server to the given server group, '0' to removethe given server from the given server group.
Return Value
int - 1 on success, exception thrown otherwise.
45.166 setGuestCpusDescription
Schedule an action of a guest's host, to set that guest's CPU allocation
Parameters
string sessionKeyint sid - The guest's system idint numOfCpus - The number of virtual cpus to allocate to the guest
Return Value
429 setGroupMembership SUSE Manager 24
int actionID - the action Id for the schedule action on the host system
45.167 setGuestMemory
Description
Schedule an action of a guest's host, to set that guest's memory allocation
Parameters
string sessionKey
int sid - The guest's system id
int memory - The amount of memory to allocate to the guest
Return Value
int actionID - the action Id for the schedule action on the host system
45.168 setLockStatus
Description
Set server lock status.
Parameters
string sessionKey
int serverId
boolean lockStatus - true to lock the system, false to unlock the system.
Return Value
int - 1 on success, exception thrown otherwise.
45.169 setPrimaryInterface
Description
430 setGuestMemory SUSE Manager 24
Sets new primary network interface
Parameters
string sessionKeyint serverIdstring interfaceName
Return Value
int - 1 on success, exception thrown otherwise.
45.170 setProfileName
Description
Set the prole name for the server.
Parameters
string sessionKeyint serverIdstring name - Name of the prole.
Return Value
int - 1 on success, exception thrown otherwise.
45.171 setVariables
Description
Sets a list of kickstart variables in the cobbler system record for the specied server. Note:This call assumes that a system record exists in cobbler for the given system and willraise an XMLRPC fault if that is not the case. To create a system record over xmlrpc usesystem.createSystemRecord To create a system record in the Web UI please go to System-> <Specied System> -> Provisioning -> Select a Kickstart prole -> Create CobblerSystem Record.
Parameters
431 setProfileName SUSE Manager 24
string sessionKeyint serverIdboolean netbootarray:
struct - kickstart variable
string "key"string or int "value"
Return Value
int - 1 on success, exception thrown otherwise.
45.172 tagLatestSnapshotDescription
Tags latest system snapshot
Parameters
string sessionKeyint serverIdstring tagName
Return Value
int - 1 on success, exception thrown otherwise.
45.173 unentitleDescription
Unentitle the system completely
Parameters
string systemid - systemid le
Return Value
432 tagLatestSnapshot SUSE Manager 24
int - 1 on success, exception thrown otherwise.
45.174 updatePackageStateDescription
Update the package state of a given system (High state would be needed to actually install/remove the package)
Parameters
string sessionKeyint serverIdstring packageName - Name of the packageint state - 0 = installed, 1 = removed, 2 = unmanagedint versionConstraint - 0 = latest, 1 = any
Return Value
1 on success, exception on failure
45.175 upgradeEntitlementDescription
Adds an entitlement to a given server.
Parameters
string sessionKeyint serverIdstring entitlementName - One of: 'enterprise_entitled' or 'virtualization_host'.
Return Value
int - 1 on success, exception thrown otherwise.
45.176 whoRegisteredDescription
433 updatePackageState SUSE Manager 24
Returns information about the user who registered the system
Parameters
string sessionKeyint sid - Id of the system in question
Return Value
struct - user
int "id"string "login"string "login_uc" - upper case version of the loginboolean "enabled" - true if user is enabled, false if the user is disabled
434 whoRegistered SUSE Manager 24
46 system.config
Provides methods to access and modify many aspects of conguration channels andserver association. basically system.cong name space
46.1 addChannelsDescription
Given a list of servers and conguration channels, this method appends the congurationchannels to either the top or the bottom (whichever you specify) of a system's subscribedconguration channels list. The ordering of the conguration channels provided in the addlist is maintained while adding. If one of the conguration channels in the 'add' list hasbeen previously subscribed by a server, the subscribed channel will be re-ranked to theappropriate place.
Parameters
string sessionKeyarray:
int - IDs of the systems to add the channels to.array:
string - List of conguration channel labels in the ranked order.boolean addToTop
true - to prepend the given channels list to the top of the conguration channelslist of a serverfalse - to append the given channels list to the bottom of the congurationchannels list of a server
Return Value
int - 1 on success, exception thrown otherwise.
46.2 createOrUpdatePathDescription
435 addChannels SUSE Manager 24
Create a new le (text or binary) or directory with the given path, or update an existingpath on a server.Available since API version: 10.2
Parameters
string sessionKey
int serverId
string path - the conguration le/directory path
boolean isDir
True - if the path is a directory
False - if the path is a le
struct - path info
string "contents" - Contents of the le (text or base64 encoded if binary) ((onlyfor non-directories)
boolean "contents_enc64" - Identies base64 encoded content (default: disabled,only for non-directories).
string "owner" - Owner of the le/directory.
string "group" - Group name of the le/directory.
string "permissions" - Octal le/directory permissions (eg: 644)
string "macro-start-delimiter" - Cong le macro end delimiter. Use null orempty string to accept the default. (only for non-directories)
string "macro-end-delimiter" - Cong le macro end delimiter. Use null or emptystring to accept the default. (only for non-directories)
string "selinux_ctx" - SeLinux context (optional)
int "revision" - next revision number, auto increment for null
boolean "binary" - mark the binary content, if True, base64 encoded content isexpected (only for non-directories)
int commitToLocal
1 - to commit conguration les to the system's local override congurationchannel
0 - to commit conguration les to the system's sandbox conguration channel
Return Value
struct - Conguration Revision information
436 createOrUpdatePath SUSE Manager 24
string "type"
le
directory
symlink
string "path" - File Path
string "target_path" - Symbolic link Target File Path. Present for Symbolic linksonly.
string "channel" - Channel Name
string "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)
boolean "contents_enc64" - Identies base64 encoded content
int "revision" - File Revision
dateTime.iso8601 "creation" - Creation Date
dateTime.iso8601 "modied" - Last Modied Date
string "owner" - File Owner. Present for les or directories only.
string "group" - File Group. Present for les or directories only.
int "permissions" - File Permissions (Deprecated). Present for les or directoriesonly.
string "permissions_mode" - File Permissions. Present for les or directories only.
string "selinux_ctx" - SELinux Context (optional).
boolean "binary" - true/false , Present for les only.
string "sha256" - File's sha256 signature. Present for les only.
string "macro-start-delimiter" - Macro start delimiter for a cong le. Presentfor text les only.
string "macro-end-delimiter" - Macro end delimiter for a cong le. Present fortext les only.
46.3 createOrUpdateSymlink
Description
Create a new symbolic link with the given path, or update an existing path.Available since API version: 10.2
Parameters
437 createOrUpdateSymlink SUSE Manager 24
string sessionKey
int serverId
string path - the conguration le/directory path
struct - path info
string "target_path" - The target path for the symbolic link
string "selinux_ctx" - SELinux Security context (optional)
int "revision" - next revision number, auto increment for null
int commitToLocal
1 - to commit conguration les to the system's local override congurationchannel
0 - to commit conguration les to the system's sandbox conguration channel
Return Value
struct - Conguration Revision information
string "type"
le
directory
symlink
string "path" - File Path
string "target_path" - Symbolic link Target File Path. Present for Symbolic linksonly.
string "channel" - Channel Name
string "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)
boolean "contents_enc64" - Identies base64 encoded content
int "revision" - File Revision
dateTime.iso8601 "creation" - Creation Date
dateTime.iso8601 "modied" - Last Modied Date
string "owner" - File Owner. Present for les or directories only.
string "group" - File Group. Present for les or directories only.
int "permissions" - File Permissions (Deprecated). Present for les or directoriesonly.
string "permissions_mode" - File Permissions. Present for les or directories only.
string "selinux_ctx" - SELinux Context (optional).
438 createOrUpdateSymlink SUSE Manager 24
boolean "binary" - true/false , Present for les only.
string "sha256" - File's sha256 signature. Present for les only.
string "macro-start-delimiter" - Macro start delimiter for a cong le. Presentfor text les only.
string "macro-end-delimiter" - Macro end delimiter for a cong le. Present fortext les only.
46.4 deleteFiles
Description
Removes le paths from a local or sandbox channel of a server.
Parameters
string sessionKey
int serverId
array:
string - paths to remove.
boolean deleteFromLocal
True - to delete conguration le paths from the system's local overrideconguration channel
False - to delete conguration le paths from the system's sandbox congurationchannel
Return Value
int - 1 on success, exception thrown otherwise.
46.5 deployAll
Description
Schedules a deploy action for all the conguration les on the given list of systems.
Parameters
439 deleteFiles SUSE Manager 24
string sessionKey
array:
int - id of the systems to schedule conguration les deployment
dateTime.iso8601 date - Earliest date for the deploy action.
Return Value
int - 1 on success, exception thrown otherwise.
46.6 listChannels
Description
List all global('Normal', 'State') conguration channels associated to a system in the orderof their ranking.
Parameters
string sessionKey
int serverId
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"
440 listChannels SUSE Manager 24
string "name"
int "priority"
46.7 listFiles
Description
Return the list of les in a given channel.
Parameters
string sessionKey
int serverId
int listLocal
1 - to return conguration les in the system's local override congurationchannel
0 - to return conguration les in the system's sandbox conguration channel
Return Value
array:
struct - Conguration File information
string "type"
le
directory
symlink
string "path" - File Path
string "channel_label" - the label of the central conguration channelthat has this le. Note this entry only shows up if the le has not beenoverridden by a central channel.
struct "channel_type"
struct - Conguration Channel Type information
int "id"
string "label"
441 listFiles SUSE Manager 24
string "name"
int "priority"
dateTime.iso8601 "last_modied" - Last Modied Date
46.8 lookupFileInfo
Description
Given a list of paths and a server, returns details about the latest revisions of the paths.Available since API version: 10.2
Parameters
string sessionKey
int serverId
array:
string - paths to lookup on.
int searchLocal
1 - to search conguration le paths in the system's local override congurationor systems subscribed central channels
0 - to search conguration le paths in the system's sandbox congurationchannel
Return Value
array:
struct - Conguration Revision information
string "type"
le
directory
symlink
string "path" - File Path
string "target_path" - Symbolic link Target File Path. Present for Symboliclinks only.
string "channel" - Channel Name
442 lookupFileInfo SUSE Manager 24
string "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)boolean "contents_enc64" - Identies base64 encoded contentint "revision" - File RevisiondateTime.iso8601 "creation" - Creation DatedateTime.iso8601 "modied" - Last Modied Datestring "owner" - File Owner. Present for les or directories only.string "group" - File Group. Present for les or directories only.int "permissions" - File Permissions (Deprecated). Present for les ordirectories only.string "permissions_mode" - File Permissions. Present for les or directoriesonly.string "selinux_ctx" - SELinux Context (optional).boolean "binary" - true/false , Present for les only.string "sha256" - File's sha256 signature. Present for les only.string "macro-start-delimiter" - Macro start delimiter for a cong le.Present for text les only.string "macro-end-delimiter" - Macro end delimiter for a cong le.Present for text les only.
46.9 removeChannels
Description
Remove cong channels from the given servers.
Parameters
string sessionKeyarray:
int - the IDs of the systems from which you would like to remove congurationchannels..
array:
string - List of conguration channel labels to remove.
Return Value
443 removeChannels SUSE Manager 24
int - 1 on success, exception thrown otherwise.
46.10 scheduleApplyConfigChannel
Description
Schedule highstate application for a given system.
Parameters
string sessionKeyint serverIddateTime.iso8601 earliestOccurrenceboolean test - Run states in test-only mode
Return Value
int actionId
46.11 setChannels
Description
Replace the existing set of cong channels on the given servers. Channels are rankedaccording to their order in the congChannelLabels array.
Parameters
string sessionKeyarray:
int - IDs of the systems to set the channels on.array:
string - List of conguration channel labels in the ranked order.
Return Value
int - 1 on success, exception thrown otherwise.
444 scheduleApplyConfigChannel SUSE Manager 24
47 system.crash
Provides methods to access and modify software crash information.
47.1 createCrashNoteDescription
Create a crash note
Parameters
string sessionKeyint crashIdstring subjectstring details
Return Value
int - 1 on success, exception thrown otherwise.
47.2 deleteCrashDescription
Delete a crash with given crash id.
Parameters
string sessionKeyint crashId
Return Value
int - 1 on success, exception thrown otherwise.
47.3 deleteCrashNoteDescription
445 createCrashNote SUSE Manager 24
Delete a crash note
Parameters
string sessionKeyint crashNoteId
Return Value
int - 1 on success, exception thrown otherwise.
47.4 getCrashCountInfo
Description
Return date of last software crashes report for given system
Parameters
string sessionKeyint serverId
Return Value
struct - Crash Count Information
int "total_count" - Total number of software crashes for a systemint "unique_count" - Number of unique software crashes for a systemdateTime.iso8601 "last_report" - Date of the last software crash report
47.5 getCrashFile
Description
Download a crash le.
Parameters
string sessionKeyint crashFileId
446 getCrashCountInfo SUSE Manager 24
Return Value
array:
byte - base64 encoded crash le
47.6 getCrashFileUrl
Description
Get a crash le download url.
Parameters
string sessionKey
int crashFileId
Return Value
string url - The crash le download url
47.7 getCrashNotesForCrash
Description
List crash notes for crash
Parameters
string sessionKey
int crashId
Return Value
array:
struct - crashNote
int "id"
string "subject"
447 getCrashFileUrl SUSE Manager 24
string "details"string "updated"
47.8 getCrashOverviewDescription
Get Software Crash Overview
Parameters
string sessionKey
Return Value
array:
struct - crash
string "uuid" - Crash UUIDstring "component" - Package component (set if unique and non empty)int "crash_count" - Number of crashes occurredint "system_count" - Number of systems aecteddateTime.iso8601 "last_report" - Last crash occurence
47.9 getCrashesByUuidDescription
List software crashes with given UUID
Parameters
string sessionKeystring uuid
Return Value
array:
struct - crash
448 getCrashOverview SUSE Manager 24
int "server_id" - ID of the server the crash occurred onstring "server_name" - Name of the server the crash occurred onint "crash_id" - ID of the crash with given UUIDint "crash_count" - Number of times the crash with given UUID occurredstring "crash_component" - Crash componentdateTime.iso8601 "last_report" - Last crash occurence
47.10 listSystemCrashFilesDescription
Return list of crash les for given crash id.
Parameters
string sessionKeyint crashId
Return Value
array:
struct - crashFile
int "id"string "lename"string "path"int "lesize"boolean "is_uploaded"date "created"date "modied"
47.11 listSystemCrashesDescription
Return list of software crashes for a system.
Parameters
449 listSystemCrashFiles SUSE Manager 24
string sessionKeyint serverId
Return Value
array:
struct - crash
int "id"string "crash"string "path"int "count"string "uuid"string "analyzer"string "architecture"string "cmdline"string "component"string "executable"string "kernel"string "reason"string "username"date "created"date "modied"
450 listSystemCrashes SUSE Manager 24
48 system.custominfo
Provides methods to access and modify custom system information.
48.1 createKey
Description
Create a new custom key
Parameters
string sessionKeystring keyLabel - new key's labelstring keyDescription - new key's description
Return Value
int - 1 on success, exception thrown otherwise.
48.2 deleteKey
Description
Delete an existing custom key and all systems' values for the key.
Parameters
string sessionKeystring keyLabel - new key's label
Return Value
int - 1 on success, exception thrown otherwise.
48.3 listAllKeys
Description
451 createKey SUSE Manager 24
List the custom information keys dened for the user's organization.
Parameters
string sessionKey
Return Value
array:
struct - custom info
int "id"string "label"string "description"int "system_count"dateTime.iso8601 "last_modied"
48.4 updateKey
Description
Update description of a custom key
Parameters
string sessionKeystring keyLabel - key to changestring keyDescription - new key's description
Return Value
int - 1 on success, exception thrown otherwise.
452 updateKey SUSE Manager 24
49 system.provisioning.powermanagement
Provides methods to access and modify power management for systems. Somefunctions exist in 2 variants. Either with server id or with a name. The functionwith server id is useful when a system exists with a full prole. Everybody allowedto manage that system can execute these functions. The variant with name expectsa cobbler system name prex. These functions enhance the name by adding the orgid of the user to limit access to systems from the own organization. Additionally OrgAdmin permissions are required to call these functions.
49.1 getDetailsDescription
Get current power management settings of the given system
Parameters
string sessionKeyint serverId
Return Value
struct - powerManagementParameters
string "powerType" - Power management typestring "powerAddress" - IP address for power managementstring "powerUsername" - The Usernamestring "powerPassword" - The Passwordstring "powerId" - Identier
49.2 getDetailsDescription
Get current power management settings of the given system
Parameters
453 getDetails SUSE Manager 24
string sessionKeystring name
Return Value
struct - powerManagementParameters
string "powerType" - Power management typestring "powerAddress" - IP address for power managementstring "powerUsername" - The Usernamestring "powerPassword" - The Passwordstring "powerId" - Identier
49.3 getStatusDescription
Execute powermanagement actions
Parameters
string sessionKeyint serverIdstring action
Return Value
boolean status - True when power is on, otherwise False
49.4 getStatusDescription
Execute powermanagement actions
Parameters
string sessionKeystring namestring action
454 getStatus SUSE Manager 24
Return Value
boolean status - True when power is on, otherwise False
49.5 listTypesDescription
Return a list of available power management types
Parameters
string sessionKey
Return Value
array:
string - power management types
49.6 powerOffDescription
Execute power management action 'powerO'
Parameters
string sessionKeyint serverId
Return Value
int - 1 on success, exception thrown otherwise.
49.7 powerOffDescription
Execute power management action 'powerO'
Parameters
455 listTypes SUSE Manager 24
string sessionKeystring name
Return Value
int - 1 on success, exception thrown otherwise.
49.8 powerOnDescription
Execute power management action 'powerOn'
Parameters
string sessionKeyint serverId
Return Value
int - 1 on success, exception thrown otherwise.
49.9 powerOnDescription
Execute power management action 'powerOn'
Parameters
string sessionKeystring name
Return Value
int - 1 on success, exception thrown otherwise.
49.10 rebootDescription
456 powerOn SUSE Manager 24
Execute power management action 'Reboot'
Parameters
string sessionKeyint serverId
Return Value
int - 1 on success, exception thrown otherwise.
49.11 rebootDescription
Execute power management action 'Reboot'
Parameters
string sessionKeystring name
Return Value
int - 1 on success, exception thrown otherwise.
49.12 setDetailsDescription
Get current power management settings of the given system
Parameters
string sessionKeyint serverIdstruct - data
string "powerType" - Power management typestring "powerAddress" - IP address for power managementstring "powerUsername" - The Username
457 reboot SUSE Manager 24
string "powerPassword" - The Passwordstring "powerId" - Identier
Return Value
int - 1 on success, exception thrown otherwise.
49.13 setDetails
Description
Get current power management settings of the given system
Parameters
string sessionKeystring namestruct - data
string "powerType" - Power management typestring "powerAddress" - IP address for power managementstring "powerUsername" - The Usernamestring "powerPassword" - The Passwordstring "powerId" - Identier
Return Value
int - 1 on success, exception thrown otherwise.
458 setDetails SUSE Manager 24
50 system.provisioning.snapshot
Provides methods to access and delete system snapshots.
50.1 addTagToSnapshotDescription
Adds tag to snapshot
Parameters
string sessionKeyint snapshotId - Id of the snapshotstring tag - Name of the snapshot tag
Return Value
int - 1 on success, exception thrown otherwise.
50.2 deleteSnapshotDescription
Deletes a snapshot with the given snapshot idAvailable since API version: 10.1
Parameters
string sessionKeyint snapshotId - Id of snapshot to delete
Return Value
int - 1 on success, exception thrown otherwise.
50.3 deleteSnapshotsDescription
459 addTagToSnapshot SUSE Manager 24
Deletes all snapshots across multiple systems based on the given date criteria. For example,If the user provides startDate only, all snapshots created either on or after the date providedwill be removed. If user provides startDate and endDate, all snapshots created on orbetween the dates provided will be removed. If the user doesn't provide a startDate andendDate, all snapshots will be removed.Available since API version: 10.1
Parameters
string sessionKeystruct - date details
dateTime.iso8601 "startDate" - Optional, unless endDate is provided.dateTime.iso8601 "endDate" - Optional.
Return Value
int - 1 on success, exception thrown otherwise.
50.4 deleteSnapshotsDescription
Deletes all snapshots for a given system based on the date criteria. For example, If the userprovides startDate only, all snapshots created either on or after the date provided will beremoved. If user provides startDate and endDate, all snapshots created on or between thedates provided will be removed. If the user doesn't provide a startDate and endDate, allsnapshots associated with the server will be removed.Available since API version: 10.1
Parameters
string sessionKeyint sid - system id of system to delete snapshots forstruct - date details
dateTime.iso8601 "startDate" - Optional, unless endDate is provided.dateTime.iso8601 "endDate" - Optional.
Return Value
460 deleteSnapshots SUSE Manager 24
int - 1 on success, exception thrown otherwise.
50.5 listSnapshotConfigFiles
Description
List the cong les associated with a snapshot.Available since API version: 10.2
Parameters
string sessionKey
int snapId
Return Value
array:
struct - Conguration Revision information
string "type"
le
directory
symlink
string "path" - File Path
string "target_path" - Symbolic link Target File Path. Present for Symboliclinks only.
string "channel" - Channel Name
string "contents" - File contents (base64 encoded according to thecontents_enc64 attribute)
boolean "contents_enc64" - Identies base64 encoded content
int "revision" - File Revision
dateTime.iso8601 "creation" - Creation Date
dateTime.iso8601 "modied" - Last Modied Date
string "owner" - File Owner. Present for les or directories only.
string "group" - File Group. Present for les or directories only.
int "permissions" - File Permissions (Deprecated). Present for les ordirectories only.
461 listSnapshotConfigFiles SUSE Manager 24
string "permissions_mode" - File Permissions. Present for les or directoriesonly.
string "selinux_ctx" - SELinux Context (optional).
boolean "binary" - true/false , Present for les only.
string "sha256" - File's sha256 signature. Present for les only.
string "macro-start-delimiter" - Macro start delimiter for a cong le.Present for text les only.
string "macro-end-delimiter" - Macro end delimiter for a cong le.Present for text les only.
50.6 listSnapshotPackages
Description
List the packages associated with a snapshot.Available since API version: 10.1
Parameters
string sessionKey
int snapId
Return Value
array:
struct - package nvera
string "name"
string "epoch"
string "version"
string "release"
string "arch"
50.7 listSnapshots
Description
462 listSnapshotPackages SUSE Manager 24
List snapshots for a given system. A user may optionally provide a start and end date tonarrow the snapshots that will be listed. For example, If the user provides startDate only,all snapshots created either on or after the date provided will be returned. If user providesstartDate and endDate, all snapshots created on or between the dates provided will bereturned. If the user doesn't provide a startDate and endDate, all snapshots associated withthe server will be returned.Available since API version: 10.1
Parameters
string sessionKey
int serverId
struct - date details
dateTime.iso8601 "startDate" - Optional, unless endDate is provided.
dateTime.iso8601 "endDate" - Optional.
Return Value
array:
struct - server snapshot
int "id"
string "reason" - the reason for the snapshot's existence
dateTime.iso8601 "created"
array "channels"
string - labels of channels associated with the snapshot
array "groups"
string - Names of server groups associated with the snapshot
array "entitlements"
string - Names of system entitlements associated with the snapshot
array "cong_channels"
string - Labels of cong channels the snapshot is associated with.
array "tags"
463 listSnapshots SUSE Manager 24
string - Tag names associated with this snapshot.string "Invalid_reason" - If the snapshot is invalid, this is the reason(optional).
50.8 rollbackToSnapshotDescription
Rollbacks server to snapshot
Parameters
string sessionKeyint serverIdint snapshotId - Id of the snapshot
Return Value
int - 1 on success, exception thrown otherwise.
50.9 rollbackToTagDescription
Rollbacks server to snapshot
Parameters
string sessionKeyint serverIdstring tagName - Name of the snapshot tag
Return Value
int - 1 on success, exception thrown otherwise.
50.10 rollbackToTagDescription
464 rollbackToSnapshot SUSE Manager 24
Rollbacks server to snapshot
Parameters
string sessionKeystring tagName - Name of the snapshot tag
Return Value
int - 1 on success, exception thrown otherwise.
465 rollbackToTag SUSE Manager 24
51 system.scap
Provides methods to schedule SCAP scans and access the results.
51.1 deleteXccdfScan
Description
Delete OpenSCAP XCCDF Scan from the SUSE Manager database. Note that only thoseSCAP Scans can be deleted which have passed their retention period.
Parameters
string sessionKeyint Id of XCCDF scan (xid).
Return Value
boolean status - indicates success of the operation
51.2 getXccdfScanDetails
Description
Get details of given OpenSCAP XCCDF scan.
Parameters
string sessionKeyint Id of XCCDF scan (xid).
Return Value
struct - OpenSCAP XCCDF Scan
int "xid" - XCCDF TestResult idint "sid" - serverIdint "action_id" - Id of the parent action.string "path" - Path to XCCDF document
466 deleteXccdfScan SUSE Manager 24
string "oscap_parameters" - oscap command-line arguments.string "test_result" - Identier of XCCDF TestResult.string "benchmark" - Identier of XCCDF Benchmark.string "benchmark_version" - Version of the Benchmark.string "prole" - Identier of XCCDF Prole.string "prole_title" - Title of XCCDF Prole.dateTime.iso8601 "start_time" - Client machine time of scan start.dateTime.iso8601 "end_time" - Client machine time of scan completion.string "errors" - Stderr output of scan.boolean "deletable" - Indicates whether the scan can be deleted.
51.3 getXccdfScanRuleResults
Description
Return a full list of RuleResults for given OpenSCAP XCCDF scan.
Parameters
string sessionKeyint Id of XCCDF scan (xid).
Return Value
array:
struct - OpenSCAP XCCDF RuleResult
string "idref" - idref from XCCDF document.string "result" - Result of evaluation.string "idents" - Comma separated list of XCCDF idents.
51.4 listXccdfScans
Description
Return a list of nished OpenSCAP scans for a given system.
Parameters
467 getXccdfScanRuleResults SUSE Manager 24
string sessionKeyint serverId
Return Value
array:
struct - OpenSCAP XCCDF Scan
int "xid" - XCCDF TestResult IDstring "prole" - XCCDF Prolestring "path" - Path to XCCDF documentdateTime.iso8601 "completed" - Scan completion time
51.5 scheduleXccdfScan
Description
Schedule OpenSCAP scan.
Parameters
string sessionKeyarray:
int - serverIdstring Path to xccdf content on targeted systems.string Additional parameters for oscap tool.
Return Value
int id - ID if SCAP action created
51.6 scheduleXccdfScan
Description
Schedule OpenSCAP scan.
Parameters
468 scheduleXccdfScan SUSE Manager 24
string sessionKeyarray:
int - serverIdstring Path to xccdf content on targeted systems.string Additional parameters for oscap tool.dateTime.iso8601 date - The date to schedule the action
Return Value
int id - ID if SCAP action created
51.7 scheduleXccdfScanDescription
Schedule Scap XCCDF scan.
Parameters
string sessionKeyint serverIdstring Path to xccdf content on targeted system.string Additional parameters for oscap tool.
Return Value
int id - ID of the scap action created
51.8 scheduleXccdfScanDescription
Schedule Scap XCCDF scan.
Parameters
string sessionKeyint serverIdstring Path to xccdf content on targeted system.
469 scheduleXccdfScan SUSE Manager 24
string Additional parameters for oscap tool.dateTime.iso8601 date - The date to schedule the action
Return Value
int id - ID of the scap action created
470 scheduleXccdfScan SUSE Manager 24
52 system.search
Provides methods to perform system search requests using the search server.
52.1 deviceDescription
Description
List the systems which match the device description.
Parameters
string sessionKey
string searchTerm
Return Value
array:
struct - system
int "id"
string "name"
dateTime.iso8601 "last_checkin" - Last time server successfully checked in
string "hostname"
string "ip"
string "hw_description" - hw description if not null
string "hw_device_id" - hw device id if not null
string "hw_vendor_id" - hw vendor id if not null
string "hw_driver" - hw driver if not null
52.2 deviceDriver
Description
List the systems which match this device driver.
Parameters
471 deviceDescription SUSE Manager 24
string sessionKeystring searchTerm
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked instring "hostname"string "ip"string "hw_description" - hw description if not nullstring "hw_device_id" - hw device id if not nullstring "hw_vendor_id" - hw vendor id if not nullstring "hw_driver" - hw driver if not null
52.3 deviceId
Description
List the systems which match this device id
Parameters
string sessionKeystring searchTerm
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked instring "hostname"
472 deviceId SUSE Manager 24
string "ip"
string "hw_description" - hw description if not null
string "hw_device_id" - hw device id if not null
string "hw_vendor_id" - hw vendor id if not null
string "hw_driver" - hw driver if not null
52.4 deviceVendorId
Description
List the systems which match this device vendor_id
Parameters
string sessionKey
string searchTerm
Return Value
array:
struct - system
int "id"
string "name"
dateTime.iso8601 "last_checkin" - Last time server successfully checked in
string "hostname"
string "ip"
string "hw_description" - hw description if not null
string "hw_device_id" - hw device id if not null
string "hw_vendor_id" - hw vendor id if not null
string "hw_driver" - hw driver if not null
52.5 hostname
Description
List the systems which match this hostname
473 deviceVendorId SUSE Manager 24
Parameters
string sessionKeystring searchTerm
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked instring "hostname"string "ip"string "hw_description" - hw description if not nullstring "hw_device_id" - hw device id if not nullstring "hw_vendor_id" - hw vendor id if not nullstring "hw_driver" - hw driver if not null
52.6 ip
Description
List the systems which match this ip.
Parameters
string sessionKeystring searchTerm
Return Value
array:
struct - system
int "id"string "name"
474 ip SUSE Manager 24
dateTime.iso8601 "last_checkin" - Last time server successfully checked instring "hostname"string "ip"string "hw_description" - hw description if not nullstring "hw_device_id" - hw device id if not nullstring "hw_vendor_id" - hw vendor id if not nullstring "hw_driver" - hw driver if not null
52.7 nameAndDescriptionDescription
List the systems which match this name or description
Parameters
string sessionKeystring searchTerm
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked instring "hostname"string "ip"string "hw_description" - hw description if not nullstring "hw_device_id" - hw device id if not nullstring "hw_vendor_id" - hw vendor id if not nullstring "hw_driver" - hw driver if not null
52.8 uuidDescription
475 nameAndDescription SUSE Manager 24
List the systems which match this UUID
Parameters
string sessionKeystring searchTerm
Return Value
array:
struct - system
int "id"string "name"dateTime.iso8601 "last_checkin" - Last time server successfully checked instring "hostname"string "ip"string "hw_description" - hw description if not nullstring "hw_device_id" - hw device id if not nullstring "hw_vendor_id" - hw vendor id if not nullstring "hw_driver" - hw driver if not null
476 uuid SUSE Manager 24
53 systemgroup
Provides methods to access and modify system groups.
53.1 addOrRemoveAdminsDescription
Add or remove administrators to/from the given group. SUSE Manager and Organizationadministrators are granted access to groups within their organization by default; therefore,users with those roles should not be included in the array provided. Caller must be anorganization administrator.
Parameters
string sessionKeystring systemGroupNamearray:
string - loginName - User's loginNameint add - 1 to add administrators, 0 to remove.
Return Value
int - 1 on success, exception thrown otherwise.
53.2 addOrRemoveSystemsDescription
Add/remove the given servers to a system group.
Parameters
string sessionKeystring systemGroupNamearray:
int - serverIdboolean add - True to add to the group, False to remove.
477 addOrRemoveAdmins SUSE Manager 24
Return Value
int - 1 on success, exception thrown otherwise.
53.3 create
Description
Create a new system group.
Parameters
string sessionKey
string name - Name of the system group.
string description - Description of the system group.
Return Value
struct - Server Group
int "id"
string "name"
string "description"
int "org_id"
int "system_count"
53.4 delete
Description
Delete a system group.
Parameters
string sessionKey
string systemGroupName
Return Value
478 create SUSE Manager 24
int - 1 on success, exception thrown otherwise.
53.5 getDetails
Description
Retrieve details of a ServerGroup based on it's id
Parameters
string sessionKeyint systemGroupId
Return Value
struct - Server Group
int "id"string "name"string "description"int "org_id"int "system_count"
53.6 getDetails
Description
Retrieve details of a ServerGroup based on it's name
Parameters
string sessionKeystring systemGroupName
Return Value
struct - Server Group
int "id"string "name"
479 getDetails SUSE Manager 24
string "description"int "org_id"int "system_count"
53.7 listActiveSystemsInGroupDescription
Lists active systems within a server group
Parameters
string sessionKeystring systemGroupName
Return Value
array:
int - server_id
53.8 listAdministratorsDescription
Returns the list of users who can administer the given group. Caller must be a system groupadmin or an organization administrator.
Parameters
string sessionKeystring systemGroupName
Return Value
array:
struct - user
int "id"string "login"
480 listActiveSystemsInGroup SUSE Manager 24
string "login_uc" - upper case version of the loginboolean "enabled" - true if user is enabled, false if the user is disabled
53.9 listAllGroupsDescription
Retrieve a list of system groups that are accessible by the logged in user.
Parameters
string sessionKey
Return Value
array:
struct - Server Group
int "id"string "name"string "description"int "org_id"int "system_count"
53.10 listGroupsWithNoAssociatedAdminsDescription
Returns a list of system groups that do not have an administrator. (who is not anorganization administrator, as they have implicit access to system groups) Caller must bean organization administrator.
Parameters
string sessionKey
Return Value
array:
struct - Server Group
481 listAllGroups SUSE Manager 24
int "id"
string "name"
string "description"
int "org_id"
int "system_count"
53.11 listInactiveSystemsInGroup
Description
Lists inactive systems within a server group using a specied inactivity time.
Parameters
string sessionKey
string systemGroupName
int daysInactive - Number of days a system must not check in to be consideredinactive.
Return Value
array:
int - server_id
53.12 listInactiveSystemsInGroup
Description
Lists inactive systems within a server group using the default 1 day threshold.
Parameters
string sessionKey
string systemGroupName
Return Value
482 listInactiveSystemsInGroup SUSE Manager 24
array:
int - server_id
53.13 listSystems
Description
Return a list of systems associated with this system group. User must have access to thissystem group.
Parameters
string sessionKey
string systemGroupName
Return Value
array:
struct - server details
int "id" - System id
string "prole_name"
string "machine_id"
string "minion_id"
string "base_entitlement" - System's base entitlement label
array "string"
addon_entitlements - System's addon entitlements labels, currentlyonly 'virtualization_host'
boolean "auto_update" - True if system has auto errata updates enabled.
string "release" - The Operating System release (i.e. 4AS, 5Server
string "address1"
string "address2"
string "city"
string "state"
string "country"
string "building"
483 listSystems SUSE Manager 24
string "room"
string "rack"
string "description"
string "hostname"
dateTime.iso8601 "last_boot"
string "osa_status" - Either 'unknown', 'oine', or 'online'.
boolean "lock_status" - True indicates that the system is locked. Falseindicates that the system is unlocked.
string "virtualization" - Virtualization type - for virtual guests only(optional)
string "contact_method" - One of the following:
default
ssh-push
ssh-push-tunnel
53.14 listSystemsMinimal
Description
Return a list of systems associated with this system group. User must have access to thissystem group.
Parameters
string sessionKey
string systemGroupName
Return Value
array:
struct - system
int "id"
string "name"
dateTime.iso8601 "last_checkin" - Last time server successfully checked in
dateTime.iso8601 "created" - Server registration time
dateTime.iso8601 "last_boot" - Last server boot time
484 listSystemsMinimal SUSE Manager 24
int "extra_pkg_count" - Number of packages not belonging to any assignedchannelint "outdated_pkg_count" - Number of out-of-date packages
53.15 scheduleApplyErrataToActiveDescription
Schedules an action to apply errata updates to active systems from a group.Available since API version: 13.0
Parameters
string sessionKeystring systemGroupNamearray:
int - errataId
Return Value
array:
int - actionId
53.16 scheduleApplyErrataToActiveDescription
Schedules an action to apply errata updates to active systems from a group at a givendate/time.Available since API version: 13.0
Parameters
string sessionKeystring systemGroupNamearray:
int - errataIddateTime.iso8601 earliestOccurrence
485 scheduleApplyErrataToActive SUSE Manager 24
Return Value
array:
int - actionId
53.17 scheduleApplyErrataToActive
Description
Schedules an action to apply errata updates to active systems from a group at a givendate/time.Available since API version: 24
Parameters
string sessionKeystring systemGroupNamearray:
int - errataIddateTime.iso8601 earliestOccurrence
Return Value
array:
int - actionId
53.18 update
Description
Update an existing system group.
Parameters
string sessionKeystring systemGroupNamestring description
486 scheduleApplyErrataToActive SUSE Manager 24
Return Value
struct - Server Group
int "id"string "name"string "description"int "org_id"int "system_count"
487 update SUSE Manager 24
54 user
User namespace contains methods to access common user functions available fromthe web user interface.
54.1 addAssignedSystemGroupDescription
Add system group to user's list of assigned system groups.
Parameters
string sessionKeystring login - User's login name.string serverGroupNameboolean setDefault - Should system group also be added to user's list of default systemgroups.
Return Value
int - 1 on success, exception thrown otherwise.
54.2 addAssignedSystemGroupsDescription
Add system groups to user's list of assigned system groups.
Parameters
string sessionKeystring login - User's login name.array:
string - serverGroupNameboolean setDefault - Should system groups also be added to user's list of default systemgroups.
Return Value
488 addAssignedSystemGroup SUSE Manager 24
int - 1 on success, exception thrown otherwise.
54.3 addDefaultSystemGroupDescription
Add system group to user's list of default system groups.
Parameters
string sessionKeystring login - User's login name.string serverGroupName
Return Value
int - 1 on success, exception thrown otherwise.
54.4 addDefaultSystemGroupsDescription
Add system groups to user's list of default system groups.
Parameters
string sessionKeystring login - User's login name.array:
string - serverGroupName
Return Value
int - 1 on success, exception thrown otherwise.
54.5 addRoleDescription
489 addDefaultSystemGroup SUSE Manager 24
Adds a role to a user.
Parameters
string sessionKey
string login - User login name to update.
string role - Role label to add. Can be any of: satellite_admin, org_admin,channel_admin, cong_admin, system_group_admin, or activation_key_admin.
Return Value
int - 1 on success, exception thrown otherwise.
54.6 create
Description
Create a new user.
Parameters
string sessionKey
string desiredLogin - Desired login name, will fail if already in use.
string desiredPassword
string rstName
string lastName
string email - User's e-mail address.
Return Value
int - 1 on success, exception thrown otherwise.
54.7 create
Description
Create a new user.
Parameters
490 create SUSE Manager 24
string sessionKeystring desiredLogin - Desired login name, will fail if already in use.string desiredPasswordstring rstNamestring lastNamestring email - User's e-mail address.int usePamAuth - 1 if you wish to use PAM authentication for this user, 0 otherwise.
Return Value
int - 1 on success, exception thrown otherwise.
54.8 delete
Description
Delete a user.
Parameters
string sessionKeystring login - User login name to delete.
Return Value
int - 1 on success, exception thrown otherwise.
54.9 disable
Description
Disable a user.
Parameters
string sessionKeystring login - User login name to disable.
Return Value
491 delete SUSE Manager 24
int - 1 on success, exception thrown otherwise.
54.10 enableDescription
Enable a user.
Parameters
string sessionKeystring login - User login name to enable.
Return Value
int - 1 on success, exception thrown otherwise.
54.11 getCreateDefaultSystemGroupDescription
Returns the current value of the CreateDefaultSystemGroup setting. If True this will causethere to be a system group created (with the same name as the user) every time a newuser is created, with the user automatically given permission to that system group and thesystem group being set as the default group for the user (so every time the user registersa system it will be placed in that system group by default). This can be useful if dierentusers will administer dierent groups of servers in the same organization. Can only becalled by an org_admin.
Parameters
string sessionKey
Return Value
int - 1 on success, exception thrown otherwise.
54.12 getDetailsDescription
492 enable SUSE Manager 24
Returns the details about a given user.
Parameters
string sessionKey
string login - User's login name.
Return Value
struct - user details
string "rst_names" - deprecated, use rst_name
string "rst_name"
string "last_name"
string "email"
int "org_id"
string "org_name"
string "prex"
string "last_login_date"
string "created_date"
boolean "enabled" - true if user is enabled, false if the user is disabled
boolean "use_pam" - true if user is congured to use PAM authentication
boolean "read_only" - true if user is readonly
boolean "errata_notication" - true if errata e-mail notication is enabled forthe user
54.13 getLoggedInTime
Description
Returns the time user last logged in.Deprecated - Never returned usable value.
Parameters
string sessionKey
string login - User's login name.
Return Value
493 getLoggedInTime SUSE Manager 24
dateTime.iso8601 date
54.14 listAssignableRoles
Description
Returns a list of user roles that this user can assign to others.
Parameters
string sessionKey
Return Value
array:
string - (role label)
54.15 listAssignedSystemGroups
Description
Returns the system groups that a user can administer.
Parameters
string sessionKey
string login - User's login name.
Return Value
array:
struct - system group
int "id"
string "name"
string "description"
494 listAssignableRoles SUSE Manager 24
int "system_count"
int "org_id" - Organization ID for this system group.
54.16 listDefaultSystemGroups
Description
Returns a user's list of default system groups.
Parameters
string sessionKey
string login - User's login name.
Return Value
array:
struct - system group
int "id"
string "name"
string "description"
int "system_count"
int "org_id" - Organization ID for this system group.
54.17 listRoles
Description
Returns a list of the user's roles.
Parameters
string sessionKey
string login - User's login name.
Return Value
495 listDefaultSystemGroups SUSE Manager 24
array:
string - (role label)
54.18 listUsers
Description
Returns a list of users in your organization.
Parameters
string sessionKey
Return Value
array:
struct - user
int "id"string "login"string "login_uc" - upper case version of the loginboolean "enabled" - true if user is enabled, false if the user is disabled
54.19 removeAssignedSystemGroup
Description
Remove system group from the user's list of assigned system groups.
Parameters
string sessionKeystring login - User's login name.string serverGroupNameboolean setDefault - Should system group also be removed from the user's list ofdefault system groups.
Return Value
496 listUsers SUSE Manager 24
int - 1 on success, exception thrown otherwise.
54.20 removeAssignedSystemGroups
Description
Remove system groups from a user's list of assigned system groups.
Parameters
string sessionKey
string login - User's login name.
array:
string - serverGroupName
boolean setDefault - Should system groups also be removed from the user's list ofdefault system groups.
Return Value
int - 1 on success, exception thrown otherwise.
54.21 removeDefaultSystemGroup
Description
Remove a system group from user's list of default system groups.
Parameters
string sessionKey
string login - User's login name.
string serverGroupName
Return Value
497 removeAssignedSystemGroups SUSE Manager 24
int - 1 on success, exception thrown otherwise.
54.22 removeDefaultSystemGroupsDescription
Remove system groups from a user's list of default system groups.
Parameters
string sessionKeystring login - User's login name.array:
string - serverGroupName
Return Value
int - 1 on success, exception thrown otherwise.
54.23 removeRoleDescription
Remove a role from a user.
Parameters
string sessionKeystring login - User login name to update.string role - Role label to remove. Can be any of: satellite_admin, org_admin,channel_admin, cong_admin, system_group_admin, or activation_key_admin.
Return Value
int - 1 on success, exception thrown otherwise.
54.24 setCreateDefaultSystemGroupDescription
498 removeDefaultSystemGroups SUSE Manager 24
Sets the value of the CreateDefaultSystemGroup setting. If True this will cause there to bea system group created (with the same name as the user) every time a new user is created,with the user automatically given permission to that system group and the system groupbeing set as the default group for the user (so every time the user registers a system itwill be placed in that system group by default). This can be useful if dierent users willadminister dierent groups of servers in the same organization. Can only be called by anorg_admin.
Parameters
string sessionKey
boolean createDefaultSystemGruop - True if we should automatically create systemgroups, false otherwise.
Return Value
int - 1 on success, exception thrown otherwise.
54.25 setDetails
Description
Updates the details of a user.
Parameters
string sessionKey
string login - User's login name.
struct - user details
string "rst_names" - deprecated, use rst_name
string "rst_name"
string "last_name"
string "email"
string "prex"
string "password"
Return Value
499 setDetails SUSE Manager 24
int - 1 on success, exception thrown otherwise.
54.26 setErrataNotificationsDescription
Enables/disables errata mail notications for a specic user.
Parameters
string sessionKeystring login - User's login name.boolean value - True for enabling errata notications, False for disabling
Return Value
int - 1 on success, exception thrown otherwise.
54.27 setReadOnlyDescription
Sets whether the target user should have only read-only API access or standard full scaleaccess.
Parameters
string sessionKeystring login - User's login name.boolean readOnly - Sets whether the target user should have only read-only APIaccess or standard full scale access.
Return Value
int - 1 on success, exception thrown otherwise.
54.28 usePamAuthenticationDescription
500 setErrataNotifications SUSE Manager 24
Toggles whether or not a user uses PAM authentication or basic SUSE Managerauthentication.
Parameters
string sessionKeystring login - User's login name.int pam_value
1 to enable PAM authentication0 to disable.
Return Value
int - 1 on success, exception thrown otherwise.
501 usePamAuthentication SUSE Manager 24
55 user.external
If you are using IPA integration to allow authentication of users from an externalIPA server (rare) the users will still need to be created in the SUSE Managerdatabase. Methods in this namespace allow you to congure some specics of howthis happens, like what organization they are created in or what roles they willhave. These options can also be set in the web admin interface.
55.1 createExternalGroupToRoleMapDescription
Externally authenticated users may be members of external groups. You can use thesegroups to assign additional roles to the users when they log in. Can only be called by aSUSE Manager Administrator.
Parameters
string sessionKeystring name - Name of the external group. Must be unique.array:
string - role - Can be any of: satellite_admin, org_admin (implies all other rolesexcept for satellite_admin), channel_admin, cong_admin, system_group_admin,or activation_key_admin.
Return Value
struct - externalGroup
string "name"array "roles"
string - role
55.2 createExternalGroupToSystemGroupMapDescription
502 createExternalGroupToRoleMap SUSE Manager 24
Externally authenticated users may be members of external groups. You can use thesegroups to give access to server groups to the users when they log in. Can only be calledby an org_admin.
Parameters
string sessionKeystring name - Name of the external group. Must be unique.array:
string - groupName - The names of the server groups to grant access to.
Return Value
struct - externalGroup
string "name"array "roles"
string - role
55.3 deleteExternalGroupToRoleMapDescription
Delete the role map for an external group. Can only be called by a SUSE ManagerAdministrator.
Parameters
string sessionKeystring name - Name of the external group.
Return Value
int - 1 on success, exception thrown otherwise.
55.4 deleteExternalGroupToSystemGroupMapDescription
503 deleteExternalGroupToRoleMap SUSE Manager 24
Delete the server group map for an external group. Can only be called by an org_admin.
Parameters
string sessionKeystring name - Name of the external group.
Return Value
int - 1 on success, exception thrown otherwise.
55.5 getDefaultOrg
Description
Get the default org that users should be added in if orgunit from IPA server isn't found oris disabled. Can only be called by a SUSE Manager Administrator.
Parameters
string sessionKey
Return Value
int id - Id of the default organization. 0 if there is no default
55.6 getExternalGroupToRoleMap
Description
Get a representation of the role mapping for an external group. Can only be called by aSUSE Manager Administrator.
Parameters
string sessionKeystring name - Name of the external group.
Return Value
struct - externalGroup
504 getDefaultOrg SUSE Manager 24
string "name"
array "roles"
string - role
55.7 getExternalGroupToSystemGroupMap
Description
Get a representation of the server group mapping for an external group. Can only be calledby an org_admin.
Parameters
string sessionKey
string name - Name of the external group.
Return Value
struct - externalGroup
string "name"
array "roles"
string - role
55.8 getKeepTemporaryRoles
Description
Get whether we should keeps roles assigned to users because of their IPA groups evenafter they log in through a non-IPA method. Can only be called by a SUSE ManagerAdministrator.
Parameters
string sessionKey
Return Value
505 getExternalGroupToSystemGroupMap SUSE Manager 24
boolean keep - True if we should keep roles after users log in through non-IPAmethod, false otherwise
55.9 getUseOrgUnit
Description
Get whether we place users into the organization that corresponds to the "orgunit" seton the IPA server. The orgunit name must match exactly the SUSE Manager organizationname. Can only be called by a SUSE Manager Administrator.
Parameters
string sessionKey
Return Value
boolean use - True if we should use the IPA orgunit to determine which organizationto create the user in, false otherwise
55.10 listExternalGroupToRoleMaps
Description
List role mappings for all known external groups. Can only be called by a SUSE ManagerAdministrator.
Parameters
string sessionKey
Return Value
array:
struct - externalGroup
string "name"
array "roles"
506 getUseOrgUnit SUSE Manager 24
string - role
55.11 listExternalGroupToSystemGroupMaps
Description
List server group mappings for all known external groups. Can only be called by anorg_admin.
Parameters
string sessionKey
Return Value
array:
struct - externalGroup
string "name"
array "roles"
string - role
55.12 setDefaultOrg
Description
Set the default org that users should be added in if orgunit from IPA server isn't found oris disabled. Can only be called by a SUSE Manager Administrator.
Parameters
string sessionKey
int defaultOrg - Id of the organization to set as the default org. 0 if there should notbe a default organization.
Return Value
507 listExternalGroupToSystemGroupMaps SUSE Manager 24
int - 1 on success, exception thrown otherwise.
55.13 setExternalGroupRoles
Description
Update the roles for an external group. Replace previously set roles with the ones passedin here. Can only be called by a SUSE Manager Administrator.
Parameters
string sessionKey
string name - Name of the external group.
array:
string - role - Can be any of: satellite_admin, org_admin (implies all other rolesexcept for satellite_admin), channel_admin, cong_admin, system_group_admin,or activation_key_admin.
Return Value
int - 1 on success, exception thrown otherwise.
55.14 setExternalGroupSystemGroups
Description
Update the server groups for an external group. Replace previously set server groups withthe ones passed in here. Can only be called by an org_admin.
Parameters
string sessionKey
string name - Name of the external group.
array:
string - groupName - The names of the server groups to grant access to.
Return Value
508 setExternalGroupRoles SUSE Manager 24
int - 1 on success, exception thrown otherwise.
55.15 setKeepTemporaryRoles
Description
Set whether we should keeps roles assigned to users because of their IPA groups evenafter they log in through a non-IPA method. Can only be called by a SUSE ManagerAdministrator.
Parameters
string sessionKeyboolean keepRoles - True if we should keep roles after users log in through non-IPAmethod, false otherwise.
Return Value
int - 1 on success, exception thrown otherwise.
55.16 setUseOrgUnit
Description
Set whether we place users into the organization that corresponds to the "orgunit" set onthe IPA server. The orgunit name must match exactly the SUSE Manager organizationname. Can only be called by a SUSE Manager Administrator.
Parameters
string sessionKeyboolean useOrgUnit - True if we should use the IPA orgunit to determine whichorganization to create the user in, false otherwise.
Return Value
int - 1 on success, exception thrown otherwise.
509 setKeepTemporaryRoles SUSE Manager 24
56 virtualhostmanager
Provides the namespace for the Virtual Host Manager methods.
56.1 createDescription
Creates a Virtual Host Manager from given arguments
Parameters
string sessionKey - Session token, issued at loginstring label - Virtual Host Manager labelstring moduleName - the name of the Gatherer moduleparameters parameters - additional parameters (credentials, parameters for virtual-host-gatherer)
Return Value
int - 1 on success, exception thrown otherwise.
56.2 deleteDescription
Deletes a Virtual Host Manager with a given label
Parameters
string sessionKey - Session token, issued at loginstring label - Virtual Host Manager label
Return Value
int - 1 on success, exception thrown otherwise.
56.3 getDetailDescription
510 create SUSE Manager 24
Gets details of a Virtual Host Manager with a given label
Parameters
string sessionKey - Session token, issued at login
string label - Virtual Host Manager label
Return Value
struct - virtual host manager
string "label"
int "org_id"
string "gatherer_module"
struct "congs"
56.4 getModuleParameters
Description
Get a list of parameters for a virtual-host-gatherer module. It returns a map of parameterswith their typical default values.
Parameters
string sessionKey - Session token, issued at login
string moduleName - The name of the module
Return Value
map module_params - module parameters
56.5 listAvailableVirtualHostGathererModules
Description
List all available modules from virtual-host-gatherer
Parameters
511 getModuleParameters SUSE Manager 24
string sessionKey - Session token, issued at login
Return Value
array:
string - moduleName
56.6 listVirtualHostManagers
Description
Lists Virtual Host Managers visible to a user
Parameters
string sessionKey - Session token, issued at login
Return Value
array:
struct - virtual host manager
string "label"int "org_id"string "gatherer_module"struct "congs"
512 listVirtualHostManagers SUSE Manager 24
Colophon
This documentation is written in DocBook (see http://www.docbook.org ). The XML sourceles were validated by xmllint , processed by xsltproc , and converted into XSL-FO using acustomized version of Norman Walsh's stylesheets. The nal PDF is formatted through XEP fromRenderX. The open source tools and the environment used to build this manual are available inthe package daps . The project's home page can be found at http://daps.sf.net/ .
513 SUSE Manager 24