api documentation: suse manager 4

API Documentation

SUSE Manager 4.2February 02, 2022

Table of ContentsFrequently Asked Questions 1

1. What programming languages are supported by the Uyuni API? 22. When trying to call a specific function, the error "Fault returned from XML RPCServer, fault code -1: Could not find method METHOD in class…" is given. What iswrong? 33. Should I call an API method using the naming scheme "methodName" or"method_name"? 4

Script Examples 54. Perl Example 6

4.1. List users with Perl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65. Python 2 Example 7

5.1. List users with Python 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76. Python 3 Examples 8

6.1. List users with SSL support with Python 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86.2. List users with Python 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

7. Ruby Example 97.1. List all channels with Ruby . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

actionchain 108. Available methods 119. Description 1210. Method: addConfigurationDeployment 1311. Method: addErrataUpdate 1412. Method: addPackageInstall 1513. Method: addPackageRemoval 1614. Method: addPackageUpgrade 1715. Method: addPackageVerify 1816. Method: addScriptRun 1917. Method: addScriptRun 2018. Method: addSystemReboot 2119. Method: createChain 2220. Method: deleteChain 2321. Method: listChainActions 2422. Method: listChains 2523. Method: removeAction 2624. Method: renameChain 2725. Method: scheduleChain 28

activationkey 2926. Available methods 3027. Description 3128. Method: addChildChannels 3229. Method: addConfigChannels 33

30. Method: addEntitlements 3431. Method: addPackages 3532. Method: addServerGroups 3633. Method: checkConfigDeployment 3734. Method: clone 3835. Method: create 3936. Method: create 4037. Method: delete 4138. Method: disableConfigDeployment 4239. Method: enableConfigDeployment 4340. Method: getDetails 4441. Method: listActivatedSystems 4642. Method: listActivationKeys 4743. Method: listChannels 4944. Method: listConfigChannels 5045. Method: removeChildChannels 5146. Method: removeConfigChannels 5247. Method: removeEntitlements 5348. Method: removePackages 5449. Method: removeServerGroups 5550. Method: setConfigChannels 5651. Method: setDetails 57

admin.monitoring 5852. Available methods 5953. Description 6054. Method: disable 6155. Method: enable 6256. Method: getStatus 63

ansible 6457. Available methods 6558. Description 6659. Method: createAnsiblePath 6760. Method: discoverPlaybooks 6861. Method: fetchPlaybookContents 6962. Method: introspectInventory 7063. Method: listAnsiblePaths 7164. Method: lookupAnsiblePathById 7265. Method: removeAnsiblePath 7366. Method: schedulePlaybook 7467. Method: schedulePlaybook 7568. Method: schedulePlaybook 7669. Method: schedulePlaybook 7770. Method: updateAnsiblePath 78

api 79

71. Available methods 8072. Description 8173. Method: getApiCallList 8274. Method: getApiNamespaceCallList 8375. Method: getApiNamespaces 8476. Method: getVersion 8577. Method: systemVersion 86

audit 8778. Available methods 8879. Description 8980. Method: listImagesByPatchStatus 9081. Method: listImagesByPatchStatus 9182. Method: listSystemsByPatchStatus 9383. Method: listSystemsByPatchStatus 94

auth 9684. Available methods 9785. Description 9886. Method: login 9987. Method: login 10088. Method: logout 101

channel 10289. Available methods 10390. Description 10491. Method: listAllChannels 10592. Method: listManageableChannels 10693. Method: listMyChannels 10794. Method: listPopularChannels 10895. Method: listRetiredChannels 10996. Method: listSharedChannels 11097. Method: listSoftwareChannels 11198. Method: listVendorChannels 112

channel.access 11399. Available methods 114100. Description 115101. Method: disableUserRestrictions 116102. Method: enableUserRestrictions 117103. Method: getOrgSharing 118104. Method: setOrgSharing 119

channel.org 120105. Available methods 121106. Description 122107. Method: disableAccess 123108. Method: enableAccess 124109. Method: list 125

channel.software 126110. Available methods 127111. Description 130112. Method: addPackages 131113. Method: addRepoFilter 132114. Method: alignMetadata 133115. Method: applyChannelState 134116. Method: associateRepo 135117. Method: clearRepoFilters 137118. Method: clone 138119. Method: create 139120. Method: create 140121. Method: create 141122. Method: create 142123. Method: createRepo 143124. Method: createRepo 144125. Method: createRepo 145126. Method: delete 146127. Method: disassociateRepo 147128. Method: getChannelLastBuildById 149129. Method: getDetails 150130. Method: getDetails 152131. Method: getRepoDetails 154132. Method: getRepoDetails 155133. Method: getRepoSyncCronExpression 156134. Method: isExisting 157135. Method: isGloballySubscribable 158136. Method: isUserManageable 159137. Method: isUserSubscribable 160138. Method: listAllPackages 161139. Method: listAllPackages 162140. Method: listAllPackages 163141. Method: listArches 164142. Method: listChannelRepos 165143. Method: listChildren 166144. Method: listErrata 168145. Method: listErrata 169146. Method: listErrata 170147. Method: listErrata 171148. Method: listErrataByType 172149. Method: listErrataNeedingSync 173150. Method: listLatestPackages 174151. Method: listPackagesWithoutChannel 175152. Method: listRepoFilters 176153. Method: listSubscribedSystems 177

154. Method: listSystemChannels 178155. Method: listUserRepos 179156. Method: mergeErrata 180157. Method: mergeErrata 181158. Method: mergeErrata 182159. Method: mergePackages 183160. Method: mergePackages 184161. Method: regenerateNeededCache 185162. Method: regenerateNeededCache 186163. Method: regenerateYumCache 187164. Method: removeErrata 188165. Method: removePackages 189166. Method: removeRepo 190167. Method: removeRepo 191168. Method: removeRepoFilter 192169. Method: setContactDetails 193170. Method: setDetails 194171. Method: setDetails 195172. Method: setGloballySubscribable 196173. Method: setRepoFilters 197174. Method: setUserManageable 198175. Method: setUserSubscribable 199176. Method: syncErrata 200177. Method: syncRepo 201178. Method: syncRepo 202179. Method: syncRepo 203180. Method: syncRepo 204181. Method: syncRepo 205182. Method: updateRepo 206183. Method: updateRepoLabel 207184. Method: updateRepoLabel 208185. Method: updateRepoSsl 209186. Method: updateRepoSsl 210187. Method: updateRepoUrl 211188. Method: updateRepoUrl 212

configchannel 213189. Available methods 214190. Description 216191. Method: channelExists 217192. Method: create 218193. Method: create 219194. Method: create 220195. Method: createOrUpdatePath 221196. Method: createOrUpdateSymlink 223197. Method: deleteChannels 225

198. Method: deleteFileRevisions 226199. Method: deleteFiles 227200. Method: deployAllSystems 228201. Method: deployAllSystems 229202. Method: deployAllSystems 230203. Method: deployAllSystems 231204. Method: getDetails 232205. Method: getDetails 233206. Method: getEncodedFileRevision 234207. Method: getFileRevision 236208. Method: getFileRevisions 238209. Method: listAssignedSystemGroups 240210. Method: listFiles 241211. Method: listGlobals 242212. Method: listSubscribedSystems 243213. Method: lookupChannelInfo 244214. Method: lookupFileInfo 245215. Method: lookupFileInfo 247216. Method: scheduleFileComparisons 249217. Method: update 250218. Method: updateInitSls 251

contentmanagement 253219. Available methods 254220. Description 256221. Method: attachFilter 257222. Method: attachSource 258223. Method: attachSource 259224. Method: buildProject 260225. Method: buildProject 261226. Method: createEnvironment 262227. Method: createFilter 263228. Method: createProject 265229. Method: detachFilter 266230. Method: detachSource 267231. Method: listFilterCriteria 268232. Method: listFilters 269233. Method: listProjectEnvironments 270234. Method: listProjectFilters 271235. Method: listProjectSources 272236. Method: listProjects 273237. Method: lookupEnvironment 274238. Method: lookupFilter 275239. Method: lookupProject 276240. Method: lookupSource 277241. Method: promoteProject 278

242. Method: removeEnvironment 279243. Method: removeFilter 280244. Method: removeProject 281245. Method: updateEnvironment 282246. Method: updateFilter 283247. Method: updateProject 284

distchannel 285248. Available methods 286249. Description 287250. Method: listDefaultMaps 288251. Method: listMapsForOrg 289252. Method: listMapsForOrg 290253. Method: setMapForOrg 291

errata 292254. Available methods 293255. Description 294256. Method: addPackages 295257. Method: applicableToChannels 296258. Method: bugzillaFixes 297259. Method: clone 298260. Method: cloneAsOriginal 299261. Method: cloneAsOriginalAsync 300262. Method: cloneAsync 301263. Method: create 302264. Method: delete 304265. Method: findByCve 305266. Method: getDetails 306267. Method: listAffectedSystems 307268. Method: listCves 308269. Method: listKeywords 309270. Method: listPackages 310271. Method: publish 312272. Method: publishAsOriginal 313273. Method: removePackages 314274. Method: setDetails 315

formula 317275. Available methods 318276. Description 319277. Method: getCombinedFormulaDataByServerIds 320278. Method: getCombinedFormulasByServerId 321279. Method: getFormulasByGroupId 322280. Method: getFormulasByServerId 323281. Method: getGroupFormulaData 324282. Method: getSystemFormulaData 325

283. Method: listFormulas 326284. Method: setFormulasOfGroup 327285. Method: setFormulasOfServer 328286. Method: setGroupFormulaData 329287. Method: setSystemFormulaData 330

image 331288. Available methods 332289. Description 333290. Method: delete 334291. Method: getCustomValues 335292. Method: getDetails 336293. Method: getRelevantErrata 338294. Method: importImage 339295. Method: listImages 340296. Method: listPackages 341297. Method: scheduleImageBuild 342

image.profile 343298. Available methods 344299. Description 345300. Method: create 346301. Method: create 347302. Method: delete 348303. Method: deleteCustomValues 349304. Method: getCustomValues 350305. Method: getDetails 351306. Method: listImageProfileTypes 352307. Method: listImageProfiles 353308. Method: setCustomValues 354309. Method: setDetails 355

image.store 356310. Available methods 357311. Description 358312. Method: create 359313. Method: delete 360314. Method: getDetails 361315. Method: listImageStoreTypes 362316. Method: listImageStores 363317. Method: setDetails 364

kickstart 365318. Available methods 366319. Description 367320. Method: cloneProfile 368321. Method: createProfile 369322. Method: createProfile 370

323. Method: createProfileWithCustomUrl 371324. Method: createProfileWithCustomUrl 372325. Method: deleteProfile 373326. Method: disableProfile 374327. Method: findKickstartForIp 375328. Method: importFile 376329. Method: importFile 377330. Method: importFile 378331. Method: importRawFile 379332. Method: importRawFile 380333. Method: isProfileDisabled 381334. Method: listAllIpRanges 382335. Method: listAutoinstallableChannels 383336. Method: listKickstartableChannels 385337. Method: listKickstarts 387338. Method: renameProfile 388

kickstart.filepreservation 389339. Available methods 390340. Description 391341. Method: create 392342. Method: delete 393343. Method: getDetails 394344. Method: listAllFilePreservations 395

kickstart.keys 396345. Available methods 397346. Description 398347. Method: create 399348. Method: delete 400349. Method: getDetails 401350. Method: listAllKeys 402351. Method: update 403

kickstart.profile 404352. Available methods 405353. Description 407354. Method: addIpRange 408355. Method: addScript 409356. Method: addScript 410357. Method: addScript 411358. Method: compareActivationKeys 412359. Method: compareAdvancedOptions 415360. Method: comparePackages 416361. Method: downloadKickstart 417362. Method: downloadRenderedKickstart 418363. Method: getAdvancedOptions 419

364. Method: getAvailableRepositories 420365. Method: getCfgPreservation 421366. Method: getChildChannels 422367. Method: getCustomOptions 423368. Method: getKickstartTree 424369. Method: getRepositories 425370. Method: getUpdateType 426371. Method: getVariables 427372. Method: getVirtualizationType 428373. Method: listIpRanges 429374. Method: listScripts 430375. Method: orderScripts 431376. Method: removeIpRange 432377. Method: removeScript 433378. Method: setAdvancedOptions 434379. Method: setCfgPreservation 435380. Method: setChildChannels 436381. Method: setCustomOptions 437382. Method: setKickstartTree 438383. Method: setLogging 439384. Method: setRepositories 440385. Method: setUpdateType 441386. Method: setVariables 442387. Method: setVirtualizationType 443

kickstart.profile.keys 444388. Available methods 445389. Description 446390. Method: addActivationKey 447391. Method: getActivationKeys 448392. Method: removeActivationKey 450

kickstart.profile.software 451393. Available methods 452394. Description 453395. Method: appendToSoftwareList 454396. Method: getSoftwareDetails 455397. Method: getSoftwareList 456398. Method: setSoftwareDetails 457399. Method: setSoftwareList 458400. Method: setSoftwareList 459

kickstart.profile.system 460401. Available methods 461402. Description 462403. Method: addFilePreservations 463404. Method: addKeys 464

405. Method: checkConfigManagement 465406. Method: checkRemoteCommands 466407. Method: disableConfigManagement 467408. Method: disableRemoteCommands 468409. Method: enableConfigManagement 469410. Method: enableRemoteCommands 470411. Method: getLocale 471412. Method: getPartitioningScheme 472413. Method: getRegistrationType 473414. Method: getSELinux 474415. Method: listFilePreservations 475416. Method: listKeys 476417. Method: removeFilePreservations 477418. Method: removeKeys 478419. Method: setLocale 479420. Method: setPartitioningScheme 480421. Method: setRegistrationType 481422. Method: setSELinux 482

kickstart.snippet 483423. Available methods 484424. Description 485425. Method: createOrUpdate 486426. Method: delete 487427. Method: listAll 488428. Method: listCustom 489429. Method: listDefault 490

kickstart.tree 491430. Available methods 492431. Description 493432. Method: create 494433. Method: delete 495434. Method: deleteTreeAndProfiles 496435. Method: getDetails 497436. Method: list 498437. Method: listInstallTypes 499438. Method: rename 500439. Method: update 501

maintenance 502440. Available methods 503441. Description 504442. Method: assignScheduleToSystems 505443. Method: createCalendar 506444. Method: createCalendarWithUrl 507445. Method: createSchedule 508

446. Method: createSchedule 509447. Method: deleteCalendar 510448. Method: deleteSchedule 511449. Method: getCalendarDetails 512450. Method: getScheduleDetails 513451. Method: listCalendarLabels 514452. Method: listScheduleNames 515453. Method: listSystemsWithSchedule 516454. Method: refreshCalendar 517455. Method: retractScheduleFromSystems 519456. Method: updateCalendar 520457. Method: updateSchedule 522

org 524458. Available methods 525459. Description 526460. Method: create 527461. Method: delete 529462. Method: getClmSyncPatchesConfig 530463. Method: getDetails 531464. Method: getDetails 532465. Method: getPolicyForScapFileUpload 533466. Method: getPolicyForScapResultDeletion 534467. Method: isContentStagingEnabled 535468. Method: isErrataEmailNotifsForOrg 536469. Method: isOrgConfigManagedByOrgAdmin 537470. Method: listOrgs 538471. Method: listUsers 539472. Method: migrateSystems (Deprecated) 540473. Method: setClmSyncPatchesConfig 541474. Method: setContentStaging 542475. Method: setErrataEmailNotifsForOrg 543476. Method: setOrgConfigManagedByOrgAdmin 544477. Method: setPolicyForScapFileUpload 545478. Method: setPolicyForScapResultDeletion 546479. Method: transferSystems 547480. Method: updateName 548

org.trusts 549481. Available methods 550482. Description 551483. Method: addTrust 552484. Method: getDetails 553485. Method: listChannelsConsumed 554486. Method: listChannelsProvided 555487. Method: listOrgs 556

488. Method: listSystemsAffected 557489. Method: listTrusts 558490. Method: removeTrust 559

packages 560491. Available methods 561492. Description 562493. Method: findByNvrea 563494. Method: getDetails 564495. Method: getPackage 566496. Method: getPackageUrl 567497. Method: listChangelog 568498. Method: listDependencies 569499. Method: listFiles 570500. Method: listProvidingChannels 571501. Method: listProvidingErrata 572502. Method: listSourcePackages 573503. Method: removePackage 574504. Method: removeSourcePackage 575

packages.provider 576505. Available methods 577506. Description 578507. Method: associateKey 579508. Method: list 580509. Method: listKeys 581

packages.search 582510. Available methods 583511. Description 584512. Method: advanced 585513. Method: advancedWithActKey 586514. Method: advancedWithChannel 587515. Method: name 588516. Method: nameAndDescription 589517. Method: nameAndSummary 590

preferences.locale 591518. Available methods 592519. Description 593520. Method: listLocales 594521. Method: listTimeZones 595522. Method: setLocale 596523. Method: setTimeZone 597

proxy 598524. Available methods 599525. Description 600526. Method: activateProxy 601

527. Method: createMonitoringScout 602528. Method: deactivateProxy 603529. Method: isProxy 604530. Method: listAvailableProxyChannels 605531. Method: listProxies 606532. Method: listProxyClients 607

recurringaction 608533. Available methods 609534. Description 610535. Method: create 611536. Method: delete 612537. Method: listByEntity 613538. Method: lookupById 614539. Method: update 615

saltkey 616540. Available methods 617541. Description 618542. Method: accept 619543. Method: acceptedList 620544. Method: delete 621545. Method: deniedList 622546. Method: pendingList 623547. Method: reject 624548. Method: rejectedList 625

schedule 626549. Available methods 627550. Description 628551. Method: archiveActions 629552. Method: cancelActions 630553. Method: deleteActions 631554. Method: failSystemAction 632555. Method: failSystemAction 633556. Method: listAllActions 634557. Method: listAllArchivedActions 635558. Method: listAllCompletedActions 636559. Method: listArchivedActions 637560. Method: listCompletedActions 638561. Method: listCompletedSystems 639562. Method: listFailedActions 640563. Method: listFailedSystems 641564. Method: listInProgressActions 642565. Method: listInProgressSystems 643566. Method: rescheduleActions 644

subscriptionmatching.pinnedsubscription 645

567. Available methods 646568. Description 647569. Method: create 648570. Method: delete 649571. Method: list 650

sync.content 651572. Available methods 652573. Description 653574. Method: addChannel 654575. Method: addChannels 655576. Method: addCredentials 656577. Method: deleteCredentials 657578. Method: listChannels 658579. Method: listCredentials 659580. Method: listProducts 660581. Method: synchronizeChannelFamilies 662582. Method: synchronizeChannels 663583. Method: synchronizeProducts 664584. Method: synchronizeRepositories 665585. Method: synchronizeSubscriptions 666

sync.master 667586. Available methods 668587. Description 669588. Method: addToMaster 670589. Method: create 671590. Method: delete 672591. Method: getDefaultMaster 673592. Method: getMaster 674593. Method: getMasterByLabel 675594. Method: getMasterOrgs 676595. Method: getMasters 677596. Method: hasMaster 678597. Method: makeDefault 679598. Method: mapToLocal 680599. Method: setCaCert 681600. Method: setMasterOrgs 682601. Method: unsetDefaultMaster 683602. Method: update 684

sync.slave 685603. Available methods 686604. Description 687605. Method: create 688606. Method: delete 689607. Method: getAllowedOrgs 690

608. Method: getSlave 691609. Method: getSlaveByName 692610. Method: getSlaves 693611. Method: setAllowedOrgs 694612. Method: update 695

system 696613. Available methods 697614. Description 705615. Method: addEntitlements 706616. Method: addNote 707617. Method: bootstrap 708618. Method: bootstrap 709619. Method: bootstrap 710620. Method: bootstrap 711621. Method: bootstrapWithPrivateSshKey 712622. Method: bootstrapWithPrivateSshKey 713623. Method: bootstrapWithPrivateSshKey 714624. Method: bootstrapWithPrivateSshKey 715625. Method: changeProxy 716626. Method: comparePackageProfile 717627. Method: comparePackages 718628. Method: createPackageProfile 719629. Method: createSystemProfile 720630. Method: createSystemRecord 721631. Method: createSystemRecord 722632. Method: deleteCustomValues 723633. Method: deleteGuestProfiles 724634. Method: deleteNote 725635. Method: deleteNotes 726636. Method: deletePackageProfile 727637. Method: deleteSystem 728638. Method: deleteSystem 729639. Method: deleteSystem 730640. Method: deleteSystems 731641. Method: deleteSystems 732642. Method: deleteTagFromSnapshot 733643. Method: downloadSystemId 734644. Method: getConnectionPath 735645. Method: getCpu 736646. Method: getCustomValues 737647. Method: getDetails 738648. Method: getDevices 740649. Method: getDmi 741650. Method: getEntitlements 742651. Method: getEventDetails 743

652. Method: getEventHistory (Deprecated) 745653. Method: getEventHistory 746654. Method: getEventHistory 747655. Method: getEventHistory 748656. Method: getId 749657. Method: getInstalledProducts 750658. Method: getKernelLivePatch 751659. Method: getMemory 752660. Method: getMinionIdMap 753661. Method: getName 754662. Method: getNetwork 755663. Method: getNetworkDevices 756664. Method: getNetworkForSystems 758665. Method: getOsaPing 759666. Method: getRegistrationDate 760667. Method: getRelevantErrata 761668. Method: getRelevantErrataByType 762669. Method: getRunningKernel 763670. Method: getScriptActionDetails 764671. Method: getScriptResults 765672. Method: getSubscribedBaseChannel 766673. Method: getSystemCurrencyMultipliers 768674. Method: getSystemCurrencyScores 769675. Method: getUnscheduledErrata 770676. Method: getUuid 771677. Method: getVariables 772678. Method: isNvreInstalled 773679. Method: isNvreInstalled 774680. Method: listActivationKeys 775681. Method: listActiveSystems 776682. Method: listActiveSystemsDetails 777683. Method: listAdministrators 780684. Method: listAllInstallablePackages 781685. Method: listDuplicatesByHostname 782686. Method: listDuplicatesByIp 783687. Method: listDuplicatesByMac 784688. Method: listEmptySystemProfiles 785689. Method: listExtraPackages 786690. Method: listFqdns 787691. Method: listGroups 788692. Method: listInactiveSystems 789693. Method: listInactiveSystems 790694. Method: listInstalledPackages 791695. Method: listLatestAvailablePackage 792696. Method: listLatestInstallablePackages 793

697. Method: listLatestUpgradablePackages 794698. Method: listMigrationTargets 795699. Method: listNewerInstalledPackages 796700. Method: listNotes 797701. Method: listOlderInstalledPackages 798702. Method: listOutOfDateSystems 799703. Method: listPackageProfiles 800704. Method: listPackageState 801705. Method: listPackages (Deprecated) 802706. Method: listPackagesFromChannel 803707. Method: listPackagesLockStatus 804708. Method: listPhysicalSystems 805709. Method: listSubscribableBaseChannels 806710. Method: listSubscribableChildChannels 807711. Method: listSubscribedChildChannels 808712. Method: listSuggestedReboot 810713. Method: listSystemEvents 811714. Method: listSystemEvents 813715. Method: listSystemEvents 815716. Method: listSystemEvents 817717. Method: listSystemGroupsForSystemsWithEntitlement 819718. Method: listSystems 820719. Method: listSystemsWithEntitlement 821720. Method: listSystemsWithExtraPackages 822721. Method: listSystemsWithPackage 823722. Method: listSystemsWithPackage 824723. Method: listUngroupedSystems 825724. Method: listUserSystems 826725. Method: listUserSystems 827726. Method: listVirtualGuests 828727. Method: listVirtualHosts 829728. Method: obtainReactivationKey 830729. Method: obtainReactivationKey 831730. Method: provisionSystem 832731. Method: provisionSystem 833732. Method: provisionVirtualGuest 834733. Method: provisionVirtualGuest 835734. Method: provisionVirtualGuest 836735. Method: refreshPillar 837736. Method: refreshPillar 838737. Method: removeEntitlements 839738. Method: scheduleApplyErrata 840739. Method: scheduleApplyErrata 841740. Method: scheduleApplyErrata 842741. Method: scheduleApplyErrata 843

742. Method: scheduleApplyErrata 844743. Method: scheduleApplyErrata 845744. Method: scheduleApplyErrata 846745. Method: scheduleApplyErrata 847746. Method: scheduleApplyErrata 848747. Method: scheduleApplyErrata 849748. Method: scheduleApplyHighstate 850749. Method: scheduleApplyHighstate 851750. Method: scheduleApplyStates 852751. Method: scheduleApplyStates 853752. Method: scheduleCertificateUpdate 854753. Method: scheduleCertificateUpdate 855754. Method: scheduleChangeChannels 856755. Method: scheduleChangeChannels 857756. Method: scheduleDistUpgrade 858757. Method: scheduleDistUpgrade 859758. Method: scheduleGuestAction 860759. Method: scheduleGuestAction 861760. Method: scheduleHardwareRefresh 862761. Method: schedulePackageInstall 863762. Method: schedulePackageInstall 864763. Method: schedulePackageInstall 865764. Method: schedulePackageInstall 866765. Method: schedulePackageInstallByNevra 867766. Method: schedulePackageInstallByNevra 868767. Method: schedulePackageInstallByNevra 869768. Method: schedulePackageInstallByNevra 870769. Method: schedulePackageLockChange 871770. Method: schedulePackageRefresh 872771. Method: schedulePackageRemove 873772. Method: schedulePackageRemove 874773. Method: schedulePackageRemove 875774. Method: schedulePackageRemove 876775. Method: schedulePackageRemoveByNevra 877776. Method: schedulePackageRemoveByNevra 878777. Method: schedulePackageRemoveByNevra 879778. Method: schedulePackageRemoveByNevra 880779. Method: scheduleProductMigration 881780. Method: scheduleProductMigration 882781. Method: scheduleProductMigration 883782. Method: scheduleProductMigration 884783. Method: scheduleReboot 885784. Method: scheduleSPMigration (Deprecated) 886785. Method: scheduleSPMigration (Deprecated) 887786. Method: scheduleSPMigration (Deprecated) 888

787. Method: scheduleSPMigration (Deprecated) 889788. Method: scheduleScriptRun 890789. Method: scheduleScriptRun 891790. Method: scheduleScriptRun 892791. Method: scheduleScriptRun 893792. Method: scheduleSyncPackagesWithSystem 894793. Method: searchByName 895794. Method: sendOsaPing 896795. Method: setBaseChannel (Deprecated) 897796. Method: setBaseChannel (Deprecated) 898797. Method: setChildChannels (Deprecated) 899798. Method: setCustomValues 900799. Method: setDetails 901800. Method: setGroupMembership 902801. Method: setGuestCpus 903802. Method: setGuestMemory 904803. Method: setLockStatus 905804. Method: setPrimaryFqdn 906805. Method: setPrimaryInterface 907806. Method: setProfileName 908807. Method: setVariables 909808. Method: tagLatestSnapshot 910809. Method: unentitle 911810. Method: updatePackageState 912811. Method: upgradeEntitlement 913812. Method: whoRegistered 914

system.config 915813. Available methods 916814. Description 917815. Method: addChannels 918816. Method: createOrUpdatePath 919817. Method: createOrUpdateSymlink 922818. Method: deleteFiles 924819. Method: deployAll 925820. Method: listChannels 926821. Method: listFiles 927822. Method: lookupFileInfo 928823. Method: removeChannels 930824. Method: scheduleApplyConfigChannel 931825. Method: setChannels 932

system.custominfo 933826. Available methods 934827. Description 935828. Method: createKey 936

829. Method: deleteKey 937830. Method: listAllKeys 938831. Method: updateKey 939

system.monitoring 940832. Available methods 941833. Description 942834. Method: listEndpoints 943

system.provisioning.snapshot 944835. Available methods 945836. Description 946837. Method: addTagToSnapshot 947838. Method: deleteSnapshot 948839. Method: deleteSnapshots 949840. Method: deleteSnapshots 950841. Method: listSnapshotConfigFiles 951842. Method: listSnapshotPackages 953843. Method: listSnapshots 954844. Method: rollbackToSnapshot 956845. Method: rollbackToTag 957846. Method: rollbackToTag 958

system.scap 959847. Available methods 960848. Description 961849. Method: deleteXccdfScan 962850. Method: getXccdfScanDetails 963851. Method: getXccdfScanRuleResults 964852. Method: listXccdfScans 965853. Method: scheduleXccdfScan 966854. Method: scheduleXccdfScan 967855. Method: scheduleXccdfScan 968856. Method: scheduleXccdfScan 969857. Method: scheduleXccdfScan 970

system.search 971858. Available methods 972859. Description 973860. Method: deviceDescription 974861. Method: deviceDriver 975862. Method: deviceId 976863. Method: deviceVendorId 977864. Method: hostname 978865. Method: ip 979866. Method: nameAndDescription 980867. Method: uuid 981

systemgroup 982

868. Available methods 983869. Description 984870. Method: addOrRemoveAdmins 985871. Method: addOrRemoveSystems 986872. Method: create 987873. Method: delete 988874. Method: getDetails 989875. Method: getDetails 990876. Method: listActiveSystemsInGroup 991877. Method: listAdministrators 992878. Method: listAllGroups 993879. Method: listAssignedConfigChannels 994880. Method: listAssignedFormuals 995881. Method: listGroupsWithNoAssociatedAdmins 996882. Method: listInactiveSystemsInGroup 997883. Method: listInactiveSystemsInGroup 998884. Method: listSystems 999885. Method: listSystemsMinimal 1001886. Method: scheduleApplyErrataToActive 1002887. Method: scheduleApplyErrataToActive 1003888. Method: scheduleApplyErrataToActive 1004889. Method: subscribeConfigChannel 1005890. Method: unsubscribeConfigChannel 1006891. Method: update 1007

user 1008892. Available methods 1009893. Description 1011894. Method: addAssignedSystemGroup 1012895. Method: addAssignedSystemGroups 1013896. Method: addDefaultSystemGroup 1014897. Method: addDefaultSystemGroups 1015898. Method: addRole 1016899. Method: create 1017900. Method: create 1018901. Method: delete 1019902. Method: disable 1020903. Method: enable 1021904. Method: getCreateDefaultSystemGroup 1022905. Method: getDetails 1023906. Method: listAssignableRoles 1024907. Method: listAssignedSystemGroups 1025908. Method: listDefaultSystemGroups 1026909. Method: listRoles 1027910. Method: listUsers 1028911. Method: removeAssignedSystemGroup 1029

912. Method: removeAssignedSystemGroups 1030913. Method: removeDefaultSystemGroup 1031914. Method: removeDefaultSystemGroups 1032915. Method: removeRole 1033916. Method: setCreateDefaultSystemGroup 1034917. Method: setDetails 1035918. Method: setErrataNotifications 1036919. Method: setReadOnly 1037920. Method: usePamAuthentication 1038

user.external 1039921. Available methods 1040922. Description 1041923. Method: createExternalGroupToRoleMap 1042924. Method: createExternalGroupToSystemGroupMap 1043925. Method: deleteExternalGroupToRoleMap 1044926. Method: deleteExternalGroupToSystemGroupMap 1045927. Method: getDefaultOrg 1046928. Method: getExternalGroupToRoleMap 1047929. Method: getExternalGroupToSystemGroupMap 1048930. Method: getKeepTemporaryRoles 1049931. Method: getUseOrgUnit 1050932. Method: listExternalGroupToRoleMaps 1051933. Method: listExternalGroupToSystemGroupMaps 1052934. Method: setDefaultOrg 1053935. Method: setExternalGroupRoles 1054936. Method: setExternalGroupSystemGroups 1055937. Method: setKeepTemporaryRoles 1056938. Method: setUseOrgUnit 1057

virtualhostmanager 1058939. Available methods 1059940. Description 1060941. Method: create 1061942. Method: delete 1062943. Method: getDetail 1063944. Method: getModuleParameters 1064945. Method: listAvailableVirtualHostGathererModules 1065946. Method: listVirtualHostManagers 1066

Frequently Asked Questions

API Documentation | 1 / 1066

Chapter 1. What programming languages aresupported by the Uyuni API?Any language that provides an XMLRPC client interface will work with the Uyuni API. While Perl and

Python are two of the most commonly used, an XMLRPC client implementation is available for

every common language.

API Documentation | Chapter 1. What programming languages are supported by the Uyuni API? 2 / 1066

Chapter 2. When trying to call a specificfunction, the error "Fault returned from XMLRPC Server, fault code -1: Could not findmethod METHOD in class…" is given. What iswrong?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 passed parameter is incorrect

(Such as an array is expected, but a String is passed). Check all of these things.

API Documentation | Chapter 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?

3 / 1066

Chapter 3. Should I call an API method usingthe naming scheme "methodName" or"method_name"?Both of these are valid names for the same method, so use whichever you prefer.

API Documentation | Chapter 3. Should I call an API method using the naming scheme "methodName" or

"method_name"?

4 / 1066

Script Examples


Chapter 4. Perl Example

4.1. List users with Perl

This Perl example shows the system.listUserSystems call being used to get a list of systems 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);

4.1. List users with Perl

API Documentation | 4.1. List users with Perl 6 / 1066

Chapter 5. Python 2 Example

5.1. List users with Python 2

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

#!/usr/bin/pythonimport xmlrpclib

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

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

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

client.auth.logout(key)

The following code shows how to use date-time parameters. This code will schedule immediate

installation of package rhnlib-2.5.22.9.el6.noarch to system with id 1000000001.

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


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

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



API Documentation | 5.1. List users with Python 2 7 / 1066

Chapter 6. Python 3 Examples

6.1. List users with SSL support with Python 3

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



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

#!/usr/bin/env python3from xmlrpc.client import ServerProxy


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

print(client.user.list_users(key))


6.1. List users with SSL support with Python 3

API Documentation | 6.1. List users with SSL support with Python 3 8 / 1066

Chapter 7. Ruby Example

7.1. List all channels with Ruby

Below is an example of the channel.listAllChannels API call. List of channel labels is 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)

7.1. List all channels with Ruby

API Documentation | 7.1. List all channels with Ruby 9 / 1066

actionchain


Chapter 8. Available methods• addConfigurationDeployment

• addErrataUpdate

• addPackageInstall

• addPackageRemoval

• addPackageUpgrade

• addPackageVerify

• addScriptRun

• addScriptRun

• addSystemReboot

• createChain

• deleteChain

• listChainActions

• listChains

• removeAction

• renameChain

• scheduleChain

API Documentation | Chapter 8. Available methods 11 / 1066

Chapter 9. DescriptionProvides the namespace for the Action Chain methods.

Namespace:

actionchain

API Documentation | Chapter 9. Description 12 / 1066

Chapter 10. Method:addConfigurationDeploymentDescription:

Adds an action to deploy a configuration file to an Action Chain.

Parameters:

• string sessionKey - Session token, issued at login

• string chainLabel - Label of the chain

• int System ID - System ID

• array :

◦ struct - config revision specifier

▪ string "channelLabel" - Channel label

▪ string "filePath" - Path of the configuration file

▪ int "revision" - Revision number

Returns:

• int - 1 on success, exception thrown otherwise.

API Documentation | Chapter 10. Method: addConfigurationDeployment 13 / 1066

Chapter 11. Method: addErrataUpdateDescription:

Adds Errata update to an Action Chain.

Parameters:


• int serverId - System ID

• array :

◦ int - Errata ID


Returns:

• int actionId - The action id of the scheduled action

API Documentation | Chapter 11. Method: addErrataUpdate 14 / 1066

Chapter 12. Method: addPackageInstallDescription:

Adds package installation action to an Action Chain.

Parameters:



• array :

◦ int - Package ID

• string chainLabel

Returns:


API Documentation | Chapter 12. Method: addPackageInstall 15 / 1066

Chapter 13. Method: addPackageRemovalDescription:

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

Parameters:



• array :

◦ int - Package ID


Returns:

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

API Documentation | Chapter 13. Method: addPackageRemoval 16 / 1066

Chapter 14. Method: addPackageUpgradeDescription:

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

Parameters:



• array :

◦ int - packageId


Returns:

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

API Documentation | Chapter 14. Method: addPackageUpgrade 17 / 1066

Chapter 15. Method: addPackageVerifyDescription:

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

Parameters:



• array :

◦ int - packageId


Returns:


API Documentation | Chapter 15. Method: addPackageVerify 18 / 1066

Chapter 16. Method: addScriptRunDescription:

Add an action with label to run a script to an Action Chain. NOTE: The script body must be Base64

encoded!

Parameters:




• string scriptLabel - Label of the script

• string uid - User ID on the particular system

• string gid - Group ID on the particular system

• int timeout - Timeout

• string scriptBodyBase64 - Base64 encoded script body

Returns:


API Documentation | Chapter 16. Method: addScriptRun 19 / 1066

Chapter 17. Method: addScriptRunDescription:

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

Parameters:




• string uid - User ID on the particular system

• string gid - Group ID on the particular system

• int timeout - Timeout

• string scriptBodyBase64 - Base64 encoded script body

Returns:


API Documentation | Chapter 17. Method: addScriptRun 20 / 1066

Chapter 18. Method: addSystemRebootDescription:

Add system reboot to an Action Chain.

Parameters:


• int serverId


Returns:


API Documentation | Chapter 18. Method: addSystemReboot 21 / 1066

Chapter 19. Method: createChainDescription:

Create an Action Chain.

Parameters:



Returns:

• int actionId - The ID of the created action chain

API Documentation | Chapter 19. Method: createChain 22 / 1066

Chapter 20. Method: deleteChainDescription:

Delete action chain by label.

Parameters:



Returns:


API Documentation | Chapter 20. Method: deleteChain 23 / 1066

Chapter 21. Method: listChainActionsDescription:

List all actions in the particular Action Chain.

Parameters:



Returns:

• array :

◦ struct - entry

▪ int "id" - Action ID

▪ string "label" - Label of an Action

▪ string "created" - Created date/time

▪ string "earliest" - Earliest scheduled date/time

▪ string "type" - Type of the action

▪ string "modified" - Modified date/time

▪ string "cuid" - Creator UID

API Documentation | Chapter 21. Method: listChainActions 24 / 1066

Chapter 22. Method: listChainsDescription:

List currently available action chains.

Parameters:


Returns:

• array :

◦ struct - chain

▪ string "label" - Label of an Action Chain

▪ string "entrycount" - Number of entries in the Action Chain

API Documentation | Chapter 22. Method: listChains 25 / 1066

Chapter 23. Method: removeActionDescription:

Remove an action from an Action Chain.

Parameters:



• int actionId - Action ID

Returns:


API Documentation | Chapter 23. Method: removeAction 26 / 1066

Chapter 24. Method: renameChainDescription:

Rename an Action Chain.

Parameters:


• string previousLabel - Previous chain label

• string newLabel - New chain label

Returns:


API Documentation | Chapter 24. Method: renameChain 27 / 1066

Chapter 25. Method: scheduleChainDescription:

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

Parameters:



• dateTime.iso8601 Earliest date

Returns:


API Documentation | Chapter 25. Method: scheduleChain 28 / 1066

activationkey


Chapter 26. Available methods• addChildChannels

• addConfigChannels

• addEntitlements

• addPackages

• addServerGroups

• checkConfigDeployment

• clone

• create

• create

• delete

• disableConfigDeployment

• enableConfigDeployment

• getDetails

• listActivatedSystems

• listActivationKeys

• listChannels

• listConfigChannels

• removeChildChannels

• removeConfigChannels

• removeEntitlements

• removePackages

• removeServerGroups

• setConfigChannels

• setDetails


Chapter 27. DescriptionContains methods to access common activation key functions available from the web interface.

Namespace:

activationkey


Chapter 28. Method: addChildChannelsDescription:

Add child channels to an activation key.

Parameters:

• string sessionKey

• string key

• array :

◦ string - childChannelLabel

Returns:


API Documentation | Chapter 28. Method: addChildChannels 32 / 1066

Chapter 29. Method: addConfigChannelsDescription:

Given a list of activation keys and configuration channels, this method adds given configuration

channels to either the top or the bottom (whichever you specify) of an activation key’s

configuration channels list. The ordering of the configuration channels provided in the add list is

maintained while adding. If one of the configuration channels in the 'add' list already exists in an

activation key, the configuration channel will be re-ranked to the appropriate place.

Parameters:


• array :

◦ string - activationKey

• array :

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

• boolean addToTop

• true - To prepend the given channels to the beginning of the activation key’s config channel

list

• false - To append the given channels to the end of the activation key’s config channel list

Returns:


API Documentation | Chapter 29. Method: addConfigChannels 33 / 1066

Chapter 30. Method: addEntitlementsDescription:

Add add-on System Types to an activation key.

Parameters:


• string key

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

◦ container_build_host

◦ monitoring_entitled

◦ osimage_build_host

◦ virtualization_host

◦ ansible_control_node

Returns:


API Documentation | Chapter 30. Method: addEntitlements 34 / 1066

Chapter 31. Method: addPackagesDescription:

Add packages to an activation key.

Parameters:


• string key

• array :

◦ struct - packages

▪ string "name" - Package name

▪ string "arch" - Arch label - Optional

Returns:


API Documentation | Chapter 31. Method: addPackages 35 / 1066

Chapter 32. Method: addServerGroupsDescription:

Add server groups to an activation key.

Parameters:


• string key

• array :

◦ int - serverGroupId

Returns:


API Documentation | Chapter 32. Method: addServerGroups 36 / 1066

Chapter 33. Method: checkConfigDeploymentDescription:

Check configuration file deployment status for the activation key specified.

Parameters:


• string key

Returns:

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

API Documentation | Chapter 33. Method: checkConfigDeployment 37 / 1066

Chapter 34. Method: cloneDescription:

Clone an existing activation key.

Parameters:


• string key - Key to be cloned.

• string cloneDescription - Description of the cloned key.

Returns:

• string The new activation key

API Documentation | Chapter 34. Method: clone 38 / 1066

Chapter 35. Method: createDescription:

Create a new activation key. The activation key parameter passed in will be prefixed with the

organization ID, and this value will be returned from the create call.

Eg. If the caller passes in the key "foo" and belong to an organization withthe ID 100, the actual activation key will be "100-foo".

This call allows for the setting of a usage limit on this activation key.If unlimited usage is desired see the similarly named API method with nousage limit argument.

Parameters:


• 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 include the

parameter.

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

◦ container_build_host

◦ monitoring_entitled

◦ osimage_build_host


◦ ansible_control_node

• boolean universalDefault

Returns:


API Documentation | Chapter 35. Method: create 39 / 1066


Create a new activation key with unlimited usage. The activation key parameter passed in will be

prefixed with the organization ID, and this value will be returned from the create call.

Eg. If the caller passes in the key "foo" and belong to an organization withthe ID 100, the actual activation key will be "100-foo".

Parameters:


• string key - Leave empty to have new key autogenerated.


• string baseChannelLabel - Leave empty to accept default.

• array string - Add-on entitlement label to associate with the key.


• boolean universalDefault

Returns:



Chapter 37. Method: deleteDescription:

Delete an activation key.

Parameters:


• string key

Returns:


API Documentation | Chapter 37. Method: delete 41 / 1066

Chapter 38. Method:disableConfigDeploymentDescription:

Disable configuration file deployment for the specified activation key.

Parameters:


• string key

Returns:


API Documentation | Chapter 38. Method: disableConfigDeployment 42 / 1066

Chapter 39. Method:enableConfigDeploymentDescription:

Enable configuration file deployment for the specified activation key.

Parameters:


• string key

Returns:


API Documentation | Chapter 39. Method: enableConfigDeployment 43 / 1066

Chapter 40. Method: getDetailsDescription:

Lookup an activation key’s details.

Parameters:


• string key

Returns:

• * 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"

▪ string - packageName - (deprecated by packages)

◦ array "packages"

▪ struct - package

▪ string "name" - packageName

▪ string "arch" - archLabel - optional

◦ boolean "universal_default"

API Documentation | Chapter 40. Method: getDetails 44 / 1066

◦ boolean "disabled"

◦ string "contact_method" - One of the following:

◦ default

◦ ssh-push

◦ ssh-push-tunnel

Available since API version: 10.2


Chapter 41. Method: listActivatedSystemsDescription:

List the systems activated with the key provided.

Parameters:


• string key

Returns:

• array :

◦ struct - system structure

▪ int "id" - System id

▪ string "hostname"

▪ dateTime.iso8601 "last_checkin" - Last time server successfully checked in

API Documentation | Chapter 41. Method: listActivatedSystems 46 / 1066

Chapter 42. Method: listActivationKeysDescription:

List activation keys that are visible to the user.

Parameters:


Returns:

• array :

• struct - activation key

◦ string "key"

















API Documentation | Chapter 42. Method: listActivationKeys 47 / 1066



◦ default

◦ ssh-push

◦ ssh-push-tunnel



Chapter 43. Method: listChannelsDescription:

List the channels for the given activation key with temporary authentication tokens to access

them. Authentication is done via a machine specific password.

Parameters:

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

• string machinePassword - password specific to a machine.

• string activationKey - activation key to use channels from.

Returns:

• array :

• struct - channelInfo

◦ string "label" - Channel label

◦ string "name" - Channel name

◦ string "url" - Channel url

◦ string "token" - Channel access token

API Documentation | Chapter 43. Method: listChannels 49 / 1066

Chapter 44. Method: listConfigChannelsDescription:

List configuration channels associated to an activation key.

Parameters:


• string key

Returns:

• array :

• struct - Configuration Channel information

◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "name"


◦ struct "configChannelType"

• struct - Configuration Channel Type information

◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"

API Documentation | Chapter 44. Method: listConfigChannels 50 / 1066

Chapter 45. Method: removeChildChannelsDescription:

Remove child channels from an activation key.

Parameters:


• string key

• array :

◦ string - childChannelLabel

Returns:


API Documentation | Chapter 45. Method: removeChildChannels 51 / 1066

Chapter 46. Method: removeConfigChannelsDescription:

Remove configuration channels from the given activation keys.

Parameters:


• array :


• array :

◦ string - configChannelLabel

Returns:


API Documentation | Chapter 46. Method: removeConfigChannels 52 / 1066

Chapter 47. Method: removeEntitlementsDescription:

Remove entitlements (by label) from an activation key. Currently only virtualization_host add-on

entitlement is permitted.

Parameters:


• string key

• array string - entitlement label


Returns:


API Documentation | Chapter 47. Method: removeEntitlements 53 / 1066

Chapter 48. Method: removePackagesDescription:

Remove package names from an activation key.

Parameters:


• string key

• array :

◦ struct - packages

▪ string "name" - Package name

▪ string "arch" - Arch label - Optional

Returns:


API Documentation | Chapter 48. Method: removePackages 54 / 1066

Chapter 49. Method: removeServerGroupsDescription:

Remove server groups from an activation key.

Parameters:


• string key

• array :

◦ int - serverGroupId

Returns:


API Documentation | Chapter 49. Method: removeServerGroups 55 / 1066

Chapter 50. Method: setConfigChannelsDescription:

Replace the existing set of configuration channels on the given activation keys. Channels are

ranked by their order in the array.

Parameters:


• array :


• array :

◦ string - configChannelLabel

Returns:


API Documentation | Chapter 50. Method: setConfigChannels 56 / 1066

Chapter 51. Method: setDetailsDescription:

Update the details of an activation key.

Parameters:


• string key


◦ string "description" - optional

◦ string "base_channel_label" - optional - to set default base channel set to empty string

or 'none'

◦ int "usage_limit" - optional

◦ boolean "unlimited_usage_limit" - Set true for unlimited usage and to override

usage_limit

◦ boolean "universal_default" - optional

◦ boolean "disabled" - optional


◦ default

◦ ssh-push

◦ ssh-push-tunnel

Returns:


API Documentation | Chapter 51. Method: setDetails 57 / 1066

admin.monitoring


Chapter 52. Available methods• disable

• enable

• getStatus


Chapter 53. DescriptionProvides methods to manage the monitoring of the Uyuni server.

Namespace:

admin.monitoring


Chapter 54. Method: disableDescription:

Disable monitoring.

Parameters:


Returns:

• array :

◦ struct - Exporters

▪ string "node"

▪ string "tomcat"

▪ string "taskomatic"

▪ string "postgres"

▪ string "self_monitoring"

API Documentation | Chapter 54. Method: disable 61 / 1066

Chapter 55. Method: enableDescription:

Enable monitoring.

Parameters:


Returns:

• array :


▪ string "node"

▪ string "tomcat"




API Documentation | Chapter 55. Method: enable 62 / 1066

Chapter 56. Method: getStatusDescription:

Get the status of each Prometheus exporter.

Parameters:


Returns:

• array :


▪ string "node"

▪ string "tomcat"




API Documentation | Chapter 56. Method: getStatus 63 / 1066

ansible


Chapter 57. Available methods• createAnsiblePath

• discoverPlaybooks

• fetchPlaybookContents

• introspectInventory

• listAnsiblePaths

• lookupAnsiblePathById

• removeAnsiblePath

• schedulePlaybook




• updateAnsiblePath


Chapter 58. DescriptionProvides methods to manage Ansible systems

Namespace:

ansible


Chapter 59. Method: createAnsiblePathDescription:

Create ansible path

Parameters:


• int pathId - path id

• struct - props

◦ string "type" - The ansible path type: 'inventory' or 'playbook'

◦ int "server_id" - ID of control node server

◦ string "path" - The local path to inventory/playbook

Returns:

• * struct - ansible path

◦ int "path id"

◦ string "type label"

◦ int "id of the ansible control node system"

◦ string "local path to inventory or playbook"

API Documentation | Chapter 59. Method: createAnsiblePath 67 / 1066

Chapter 60. Method: discoverPlaybooksDescription:

Discover playbooks under given playbook path with given pathId

Parameters:



Returns:

• struct - playbooks

◦ struct - playbook

• struct - ansible path

◦ int "path id"




API Documentation | Chapter 60. Method: discoverPlaybooks 68 / 1066

Chapter 61. Method: fetchPlaybookContentsDescription:

Fetch the playbook content from the control node using a synchronous salt call.

Parameters:


• int pathId - playbook path id

• string playbookRelPath - relative path of playbook (inside path specified by pathId)

Returns:

• string contents - Text contents of the playbook

API Documentation | Chapter 61. Method: fetchPlaybookContents 69 / 1066

Chapter 62. Method: introspectInventoryDescription:

Introspect inventory under given inventory path with given pathId and return it in a structured

way

Parameters:



Returns:

• struct - Inventory in a nested structure

◦ object Inventory item - Inventory item (can be nested)

API Documentation | Chapter 62. Method: introspectInventory 70 / 1066

Chapter 63. Method: listAnsiblePathsDescription:

List ansible paths for server (control node)

Parameters:


• int controlNodeId - id of ansible control node server

Returns:

• array :

• struct - ansible path

◦ int "path id"




API Documentation | Chapter 63. Method: listAnsiblePaths 71 / 1066

Chapter 64. Method: lookupAnsiblePathByIdDescription:

Lookup ansible path by path id

Parameters:



Returns:


◦ int "path id"




API Documentation | Chapter 64. Method: lookupAnsiblePathById 72 / 1066

Chapter 65. Method: removeAnsiblePathDescription:

Create ansible path

Parameters:



Returns:


API Documentation | Chapter 65. Method: removeAnsiblePath 73 / 1066

Chapter 66. Method: schedulePlaybookDescription:

Schedule a playbook execution

Parameters:


• string playbookPath

• string inventoryPath - path to Ansible inventory or empty

• int controlNodeId - system ID of the control node

• dateTime.iso8601 earliestOccurrence - earliest the execution command can be sent to the

control node. ignored when actionChainLabel is used

• string actionChainLabel - label of an action chain to use, or None

Returns:

• int id - ID of the playbook execution action created

API Documentation | Chapter 66. Method: schedulePlaybook 74 / 1066



Parameters:








• boolean testMode - 'true' if the playbook shall be executed in test mode

Returns:





Parameters:








• struct - ansibleArgs

◦ boolean "flushCache"

Returns:





Parameters:








• boolean testMode - 'true' if the playbook shall be executed in test mode

• struct - ansibleArgs

◦ boolean "flushCache"

Returns:



Chapter 70. Method: updateAnsiblePathDescription:

Create ansible path

Parameters:



• struct - props

◦ string "path" - The local path to inventory/playbook

Returns:


◦ int "path id"




API Documentation | Chapter 70. Method: updateAnsiblePath 78 / 1066

api


Chapter 71. Available methods• getApiCallList

• getApiNamespaceCallList

• getApiNamespaces

• getVersion

• systemVersion


Chapter 72. DescriptionMethods providing information about the API.

Namespace:

api


Chapter 73. Method: getApiCallListDescription:

Lists all available api calls grouped by namespace

Parameters:


Returns:

• struct - method_info

◦ string "name" - method name

◦ string "parameters" - method parameters

◦ string "exceptions" - method exceptions

◦ string "return" - method return type

API Documentation | Chapter 73. Method: getApiCallList 82 / 1066

Chapter 74. Method:getApiNamespaceCallListDescription:

Lists all available api calls for the specified namespace

Parameters:


• string namespace

Returns:

• struct - method_info

◦ string "name" - method name

◦ string "parameters" - method parameters

◦ string "exceptions" - method exceptions

◦ string "return" - method return type

API Documentation | Chapter 74. Method: getApiNamespaceCallList 83 / 1066

Chapter 75. Method: getApiNamespacesDescription:

Lists available API namespaces

Parameters:


Returns:

• struct - namespace

◦ string "namespace" - API namespace

◦ string "handler" - API Handler

API Documentation | Chapter 75. Method: getApiNamespaces 84 / 1066

Chapter 76. Method: getVersionDescription:

Returns the version of the API.

Parameters:

Returns:

• string version

API Documentation | Chapter 76. Method: getVersion 85 / 1066

Chapter 77. Method: systemVersionDescription:

Returns the server version.

Parameters:

Returns:

• string version

API Documentation | Chapter 77. Method: systemVersion 86 / 1066

audit


Chapter 78. Available methods• listImagesByPatchStatus

• listImagesByPatchStatus

• listSystemsByPatchStatus

• listSystemsByPatchStatus


Chapter 79. DescriptionMethods to audit systems.

Namespace:

audit


Chapter 80. Method: listImagesByPatchStatusDescription:

List visible images with their patch status regarding a given CVE identifier. Please note that the

query code relies on data that is pre-generated by the 'cve-server-channels' taskomatic job.

Parameters:


• string cveIdentifier

Returns:

• array :

• struct - cve_audit_image

◦ int "image_id"

◦ string "patch_status"

◦ AFFECTED_PATCH_INAPPLICABLE - Affected, patch available in unassigned channel

◦ AFFECTED_PATCH_APPLICABLE - Affected, patch available in assigned channel

◦ NOT_AFFECTED - Not affected

◦ PATCHED - Patched

◦ array "string"

▪ channel_labels - Labels of channels that contain an unapplied patch

◦ array "string"

▪ errata_advisories - Advisories of erratas that patch the specified vulnerability

API Documentation | Chapter 80. Method: listImagesByPatchStatus 90 / 1066

Chapter 81. Method: listImagesByPatchStatusDescription:

List visible images with their patch status regarding a given CVE identifier. Filter the results by

passing in a list of patch status labels. Please note that the query code relies on data that is pre-

generated by the 'cve-server-channels' taskomatic job.

Parameters:



• array :

◦ string - patchStatusLabel

• AFFECTED_PATCH_INAPPLICABLE - Affected, patch available in unassigned channel

• AFFECTED_PATCH_APPLICABLE - Affected, patch available in assigned channel

• NOT_AFFECTED - Not affected

• PATCHED - Patched

Returns:

• array :

• struct - cve_audit_image

◦ int "image_id"






◦ array "string"


◦ array "string"


Chapter 82. Method:listSystemsByPatchStatusDescription:

List visible systems with their patch status regarding a given CVE identifier. Please note that the

query code relies on data that is pre-generated by the 'cve-server-channels' taskomatic job.

Parameters:



Returns:

• array :

• struct - cve_audit_system

◦ int "system_id"






◦ array "string"


◦ array "string"


API Documentation | Chapter 82. Method: listSystemsByPatchStatus 93 / 1066

Chapter 83. Method:listSystemsByPatchStatusDescription:

List visible systems with their patch status regarding a given CVE identifier. Filter the results by

passing in a list of patch status labels. Please note that the query code relies on data that is pre-

generated by the 'cve-server-channels' taskomatic job.

Parameters:



• array :

◦ string - patchStatusLabel

• AFFECTED_PATCH_INAPPLICABLE - Affected, patch available in unassigned channel

• AFFECTED_PATCH_APPLICABLE - Affected, patch available in assigned channel

• NOT_AFFECTED - Not affected

• PATCHED - Patched

Returns:

• array :

• struct - cve_audit_system

◦ int "system_id"






◦ array "string"



◦ array "string"



auth


Chapter 84. Available methods• login

• login

• logout


Chapter 85. DescriptionThis namespace provides methods to authenticate with the system’s management server.

Namespace:

auth


Chapter 86. Method: loginDescription:

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

Parameters:

• string username

• string password

Returns:


API Documentation | Chapter 86. Method: login 99 / 1066

Chapter 87. Method: loginDescription:

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

Parameters:

• string username

• string password

• int duration - Length of session.

Returns:


API Documentation | Chapter 87. Method: login 100 / 1066

Chapter 88. Method: logoutDescription:

Logout the user with the given session key.

Parameters:


Returns:


API Documentation | Chapter 88. Method: logout 101 / 1066

channel


Chapter 89. Available methods• listAllChannels

• listManageableChannels

• listMyChannels

• listPopularChannels

• listRetiredChannels

• listSharedChannels

• listSoftwareChannels

• listVendorChannels


Chapter 90. DescriptionProvides method to get back a list of Software Channels.

Namespace:

channel


Chapter 91. Method: listAllChannelsDescription:

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

Parameters:


Returns:

• array :

• struct - channel info

◦ int "id"

◦ string "label"

◦ string "name"

◦ string "provider_name"

◦ int "packages"

◦ int "systems"

◦ string "arch_name"

API Documentation | Chapter 91. Method: listAllChannels 105 / 1066

Chapter 92. Method: listManageableChannelsDescription:

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

Parameters:


Returns:

• array :


◦ int "id"

◦ string "label"

◦ string "name"


◦ int "packages"

◦ int "systems"


API Documentation | Chapter 92. Method: listManageableChannels 106 / 1066

Chapter 93. Method: listMyChannelsDescription:

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

Parameters:


Returns:

• array :


◦ int "id"

◦ string "label"

◦ string "name"


◦ int "packages"

◦ int "systems"


API Documentation | Chapter 93. Method: listMyChannels 107 / 1066

Chapter 94. Method: listPopularChannelsDescription:

List the most popular software channels. Channels that have at least the number of systems

subscribed as specified by the popularity count will be returned.

Parameters:


• int popularityCount

Returns:

• array :


◦ int "id"

◦ string "label"

◦ string "name"


◦ int "packages"

◦ int "systems"


API Documentation | Chapter 94. Method: listPopularChannels 108 / 1066

Chapter 95. Method: listRetiredChannelsDescription:

List all retired software channels. These are channels that the user’s organization is entitled to, but

are no longer supported because they have reached their 'end-of-life' date.

Parameters:


Returns:

• array :


◦ int "id"

◦ string "label"

◦ string "name"


◦ int "packages"

◦ int "systems"


API Documentation | Chapter 95. Method: listRetiredChannels 109 / 1066

Chapter 96. Method: listSharedChannelsDescription:

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

Parameters:


Returns:

• array :


◦ int "id"

◦ string "label"

◦ string "name"


◦ int "packages"

◦ int "systems"


API Documentation | Chapter 96. Method: listSharedChannels 110 / 1066

Chapter 97. Method: listSoftwareChannelsDescription:

List all visible software channels.

Parameters:


Returns:

• array :

◦ struct - channel

▪ string "label"

▪ string "name"

▪ string "parent_label"

▪ string "end_of_life"

▪ string "arch"

API Documentation | Chapter 97. Method: listSoftwareChannels 111 / 1066

Chapter 98. Method: listVendorChannelsDescription:

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

Parameters:


Returns:

• array :


◦ int "id"

◦ string "label"

◦ string "name"


◦ int "packages"

◦ int "systems"


API Documentation | Chapter 98. Method: listVendorChannels 112 / 1066

channel.access


Chapter 99. Available methods• disableUserRestrictions

• enableUserRestrictions

• getOrgSharing

• setOrgSharing


Chapter 100. DescriptionProvides methods to retrieve and alter channel access restrictions.

Namespace:

channel.access


Chapter 101. Method: disableUserRestrictionsDescription:

Disable user restrictions for the given channel. If disabled, all users within the organization may

subscribe to the channel.

Parameters:


• string channelLabel - label of the channel

Returns:


API Documentation | Chapter 101. Method: disableUserRestrictions 116 / 1066

Chapter 102. Method: enableUserRestrictionsDescription:

Enable user restrictions for the given channel. If enabled, only selected users within the

organization may subscribe to the channel.

Parameters:



Returns:


API Documentation | Chapter 102. Method: enableUserRestrictions 117 / 1066

Chapter 103. Method: getOrgSharingDescription:

Get organization sharing access control.

Parameters:



Returns:

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

API Documentation | Chapter 103. Method: getOrgSharing 118 / 1066

Chapter 104. Method: setOrgSharingDescription:

Set organization sharing access control.

Parameters:



• string access - Access (one of the following: 'public', 'private', or 'protected'

Returns:


API Documentation | Chapter 104. Method: setOrgSharing 119 / 1066

channel.org


Chapter 105. Available methods• disableAccess

• enableAccess

• list


Chapter 106. DescriptionProvides methods to retrieve and alter organization trust relationships for a channel.

Namespace:

channel.org


Chapter 107. Method: disableAccessDescription:

Disable access to the channel for the given organization.

Parameters:



• int orgId - id of org being removed access

Returns:


API Documentation | Chapter 107. Method: disableAccess 123 / 1066

Chapter 108. Method: enableAccessDescription:

Enable access to the channel for the given organization.

Parameters:



• int orgId - id of org being granted access

Returns:


API Documentation | Chapter 108. Method: enableAccess 124 / 1066

Chapter 109. Method: listDescription:

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

Parameters:



Returns:

• array :

◦ struct - org

▪ int "org_id"

▪ string "org_name"

▪ boolean "access_enabled"

API Documentation | Chapter 109. Method: list 125 / 1066

channel.software


Chapter 110. Available methods• addPackages

• addRepoFilter

• alignMetadata

• applyChannelState

• associateRepo

• clearRepoFilters

• clone

• create

• create

• create

• create

• createRepo

• createRepo

• createRepo

• delete

• disassociateRepo

• getChannelLastBuildById

• getDetails

• getDetails

• getRepoDetails

• getRepoDetails

• getRepoSyncCronExpression

• isExisting

• isGloballySubscribable

• isUserManageable


• isUserSubscribable

• listAllPackages

• listAllPackages

• listAllPackages

• listArches

• listChannelRepos

• listChildren

• listErrata

• listErrata

• listErrata

• listErrata

• listErrataByType

• listErrataNeedingSync

• listLatestPackages

• listPackagesWithoutChannel

• listRepoFilters

• listSubscribedSystems

• listSystemChannels

• listUserRepos

• mergeErrata

• mergeErrata

• mergeErrata

• mergePackages

• mergePackages

• regenerateNeededCache

• regenerateNeededCache


• regenerateYumCache

• removeErrata

• removePackages

• removeRepo

• removeRepo

• removeRepoFilter

• setContactDetails

• setDetails

• setDetails

• setGloballySubscribable

• setRepoFilters

• setUserManageable

• setUserSubscribable

• syncErrata

• syncRepo

• syncRepo

• syncRepo

• syncRepo

• syncRepo

• updateRepo

• updateRepoLabel

• updateRepoLabel

• updateRepoSsl

• updateRepoSsl

• updateRepoUrl

• updateRepoUrl


Chapter 111. DescriptionProvides methods to access and modify many aspects of a channel.

Namespace:

channel.software



Adds a given list of packages to the given channel.

Parameters:


• string channelLabel - target channel.

• array :

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

Returns:



Chapter 113. Method: addRepoFilterDescription:

Adds a filter for a given repo.

Parameters:


• string label - repository label

• struct - filter_map

◦ string "filter" - string to filter on

◦ string "flag" - + for include, - for exclude

Returns:

• int order - sort order for new filter

API Documentation | Chapter 113. Method: addRepoFilter 132 / 1066

Chapter 114. Method: alignMetadataDescription:

Align the metadata of a channel to another channel.

Parameters:


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

Returns:

• int result code - 1 when metadata has been aligned, 0 otherwise

API Documentation | Chapter 114. Method: alignMetadata 133 / 1066

Chapter 115. Method: applyChannelStateDescription:

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

Parameters:


• array :

◦ int - serverId

Returns:

• array :

◦ int - actionId

API Documentation | Chapter 115. Method: applyChannelState 134 / 1066

Chapter 116. Method: associateRepoDescription:

Associates a repository with a channel

Parameters:


• string channelLabel - channel label

• string repoLabel - repository label

Returns:

• * struct - channel

◦ int "id"

◦ string "name"

◦ string "label"


◦ string "arch_label"

◦ string "summary"


◦ string "checksum_label"

◦ dateTime.iso8601 "last_modified"

◦ string "maintainer_name"

◦ string "maintainer_email"

◦ string "maintainer_phone"

◦ string "support_policy"

◦ string "gpg_key_url"

◦ string "gpg_key_id"

◦ string "gpg_key_fp"

API Documentation | Chapter 116. Method: associateRepo 135 / 1066

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

API Documentation | Chapter 116. Method: associateRepo 136 / 1066

Chapter 117. Method: clearRepoFiltersDescription:

Removes the filters for a repo

Parameters:



Returns:


API Documentation | Chapter 117. Method: clearRepoFilters 137 / 1066


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 original_label

• struct - channel details

◦ string "name"

◦ string "label"


◦ string "parent_label" - (optional)

◦ string "arch_label" - (optional)

◦ string "gpg_key_url" - (optional), gpg_url might be used as well

◦ string "gpg_key_id" - (optional), gpg_id might be used as well

◦ string "gpg_key_fp" - (optional), gpg_fingerprint might be used as well

◦ string "gpg_check" - (optional)

◦ string "description" - (optional)

◦ string "checksum" - either sha1 or sha256

• boolean original_state

Returns:

• int id - the cloned channel ID



Creates a software channel

Parameters:


• string label - label of the new channel

• string name - name of the new channel

• string summary - summary of the channel

• string archLabel - the label of the architecture the channel corresponds to, run

channel.software.listArches API for complete listing

• string parentLabel - label of the parent of this channel, an empty string if it does not have

one

• string checksumType - checksum type for this channel, used for yum repository metadata

generation

• sha1 - Offers widest compatibility with clients

• sha256 - Offers highest security, but is compatible only with newer clients: Fedora 11 and

newer, or Enterprise Linux 6 and newer.

• struct - gpgKey

◦ string "url" - GPG key URL

◦ string "id" - GPG key ID

◦ string "fingerprint" - GPG key Fingerprint

• boolean gpgCheck - true if the GPG check should be enabled by default, false otherwise

Returns:

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





Parameters:








one


generation




• struct - gpgKey

◦ string "url" - GPG key URL

◦ string "id" - GPG key ID

◦ string "fingerprint" - GPG key Fingerprint

Returns:






Parameters:








one


generation




Returns:






Parameters:








one

Returns:



Chapter 123. Method: createRepoDescription:

Creates a repository

Parameters:



• string type - repository type (yum, uln…)

• string url - repository url

Returns:


◦ int "id"

◦ string "label"

◦ string "sourceUrl"

◦ string "type"

◦ boolean "hasSignedMetadata"

◦ array "sslContentSources" -

• struct - contentsourcessl

◦ string "sslCaDesc"

◦ string "sslCertDesc"

◦ string "sslKeyDesc"

API Documentation | Chapter 123. Method: createRepo 143 / 1066



Parameters:



• string type - repository type (yum, uln…)


• string sslCaCert - SSL CA cert description

• string sslCliCert - SSL Client cert description

• string sslCliKey - SSL Client key description

Returns:


◦ int "id"

◦ string "label"


◦ string "type"










Parameters:



• string type - repository type (only YUM is supported)


• 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, false otherwise

Returns:


◦ int "id"

◦ string "label"


◦ string "type"









Deletes a custom software channel

Parameters:


• string channelLabel - channel to delete

Returns:



Chapter 127. Method: disassociateRepoDescription:

Disassociates a repository from a channel

Parameters:



• string repoLabel - repository label

Returns:


◦ int "id"

◦ string "name"

◦ string "label"














API Documentation | Chapter 127. Method: disassociateRepo 147 / 1066





◦ array :


▪ int "id"

▪ string "label"


▪ string "type"

API Documentation | Chapter 127. Method: disassociateRepo 148 / 1066

Chapter 128. Method: getChannelLastBuildByIdDescription:

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

Parameters:


• int id - id of channel wanted

Returns:

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

API Documentation | Chapter 128. Method: getChannelLastBuildById 149 / 1066


Returns details of the given channel as a map

Parameters:


• string channelLabel - channel to query

Returns:


◦ int "id"

◦ string "name"

◦ string "label"



















◦ array :


▪ int "id"

▪ string "label"


▪ string "type"



Returns details of the given channel as a map

Parameters:


• int id - channel to query

Returns:


◦ int "id"

◦ string "name"

◦ string "label"



















◦ array :


▪ int "id"

▪ string "label"


▪ string "type"


Chapter 131. Method: getRepoDetailsDescription:

Returns details of the given repository

Parameters:


• string repoLabel - repo to query

Returns:


◦ int "id"

◦ string "label"


◦ string "type"







API Documentation | Chapter 131. Method: getRepoDetails 154 / 1066

Chapter 132. Method: getRepoDetailsDescription:

Returns details of the given repository

Parameters:


• int id - repository id

Returns:


◦ int "id"

◦ string "label"


◦ string "type"







API Documentation | Chapter 132. Method: getRepoDetails 155 / 1066

Chapter 133. Method:getRepoSyncCronExpressionDescription:

Returns repo synchronization cron expression

Parameters:



Returns:

• string expression - quartz expression

API Documentation | Chapter 133. Method: getRepoSyncCronExpression 156 / 1066

Chapter 134. Method: isExistingDescription:

Returns whether is existing

Parameters:



Returns:

• boolean result - True if the channel exists

API Documentation | Chapter 134. Method: isExisting 157 / 1066

Chapter 135. Method: isGloballySubscribableDescription:

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

Parameters:



Returns:

• int subscribable - 1 if true, 0 otherwise

API Documentation | Chapter 135. Method: isGloballySubscribable 158 / 1066

Chapter 136. Method: isUserManageableDescription:

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

Parameters:



• string login - login of the target user

Returns:

• int status - 1 if manageable, 0 if not

API Documentation | Chapter 136. Method: isUserManageable 159 / 1066

Chapter 137. Method: isUserSubscribableDescription:

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

Parameters:




Returns:

• int status - 1 if subscribable, 0 if not

API Documentation | Chapter 137. Method: isUserSubscribable 160 / 1066

Chapter 138. Method: listAllPackagesDescription:

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

Parameters:



• dateTime.iso8601 startDate

• dateTime.iso8601 endDate

Returns:

• array :

• struct - package

◦ string "name"

◦ string "version"

◦ string "release"

◦ string "epoch"

◦ string "checksum"

◦ string "checksum_type"

◦ int "id"


◦ string "last_modified_date"

◦ string "last_modified" - (Deprecated)

API Documentation | Chapter 138. Method: listAllPackages 161 / 1066


Lists all packages in the channel, regardless of version whose last modified date is greater than

given date.

Parameters:




Returns:

• array :


◦ string "name"



◦ string "epoch"



◦ int "id"






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

Parameters:



Returns:

• array :


◦ string "name"



◦ string "epoch"



◦ int "id"





Chapter 141. Method: listArchesDescription:

Lists the potential software channel architectures that can be created

Parameters:


Returns:

• array :

• struct - channel arch

◦ string "name"

◦ string "label"

API Documentation | Chapter 141. Method: listArches 164 / 1066

Chapter 142. Method: listChannelReposDescription:

Lists associated repos with the given channel

Parameters:



Returns:

• array :

• struct - channel

◦ int "id"

◦ string "label"


◦ string "type"







API Documentation | Chapter 142. Method: listChannelRepos 165 / 1066

Chapter 143. Method: listChildrenDescription:

List the children of a channel

Parameters:


• string channelLabel - the label of the channel

Returns:

• array :


◦ int "id"

◦ string "name"

◦ string "label"














API Documentation | Chapter 143. Method: listChildren 166 / 1066





◦ array :


▪ int "id"

▪ string "label"


▪ string "type"

API Documentation | Chapter 143. Method: listChildren 167 / 1066

Chapter 144. Method: listErrataDescription:

List the errata applicable to a channel after given startDate

Parameters:




Returns:

• 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 final, testing, retracted

◦ string "advisory_name" - Name such as RHSA, etc

API Documentation | Chapter 144. Method: listErrata 168 / 1066


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

Parameters:





Returns:

• array :

• struct - errata











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

Parameters:





• boolean lastModified - select by last modified or not

Returns:

• array :

• struct - errata











List the errata applicable to a channel

Parameters:



Returns:

• array :

• struct - errata










Chapter 148. Method: listErrataByTypeDescription:

List the errata of a specific type that are applicable to a channel

Parameters:



• string advisoryType - type of advisory (one of of the following: 'Security Advisory', 'Product

Enhancement Advisory', 'Bug Fix Advisory'

Returns:

• array :

◦ struct - errata

▪ string "advisory" - name of the advisory

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

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

▪ string "synopsis"

▪ string "advisory_type"

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

API Documentation | Chapter 148. Method: listErrataByType 172 / 1066

Chapter 149. Method: listErrataNeedingSyncDescription:

If you have synced a new channel then patches will have been updated with the packages that

are in the newly synced channel. A cloned erratum will not have been automatically updated

however. If you cloned a channel that includes those cloned errata and should include the new

packages, they will not be included when they should. This method lists the errata that will be

updated if you run the syncErrata method.

Parameters:


• string channelLabel - channel to update

Returns:

• array :

• struct - errata









API Documentation | Chapter 149. Method: listErrataNeedingSync 173 / 1066

Chapter 150. Method: listLatestPackagesDescription:

Lists the packages with the latest version (including release and epoch) for the given channel

Parameters:



Returns:

• array :

◦ struct - package

▪ string "name"

▪ string "version"

▪ string "release"

▪ string "epoch"

▪ int "id"

▪ string "arch_label"

API Documentation | Chapter 150. Method: listLatestPackages 174 / 1066

Chapter 151. Method:listPackagesWithoutChannelDescription:

Lists all packages that are not associated with a channel. Typically these are custom packages.

Parameters:


Returns:

• array :


◦ string "name"



◦ string "epoch"

◦ int "id"



◦ string "path" - The path on that file system that the package resides

◦ boolean "part_of_retracted_patch" - True if the package is a part of a retracted patch

◦ string "provider" - The provider of the package, determined by the gpg key it was signed

with.

API Documentation | Chapter 151. Method: listPackagesWithoutChannel 175 / 1066

Chapter 152. Method: listRepoFiltersDescription:

Lists the filters for a repo

Parameters:



Returns:

• array :

• struct - filter

◦ int "sortOrder"

◦ string "filter"

◦ string "flag"

API Documentation | Chapter 152. Method: listRepoFilters 176 / 1066

Chapter 153. Method: listSubscribedSystemsDescription:

Returns list of subscribed systems for the given channel label

Parameters:



Returns:

• array :

◦ struct - system

▪ int "id"

▪ string "name"

API Documentation | Chapter 153. Method: listSubscribedSystems 177 / 1066

Chapter 154. Method: listSystemChannelsDescription:

Returns a list of channels that a system is subscribed to for the given system id

Parameters:


• int serverId

Returns:

• array :


▪ string "id"

▪ string "label"

▪ string "name"

API Documentation | Chapter 154. Method: listSystemChannels 178 / 1066

Chapter 155. Method: listUserReposDescription:

Returns a list of ContentSource (repos) that the user can see

Parameters:


Returns:

• array :

◦ struct - map

▪ long "id" - ID of the repo

▪ string "label" - label of the repo

▪ string "sourceUrl" - URL of the repo

API Documentation | Chapter 155. Method: listUserRepos 179 / 1066

Chapter 156. Method: mergeErrataDescription:

Merges all errata from one channel into another

Parameters:


• string mergeFromLabel - the label of the channel to pull errata from

• string mergeToLabel - the label to push the errata into

Returns:

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

◦ string "advisory_name" - Name of the advisory.


API Documentation | Chapter 156. Method: mergeErrata 180 / 1066


Merges all errata from one channel into another based upon a given start/end date.

Parameters:




• string startDate

• string endDate

Returns:

• array :

• struct - errata









Merges a list of errata from one channel into another

Parameters:




• array :

◦ string - advisory - The advisory name of the errata to merge

Returns:

• array :

• struct - errata








Chapter 159. Method: mergePackagesDescription:

Merges all packages from one channel into another

Parameters:


• string mergeFromLabel - the label of the channel to pull packages from

• string mergeToLabel - the label to push the packages into

Returns:

• array :


◦ string "name"



◦ string "epoch"

◦ int "id"






with.

API Documentation | Chapter 159. Method: mergePackages 183 / 1066

Chapter 160. Method: mergePackagesDescription:

Merges all packages from one channel into another

Parameters:


• string mergeFromLabel - the label of the channel to pull packages from

• string mergeToLabel - the label to push the packages into

• boolean alignModules - align modular data of the target channel to the source channel

(RHEL8 and higher)

Returns:

• array :


◦ string "name"



◦ string "epoch"

◦ int "id"






with.

API Documentation | Chapter 160. Method: mergePackages 184 / 1066

Chapter 161. Method:regenerateNeededCacheDescription:

Completely clear and regenerate the needed Errata and Package cache for all systems

subscribed to the specified channel. This should be used only if you believe your cache is

incorrect for all the systems in a given channel. This will schedule an asynchronous action to

actually do the processing.

Parameters:



Returns:


API Documentation | Chapter 161. Method: regenerateNeededCache 185 / 1066

Chapter 162. Method:regenerateNeededCacheDescription:

Completely clear and regenerate the needed Errata and Package cache for all systems

subscribed. You must be a Uyuni Admin to perform this action. This will schedule an

asynchronous action to actually do the processing.

Parameters:


Returns:


API Documentation | Chapter 162. Method: regenerateNeededCache 186 / 1066

Chapter 163. Method: regenerateYumCacheDescription:

Regenerate yum cache for the specified channel.

Parameters:



• boolean force - force cache regeneration

Returns:


API Documentation | Chapter 163. Method: regenerateYumCache 187 / 1066

Chapter 164. Method: removeErrataDescription:

Removes a given list of errata from the given channel.

Parameters:



• array :

◦ string - advisoryName - name of an erratum to remove

• boolean removePackages - True to remove packages from the channel

Returns:


API Documentation | Chapter 164. Method: removeErrata 188 / 1066


Removes a given list of packages from the given channel.

Parameters:



• array :

◦ int - packageId - id of a package to remove from the channel.

Returns:



Chapter 166. Method: removeRepoDescription:

Removes a repository

Parameters:


• long id - ID of repo to be removed

Returns:


API Documentation | Chapter 166. Method: removeRepo 190 / 1066

Chapter 167. Method: removeRepoDescription:

Removes a repository

Parameters:


• string label - label of repo to be removed

Returns:


API Documentation | Chapter 167. Method: removeRepo 191 / 1066

Chapter 168. Method: removeRepoFilterDescription:

Removes a filter for a given repo.

Parameters:



• struct - filter_map

◦ string "filter" - string to filter on

◦ string "flag" - + for include, - for exclude

Returns:


API Documentation | Chapter 168. Method: removeRepoFilter 192 / 1066

Chapter 169. Method: setContactDetailsDescription:

Set contact/support information for given channel.

Parameters:



• 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

Returns:


API Documentation | Chapter 169. Method: setContactDetails 193 / 1066


Allows to modify channel attributes

Parameters:


• 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 fingerprint (optional)

◦ string "gpg_check" - enable/disable gpg check (optional)

Returns:



Chapter 172. Method: setGloballySubscribableDescription:

Set globally subscribable attribute for given channel.

Parameters:



• boolean subscribable - true if the channel is to be globally subscribable. False otherwise.

Returns:


API Documentation | Chapter 172. Method: setGloballySubscribable 196 / 1066

Chapter 173. Method: setRepoFiltersDescription:

Replaces the existing set of filters for a given repo. Filters are ranked by their order in the array.

Parameters:



• array :

◦ struct - filter_map

▪ string "filter" - string to filter on

▪ string "flag" - + for include, - for exclude

Returns:


API Documentation | Chapter 173. Method: setRepoFilters 197 / 1066

Chapter 174. Method: setUserManageableDescription:

Set the manageable flag for a given channel and user. If value is set to 'true', this method will give

the user manage permissions to the channel. Otherwise, that privilege is revoked.

Parameters:




• boolean value - value of the flag to set

Returns:


API Documentation | Chapter 174. Method: setUserManageable 198 / 1066

Chapter 175. Method: setUserSubscribableDescription:

Set the subscribable flag for a given channel and user. If value is set to 'true', this method will give

the user subscribe permissions to the channel. Otherwise, that privilege is revoked.

Parameters:




• boolean value - value of the flag to set

Returns:


API Documentation | Chapter 175. Method: setUserSubscribable 199 / 1066

Chapter 176. Method: syncErrataDescription:

If you have synced a new channel then patches will have been updated with the packages that

are in the newly synced channel. A cloned erratum will not have been automatically updated

however. If you cloned a channel that includes those cloned errata and should include the new

packages, they will not be included when they should. This method updates all the errata in the

given cloned channel with packages that have recently been added, and ensures that all the

packages you expect are in the channel. It also updates cloned errata attributes like

advisoryStatus.

Parameters:


• string channelLabel - channel to update

Returns:


API Documentation | Chapter 176. Method: syncErrata 200 / 1066

Chapter 177. Method: syncRepoDescription:

Trigger immediate repo synchronization

Parameters:


• array :

◦ string - channelLabels

Returns:


API Documentation | Chapter 177. Method: syncRepo 201 / 1066



Parameters:



Returns:





Parameters:



• 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

Returns:




Schedule periodic repo synchronization

Parameters:



• string cron expression - if empty all periodic schedules will be disabled

Returns:




Schedule periodic repo synchronization

Parameters:



• 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

Returns:



Chapter 182. Method: updateRepoDescription:

Updates a ContentSource (repo)

Parameters:



• string label - new repository label

• string url - new repository URL

Returns:


◦ int "id"

◦ string "label"


◦ string "type"







API Documentation | Chapter 182. Method: updateRepo 206 / 1066

Chapter 183. Method: updateRepoLabelDescription:

Updates repository label

Parameters:



• string label - new repository label

Returns:


◦ int "id"

◦ string "label"


◦ string "type"







API Documentation | Chapter 183. Method: updateRepoLabel 207 / 1066

Chapter 184. Method: updateRepoLabelDescription:

Updates repository label

Parameters:



• string newLabel - new repository label

Returns:


◦ int "id"

◦ string "label"


◦ string "type"







API Documentation | Chapter 184. Method: updateRepoLabel 208 / 1066

Chapter 185. Method: updateRepoSslDescription:

Updates repository SSL certificates

Parameters:






Returns:


◦ int "id"

◦ string "label"


◦ string "type"







API Documentation | Chapter 185. Method: updateRepoSsl 209 / 1066

Chapter 186. Method: updateRepoSslDescription:

Updates repository SSL certificates

Parameters:






Returns:


◦ int "id"

◦ string "label"


◦ string "type"







API Documentation | Chapter 186. Method: updateRepoSsl 210 / 1066

Chapter 187. Method: updateRepoUrlDescription:

Updates repository source URL

Parameters:



• string url - new repository url

Returns:


◦ int "id"

◦ string "label"


◦ string "type"







API Documentation | Chapter 187. Method: updateRepoUrl 211 / 1066

Chapter 188. Method: updateRepoUrlDescription:

Updates repository source URL

Parameters:



• string url - new repository url

Returns:


◦ int "id"

◦ string "label"


◦ string "type"







API Documentation | Chapter 188. Method: updateRepoUrl 212 / 1066

configchannel


Chapter 189. Available methods• channelExists

• create

• create

• create

• createOrUpdatePath

• createOrUpdateSymlink

• deleteChannels

• deleteFileRevisions

• deleteFiles

• deployAllSystems




• getDetails

• getDetails

• getEncodedFileRevision

• getFileRevision

• getFileRevisions

• listAssignedSystemGroups

• listFiles

• listGlobals

• listSubscribedSystems

• lookupChannelInfo

• lookupFileInfo

• lookupFileInfo


• scheduleFileComparisons

• update

• updateInitSls


Chapter 190. DescriptionProvides methods to access and modify many aspects of configuration channels.

Namespace:

configchannel


Chapter 191. Method: channelExistsDescription:

Check for the existence of the config channel provided.

Parameters:


• string channelLabel - Channel to check for.

Returns:

• int existence - 1 if exists, 0 otherwise

API Documentation | Chapter 191. Method: channelExists 217 / 1066


Create a new global config channel. Caller must be at least a config admin or an organization

admin.

Parameters:


• string channelLabel

• string channelName

• string channelDescription

Returns:

• * struct - Configuration Channel information

◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "name"




◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"




admin.

Parameters:





• string channelType - The channel type either 'normal' or 'state'.

Returns:


◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "name"




◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"




admin.

Parameters:





• string channelType - The channel type either 'normal' or 'state'.

• struct - path info

◦ string "contents" - Contents of the init.sls file

◦ boolean "contents_enc64" - Identifies base64 encoded content(default: disabled)

Returns:


◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "name"




◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"


Chapter 195. Method: createOrUpdatePathDescription:

Create a new file or directory with the given path, or update an existing path.

Parameters:


• string configChannelLabel

• string path

• boolean isDir - True if the path is a directory, False if it is a file.


◦ string "contents" - Contents of the file (text or base64 encoded if binary or want to

preserve control characters like LF, CR etc.)(only for non-directories)

◦ boolean "contents_enc64" - Identifies base64 encoded content (default: disabled, only

for non-directories)

◦ string "owner" - Owner of the file/directory.

◦ string "group" - Group name of the file/directory.

◦ string "permissions" - Octal file/directory permissions (eg: 644)

◦ string "selinux_ctx" - SELinux Security context (optional)

◦ string "macro-start-delimiter" - Config file macro start delimiter. Use null or empty string

to accept the default. (only for non-directories)

◦ string "macro-end-delimiter" - Config file macro end delimiter. Use null or empty string


◦ int "revision" - next revision number, auto increment for null

◦ boolean "binary" - mark the binary content, if True, base64 encoded content is expected

(only for non-directories)

Returns:

• * struct - Configuration Revision information

◦ string "type"

API Documentation | Chapter 195. Method: createOrUpdatePath 221 / 1066

◦ file

◦ directory

◦ symlink

◦ string "path" - File Path

◦ string "target_path" - Symbolic link Target File Path. Present for Symbolic links only.

◦ string "channel" - Channel Name

◦ string "contents" - File contents (base64 encoded according to the contents_enc64

attribute)

◦ boolean "contents_enc64" - Identifies base64 encoded content

◦ int "revision" - File Revision

◦ dateTime.iso8601 "creation" - Creation Date

◦ dateTime.iso8601 "modified" - Last Modified Date

◦ string "owner" - File Owner. Present for files or directories only.

◦ string "group" - File Group. Present for files or directories only.

◦ int "permissions" - File Permissions (Deprecated). Present for files or directories only.

◦ string "permissions_mode" - File Permissions. Present for files or directories only.

◦ string "selinux_ctx" - SELinux Context (optional).

◦ boolean "binary" - true/false , Present for files only.

◦ string "sha256" - File’s sha256 signature. Present for files only.

◦ string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files

only.

◦ string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files

only.



Chapter 196. Method: createOrUpdateSymlinkDescription:

Create a new symbolic link with the given path, or update an existing path in config channel of

'normal' type.

Parameters:



• string path


◦ string "target_path" - The target path for the symbolic link


◦ int "revision" - next revision number, skip this field for automatic revision number

assignment

Returns:


◦ string "type"

◦ file

◦ directory

◦ symlink





attribute)



API Documentation | Chapter 196. Method: createOrUpdateSymlink 223 / 1066











only.


only.



Chapter 197. Method: deleteChannelsDescription:

Delete a list of global config channels. Caller must be a config admin.

Parameters:


• array :

◦ string - configuration channel labels to delete.

Returns:


API Documentation | Chapter 197. Method: deleteChannels 225 / 1066

Chapter 198. Method: deleteFileRevisionsDescription:

Delete specified revisions of a given configuration file

Parameters:


• string channelLabel - Label of config channel to lookup on.

• string filePath - Configuration file path.

• array :

◦ int - List of revisions to delete

Returns:


API Documentation | Chapter 198. Method: deleteFileRevisions 226 / 1066

Chapter 199. Method: deleteFilesDescription:

Remove file paths from a global channel.

Parameters:


• string channelLabel - Channel to remove the files from.

• array :

◦ string - file paths to remove.

Returns:


API Documentation | Chapter 199. Method: deleteFiles 227 / 1066

Chapter 200. Method: deployAllSystemsDescription:

Schedule an immediate configuration deployment for all systems subscribed to a particular

configuration channel.

Parameters:


• string channelLabel - The configuration channel’s label.

Returns:


API Documentation | Chapter 200. Method: deployAllSystems 228 / 1066


Schedule a configuration deployment for all systems subscribed to a particular configuration

channel.

Parameters:



• dateTime.iso8601 date - The date to schedule the action

Returns:




Schedule a configuration deployment of a certain file for all systems subscribed to a particular


Parameters:



• string filePath - The configuration file path.

Returns:




Schedule a configuration deployment of a certain file for all systems subscribed to a particular


Parameters:



• string filePath - The configuration file path.


Returns:




Lookup config channel details.

Parameters:



Returns:


◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "name"




◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"



Lookup config channel details.

Parameters:


• int channelId

Returns:


◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "name"




◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"


Chapter 206. Method: getEncodedFileRevisionDescription:

Get revision of the specified configuration file and transmit the contents as base64 encoded.

Parameters:


• string configChannelLabel - label of config channel to lookup on

• string filePath - config file path to examine

• int revision - config file revision to examine

Returns:


◦ string "type"

◦ file

◦ directory

◦ symlink





attribute)








API Documentation | Chapter 206. Method: getEncodedFileRevision 234 / 1066






only.


only.

API Documentation | Chapter 206. Method: getEncodedFileRevision 235 / 1066

Chapter 207. Method: getFileRevisionDescription:

Get revision of the specified config file

Parameters:


• string configChannelLabel - label of config channel to lookup on


• int revision - config file revision to examine

Returns:


◦ string "type"

◦ file

◦ directory

◦ symlink





attribute)








API Documentation | Chapter 207. Method: getFileRevision 236 / 1066






only.


only.

API Documentation | Chapter 207. Method: getFileRevision 237 / 1066

Chapter 208. Method: getFileRevisionsDescription:

Get list of revisions for specified config file

Parameters:


• string channelLabel - label of config channel to lookup on


Returns:

• array :

• struct - Configuration Revision information

◦ string "type"

◦ file

◦ directory

◦ symlink





attribute)








API Documentation | Chapter 208. Method: getFileRevisions 238 / 1066






only.


only.

API Documentation | Chapter 208. Method: getFileRevisions 239 / 1066

Chapter 209. Method:listAssignedSystemGroupsDescription:

Return a list of Groups where a given configuration channel is assigned to

Parameters:


• string channelLabel - label of config channel to list assigned groups.

Returns:

• array :

• struct - Server Group

◦ int "id"

◦ string "name"


◦ int "org_id"

◦ int "system_count"

API Documentation | Chapter 209. Method: listAssignedSystemGroups 240 / 1066

Chapter 210. Method: listFilesDescription:

Return a list of files in a channel.

Parameters:


• string channelLabel - label of config channel to list files on.

Returns:

• array :

• struct - Configuration File information

◦ string "type"

◦ file

◦ directory

◦ symlink


◦ dateTime.iso8601 "last_modified" - Last Modified Date

API Documentation | Chapter 210. Method: listFiles 241 / 1066

Chapter 211. Method: listGlobalsDescription:

List all the global config channels accessible to the logged-in user.

Parameters:


Returns:

• array :


◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "name"


◦ string "type"



◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"

API Documentation | Chapter 211. Method: listGlobals 242 / 1066

Chapter 212. Method: listSubscribedSystemsDescription:

Return a list of systems subscribed to a configuration channel

Parameters:


• string channelLabel - label of config channel to list subscribed systems.

Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"

API Documentation | Chapter 212. Method: listSubscribedSystems 243 / 1066

Chapter 213. Method: lookupChannelInfoDescription:

Lists details on a list channels given their channel labels.

Parameters:


• array :

◦ string - configuration channel label

Returns:

• array :


◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "name"




◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"

API Documentation | Chapter 213. Method: lookupChannelInfo 244 / 1066

Chapter 214. Method: lookupFileInfoDescription:

Given a list of paths and a channel, returns details about the latest revisions of the paths.

Parameters:



• array :

◦ string - List of paths to examine.

Returns:

• array :


◦ string "type"

◦ file

◦ directory

◦ symlink





attribute)







API Documentation | Chapter 214. Method: lookupFileInfo 245 / 1066







only.


only.




Given a path, revision number, and a channel, returns details about the latest revisions of the

paths.

Parameters:



• string path - path of file/directory

• int revsion - The revision number.

Returns:


◦ string "type"

◦ file

◦ directory

◦ symlink





attribute)














only.


only.



Chapter 216. Method:scheduleFileComparisonsDescription:

Schedule a comparison of the latest revision of a file against the version deployed on a list of

systems.

Parameters:


• string channelLabel - Label of config channel

• string path - File path

• array :

◦ long - The list of server id that the comparison will be performed on

Returns:


API Documentation | Chapter 216. Method: scheduleFileComparisons 249 / 1066

Chapter 217. Method: updateDescription:

Update a global config channel. Caller must be at least a config admin or an organization admin,

or have access to a system containing this config channel.

Parameters:





Returns:


◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "name"




◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"

API Documentation | Chapter 217. Method: update 250 / 1066

Chapter 218. Method: updateInitSlsDescription:

Update the init.sls file for the given state channel. User can only update contents, nothing else.

Parameters:




◦ string "contents" - Contents of the init.sls file

◦ boolean "contents_enc64" - Identifies base64 encoded content(default: disabled)


Returns:


◦ string "type"

◦ file

◦ directory

◦ symlink





attribute)






API Documentation | Chapter 218. Method: updateInitSls 251 / 1066








only.


only.

API Documentation | Chapter 218. Method: updateInitSls 252 / 1066

contentmanagement


Chapter 219. Available methods• attachFilter

• attachSource

• attachSource

• buildProject

• buildProject

• createEnvironment

• createFilter

• createProject

• detachFilter

• detachSource

• listFilterCriteria

• listFilters

• listProjectEnvironments

• listProjectFilters

• listProjectSources

• listProjects

• lookupEnvironment

• lookupFilter

• lookupProject

• lookupSource

• promoteProject

• removeEnvironment

• removeFilter

• removeProject

• updateEnvironment


• updateFilter

• updateProject


Chapter 220. DescriptionProvides methods to access and modify Content Lifecycle Management related entities (Projects,

Environments, Filters, Sources).

Namespace:

contentmanagement


Chapter 221. Method: attachFilterDescription:

Attach a Filter to a Project

Parameters:


• string projectLabel - Project label

• int id - Filter id to attach

Returns:

• * 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 filter (e.g. 'contains')

▪ string "field" - The entity field to match (e.g. 'name'

▪ string "value" - The field value to match (e.g. 'kernel')

API Documentation | Chapter 221. Method: attachFilter 257 / 1066

Chapter 222. Method: attachSourceDescription:

Attach a Source to a Project

Parameters:


• string projectLabel - Content Project label

• string sourceType - Project Source type, e.g. 'software'

• string sourceLabel - Project Source label

• int sourcePosition - Project Source position

Returns:

• * struct - Content Project Source information

◦ string "contentProjectLabel"

◦ string "type"

◦ string "state"

◦ string "channelLabel" - (If type is SW_CHANNEL) The label of channel associated with the

source

API Documentation | Chapter 222. Method: attachSource 258 / 1066

Chapter 223. Method: attachSourceDescription:

Attach a Source to a Project

Parameters:





Returns:



◦ string "type"

◦ string "state"


source

API Documentation | Chapter 223. Method: attachSource 259 / 1066

Chapter 224. Method: buildProjectDescription:

Build a Project

Parameters:



Returns:


API Documentation | Chapter 224. Method: buildProject 260 / 1066

Chapter 225. Method: buildProjectDescription:

Build a Project

Parameters:



• string message - Log message to be assigned to the build

Returns:


API Documentation | Chapter 225. Method: buildProject 261 / 1066

Chapter 226. Method: createEnvironmentDescription:

Create a Content Environment and appends it behind given Content Environment

Parameters:



• string predecessorLabel - Predecessor Environment label

• string label - new Content Environment label

• string name - new Content Environment name

• string description - new Content Environment description

Returns:

• * struct - Content Environment information

◦ int "id"

◦ string "label"

◦ string "name"


◦ int "version"

◦ string "status"


◦ string "previousEnvironmentLabel"

◦ string "nextEnvironmentLabel"

API Documentation | Chapter 226. Method: createEnvironment 262 / 1066

Chapter 227. Method: createFilterDescription:

Create a Content Filter

The following filters are available (you can get the list in machine-readable format usingthe listFilterCriteria() endpoint):

Package filtering:

by name - field: name; matchers: contains or matchesby name, epoch, version, release and architecture - field: nevr or nevra; matcher: equals

Errata/Patch filtering:

by advisory name - field: advisory_name; matcher: equals or matches by type - field: advisory_type (e.g. 'Security Advisory'); matcher: equals by synopsis - field: synopsis; matcher: equals, contains or matches by keyword - field: keyword; matcher: contains by date - field: issue_date; matcher: greater or greatereq by affected package name - field: package_name; matcher: contains_pkg_name ormatches_pkg_name by affected package with version - field: package_nevr; matcher: contains_pkg_lt_evr,contains_pkg_le_evr, contains_pkg_eq_evr, contains_pkg_ge_evr orcontains_pkg_gt_evr

Appstream module/stream filtering:

by module name, stream - field: module_stream; matcher: equals; value:modulaneme:stream

Note: Only 'allow' rule is supported for appstream filters.

Note: The 'matches' matcher works on Java regular expressions.

Parameters:


API Documentation | Chapter 227. Method: createFilter 263 / 1066

• 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 filter (e.g. 'contains')

◦ string "field" - The entity field to match (e.g. 'name'

◦ string "value" - The field value to match (e.g. 'kernel')

Returns:


◦ int "id"

◦ string "name"

◦ int "orgId"







API Documentation | Chapter 227. Method: createFilter 264 / 1066

Chapter 228. Method: createProjectDescription:

Create Content Project

Parameters:


• string label - Content Project label

• string name - Content Project name

• string description - Content Project description

Returns:

• * struct - Content Project information

◦ int "id"

◦ string "label"

◦ string "name"


◦ dateTime.iso8601 "lastBuildDate"

◦ int "orgId"

◦ string "firstEnvironment label"

API Documentation | Chapter 228. Method: createProject 265 / 1066

Chapter 229. Method: detachFilterDescription:

Detach a Filter from a Project

Parameters:



• int id - Filter id to detach

Returns:


API Documentation | Chapter 229. Method: detachFilter 266 / 1066

Chapter 230. Method: detachSourceDescription:

Detach a Source from a Project

Parameters:





Returns:


API Documentation | Chapter 230. Method: detachSource 267 / 1066

Chapter 231. Method: listFilterCriteriaDescription:

List of available filter criteria

Parameters:


Returns:

• array :

◦ struct - Filter Criteria

▪ string "type"

▪ string "matcher"

▪ string "field"

API Documentation | Chapter 231. Method: listFilterCriteria 268 / 1066

Chapter 232. Method: listFiltersDescription:

List all Content Filters visible to given user

Parameters:


Returns:

• array :

• struct - Content Filter information

◦ int "id"

◦ string "name"

◦ int "orgId"







API Documentation | Chapter 232. Method: listFilters 269 / 1066

Chapter 233. Method: listProjectEnvironmentsDescription:

List Environments in a Content Project with the respect to their ordering

Parameters:



Returns:

• array :

• struct - Content Environment information

◦ int "id"

◦ string "label"

◦ string "name"


◦ int "version"

◦ string "status"




API Documentation | Chapter 233. Method: listProjectEnvironments 270 / 1066

Chapter 234. Method: listProjectFiltersDescription:

List all Filters associated with a Project

Parameters:



Returns:

• array :

• struct - Assigned Content Filter information

◦ string "state"

• struct - Content Filter information

◦ int "id"

◦ string "name"

◦ int "orgId"







API Documentation | Chapter 234. Method: listProjectFilters 271 / 1066

Chapter 235. Method: listProjectSourcesDescription:

List Content Project Sources

Parameters:



Returns:

• array :

• struct - Content Project Source information


◦ string "type"

◦ string "state"


source

API Documentation | Chapter 235. Method: listProjectSources 272 / 1066

Chapter 236. Method: listProjectsDescription:

List Content Projects visible to user

Parameters:


Returns:

• array :

• struct - Content Project information

◦ int "id"

◦ string "label"

◦ string "name"



◦ int "orgId"


API Documentation | Chapter 236. Method: listProjects 273 / 1066

Chapter 237. Method: lookupEnvironmentDescription:

Look up Content Environment based on Content Project and Content Environment label

Parameters:



• string envLabel - Content Environment label

Returns:


◦ int "id"

◦ string "label"

◦ string "name"


◦ int "version"

◦ string "status"




API Documentation | Chapter 237. Method: lookupEnvironment 274 / 1066

Chapter 238. Method: lookupFilterDescription:

Lookup a Content Filter by id

Parameters:


• int id - Filter id

Returns:


◦ int "id"

◦ string "name"

◦ int "orgId"







API Documentation | Chapter 238. Method: lookupFilter 275 / 1066

Chapter 239. Method: lookupProjectDescription:

Look up Content Project with given label

Parameters:



Returns:


◦ int "id"

◦ string "label"

◦ string "name"



◦ int "orgId"


API Documentation | Chapter 239. Method: lookupProject 276 / 1066

Chapter 240. Method: lookupSourceDescription:

Look up Content Project Source

Parameters:





Returns:



◦ string "type"

◦ string "state"


source

API Documentation | Chapter 240. Method: lookupSource 277 / 1066

Chapter 241. Method: promoteProjectDescription:

Promote an Environment in a Project

Parameters:



• string envLabel - Environment label

Returns:


API Documentation | Chapter 241. Method: promoteProject 278 / 1066

Chapter 242. Method: removeEnvironmentDescription:

Remove a Content Environment

Parameters:




Returns:


API Documentation | Chapter 242. Method: removeEnvironment 279 / 1066

Chapter 243. Method: removeFilterDescription:

Remove a Content Filter

Parameters:


• int id - Filter id

Returns:


API Documentation | Chapter 243. Method: removeFilter 280 / 1066

Chapter 244. Method: removeProjectDescription:

Remove Content Project

Parameters:



Returns:


API Documentation | Chapter 244. Method: removeProject 281 / 1066

Chapter 245. Method: updateEnvironmentDescription:

Update Content Environment with given label

Parameters:




• struct - data

◦ string "name" - Content Environment name

◦ string "description" - Content Environment description

Returns:


◦ int "id"

◦ string "label"

◦ string "name"


◦ int "version"

◦ string "status"




API Documentation | Chapter 245. Method: updateEnvironment 282 / 1066

Chapter 246. Method: updateFilterDescription:

Update a Content Filter

See also: createFilter(), listFilterCriteria()

Parameters:


• int filterId - Filter id

• string name - New filter name

• string rule - New filter rule ('deny' or 'allow')

• struct - criteria

◦ string "matcher" - The matcher type of the filter (e.g. 'contains')

◦ string "field" - The entity field to match (e.g. 'name'

◦ string "value" - The field value to match (e.g. 'kernel')

Returns:


◦ int "id"

◦ string "name"

◦ int "orgId"







API Documentation | Chapter 246. Method: updateFilter 283 / 1066

Chapter 247. Method: updateProjectDescription:

Update Content Project with given label

Parameters:



• struct - data

◦ string "name" - Content Project name

◦ string "description" - Content Project description

Returns:


◦ int "id"

◦ string "label"

◦ string "name"



◦ int "orgId"


API Documentation | Chapter 247. Method: updateProject 284 / 1066

distchannel


Chapter 248. Available methods• listDefaultMaps

• listMapsForOrg

• listMapsForOrg

• setMapForOrg


Chapter 249. DescriptionProvides methods to access and modify distribution channel information

Namespace:

distchannel


Chapter 250. Method: listDefaultMapsDescription:

Lists the default distribution channel maps

Parameters:


Returns:

• array :

• struct - distChannelMap

◦ string "os" - Operationg System

◦ string "release" - OS Relase

◦ string "arch_name" - Channel architecture

◦ string "channel_label" - Channel label

◦ string "org_specific" - 'Y' organization specific, 'N' default

API Documentation | Chapter 250. Method: listDefaultMaps 288 / 1066

Chapter 251. Method: listMapsForOrgDescription:

Lists distribution channel maps valid for the user’s organization

Parameters:


Returns:

• array :







API Documentation | Chapter 251. Method: listMapsForOrg 289 / 1066

Chapter 252. Method: listMapsForOrgDescription:

Lists distribution channel maps valid for an organization, Uyuni admin rights needed.

Parameters:


• int orgId

Returns:

• array :







API Documentation | Chapter 252. Method: listMapsForOrg 290 / 1066

Chapter 253. Method: setMapForOrgDescription:

Sets, overrides (/removes if channelLabel empty) a distribution channel map within an

organization

Parameters:


• string os

• string release

• string archName


Returns:


API Documentation | Chapter 253. Method: setMapForOrg 291 / 1066

errata


Chapter 254. Available methods• addPackages

• applicableToChannels

• bugzillaFixes

• clone

• cloneAsOriginal

• cloneAsOriginalAsync

• cloneAsync

• create

• delete

• findByCve

• getDetails

• listAffectedSystems

• listCves

• listKeywords

• listPackages

• publish

• publishAsOriginal

• removePackages

• setDetails


Chapter 255. DescriptionProvides methods to access and modify errata.

Namespace:

errata



Add a set of packages to an erratum with the given advisory name. This method will only allow

for modification of custom errata created either through the UI or API.

Parameters:


• string advisoryName

• array :

◦ int - packageId

Returns:

• int count - representing the number of packages added, exception otherwise


Chapter 257. Method: applicableToChannelsDescription:

Returns a list of channels applicable to the errata with the given advisory name. For those errata

that are present in both vendor and user organizations under the same advisory name, this

method retrieves the list of channels applicable of both of them.

Parameters:



Returns:

• array :


▪ int "channel_id"

▪ string "label"

▪ string "name"

▪ string "parent_channel_label"

API Documentation | Chapter 257. Method: applicableToChannels 296 / 1066

Chapter 258. Method: bugzillaFixesDescription:

Get the Bugzilla fixes for an erratum matching the given advisoryName. The bugs will be returned

in a struct where the bug id is the key. i.e. 208144="errata.bugzillaFixes Method Returns different

results than docs say" For those errata that are present in both vendor and user organizations

under the same advisory name, this method retrieves the list of Bugzilla fixes of both of them.

Parameters:



Returns:

• 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

API Documentation | Chapter 258. Method: bugzillaFixes 297 / 1066


Clone a list of errata into the specified channel.

Parameters:


• string channel_label

• array :

◦ string - advisory - The advisory name of the errata to clone.

Returns:

• array :

• struct - errata








Chapter 260. Method: cloneAsOriginalDescription:

Clones a list of errata into a specified cloned channel according the original erratas.

Parameters:



• array :


Returns:

• array :

• struct - errata







API Documentation | Chapter 260. Method: cloneAsOriginal 299 / 1066

Chapter 261. Method: cloneAsOriginalAsyncDescription:

Asynchronously clones a list of errata into a specified cloned channel according the original

erratas

Parameters:



• array :


Returns:


API Documentation | Chapter 261. Method: cloneAsOriginalAsync 300 / 1066

Chapter 262. Method: cloneAsyncDescription:

Asynchronously clone a list of errata into the specified channel.

Parameters:



• array :


Returns:


API Documentation | Chapter 262. Method: cloneAsync 301 / 1066


Create a custom errata

Parameters:


• struct - errata info

◦ string "synopsis"

◦ string "advisory_name"

◦ int "advisory_release"

◦ string "advisory_type" - Type of advisory (one of the following: 'Security Advisory',

'Product Enhancement Advisory', or 'Bug Fix Advisory'

◦ string "advisory_status" - Status of advisory (one of the following: 'final', 'testing', 'stable'

or 'retracted'

◦ string "product"

◦ string "errataFrom"

◦ string "topic"


◦ string "references"

◦ string "notes"

◦ string "solution"

◦ string "severity" - Severity of advisory (one of the following: 'Low', 'Moderate', 'Important',

'Critical' or 'Unspecified'

• array :

◦ struct - bug

▪ 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

Returns:

• * struct - errata









Delete an erratum. This method will only allow for deletion of custom errata created either

through the UI or API.

Parameters:



Returns:



Chapter 265. Method: findByCveDescription:

Lookup the details for errata associated with the given CVE (e.g. CVE-2008-3270)

Parameters:


• string cveName

Returns:

• array :

• struct - errata







API Documentation | Chapter 265. Method: findByCve 305 / 1066


Retrieves the details for the erratum matching the given advisory name.

Parameters:



Returns:

• struct - erratum

◦ int "id"

◦ string "issue_date"

◦ string "update_date"

◦ string "last_modified_date" - last time the erratum was modified.


◦ int "release"

◦ string "advisory_status"

◦ string "type"



◦ string "topic"



◦ string "notes"



Chapter 267. Method: listAffectedSystemsDescription:

Return the list of systems affected by the errata with the given advisory name. For those errata

that are present in both vendor and user organizations under the same advisory name, this

method retrieves the affected systems by both of them.

Parameters:



Returns:

• 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

◦ int "extra_pkg_count" - Number of packages not belonging to any assigned channel

◦ int "outdated_pkg_count" - Number of out-of-date packages

API Documentation | Chapter 267. Method: listAffectedSystems 307 / 1066

Chapter 268. Method: listCvesDescription:

Returns a list of CVEs applicable to the errata with the given advisory name. For those errata that

are present in both vendor and user organizations under the same advisory name, this method

retrieves the list of CVEs of both of them.

Parameters:



Returns:

• array :

◦ string - cveName

API Documentation | Chapter 268. Method: listCves 308 / 1066

Chapter 269. Method: listKeywordsDescription:

Get the keywords associated with an erratum matching the given advisory name. For those

errata that are present in both vendor and user organizations under the same advisory name,

this method retrieves the keywords of both of them.

Parameters:



Returns:

• array :

◦ string - Keyword associated with erratum.

API Documentation | Chapter 269. Method: listKeywords 309 / 1066

Chapter 270. Method: listPackagesDescription:

Returns a list of the packages affected by the errata with the given advisory name. For those

errata that are present in both vendor and user organizations under the same advisory name,

this method retrieves the packages of both of them.

Parameters:



Returns:

• array :


▪ int "id"

▪ string "name"

▪ string "epoch"




▪ array "providing_channels"

▪ string - - Channel label providing this package.

▪ string "build_host"

▪ string "description"

▪ string "checksum"

▪ string "checksum_type"

▪ string "vendor"


▪ string "cookie"

API Documentation | Chapter 270. Method: listPackages 310 / 1066

▪ string "license"

▪ string "path"

▪ string "file"

▪ string "build_date"

▪ string "last_modified_date"

▪ string "size"

▪ string "payload_size"


Chapter 271. Method: publishDescription:

Adds an existing errata to a set of channels.

Parameters:



• array :

◦ string - channelLabel - list of channel labels to add to

Returns:








API Documentation | Chapter 271. Method: publish 312 / 1066

Chapter 272. Method: publishAsOriginalDescription:

Adds an existing cloned errata to a set of cloned channels according to its original erratum

Parameters:



• array :

◦ string - channelLabel - list of channel labels to add to

Returns:








API Documentation | Chapter 272. Method: publishAsOriginal 313 / 1066


Remove a set of packages from an erratum with the given advisory name. This method will only

allow for modification of custom errata created either through the UI or API.

Parameters:



• array :

◦ int - packageId

Returns:

• int count - representing the number of packages removed, exception otherwise



Set erratum details. All arguments are optional and will only be modified if included in the struct.

This method will only allow for modification of custom errata created either through the UI or API.

Parameters:



• struct - errata details


◦ string "advisory_name"

◦ int "advisory_release"

◦ string "advisory_type" - Type of advisory (one of the following: 'Security Advisory',

'Product Enhancement Advisory', or 'Bug Fix Advisory'


◦ dateTime.iso8601 "issue_date"

◦ dateTime.iso8601 "update_date"


◦ string "topic"



◦ string "notes"


◦ string "severity" - Severity of advisory (one of the following: 'Low', 'Moderate', 'Important',

'Critical' or 'Unspecified'

◦ array "bugs" - 'bugs' is the key into the struct

◦ array :

▪ struct - bug


▪ int "id" - Bug Id


▪ string "url"

◦ array "keywords" - 'keywords' is the key into the struct

◦ array :

▪ string - keyword - List of keywords to associate with the errata.

◦ array "CVEs" - 'cves' is the key into the struct

◦ array :

▪ string - cves - List of CVEs to associate with the errata

Returns:



formula


Chapter 275. Available methods• getCombinedFormulaDataByServerIds

• getCombinedFormulasByServerId

• getFormulasByGroupId

• getFormulasByServerId

• getGroupFormulaData

• getSystemFormulaData

• listFormulas

• setFormulasOfGroup

• setFormulasOfServer

• setGroupFormulaData

• setSystemFormulaData


Chapter 276. DescriptionProvides methods to access and modify formulas.

Namespace:

formula


Chapter 277. Method:getCombinedFormulaDataByServerIdsDescription:

Return the list of formulas a server and all his groups have.

Parameters:


• string formulaName

• array :

◦ int - systemID

Returns:

• array :

• struct - formula_data

◦ int "system_id"

◦ string "minion_id"

◦ struct with saved formula values "formula_values"

API Documentation | Chapter 277. Method: getCombinedFormulaDataByServerIds 320 / 1066

Chapter 278. Method:getCombinedFormulasByServerIdDescription:

Return the list of formulas a server and all his groups have.

Parameters:


• int systemId

Returns:

• array :

◦ string - (formulas)

API Documentation | Chapter 278. Method: getCombinedFormulasByServerId 321 / 1066

Chapter 279. Method: getFormulasByGroupIdDescription:

Return the list of formulas a server group has.

Parameters:


• int systemGroupId

Returns:

• array :


API Documentation | Chapter 279. Method: getFormulasByGroupId 322 / 1066

Chapter 280. Method: getFormulasByServerIdDescription:

Return the list of formulas directly applied to a server.

Parameters:


• int systemId

Returns:

• array :


API Documentation | Chapter 280. Method: getFormulasByServerId 323 / 1066

Chapter 281. Method: getGroupFormulaDataDescription:

Get the saved data for the specific formula against specific group

Parameters:


• int groupId


Returns:

• struct with saved formula data

API Documentation | Chapter 281. Method: getGroupFormulaData 324 / 1066

Chapter 282. Method: getSystemFormulaDataDescription:

Get the saved data for the specific formula against specific server

Parameters:


• int systemId


Returns:

• struct with saved formula data

API Documentation | Chapter 282. Method: getSystemFormulaData 325 / 1066

Chapter 283. Method: listFormulasDescription:

Return the list of formulas currently installed.

Parameters:


Returns:

• array :


API Documentation | Chapter 283. Method: listFormulas 326 / 1066

Chapter 284. Method: setFormulasOfGroupDescription:

Set the formulas of a server group.

Parameters:



• array :

◦ string - formulaName

Returns:


API Documentation | Chapter 284. Method: setFormulasOfGroup 327 / 1066

Chapter 285. Method: setFormulasOfServerDescription:

Set the formulas of a server.

Parameters:


• int systemId

• array :

◦ string - formulaName

Returns:


API Documentation | Chapter 285. Method: setFormulasOfServer 328 / 1066

Chapter 286. Method: setGroupFormulaDataDescription:

Set the formula form for the specified group.

Parameters:


• int groupId


• struct containing the values for each field in the form

Returns:


API Documentation | Chapter 286. Method: setGroupFormulaData 329 / 1066

Chapter 287. Method: setSystemFormulaDataDescription:

Set the formula form for the specified server.

Parameters:


• int systemId


• struct content with the values for each field in the form

Returns:


API Documentation | Chapter 287. Method: setSystemFormulaData 330 / 1066

image


Chapter 288. Available methods• delete

• getCustomValues

• getDetails

• getRelevantErrata

• importImage

• listImages

• listPackages

• scheduleImageBuild


Chapter 289. DescriptionProvides methods to access and modify images.

Namespace:

image



Delete an Image

Parameters:


• int imageId

Returns:



Chapter 291. Method: getCustomValuesDescription:

Get the custom data values defined for the Image.

Parameters:


• int imageId

Returns:

• struct - Map of custom labels to custom values

◦ string "custom info label"

◦ string "value"

API Documentation | Chapter 291. Method: getCustomValues 335 / 1066


Get details of an Image

Parameters:


• int imageId

Returns:

• * 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 "profileLabel"

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

◦ int "outdatedPackages"

◦ int "installedPackages"


Chapter 293. Method: getRelevantErrataDescription:

Returns a list of all errata that are relevant for the image

Parameters:


• int imageId

Returns:

• array :

• struct - errata









API Documentation | Chapter 293. Method: getRelevantErrata 338 / 1066

Chapter 294. Method: importImageDescription:

Import an image and schedule an inspect afterwards

Parameters:


• string name - image name as specified in the store

• string version - version to import or empty

• int buildHostId - system ID of the build host

• string storeLabel

• string activationKey - activation key to get the channel data from

• dateTime.iso8601 earliestOccurrence - earliest the following inspect can run

Returns:

• int id - ID of the inspect action created

API Documentation | Chapter 294. Method: importImage 339 / 1066

Chapter 295. Method: listImagesDescription:

List available Images

Parameters:


Returns:

• array :

• struct - Image 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 "storeLabel"


API Documentation | Chapter 295. Method: listImages 340 / 1066

Chapter 296. Method: listPackagesDescription:

List the installed packages on the given image.

Parameters:


• int imageId

Returns:

• array :


▪ string "name"



▪ string "epoch"

▪ string "arch"


Chapter 297. Method: scheduleImageBuildDescription:

Schedule an image build

Parameters:


• string profileLabel

• string version - version to build or empty

• int buildHostId - system id of the build host

• dateTime.iso8601 earliestOccurrence - earliest the build can run.

Returns:

• int id - ID of the build action created

API Documentation | Chapter 297. Method: scheduleImageBuild 342 / 1066

image.profile


Chapter 298. Available methods• create

• create

• delete

• deleteCustomValues

• getCustomValues

• getDetails

• listImageProfileTypes

• listImageProfiles

• setCustomValues

• setDetails


Chapter 299. DescriptionProvides methods to access and modify image profiles.

Namespace:

image.profile



Create a new Image Profile

Parameters:


• string label

• string type


• string path

• string activationKey - Optional

• string kiwiOptions

Returns:




Create a new Image Profile

Parameters:


• string label

• string type


• string path

• string activationKey - Optional

Returns:




Delete an Image Profile

Parameters:


• string label

Returns:



Chapter 303. Method: deleteCustomValuesDescription:

Delete the custom values defined for the specified Image Profile. (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 throw exception.)

Parameters:


• string label

• array :

◦ string - customDataKeys

Returns:


API Documentation | Chapter 303. Method: deleteCustomValues 349 / 1066


Get the custom data values defined for the Image Profile.

Parameters:


• string label

Returns:



◦ string "value"



Get details of an Image Profile

Parameters:


• string label

Returns:

• * struct - Image Profile information

◦ string "label"

◦ string "imageType"

◦ string "imageStore"

◦ string "activationKey"

◦ string "path" - in case type support path


Chapter 306. Method: listImageProfileTypesDescription:

List available Image Store Types

Parameters:


Returns:

• array :

◦ string - imageProfileTypes

API Documentation | Chapter 306. Method: listImageProfileTypes 352 / 1066

Chapter 307. Method: listImageProfilesDescription:

List available Image Profiles

Parameters:


Returns:

• array :

• struct - Image Profile information

◦ string "label"

◦ string "imageType"

◦ string "imageStore"

◦ string "activationKey"

◦ string "path" - in case type support path

API Documentation | Chapter 307. Method: listImageProfiles 353 / 1066

Chapter 308. Method: setCustomValuesDescription:

Set custom values for the specified Image Profile.

Parameters:


• string label



◦ string "value"

Returns:


API Documentation | Chapter 308. Method: setCustomValues 354 / 1066


Set details of an Image Profile

Parameters:


• string label

• struct - image profile details

◦ string "storeLabel"

◦ string "path"

◦ string "activationKey" - set empty string to unset

Returns:



image.store



• delete

• getDetails

• listImageStoreTypes

• listImageStores

• setDetails


Chapter 311. DescriptionProvides methods to access and modify image stores.

Namespace:

image.store



Create a new Image Store

Parameters:


• string label

• string uri

• string storeType

• struct - credentials optional

◦ string "username"

◦ string "password"

Returns:




Delete an Image Store

Parameters:


• string label

Returns:




Get details of an Image Store

Parameters:


• string label

Returns:

• * struct - Image Store information

◦ string "label"

◦ string "uri"

◦ string "storetype"

◦ boolean "hasCredentials"



Chapter 315. Method: listImageStoreTypesDescription:

List available Image Store Types

Parameters:


Returns:

• array :

• struct - Image Store Type information

◦ int "id"

◦ string "label"

◦ string "name"

API Documentation | Chapter 315. Method: listImageStoreTypes 362 / 1066

Chapter 316. Method: listImageStoresDescription:

List available Image Stores

Parameters:


Returns:

• array :

• struct - Image Store information

◦ string "label"

◦ string "uri"

◦ string "storetype"

◦ boolean "hasCredentials"


API Documentation | Chapter 316. Method: listImageStores 363 / 1066


Set details of an Image Store

Parameters:


• string label

• struct - image store details

◦ string "uri"

◦ string "username" - pass empty string to unset credentials


Returns:



kickstart


Chapter 318. Available methods• cloneProfile

• createProfile

• createProfile

• createProfileWithCustomUrl

• createProfileWithCustomUrl

• deleteProfile

• disableProfile

• findKickstartForIp

• importFile

• importFile

• importFile

• importRawFile

• importRawFile

• isProfileDisabled

• listAllIpRanges

• listAutoinstallableChannels

• listKickstartableChannels

• listKickstarts

• renameProfile


Chapter 319. DescriptionProvides methods to create kickstart files

Namespace:

kickstart


Chapter 320. Method: cloneProfileDescription:

Clone a Kickstart Profile

Parameters:


• string ksLabelToClone - Label of the kickstart profile to clone

• string newKsLabel - label of the cloned profile

Returns:


API Documentation | Chapter 320. Method: cloneProfile 368 / 1066

Chapter 321. Method: createProfileDescription:

Create a kickstart profile.

Parameters:


• string profileLabel - Label for the new kickstart profile.

• string virtualizationType - none, para_host, qemu, xenfv or xenpv.

• string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.

• string kickstartHost - Kickstart hostname (of a Uyuni server or proxy) used to construct the

default download URL for the new kickstart profile.

• string rootPassword - Root password.

• string updateType - Should the profile update itself to use the newest tree available?

Possible values are: none (default) or all (includes custom Kickstart Trees).

Returns:


API Documentation | Chapter 321. Method: createProfile 369 / 1066

Chapter 322. Method: createProfileDescription:


Parameters:






default download URL for the new kickstart profile.


Returns:


API Documentation | Chapter 322. Method: createProfile 370 / 1066

Chapter 323. Method:createProfileWithCustomUrlDescription:


Parameters:





• boolean downloadUrl - Download URL, or 'default' to use the kickstart tree’s default URL.


Returns:


API Documentation | Chapter 323. Method: createProfileWithCustomUrl 371 / 1066

Chapter 324. Method:createProfileWithCustomUrlDescription:


Parameters:





• boolean downloadUrl - Download URL, or 'default' to use the kickstart tree’s default URL.




Returns:


API Documentation | Chapter 324. Method: createProfileWithCustomUrl 372 / 1066

Chapter 325. Method: deleteProfileDescription:

Delete a kickstart profile

Parameters:


• string ksLabel - The label of the kickstart profile you want to remove

Returns:


API Documentation | Chapter 325. Method: deleteProfile 373 / 1066

Chapter 326. Method: disableProfileDescription:

Enable/Disable a Kickstart Profile

Parameters:


• string profileLabel - Label for the kickstart tree you want to en/disable

• string disabled - true to disable the profile

Returns:


API Documentation | Chapter 326. Method: disableProfile 374 / 1066

Chapter 327. Method: findKickstartForIpDescription:

Find an associated kickstart for a given ip address.

Parameters:


• string ipAddress - The ip address to search for (i.e. 192.168.0.1)

Returns:

• string label - label of the kickstart. Empty string if not found

API Documentation | Chapter 327. Method: findKickstartForIp 375 / 1066

Chapter 328. Method: importFileDescription:

Import a kickstart profile.

Parameters:





• string kickstartFileContents - Contents of the kickstart file to import.

Returns:


API Documentation | Chapter 328. Method: importFile 376 / 1066



Parameters:






default download URL for the new kickstart profile. Using this option signifies that this default

URL will be used instead of any url/nfs/cdrom/harddrive commands in the kickstart file itself.


Returns:





Parameters:






default download URL for the new kickstart profile. Using this option signifies that this default

URL will be used instead of any url/nfs/cdrom/harddrive commands in the kickstart file itself.




Returns:



Chapter 331. Method: importRawFileDescription:

Import a raw kickstart file into Uyuni.

Parameters:






Returns:


API Documentation | Chapter 331. Method: importRawFile 379 / 1066

Chapter 332. Method: importRawFileDescription:

Import a raw kickstart file into Uyuni.

Parameters:








Returns:


API Documentation | Chapter 332. Method: importRawFile 380 / 1066

Chapter 333. Method: isProfileDisabledDescription:

Returns whether a kickstart profile is disabled

Parameters:


• string profileLabel - kickstart profile label

Returns:

• boolean disabled - true if profile is disabled

API Documentation | Chapter 333. Method: isProfileDisabled 381 / 1066

Chapter 334. Method: listAllIpRangesDescription:

List all Ip Ranges and their associated kickstarts available in the user’s org.

Parameters:


Returns:

• 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

API Documentation | Chapter 334. Method: listAllIpRanges 382 / 1066

Chapter 335. Method:listAutoinstallableChannelsDescription:

List autoinstallable channels for the logged in user.

Parameters:


Returns:

• array :


◦ int "id"

◦ string "name"

◦ string "label"














API Documentation | Chapter 335. Method: listAutoinstallableChannels 383 / 1066





◦ array :


▪ int "id"

▪ string "label"


▪ string "type"

API Documentation | Chapter 335. Method: listAutoinstallableChannels 384 / 1066

Chapter 336. Method:listKickstartableChannelsDescription:

List kickstartable channels for the logged in user.

Parameters:


Returns:

• array :


◦ int "id"

◦ string "name"

◦ string "label"














API Documentation | Chapter 336. Method: listKickstartableChannels 385 / 1066





◦ array :


▪ int "id"

▪ string "label"


▪ string "type"

API Documentation | Chapter 336. Method: listKickstartableChannels 386 / 1066

Chapter 337. Method: listKickstartsDescription:

Provides a list of kickstart profiles visible to the user’s org

Parameters:


Returns:

• array :

• struct - kickstart

◦ string "label"

◦ string "tree_label"

◦ string "name"

◦ boolean "advanced_mode"

◦ boolean "org_default"

◦ boolean "active"

◦ string "update_type"

API Documentation | Chapter 337. Method: listKickstarts 387 / 1066

Chapter 338. Method: renameProfileDescription:

Rename a kickstart profile in Uyuni.

Parameters:


• string originalLabel - Label for the kickstart profile you want to rename

• string newLabel - new label to change to

Returns:


API Documentation | Chapter 338. Method: renameProfile 388 / 1066

kickstart.filepreservation



• delete

• getDetails

• listAllFilePreservations


Chapter 340. DescriptionProvides methods to retrieve and manipulate kickstart file preservation lists.

Namespace:

kickstart.filepreservation



Create a new file preservation list.

Parameters:

• string session_key

• string name - name of the file list to create

• array :

◦ string - name - file names to include

Returns:




Delete a file preservation list.

Parameters:


• string name - name of the file list to delete

Returns:




Returns all of the data associated with the given file preservation list.

Parameters:


• string name - name of the file list to retrieve details for

Returns:

• * struct - file list

◦ string "name"

◦ array "file_names"

▪ string - name


Chapter 344. Method: listAllFilePreservationsDescription:

List all file preservation lists for the organization associated with the user logged into the given

session

Parameters:


Returns:

• array :

• struct - file preservation

◦ int "id"

◦ string "name"

◦ dateTime.iso8601 "created"


API Documentation | Chapter 344. Method: listAllFilePreservations 395 / 1066

kickstart.keys



• delete

• getDetails

• listAllKeys

• update


Chapter 346. DescriptionProvides methods to manipulate kickstart keys.

Namespace:

kickstart.keys



creates a new key with the given parameters

Parameters:



• string type - valid values are GPG or SSL

• string content

Returns:




deletes the key identified by the given parameters

Parameters:



Returns:




returns all of the data associated with the given key

Parameters:



Returns:

• struct - key


◦ string "type"

◦ string "content"


Chapter 350. Method: listAllKeysDescription:

list all keys for the org associated with the user logged into the given session

Parameters:


Returns:

• array :

◦ struct - key


▪ string "type"

API Documentation | Chapter 350. Method: listAllKeys 402 / 1066


Updates type and content of the key identified by the description

Parameters:



• string type - valid values are GPG or SSL

• string content

Returns:



kickstart.profile


Chapter 352. Available methods• addIpRange

• addScript

• addScript

• addScript

• compareActivationKeys

• compareAdvancedOptions

• comparePackages

• downloadKickstart

• downloadRenderedKickstart

• getAdvancedOptions

• getAvailableRepositories

• getCfgPreservation

• getChildChannels

• getCustomOptions

• getKickstartTree

• getRepositories

• getUpdateType

• getVariables

• getVirtualizationType

• listIpRanges

• listScripts

• orderScripts

• removeIpRange

• removeScript

• setAdvancedOptions


• setCfgPreservation

• setChildChannels

• setCustomOptions

• setKickstartTree

• setLogging

• setRepositories

• setUpdateType

• setVariables

• setVirtualizationType


Chapter 353. DescriptionProvides methods to access and modify many aspects of a kickstart profile.

Namespace:

kickstart.profile


Chapter 354. Method: addIpRangeDescription:

Add an ip range to a kickstart profile.

Parameters:


• string label - The label of the kickstart

• string 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)

Returns:


API Documentation | Chapter 354. Method: addIpRange 408 / 1066

Chapter 355. Method: addScriptDescription:

Add a pre/post script to a kickstart profile.

Parameters:


• string 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 string will 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.

Returns:

• int id - the id of the added script

API Documentation | Chapter 355. Method: addScript 409 / 1066



Parameters:









or not.

• boolean template - Enable templating using cobbler.

Returns:





Parameters:









or not.

• boolean template - Enable templating using cobbler.

• boolean erroronfail - Whether to throw an error if the script fails or not

Returns:



Chapter 358. Method: compareActivationKeysDescription:

Returns a list for each kickstart profile; each list will contain activation keys not present on the

other profile.

Parameters:


• string kickstartLabel1


Returns:

• struct - Comparison Info

◦ array "kickstartLabel1" - Actual label of the first kickstart profile is the key into the struct

◦ array :


◦ string "key"













API Documentation | Chapter 358. Method: compareActivationKeys 412 / 1066







◦ default

◦ ssh-push

◦ ssh-push-tunnel

◦ array "kickstartLabel2" - Actual label of the second kickstart profile is the key into the

struct

◦ array :


◦ string "key"




















◦ default

◦ ssh-push

◦ ssh-push-tunnel


Chapter 359. Method:compareAdvancedOptionsDescription:

Returns a list for each kickstart profile; each list will contain the properties that differ between the

profiles and their values for that specific profile .

Parameters:




Returns:



◦ array :

• struct - value

◦ string "name"

◦ string "value"

◦ boolean "enabled"


struct

◦ array :

• struct - value

◦ string "name"

◦ string "value"


API Documentation | Chapter 359. Method: compareAdvancedOptions 415 / 1066

Chapter 360. Method: comparePackagesDescription:

Returns a list for each kickstart profile; each list will contain package names not present on the

other profile.

Parameters:




Returns:



◦ array :

▪ string - package name


struct

◦ array :

▪ string - package name

API Documentation | Chapter 360. Method: comparePackages 416 / 1066

Chapter 361. Method: downloadKickstartDescription:

Download the full contents of a kickstart file.

Parameters:


• string ksLabel - The label of the kickstart to download.

• string host - The host to use when referring to the Uyuni server. Usually this should be the

FQDN, but could be the ip address or shortname as well.

Returns:

• string ks - The contents of the kickstart file. Note: if an activation key is not associated with

the kickstart file, registration will not occur in the generated %post section. If one is

associated, it will be used for registration

API Documentation | Chapter 361. Method: downloadKickstart 417 / 1066

Chapter 362. Method:downloadRenderedKickstartDescription:

Downloads the Cobbler-rendered Kickstart file.

Parameters:


• string ksLabel - The label of the kickstart to download.

Returns:

• string ks - The contents of the kickstart file

API Documentation | Chapter 362. Method: downloadRenderedKickstart 418 / 1066

Chapter 363. Method: getAdvancedOptionsDescription:

Get advanced options for a kickstart profile.

Parameters:


• string ksLabel - Label of kickstart profile to be changed.

Returns:

• array :

• struct - option

◦ string "name"

◦ string "arguments"

API Documentation | Chapter 363. Method: getAdvancedOptions 419 / 1066

Chapter 364. Method:getAvailableRepositoriesDescription:

Lists available OS repositories to associate with the provided kickstart profile.

Parameters:


• string ksLabel

Returns:

• array :

◦ string - repositoryLabel

API Documentation | Chapter 364. Method: getAvailableRepositories 420 / 1066

Chapter 365. Method: getCfgPreservationDescription:

Get ks.cfg preservation option for a kickstart profile.

Parameters:


• string kslabel - Label of kickstart profile to be changed.

Returns:

• boolean preserve - The value of the option. True means that ks.cfg will be copied to /root,

false means that it will not

API Documentation | Chapter 365. Method: getCfgPreservation 421 / 1066

Chapter 366. Method: getChildChannelsDescription:

Get the child channels for a kickstart profile.

Parameters:


• string kslabel - Label of kickstart profile.

Returns:

• array :

◦ string - channelLabel

API Documentation | Chapter 366. Method: getChildChannels 422 / 1066

Chapter 367. Method: getCustomOptionsDescription:

Get custom options for a kickstart profile.

Parameters:


• string ksLabel

Returns:

• array :

• struct - option

◦ int "id"

◦ string "arguments"

API Documentation | Chapter 367. Method: getCustomOptions 423 / 1066

Chapter 368. Method: getKickstartTreeDescription:

Get the kickstart tree for a kickstart profile.

Parameters:



Returns:

• string kstreeLabel - Label of the kickstart tree.

API Documentation | Chapter 368. Method: getKickstartTree 424 / 1066

Chapter 369. Method: getRepositoriesDescription:

Lists all OS repositories associated with provided kickstart profile.

Parameters:


• string ksLabel

Returns:

• array :


API Documentation | Chapter 369. Method: getRepositories 425 / 1066

Chapter 370. Method: getUpdateTypeDescription:

Get the update type for a kickstart profile.

Parameters:


• string kslabel - Label of kickstart profile.

Returns:

• string update_type - Update type for this Kickstart Profile.

API Documentation | Chapter 370. Method: getUpdateType 426 / 1066

Chapter 371. Method: getVariablesDescription:

Returns a list of variables associated with the specified kickstart profile

Parameters:


• string ksLabel

Returns:

• struct - kickstart variable

◦ string "key"

◦ string or int "value"

API Documentation | Chapter 371. Method: getVariables 427 / 1066

Chapter 372. Method: getVirtualizationTypeDescription:

For given kickstart profile label returns label of virtualization type it’s using

Parameters:


• string ksLabel

Returns:

• string virtLabel - Label of virtualization type.

API Documentation | Chapter 372. Method: getVirtualizationType 428 / 1066

Chapter 373. Method: listIpRangesDescription:

List all ip ranges for a kickstart profile.

Parameters:


• string label - The label of the kickstart

Returns:

• 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

API Documentation | Chapter 373. Method: listIpRanges 429 / 1066

Chapter 374. Method: listScriptsDescription:

List the pre and post scripts for a kickstart profile in the order they will run during the kickstart.

Parameters:


• string ksLabel - The label of the kickstart

Returns:

• 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 this script. An empty

string indicates the default kickstart shell.

◦ boolean "chroot" - True if the script will be executed within the chroot environment.

◦ 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 server registers and

performs server actions.

API Documentation | Chapter 374. Method: listScripts 430 / 1066

Chapter 375. Method: orderScriptsDescription:

Change the order that kickstart scripts will run for this kickstart profile. Scripts will run in the order

they appear in the array. There are three arrays, one for all pre scripts, one for the post scripts

that run before registration and server actions happen, and one for post scripts that run after

registration and server actions. All scripts must be included in one of these lists, as appropriate.

Parameters:


• string ksLabel - The label of the kickstart

• 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

Returns:


API Documentation | Chapter 375. Method: orderScripts 431 / 1066

Chapter 376. Method: removeIpRangeDescription:

Remove an ip range from a kickstart profile.

Parameters:


• 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 to remove.

The min or max of the range will work.

Returns:

• int status - 1 on successful removal, 0 if range wasn’t found for the specified kickstart,

exception otherwise

API Documentation | Chapter 376. Method: removeIpRange 432 / 1066

Chapter 377. Method: removeScriptDescription:

Remove a script from a kickstart profile.

Parameters:


• string ksLabel - The kickstart from which to remove the script from.

• int scriptId - The id of the script to remove.

Returns:


API Documentation | Chapter 377. Method: removeScript 433 / 1066

Chapter 378. Method: setAdvancedOptionsDescription:

Set advanced options for a kickstart profile. If 'md5_crypt_rootpw' is set to 'True', 'root_pw' is

taken as plaintext and will md5 encrypted on server side, otherwise a hash encoded password

(according to the auth option) is expected

Parameters:


• 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, firewall, xconfig, skipx, key, ignoredisk,

autopart, cmdline, firstboot, graphical, iscsi, iscsiname, logging, monitor, multipath,

poweroff, halt, services, shutdown, user, vnc, zfcp, driverdisk, md5_crypt_rootpw

▪ string "arguments" - Arguments of the option

Returns:


API Documentation | Chapter 378. Method: setAdvancedOptions 434 / 1066

Chapter 379. Method: setCfgPreservationDescription:

Set ks.cfg preservation option for a kickstart profile.

Parameters:



• boolean preserve - whether or not ks.cfg and all %include fragments will be copied to /root.

Returns:


API Documentation | Chapter 379. Method: setCfgPreservation 435 / 1066

Chapter 380. Method: setChildChannelsDescription:

Set the child channels for a kickstart profile.

Parameters:



• [.string[]]string[] channelLabels - List of labels of child channels

Returns:


API Documentation | Chapter 380. Method: setChildChannels 436 / 1066

Chapter 381. Method: setCustomOptionsDescription:

Set custom options for a kickstart profile.

Parameters:


• string ksLabel

• [.string[]]string[] options

Returns:


API Documentation | Chapter 381. Method: setCustomOptions 437 / 1066

Chapter 382. Method: setKickstartTreeDescription:

Set the kickstart tree for a kickstart profile.

Parameters:



• string kstreeLabel - Label of new kickstart tree.

Returns:


API Documentation | Chapter 382. Method: setKickstartTree 438 / 1066

Chapter 383. Method: setLoggingDescription:

Set logging options for a kickstart profile.

Parameters:



• boolean pre - whether or not to log the pre section of a kickstart to /root/ks-pre.log

• boolean post - whether or not to log the post section of a kickstart to /root/ks-post.log

Returns:


API Documentation | Chapter 383. Method: setLogging 439 / 1066

Chapter 384. Method: setRepositoriesDescription:

Associates OS repository to a kickstart profile.

Parameters:


• string ksLabel

• array :


Returns:


API Documentation | Chapter 384. Method: setRepositories 440 / 1066

Chapter 385. Method: setUpdateTypeDescription:

Set the update typefor a kickstart profile.

Parameters:



• string updateType - The new update type to set. Possible values are 'all' and 'none'.

Returns:


API Documentation | Chapter 385. Method: setUpdateType 441 / 1066

Chapter 386. Method: setVariablesDescription:

Associates list of kickstart variables with the specified kickstart profile

Parameters:


• string ksLabel

• struct - kickstart variable

◦ string "key"

◦ string or int "value"

Returns:


API Documentation | Chapter 386. Method: setVariables 442 / 1066

Chapter 387. Method: setVirtualizationTypeDescription:

For given kickstart profile label sets its virtualization type.

Parameters:


• string ksLabel

• string typeLabel - One of the following: 'none', 'qemu', 'para_host', 'xenpv', 'xenfv'

Returns:


API Documentation | Chapter 387. Method: setVirtualizationType 443 / 1066

kickstart.profile.keys


Chapter 388. Available methods• addActivationKey

• getActivationKeys

• removeActivationKey


Chapter 389. DescriptionProvides methods to access and modify the list of activation keys associated with a kickstart

profile.

Namespace:

kickstart.profile.keys


Chapter 390. Method: addActivationKeyDescription:

Add an activation key association to the kickstart profile

Parameters:


• string ksLabel - the kickstart profile label

• string key - the activation key

Returns:


API Documentation | Chapter 390. Method: addActivationKey 447 / 1066

Chapter 391. Method: getActivationKeysDescription:

Lookup the activation keys associated with the kickstart profile.

Parameters:



Returns:

• array :


◦ string "key"
















API Documentation | Chapter 391. Method: getActivationKeys 448 / 1066




◦ default

◦ ssh-push

◦ ssh-push-tunnel

API Documentation | Chapter 391. Method: getActivationKeys 449 / 1066

Chapter 392. Method: removeActivationKeyDescription:

Remove an activation key association from the kickstart profile

Parameters:



• string key - the activation key

Returns:


API Documentation | Chapter 392. Method: removeActivationKey 450 / 1066

kickstart.profile.software


Chapter 393. Available methods• appendToSoftwareList

• getSoftwareDetails

• getSoftwareList

• setSoftwareDetails

• setSoftwareList

• setSoftwareList


Chapter 394. DescriptionProvides methods to access and modify the software list associated with a kickstart profile.

Namespace:

kickstart.profile.software


Chapter 395. Method: appendToSoftwareListDescription:

Append the list of software packages to a kickstart profile. Duplicate packages will be ignored.

Parameters:


• string ksLabel - The label of a kickstart profile.

• [.string[]]string[] packageList - A list of package names to be added to the profile.

Returns:


API Documentation | Chapter 395. Method: appendToSoftwareList 454 / 1066

Chapter 396. Method: getSoftwareDetailsDescription:

Gets kickstart profile software details.

Parameters:


• string ksLabel - Label of the kickstart profile

Returns:

• struct - Kickstart packages info

◦ string "noBase" - Install @Base package group

◦ string "ignoreMissing" - Ignore missing packages

API Documentation | Chapter 396. Method: getSoftwareDetails 455 / 1066

Chapter 397. Method: getSoftwareListDescription:

Get a list of a kickstart profile’s software packages.

Parameters:



Returns:

• array :

◦ string - Get a list of a kickstart profile’s software packages

API Documentation | Chapter 397. Method: getSoftwareList 456 / 1066

Chapter 398. Method: setSoftwareDetailsDescription:

Sets kickstart profile software details.

Parameters:


• string ksLabel - Label of the kickstart profile

• struct - Kickstart packages info

◦ string "noBase" - Install @Base package group

◦ string "ignoreMissing" - Ignore missing packages

Returns:


API Documentation | Chapter 398. Method: setSoftwareDetails 457 / 1066

Chapter 399. Method: setSoftwareListDescription:

Set the list of software packages for a kickstart profile.

Parameters:



• [.string[]]string[] packageList - A list of package names to be set on the profile.

Returns:


API Documentation | Chapter 399. Method: setSoftwareList 458 / 1066

Chapter 400. Method: setSoftwareListDescription:

Set the list of software packages for a kickstart profile.

Parameters:



• [.string[]]string[] packageList - A list of package names to be set on the profile.

• boolean ignoremissing - Ignore missing packages if true

• boolean nobase - Don’t install @Base package group if true

Returns:


API Documentation | Chapter 400. Method: setSoftwareList 459 / 1066

kickstart.profile.system


Chapter 401. Available methods• addFilePreservations

• addKeys

• checkConfigManagement

• checkRemoteCommands

• disableConfigManagement

• disableRemoteCommands

• enableConfigManagement

• enableRemoteCommands

• getLocale

• getPartitioningScheme

• getRegistrationType

• getSELinux

• listFilePreservations

• listKeys

• removeFilePreservations

• removeKeys

• setLocale

• setPartitioningScheme

• setRegistrationType

• setSELinux


Chapter 402. DescriptionProvides methods to set various properties of a kickstart profile.

Namespace:

kickstart.profile.system


Chapter 403. Method: addFilePreservationsDescription:

Adds the given list of file preservations to the specified kickstart profile.

Parameters:


• string kickstartLabel

• array :

◦ string - filePreservations

Returns:


API Documentation | Chapter 403. Method: addFilePreservations 463 / 1066

Chapter 404. Method: addKeysDescription:

Adds the given list of keys to the specified kickstart profile.

Parameters:



• array :

◦ string - keyDescription

Returns:


API Documentation | Chapter 404. Method: addKeys 464 / 1066

Chapter 405. Method:checkConfigManagementDescription:

Check the configuration management status for a kickstart profile.

Parameters:



Returns:

• boolean enabled - true if configuration management is enabled; otherwise, false

API Documentation | Chapter 405. Method: checkConfigManagement 465 / 1066

Chapter 406. Method:checkRemoteCommandsDescription:

Check the remote commands status flag for a kickstart profile.

Parameters:



Returns:

• boolean enabled - true if remote commands support is enabled; otherwise, false

API Documentation | Chapter 406. Method: checkRemoteCommands 466 / 1066

Chapter 407. Method:disableConfigManagementDescription:

Disables the configuration management flag in a kickstart profile so that a system created using

this profile will be NOT be configuration capable.

Parameters:



Returns:


API Documentation | Chapter 407. Method: disableConfigManagement 467 / 1066

Chapter 408. Method:disableRemoteCommandsDescription:

Disables the remote command flag in a kickstart profile so that a system created using this

profile will be capable of running remote commands

Parameters:



Returns:


API Documentation | Chapter 408. Method: disableRemoteCommands 468 / 1066

Chapter 409. Method:enableConfigManagementDescription:

Enables the configuration management flag in a kickstart profile so that a system created using

this profile will be configuration capable.

Parameters:



Returns:


API Documentation | Chapter 409. Method: enableConfigManagement 469 / 1066

Chapter 410. Method:enableRemoteCommandsDescription:

Enables the remote command flag in a kickstart profile so that a system created using this profile

will be capable of running remote commands

Parameters:



Returns:


API Documentation | Chapter 410. Method: enableRemoteCommands 470 / 1066

Chapter 411. Method: getLocaleDescription:

Retrieves the locale for a kickstart profile.

Parameters:



Returns:

• struct - locale info

◦ string "locale"

◦ boolean "useUtc"

◦ true - the hardware clock uses UTC

◦ false - the hardware clock does not use UTC

API Documentation | Chapter 411. Method: getLocale 471 / 1066

Chapter 412. Method: getPartitioningSchemeDescription:

Get the partitioning scheme for a kickstart profile.

Parameters:



Returns:

• array :

◦ string - A list of partitioning commands used to setup the partitions, logical volumes and

volume groups

API Documentation | Chapter 412. Method: getPartitioningScheme 472 / 1066

Chapter 413. Method: getRegistrationTypeDescription:

returns the registration type of a given kickstart profile. Registration Type can be one of

reactivation/deletion/none These types determine the behaviour of the registration when using

this profile for reprovisioning.

Parameters:



Returns:

• string registrationType

• reactivation

• deletion

• none

API Documentation | Chapter 413. Method: getRegistrationType 473 / 1066

Chapter 414. Method: getSELinuxDescription:

Retrieves the SELinux enforcing mode property of a kickstart profile.

Parameters:



Returns:

• string enforcingMode

• enforcing

• permissive

• disabled

API Documentation | Chapter 414. Method: getSELinux 474 / 1066

Chapter 415. Method: listFilePreservationsDescription:

Returns the set of all file preservations associated with the given kickstart profile.

Parameters:



Returns:

• array :

• struct - file list

◦ string "name"

◦ array "file_names"

▪ string - name

API Documentation | Chapter 415. Method: listFilePreservations 475 / 1066

Chapter 416. Method: listKeysDescription:

Returns the set of all keys associated with the given kickstart profile.

Parameters:



Returns:

• array :

◦ struct - key


▪ string "type"

▪ string "content"

API Documentation | Chapter 416. Method: listKeys 476 / 1066

Chapter 417. Method: removeFilePreservationsDescription:

Removes the given list of file preservations from the specified kickstart profile.

Parameters:



• array :

◦ string - filePreservations

Returns:


API Documentation | Chapter 417. Method: removeFilePreservations 477 / 1066

Chapter 418. Method: removeKeysDescription:

Removes the given list of keys from the specified kickstart profile.

Parameters:



• array :

◦ string - keyDescription

Returns:


API Documentation | Chapter 418. Method: removeKeys 478 / 1066

Chapter 419. Method: setLocaleDescription:

Sets the locale for a kickstart profile.

Parameters:



• string locale - the locale

• boolean useUtc

• true - the hardware clock uses UTC

• false - the hardware clock does not use UTC

Returns:


API Documentation | Chapter 419. Method: setLocale 479 / 1066

Chapter 420. Method: setPartitioningSchemeDescription:

Set the partitioning scheme for a kickstart profile.

Parameters:


• string ksLabel - The label of the kickstart profile to update.

• [.string[]]string[] scheme - The partitioning scheme is a list of partitioning command strings

used to setup the partitions, volume groups and logical volumes.

Returns:


API Documentation | Chapter 420. Method: setPartitioningScheme 480 / 1066

Chapter 421. Method: setRegistrationTypeDescription:

Sets the registration type of a given kickstart profile. Registration Type can be one of

reactivation/deletion/none These types determine the behaviour of the re registration when

using this profile.

Parameters:



• string registrationType

• reactivation - to try and generate a reactivation key and use that to register the system

when reprovisioning a system.

• deletion - to try and delete the existing system profile and reregister the system being

reprovisioned as new

• none - to preserve the status quo and leave the current system as a duplicate on a

reprovision.

Returns:


API Documentation | Chapter 421. Method: setRegistrationType 481 / 1066

Chapter 422. Method: setSELinuxDescription:

Sets the SELinux enforcing mode property of a kickstart profile so that a system created using this

profile will be have the appropriate SELinux enforcing mode.

Parameters:



• string enforcingMode - the selinux enforcing mode

• enforcing

• permissive

• disabled

Returns:


API Documentation | Chapter 422. Method: setSELinux 482 / 1066

kickstart.snippet


Chapter 423. Available methods• createOrUpdate

• delete

• listAll

• listCustom

• listDefault


Chapter 424. DescriptionProvides methods to create kickstart files

Namespace:

kickstart.snippet


Chapter 425. Method: createOrUpdateDescription:

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 name

• string contents

Returns:

• * struct - snippet

◦ string "name"


◦ string "fragment" - The string to include in a kickstart file that will generate this snippet.

◦ string "file" - The local path to the file containing this snippet.

API Documentation | Chapter 425. Method: createOrUpdate 486 / 1066


Delete the specified snippet. If the snippet is not found, 0 is returned.

Parameters:


• string name

Returns:



Chapter 427. Method: listAllDescription:

List all cobbler snippets for the logged in user

Parameters:


Returns:

• array :

• struct - snippet

◦ string "name"




API Documentation | Chapter 427. Method: listAll 488 / 1066

Chapter 428. Method: listCustomDescription:

List only custom snippets for the logged in user. These snipppets are editable.

Parameters:


Returns:

• array :


◦ string "name"




API Documentation | Chapter 428. Method: listCustom 489 / 1066

Chapter 429. Method: listDefaultDescription:

List only pre-made default snippets for the logged in user. These snipppets are not editable.

Parameters:


Returns:

• array :


◦ string "name"




API Documentation | Chapter 429. Method: listDefault 490 / 1066

kickstart.tree



• delete

• deleteTreeAndProfiles

• getDetails

• list

• listInstallTypes

• rename

• update


Chapter 431. DescriptionProvides methods to access and modify the kickstart trees.

Namespace:

kickstart.tree



Create a Kickstart Tree (Distribution) in Uyuni.

Parameters:


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

Returns:




Delete a Kickstart Tree (Distribution) from Uyuni.

Parameters:


• string treeLabel - Label for the kickstart tree to delete.

Returns:



Chapter 434. Method: deleteTreeAndProfilesDescription:

Delete a kickstarttree and any profiles associated with this kickstart tree. WARNING: This will delete

all profiles associated with this kickstart tree!

Parameters:


• string treeLabel - Label for the kickstart tree to delete.

Returns:


API Documentation | Chapter 434. Method: deleteTreeAndProfiles 496 / 1066


The detailed information about a kickstartable tree given the tree name.

Parameters:


• string treeLabel - Label of kickstartable tree to search.

Returns:

• * struct - kickstartable tree

◦ int "id"

◦ string "label"

◦ string "abs_path"

◦ int "channel_id"

• struct - kickstart install type

◦ int "id"

◦ string "label"

◦ string "name"



List the available kickstartable trees for the given channel.

Parameters:


• string channelLabel - Label of channel to search.

Returns:

• array :

• struct - kickstartable tree

◦ int "id"

◦ string "label"

◦ string "base_path"

◦ int "channel_id"


Chapter 437. Method: listInstallTypesDescription:

List the available kickstartable install types (rhel2,3,4,5 and fedora9+).

Parameters:


Returns:

• array :

• struct - kickstart install type

◦ int "id"

◦ string "label"

◦ string "name"

API Documentation | Chapter 437. Method: listInstallTypes 499 / 1066

Chapter 438. Method: renameDescription:

Rename a Kickstart Tree (Distribution) in Uyuni.

Parameters:


• string originalLabel - Label for the kickstart tree to rename.

• string newLabel - The kickstart tree’s new label.

Returns:


API Documentation | Chapter 438. Method: rename 500 / 1066


Edit a Kickstart Tree (Distribution) in Uyuni.

Parameters:


• string 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).

Returns:



maintenance


Chapter 440. Available methods• assignScheduleToSystems

• createCalendar

• createCalendarWithUrl

• createSchedule

• createSchedule

• deleteCalendar

• deleteSchedule

• getCalendarDetails

• getScheduleDetails

• listCalendarLabels

• listScheduleNames

• listSystemsWithSchedule

• refreshCalendar

• retractScheduleFromSystems

• updateCalendar

• updateSchedule


Chapter 441. DescriptionProvides methods to access and modify Maintenance Schedules related entities

Namespace:

maintenance


Chapter 442. Method:assignScheduleToSystemsDescription:

Assign schedule with given name to systems with given IDs. Throws a

PermissionCheckFailureException when some of the systems are not accessible by the user.

Throws a InvalidParameterException when some of the systems have pending actions that are

not allowed in the maintenance mode.

Parameters:


• 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

Returns:

• array :

◦ int - number of involved systems

API Documentation | Chapter 442. Method: assignScheduleToSystems 505 / 1066

Chapter 443. Method: createCalendarDescription:

Create a new Maintenance Calendar

Parameters:


• string label - Maintenance Calendar Label

• string ical - ICal Calendar Data

Returns:

• array :

• struct - Maintenance Calendar information

◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "url" - calendar url if present

◦ string "ical"

API Documentation | Chapter 443. Method: createCalendar 506 / 1066

Chapter 444. Method: createCalendarWithUrlDescription:

Create a new Maintenance Calendar

Parameters:



• string url - download URL for ICal Calendar Data

Returns:

• array :


◦ int "id"

◦ int "orgId"

◦ string "label"


◦ string "ical"

API Documentation | Chapter 444. Method: createCalendarWithUrl 507 / 1066

Chapter 445. Method: createScheduleDescription:

Create a new Maintenance Schedule

Parameters:


• string name - Maintenance Schedule Name

• string type - Schedule type: single, multi

Returns:

• array :

• struct - Maintenance Schedule information

◦ int "id"

◦ int "orgId"

◦ string "name"

◦ string "type"


◦ int "id"

◦ int "orgId"

◦ string "label"


◦ string "ical"

API Documentation | Chapter 445. Method: createSchedule 508 / 1066

Chapter 446. Method: createScheduleDescription:

Create a new Maintenance Schedule

Parameters:



• string type - Schedule type: single, multi

• string calendar - Maintenance Calendar Label

Returns:

• array :


◦ int "id"

◦ int "orgId"

◦ string "name"

◦ string "type"


◦ int "id"

◦ int "orgId"

◦ string "label"


◦ string "ical"

API Documentation | Chapter 446. Method: createSchedule 509 / 1066

Chapter 447. Method: deleteCalendarDescription:

Remove a Maintenance Calendar

Parameters:



• boolean cancelScheduledActions - Cancel Actions of affected Schedules

Returns:

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

▪ string "type" - Action type.

▪ string "scheduler" - The user that scheduled the action. (optional)

▪ dateTime.iso8601 "earliest" - The earliest date and time the action will be

performed

▪ int "prerequisite" - ID of the prerequisite Action (optional)

▪ array "affected_system_ids"

▪ int - affected System Ids

▪ string "details" - Action details string

API Documentation | Chapter 447. Method: deleteCalendar 510 / 1066

Chapter 448. Method: deleteScheduleDescription:

Remove a Maintenance Schedule

Parameters:



Returns:


API Documentation | Chapter 448. Method: deleteSchedule 511 / 1066

Chapter 449. Method: getCalendarDetailsDescription:

Lookup a specific Maintenance Schedule

Parameters:



Returns:

• array :


◦ int "id"

◦ int "orgId"

◦ string "label"


◦ string "ical"

API Documentation | Chapter 449. Method: getCalendarDetails 512 / 1066

Chapter 450. Method: getScheduleDetailsDescription:

Lookup a specific Maintenance Schedule

Parameters:



Returns:

• array :


◦ int "id"

◦ int "orgId"

◦ string "name"

◦ string "type"


◦ int "id"

◦ int "orgId"

◦ string "label"


◦ string "ical"

API Documentation | Chapter 450. Method: getScheduleDetails 513 / 1066

Chapter 451. Method: listCalendarLabelsDescription:

List Schedule Names visible to user

Parameters:


Returns:

• array :

◦ string - maintenance calendar labels

API Documentation | Chapter 451. Method: listCalendarLabels 514 / 1066

Chapter 452. Method: listScheduleNamesDescription:

List Schedule Names visible to user

Parameters:


Returns:

• array :

◦ string - maintenance schedule names

API Documentation | Chapter 452. Method: listScheduleNames 515 / 1066

Chapter 453. Method:listSystemsWithScheduleDescription:

List IDs of systems that have given schedule assigned Throws a PermissionCheckFailureException

when some of the systems are not accessible by the user.

Parameters:


• string scheduleName - The schedule name

Returns:

• array :


API Documentation | Chapter 453. Method: listSystemsWithSchedule 516 / 1066

Chapter 454. Method: refreshCalendarDescription:

Refresh Maintenance Calendar Data using the configured URL

Parameters:



• array :



◦ Fail - Let update fail. The calendar stay untouched

Returns:

• array :






◦ array "actions"







performed


API Documentation | Chapter 454. Method: refreshCalendar 517 / 1066




API Documentation | Chapter 454. Method: refreshCalendar 518 / 1066

Chapter 455. Method:retractScheduleFromSystemsDescription:

Retract schedule with given name from systems with given IDs Throws a

PermissionCheckFailureException when some of the systems are not accessible by the user.

Parameters:


• array :


Returns:

• array :

◦ int - number of involved systems

API Documentation | Chapter 455. Method: retractScheduleFromSystems 519 / 1066

Chapter 456. Method: updateCalendarDescription:

Update a Maintenance Calendar

Parameters:



• struct - Maintenance Calendar Details

◦ string "ical" - new ical Calendar data

◦ string "url" - new Calendar URL

• array :




Returns:

• array :






◦ array "actions"





API Documentation | Chapter 456. Method: updateCalendar 520 / 1066



performed





API Documentation | Chapter 456. Method: updateCalendar 521 / 1066

Chapter 457. Method: updateScheduleDescription:

Update a Maintenance Schedule

Parameters:



• struct - Maintenance Schedule Details

◦ string "type" - new Schedule Type

◦ single

◦ multi

◦ string "calendar" - new calendar label

• array :




Returns:

• * struct - Reschedule information





◦ array "actions"




API Documentation | Chapter 457. Method: updateSchedule 522 / 1066




performed





API Documentation | Chapter 457. Method: updateSchedule 523 / 1066

org



• delete

• getClmSyncPatchesConfig

• getDetails

• getDetails

• getPolicyForScapFileUpload

• getPolicyForScapResultDeletion

• isContentStagingEnabled

• isErrataEmailNotifsForOrg

• isOrgConfigManagedByOrgAdmin

• listOrgs

• listUsers

• migrateSystems

• setClmSyncPatchesConfig

• setContentStaging

• setErrataEmailNotifsForOrg

• setOrgConfigManagedByOrgAdmin

• setPolicyForScapFileUpload

• setPolicyForScapResultDeletion

• transferSystems

• updateName


Chapter 459. DescriptionContains methods to access common organization management functions available from the

web interface.

Namespace:

org



Create a new organization and associated administrator account.

Parameters:


• string orgName - Organization name. Must meet same criteria as in the web UI.

• string adminLogin - New administrator login name.

• string adminPassword - New administrator password.

• string prefix - New administrator’s prefix. Must match one of the values available in the web

UI. (i.e. Dr., Mr., Mrs., Sr., etc.)

• string firstName - New administrator’s first name.

• string lastName - New administrator’s first name.

• string email - New administrator’s e-mail.

• boolean usePamAuth - True if PAM authentication should be used for the new administrator

account.

Returns:

• * 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_profiles" - Number of kickstart profiles in the organization. (optional)

◦ int "configuration_channels" - Number of configuration channels in the organization.


(optional)

◦ boolean "staging_content_enabled" - Is staging content enabled in organization.

(optional)



Delete an organization. The default organization (i.e. orgId=1) cannot be deleted.

Parameters:


• int orgId

Returns:



Chapter 462. Method:getClmSyncPatchesConfigDescription:

Reads the content lifecycle management patch synchronization config option.

Parameters:


• int orgId

Returns:

• boolean status - Get the config option value

API Documentation | Chapter 462. Method: getClmSyncPatchesConfig 530 / 1066


The detailed information about an organization given the organization ID.

Parameters:


• int orgId

Returns:


◦ int "id"

◦ string "name"








(optional)


(optional)



The detailed information about an organization given the organization name.

Parameters:


• string name

Returns:


◦ int "id"

◦ string "name"








(optional)


(optional)


Chapter 465. Method:getPolicyForScapFileUploadDescription:

Get the status of SCAP detailed result file upload settings for the given organization.

Parameters:


• int orgId

Returns:

• struct - scap_upload_info

◦ boolean "enabled" - Aggregation of detailed SCAP results is enabled.

◦ int "size_limit" - Limit (in Bytes) for a single SCAP file upload.

API Documentation | Chapter 465. Method: getPolicyForScapFileUpload 533 / 1066

Chapter 466. Method:getPolicyForScapResultDeletionDescription:

Get the status of SCAP result deletion settings for the given organization.

Parameters:


• int orgId

Returns:

• struct - scap_deletion_info

◦ boolean "enabled" - Deletion of SCAP results is enabled

◦ int "retention_period" - Period (in days) after which a scan can be deleted (if enabled).

API Documentation | Chapter 466. Method: getPolicyForScapResultDeletion 534 / 1066

Chapter 467. Method:isContentStagingEnabledDescription:

Get the status of content staging settings for the given organization. Returns true if enabled, false

otherwise.

Parameters:


• int orgId

Returns:

• boolean status - Get the status of content staging settings

API Documentation | Chapter 467. Method: isContentStagingEnabled 535 / 1066

Chapter 468. Method:isErrataEmailNotifsForOrgDescription:

Returns whether errata e-mail notifications are enabled for the organization

Parameters:


• int orgId

Returns:

• boolean status - Returns the status of the errata e-mail notification setting for the

organization

API Documentation | Chapter 468. Method: isErrataEmailNotifsForOrg 536 / 1066

Chapter 469. Method:isOrgConfigManagedByOrgAdminDescription:

Returns whether Organization Administrator is able to manage his organization configuration.

This may have a high impact on general Uyuni performance.

Parameters:


• int orgId

Returns:

• boolean status - Returns the status org admin management setting

API Documentation | Chapter 469. Method: isOrgConfigManagedByOrgAdmin 537 / 1066

Chapter 470. Method: listOrgsDescription:

Returns the list of organizations.

Parameters:


Returns:

• array :

• struct - organization info

◦ int "id"

◦ string "name"








(optional)


(optional)

API Documentation | Chapter 470. Method: listOrgs 538 / 1066

Chapter 471. Method: listUsersDescription:

Returns the list of users in a given organization.

Parameters:


• int orgId

Returns:

• array :

• struct - user

◦ string "login"

◦ string "login_uc"

◦ string "name"

◦ string "email"

◦ boolean "is_org_admin"

API Documentation | Chapter 471. Method: listUsers 539 / 1066

Chapter 472. Method: migrateSystems(Deprecated)Description:

Transfer systems from one organization to another. If executed by a Uyuni administrator, the

systems will be transferred from their current organization to the organization specified by the

toOrgId. If executed by an organization administrator, the systems must exist in the same

organization as that administrator and the systems will be transferred to the organization

specified by the toOrgId. In any scenario, the origination and destination organizations must be

defined in a trust.

Note: This method is deprecated and will be removed in a future API version. Please usetransferSystems instead.

Deprecated - being replaced by org.transferSystems(User loggedInUser, Integer toOrgId,

List(Integer) sids)

Parameters:


• int toOrgId - ID of the organization where the system(s) will be transferred to.

• array :

◦ int - systemId

Returns:

• array :

◦ int - serverIdTransferred

API Documentation | Chapter 472. Method: migrateSystems (Deprecated) 540 / 1066

Chapter 473. Method:setClmSyncPatchesConfigDescription:

Sets the content lifecycle management patch synchronization config option.

Parameters:


• int orgId

• boolean value - The config option value

Returns:


API Documentation | Chapter 473. Method: setClmSyncPatchesConfig 541 / 1066

Chapter 474. Method: setContentStagingDescription:

Set the status of content staging for the given organization.

Parameters:


• int orgId

• boolean enable - Use true/false to enable/disable

Returns:


API Documentation | Chapter 474. Method: setContentStaging 542 / 1066

Chapter 475. Method:setErrataEmailNotifsForOrgDescription:

Dis/enables errata e-mail notifications for the organization

Parameters:


• int orgId


Returns:


API Documentation | Chapter 475. Method: setErrataEmailNotifsForOrg 543 / 1066

Chapter 476. Method:setOrgConfigManagedByOrgAdminDescription:

Sets whether Organization Administrator can manage his organization configuration. This may

have a high impact on general Uyuni performance.

Parameters:


• int orgId


Returns:


API Documentation | Chapter 476. Method: setOrgConfigManagedByOrgAdmin 544 / 1066

Chapter 477. Method:setPolicyForScapFileUploadDescription:

Set the status of SCAP detailed result file upload settings for the given organization.

Parameters:


• 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 file upload.

Returns:


API Documentation | Chapter 477. Method: setPolicyForScapFileUpload 545 / 1066

Chapter 478. Method:setPolicyForScapResultDeletionDescription:

Set the status of SCAP result deletion settins for the given organization.

Parameters:


• int orgId

• struct - scap_deletion_info

◦ boolean "enabled" - Deletion of SCAP results is enabled

◦ int "retention_period" - Period (in days) after which a scan can be deleted (if enabled).

Returns:


API Documentation | Chapter 478. Method: setPolicyForScapResultDeletion 546 / 1066

Chapter 479. Method: transferSystemsDescription:

Transfer systems from one organization to another. If executed by a Uyuni administrator, the

systems will be transferred from their current organization to the organization specified by the

toOrgId. If executed by an organization administrator, the systems must exist in the same

organization as that administrator and the systems will be transferred to the organization

specified by the toOrgId. In any scenario, the origination and destination organizations must be

defined in a trust.

Parameters:


• int toOrgId - ID of the organization where the system(s) will be transferred to.

• array :

◦ int - systemId

Returns:

• array :

◦ int - serverIdTransferred

API Documentation | Chapter 479. Method: transferSystems 547 / 1066

Chapter 480. Method: updateNameDescription:

Updates the name of an organization

Parameters:


• int orgId

• string name - Organization name. Must meet same criteria as in the web UI.

Returns:


◦ int "id"

◦ string "name"








(optional)


(optional)

API Documentation | Chapter 480. Method: updateName 548 / 1066

org.trusts


Chapter 481. Available methods• addTrust

• getDetails

• listChannelsConsumed

• listChannelsProvided

• listOrgs

• listSystemsAffected

• listTrusts

• removeTrust


Chapter 482. DescriptionContains methods to access common organization trust information available from the web

interface.

Namespace:

org.trusts


Chapter 483. Method: addTrustDescription:

Add an organization to the list of trusted organizations.

Parameters:


• int orgId

• int trustOrgId

Returns:


API Documentation | Chapter 483. Method: addTrust 552 / 1066


The trust details about an organization given the organization’s ID.

Parameters:


• int trustOrgId - Id of the trusted organization

Returns:

• struct - org trust details

◦ dateTime.iso8601 "created" - Date the organization was created

◦ dateTime.iso8601 "trusted_since" - Date the organization was defined as trusted

◦ int "channels_provided" - Number of channels provided by the organization.

◦ int "channels_consumed" - Number of channels consumed by the organization.

◦ int "systems_migrated_to" - (Deprecated by systems_transferred_to) Number of

systems transferred to the organization.

◦ int "systems_migrated_from" - (Deprecated by systems_transferred_from) Number of

systems transferred from the organization.

◦ int "systems_transferred_to" - Number of systems transferred to the organization.

◦ int "systems_transferred_from" - Number of systems transferred from the organization.


Chapter 485. Method: listChannelsConsumedDescription:

Lists all software channels that the organization given may consume from the user’s

organization.

Parameters:



Returns:

• array :

◦ struct - channel info


▪ string "channel_name"

▪ int "packages"

▪ int "systems"

API Documentation | Chapter 485. Method: listChannelsConsumed 554 / 1066

Chapter 486. Method: listChannelsProvidedDescription:

Lists all software channels that the organization given is providing to the user’s organization.

Parameters:



Returns:

• array :

◦ struct - channel info


▪ string "channel_name"

▪ int "packages"

▪ int "systems"

API Documentation | Chapter 486. Method: listChannelsProvided 555 / 1066

Chapter 487. Method: listOrgsDescription:

List all organanizations trusted by the user’s organization.

Parameters:


Returns:

• array :

• struct - trusted organizations

◦ int "org_id"

◦ string "org_name"

◦ int "shared_channels"

API Documentation | Chapter 487. Method: listOrgs 556 / 1066

Chapter 488. Method: listSystemsAffectedDescription:

Get a list of systems within the trusted organization that would be affected if the trust relationship

was removed. This basically lists systems that are sharing at least (1) package.

Parameters:


• int orgId

• string trustOrgId

Returns:

• array :

◦ struct - affected systems

▪ int "systemId"

▪ string "systemName"

API Documentation | Chapter 488. Method: listSystemsAffected 557 / 1066

Chapter 489. Method: listTrustsDescription:

Returns the list of trusted organizations.

Parameters:


• int orgId

Returns:

• * array :

◦ struct - trusted organizations

▪ int "orgId"

▪ string "orgName"

▪ boolean "trustEnabled"

API Documentation | Chapter 489. Method: listTrusts 558 / 1066

Chapter 490. Method: removeTrustDescription:

Remove an organization to the list of trusted organizations.

Parameters:


• int orgId

• int trustOrgId

Returns:


API Documentation | Chapter 490. Method: removeTrust 559 / 1066

packages


Chapter 491. Available methods• findByNvrea

• getDetails

• getPackage

• getPackageUrl

• listChangelog

• listDependencies

• listFiles

• listProvidingChannels

• listProvidingErrata

• listSourcePackages

• removePackage

• removeSourcePackage


Chapter 492. DescriptionMethods to retrieve information about the Packages contained within this server.

Namespace:

packages


Chapter 493. Method: findByNvreaDescription:

Lookup the details for packages with the given name, version, release, architecture label, and

(optionally) epoch.

Parameters:


• string name

• string version

• string release

• string epoch - If set to something other than empty string, strict matching will be used and

the epoch string must be correct. If set to an empty string, if the epoch is null or there is only

one NVRA combination, it will be returned. (Empty string is recommended.)

• string archLabel

Returns:

• array :


◦ string "name"



◦ string "epoch"

◦ int "id"






with.

API Documentation | Chapter 493. Method: findByNvrea 563 / 1066


Retrieve details for the package with the ID.

Parameters:


• int packageId

Returns:


◦ int "id"

◦ string "name"

◦ string "epoch"




◦ array "providing_channels"

▪ string - Channel label providing this package.

◦ string "build_host"




◦ string "vendor"


◦ string "cookie"

◦ string "license"

◦ string "file"


◦ string "build_date"


◦ string "size"

◦ string "path" - The path on the Uyuni server’s file system that the package resides.

◦ string "payload_size"


Chapter 495. Method: getPackageDescription:

Retrieve the package file associated with a package. (Consider using packages.getPackageUrl

for larger files.)

Parameters:


• int package_id

Returns:

• array :

◦ byte - binary object - package file

API Documentation | Chapter 495. Method: getPackage 566 / 1066

Chapter 496. Method: getPackageUrlDescription:

Retrieve the url that can be used to download a package. This will expire after a certain time

period.

Parameters:


• int package_id

Returns:

• string - the download url

API Documentation | Chapter 496. Method: getPackageUrl 567 / 1066

Chapter 497. Method: listChangelogDescription:

List the change log for a package.

Parameters:


• int packageId

Returns:

• string

API Documentation | Chapter 497. Method: listChangelog 568 / 1066

Chapter 498. Method: listDependenciesDescription:

List the dependencies for a package.

Parameters:


• int packageId

Returns:

• array :

◦ struct - dependency

▪ string "dependency"

▪ string "dependency_type" - One of the following:

▪ requires

▪ conflicts

▪ obsoletes

▪ provides

▪ recommends

▪ suggests

▪ supplements

▪ enhances

▪ predepends

▪ breaks

▪ string "dependency_modifier"

API Documentation | Chapter 498. Method: listDependencies 569 / 1066


List the files associated with a package.

Parameters:


• int packageId

Returns:

• array :

◦ struct - file info

▪ string "path"

▪ string "type"


▪ string "checksum"

▪ string "checksum_type"

▪ int "size"

▪ string "linkto"


Chapter 500. Method: listProvidingChannelsDescription:

List the channels that provide the a package.

Parameters:


• int packageId

Returns:

• array :


▪ string "label"

▪ string "parent_label"

▪ string "name"

API Documentation | Chapter 500. Method: listProvidingChannels 571 / 1066

Chapter 501. Method: listProvidingErrataDescription:

List the errata providing the a package.

Parameters:


• int packageId

Returns:

• array :

◦ struct - errata

▪ string "advisory"

▪ string "issue_date"


▪ string "update_date"

▪ string "synopsis"

▪ string "type"

API Documentation | Chapter 501. Method: listProvidingErrata 572 / 1066

Chapter 502. Method: listSourcePackagesDescription:

List all source packages in user’s organization.

Parameters:


Returns:

• array :

◦ struct - source_package

▪ int "id"

▪ string "name"

API Documentation | Chapter 502. Method: listSourcePackages 573 / 1066

Chapter 503. Method: removePackageDescription:

Remove a package from Uyuni.

Parameters:


• int packageId

Returns:


API Documentation | Chapter 503. Method: removePackage 574 / 1066

Chapter 504. Method: removeSourcePackageDescription:

Remove a source package.

Parameters:


• int packageSourceId

Returns:


API Documentation | Chapter 504. Method: removeSourcePackage 575 / 1066

packages.provider


Chapter 505. Available methods• associateKey

• list

• listKeys


Chapter 506. DescriptionMethods to retrieve information about Package Providers associated with packages.

Namespace:

packages.provider


Chapter 507. Method: associateKeyDescription:

Associate a package security key and with the package provider. If the provider or key doesn’t

exist, it is created. User executing the request must be a Uyuni administrator.

Parameters:


• string providerName - The provider name

• string key - The actual key

• string type - The type of the key. Currently, only 'gpg' is supported

Returns:


API Documentation | Chapter 507. Method: associateKey 579 / 1066


List all Package Providers. User executing the request must be a Uyuni administrator.

Parameters:


Returns:

• array :

• struct - package provider

◦ string "name"

◦ array "keys"

• struct - package security key

◦ string "key"

◦ string "type"


Chapter 509. Method: listKeysDescription:

List all security keys associated with a package provider. User executing the request must be a

Uyuni administrator.

Parameters:


• string providerName - The provider name

Returns:

• array :

• struct - package security key

◦ string "key"

◦ string "type"

API Documentation | Chapter 509. Method: listKeys 581 / 1066

packages.search


Chapter 510. Available methods• advanced

• advancedWithActKey

• advancedWithChannel

• name

• nameAndDescription

• nameAndSummary


Chapter 511. DescriptionMethods to interface to package search capabilities in search server..

Namespace:

packages.search


Chapter 512. Method: advancedDescription:

Advanced method to search lucene indexes with a passed in query written in Lucene Query

Parser syntax. Lucene Query Parser syntax is defined at

lucene.apache.org.Fields searchable for Packages:name, epoch, version, release, arch, description, summaryLucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"

Parameters:


• string luceneQuery - a query written in the form of Lucene QueryParser Syntax

Returns:

• array :

• struct - package overview

◦ int "id"

◦ string "name"





◦ string "arch"

◦ string "epoch"

◦ string "provider"

API Documentation | Chapter 512. Method: advanced 585 / 1066

Chapter 513. Method: advancedWithActKeyDescription:


Parser syntax, additionally this method will limit results to those which are associated with a

given activation key. Lucene Query Parser syntax is defined at


Parameters:



• string actKey - activation key to look for packages in

Returns:

• array :


◦ int "id"

◦ string "name"





◦ string "arch"

◦ string "epoch"


API Documentation | Chapter 513. Method: advancedWithActKey 586 / 1066

Chapter 514. Method: advancedWithChannelDescription:


Parser syntax, additionally this method will limit results to those which are in the passed in

channel label. Lucene Query Parser syntax is defined at


Parameters:



• string channelLabel - Channel Label

Returns:

• array :


◦ int "id"

◦ string "name"





◦ string "arch"

◦ string "epoch"


API Documentation | Chapter 514. Method: advancedWithChannel 587 / 1066

Chapter 515. Method: nameDescription:

Search the lucene package indexes for all packages which match the given name.

Parameters:


• string name - package name to search for

Returns:

• array :


◦ int "id"

◦ string "name"





◦ string "arch"

◦ string "epoch"


API Documentation | Chapter 515. Method: name 588 / 1066

Chapter 516. Method: nameAndDescriptionDescription:

Search the lucene package indexes for all packages which match the given query in name or

description

Parameters:


• string query - text to match in package name or description

Returns:

• array :


◦ int "id"

◦ string "name"





◦ string "arch"

◦ string "epoch"


API Documentation | Chapter 516. Method: nameAndDescription 589 / 1066

Chapter 517. Method: nameAndSummaryDescription:

Search the lucene package indexes for all packages which match the given query in name or

summary.

Parameters:


• string query - text to match in package name or summary

Returns:

• array :


◦ int "id"

◦ string "name"





◦ string "arch"

◦ string "epoch"


API Documentation | Chapter 517. Method: nameAndSummary 590 / 1066

preferences.locale


Chapter 518. Available methods• listLocales

• listTimeZones

• setLocale

• setTimeZone


Chapter 519. DescriptionProvides methods to access and modify user locale information

Namespace:

preferences.locale


Chapter 520. Method: listLocalesDescription:

Returns a list of all understood locales. Can be used as input to setLocale.

Parameters:

Returns:

• array :

◦ string - Locale code.

API Documentation | Chapter 520. Method: listLocales 594 / 1066

Chapter 521. Method: listTimeZonesDescription:

Returns a list of all understood timezones. Results can be used as input to setTimeZone.

Parameters:

Returns:

• array :

• struct - timezone

◦ int "time_zone_id" - Unique identifier for timezone.

◦ string "olson_name" - Name as identified by the Olson database.

API Documentation | Chapter 521. Method: listTimeZones 595 / 1066

Chapter 522. Method: setLocaleDescription:

Set a user’s locale.

Parameters:


• string login - User’s login name.

• string locale - Locale to set. (from listLocales)

Returns:


API Documentation | Chapter 522. Method: setLocale 596 / 1066

Chapter 523. Method: setTimeZoneDescription:

Set a user’s timezone.

Parameters:



• int tzid - Timezone ID. (from listTimeZones)

Returns:


API Documentation | Chapter 523. Method: setTimeZone 597 / 1066

proxy


Chapter 524. Available methods• activateProxy

• createMonitoringScout

• deactivateProxy

• isProxy

• listAvailableProxyChannels

• listProxies

• listProxyClients


Chapter 525. DescriptionProvides methods to activate/deactivate a proxy server.

Namespace:

proxy


Chapter 526. Method: activateProxyDescription:

Activates the proxy identified by the given client certificate i.e. systemid file.

Parameters:

• string systemid - systemid file

• string version - Version of proxy to be registered.

Returns:


API Documentation | Chapter 526. Method: activateProxy 601 / 1066

Chapter 527. Method: createMonitoringScoutDescription:

Create Monitoring Scout for proxy.

Parameters:


Returns:

• string


API Documentation | Chapter 527. Method: createMonitoringScout 602 / 1066

Chapter 528. Method: deactivateProxyDescription:

Deactivates the proxy identified by the given client certificate i.e. systemid file.

Parameters:


Returns:


API Documentation | Chapter 528. Method: deactivateProxy 603 / 1066

Chapter 529. Method: isProxyDescription:

Test, if the system identified by the given client certificate i.e. systemid file, is proxy.

Parameters:


Returns:


API Documentation | Chapter 529. Method: isProxy 604 / 1066

Chapter 530. Method:listAvailableProxyChannelsDescription:

List available version of proxy channel for system identified by the given client certificate i.e.

systemid file.

Parameters:


Returns:

• array :

◦ string - version


API Documentation | Chapter 530. Method: listAvailableProxyChannels 605 / 1066

Chapter 531. Method: listProxiesDescription:

List the proxies within the user’s organization.

Parameters:


Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"






API Documentation | Chapter 531. Method: listProxies 606 / 1066

Chapter 532. Method: listProxyClientsDescription:

List the clients directly connected to a given Proxy.

Parameters:


• int proxyId

Returns:

• array :

◦ int - clientId

API Documentation | Chapter 532. Method: listProxyClients 607 / 1066

recurringaction



• delete

• listByEntity

• lookupById

• update


Chapter 534. DescriptionProvides methods to handle Recurring Actions for Minions, Groups and Organizations.

Namespace:

recurringaction



Create a new recurring action.

Parameters:


• struct - actionProps

◦ string "entity_type" - The type of the target entity. One of the following:

◦ MINION

◦ GROUP

◦ ORG

◦ int "entity_id" - The id of the target entity

◦ string "name" - The name of the action

◦ string "cron_expr" - The execution frequency of the action

◦ boolean "test" - Whether the action should be executed in test mode (optional)

Returns:

• int id - The id of the recurring action



Delete recurring action with given action id.

Parameters:


• int actionId - Id of the action

Returns:



Chapter 537. Method: listByEntityDescription:

Return a list of recurring actions for a given entity.

Parameters:


• string entityType - Type of the target entity. Can be MINION, GROUP or ORG.

• int entityId - Id of the target entity

Returns:

• array :

• struct - Recurring Action information

◦ int "id"

◦ string "name"

◦ int "entity_id"

◦ string "entity_type"

◦ string "cron_expr"


◦ string "creator"

◦ boolean "test"


API Documentation | Chapter 537. Method: listByEntity 613 / 1066

Chapter 538. Method: lookupByIdDescription:

Return recurring action with given action id.

Parameters:


• int actionId - Id of the action

Returns:

• * struct - Recurring Action information

◦ int "id"

◦ string "name"

◦ int "entity_id"

◦ string "entity_type"

◦ string "cron_expr"


◦ string "creator"

◦ boolean "test"


API Documentation | Chapter 538. Method: lookupById 614 / 1066


Update a recurring action.

Parameters:


• struct - actionProps

◦ int "id" - The id of the action to update

◦ string "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)

Returns:



saltkey


Chapter 540. Available methods• accept

• acceptedList

• delete

• deniedList

• pendingList

• reject

• rejectedList


Chapter 541. DescriptionProvides methods to manage salt keys

Namespace:

saltkey


Chapter 542. Method: acceptDescription:

Accept a minion key

Parameters:

• [. string ]# string # loggedInUser

• [. string ]# string # minionId

Returns:


API Documentation | Chapter 542. Method: accept 619 / 1066

Chapter 543. Method: acceptedListDescription:

List accepted salt keys

Parameters:


Returns:

• array :

◦ [. string ]# string # - Accepted salt key list

API Documentation | Chapter 543. Method: acceptedList 620 / 1066


Delete a minion key

Parameters:



Returns:



Chapter 545. Method: deniedListDescription:

List of denied salt keys

Parameters:


Returns:

• array :

◦ [. string ]# string # - Denied salt key list

API Documentation | Chapter 545. Method: deniedList 622 / 1066

Chapter 546. Method: pendingListDescription:

List pending salt keys

Parameters:


Returns:

• array :

◦ [. string ]# string # - Pending salt key list

API Documentation | Chapter 546. Method: pendingList 623 / 1066

Chapter 547. Method: rejectDescription:

Reject a minion key

Parameters:



Returns:


API Documentation | Chapter 547. Method: reject 624 / 1066

Chapter 548. Method: rejectedListDescription:

List of rejected salt keys

Parameters:


Returns:

• array :

◦ [. string ]# string # - Rejected salt key list

API Documentation | Chapter 548. Method: rejectedList 625 / 1066

schedule


Chapter 549. Available methods• archiveActions

• cancelActions

• deleteActions

• failSystemAction

• failSystemAction

• listAllActions

• listAllArchivedActions

• listAllCompletedActions

• listArchivedActions

• listCompletedActions

• listCompletedSystems

• listFailedActions

• listFailedSystems

• listInProgressActions

• listInProgressSystems

• rescheduleActions


Chapter 550. DescriptionMethods to retrieve information about scheduled actions.

Namespace:

schedule


Chapter 551. Method: archiveActionsDescription:

Archive all actions in the given list.

Parameters:


• array :

◦ int - action id

Returns:


API Documentation | Chapter 551. Method: archiveActions 629 / 1066

Chapter 552. Method: cancelActionsDescription:

Cancel all actions in given list. If an invalid action is provided, none of the actions given will

canceled.

Parameters:


• array :

◦ int - action id

Returns:


API Documentation | Chapter 552. Method: cancelActions 630 / 1066

Chapter 553. Method: deleteActionsDescription:

Delete all archived actions in the given list.

Parameters:


• array :

◦ int - action id

Returns:


API Documentation | Chapter 553. Method: deleteActions 631 / 1066

Chapter 554. Method: failSystemActionDescription:

Fail specific event on specified system

Parameters:


• int serverId

• int actionId

Returns:


API Documentation | Chapter 554. Method: failSystemAction 632 / 1066

Chapter 555. Method: failSystemActionDescription:

Fail specific event on specified system

Parameters:


• int serverId

• int actionId

• string message

Returns:


API Documentation | Chapter 555. Method: failSystemAction 633 / 1066

Chapter 556. Method: listAllActionsDescription:

Returns a list of all actions. This includes completed, in progress, failed and archived actions.

Parameters:


Returns:

• 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 be performed

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

API Documentation | Chapter 556. Method: listAllActions 634 / 1066

Chapter 557. Method: listAllArchivedActionsDescription:

Returns a list of actions that have been archived.

Parameters:


Returns:

• array :

• struct - action










API Documentation | Chapter 557. Method: listAllArchivedActions 635 / 1066

Chapter 558. Method: listAllCompletedActionsDescription:

Returns a list of actions that have been completed.

Parameters:


Returns:

• array :

• struct - action










API Documentation | Chapter 558. Method: listAllCompletedActions 636 / 1066

Chapter 559. Method: listArchivedActionsDescription:

Returns a list of actions that have been archived.

Parameters:


Returns:

• array :

• struct - action










API Documentation | Chapter 559. Method: listArchivedActions 637 / 1066

Chapter 560. Method: listCompletedActionsDescription:

Returns a list of actions that have completed successfully.

Parameters:


Returns:

• array :

• struct - action










API Documentation | Chapter 560. Method: listCompletedActions 638 / 1066

Chapter 561. Method: listCompletedSystemsDescription:

Returns a list of systems that have completed a specific action.

Parameters:


• int actionId

Returns:

• 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 completed

◦ string "message" - Optional message containing details on the execution of the action.

For example, if the action failed, this will contain the failure text.

API Documentation | Chapter 561. Method: listCompletedSystems 639 / 1066

Chapter 562. Method: listFailedActionsDescription:

Returns a list of actions that have failed.

Parameters:


Returns:

• array :

• struct - action










API Documentation | Chapter 562. Method: listFailedActions 640 / 1066

Chapter 563. Method: listFailedSystemsDescription:

Returns a list of systems that have failed a specific action.

Parameters:


• int actionId

Returns:

• array :

• struct - system

◦ int "server_id"






API Documentation | Chapter 563. Method: listFailedSystems 641 / 1066

Chapter 564. Method: listInProgressActionsDescription:

Returns a list of actions that are in progress.

Parameters:


Returns:

• array :

• struct - action










API Documentation | Chapter 564. Method: listInProgressActions 642 / 1066

Chapter 565. Method: listInProgressSystemsDescription:

Returns a list of systems that have a specific action in progress.

Parameters:


• int actionId

Returns:

• array :

• struct - system

◦ int "server_id"






API Documentation | Chapter 565. Method: listInProgressSystems 643 / 1066

Chapter 566. Method: rescheduleActionsDescription:

Reschedule all actions in the given list.

Parameters:


• array :

◦ int - action id

• boolean onlyFailed - True to only reschedule failed actions, False to reschedule all

Returns:


API Documentation | Chapter 566. Method: rescheduleActions 644 / 1066

subscriptionmatching.pinnedsubscription



• delete

• list


Chapter 568. DescriptionProvides the namespace for operations on Pinned Subscriptions

Namespace:

subscriptionmatching.pinnedsubscription



Creates a Pinned Subscription based on given subscription and system

Parameters:


• int subscriptionId - Subscription Id

• int systemId - System Id

Returns:

• * struct - pinned subscription

◦ int "id"

◦ int "subscription_id"

◦ int "system_id"



Deletes Pinned Subscription with given id

Parameters:


• int pinnedSubscriptionId - Pinned Subscription id

Returns:




Lists all PinnedSubscriptions

Parameters:


Returns:

• array :

• struct - pinned subscription

◦ int "id"

◦ int "subscription_id"

◦ int "system_id"


sync.content


Chapter 572. Available methods• addChannel

• addChannels

• addCredentials

• deleteCredentials

• listChannels

• listCredentials

• listProducts

• synchronizeChannelFamilies

• synchronizeChannels

• synchronizeProducts

• synchronizeRepositories

• synchronizeSubscriptions


Chapter 573. DescriptionProvides the namespace for the content synchronization methods.

Namespace:

sync.content


Chapter 574. Method: addChannelDescription:

Add a new channel to the Uyuni database

Parameters:


• string channelLabel - Label of the channel to add

• string mirrorUrl - Sync from mirror temporarily

Returns:


API Documentation | Chapter 574. Method: addChannel 654 / 1066

Chapter 575. Method: addChannelsDescription:

Add a new channel to the Uyuni database

Parameters:


• string channelLabel - Label of the channel to add


Returns:

• array :

◦ string - enabled channel labels

API Documentation | Chapter 575. Method: addChannels 655 / 1066

Chapter 576. Method: addCredentialsDescription:

Add organization credentials (mirror credentials) to Uyuni.

Parameters:


• string username - Organization credentials (Mirror credentials) username

• string password - Organization credentials (Mirror credentials) password

• boolean primary - Make this the primary credentials

Returns:


API Documentation | Chapter 576. Method: addCredentials 656 / 1066

Chapter 577. Method: deleteCredentialsDescription:

Delete organization credentials (mirror credentials) from Uyuni.

Parameters:


• string username - Username of credentials to delete

Returns:


API Documentation | Chapter 577. Method: deleteCredentials 657 / 1066


List all accessible channels.

Parameters:


Returns:

• array :


◦ 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 or installed

◦ string "summary" - Channel summary

◦ string "update_tag" - Update tag

◦ boolean "installer_updates" - is an installer update channel


Chapter 579. Method: listCredentialsDescription:

List organization credentials (mirror credentials) available in Uyuni.

Parameters:


Returns:

• array :

• struct - credentials

◦ int "id" - ID of the credentials

◦ string "user" - username

◦ boolean "isPrimary" - primary

API Documentation | Chapter 579. Method: listCredentials 659 / 1066

Chapter 580. Method: listProductsDescription:

List all accessible products.

Parameters:


Returns:

• array :

• struct - product

◦ string "friendly_name" - Friendly name of the product

◦ string "arch" - Architecture

◦ string "status" - 'available', 'unavailable' or 'installed'

◦ array :














API Documentation | Chapter 580. Method: listProducts 660 / 1066




◦ array :

▪ struct - extension product

▪ string "friendly_name" - Friendly name of extension product

▪ string "arch" - Architecture

▪ string "status" - 'available', 'unavailable' or 'installed'

▪ array :

















◦ boolean "recommended" - Recommended

API Documentation | Chapter 580. Method: listProducts 661 / 1066

Chapter 581. Method:synchronizeChannelFamiliesDescription:

Synchronize channel families between the Customer Center and the Uyuni database.

Parameters:


Returns:


API Documentation | Chapter 581. Method: synchronizeChannelFamilies 662 / 1066

Chapter 582. Method: synchronizeChannelsDescription:

(Deprecated) Synchronize channels between the Customer Center and the Uyuni database.

Parameters:



Returns:


API Documentation | Chapter 582. Method: synchronizeChannels 663 / 1066

Chapter 583. Method: synchronizeProductsDescription:

Synchronize SUSE products between the Customer Center and the Uyuni database.

Parameters:


Returns:


API Documentation | Chapter 583. Method: synchronizeProducts 664 / 1066

Chapter 584. Method: synchronizeRepositoriesDescription:

Synchronize repositories between the Customer Center and the Uyuni database.

Parameters:


• string mirrorUrl - Optional mirror url or null

Returns:


API Documentation | Chapter 584. Method: synchronizeRepositories 665 / 1066

Chapter 585. Method:synchronizeSubscriptionsDescription:

Synchronize subscriptions between the Customer Center and the Uyuni database.

Parameters:


Returns:


API Documentation | Chapter 585. Method: synchronizeSubscriptions 666 / 1066

sync.master


Chapter 586. Available methods• addToMaster

• create

• delete

• getDefaultMaster

• getMaster

• getMasterByLabel

• getMasterOrgs

• getMasters

• hasMaster

• makeDefault

• mapToLocal

• setCaCert

• setMasterOrgs

• unsetDefaultMaster

• update


Chapter 587. DescriptionContains methods to set up information about known-"masters", for use on the "slave" side of ISS

Namespace:

sync.master


Chapter 588. Method: addToMasterDescription:

Add a single organizations to the list of those the specified Master has exported to this Slave

Parameters:


• int id - Id of the desired Master

• struct - master-org details

◦ int "masterOrgId"

◦ string "masterOrgName"

◦ int "localOrgId"

Returns:


API Documentation | Chapter 588. Method: addToMaster 670 / 1066


Create a new Master, known to this Slave.

Parameters:


• string label - Master’s fully-qualified domain name

Returns:

• * struct - IssMaster info

◦ int "id"

◦ string "label"

◦ string "caCert"

◦ boolean "isCurrentMaster"



Remove the specified Master

Parameters:


• int id - Id of the Master to remove

Returns:



Chapter 591. Method: getDefaultMasterDescription:

Return the current default-Master for this Slave

Parameters:


Returns:


◦ int "id"

◦ string "label"

◦ string "caCert"


API Documentation | Chapter 591. Method: getDefaultMaster 673 / 1066

Chapter 592. Method: getMasterDescription:

Find a Master by specifying its ID

Parameters:



Returns:


◦ int "id"

◦ string "label"

◦ string "caCert"


API Documentation | Chapter 592. Method: getMaster 674 / 1066

Chapter 593. Method: getMasterByLabelDescription:

Find a Master by specifying its label

Parameters:


• string label - Label of the desired Master

Returns:


◦ int "id"

◦ string "label"

◦ string "caCert"


API Documentation | Chapter 593. Method: getMasterByLabel 675 / 1066

Chapter 594. Method: getMasterOrgsDescription:

List all organizations the specified Master has exported to this Slave

Parameters:



Returns:

• array :

• struct - IssMasterOrg info

◦ int "masterOrgId"

◦ string "masterOrgName"

◦ int "localOrgId"

API Documentation | Chapter 594. Method: getMasterOrgs 676 / 1066

Chapter 595. Method: getMastersDescription:

Get all the Masters this Slave knows about

Parameters:


Returns:

• array :

• struct - IssMaster info

◦ int "id"

◦ string "label"

◦ string "caCert"


API Documentation | Chapter 595. Method: getMasters 677 / 1066

Chapter 596. Method: hasMasterDescription:

Check if this host is reading configuration from an ISS master.

Parameters:

Returns:

• boolean master - True if has an ISS master, false otherwise

API Documentation | Chapter 596. Method: hasMaster 678 / 1066

Chapter 597. Method: makeDefaultDescription:

Make the specified Master the default for this Slave’s inter-server-sync

Parameters:


• int id - Id of the Master to make the default

Returns:


API Documentation | Chapter 597. Method: makeDefault 679 / 1066

Chapter 598. Method: mapToLocalDescription:

Add a single organizations to the list of those the specified Master has exported to this Slave

Parameters:


• int masterId - Id of the desired Master

• int masterOrgId - Id of the desired Master

• int localOrgId - Id of the desired Master

Returns:


API Documentation | Chapter 598. Method: mapToLocal 680 / 1066

Chapter 599. Method: setCaCertDescription:

Set the CA-CERT filename for specified Master on this Slave

Parameters:


• int id - Id of the Master to affect

• string caCertFilename - path to specified Master’s CA cert

Returns:


API Documentation | Chapter 599. Method: setCaCert 681 / 1066

Chapter 600. Method: setMasterOrgsDescription:

Reset all organizations the specified Master has exported to this Slave

Parameters:



• array :

◦ struct - master-org details

▪ int "masterOrgId"

▪ string "masterOrgName"

▪ int "localOrgId"

Returns:


API Documentation | Chapter 600. Method: setMasterOrgs 682 / 1066

Chapter 601. Method: unsetDefaultMasterDescription:

Make this slave have no default Master for inter-server-sync

Parameters:


Returns:


API Documentation | Chapter 601. Method: unsetDefaultMaster 683 / 1066


Updates the label of the specified Master

Parameters:


• int id - Id of the Master to update

• string label - Desired new label

Returns:


◦ int "id"

◦ string "label"

◦ string "caCert"



sync.slave



• delete

• getAllowedOrgs

• getSlave

• getSlaveByName

• getSlaves

• setAllowedOrgs

• update


Chapter 604. DescriptionContains methods to set up information about allowed-"slaves", for use on the "master" side of

ISS

Namespace:

sync.slave



Create a new Slave, known to this Master.

Parameters:


• string slave - Slave’s fully-qualified domain name

• boolean enabled - Let this slave talk to us?

• boolean allowAllOrgs - Export all our orgs to this slave?

Returns:

• * struct - IssSlave info

◦ int "id"

◦ string "slave"


◦ boolean "allowAllOrgs"



Remove the specified Slave

Parameters:


• int id - Id of the Slave to remove

Returns:



Chapter 607. Method: getAllowedOrgsDescription:

Get all orgs this Master is willing to export to the specified Slave

Parameters:


• int id - Id of the desired Slave

Returns:

• array :

◦ int - ids of allowed organizations

API Documentation | Chapter 607. Method: getAllowedOrgs 690 / 1066

Chapter 608. Method: getSlaveDescription:

Find a Slave by specifying its ID

Parameters:



Returns:


◦ int "id"

◦ string "slave"



API Documentation | Chapter 608. Method: getSlave 691 / 1066

Chapter 609. Method: getSlaveByNameDescription:

Find a Slave by specifying its Fully-Qualified Domain Name

Parameters:


• string fqdn - Domain-name of the desired Slave

Returns:


◦ int "id"

◦ string "slave"



API Documentation | Chapter 609. Method: getSlaveByName 692 / 1066

Chapter 610. Method: getSlavesDescription:

Get all the Slaves this Master knows about

Parameters:


Returns:

• array :

• struct - IssSlave info

◦ int "id"

◦ string "slave"



API Documentation | Chapter 610. Method: getSlaves 693 / 1066

Chapter 611. Method: setAllowedOrgsDescription:

Set the orgs this Master is willing to export to the specified Slave

Parameters:



• array :

◦ int - List of org-ids we’re willing to export

Returns:


API Documentation | Chapter 611. Method: setAllowedOrgs 694 / 1066


Updates attributes of the specified Slave

Parameters:


• int id - Id of the Slave to update

• string slave - Slave’s fully-qualified domain name

• boolean enabled - Let this slave talk to us?

• boolean allowAllOrgs - Export all our orgs to this Slave?

Returns:


◦ int "id"

◦ string "slave"




system


Chapter 613. Available methods• addEntitlements

• addNote

• bootstrap

• bootstrap

• bootstrap

• bootstrap

• bootstrapWithPrivateSshKey




• changeProxy

• comparePackageProfile

• comparePackages

• createPackageProfile

• createSystemProfile

• createSystemRecord

• createSystemRecord

• deleteCustomValues

• deleteGuestProfiles

• deleteNote

• deleteNotes

• deletePackageProfile

• deleteSystem

• deleteSystem

• deleteSystem


• deleteSystems

• deleteSystems

• deleteTagFromSnapshot

• downloadSystemId

• getConnectionPath

• getCpu

• getCustomValues

• getDetails

• getDevices

• getDmi

• getEntitlements

• getEventDetails

• getEventHistory

• getEventHistory

• getEventHistory

• getEventHistory

• getId

• getInstalledProducts

• getKernelLivePatch

• getMemory

• getMinionIdMap

• getName

• getNetwork

• getNetworkDevices

• getNetworkForSystems

• getOsaPing


• getRegistrationDate

• getRelevantErrata

• getRelevantErrataByType

• getRunningKernel

• getScriptActionDetails

• getScriptResults

• getSubscribedBaseChannel

• getSystemCurrencyMultipliers

• getSystemCurrencyScores

• getUnscheduledErrata

• getUuid

• getVariables

• isNvreInstalled

• isNvreInstalled

• listActivationKeys

• listActiveSystems

• listActiveSystemsDetails

• listAdministrators

• listAllInstallablePackages

• listDuplicatesByHostname

• listDuplicatesByIp

• listDuplicatesByMac

• listEmptySystemProfiles

• listExtraPackages

• listFqdns

• listGroups


• listInactiveSystems

• listInactiveSystems

• listInstalledPackages

• listLatestAvailablePackage

• listLatestInstallablePackages

• listLatestUpgradablePackages

• listMigrationTargets

• listNewerInstalledPackages

• listNotes

• listOlderInstalledPackages

• listOutOfDateSystems

• listPackageProfiles

• listPackageState

• listPackages

• listPackagesFromChannel

• listPackagesLockStatus

• listPhysicalSystems

• listSubscribableBaseChannels

• listSubscribableChildChannels

• listSubscribedChildChannels

• listSuggestedReboot

• listSystemEvents




• listSystemGroupsForSystemsWithEntitlement


• listSystems

• listSystemsWithEntitlement

• listSystemsWithExtraPackages

• listSystemsWithPackage

• listSystemsWithPackage

• listUngroupedSystems

• listUserSystems

• listUserSystems

• listVirtualGuests

• listVirtualHosts

• obtainReactivationKey

• obtainReactivationKey

• provisionSystem

• provisionSystem

• provisionVirtualGuest



• refreshPillar

• refreshPillar

• removeEntitlements

• scheduleApplyErrata











• scheduleApplyHighstate

• scheduleApplyHighstate

• scheduleApplyStates

• scheduleApplyStates

• scheduleCertificateUpdate

• scheduleCertificateUpdate

• scheduleChangeChannels

• scheduleChangeChannels

• scheduleDistUpgrade

• scheduleDistUpgrade

• scheduleGuestAction

• scheduleGuestAction

• scheduleHardwareRefresh

• schedulePackageInstall




• schedulePackageInstallByNevra




• schedulePackageLockChange


• schedulePackageRefresh

• schedulePackageRemove




• schedulePackageRemoveByNevra




• scheduleProductMigration




• scheduleReboot

• scheduleSPMigration




• scheduleScriptRun




• scheduleSyncPackagesWithSystem

• searchByName

• sendOsaPing

• setBaseChannel


• setBaseChannel

• setChildChannels

• setCustomValues

• setDetails

• setGroupMembership

• setGuestCpus

• setGuestMemory

• setLockStatus

• setPrimaryFqdn

• setPrimaryInterface

• setProfileName

• setVariables

• tagLatestSnapshot

• unentitle

• updatePackageState

• upgradeEntitlement

• whoRegistered


Chapter 614. DescriptionProvides methods to access and modify registered system.

Namespace:

system


Chapter 615. Method: addEntitlementsDescription:

Add entitlements to a server. Entitlements a server already has are quietly ignored.

Parameters:


• int serverId

• array :

◦ string - entitlementLabel - one of following: virtualization_host, enterprise_entitled

Returns:


API Documentation | Chapter 615. Method: addEntitlements 706 / 1066

Chapter 616. Method: addNoteDescription:

Add a new note to the given server.

Parameters:


• int serverId

• string subject - What the note is about.

• string body - Content of the note.

Returns:


API Documentation | Chapter 616. Method: addNote 707 / 1066

Chapter 617. Method: bootstrapDescription:

Bootstrap a system for management via either Salt or Salt SSH.

Parameters:


• string host - Hostname or IP address of target

• int sshPort - SSH port on target machine

• string sshUser - SSH user on target machine

• string sshPassword - SSH password of given user

• string activationKey - Activation key

• boolean saltSSH - Manage system with Salt SSH

Returns:


API Documentation | Chapter 617. Method: bootstrap 708 / 1066



Parameters:







• int proxyId - System ID of proxy to use


Returns:





Parameters:







• string reactivationKey - Reactivation key


Returns:





Parameters:










Returns:



Chapter 621. Method:bootstrapWithPrivateSshKeyDescription:

Bootstrap a system for management via either Salt or Salt SSH. Use SSH private key for

authentication.

Parameters:





• string sshPrivKey - SSH private key as a string in PEM format

• string sshPrivKeyPass - SSH passphrase for the key (use empty string for no passphrase)



Returns:


API Documentation | Chapter 621. Method: bootstrapWithPrivateSshKey 712 / 1066



authentication.

Parameters:










Returns:





authentication.

Parameters:











Returns:



Chapter 625. Method: changeProxyDescription:

Connect given systems to another proxy.

Parameters:


• array :

◦ int - systemIds

• int proxyId

Returns:

• array :

◦ int - actionIds

API Documentation | Chapter 625. Method: changeProxy 716 / 1066

Chapter 626. Method: comparePackageProfileDescription:

Compare a system’s packages against a package profile. In the result returned, 'this_system'

represents the server provided as an input and 'other_system' represents the profile provided as

an input.

Parameters:


• int serverId


Returns:

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

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

API Documentation | Chapter 626. Method: comparePackageProfile 717 / 1066

Chapter 627. Method: comparePackagesDescription:

Compares the packages installed on two systems.

Parameters:


• int thisServerId

• int otherServerId

Returns:

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

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

API Documentation | Chapter 627. Method: comparePackages 718 / 1066

Chapter 628. Method: createPackageProfileDescription:

Create a new stored Package Profile from a systems installed package list.

Parameters:


• int serverId



Returns:


API Documentation | Chapter 628. Method: createPackageProfile 719 / 1066

Chapter 629. Method: createSystemProfileDescription:

Creates a system record in database for a system that is not registered. Either "hwAddress" or

"hostname" prop must be specified in the "data" struct. If a system(s) matching given data exists,

a SystemsExistFaultException is thrown which contains matching system IDs in its message.

Parameters:


• string systemName - System name

• struct - data

◦ string "hwAddress" - The HW address of the network interface (MAC)

◦ string "hostname" - The hostname of the profile

Returns:

• int systemId - The id of the created system

API Documentation | Chapter 629. Method: createSystemProfile 720 / 1066

Chapter 630. Method: createSystemRecordDescription:

Creates a cobbler system record with the specified kickstart label

Parameters:


• int serverId

• string ksLabel

Returns:


API Documentation | Chapter 630. Method: createSystemRecord 721 / 1066

Chapter 631. Method: createSystemRecordDescription:

Creates a cobbler system record for a system that is not registered.

Parameters:


• string sysName

• string ksLabel

• string kOptions

• string comment

• array :

◦ struct - network device

▪ string "name"

▪ string "mac"

▪ string "ip"

▪ string "dnsname"

Returns:


API Documentation | Chapter 631. Method: createSystemRecord 722 / 1066

Chapter 632. Method: deleteCustomValuesDescription:

Delete the custom values defined for the custom system information keys provided from the

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 throw exception.)

Parameters:


• int serverId

• array :

◦ string - customInfoLabel

Returns:


API Documentation | Chapter 632. Method: deleteCustomValues 723 / 1066

Chapter 633. Method: deleteGuestProfilesDescription:

Delete the specified list of guest profiles for a given host

Parameters:


• int hostId

• array :

◦ string - guestNames

Returns:


API Documentation | Chapter 633. Method: deleteGuestProfiles 724 / 1066

Chapter 634. Method: deleteNoteDescription:

Deletes the given note from the server.

Parameters:


• int serverId

• int noteId

Returns:


API Documentation | Chapter 634. Method: deleteNote 725 / 1066

Chapter 635. Method: deleteNotesDescription:

Deletes all notes from the server.

Parameters:


• int serverId

Returns:


API Documentation | Chapter 635. Method: deleteNotes 726 / 1066

Chapter 636. Method: deletePackageProfileDescription:

Delete a package profile

Parameters:


• int profileId

Returns:


API Documentation | Chapter 636. Method: deletePackageProfile 727 / 1066

Chapter 637. Method: deleteSystemDescription:

Delete a system given its client certificate.

Parameters:


Returns:



API Documentation | Chapter 637. Method: deleteSystem 728 / 1066


Delete a system given its server id synchronously without cleanup

Parameters:


• int serverId

Returns:




Delete a system given its server id synchronously

Parameters:


• int serverId

• string cleanupType - Possible values: 'FAIL_ON_CLEANUP_ERR' - fail in case of cleanup error,

'NO_CLEANUP' - do not cleanup, just delete, 'FORCE_DELETE' - Try cleanup first but delete

server anyway in case of error

Returns:



Chapter 640. Method: deleteSystemsDescription:

Delete systems given a list of system ids asynchronously.

Parameters:


• array :

◦ int - serverId

Returns:


API Documentation | Chapter 640. Method: deleteSystems 731 / 1066

Chapter 641. Method: deleteSystemsDescription:

Delete systems given a list of system ids asynchronously.

Parameters:


• array :

◦ int - serverId

• string cleanupType - Possible values: 'FAIL_ON_CLEANUP_ERR' - fail in case of cleanup error,

'NO_CLEANUP' - do not cleanup, just delete, 'FORCE_DELETE' - Try cleanup first but delete

server anyway in case of error

Returns:


API Documentation | Chapter 641. Method: deleteSystems 732 / 1066

Chapter 642. Method:deleteTagFromSnapshotDescription:

Deletes tag from system snapshot

Parameters:


• int serverId

• string tagName

Returns:


API Documentation | Chapter 642. Method: deleteTagFromSnapshot 733 / 1066

Chapter 643. Method: downloadSystemIdDescription:

Get the system ID file for a given server.

Parameters:


• int serverId

Returns:

• string id

API Documentation | Chapter 643. Method: downloadSystemId 734 / 1066

Chapter 644. Method: getConnectionPathDescription:

Get the list of proxies that the given system connects through in order to reach the server.

Parameters:


• int serverId

Returns:

• array :

• struct - proxy connection path details

◦ int "position" - Position of proxy in chain. The proxy that the system connects directly to is

listed in position 1.

◦ int "id" - Proxy system id

◦ string "hostname" - Proxy host name

API Documentation | Chapter 644. Method: getConnectionPath 735 / 1066

Chapter 645. Method: getCpuDescription:

Gets the CPU information of a system.

Parameters:


• int serverId

Returns:

• * struct - CPU

◦ string "cache"

◦ string "family"

◦ string "mhz"

◦ string "flags"

◦ string "model"

◦ string "vendor"

◦ string "arch"

◦ string "stepping"

◦ string "count"

◦ int "socket_count (if available)"

API Documentation | Chapter 645. Method: getCpu 736 / 1066


Get the custom data values defined for the server.

Parameters:


• int serverId

Returns:

• struct - custom value




Get system details.

Parameters:


• int serverId

Returns:

• * struct - server details

◦ int "id" - System id

◦ string "profile_name"

◦ string "machine_id"


◦ string "base_entitlement" - System’s base entitlement label

◦ 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, 5Server

◦ string "address1"


◦ string "city"

◦ string "state"

◦ string "country"

◦ string "building"

◦ string "room"

◦ string "rack"



◦ string "hostname"

◦ dateTime.iso8601 "last_boot"

◦ string "osa_status" - Either 'unknown', 'offline', or 'online'.

◦ boolean "lock_status" - True indicates that the system is locked. False indicates that the

system is unlocked.

◦ string "virtualization" - Virtualization type - for virtual guests only (optional)


◦ default

◦ ssh-push

◦ ssh-push-tunnel


Chapter 648. Method: getDevicesDescription:

Gets a list of devices for a system.

Parameters:


• int serverId

Returns:

• array :

• struct - device

◦ string "device" - optional

◦ string "device_class" - Includes CDROM, FIREWIRE, HD, USB, VIDEO, OTHER, etc.

◦ string "driver"


◦ string "bus"

◦ string "pcitype"

API Documentation | Chapter 648. Method: getDevices 740 / 1066

Chapter 649. Method: getDmiDescription:

Gets the DMI information of a system.

Parameters:


• int serverId

Returns:

• * struct - DMI

◦ string "vendor"

◦ string "system"


◦ string "asset"

◦ string "board"

◦ string "bios_release" - (optional)

◦ string "bios_vendor" - (optional)

◦ string "bios_version" - (optional)

API Documentation | Chapter 649. Method: getDmi 741 / 1066

Chapter 650. Method: getEntitlementsDescription:

Gets the entitlements for a given server.

Parameters:


• int serverId

Returns:

• array :

◦ string - entitlement_label

API Documentation | Chapter 650. Method: getEntitlements 742 / 1066

Chapter 651. Method: getEventDetailsDescription:

Returns the details of the event associated with the specified server and event. The event id must

be a value returned by the system.getEventHistory API.

Parameters:


• int serverId

• int eventId

Returns:

• array :

• struct - System Event

◦ int "id" - Identifier of the event

◦ string "history_type" - Type of history event

◦ string "status" - Status of the event

◦ string "summary" - Summary of the event

◦ dateTime.iso8601 "created" - Date that the event was created

◦ dateTime.iso8601 "picked_up" - Date that the event was picked up

◦ dateTime.iso8601 "completed" - Date that the event occurred

◦ dateTime.iso8601 "earliest_action" - Earliest date this action could occur.

◦ string "result_msg" - The result string of the action executed on the client machine.

(optional)

◦ int "result_code" - The result code of the action executed on the client machine.

(optional).

◦ array "additional_info" - This array contains additional information for the event, if

available.

◦ struct - info

▪ string "detail" - The detail provided depends on the specific event. For example, for a

API Documentation | Chapter 651. Method: getEventDetails 743 / 1066

package event, this will be the package name, for an errata event, this will be the

advisory name and synopsis, for a config file event, this will be path and optional

revision information…etc.

▪ string "result" - The result (if included) depends on the specific event. For example,

for a package or errata event, no result is included, for a config file event, the result

might include an error (if one occurred, such as the file was missing) or in the case

of a config file comparison it might include the differences found.

API Documentation | Chapter 651. Method: getEventDetails 744 / 1066

Chapter 652. Method: getEventHistory(Deprecated)Description:

Returns a list history items associated with the system, ordered from newest to oldest. Note that

the details may be empty for events that were scheduled against the system (as compared to

instant). For more information on such events, see the system.listSystemEvents operation. Note:

This version of the method is deprecated and the return value will be changed in a future API

version. Please one of the other overloaded versions of getEventHistory.

Deprecated - This version of the method is deprecated and the return value will be changed in a

future API version. Please one of the other overloaded versions of getEventHistory.

Parameters:


• int serverId

Returns:

• array :

• struct - History Event

◦ dateTime.iso8601 "completed" - Date that the event occurred (optional)


◦ string "details" - Details of the event

API Documentation | Chapter 652. Method: getEventHistory (Deprecated) 745 / 1066

Chapter 653. Method: getEventHistoryDescription:

Returns a list of history items associated with the system happened after the specified date. The

list is paged and ordered from newest to oldest.

Parameters:


• int serverId

• dateTime.iso8601 earliestDate

• int offset - Number of results to skip

• int limit - Maximum number of results

Returns:

• array :







API Documentation | Chapter 653. Method: getEventHistory 746 / 1066


Returns a list of history items associated with the system. The list is paged and ordered from

newest to oldest.

Parameters:


• int serverId

• int offset - Number of results to skip

• int limit - Maximum number of results

Returns:

• array :









Returns a list of history items associated with the system happened after the specified date. The

list is ordered from newest to oldest.

Parameters:


• int serverId


Returns:

• array :








Chapter 656. Method: getIdDescription:

Get system IDs and last check in information for the given system name.

Parameters:


• string systemName

Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"






API Documentation | Chapter 656. Method: getId 749 / 1066

Chapter 657. Method: getInstalledProductsDescription:

Get a list of installed products for given system

Parameters:

• User loggedInUser

• int serverId

Returns:

• array :

• struct - installed product

◦ string "name"

◦ boolean "isBaseProduct"

◦ string "version" - returned only if applies

◦ string "arch" - returned only if applies

◦ string "release" - returned only if applies

◦ string "friendlyName" - returned only if available

API Documentation | Chapter 657. Method: getInstalledProducts 750 / 1066

Chapter 658. Method: getKernelLivePatchDescription:

Returns the currently active kernel live patching version relative to the running kernel version of

the system, or empty string if live patching feature is not in use for the given system.

Parameters:


• int serverId

Returns:

• string

API Documentation | Chapter 658. Method: getKernelLivePatch 751 / 1066

Chapter 659. Method: getMemoryDescription:

Gets the memory information for a system.

Parameters:


• int serverId

Returns:

• struct - memory

◦ int "ram" - The amount of physical memory in MB.

◦ int "swap" - The amount of swap space in MB.

API Documentation | Chapter 659. Method: getMemory 752 / 1066

Chapter 660. Method: getMinionIdMapDescription:

Return a map from Salt minion IDs to System IDs. Map entries are limited to systems that are

visible by the current user.

Parameters:


Returns:

• map id_map - minion IDs to system IDs

API Documentation | Chapter 660. Method: getMinionIdMap 753 / 1066

Chapter 661. Method: getNameDescription:

Get system name and last check in information for the given system ID.

Parameters:


• string serverId

Returns:

• struct - name info

◦ int "id" - Server id

◦ string "name" - Server name


API Documentation | Chapter 661. Method: getName 754 / 1066

Chapter 662. Method: getNetworkDescription:

Get the addresses and hostname for a given server.

Parameters:


• int serverId

Returns:

• struct - network info

◦ string "ip" - IPv4 address of server

◦ string "ip6" - IPv6 address of server

◦ string "hostname" - Hostname of server

API Documentation | Chapter 662. Method: getNetwork 755 / 1066

Chapter 663. Method: getNetworkDevicesDescription:

Returns the network devices for the given server.

Parameters:


• int serverId

Returns:

• array :

• 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

◦ 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 :



API Documentation | Chapter 663. Method: getNetworkDevices 756 / 1066


▪ string "broadcast" - IPv4 broadcast address of this network device

API Documentation | Chapter 663. Method: getNetworkDevices 757 / 1066

Chapter 664. Method: getNetworkForSystemsDescription:

Get the addresses and hostname for a given list of systems.

Parameters:


• array :

◦ int - systemIDs

Returns:

• array :

◦ struct - network info

▪ int "system_id" - ID of the system

▪ string "ip" - IPv4 address of system

▪ string "ip6" - IPv6 address of system

▪ string "hostname" - Hostname of system

▪ string "primary_fqdn" - Primary FQDN of system

API Documentation | Chapter 664. Method: getNetworkForSystems 758 / 1066

Chapter 665. Method: getOsaPingDescription:

get details about a ping sent to a system using OSA

Parameters:

• User loggedInUser

• int serverId

Returns:

• struct - osaPing

◦ string "state" - state of the system (unknown, online, offline)

◦ 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/01 00:00:00 if no

ping is pending

API Documentation | Chapter 665. Method: getOsaPing 759 / 1066

Chapter 666. Method: getRegistrationDateDescription:

Returns the date the system was registered.

Parameters:


• int serverId

Returns:

• dateTime.iso8601 date - The date the system was registered, in local time

API Documentation | Chapter 666. Method: getRegistrationDate 760 / 1066

Chapter 667. Method: getRelevantErrataDescription:

Returns a list of all errata that are relevant to the system.

Parameters:


• int serverId

Returns:

• array :

• struct - errata









API Documentation | Chapter 667. Method: getRelevantErrata 761 / 1066

Chapter 668. Method:getRelevantErrataByTypeDescription:

Returns a list of all errata of the specified type that are relevant to the system.

Parameters:


• int serverId

• string advisoryType - type of advisory (one of of the following: 'Security Advisory', 'Product

Enhancement Advisory', 'Bug Fix Advisory'

Returns:

• array :

• struct - errata









API Documentation | Chapter 668. Method: getRelevantErrataByType 762 / 1066

Chapter 669. Method: getRunningKernelDescription:

Returns the running kernel of the given system.

Parameters:


• int serverId

Returns:

• string kernel

API Documentation | Chapter 669. Method: getRunningKernel 763 / 1066

Chapter 670. Method: getScriptActionDetailsDescription:

Returns script details for script run actions

Parameters:


• int actionId - ID of the script run action.

Returns:

• struct - Script details

◦ int "id" - action id

◦ string "content" - script content

◦ string "run_as_user" - Run as user

◦ string "run_as_group" - Run as group

◦ int "timeout" - Timeout in seconds

◦ 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 the output_enc64

attribute)

◦ boolean "output_enc64" - Identifies base64 encoded output

API Documentation | Chapter 670. Method: getScriptActionDetails 764 / 1066

Chapter 671. Method: getScriptResultsDescription:

Fetch results from a script execution. Returns an empty array if no results are yet available.

Parameters:


• int actionId - ID of the script run action.

Returns:

• 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 the output_enc64

attribute)

◦ boolean "output_enc64" - Identifies base64 encoded output

API Documentation | Chapter 671. Method: getScriptResults 765 / 1066

Chapter 672. Method:getSubscribedBaseChannelDescription:

Provides the base channel of a given system

Parameters:


• int serverId

Returns:


◦ int "id"

◦ string "name"

◦ string "label"














API Documentation | Chapter 672. Method: getSubscribedBaseChannel 766 / 1066





◦ array :


▪ int "id"

▪ string "label"


▪ string "type"

API Documentation | Chapter 672. Method: getSubscribedBaseChannel 767 / 1066

Chapter 673. Method:getSystemCurrencyMultipliersDescription:

Get the System Currency score multipliers

Parameters:


Returns:

• map multipliers - Map of score multipliers

API Documentation | Chapter 673. Method: getSystemCurrencyMultipliers 768 / 1066

Chapter 674. Method:getSystemCurrencyScoresDescription:

Get the System Currency scores for all servers the user has access to

Parameters:


Returns:

• 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 fix errata count"

▪ int "enhancement errata count"

▪ int "system currency score"

API Documentation | Chapter 674. Method: getSystemCurrencyScores 769 / 1066

Chapter 675. Method: getUnscheduledErrataDescription:

Provides an array of errata that are applicable to a given system.

Parameters:


• int serverId

Returns:

• array :

• struct - errata







API Documentation | Chapter 675. Method: getUnscheduledErrata 770 / 1066

Chapter 676. Method: getUuidDescription:

Get the UUID from the given system ID.

Parameters:


• int serverId

Returns:

• string uuid

API Documentation | Chapter 676. Method: getUuid 771 / 1066

Chapter 677. Method: getVariablesDescription:

Lists kickstart variables set in the system record for the specified server. Note: This call assumes

that a system record exists in cobbler for the given system and will raise an XMLRPC fault if that is

not the case. To create a system record over xmlrpc use system.createSystemRecord

To create a system record in the Web UI please go toSystem -> <Specified System> -> Provisioning ->Select a Kickstart profile -> Create Cobbler System Record.

Parameters:


• int serverId

Returns:

• struct - System kickstart variables

◦ boolean "netboot" - netboot enabled

◦ array "kickstart variables"

▪ struct - kickstart variable

▪ string "key"

▪ string or int "value"

API Documentation | Chapter 677. Method: getVariables 772 / 1066

Chapter 678. Method: isNvreInstalledDescription:

Check if the package with the given NVRE is installed on given system.

Parameters:


• int serverId

• string name - Package name.

• string version - Package version.

• string release - Package release.

Returns:

• int status - 1 if package exists, 0 if not, exception is thrown if an error occurs

API Documentation | Chapter 678. Method: isNvreInstalled 773 / 1066

Chapter 679. Method: isNvreInstalledDescription:

Is the package with the given NVRE installed on given system.

Parameters:


• int serverId




• string epoch - Package epoch.

Returns:

• int status - 1 if package exists, 0 if not, exception is thrown if an error occurs

API Documentation | Chapter 679. Method: isNvreInstalled 774 / 1066

Chapter 680. Method: listActivationKeysDescription:

List the activation keys the system was registered with. An empty list will be returned if an

activation key was not used during registration.

Parameters:


• int serverId

Returns:

• array :

◦ string - key


Chapter 681. Method: listActiveSystemsDescription:

Returns a list of active servers visible to the user.

Parameters:


Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"




API Documentation | Chapter 681. Method: listActiveSystems 776 / 1066

Chapter 682. Method: listActiveSystemsDetailsDescription:

Given a list of server ids, returns a list of active servers' details visible to the user.

Parameters:


• array :

◦ int - serverIds

Returns:

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


API Documentation | Chapter 682. Method: listActiveSystemsDetails 777 / 1066

◦ array :




▪ string "scope" - IPv6 address scope


◦ array :




▪ string "broadcast" - IPv4 broadcast address of this network device

▪ struct "dmi_info" - The server’s dmi info

• struct - DMI

◦ string "vendor"

◦ string "system"


◦ 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 "flags"

◦ string "model"


◦ string "vendor"

◦ string "arch"

◦ string "stepping"

◦ 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 active guests

▪ array :

▪ int "guest_id" - The guest’s system id.


Chapter 683. Method: listAdministratorsDescription:

Returns a list of users which can administer the system.

Parameters:


• int serverId

Returns:

• array :

• struct - user

◦ int "id"

◦ string "login"

◦ string "login_uc" - upper case version of the login

◦ boolean "enabled" - true if user is enabled, false if the user is disabled

API Documentation | Chapter 683. Method: listAdministrators 780 / 1066

Chapter 684. Method:listAllInstallablePackagesDescription:

Get the list of all installable packages for a given system.

Parameters:


• int serverId

Returns:

• array :


▪ string "name"



▪ string "epoch"

▪ int "id"


API Documentation | Chapter 684. Method: listAllInstallablePackages 781 / 1066

Chapter 685. Method:listDuplicatesByHostnameDescription:

List duplicate systems by Hostname.

Parameters:


Returns:

• array :

◦ struct - Duplicate Group

▪ string "hostname"

▪ array "systems"

• struct - system

◦ int "systemId"

◦ string "systemName"


API Documentation | Chapter 685. Method: listDuplicatesByHostname 782 / 1066

Chapter 686. Method: listDuplicatesByIpDescription:

List duplicate systems by IP Address.

Parameters:


Returns:

• array :


▪ string "ip"

▪ array "systems"

• struct - system

◦ int "systemId"



API Documentation | Chapter 686. Method: listDuplicatesByIp 783 / 1066

Chapter 687. Method: listDuplicatesByMacDescription:

List duplicate systems by Mac Address.

Parameters:


Returns:

• array :


▪ string "mac"

▪ array "systems"

• struct - system

◦ int "systemId"



API Documentation | Chapter 687. Method: listDuplicatesByMac 784 / 1066

Chapter 688. Method: listEmptySystemProfilesDescription:

Returns a list of empty system profiles visible to user (created by the createSystemProfile

method).

Parameters:


Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"

◦ dateTime.iso8601 "created" - Server creation time

◦ array "hw_addresses" - HW addresses

◦ array :

▪ string - HW address

API Documentation | Chapter 688. Method: listEmptySystemProfiles 785 / 1066

Chapter 689. Method: listExtraPackagesDescription:

List extra packages for a system

Parameters:


• int serverId

Returns:

• array :


▪ string "name"



▪ string "epoch" - returned only if non-zero

▪ string "arch"

▪ date "installtime" - returned only if known

API Documentation | Chapter 689. Method: listExtraPackages 786 / 1066

Chapter 690. Method: listFqdnsDescription:

Provides a list of FQDNs associated with a system.

Parameters:


• int serverId

Returns:

• array :

◦ string - fqdn

API Documentation | Chapter 690. Method: listFqdns 787 / 1066

Chapter 691. Method: listGroupsDescription:

List the available groups for a given system.

Parameters:


• int serverId

Returns:

• array :

◦ struct - system group

▪ int "id" - server group id

▪ int "subscribed" - 1 if the given server is subscribed to this server group, 0 otherwise

▪ string "system_group_name" - Name of the server group

▪ string "sgid" - server group id (Deprecated)

API Documentation | Chapter 691. Method: listGroups 788 / 1066

Chapter 692. Method: listInactiveSystemsDescription:

Lists systems that have been inactive for the default period of inactivity

Parameters:


Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"




API Documentation | Chapter 692. Method: listInactiveSystems 789 / 1066

Chapter 693. Method: listInactiveSystemsDescription:

Lists systems that have been inactive for the specified number of days..

Parameters:


• int days

Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"




API Documentation | Chapter 693. Method: listInactiveSystems 790 / 1066

Chapter 694. Method: listInstalledPackagesDescription:

List the installed packages for a given system.

Parameters:


• int serverId

Returns:

• array :


▪ int "package_id" - PackageID, -1 if package is installed but not available in

subscribed channels

▪ string "name"

▪ string "epoch"



▪ string "arch" - architecture label


▪ boolean "retracted"

API Documentation | Chapter 694. Method: listInstalledPackages 791 / 1066

Chapter 695. Method:listLatestAvailablePackageDescription:

Get the latest available version of a package for each system

Parameters:


• array :

◦ int - serverId

• string packageName

Returns:

• array :

◦ struct - system

▪ int "id" - server ID

▪ string "name" - server name

▪ struct "package" - package structure


▪ int "id"

▪ string "name"



▪ string "epoch"

▪ string "arch"

API Documentation | Chapter 695. Method: listLatestAvailablePackage 792 / 1066

Chapter 696. Method:listLatestInstallablePackagesDescription:

Get the list of latest installable packages for a given system.

Parameters:


• int serverId

Returns:

• array :


▪ string "name"



▪ string "epoch"

▪ int "id"


API Documentation | Chapter 696. Method: listLatestInstallablePackages 793 / 1066

Chapter 697. Method:listLatestUpgradablePackagesDescription:

Get the list of latest upgradable packages for a given system.

Parameters:


• int serverId

Returns:

• array :


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

API Documentation | Chapter 697. Method: listLatestUpgradablePackages 794 / 1066

Chapter 698. Method: listMigrationTargetsDescription:

List possible migration targets for a system

Parameters:


• int serverId

Returns:

• array :

◦ struct - migrationtarget

▪ string "ident"

▪ string "friendly"

API Documentation | Chapter 698. Method: listMigrationTargets 795 / 1066

Chapter 699. Method:listNewerInstalledPackagesDescription:

Given a package name, version, release, and epoch, returns the list of packages installed on the

system w/ the same name that are newer.

Parameters:


• int serverId





Returns:

• array :


▪ string "name"



▪ string "epoch"

API Documentation | Chapter 699. Method: listNewerInstalledPackages 796 / 1066

Chapter 700. Method: listNotesDescription:

Provides a list of notes associated with a system.

Parameters:


• int serverId

Returns:

• array :

• struct - note details

◦ int "id"

◦ string "subject" - Subject of the note

◦ string "note" - Contents of the note

◦ int "system_id" - The id of the system associated with the note

◦ string "creator" - Creator of the note if exists (optional)

◦ date "updated" - Date of the last note update

API Documentation | Chapter 700. Method: listNotes 797 / 1066

Chapter 701. Method:listOlderInstalledPackagesDescription:

Given a package name, version, release, and epoch, returns the list of packages installed on the

system with the same name that are older.

Parameters:


• int serverId





Returns:

• array :


▪ string "name"



▪ string "epoch"

API Documentation | Chapter 701. Method: listOlderInstalledPackages 798 / 1066

Chapter 702. Method: listOutOfDateSystemsDescription:

Returns list of systems needing package updates.

Parameters:


Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"






API Documentation | Chapter 702. Method: listOutOfDateSystems 799 / 1066

Chapter 703. Method: listPackageProfilesDescription:

List the package profiles in this organization

Parameters:


Returns:

• array :

• struct - package profile

◦ int "id"

◦ string "name"

◦ string "channel"

API Documentation | Chapter 703. Method: listPackageProfiles 800 / 1066

Chapter 704. Method: listPackageStateDescription:

List possible migration targets for a system

Parameters:


• int serverId

Returns:

• array :

• struct - packagestate

◦ int "id"

◦ string "name"

◦ int "state_revision_id" - State revision Id

◦ string "package_state_type_id" - INSTALLED or REMOVED

◦ string "version_constraint_id" - LATEST or ANY

API Documentation | Chapter 704. Method: listPackageState 801 / 1066

Chapter 705. Method: listPackages(Deprecated)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 architecture name,

whereas the other endpoints return/accept architecture label. Instead of this method, use

listInstalledPackages preferably.

Parameters:


• int serverId

Returns:

• array :


▪ string "name"



▪ string "epoch"

▪ string "arch" - Architecture name


API Documentation | Chapter 705. Method: listPackages (Deprecated) 802 / 1066

Chapter 706. Method:listPackagesFromChannelDescription:

Provides a list of packages installed on a system that are also contained in the given channel.

The installed package list did not include arch information before RHEL 5, so it is arch unaware.

RHEL 5 systems do upload the arch information, and thus are arch aware.

Parameters:


• int serverId


Returns:

• array :


◦ string "name"



◦ string "epoch"

◦ int "id"






with.

API Documentation | Chapter 706. Method: listPackagesFromChannel 803 / 1066

Chapter 707. Method: listPackagesLockStatusDescription:

List current package locks status.

Parameters:


• string system_id

Returns:

• array :


▪ int "package_id" - PackageID, -1 if package is locked but not available in subscribed

channels

▪ string "name"

▪ string "epoch"



▪ string "arch" - architecture label

▪ string "pending status" - return only if there is a pending locking

API Documentation | Chapter 707. Method: listPackagesLockStatus 804 / 1066

Chapter 708. Method: listPhysicalSystemsDescription:

Returns a list of all Physical servers visible to the user.

Parameters:


Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"






API Documentation | Chapter 708. Method: listPhysicalSystems 805 / 1066

Chapter 709. Method:listSubscribableBaseChannelsDescription:

Returns a list of subscribable base channels.

Parameters:


• int serverId

Returns:

• array :


▪ int "id" - Base Channel ID.

▪ string "name" - Name of channel.

▪ string "label" - Label of Channel

▪ int "current_base" - 1 indicates it is the current base channel

API Documentation | Chapter 709. Method: listSubscribableBaseChannels 806 / 1066

Chapter 710. Method:listSubscribableChildChannelsDescription:

Returns a list of subscribable child channels. This only shows channels the system is not currently

subscribed to.

Parameters:


• int serverId

Returns:

• array :

◦ struct - child channel

▪ int "id"

▪ string "name"

▪ string "label"


▪ string "has_license"

▪ string "gpg_key_url"

API Documentation | Chapter 710. Method: listSubscribableChildChannels 807 / 1066

Chapter 711. Method:listSubscribedChildChannelsDescription:

Returns a list of subscribed child channels.

Parameters:


• int serverId

Returns:

• array :


◦ int "id"

◦ string "name"

◦ string "label"













API Documentation | Chapter 711. Method: listSubscribedChildChannels 808 / 1066






◦ array :


▪ int "id"

▪ string "label"


▪ string "type"

API Documentation | Chapter 711. Method: listSubscribedChildChannels 809 / 1066

Chapter 712. Method: listSuggestedRebootDescription:

List systems that require reboot.

Parameters:


Returns:

• array :

◦ struct - system

▪ int "id"

▪ string "name"

API Documentation | Chapter 712. Method: listSuggestedReboot 810 / 1066

Chapter 713. Method: listSystemEventsDescription:

List system actions of the specified type that were scheduled against the given server after the

specified date. "actionType" should be exactly the string returned in the action_type field from

the listSystemEvents(sessionKey, serverId) method. For example, 'Package Install' or 'Initiate a

kickstart for a virtual guest.' Note: see also system.getEventHistory method which returns a history

of all events.

Parameters:


• int serverId - ID of system.

• string actionType - Type of the action.


Returns:

• array :

◦ struct - action

▪ int "failed_count" - Number of times action failed.

▪ string "modified" - Date modified. (Deprecated by modified_date)

▪ dateTime.iso8601 "modified_date" - Date modified.

▪ 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 the action

▪ string "prerequisite" - Pre-requisite action. (optional)

▪ string "name" - Name of this action.

API Documentation | Chapter 713. Method: listSystemEvents 811 / 1066

▪ 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 was completed.

(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 client

machine. (optional)

▪ array "additional_info" - This array contains additional information for the event, if

available.

▪ struct - info

▪ string "detail" - The detail provided depends on the specific event. For example,

for a package event, this will be the package name, for an errata event, this will

be the advisory name and synopsis, for a config file event, this will be path and

optional revision information…etc.

▪ string "result" - The result (if included) depends on the specific event. For

example, for a package or errata event, no result is included, for a config file

event, the result might include an error (if one occurred, such as the file was

missing) or in the case of a config file comparison it might include the

differences found.




List all system actions that were scheduled against the given server. This may require the caller

to filter the result to fetch actions with a specific action type or to use the overloaded

system.listSystemEvents method with actionType as a parameter. Note: see also

system.getEventHistory method which returns a history of all events.

Parameters:



Returns:

• array :

◦ struct - action


















completed_date)


(optional)



pickup_date)


(optional)


machine. (optional)


available.

▪ struct - info









differences found.




List system actions of the specified type that were scheduled against the given server.

"actionType" should be exactly the string returned in the action_type field from the

listSystemEvents(sessionKey, serverId) method. For example, 'Package Install' or 'Initiate a

kickstart for a virtual guest.' Note: see also system.getEventHistory method which returns a history

of all events.

Parameters:




Returns:

• array :

◦ struct - action


















completed_date)


(optional)



pickup_date)


(optional)


machine. (optional)


available.

▪ struct - info









differences found.




List system actions of the specified type that were scheduled against the given server after the

specified date. This may require the caller to filter the result to fetch actions with a specific action

type or to use the overloaded system.listSystemEvents method with actionType as a parameter.

Note: see also system.getEventHistory method which returns a history of all events.

Parameters:





Returns:

• array :

◦ struct - action


















completed_date)


(optional)



pickup_date)


(optional)


machine. (optional)


available.

▪ struct - info









differences found.



Chapter 717. Method:listSystemGroupsForSystemsWithEntitlementDescription:

Returns the groups information a system is member of, for all the systems visible to the passed

user and that are entitled with the passed entitlement.

Parameters:


• string entitlement

Returns:

• array :

• struct - system

◦ int "id" - system ID

◦ array "system_groups"

▪ struct - system_group

▪ int "id" - system group ID

▪ string "name" - system group name

API Documentation | Chapter 717. Method: listSystemGroupsForSystemsWithEntitlement 819 / 1066

Chapter 718. Method: listSystemsDescription:

Returns a list of all servers visible to the user.

Parameters:


Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"




API Documentation | Chapter 718. Method: listSystems 820 / 1066

Chapter 719. Method:listSystemsWithEntitlementDescription:

Lists the systems that have the given entitlement

Parameters:


• string entitlementName - the entitlement name

Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"






API Documentation | Chapter 719. Method: listSystemsWithEntitlement 821 / 1066

Chapter 720. Method:listSystemsWithExtraPackagesDescription:

List systems with extra packages

Parameters:


Returns:

• array :

◦ struct - system

▪ int "id" - System ID

▪ string "name" - System profile name

▪ int "extra_pkg_count" - Extra packages count

API Documentation | Chapter 720. Method: listSystemsWithExtraPackages 822 / 1066

Chapter 721. Method: listSystemsWithPackageDescription:

Lists the systems that have the given installed package

Parameters:


• int pid - the package id

Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"






API Documentation | Chapter 721. Method: listSystemsWithPackage 823 / 1066

Chapter 722. Method: listSystemsWithPackageDescription:

Lists the systems that have the given installed package

Parameters:


• string name - the package name

• string version - the package version

• string release - the package release

Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"






API Documentation | Chapter 722. Method: listSystemsWithPackage 824 / 1066

Chapter 723. Method: listUngroupedSystemsDescription:

List systems that are not associated with any system groups.

Parameters:


Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"






API Documentation | Chapter 723. Method: listUngroupedSystems 825 / 1066

Chapter 724. Method: listUserSystemsDescription:

List systems for a given user.

Parameters:



Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"




API Documentation | Chapter 724. Method: listUserSystems 826 / 1066

Chapter 725. Method: listUserSystemsDescription:

List systems for the logged in user.

Parameters:


Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"




API Documentation | Chapter 725. Method: listUserSystems 827 / 1066

Chapter 726. Method: listVirtualGuestsDescription:

Lists the virtual guests for a given virtual host

Parameters:


• int sid - the virtual host’s id

Returns:

• array :

• struct - virtual system

◦ int "id"

◦ string "name"

◦ string "guest_name" - The virtual guest name as provided by the virtual host

◦ dateTime.iso8601 "last_checkin" - Last time server successfully checked in.

◦ string "uuid"

API Documentation | Chapter 726. Method: listVirtualGuests 828 / 1066

Chapter 727. Method: listVirtualHostsDescription:

Lists the virtual hosts visible to the user

Parameters:


Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"






API Documentation | Chapter 727. Method: listVirtualHosts 829 / 1066

Chapter 728. Method: obtainReactivationKeyDescription:

Obtains a reactivation key for this server.

Parameters:


• int serverId

Returns:

• string key

API Documentation | Chapter 728. Method: obtainReactivationKey 830 / 1066

Chapter 729. Method: obtainReactivationKeyDescription:

Obtains a reactivation key for this server.

Parameters:


Returns:

• string key


API Documentation | Chapter 729. Method: obtainReactivationKey 831 / 1066

Chapter 730. Method: provisionSystemDescription:

Provision a system using the specified kickstart/autoinstallation profile.

Parameters:


• int serverId - ID of the system to be provisioned.

• string profileName - Profile to use.

Returns:

• int id - ID of the action scheduled, otherwise exception thrown on error

API Documentation | Chapter 730. Method: provisionSystem 832 / 1066

Chapter 731. Method: provisionSystemDescription:

Provision a system using the specified kickstart/autoinstallation profile.

Parameters:


• int serverId - ID of the system to be provisioned.

• string profileName - Profile to use.


Returns:


API Documentation | Chapter 731. Method: provisionSystem 833 / 1066

Chapter 732. Method: provisionVirtualGuestDescription:

Provision a guest on the host specified. Defaults to: memory=512MB, vcpu=1, storage=3GB,

mac_address=random.

Parameters:


• int serverId - ID of host to provision guest on.

• string guestName

• string profileName - Kickstart profile to use.

Returns:


API Documentation | Chapter 732. Method: provisionVirtualGuest 834 / 1066


Provision a guest on the host specified. This schedules the guest for creation and will begin the

provisioning process when the host checks in or if OSAD is enabled will begin immediately.

Defaults to mac_address=random.

Parameters:




• string profileName - Kickstart Profile to use.

• int memoryMb - Memory to allocate to the guest

• int vcpus - Number of virtual CPUs to allocate to the guest.

• int storageGb - Size of the guests disk image.

Returns:




Provision a guest on the host specified. This schedules the guest for creation and will begin the

provisioning process when the host checks in or if OSAD is enabled will begin immediately.

Parameters:




• string profileName - Kickstart Profile to use.

• int memoryMb - Memory to allocate to the guest

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

Returns:



Chapter 735. Method: refreshPillarDescription:

refresh all the pillar data of a list of systems.

Parameters:


• array :

◦ int - serverIds

Returns:

• array :

◦ int - skippedIds

API Documentation | Chapter 735. Method: refreshPillar 837 / 1066

Chapter 736. Method: refreshPillarDescription:

refresh the pillar data of a list of systems. The subset value represents the pillar to be refreshed

and can be one of 'general', 'group_membership', 'virtualization' or 'custom_info'.

Parameters:


• string subset

• array :

◦ int - serverIds

Returns:

• array :

◦ int - skippedIds

API Documentation | Chapter 736. Method: refreshPillar 838 / 1066

Chapter 737. Method: removeEntitlementsDescription:

Remove addon entitlements from a server. Entitlements a server does not have are quietly

ignored.

Parameters:


• int serverId

• array :

◦ string - entitlement_label

Returns:


API Documentation | Chapter 737. Method: removeEntitlements 839 / 1066

Chapter 738. Method: scheduleApplyErrataDescription:

Schedules an action to apply errata updates to multiple systems.

Parameters:


• array :

◦ int - serverId

• array :

◦ int - errataId

Returns:

• array :

◦ int - actionId


API Documentation | Chapter 738. Method: scheduleApplyErrata 840 / 1066


Schedules an action to apply errata updates to multiple systems.

Parameters:


• array :

◦ int - serverId

• array :

◦ int - errataId

• boolean allowModules - Allow this API call, despite modular content being present

Returns:

• array :

◦ int - actionId

Available since API version: 21



Schedules an action to apply errata updates to multiple systems at a given date/time.

Parameters:


• array :

◦ int - serverId

• array :

◦ int - errataId

• dateTime.iso8601 earliestOccurrence

Returns:

• array :

◦ int - actionId





Parameters:


• array :

◦ int - serverId

• array :

◦ int - errataId



Returns:

• array :

◦ int - actionId





Parameters:


• array :

◦ int - serverId

• array :

◦ int - errataId



• boolean onlyRelevant - If true not all erratas are applied to all systems. Systems get only the

erratas relevant for them.

Returns:

• array :

◦ int - actionId




Schedules an action to apply errata updates to a system.

Parameters:


• int serverId

• array :

◦ int - errataId

Returns:

• array :

◦ int - actionId




Schedules an action to apply errata updates to a system.

Parameters:


• int serverId

• array :

◦ int - errataId


Returns:

• array :

◦ int - actionId




Schedules an action to apply errata updates to a system at a given date/time.

Parameters:


• int serverId

• array :

◦ int - errataId


Returns:

• array :

◦ int - actionId





Parameters:


• int serverId

• array :

◦ int - errataId



Returns:

• array :

◦ int - actionId





Parameters:


• int serverId

• array :

◦ int - errataId



• boolean allowVendorChange

Returns:

• array :

◦ int - actionId



Chapter 748. Method:scheduleApplyHighstateDescription:

Schedule highstate application for a given system.

Parameters:


• int serverId


• boolean test - Run states in test-only mode

Returns:

• int actionId

API Documentation | Chapter 748. Method: scheduleApplyHighstate 850 / 1066

Chapter 749. Method:scheduleApplyHighstateDescription:


Parameters:


• array :

◦ int - systemIds



Returns:

• int actionId

API Documentation | Chapter 749. Method: scheduleApplyHighstate 851 / 1066

Chapter 750. Method: scheduleApplyStatesDescription:


Parameters:


• int serverId

• array :

◦ string - state names



Returns:

• int actionId

API Documentation | Chapter 750. Method: scheduleApplyStates 852 / 1066

Chapter 751. Method: scheduleApplyStatesDescription:


Parameters:


• array :

◦ int - systemIds

• array :

◦ string - state names



Returns:

• int actionId

API Documentation | Chapter 751. Method: scheduleApplyStates 853 / 1066

Chapter 752. Method:scheduleCertificateUpdateDescription:

Schedule update of client certificate

Parameters:


• int serverId

Returns:


API Documentation | Chapter 752. Method: scheduleCertificateUpdate 854 / 1066

Chapter 753. Method:scheduleCertificateUpdateDescription:

Schedule update of client certificate at given date and time

Parameters:


• int serverId

• dateTime.iso860 date

Returns:


API Documentation | Chapter 753. Method: scheduleCertificateUpdate 855 / 1066

Chapter 754. Method:scheduleChangeChannelsDescription:

Schedule an action to change the channels of the given system. Works for both traditional and

Salt systems. This method accepts labels for the base and child channels. If the user provides an

empty string for the channelLabel, the current base channel and all child channels will be

removed from the system.

Parameters:


• int serverId

• string baseChannelLabel

• array :


• dateTime.iso8601 date - the time/date to schedule the action

Returns:



API Documentation | Chapter 754. Method: scheduleChangeChannels 856 / 1066

Chapter 755. Method:scheduleChangeChannelsDescription:

Schedule an action to change the channels of the given system. Works for both traditional and

Salt systems. This method accepts labels for the base and child channels. If the user provides an

empty string for the channelLabel, the current base channel and all child channels will be

removed from the system.

Parameters:


• int serverId


• array :



Returns:

• array :

◦ long - actionIds


API Documentation | Chapter 755. Method: scheduleChangeChannels 857 / 1066

Chapter 756. Method: scheduleDistUpgradeDescription:

Schedule a dist upgrade for a system. This call takes a list of channel labels that the system will

be subscribed to before performing the dist upgrade. Note: You can seriously damage your

system with this call, use it only if you really know what you are doing! Make sure that the list of

channel labels is complete and in any case do a dry run before scheduling an actual dist

upgrade.

Parameters:


• int serverId

• array :

◦ string - channels

• boolean dryRun

• dateTime.iso8601 earliest

Returns:

• int actionId

API Documentation | Chapter 756. Method: scheduleDistUpgrade 858 / 1066

Chapter 757. Method: scheduleDistUpgradeDescription:

Schedule a dist upgrade for a system. This call takes a list of channel labels that the system will

be subscribed to before performing the dist upgrade. Note: You can seriously damage your

system with this call, use it only if you really know what you are doing! Make sure that the list of

channel labels is complete and in any case do a dry run before scheduling an actual dist

upgrade.

Parameters:


• int serverId

• array :

◦ string - channels

• boolean dryRun



Returns:

• int actionId

API Documentation | Chapter 757. Method: scheduleDistUpgrade 859 / 1066

Chapter 758. Method: scheduleGuestActionDescription:

Schedules a guest action for the specified virtual guest for a given date/time.

Parameters:


• int sid - the system Id of the guest

• string state - One of the following actions 'start', 'suspend', 'resume', 'restart', 'shutdown'.


Returns:


API Documentation | Chapter 758. Method: scheduleGuestAction 860 / 1066

Chapter 759. Method: scheduleGuestActionDescription:

Schedules a guest action for the specified virtual guest for the current time.

Parameters:


• int sid - the system Id of the guest

• string state - One of the following actions 'start', 'suspend', 'resume', 'restart', 'shutdown'.

Returns:


API Documentation | Chapter 759. Method: scheduleGuestAction 861 / 1066

Chapter 760. Method:scheduleHardwareRefreshDescription:

Schedule a hardware refresh for a system.

Parameters:


• int serverId


Returns:



API Documentation | Chapter 760. Method: scheduleHardwareRefresh 862 / 1066

Chapter 761. Method: schedulePackageInstallDescription:

Schedule package installation for several systems.

Parameters:


• array :

◦ int - serverId

• array :

◦ int - packageId


Returns:

• array :

◦ int - actionId

API Documentation | Chapter 761. Method: schedulePackageInstall 863 / 1066



Parameters:


• array :

◦ int - serverId

• array :

◦ int - packageId



Returns:

• array :

◦ int - actionId




Schedule package installation for a system.

Parameters:


• int serverId

• array :

◦ int - packageId


Returns:






Parameters:


• int serverId

• array :

◦ int - packageId



Returns:




Chapter 765. Method:schedulePackageInstallByNevraDescription:


Parameters:


• array :

◦ int - serverId

• array :

◦ struct - Package nevra

▪ string "package_name"

▪ string "package_epoch"

▪ string "package_version"

▪ string "package_release"

▪ string "package_arch"


Returns:

• array :

◦ int - actionId

API Documentation | Chapter 765. Method: schedulePackageInstallByNevra 867 / 1066



Parameters:


• array :

◦ int - serverId

• array :









Returns:

• array :

◦ int - actionId





Parameters:


• int serverId

• array :








Returns:





Parameters:


• int serverId

• array :









Returns:




Chapter 769. Method:schedulePackageLockChangeDescription:

Schedule package lock for a system.

Parameters:


• int serverId

• array :

◦ int - pkgIdsToLock

• array :

◦ int - pkgIdsToUnlock


Returns:

• [.return_int_success] int - 1 on success, exception thrown otherwise. # $value - $desc

API Documentation | Chapter 769. Method: schedulePackageLockChange 871 / 1066

Chapter 770. Method:schedulePackageRefreshDescription:

Schedule a package list refresh for a system.

Parameters:


• int serverId


Returns:


API Documentation | Chapter 770. Method: schedulePackageRefresh 872 / 1066

Chapter 771. Method:schedulePackageRemoveDescription:

Schedule package removal for several systems.

Parameters:


• array :

◦ int - serverId

• array :

◦ int - packageId


Returns:

• array :

◦ int - actionId

API Documentation | Chapter 771. Method: schedulePackageRemove 873 / 1066



Parameters:


• array :

◦ int - serverId

• array :

◦ int - packageId



Returns:

• array :

◦ int - actionId




Schedule package removal for a system.

Parameters:


• int serverId

• array :

◦ int - packageId


Returns:





Parameters:


• int serverId

• array :

◦ int - packageId



Returns:




Chapter 775. Method:schedulePackageRemoveByNevraDescription:


Parameters:


• array :

◦ int - serverId

• array :








Returns:

• array :

◦ int - actionId

API Documentation | Chapter 775. Method: schedulePackageRemoveByNevra 877 / 1066



Parameters:


• array :

◦ int - serverId

• array :









Returns:

• array :

◦ int - actionId





Parameters:


• int serverId

• array :








Returns:

• array :

◦ int - actionId




Parameters:


• int serverId

• array :









Returns:

• array :

◦ int - actionId



Chapter 779. Method:scheduleProductMigrationDescription:

Schedule a Product migration for a system. This call is the recommended and supported way of

migrating a system to the next Service Pack. It will automatically find all mandatory product

channels below a given target base channel and subscribe the system accordingly. Any

additional optional channels can be subscribed by providing their labels.

Parameters:


• int serverId


• array :

◦ string - optionalChildChannels

• boolean dryRun


Returns:


API Documentation | Chapter 779. Method: scheduleProductMigration 881 / 1066






Parameters:


• int serverId


• array :


• boolean dryRun



Returns:




Schedule a Prodcut migration for a system. This call is the recommended and supported way of




Parameters:


• int serverId

• string targetIdent


• array :


• boolean dryRun


Returns:








Parameters:


• int serverId



• array :


• boolean dryRun



Returns:



Chapter 783. Method: scheduleRebootDescription:

Schedule a reboot for a system.

Parameters:


• int serverId


Returns:



API Documentation | Chapter 783. Method: scheduleReboot 885 / 1066

Chapter 784. Method: scheduleSPMigration(Deprecated)Description:





Note: This method is deprecated and will be removed in a future API version. Please usescheduleProductMigration instead.

Deprecated - being replaced by scheduleProductMigration(User loggedInUser, Integer sid, String

baseChannelLabel, List(String) optionalChildChannels, boolean dryRun, Date earliest)

Parameters:


• int serverId


• array :


• boolean dryRun


Returns:


API Documentation | Chapter 784. Method: scheduleSPMigration (Deprecated) 886 / 1066








baseChannelLabel, List(String) optionalChildChannels, boolean dryRun, boolean

allowVendorChange, Date earliest)

Parameters:


• int serverId


• array :


• boolean dryRun



Returns:




Schedule a Prodcut migration for a system. This call is the recommended and supported way of






targetIdent, String baseChannelLabel, List(String) optionalChildChannels, boolean dryRun, Date

earliest)

Parameters:


• int serverId



• array :


• boolean dryRun


Returns:










targetIdent, String baseChannelLabel, List(String) optionalChildChannels, boolean dryRun,

boolean allowVendorChange, Date earliest)

Parameters:


• int serverId



• array :


• boolean dryRun



Returns:



Chapter 788. Method: scheduleScriptRunDescription:

Schedule a script to run.

Parameters:


• string label

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

Returns:

• int id - ID of the script run action created. Can be used to fetch results with

system.getScriptResults

API Documentation | Chapter 788. Method: scheduleScriptRun 890 / 1066



Parameters:


• array :

◦ int - System IDs of the servers to run the script on.






Returns:






Parameters:


• int serverId - ID of the server to run the script on.






Returns:






Parameters:


• string label

• int serverId - ID of the server to run the script on.






Returns:




Chapter 792. Method:scheduleSyncPackagesWithSystemDescription:

Sync packages from a source system to a target.

Parameters:


• int targetServerId - Target system to apply package changes to.

• 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

Returns:



API Documentation | Chapter 792. Method: scheduleSyncPackagesWithSystem 894 / 1066

Chapter 793. Method: searchByNameDescription:

Returns a list of system IDs whose name matches the supplied regular expression(defined by

Java representation of regular expressions)

Parameters:


• string regexp - A regular expression

Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"




API Documentation | Chapter 793. Method: searchByName 895 / 1066

Chapter 794. Method: sendOsaPingDescription:

send a ping to a system using OSA

Parameters:


• int serverId

Returns:


API Documentation | Chapter 794. Method: sendOsaPing 896 / 1066

Chapter 795. Method: setBaseChannel(Deprecated)Description:

Assigns the server to a new baseChannel.

Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string

channelLabel)

Parameters:


• int serverId

• int channelId

Returns:


API Documentation | Chapter 795. Method: setBaseChannel (Deprecated) 897 / 1066

Chapter 796. Method: setBaseChannel(Deprecated)Description:

Assigns the server to a new base channel. If the user provides an empty string for the

channelLabel, the current base channel and all child channels will be removed from the system.

Deprecated - being replaced by system.scheduleChangeChannels(string sessionKey, int

serverId, String baseChannelLabel, array_single channelLabels, date earliestOccurrence).

Parameters:


• int serverId


Returns:


API Documentation | Chapter 796. Method: setBaseChannel (Deprecated) 898 / 1066

Chapter 797. Method: setChildChannels(Deprecated)Description:

Subscribe the given server to the child channels provided. This method will unsubscribe the

server from any child channels that the server is currently subscribed to, but that are not

included in the list. The user may provide either a list of channel ids (int) or a list of channel labels

(string) as input. Changes to channel assignments on salt managed systems will take effect at

next highstate application.

Deprecated - being replaced by system.scheduleChangeChannels(string sessionKey, int

serverId, String baseChannelLabel, array_single channelLabels, date earliestOccurrence). This

method will schedule an action for changing the child channels immediately.

Parameters:


• int serverId

• array :

◦ int (deprecated) or string - channelId (deprecated) or channelLabel

Returns:


API Documentation | Chapter 797. Method: setChildChannels (Deprecated) 899 / 1066

Chapter 798. Method: setCustomValuesDescription:

Set custom values for the specified server.

Parameters:


• int serverId



◦ string "value"

Returns:


API Documentation | Chapter 798. Method: setCustomValues 900 / 1066


Set server details. All arguments are optional and will only be modified if included in the struct.

Parameters:


• int serverId - ID of server to lookup details for.

• struct - server details

◦ string "profile_name" - System’s profile name

◦ string "base_entitlement" - System’s base entitlement label. (enterprise_entitled or

unentitle)

◦ boolean "auto_errata_update" - True if system has auto errata updates enabled

◦ string "description" - System description

◦ string "address1" - System’s address line 1.

◦ string "address2" - System’s address line 2.

◦ string "city"

◦ string "state"



◦ string "room"

◦ string "rack"


◦ default

◦ ssh-push

◦ ssh-push-tunnel

Returns:



Chapter 800. Method: setGroupMembershipDescription:

Set a servers membership in a given group.

Parameters:


• int serverId

• int serverGroupId

• boolean member - '1' to assign the given server to the given server group, '0' to remove the

given server from the given server group.

Returns:


API Documentation | Chapter 800. Method: setGroupMembership 902 / 1066

Chapter 801. Method: setGuestCpusDescription:

Schedule an action of a guest’s host, to set that guest’s CPU allocation

Parameters:


• int sid - The guest’s system id

• int numOfCpus - The number of virtual cpus to allocate to the guest

Returns:

• int actionID - the action Id for the schedule action on the host system

API Documentation | Chapter 801. Method: setGuestCpus 903 / 1066

Chapter 802. Method: setGuestMemoryDescription:

Schedule an action of a guest’s host, to set that guest’s memory allocation

Parameters:


• int sid - The guest’s system id

• int memory - The amount of memory to allocate to the guest

Returns:

• int actionID - the action Id for the schedule action on the host system

API Documentation | Chapter 802. Method: setGuestMemory 904 / 1066

Chapter 803. Method: setLockStatusDescription:

Set server lock status.

Parameters:


• int serverId

• boolean lockStatus - true to lock the system, false to unlock the system.

Returns:


API Documentation | Chapter 803. Method: setLockStatus 905 / 1066

Chapter 804. Method: setPrimaryFqdnDescription:

Sets new primary FQDN

Parameters:


• int serverId

• string fqdn

Returns:


API Documentation | Chapter 804. Method: setPrimaryFqdn 906 / 1066

Chapter 805. Method: setPrimaryInterfaceDescription:

Sets new primary network interface

Parameters:


• int serverId

• string interfaceName

Returns:


API Documentation | Chapter 805. Method: setPrimaryInterface 907 / 1066

Chapter 806. Method: setProfileNameDescription:

Set the profile name for the server.

Parameters:


• int serverId

• string name - Name of the profile.

Returns:


API Documentation | Chapter 806. Method: setProfileName 908 / 1066

Chapter 807. Method: setVariablesDescription:

Sets a list of kickstart variables in the cobbler system record for the specified server. Note: This

call assumes that a system record exists in cobbler for the given system and will raise an XMLRPC

fault if that is not the case. To create a system record over xmlrpc use

system.createSystemRecord

To create a system record in the Web UI please go toSystem -> <Specified System> -> Provisioning ->Select a Kickstart profile -> Create Cobbler System Record.

Parameters:


• int serverId

• boolean netboot

• array :

◦ struct - kickstart variable

▪ string "key"

▪ string or int "value"

Returns:


API Documentation | Chapter 807. Method: setVariables 909 / 1066

Chapter 808. Method: tagLatestSnapshotDescription:

Tags latest system snapshot

Parameters:


• int serverId

• string tagName

Returns:


API Documentation | Chapter 808. Method: tagLatestSnapshot 910 / 1066

Chapter 809. Method: unentitleDescription:

Unentitle the system completely

Parameters:


Returns:


API Documentation | Chapter 809. Method: unentitle 911 / 1066

Chapter 810. Method: updatePackageStateDescription:

Update the package state of a given system (High state would be needed to actually

install/remove the package)

Parameters:


• int serverId

• string packageName - Name of the package

• int state - 0 = installed, 1 = removed, 2 = unmanaged

• int versionConstraint - 0 = latest, 1 = any

Returns:

• 1 on success, exception on failure

API Documentation | Chapter 810. Method: updatePackageState 912 / 1066

Chapter 811. Method: upgradeEntitlementDescription:

Adds an entitlement to a given server.

Parameters:


• int serverId

• string entitlementName - One of: 'enterprise_entitled' or 'virtualization_host'.

Returns:


API Documentation | Chapter 811. Method: upgradeEntitlement 913 / 1066

Chapter 812. Method: whoRegisteredDescription:

Returns information about the user who registered the system

Parameters:


• int sid - Id of the system in question

Returns:

• * struct - user

◦ int "id"

◦ string "login"



API Documentation | Chapter 812. Method: whoRegistered 914 / 1066

system.config


Chapter 813. Available methods• addChannels

• createOrUpdatePath

• createOrUpdateSymlink

• deleteFiles

• deployAll

• listChannels

• listFiles

• lookupFileInfo

• removeChannels

• scheduleApplyConfigChannel

• setChannels


Chapter 814. DescriptionProvides methods to access and modify many aspects of configuration channels and server

association. basically system.config name space

Namespace:

system.config


Chapter 815. Method: addChannelsDescription:

Given a list of servers and configuration channels, this method appends the configuration

channels to either the top or the bottom (whichever you specify) of a system’s subscribed

configuration channels list. The ordering of the configuration channels provided in the add list is

maintained while adding. If one of the configuration channels in the 'add' list has been previously

subscribed by a server, the subscribed channel will be re-ranked to the appropriate place.

Parameters:


• array :

◦ int - IDs of the systems to add the channels to.

• array :


• boolean addToTop

• true - to prepend the given channels list to the top of the configuration channels list of a

server

• false - to append the given channels list to the bottom of the configuration channels list of a

server

Returns:


API Documentation | Chapter 815. Method: addChannels 918 / 1066

Chapter 816. Method: createOrUpdatePathDescription:

Create a new file (text or binary) or directory with the given path, or update an existing path on a

server.

Parameters:


• int serverId

• string path - the configuration file/directory path

• boolean isDir

• True - if the path is a directory

• False - if the path is a file


◦ string "contents" - Contents of the file (text or base64 encoded if binary) ((only for non-

directories)

◦ boolean "contents_enc64" - Identifies base64 encoded content (default: disabled, only

for non-directories).

◦ string "owner" - Owner of the file/directory.

◦ string "group" - Group name of the file/directory.

◦ string "permissions" - Octal file/directory permissions (eg: 644)

◦ string "macro-start-delimiter" - Config file macro end delimiter. Use null or empty string


◦ string "macro-end-delimiter" - Config file macro end delimiter. Use null or empty string


◦ string "selinux_ctx" - SeLinux context (optional)


◦ boolean "binary" - mark the binary content, if True, base64 encoded content is expected

(only for non-directories)

• int commitToLocal


• 1 - to commit configuration files to the system’s local override configuration channel

• 0 - to commit configuration files to the system’s sandbox configuration channel

Returns:


◦ string "type"

◦ file

◦ directory

◦ symlink





attribute)













only.


only.


Chapter 817. Method: createOrUpdateSymlinkDescription:

Create a new symbolic link with the given path, or update an existing path.

Parameters:


• int serverId

• string path - the configuration file/directory path


◦ string "target_path" - The target path for the symbolic link



• int commitToLocal

• 1 - to commit configuration files to the system’s local override configuration channel

• 0 - to commit configuration files to the system’s sandbox configuration channel

Returns:


◦ string "type"

◦ file

◦ directory

◦ symlink





attribute)














only.


only.



Chapter 818. Method: deleteFilesDescription:

Removes file paths from a local or sandbox channel of a server.

Parameters:


• int serverId

• array :

◦ string - paths to remove.

• boolean deleteFromLocal

• True - to delete configuration file paths from the system’s local override configuration

channel

• False - to delete configuration file paths from the system’s sandbox configuration channel

Returns:


API Documentation | Chapter 818. Method: deleteFiles 924 / 1066

Chapter 819. Method: deployAllDescription:

Schedules a deploy action for all the configuration files on the given list of systems.

Parameters:


• array :

◦ int - id of the systems to schedule configuration files deployment

• dateTime.iso8601 date - Earliest date for the deploy action.

Returns:


API Documentation | Chapter 819. Method: deployAll 925 / 1066


List all global('Normal', 'State') configuration channels associated to a system in the order of their

ranking.

Parameters:


• int serverId

Returns:

• array :


◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "name"




◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"



Return the list of files in a given channel.

Parameters:


• int serverId

• int listLocal

• 1 - to return configuration files in the system’s local override configuration channel

• 0 - to return configuration files in the system’s sandbox configuration channel

Returns:

• array :

• struct - Configuration File information

◦ string "type"

◦ file

◦ directory

◦ symlink


◦ string "channel_label" - the label of the central configuration channel that has this file.

Note this entry only shows up if the file has not been overridden by a central channel.

◦ struct "channel_type"


◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"

◦ dateTime.iso8601 "last_modified" - Last Modified Date



Given a list of paths and a server, returns details about the latest revisions of the paths.

Parameters:


• int serverId

• array :

◦ string - paths to lookup on.

• boolean searchLocal

• 1 - to search configuration file paths in the system’s local override configuration or systems

subscribed central channels

• 0 - to search configuration file paths in the system’s sandbox configuration channel

Returns:

• array :


◦ string "type"

◦ file

◦ directory

◦ symlink





attribute)














only.


only.



Chapter 823. Method: removeChannelsDescription:

Remove config channels from the given servers.

Parameters:


• array :

◦ int - the IDs of the systems from which you would like to remove configuration channels..

• array :

◦ string - List of configuration channel labels to remove.

Returns:


API Documentation | Chapter 823. Method: removeChannels 930 / 1066

Chapter 824. Method:scheduleApplyConfigChannelDescription:


Parameters:


• int serverId



Returns:

• int actionId

API Documentation | Chapter 824. Method: scheduleApplyConfigChannel 931 / 1066

Chapter 825. Method: setChannelsDescription:

Replace the existing set of config channels on the given servers. Channels are ranked according

to their order in the configChannelLabels array.

Parameters:


• array :

◦ int - IDs of the systems to set the channels on.

• array :


Returns:


API Documentation | Chapter 825. Method: setChannels 932 / 1066

system.custominfo


Chapter 826. Available methods• createKey

• deleteKey

• listAllKeys

• updateKey


Chapter 827. DescriptionProvides methods to access and modify custom system information.

Namespace:

system.custominfo


Chapter 828. Method: createKeyDescription:

Create a new custom key

Parameters:


• string keyLabel - new key’s label

• string keyDescription - new key’s description

Returns:


API Documentation | Chapter 828. Method: createKey 936 / 1066

Chapter 829. Method: deleteKeyDescription:

Delete an existing custom key and all systems' values for the key.

Parameters:


• string keyLabel - new key’s label

Returns:


API Documentation | Chapter 829. Method: deleteKey 937 / 1066

Chapter 830. Method: listAllKeysDescription:

List the custom information keys defined for the user’s organization.

Parameters:


Returns:

• array :

• struct - custom info

◦ int "id"

◦ string "label"




API Documentation | Chapter 830. Method: listAllKeys 938 / 1066

Chapter 831. Method: updateKeyDescription:

Update description of a custom key

Parameters:


• string keyLabel - key to change

• string keyDescription - new key’s description

Returns:


API Documentation | Chapter 831. Method: updateKey 939 / 1066

system.monitoring


Chapter 832. Available methods• listEndpoints


Chapter 833. DescriptionProvides methods to access information about managed systems, applications and formulas

which can be relevant for Prometheus monitoring

Namespace:

system.monitoring


Chapter 834. Method: listEndpointsDescription:

Get the list of monitoring endpoint details.

Parameters:


• array :

◦ int - systemID

Returns:

• array :

• struct - endpoint_info

◦ int "system_id"

◦ string "endpoint_name"

◦ string "exporter_name"

◦ string "module"

◦ string "path"

◦ int "port"

◦ bool "tls_enabled"

API Documentation | Chapter 834. Method: listEndpoints 943 / 1066

system.provisioning.snapshot


Chapter 835. Available methods• addTagToSnapshot

• deleteSnapshot

• deleteSnapshots

• deleteSnapshots

• listSnapshotConfigFiles

• listSnapshotPackages

• listSnapshots

• rollbackToSnapshot

• rollbackToTag

• rollbackToTag


Chapter 836. DescriptionProvides methods to access and delete system snapshots.

Namespace:

system.provisioning.snapshot


Chapter 837. Method: addTagToSnapshotDescription:

Adds tag to snapshot

Parameters:


• int snapshotId - Id of the snapshot

• string tag - Name of the snapshot tag

Returns:


API Documentation | Chapter 837. Method: addTagToSnapshot 947 / 1066

Chapter 838. Method: deleteSnapshotDescription:

Deletes a snapshot with the given snapshot id

Parameters:


• int snapshotId - Id of snapshot to delete

Returns:



API Documentation | Chapter 838. Method: deleteSnapshot 948 / 1066

Chapter 839. Method: deleteSnapshotsDescription:

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 afterthe date provided will be removed.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, all snapshots will beremoved.

Parameters:


• struct - date details

◦ dateTime.iso8601 "startDate" - Optional, unless endDate is provided.

◦ dateTime.iso8601 "endDate" - Optional.

Returns:



API Documentation | Chapter 839. Method: deleteSnapshots 949 / 1066

Chapter 840. Method: deleteSnapshotsDescription:

Deletes all snapshots for a given system based on the date criteria. For example,

If the user provides startDate only, all snapshots created either on or afterthe date provided will be removed.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, all snapshots associatedwith the server will be removed.

Parameters:


• int sid - system id of system to delete snapshots for




Returns:



API Documentation | Chapter 840. Method: deleteSnapshots 950 / 1066

Chapter 841. Method: listSnapshotConfigFilesDescription:

List the config files associated with a snapshot.

Parameters:


• int snapId

Returns:

• array :


◦ string "type"

◦ file

◦ directory

◦ symlink





attribute)









API Documentation | Chapter 841. Method: listSnapshotConfigFiles 951 / 1066





only.


only.


API Documentation | Chapter 841. Method: listSnapshotConfigFiles 952 / 1066

Chapter 842. Method: listSnapshotPackagesDescription:

List the packages associated with a snapshot.

Parameters:


• int snapId

Returns:

• array :

• struct - package nvera

◦ string "name"

◦ string "epoch"



◦ string "arch"


API Documentation | Chapter 842. Method: listSnapshotPackages 953 / 1066

Chapter 843. Method: listSnapshotsDescription:

List snapshots for a given system. A user may optionally provide a start and end date to narrow

the snapshots that will be listed. For example,

If the user provides startDate only, all snapshots created either on or afterthe date provided will be returned.If user provides startDate and endDate, all snapshots created on or between thedates provided will be returned.If the user doesn't provide a startDate and endDate, all snapshots associatedwith the server will be returned.

Parameters:


• int serverId




Returns:

• array :

• struct - server snapshot

◦ int "id"

◦ string "reason" - the reason for the snapshot’s existence


◦ array "channels"

▪ string - labels of channels associated with the snapshot

◦ array "groups"

▪ string - Names of server groups associated with the snapshot


API Documentation | Chapter 843. Method: listSnapshots 954 / 1066

▪ string - Names of system entitlements associated with the snapshot

◦ array "config_channels"

▪ string - Labels of config channels the snapshot is associated with.

◦ array "tags"

▪ string - Tag names associated with this snapshot.

◦ string "Invalid_reason" - If the snapshot is invalid, this is the reason (optional).


API Documentation | Chapter 843. Method: listSnapshots 955 / 1066

Chapter 844. Method: rollbackToSnapshotDescription:

Rollbacks server to snapshot

Parameters:


• int serverId

• int snapshotId - Id of the snapshot

Returns:


API Documentation | Chapter 844. Method: rollbackToSnapshot 956 / 1066

Chapter 845. Method: rollbackToTagDescription:


Parameters:


• int serverId

• string tagName - Name of the snapshot tag

Returns:


API Documentation | Chapter 845. Method: rollbackToTag 957 / 1066

Chapter 846. Method: rollbackToTagDescription:


Parameters:


• string tagName - Name of the snapshot tag

Returns:


API Documentation | Chapter 846. Method: rollbackToTag 958 / 1066

system.scap


Chapter 847. Available methods• deleteXccdfScan

• getXccdfScanDetails

• getXccdfScanRuleResults

• listXccdfScans

• scheduleXccdfScan






Chapter 848. DescriptionProvides methods to schedule SCAP scans and access the results.

Namespace:

system.scap


Chapter 849. Method: deleteXccdfScanDescription:

Delete OpenSCAP XCCDF Scan from the Uyuni database. Note that only those SCAP Scans can be

deleted which have passed their retention period.

Parameters:


• int Id of XCCDF scan (xid).

Returns:

• boolean status - indicates success of the operation

API Documentation | Chapter 849. Method: deleteXccdfScan 962 / 1066

Chapter 850. Method: getXccdfScanDetailsDescription:

Get details of given OpenSCAP XCCDF scan.

Parameters:



Returns:

• * struct - OpenSCAP XCCDF Scan

◦ int "xid" - XCCDF TestResult id

◦ int "sid" - serverId

◦ int "action_id" - Id of the parent action.

◦ string "path" - Path to XCCDF document

◦ string "ovalfiles" - Optional OVAL Files

◦ string "oscap_parameters" - oscap command-line arguments.

◦ string "test_result" - Identifier of XCCDF TestResult.

◦ string "benchmark" - Identifier of XCCDF Benchmark.

◦ string "benchmark_version" - Version of the Benchmark.

◦ string "profile" - Identifier of XCCDF Profile.

◦ string "profile_title" - Title of XCCDF Profile.

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

API Documentation | Chapter 850. Method: getXccdfScanDetails 963 / 1066

Chapter 851. Method:getXccdfScanRuleResultsDescription:

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

Parameters:



Returns:

• array :

• struct - OpenSCAP XCCDF RuleResult

◦ string "idref" - idref from XCCDF document.

◦ string "result" - Result of evaluation.

◦ string "idents" - Comma separated list of XCCDF idents.

API Documentation | Chapter 851. Method: getXccdfScanRuleResults 964 / 1066

Chapter 852. Method: listXccdfScansDescription:

Return a list of finished OpenSCAP scans for a given system.

Parameters:


• int serverId

Returns:

• array :

• struct - OpenSCAP XCCDF Scan

◦ int "xid" - XCCDF TestResult ID

◦ string "profile" - XCCDF Profile

◦ string "path" - Path to XCCDF document

◦ string "ovalfiles" - Optional OVAL files

◦ dateTime.iso8601 "completed" - Scan completion time

API Documentation | Chapter 852. Method: listXccdfScans 965 / 1066

Chapter 853. Method: scheduleXccdfScanDescription:

Schedule OpenSCAP scan.

Parameters:


• array :

◦ int - serverId

• string Path to xccdf content on targeted systems.

• string Additional parameters for oscap tool.

Returns:

• int id - ID if SCAP action created

API Documentation | Chapter 853. Method: scheduleXccdfScan 966 / 1066



Parameters:


• array :

◦ int - serverId




Returns:





Parameters:


• array :

◦ int - serverId



• string Additional OVAL files for oscap tool.


Returns:




Schedule Scap XCCDF scan.

Parameters:


• int serverId

• string Path to xccdf content on targeted system.


Returns:

• int id - ID of the scap action created



Schedule Scap XCCDF scan.

Parameters:


• int serverId

• string Path to xccdf content on targeted system.



Returns:

• int id - ID of the scap action created


system.search


Chapter 858. Available methods• deviceDescription

• deviceDriver

• deviceId

• deviceVendorId

• hostname

• ip

• nameAndDescription

• uuid


Chapter 859. DescriptionProvides methods to perform system search requests using the search server.

Namespace:

system.search


Chapter 860. Method: deviceDescriptionDescription:

List the systems which match the device description.

Parameters:


• string searchTerm

Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"



◦ 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

API Documentation | Chapter 860. Method: deviceDescription 974 / 1066

Chapter 861. Method: deviceDriverDescription:

List the systems which match this device driver.

Parameters:



Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"



◦ string "ip"





API Documentation | Chapter 861. Method: deviceDriver 975 / 1066

Chapter 862. Method: deviceIdDescription:

List the systems which match this device id

Parameters:



Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"



◦ string "ip"





API Documentation | Chapter 862. Method: deviceId 976 / 1066

Chapter 863. Method: deviceVendorIdDescription:

List the systems which match this device vendor_id

Parameters:



Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"



◦ string "ip"





API Documentation | Chapter 863. Method: deviceVendorId 977 / 1066

Chapter 864. Method: hostnameDescription:

List the systems which match this hostname

Parameters:



Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"



◦ string "ip"





API Documentation | Chapter 864. Method: hostname 978 / 1066

Chapter 865. Method: ipDescription:

List the systems which match this ip.

Parameters:



Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"



◦ string "ip"





API Documentation | Chapter 865. Method: ip 979 / 1066

Chapter 866. Method: nameAndDescriptionDescription:

List the systems which match this name or description

Parameters:



Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"



◦ string "ip"





API Documentation | Chapter 866. Method: nameAndDescription 980 / 1066

Chapter 867. Method: uuidDescription:

List the systems which match this UUID

Parameters:



Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"



◦ string "ip"





API Documentation | Chapter 867. Method: uuid 981 / 1066

systemgroup


Chapter 868. Available methods• addOrRemoveAdmins

• addOrRemoveSystems

• create

• delete

• getDetails

• getDetails

• listActiveSystemsInGroup

• listAdministrators

• listAllGroups

• listAssignedConfigChannels

• listAssignedFormuals

• listGroupsWithNoAssociatedAdmins

• listInactiveSystemsInGroup

• listInactiveSystemsInGroup

• listSystems

• listSystemsMinimal

• scheduleApplyErrataToActive



• subscribeConfigChannel

• unsubscribeConfigChannel

• update


Chapter 869. DescriptionProvides methods to access and modify system groups.

Namespace:

systemgroup


Chapter 870. Method: addOrRemoveAdminsDescription:

Add or remove administrators to/from the given group. Uyuni and Organization administrators

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 an organization administrator.

Parameters:


• string systemGroupName

• array :

◦ string - loginName - User’s loginName

• int add - 1 to add administrators, 0 to remove.

Returns:


API Documentation | Chapter 870. Method: addOrRemoveAdmins 985 / 1066

Chapter 871. Method: addOrRemoveSystemsDescription:

Add/remove the given servers to a system group.

Parameters:



• array :

◦ int - serverId

• boolean add - True to add to the group, False to remove.

Returns:


API Documentation | Chapter 871. Method: addOrRemoveSystems 986 / 1066


Create a new system group.

Parameters:


• string name - Name of the system group.

• string description - Description of the system group.

Returns:

• * struct - Server Group

◦ int "id"

◦ string "name"


◦ int "org_id"




Delete a system group.

Parameters:



Returns:




Retrieve details of a ServerGroup based on it’s id

Parameters:



Returns:


◦ int "id"

◦ string "name"


◦ int "org_id"




Retrieve details of a ServerGroup based on it’s name

Parameters:



Returns:


◦ int "id"

◦ string "name"


◦ int "org_id"



Chapter 876. Method:listActiveSystemsInGroupDescription:

Lists active systems within a server group

Parameters:



Returns:

• array :

◦ int - server_id

API Documentation | Chapter 876. Method: listActiveSystemsInGroup 991 / 1066

Chapter 877. Method: listAdministratorsDescription:

Returns the list of users who can administer the given group. Caller must be a system group

admin or an organization administrator.

Parameters:



Returns:

• array :

• struct - user

◦ int "id"

◦ string "login"



API Documentation | Chapter 877. Method: listAdministrators 992 / 1066

Chapter 878. Method: listAllGroupsDescription:

Retrieve a list of system groups that are accessible by the logged in user.

Parameters:


Returns:

• array :


◦ int "id"

◦ string "name"


◦ int "org_id"


API Documentation | Chapter 878. Method: listAllGroups 993 / 1066

Chapter 879. Method:listAssignedConfigChannelsDescription:

List all Configuration Channels assigned to a system group

Parameters:



Returns:

• array :


◦ int "id"

◦ int "orgId"

◦ string "label"

◦ string "name"




◦ int "id"

◦ string "label"

◦ string "name"

◦ int "priority"


API Documentation | Chapter 879. Method: listAssignedConfigChannels 994 / 1066

Chapter 880. Method: listAssignedFormualsDescription:

List all Configuration Channels assigned to a system group

Parameters:



Returns:

• array :

• struct - formula

◦ string "name"


◦ string "formula_group"


API Documentation | Chapter 880. Method: listAssignedFormuals 995 / 1066

Chapter 881. Method:listGroupsWithNoAssociatedAdminsDescription:

Returns a list of system groups that do not have an administrator. (who is not an organization

administrator, as they have implicit access to system groups) Caller must be an organization

administrator.

Parameters:


Returns:

• array :


◦ int "id"

◦ string "name"


◦ int "org_id"


API Documentation | Chapter 881. Method: listGroupsWithNoAssociatedAdmins 996 / 1066

Chapter 882. Method:listInactiveSystemsInGroupDescription:

Lists inactive systems within a server group using a specified inactivity time.

Parameters:



• int daysInactive - Number of days a system must not check in to be considered inactive.

Returns:

• array :

◦ int - server_id

API Documentation | Chapter 882. Method: listInactiveSystemsInGroup 997 / 1066

Chapter 883. Method:listInactiveSystemsInGroupDescription:

Lists inactive systems within a server group using the default 1 day threshold.

Parameters:



Returns:

• array :

◦ int - server_id

API Documentation | Chapter 883. Method: listInactiveSystemsInGroup 998 / 1066

Chapter 884. Method: listSystemsDescription:

Return a list of systems associated with this system group. User must have access to this system

group.

Parameters:



Returns:

• array :

• struct - server details

◦ int "id" - System id

◦ string "profile_name"

◦ string "machine_id"


◦ string "base_entitlement" - System’s base entitlement label

◦ 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, 5Server



◦ string "city"

◦ string "state"




◦ string "room"

◦ string "rack"



◦ dateTime.iso8601 "last_boot"

◦ string "osa_status" - Either 'unknown', 'offline', or 'online'.

◦ boolean "lock_status" - True indicates that the system is locked. False indicates that the

system is unlocked.

◦ string "virtualization" - Virtualization type - for virtual guests only (optional)


◦ default

◦ ssh-push

◦ ssh-push-tunnel


Chapter 885. Method: listSystemsMinimalDescription:

Return a list of systems associated with this system group. User must have access to this system

group.

Parameters:



Returns:

• array :

• struct - system

◦ int "id"

◦ string "name"






API Documentation | Chapter 885. Method: listSystemsMinimal 1001 / 1066

Chapter 886. Method:scheduleApplyErrataToActiveDescription:

Schedules an action to apply errata updates to active systems from a group.

Parameters:



• array :

◦ int - errataId

Returns:

• array :

◦ int - actionId


API Documentation | Chapter 886. Method: scheduleApplyErrataToActive 1002 / 1066


Schedules an action to apply errata updates to active systems from a group at a given

date/time.

Parameters:



• array :

◦ int - errataId


Returns:

• array :

◦ int - actionId



Chapter 889. Method:subscribeConfigChannelDescription:

Subscribe given config channels to a system group

Parameters:



• array :

◦ string - configChannelLabels

Returns:


API Documentation | Chapter 889. Method: subscribeConfigChannel 1005 / 1066

Chapter 890. Method:unsubscribeConfigChannelDescription:

Unsubscribe given config channels to a system group

Parameters:



• array :

◦ string - configChannelLabels

Returns:


API Documentation | Chapter 890. Method: unsubscribeConfigChannel 1006 / 1066


Update an existing system group.

Parameters:




Returns:


◦ int "id"

◦ string "name"


◦ int "org_id"



user


Chapter 892. Available methods• addAssignedSystemGroup

• addAssignedSystemGroups

• addDefaultSystemGroup

• addDefaultSystemGroups

• addRole

• create

• create

• delete

• disable

• enable

• getCreateDefaultSystemGroup

• getDetails

• listAssignableRoles

• listAssignedSystemGroups

• listDefaultSystemGroups

• listRoles

• listUsers

• removeAssignedSystemGroup

• removeAssignedSystemGroups

• removeDefaultSystemGroup

• removeDefaultSystemGroups

• removeRole

• setCreateDefaultSystemGroup

• setDetails

• setErrataNotifications


• setReadOnly

• usePamAuthentication


Chapter 893. DescriptionUser namespace contains methods to access common user functions available from the web

user interface.

Namespace:

user


Chapter 894. Method:addAssignedSystemGroupDescription:

Add system group to user’s list of assigned system groups.

Parameters:



• string serverGroupName

• boolean setDefault - Should system group also be added to user’s list of default system

groups.

Returns:


API Documentation | Chapter 894. Method: addAssignedSystemGroup 1012 / 1066

Chapter 895. Method:addAssignedSystemGroupsDescription:

Add system groups to user’s list of assigned system groups.

Parameters:



• array :

◦ string - serverGroupName

• boolean setDefault - Should system groups also be added to user’s list of default system

groups.

Returns:


API Documentation | Chapter 895. Method: addAssignedSystemGroups 1013 / 1066

Chapter 896. Method:addDefaultSystemGroupDescription:

Add system group to user’s list of default system groups.

Parameters:




Returns:


API Documentation | Chapter 896. Method: addDefaultSystemGroup 1014 / 1066

Chapter 897. Method:addDefaultSystemGroupsDescription:

Add system groups to user’s list of default system groups.

Parameters:



• array :


Returns:


API Documentation | Chapter 897. Method: addDefaultSystemGroups 1015 / 1066

Chapter 898. Method: addRoleDescription:

Adds a role to a user.

Parameters:


• string login - User login name to update.

• string role - Role label to add. Can be any of: satellite_admin, org_admin, channel_admin,

config_admin, system_group_admin, or activation_key_admin.

Returns:


API Documentation | Chapter 898. Method: addRole 1016 / 1066


Create a new user.

Parameters:


• string desiredLogin - Desired login name, will fail if already in use.

• string desiredPassword

• string firstName

• string lastName

• string email - User’s e-mail address.

Returns:




Create a new user.

Parameters:


• string desiredLogin - Desired login name, will fail if already in use.

• string desiredPassword

• string firstName

• string lastName

• string email - User’s e-mail address.

• int usePamAuth - 1 if you wish to use PAM authentication for this user, 0 otherwise.

Returns:




Delete a user.

Parameters:


• string login - User login name to delete.

Returns:



Chapter 902. Method: disableDescription:

Disable a user.

Parameters:


• string login - User login name to disable.

Returns:


API Documentation | Chapter 902. Method: disable 1020 / 1066

Chapter 903. Method: enableDescription:

Enable a user.

Parameters:


• string login - User login name to enable.

Returns:


API Documentation | Chapter 903. Method: enable 1021 / 1066

Chapter 904. Method:getCreateDefaultSystemGroupDescription:

Returns the current value of the CreateDefaultSystemGroup setting. If True this will cause there to

be a 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 group being

set as the default group for the user (so every time the user registers a system it will be placed in

that system group by default). This can be useful if different users will administer different groups

of servers in the same organization. Can only be called by an org_admin.

Parameters:


Returns:


API Documentation | Chapter 904. Method: getCreateDefaultSystemGroup 1022 / 1066


Returns the details about a given user.

Parameters:



Returns:

• struct - user details

◦ string "first_names" - deprecated, use first_name

◦ string "first_name"

◦ string "last_name"

◦ string "email"

◦ int "org_id"

◦ string "org_name"

◦ string "prefix"

◦ string "last_login_date"

◦ string "created_date"


◦ boolean "use_pam" - true if user is configured to use PAM authentication

◦ boolean "read_only" - true if user is readonly

◦ boolean "errata_notification" - true if errata e-mail notification is enabled for the user


Chapter 906. Method: listAssignableRolesDescription:

Returns a list of user roles that this user can assign to others.

Parameters:


Returns:

• array :

◦ string - (role label)

API Documentation | Chapter 906. Method: listAssignableRoles 1024 / 1066

Chapter 907. Method:listAssignedSystemGroupsDescription:

Returns the system groups that a user can administer.

Parameters:



Returns:

• array :


▪ int "id"

▪ string "name"


▪ int "system_count"

▪ int "org_id" - Organization ID for this system group.

API Documentation | Chapter 907. Method: listAssignedSystemGroups 1025 / 1066

Chapter 908. Method:listDefaultSystemGroupsDescription:

Returns a user’s list of default system groups.

Parameters:



Returns:

• array :


▪ int "id"

▪ string "name"


▪ int "system_count"

▪ int "org_id" - Organization ID for this system group.

API Documentation | Chapter 908. Method: listDefaultSystemGroups 1026 / 1066

Chapter 909. Method: listRolesDescription:

Returns a list of the user’s roles.

Parameters:



Returns:

• array :

◦ string - (role label)

API Documentation | Chapter 909. Method: listRoles 1027 / 1066

Chapter 910. Method: listUsersDescription:

Returns a list of users in your organization.

Parameters:


Returns:

• array :

• struct - user

◦ int "id"

◦ string "login"



API Documentation | Chapter 910. Method: listUsers 1028 / 1066

Chapter 911. Method:removeAssignedSystemGroupDescription:

Remove system group from the user’s list of assigned system groups.

Parameters:




• boolean setDefault - Should system group also be removed from the user’s list of default

system groups.

Returns:


API Documentation | Chapter 911. Method: removeAssignedSystemGroup 1029 / 1066

Chapter 912. Method:removeAssignedSystemGroupsDescription:

Remove system groups from a user’s list of assigned system groups.

Parameters:



• array :


• boolean setDefault - Should system groups also be removed from the user’s list of default

system groups.

Returns:


API Documentation | Chapter 912. Method: removeAssignedSystemGroups 1030 / 1066

Chapter 913. Method:removeDefaultSystemGroupDescription:

Remove a system group from user’s list of default system groups.

Parameters:




Returns:


API Documentation | Chapter 913. Method: removeDefaultSystemGroup 1031 / 1066

Chapter 914. Method:removeDefaultSystemGroupsDescription:

Remove system groups from a user’s list of default system groups.

Parameters:



• array :


Returns:


API Documentation | Chapter 914. Method: removeDefaultSystemGroups 1032 / 1066

Chapter 915. Method: removeRoleDescription:

Remove a role from a user.

Parameters:


• string login - User login name to update.

• string role - Role label to remove. Can be any of: satellite_admin, org_admin,

channel_admin, config_admin, system_group_admin, or activation_key_admin.

Returns:


API Documentation | Chapter 915. Method: removeRole 1033 / 1066

Chapter 916. Method:setCreateDefaultSystemGroupDescription:

Sets the value of the CreateDefaultSystemGroup setting. If True this will cause there to be a

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 group being set as

the default group for the user (so every time the user registers a system it will be placed in that

system group by default). This can be useful if different users will administer different groups of

servers in the same organization. Can only be called by an org_admin.

Parameters:


• boolean createDefaultSystemGruop - True if we should automatically create system groups,

false otherwise.

Returns:


API Documentation | Chapter 916. Method: setCreateDefaultSystemGroup 1034 / 1066


Updates the details of a user.

Parameters:



• struct - user details

◦ string "first_names" - deprecated, use first_name

◦ string "first_name"

◦ string "last_name"

◦ string "email"

◦ string "prefix"


Returns:



Chapter 918. Method: setErrataNotificationsDescription:

Enables/disables errata mail notifications for a specific user.

Parameters:



• boolean value - True for enabling errata notifications, False for disabling

Returns:


API Documentation | Chapter 918. Method: setErrataNotifications 1036 / 1066

Chapter 919. Method: setReadOnlyDescription:

Sets whether the target user should have only read-only API access or standard full scale access.

Parameters:



• boolean readOnly - Sets whether the target user should have only read-only API access or

standard full scale access.

Returns:


API Documentation | Chapter 919. Method: setReadOnly 1037 / 1066

Chapter 920. Method: usePamAuthenticationDescription:

Toggles whether or not a user uses PAM authentication or basic Uyuni authentication.

Parameters:



• int pam_value

• 1 to enable PAM authentication

• 0 to disable.

Returns:


API Documentation | Chapter 920. Method: usePamAuthentication 1038 / 1066

user.external


Chapter 921. Available methods• createExternalGroupToRoleMap

• createExternalGroupToSystemGroupMap

• deleteExternalGroupToRoleMap

• deleteExternalGroupToSystemGroupMap

• getDefaultOrg

• getExternalGroupToRoleMap

• getExternalGroupToSystemGroupMap

• getKeepTemporaryRoles

• getUseOrgUnit

• listExternalGroupToRoleMaps

• listExternalGroupToSystemGroupMaps

• setDefaultOrg

• setExternalGroupRoles

• setExternalGroupSystemGroups

• setKeepTemporaryRoles

• setUseOrgUnit


Chapter 922. DescriptionIf you are using IPA integration to allow authentication of users from an external IPA server (rare)

the users will still need to be created in the Uyuni database. Methods in this namespace allow

you to configure some specifics of how this happens, like what organization they are created in

or what roles they will have. These options can also be set in the web admin interface.

Namespace:

user.external


Chapter 923. Method:createExternalGroupToRoleMapDescription:

Externally authenticated users may be members of external groups. You can use these groups to

assign additional roles to the users when they log in. Can only be called by a Uyuni Administrator.

Parameters:


• string name - Name of the external group. Must be unique.

• array :

◦ string - role - Can be any of: satellite_admin, org_admin (implies all other roles except

for satellite_admin), channel_admin, config_admin, system_group_admin, or

activation_key_admin.

Returns:

• * struct - externalGroup

◦ string "name"

◦ array "roles"

▪ string - role

API Documentation | Chapter 923. Method: createExternalGroupToRoleMap 1042 / 1066

Chapter 924. Method:createExternalGroupToSystemGroupMapDescription:

Externally authenticated users may be members of external groups. You can use these groups to

give access to server groups to the users when they log in. Can only be called by an org_admin.

Parameters:


• string name - Name of the external group. Must be unique.

• array :

◦ string - groupName - The names of the server groups to grant access to.

Returns:


◦ string "name"

◦ array "roles"

▪ string - role

API Documentation | Chapter 924. Method: createExternalGroupToSystemGroupMap 1043 / 1066

Chapter 925. Method:deleteExternalGroupToRoleMapDescription:

Delete the role map for an external group. Can only be called by a Uyuni Administrator.

Parameters:


• string name - Name of the external group.

Returns:


API Documentation | Chapter 925. Method: deleteExternalGroupToRoleMap 1044 / 1066

Chapter 926. Method:deleteExternalGroupToSystemGroupMapDescription:

Delete the server group map for an external group. Can only be called by an org_admin.

Parameters:



Returns:


API Documentation | Chapter 926. Method: deleteExternalGroupToSystemGroupMap 1045 / 1066

Chapter 927. Method: getDefaultOrgDescription:

Get the default org that users should be added in if orgunit from IPA server isn’t found or is

disabled. Can only be called by a Uyuni Administrator.

Parameters:


Returns:

• int id - Id of the default organization. 0 if there is no default

API Documentation | Chapter 927. Method: getDefaultOrg 1046 / 1066

Chapter 928. Method:getExternalGroupToRoleMapDescription:

Get a representation of the role mapping for an external group. Can only be called by a Uyuni

Administrator.

Parameters:



Returns:


◦ string "name"

◦ array "roles"

▪ string - role

API Documentation | Chapter 928. Method: getExternalGroupToRoleMap 1047 / 1066

Chapter 929. Method:getExternalGroupToSystemGroupMapDescription:

Get a representation of the server group mapping for an external group. Can only be called by an

org_admin.

Parameters:



Returns:


◦ string "name"

◦ array "roles"

▪ string - role

API Documentation | Chapter 929. Method: getExternalGroupToSystemGroupMap 1048 / 1066

Chapter 930. Method:getKeepTemporaryRolesDescription:

Get whether we should keeps roles assigned to users because of their IPA groups even after they

log in through a non-IPA method. Can only be called by a Uyuni Administrator.

Parameters:


Returns:

• boolean keep - True if we should keep roles after users log in through non-IPA method, false

otherwise

API Documentation | Chapter 930. Method: getKeepTemporaryRoles 1049 / 1066

Chapter 931. Method: getUseOrgUnitDescription:

Get whether we place users into the organization that corresponds to the "orgunit" set on the IPA

server. The orgunit name must match exactly the Uyuni organization name. Can only be called

by a Uyuni Administrator.

Parameters:


Returns:

• boolean use - True if we should use the IPA orgunit to determine which organization to

create the user in, false otherwise

API Documentation | Chapter 931. Method: getUseOrgUnit 1050 / 1066

Chapter 932. Method:listExternalGroupToRoleMapsDescription:

List role mappings for all known external groups. Can only be called by a Uyuni Administrator.

Parameters:


Returns:

• array :

• struct - externalGroup

◦ string "name"

◦ array "roles"

▪ string - role

API Documentation | Chapter 932. Method: listExternalGroupToRoleMaps 1051 / 1066

Chapter 933. Method:listExternalGroupToSystemGroupMapsDescription:

List server group mappings for all known external groups. Can only be called by an org_admin.

Parameters:


Returns:

• array :

• struct - externalGroup

◦ string "name"

◦ array "roles"

▪ string - role

API Documentation | Chapter 933. Method: listExternalGroupToSystemGroupMaps 1052 / 1066

Chapter 934. Method: setDefaultOrgDescription:

Set the default org that users should be added in if orgunit from IPA server isn’t found or is

disabled. Can only be called by a Uyuni Administrator.

Parameters:


• int defaultOrg - Id of the organization to set as the default org. 0 if there should not be a

default organization.

Returns:


API Documentation | Chapter 934. Method: setDefaultOrg 1053 / 1066

Chapter 935. Method: setExternalGroupRolesDescription:

Update the roles for an external group. Replace previously set roles with the ones passed in here.

Can only be called by a Uyuni Administrator.

Parameters:



• array :

◦ string - role - Can be any of: satellite_admin, org_admin (implies all other roles except

for satellite_admin), channel_admin, config_admin, system_group_admin, or

activation_key_admin.

Returns:


API Documentation | Chapter 935. Method: setExternalGroupRoles 1054 / 1066

Chapter 936. Method:setExternalGroupSystemGroupsDescription:

Update the server groups for an external group. Replace previously set server groups with the

ones passed in here. Can only be called by an org_admin.

Parameters:



• array :

◦ string - groupName - The names of the server groups to grant access to.

Returns:


API Documentation | Chapter 936. Method: setExternalGroupSystemGroups 1055 / 1066

Chapter 937. Method: setKeepTemporaryRolesDescription:

Set whether we should keeps roles assigned to users because of their IPA groups even after they

log in through a non-IPA method. Can only be called by a Uyuni Administrator.

Parameters:


• boolean keepRoles - True if we should keep roles after users log in through non-IPA method,

false otherwise.

Returns:


API Documentation | Chapter 937. Method: setKeepTemporaryRoles 1056 / 1066

Chapter 938. Method: setUseOrgUnitDescription:

Set whether we place users into the organization that corresponds to the "orgunit" set on the IPA

server. The orgunit name must match exactly the Uyuni organization name. Can only be called

by a Uyuni Administrator.

Parameters:


• boolean useOrgUnit - True if we should use the IPA orgunit to determine which organization

to create the user in, false otherwise.

Returns:


API Documentation | Chapter 938. Method: setUseOrgUnit 1057 / 1066

virtualhostmanager



• delete

• getDetail

• getModuleParameters

• listAvailableVirtualHostGathererModules

• listVirtualHostManagers


Chapter 940. DescriptionProvides the namespace for the Virtual Host Manager methods.

Namespace:

virtualhostmanager



Creates a Virtual Host Manager from given arguments

Parameters:


• string label - Virtual Host Manager label

• string moduleName - the name of the Gatherer module

• parameters parameters - additional parameters (credentials, parameters for virtual-host-

gatherer)

Returns:




Deletes a Virtual Host Manager with a given label

Parameters:



Returns:



Chapter 943. Method: getDetailDescription:

Gets details of a Virtual Host Manager with a given label

Parameters:



Returns:

• * struct - virtual host manager

◦ string "label"

◦ int "org_id"

◦ string "gatherer_module"

◦ struct "configs"

API Documentation | Chapter 943. Method: getDetail 1063 / 1066

Chapter 944. Method: getModuleParametersDescription:

Get a list of parameters for a virtual-host-gatherer module. It returns a map of parameters with

their typical default values.

Parameters:


• string moduleName - The name of the module

Returns:

• map module_params - module parameters

API Documentation | Chapter 944. Method: getModuleParameters 1064 / 1066

Chapter 945. Method:listAvailableVirtualHostGathererModulesDescription:

List all available modules from virtual-host-gatherer

Parameters:


Returns:

• array :

◦ string - moduleName

API Documentation | Chapter 945. Method: listAvailableVirtualHostGathererModules 1065 / 1066

Chapter 946. Method: listVirtualHostManagersDescription:

Lists Virtual Host Managers visible to a user

Parameters:


Returns:

• array :

• struct - virtual host manager

◦ string "label"

◦ int "org_id"

◦ string "gatherer_module"

◦ struct "configs"

API Documentation | Chapter 946. Method: listVirtualHostManagers 1066 / 1066

api documentation: suse manager 4

Documents