Red Hat Satellite API Documentation

activationkey

(Return to Handler List)

Available methods

Description

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

Namespace: activationkey


Method: addChildChannels

Description:
Add child channels to an activation key.

Parameters:

Returns:


Method: addConfigChannels

Description:
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:

Returns:


Method: addEntitlements

Description:
Add entitlements to an activation key. Currently only add-on entitlements are permitted. (monitoring_entitled, provisioning_entitled, virtualization_host, virtualization_host_platform)

Parameters:

Returns:


Method: addPackageNames

Description:
Add packages to an activation key using package name only.

Deprecated - being replaced by addPackages(string sessionKey, string key, array[packages])

Parameters:

Returns:

Available since: 10.2


Method: addPackages

Description:
Add packages to an activation key.

Parameters:

Returns:


Method: addServerGroups

Description:
Add server groups to an activation key.

Parameters:

Returns:


Method: checkConfigDeployment

Description:
Check configuration file deployment status for the activation key specified.

Parameters:

Returns:


Method: create

Description:
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 with the 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 no usage limit argument.

Parameters:

Returns:


Method: create

Description:
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 with the ID 100, the actual activation key will be "100-foo".

Parameters:

Returns:


Method: delete

Description:
Delete an activation key.

Parameters:

Returns:


Method: disableConfigDeployment

Description:
Disable configuration file deployment for the specified activation key.

Parameters:

Returns:


Method: enableConfigDeployment

Description:
Enable configuration file deployment for the specified activation key.

Parameters:

Returns:


Method: getDetails

Description:
Lookup an activation key's details.

Parameters:

Returns:

Available since: 10.2


Method: listActivatedSystems

Description:
List the systems activated with the key provided.

Parameters:

Returns:


Method: listActivationKeys

Description:
List activation keys that are visible to the user.

Parameters:

Returns:

Available since: 10.2


Method: listConfigChannels

Description:
List configuration channels associated to an activation key.

Parameters:

Returns:


Method: removeChildChannels

Description:
Remove child channels from an activation key.

Parameters:

Returns:


Method: removeConfigChannels

Description:
Remove configuration channels from the given activation keys.

Parameters:

Returns:


Method: removeEntitlements

Description:
Remove entitlements (by label) from an activation key. Currently only add-on entitlements are permitted. (monitoring_entitled, provisioning_entitled, virtualization_host, virtualization_host_platform)

Parameters:

Returns:


Method: removePackageNames

Description:
Remove package names from an activation key.

Deprecated - being replaced by removePackages(string sessionKey, string key, array[packages])

Parameters:

Returns:

Available since: 10.2


Method: removePackages

Description:
Remove package names from an activation key.

Parameters:

Returns:


Method: removeServerGroups

Description:
Remove server groups from an activation key.

Parameters:

Returns:


Method: setConfigChannels

Description:
Replace the existing set of configuration channels on the given activation keys. Channels are ranked by their order in the array.

Parameters:

Returns:


Method: setDetails

Description:
Update the details of an activation key.

Parameters:

Returns:


api

(Return to Handler List)

Available methods

Description

Methods providing information about the API.

Namespace: api


Method: getApiCallList

Description:
Lists all available api calls grouped by namespace

Parameters:

Returns:


Method: getApiNamespaceCallList

Description:
Lists all available api calls for the specified namespace

Parameters:

Returns:


Method: getApiNamespaces

Description:
Lists available API namespaces

Parameters:

Returns:


Method: getVersion

Description:
Returns the version of the API. Since Spacewalk 0.4 (Satellie 5.3) it is no more related to server version.

Parameters:

Returns:


Method: systemVersion

Description:
Returns the server version.

Parameters:

Returns:


auth

(Return to Handler List)

Available methods

Description

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

Namespace: auth


Method: login

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

Parameters:

Returns:


Method: login

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

Parameters:

Returns:


Method: logout

Description:
Logout the user with the given session key.

Parameters:

Returns:


channel

(Return to Handler List)

Available methods

Description

Provides method to get back a list of Software Channels.

Namespace: channel


Method: listAllChannels

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

Parameters:

Returns:


Method: listMyChannels

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

Parameters:

Returns:


Method: listPopularChannels

Description:
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:

Returns:


Method: listRedHatChannels

Description:
List all Red Hat software channels that the user's organization is entitled to.

Deprecated - being replaced by listVendorChannels(String sessionKey)

Parameters:

Returns:


Method: listRetiredChannels

Description:
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:


Method: listSharedChannels

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

Parameters:

Returns:


Method: listSoftwareChannels

Description:
List all visible software channels.

Parameters:

Returns:


Method: listVendorChannels

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

Parameters:

Returns:


channel.access

(Return to Handler List)

Available methods

Description

Provides methods to retrieve and alter channel access restrictions.

Namespace: channel.access


Method: disableUserRestrictions

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

Parameters:

Returns:


Method: enableUserRestrictions

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

Parameters:

Returns:


Method: getOrgSharing

Description:
Get organization sharing access control.

Parameters:

Returns:


Method: setOrgSharing

Description:
Set organization sharing access control.

Parameters:

Returns:


channel.org

(Return to Handler List)

Available methods

Description

Provides methods to retrieve and alter organization trust relationships for a channel.

Namespace: channel.org


Method: disableAccess

Description:
Disable access to the channel for the given organization.

Parameters:

Returns:


Method: enableAccess

Description:
Enable access to the channel for the given organization.

Parameters:

Returns:


Method: list

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

Parameters:

Returns:


channel.software

(Return to Handler List)

Available methods

Description

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

Namespace: channel.software


Method: addPackages

Description:
Adds a given list of packages to the given channel.

Parameters:

Returns:


Method: associateRepo

Description:
Associates a repository with a channel

Parameters:

Returns:


Method: availableEntitlements

Description:
Returns the number of available subscriptions for the given channel

Parameters:

Returns:


Method: clone

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

Parameters:

Returns:


Method: create

Description:
Creates a software channel

Parameters:

Returns:

Available since: 10.9


Method: create

Description:
Creates a software channel

Parameters:

Returns:

Available since: 10.9


Method: create

Description:
Creates a software channel

Parameters:

Returns:


Method: createRepo

Description:
Creates a repository

Parameters:

Returns:


Method: delete

Description:
Deletes a custom software channel

Parameters:

Returns:


Method: disassociateRepo

Description:
Disassociates a repository from a channel

Parameters:

Returns:


Method: getChannelLastBuildById

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

Parameters:

Returns:


Method: getDetails

Description:
Returns details of the given channel as a map

Parameters:

Returns:


Method: getDetails

Description:
Returns details of the given channel as a map

Parameters:

Returns:


Method: getRepoDetails

Description:
Returns details of the given repository

Parameters:

Returns:


Method: getRepoDetails

Description:
Returns details of the given repo

Parameters:

Returns:


Method: getRepoSyncCronExpression

Description:
Returns repo synchronization cron expression

Parameters:

Returns:


Method: isGloballySubscribable

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

Parameters:

Returns:


Method: isUserManageable

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

Parameters:

Returns:


Method: isUserSubscribable

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

Parameters:

Returns:


Method: listAllPackages

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

Parameters:

Returns:


Method: listAllPackages

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

Parameters:

Returns:


Method: listAllPackages

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

Parameters:

Returns:


Method: listAllPackages

Description:
Lists all packages in the channel, regardless of package version, between the given dates. Example Date: '2008-08-20 08:00:00'

Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601 endDate)

Parameters:

Returns:


Method: listAllPackages

Description:
Lists all packages in the channel, regardless of version whose last modified date is greater than given date. Example Date: '2008-08-20 08:00:00'

Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate)

Parameters:

Returns:


Method: listAllPackagesByDate

Description:
Lists all packages in the channel, regardless of the package version, between the given dates. Example Date: '2008-08-20 08:00:00'

Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601 endDate)

Parameters:

Returns:


Method: listAllPackagesByDate

Description:
Lists all packages in the channel, regardless of the package version, whose last modified date is greater than given date. Example Date: '2008-08-20 08:00:00'

Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate)

Parameters:

Returns:


Method: listAllPackagesByDate

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

Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel)

Parameters:

Returns:


Method: listArches

Description:
Lists the potential software channel architectures that can be created

Parameters:

Returns:


Method: listChannelRepos

Description:
Lists associated repos with the given channel

Parameters:

Returns:


Method: listChildren

Description:
List the children of a channel

Parameters:

Returns:


Method: listErrata

Description:
List the errata applicable to a channel after given startDate

Parameters:

Returns:


Method: listErrata

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

Parameters:

Returns:


Method: listErrata

Description:
List the errata applicable to a channel

Parameters:

Returns:


Method: listErrata

Description:
List the errata applicable to a channel after given startDate

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

Parameters:

Returns:


Method: listErrata

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

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

Parameters:

Returns:


Method: listErrataByType

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

Parameters:

Returns:


Method: listLatestPackages

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

Parameters:

Returns:


Method: listPackagesWithoutChannel

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

Parameters:

Returns:


Method: listSubscribedSystems

Description:
Returns list of subscribed systems for the given channel label

Parameters:

Returns:


Method: listSystemChannels

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

Parameters:

Returns:


Method: listUserRepos

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

Parameters:

Returns:


Method: mergeErrata

Description:
Merges all errata from one channel into another

Parameters:

Returns:


Method: mergeErrata

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

Parameters:

Returns:


Method: mergeErrata

Description:
Merges a list of errata from one channel into another

Parameters:

Returns:


Method: mergePackages

Description:
Merges all packages from one channel into another

Parameters:

Returns:


Method: regenerateNeededCache

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

Parameters:

Returns:


Method: regenerateNeededCache

Description:
Completely clear and regenerate the needed Errata and Package cache for all systems subscribed. You must be a Satellite Admin to perform this action.

Parameters:

Returns:


Method: regenerateYumCache

Description:
Regenerate yum cache for the specified channel.

Parameters:

Returns:


Method: removeErrata

Description:
Removes a given list of errata from the given channel.

Parameters:

Returns:


Method: removePackages

Description:
Removes a given list of packages from the given channel.

Parameters:

Returns:


Method: removeRepo

Description:
Removes a repository

Parameters:

Returns:


Method: removeRepo

Description:
Removes a repository

Parameters:

Returns:


Method: setContactDetails

Description:
Set contact/support information for given channel.

Parameters:

Returns:


Method: setDetails

Description:
Allows to modify channel attributes

Parameters:

Returns:


Method: setGloballySubscribable

Description:
Set globally subscribable attribute for given channel.

Parameters:

Returns:


Method: setSystemChannels

Description:
Change a systems subscribed channels to the list of channels passed in.

Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string channelLabel) and system.setChildChannels(string sessionKey, int serverId, array[string channelLabel])

Parameters:

Returns:


Method: setUserManageable

Description:
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:

Returns:


Method: setUserSubscribable

Description:
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:

Returns:


Method: subscribeSystem

Description:
Subscribes a system to a list of channels. If a base channel is included, that is set before setting child channels. When setting child channels the current child channel subscriptions are cleared. To fully unsubscribe the system from all channels, simply provide an empty list of channel labels.

Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string channelLabel) and system.setChildChannels(string sessionKey, int serverId, array[string channelLabel])

Parameters:

Returns:


Method: syncRepo

Description:
Trigger immediate repo synchronization

Parameters:

Returns:


Method: syncRepo

Description:
Schedule periodic repo synchronization

Parameters:

Returns:


Method: updateRepo

Description:
Updates a ContentSource (repo)

Parameters:

Returns:


Method: updateRepoLabel

Description:
Updates repository label

Parameters:

Returns:


Method: updateRepoUrl

Description:
Updates repository source URL

Parameters:

Returns:


Method: updateRepoUrl

Description:
Updates repository source URL

Parameters:

Returns:


configchannel

(Return to Handler List)

Available methods

Description

Provides methods to access and modify many aspects of configuration channels.

Namespace: configchannel


Method: channelExists

Description:
Check for the existence of the config channel provided.

Parameters:

Returns:


Method: create

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

Parameters:

Returns:


Method: createOrUpdatePath

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

Parameters:

Returns:

Available since: 10.2


Method: createOrUpdateSymlink

Description:
Create a new symbolic link with the given path, or update an existing path.

Parameters:

Returns:

Available since: 10.2


Method: deleteChannels

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

Parameters:

Returns:


Method: deleteFileRevisions

Description:
Delete specified revisions of a given configuration file

Parameters:

Returns:


Method: deleteFiles

Description:
Remove file paths from a global channel.

Parameters:

Returns:


Method: deployAllSystems

Description:
Schedule an immediate configuration deployment for all systems subscribed to a particular configuration channel.

Parameters:

Returns:


Method: deployAllSystems

Description:
Schedule a configuration deployment for all systems subscribed to a particular configuration channel.

Parameters:

Returns:


Method: getDetails

Description:
Lookup config channel details.

Parameters:

Returns:


Method: getDetails

Description:
Lookup config channel details.

Parameters:

Returns:


Method: getEncodedFileRevision

Description:
Get revision of the specified config file

Parameters:

Returns:


Method: getFileRevision

Description:
Get revision of the specified config file

Parameters:

Returns:


Method: getFileRevisions

Description:
Get list of revisions for specified config file

Parameters:

Returns:


Method: listFiles

Description:
Return a list of files in a channel.

Parameters:

Returns:


Method: listGlobals

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

Parameters:

Returns:


Method: listSubscribedSystems

Description:
Return a list of systems subscribed to a configuration channel

Parameters:

Returns:


Method: lookupChannelInfo

Description:
Lists details on a list channels given their channel labels.

Parameters:

Returns:


Method: lookupFileInfo

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

Parameters:

Returns:

Available since: 10.2


Method: lookupFileInfo

Description:
Given a path, revision number, and a channel, returns details about the latest revisions of the paths.

Parameters:

Returns:

Available since: 10.12


Method: scheduleFileComparisons

Description:
Schedule a comparison of the latest revision of a file against the version deployed on a list of systems.

Parameters:

Returns:


Method: update

Description:
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:


distchannel

(Return to Handler List)

Available methods

Description

Provides methods to access and modify distribution channel information

Namespace: distchannel


Method: listDefaultMaps

Description:
Lists the default distribution channel maps defined per satellite

Parameters:

Returns:


Method: setDefaultMap

Description:
Sets (/removes if channelLabel empty) a default distribution channel map

Parameters:

Returns:


errata

(Return to Handler List)

Available methods

Description

Provides methods to access and modify errata.

Namespace: errata


Method: addPackages

Description:
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:

Returns:


Method: applicableToChannels

Description:
Returns a list of channels applicable to the erratum with the given advisory name.

Parameters:

Returns:


Method: bugzillaFixes

Description:
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"

Parameters:

Returns:


Method: clone

Description:
Clone a list of errata into the specified channel.

Parameters:

Returns:


Method: cloneAsOriginal

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

Parameters:

Returns:


Method: cloneAsOriginalAsync

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

Parameters:

Returns:


Method: cloneAsync

Description:
Asynchronously clone a list of errata into the specified channel.

Parameters:

Returns:


Method: create

Description:
Create a custom errata. If "publish" is set to true, the errata will be published as well

Parameters:

Returns:


Method: delete

Description:
Delete an erratum. This method will only allow for deletion of custom errata created either through the UI or API.

Parameters:

Returns:


Method: findByCve

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

Parameters:

Returns:


Method: getDetails

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

Parameters:

Returns:


Method: listAffectedSystems

Description:
Return the list of systems affected by the erratum with advisory name.

Parameters:

Returns:


Method: listByDate

Description:
List errata that have been applied to a particular channel by date.

Deprecated - being replaced by channel.software.listErrata(string sessionKey, string channelLabel)

Parameters:

Returns:


Method: listCves

Description:
Returns a list of CVEs applicable to the erratum with the given advisory name.

Parameters:

Returns:


Method: listKeywords

Description:
Get the keywords associated with an erratum matching the given advisory name.

Parameters:

Returns:


Method: listPackages

Description:
Returns a list of the packages affected by the erratum with the given advisory name.

Parameters:

Returns:


Method: listUnpublishedErrata

Description:
Returns a list of unpublished errata

Parameters:

Returns:


Method: publish

Description:
Publish an existing (unpublished) errata to a set of channels.

Parameters:

Returns:


Method: publishAsOriginal

Description:
Publishes an existing (unpublished) cloned errata to a set of cloned channels according to its original erratum

Parameters:

Returns:


Method: removePackages

Description:
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:

Returns:


Method: setDetails

Description:
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:

Returns:


kickstart

(Return to Handler List)

Available methods

Description

Provides methods to create kickstart files

Namespace: kickstart


Method: cloneProfile

Description:
Clone a Kickstart Profile

Parameters:

Returns:


Method: createProfile

Description:
Import a kickstart profile into RHN.

Parameters:

Returns:


Method: createProfileWithCustomUrl

Description:
Import a kickstart profile into RHN.

Parameters:

Returns:


Method: deleteProfile

Description:
Delete a kickstart profile

Parameters:

Returns:


Method: disableProfile

Description:
Enable/Disable a Kickstart Profile

Parameters:

Returns:


Method: findKickstartForIp

Description:
Find an associated kickstart for a given ip address.

Parameters:

Returns:


Method: importFile

Description:
Import a kickstart profile into RHN.

Parameters:

Returns:


Method: importFile

Description:
Import a kickstart profile into RHN.

Parameters:

Returns:


Method: importRawFile

Description:
Import a raw kickstart file into satellite.

Parameters:

Returns:


Method: isProfileDisabled

Description:
Returns whether a kickstart profile is disabled

Parameters:

Returns:


Method: listAllIpRanges

Description:
List all Ip Ranges and their associated kickstarts available in the user's org.

Parameters:

Returns:


Method: listKickstartableChannels

Description:
List kickstartable channels for the logged in user.

Parameters:

Returns:


Method: listKickstartableTrees

Description:
List the available kickstartable trees for the given channel.

Deprecated - being replaced by kickstart.tree.list(string sessionKey, string channelLabel)

Parameters:

Returns:


Method: listKickstarts

Description:
Provides a list of kickstart profiles visible to the user's org

Parameters:

Returns:


Method: renameProfile

Description:
Rename a Kickstart Tree (Distribution) in Satellite

Parameters:

Returns:


kickstart.filepreservation

(Return to Handler List)

Available methods

Description

Provides methods to retrieve and manipulate kickstart file preservation lists.

Namespace: kickstart.filepreservation


Method: create

Description:
Create a new file preservation list.

Parameters:

Returns:


Method: delete

Description:
Delete a file preservation list.

Parameters:

Returns:


Method: getDetails

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

Parameters:

Returns:


Method: listAllFilePreservations

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

Parameters:

Returns:


kickstart.keys

(Return to Handler List)

Available methods

Description

Provides methods to manipulate kickstart keys.

Namespace: kickstart.keys


Method: create

Description:
creates a new key with the given parameters

Parameters:

Returns:


Method: delete

Description:
deletes the key identified by the given parameters

Parameters:

Returns:


Method: getDetails

Description:
returns all of the data associated with the given key

Parameters:

Returns:


Method: listAllKeys

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

Parameters:

Returns:


Method: update

Description:
Updates type and content of the key identified by the description

Parameters:

Returns:


kickstart.profile

(Return to Handler List)

Available methods

Description

Provides methods to access and modify many aspects of a kickstart profile.

Namespace: kickstart.profile


Method: addIpRange

Description:
Add an ip range to a kickstart profile.

Parameters:

Returns:


Method: addScript

Description:
Add a pre/post script to a kickstart profile.

Parameters:

Returns:


Method: addScript

Description:
Add a pre/post script to a kickstart profile.

Parameters:

Returns:


Method: compareActivationKeys

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

Parameters:

Returns:


Method: compareAdvancedOptions

Description:
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:


Method: comparePackages

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

Parameters:

Returns:


Method: downloadKickstart

Description:
Download the full contents of a kickstart file.

Parameters:

Returns:


Method: downloadRenderedKickstart

Description:
Downloads the Cobbler-rendered Kickstart file.

Parameters:

Returns:


Method: getAdvancedOptions

Description:
Get advanced options for a kickstart profile.

Parameters:

Returns:


Method: getCfgPreservation

Description:
Get ks.cfg preservation option for a kickstart profile.

Parameters:

Returns:


Method: getChildChannels

Description:
Get the child channels for a kickstart profile.

Parameters:

Returns:


Method: getCustomOptions

Description:
Get custom options for a kickstart profile.

Parameters:

Returns:


Method: getKickstartTree

Description:
Get the kickstart tree for a kickstart profile.

Parameters:

Returns:


Method: getVariables

Description:
Returns a list of variables associated with the specified kickstart profile

Parameters:

Returns:


Method: listIpRanges

Description:
List all ip ranges for a kickstart profile.

Parameters:

Returns:


Method: listScripts

Description:
List the pre and post scripts for a kickstart profile. profile

Parameters:

Returns:


Method: removeIpRange

Description:
Remove an ip range from a kickstart profile.

Parameters:

Returns:


Method: removeScript

Description:
Remove a script from a kickstart profile.

Parameters:

Returns:


Method: setAdvancedOptions

Description:
Set advanced options for a kickstart profile.

Parameters:

Returns:


Method: setCfgPreservation

Description:
Set ks.cfg preservation option for a kickstart profile.

Parameters:

Returns:


Method: setChildChannels

Description:
Set the child channels for a kickstart profile.

Parameters:

Returns:


Method: setCustomOptions

Description:
Set custom options for a kickstart profile.

Parameters:

Returns:


Method: setKickstartTree

Description:
Set the kickstart tree for a kickstart profile.

Parameters:

Returns:


Method: setLogging

Description:
Set logging options for a kickstart profile.

Parameters:

Returns:


Method: setVariables

Description:
Associates list of kickstart variables with the specified kickstart profile

Parameters:

Returns:


kickstart.profile.keys

(Return to Handler List)

Available methods

Description

Provides methods to access and modify the list of activation keys associated with a kickstart profile.

Namespace: kickstart.profile.keys


Method: addActivationKey

Description:
Add an activation key association to the kickstart profile

Parameters:

Returns:


Method: getActivationKeys

Description:
Lookup the activation keys associated with the kickstart profile.

Parameters:

Returns:


Method: removeActivationKey

Description:
Remove an activation key association from the kickstart profile

Parameters:

Returns:


kickstart.profile.software

(Return to Handler List)

Available methods

Description

Provides methods to access and modify the software list associated with a kickstart profile.

Namespace: kickstart.profile.software


Method: appendToSoftwareList

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

Parameters:

Returns:


Method: getSoftwareList

Description:
Get a list of a kickstart profile's software packages.

Parameters:

Returns:


Method: setSoftwareList

Description:
Set the list of software packages for a kickstart profile.

Parameters:

Returns:


kickstart.profile.system

(Return to Handler List)

Available methods

Description

Provides methods to set various properties of a kickstart profile.

Namespace: kickstart.profile.system


Method: addFilePreservations

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

Parameters:

Returns:


Method: addKeys

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

Parameters:

Returns:


Method: checkConfigManagement

Description:
Check the configuration management status for a kickstart profile.

Parameters:

Returns:


Method: checkRemoteCommands

Description:
Check the remote commands status flag for a kickstart profile.

Parameters:

Returns:


Method: disableConfigManagement

Description:
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:


Method: disableRemoteCommands

Description:
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:


Method: enableConfigManagement

Description:
Enables the configuration management flag in a kickstart profile so that a system created using this profile will be configuration capable.

Parameters:

Returns:


Method: enableRemoteCommands

Description:
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:


Method: getLocale

Description:
Retrieves the locale for a kickstart profile.

Parameters:

Returns:


Method: getPartitioningScheme

Description:
Get the partitioning scheme for a kickstart profile.

Parameters:

Returns:


Method: getRegistrationType

Description:
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:


Method: getSELinux

Description:
Retrieves the SELinux enforcing mode property of a kickstart profile.

Parameters:

Returns:


Method: listFilePreservations

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

Parameters:

Returns:


Method: listKeys

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

Parameters:

Returns:


Method: removeFilePreservations

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

Parameters:

Returns:


Method: removeKeys

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

Parameters:

Returns:


Method: setLocale

Description:
Sets the locale for a kickstart profile.

Parameters:

Returns:


Method: setPartitioningScheme

Description:
Set the partitioning scheme for a kickstart profile.

Parameters:

Returns:


Method: setRegistrationType

Description:
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:

Returns:


Method: setSELinux

Description:
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:

Returns:


kickstart.snippet

(Return to Handler List)

Available methods

Description

Provides methods to create kickstart files

Namespace: kickstart.snippet


Method: createOrUpdate

Description:
Will create a snippet with the given name and contents if it doesn't exist. If it does exist, the existing snippet will be updated.

Parameters:

Returns:


Method: delete

Description:
Delete the specified snippet. If the snippet is not found, 0 is returned.

Parameters:

Returns:


Method: listAll

Description:
List all cobbler snippets for the logged in user

Parameters:

Returns:


Method: listCustom

Description:
List only custom snippets for the logged in user. These snipppets are editable.

Parameters:

Returns:


Method: listDefault

Description:
List only pre-made default snippets for the logged in user. These snipppets are not editable.

Parameters:

Returns:


kickstart.tree

(Return to Handler List)

Available methods

Description

Provides methods to access and modify the kickstart trees.

Namespace: kickstart.tree


Method: create

Description:
Create a Kickstart Tree (Distribution) in Satellite.

Parameters:

Returns:


Method: delete

Description:
Delete a Kickstart Tree (Distribution) in Satellite.

Parameters:

Returns:


Method: deleteTreeAndProfiles

Description:
Delete a kickstarttree and any profiles associated with this kickstart tree. WARNING: This will delete all profiles associated with this kickstart tree!

Parameters:

Returns:


Method: getDetails

Description:
The detailed information about a kickstartable tree given the tree name.

Parameters:

Returns:


Method: list

Description:
List the available kickstartable trees for the given channel.

Parameters:

Returns:


Method: listInstallTypes

Description:
List the available kickstartable install types (rhel2,3,4,5 and fedora9+).

Parameters:

Returns:


Method: rename

Description:
Rename a Kickstart Tree (Distribution) in Satellite.

Parameters:

Returns:


Method: update

Description:
Edit a Kickstart Tree (Distribution) in Satellite.

Parameters:

Returns:


org

(Return to Handler List)

Available methods

Description

Contains methods to access common organization management functions available from the web interface.

Namespace: org


Method: create

Description:
Create a new organization and associated administrator account.

Parameters:

Returns:


Method: delete

Description:
Delete an organization. The default organization (i.e. orgId=1) cannot be deleted.

Parameters:

Returns:


Method: getDetails

Description:
The detailed information about an organization given the organization ID.

Parameters:

Returns:


Method: getDetails

Description:
The detailed information about an organization given the organization name.

Parameters:

Returns:


Method: listOrgs

Description:
Returns the list of organizations.

Parameters:

Returns:


Method: listSoftwareEntitlements

Description:
List software entitlement allocation information across all organizations. Caller must be a satellite administrator.

Parameters:

Returns:


Method: listSoftwareEntitlements

Description:
List each organization's allocation of a given software entitlement. Organizations with no allocation will not be present in the list. A value of -1 indicates unlimited entitlements.

Deprecated - being replaced by listSoftwareEntitlements(string sessionKey, string label, boolean includeUnentitled)

Parameters:

Returns:


Method: listSoftwareEntitlements

Description:
List each organization's allocation of a given software entitlement. A value of -1 indicates unlimited entitlements.

Parameters:

Returns:

Available since: 10.4


Method: listSoftwareEntitlementsForOrg

Description:
List an organization's allocation of each software entitlement. A value of -1 indicates unlimited entitlements.

Parameters:

Returns:


Method: listSystemEntitlements

Description:
Lists system entitlement allocation information across all organizations. Caller must be a satellite administrator.

Parameters:

Returns:


Method: listSystemEntitlements

Description:
List each organization's allocation of a system entitlement. If the organization has no allocation for a particular entitlement, it will not appear in the list.

Deprecated - being replaced by listSystemEntitlements(string sessionKey, string label, boolean includeUnentitled)

Parameters:

Returns:


Method: listSystemEntitlements

Description:
List each organization's allocation of a system entitlement.

Parameters:

Returns:

Available since: 10.4


Method: listSystemEntitlementsForOrg

Description:
List an organization's allocation of each system entitlement.

Parameters:

Returns:


Method: listUsers

Description:
Returns the list of users in a given organization.

Parameters:

Returns:


Method: migrateSystems

Description:
Migrate systems from one organization to another. If executed by a Satellite administrator, the systems will be migrated 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 migrated to the organization specified by the toOrgId. In any scenario, the origination and destination organizations must be defined in a trust.

Parameters:

Returns:


Method: setSoftwareEntitlements

Description:
Set an organization's entitlement allocation for the given software entitlement. If increasing the entitlement allocation, the default organization (i.e. orgId=1) must have a sufficient number of free entitlements.

Parameters:

Returns:


Method: setSoftwareFlexEntitlements

Description:
Set an organization's flex entitlement allocation for the given software entitlement. If increasing the flex entitlement allocation, the default organization (i.e. orgId=1) must have a sufficient number of free flex entitlements.

Parameters:

Returns:


Method: setSystemEntitlements

Description:
Set an organization's entitlement allocation for the given software entitlement. If increasing the entitlement allocation, the default organization (i.e. orgId=1) must have a sufficient number of free entitlements.

Parameters:

Returns:


Method: updateName

Description:
Updates the name of an organization

Parameters:

Returns:


org.trusts

(Return to Handler List)

Available methods

Description

Contains methods to access common organization trust information available from the web interface.

Namespace: org.trusts


Method: addTrust

Description:
Add an organization to the list of trusted organizations.

Parameters:

Returns:


Method: getDetails

Description:
The trust details about an organization given the organization's ID.

Parameters:

Returns:


Method: listChannelsConsumed

Description:
Lists all software channels that the organization given may consume from the user's organization.

Parameters:

Returns:


Method: listChannelsProvided

Description:
Lists all software channels that the organization given is providing to the user's organization.

Parameters:

Returns:


Method: listOrgs

Description:
List all organanizations trusted by the user's organization.

Parameters:

Returns:


Method: listSystemsAffected

Description:
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:

Returns:


Method: listTrusts

Description:
Returns the list of trusted organizations.

Parameters:

Returns:


Method: removeTrust

Description:
Remove an organization to the list of trusted organizations.

Parameters:

Returns:


packages

(Return to Handler List)

Available methods

Description

Methods to retrieve information about the Packages contained within this server.

Namespace: packages


Method: findByNvrea

Description:
Lookup the details for packages with the given name, version, release, architecture label, and (optionally) epoch.

Parameters:

Returns:


Method: getDetails

Description:
Retrieve details for the package with the ID.

Parameters:

Returns:


Method: getPackage

Description:
Retrieve the package file associated with a package.

Parameters:

Returns:


Method: getPackageUrl

Description:
Retrieve the url that can be used to download a package. This will expire after a certain time period.

Parameters:

Returns:


Method: listChangelog

Description:
List the change log for a package.

Parameters:

Returns:


Method: listDependencies

Description:
List the dependencies for a package.

Parameters:

Returns:


Method: listFiles

Description:
List the files associated with a package.

Parameters:

Returns:


Method: listProvidingChannels

Description:
List the channels that provide the a package.

Parameters:

Returns:


Method: listProvidingErrata

Description:
List the errata providing the a package.

Parameters:

Returns:


Method: removePackage

Description:
Remove a package from the satellite.

Parameters:

Returns:


packages.provider

(Return to Handler List)

Available methods

Description

Methods to retrieve information about Package Providers associated with packages.

Namespace: packages.provider


Method: associateKey

Description:
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 Satellite administrator.

Parameters:

Returns:


Method: list

Description:
List all Package Providers. User executing the request must be a Satellite administrator.

Parameters:

Returns:


Method: listKeys

Description:
List all security keys associated with a package provider. User executing the request must be a Satellite administrator.

Parameters:

Returns:


packages.search

(Return to Handler List)

Available methods

Description

Methods to interface to package search capabilities in search server..

Namespace: packages.search


Method: advanced

Description:
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, summary
Lucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"

Parameters:

Returns:


Method: advancedWithActKey

Description:
Advanced method to search lucene indexes with a passed in query written in Lucene Query 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 lucene.apache.org.
Fields searchable for Packages: name, epoch, version, release, arch, description, summary
Lucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"

Parameters:

Returns:


Method: advancedWithChannel

Description:
Advanced method to search lucene indexes with a passed in query written in Lucene Query 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 lucene.apache.org.
Fields searchable for Packages: name, epoch, version, release, arch, description, summary
Lucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"

Parameters:

Returns:


Method: name

Description:
Search the lucene package indexes for all packages which match the given name.

Parameters:

Returns:


Method: nameAndDescription

Description:
Search the lucene package indexes for all packages which match the given query in name or description

Parameters:

Returns:


Method: nameAndSummary

Description:
Search the lucene package indexes for all packages which match the given query in name or summary.

Parameters:

Returns:


preferences.locale

(Return to Handler List)

Available methods

Description

Provides methods to access and modify user locale information

Namespace: preferences.locale


Method: listLocales

Description:
Returns a list of all understood locales. Can be used as input to setLocale.

Parameters:

Returns:


Method: listTimeZones

Description:
Returns a list of all understood timezones. Results can be used as input to setTimeZone.

Parameters:

Returns:


Method: setLocale

Description:
Set a user's locale.

Parameters:

Returns:


Method: setTimeZone

Description:
Set a user's timezone.

Parameters:

Returns:


proxy

(Return to Handler List)

Available methods

Description

Provides methods to activate/deactivate a proxy server.

Namespace: proxy


Method: activateProxy

Description:
Activates the proxy identified by the given client certificate i.e. systemid file.

Parameters:

Returns:


Method: createMonitoringScout

Description:
Create Monitoring Scout for proxy.

Parameters:

Returns:

Available since: 10.7


Method: deactivateProxy

Description:
Deactivates the proxy identified by the given client certificate i.e. systemid file.

Parameters:

Returns:


Method: isProxy

Description:
Test, if the system identified by the given client certificate i.e. systemid file, is proxy.

Parameters:

Returns:


Method: listAvailableProxyChannels

Description:
List available version of proxy channel for system identified by the given client certificate i.e. systemid file.

Parameters:

Returns:

Available since: 10.5


satellite

(Return to Handler List)

Available methods

Description

Provides methods to obtain details on the Satellite.

Namespace: satellite


Method: getCertificateExpirationDate

Description:
Retrieves the certificate expiration date of the activated certificate.

Parameters:

Returns:


Method: isMonitoringEnabled

Description:
Indicates if monitoring is enabled on the satellite

Parameters:

Returns:


Method: isMonitoringEnabledBySystemId

Description:
Indicates if monitoring is enabled on the satellite

Parameters:

Returns:


Method: listEntitlements

Description:
Lists all channel and system entitlements for the organization associated with the user executing the request.

Parameters:

Returns:


Method: listProxies

Description:
List the proxies within the user's organization.

Parameters:

Returns:


schedule

(Return to Handler List)

Available methods

Description

Methods to retrieve information about scheduled actions.

Namespace: schedule


Method: archiveActions

Description:
Archive all actions in the given list.

Parameters:

Returns:


Method: cancelActions

Description:
Cancel all actions in given list. If an invalid action is provided, none of the actions given will canceled.

Parameters:

Returns:


Method: listAllActions

Description:
Returns a list of all actions. This includes completed, in progress, failed and archived actions.

Parameters:

Returns:


Method: listArchivedActions

Description:
Returns a list of actions that have been archived.

Parameters:

Returns:


Method: listCompletedActions

Description:
Returns a list of actions that have completed successfully.

Parameters:

Returns:


Method: listCompletedSystems

Description:
Returns a list of systems that have completed a specific action.

Parameters:

Returns:


Method: listFailedActions

Description:
Returns a list of actions that have failed.

Parameters:

Returns:


Method: listFailedSystems

Description:
Returns a list of systems that have failed a specific action.

Parameters:

Returns:


Method: listInProgressActions

Description:
Returns a list of actions that are in progress.

Parameters:

Returns:


Method: listInProgressSystems

Description:
Returns a list of systems that have a specific action in progress.

Parameters:

Returns:


Method: rescheduleActions

Description:
Reschedule all actions in the given list.

Parameters:

Returns:


system

(Return to Handler List)

Available methods

Description

Provides methods to access and modify registered system.

Namespace: system


Method: addEntitlements

Description:
Add addon entitlements to a server. Entitlements a server already has are quietly ignored.

Parameters:

Returns:


Method: addNote

Description:
Add a new note to the given server.

Parameters:

Returns:


Method: applyErrata

Description:
Schedules an action to apply errata updates to a system.

Deprecated - being replaced by system.scheduleApplyErrata(string sessionKey, int serverId, array[int errataId])

Parameters:

Returns:


Method: comparePackageProfile

Description:
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:

Returns:


Method: comparePackages

Description:
Compares the packages installed on two systems.

Parameters:

Returns:


Method: convertToFlexEntitlement

Description:
Converts the given list of systems for a given channel family to use the flex entitlement.

Parameters:

Returns:


Method: createPackageProfile

Description:
Create a new stored Package Profile from a systems installed package list.

Parameters:

Returns:


Method: createSystemRecord

Description:
Creates a cobbler system record with the specified kickstart label

Parameters:

Returns:


Method: deleteCustomValues

Description:
Delete the custom values defined for the custom system information keys provided from the given system.

Parameters:

Returns:


Method: deleteGuestProfiles

Description:
Delete the specified list of guest profiles for a given host

Parameters:

Returns:


Method: deleteNote

Description:
Deletes the given note from the server.

Parameters:

Returns:


Method: deleteNotes

Description:
Deletes all notes from the server.

Parameters:

Returns:


Method: deletePackageProfile

Description:
Delete a package profile

Parameters:

Returns:


Method: deleteSystem

Description:
Delete a system given its cilent certificate.

Parameters:

Returns:

Available since: 10.10


Method: deleteSystems

Description:
Delete systems given a list of system ids.

Parameters:

Returns:


Method: deleteTagFromSnapshot

Description:
Deletes tag from system snapshot

Parameters:

Returns:


Method: downloadSystemId

Description:
Get the system ID file for a given server.

Parameters:

Returns:


Method: getConnectionPath

Description:
Get the list of proxies that the given system connects through in order to reach the server.

Parameters:

Returns:


Method: getCpu

Description:
Gets the CPU information of a system.

Parameters:

Returns:


Method: getCustomValues

Description:
Get the custom data values defined for the server.

Parameters:

Returns:


Method: getDetails

Description:
Get system details.

Parameters:

Returns:


Method: getDevices

Description:
Gets a list of devices for a system.

Parameters:

Returns:


Method: getDmi

Description:
Gets the DMI information of a system.

Parameters:

Returns:


Method: getEntitlements

Description:
Gets the entitlements for a given server.

Parameters:

Returns:


Method: getEventHistory

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.

Parameters:

Returns:


Method: getId

Description:
Get system IDs and last check in information for the given system name.

Parameters:

Returns:


Method: getMemory

Description:
Gets the memory information for a system.

Parameters:

Returns:


Method: getName

Description:
Get system name and last check in information for the given system ID.

Parameters:

Returns:


Method: getNetwork

Description:
Get the addresses and hostname for a given server.

Parameters:

Returns:


Method: getNetworkDevices

Description:
Returns the network devices for the given server.

Parameters:

Returns:


Method: getRegistrationDate

Description:
Returns the date the system was registered.

Parameters:

Returns:


Method: getRelevantErrata

Description:
Returns a list of all errata that are relevant to the system.

Parameters:

Returns:


Method: getRelevantErrataByType

Description:
Returns a list of all errata of the specified type that are relevant to the system.

Parameters:

Returns:


Method: getRunningKernel

Description:
Returns the running kernel of the given system.

Parameters:

Returns:


Method: getScriptActionDetails

Description:
Returns script details for script run actions

Parameters:

Returns:


Method: getScriptResults

Description:
Fetch results from a script execution. Returns an empty array if no results are yet available.

Parameters:

Returns:


Method: getSubscribedBaseChannel

Description:
Provides the base channel of a given system

Parameters:

Returns:


Method: getSystemCurrencyMultipliers

Description:
Get the System Currency score multipliers

Parameters:

Returns:


Method: getSystemCurrencyScores

Description:
Get the System Currency score multipliers

Parameters:

Returns:


Method: getUnscheduledErrata

Description:
Provides an array of errata that are applicable to a given system.

Parameters:

Returns:


Method: getUuid

Description:
Get the UUID from the given system ID.

Parameters:

Returns:


Method: getVariables

Description:
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 to System -> <Specified System> -> Provisioning -> Select a Kickstart profile -> Create Cobbler System Record.

Parameters:

Returns:


Method: isNvreInstalled

Description:
Check if the package with the given NVRE is installed on given system.

Parameters:

Returns:


Method: isNvreInstalled

Description:
Is the package with the given NVRE installed on given system.

Parameters:

Returns:


Method: listActivationKeys

Description:
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:

Returns:


Method: listActiveSystems

Description:
Returns a list of active servers visible to the user.

Parameters:

Returns:


Method: listAdministrators

Description:
Returns a list of users which can administer the system.

Parameters:

Returns:


Method: listBaseChannels

Description:
Returns a list of subscribable base channels.

Deprecated - being replaced by listSubscribableBaseChannels(string sessionKey, int serverId)

Parameters:

Returns:


Method: listChildChannels

Description:
Returns a list of subscribable child channels. This only shows channels the system is *not* currently subscribed to.

Deprecated - being replaced by listSubscribableChildChannels(string sessionKey, int serverId)

Parameters:

Returns:


Method: listDuplicatesByHostname

Description:
List duplicate systems by Hostname.

Parameters:

Returns:


Method: listDuplicatesByIp

Description:
List duplicate systems by IP Address.

Parameters:

Returns:


Method: listDuplicatesByMac

Description:
List duplicate systems by Mac Address.

Parameters:

Returns:


Method: listEligibleFlexGuests

Description:
List eligible flex guests accessible to the user

Parameters:

Returns:


Method: listFlexGuests

Description:
List flex guests accessible to the user

Parameters:

Returns:


Method: listGroups

Description:
List the available groups for a given system.

Parameters:

Returns:


Method: listInactiveSystems

Description:
Lists systems that have been inactive for the default period of inactivity

Parameters:

Returns:


Method: listInactiveSystems

Description:
Lists systems that have been inactive for the specified number of days..

Parameters:

Returns:


Method: listLatestAvailablePackage

Description:
Get the latest available version of a package for each system

Parameters:

Returns:


Method: listLatestInstallablePackages

Description:
Get the list of latest installable packages for a given system.

Parameters:

Returns:


Method: listLatestUpgradablePackages

Description:
Get the list of latest upgradable packages for a given system.

Parameters:

Returns:


Method: listNewerInstalledPackages

Description:
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:

Returns:


Method: listNotes

Description:
Provides a list of notes associated with a system.

Parameters:

Returns:


Method: listOlderInstalledPackages

Description:
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:

Returns:


Method: listOutOfDateSystems

Description:
Returns list of systems needing package updates.

Parameters:

Returns:


Method: listPackageProfiles

Description:
List the package profiles in this organization

Parameters:

Returns:


Method: listPackages

Description:
List the installed packages for a given system. The attribute installtime is returned since API version 10.10.

Parameters:

Returns:


Method: listPackagesFromChannel

Description:
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:

Returns:


Method: listSubscribableBaseChannels

Description:
Returns a list of subscribable base channels.

Parameters:

Returns:


Method: listSubscribableChildChannels

Description:
Returns a list of subscribable child channels. This only shows channels the system is *not* currently subscribed to.

Parameters:

Returns:


Method: listSubscribedChildChannels

Description:
Returns a list of subscribed child channels.

Parameters:

Returns:


Method: listSystemEvents

Description:
List all system events for given server. This includes *all* events for the server since it was registered. This may require the caller to filter the results to fetch the specific events they are looking for.

Parameters:

Returns:

Available since: 10.8


Method: listSystems

Description:
Returns a list of all servers visible to the user.

Parameters:

Returns:


Method: listSystemsWithPackage

Description:
Lists the systems that have the given installed package

Parameters:

Returns:


Method: listSystemsWithPackage

Description:
Lists the systems that have the given installed package

Parameters:

Returns:


Method: listUngroupedSystems

Description:
List systems that are not associated with any system groups.

Parameters:

Returns:


Method: listUserSystems

Description:
List systems for a given user.

Parameters:

Returns:


Method: listUserSystems

Description:
List systems for the logged in user.

Parameters:

Returns:


Method: listVirtualGuests

Description:
Lists the virtual guests for agiven virtual host

Parameters:

Returns:


Method: listVirtualHosts

Description:
Lists the virtual hosts visible to the user

Parameters:

Returns:


Method: obtainReactivationKey

Description:
Obtains a reactivation key for this server.

Parameters:

Returns:


Method: obtainReactivationKey

Description:
Obtains a reactivation key for this server.

Parameters:

Returns:

Available since: 10.10


Method: provisionSystem

Description:
Provision a system using the specified kickstart profile.

Parameters:

Returns:


Method: provisionSystem

Description:
Provision a system using the specified kickstart profile.

Parameters:

Returns:


Method: provisionVirtualGuest

Description:
Provision a guest on the host specified. Defaults to: memory=512MB, vcpu=1, storage=3GB, mac_address=random.

Parameters:

Returns:


Method: provisionVirtualGuest

Description:
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:

Returns:


Method: provisionVirtualGuest

Description:
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:

Returns:


Method: removeEntitlements

Description:
Remove addon entitlements from a server. Entitlements a server does not have are quietly ignored.

Parameters:

Returns:


Method: scheduleApplyErrata

Description:
Schedules an action to apply errata updates to multiple systems.

Parameters:

Returns:


Method: scheduleApplyErrata

Description:
Schedules an action to apply errata updates to multiple systems at a given date/time.

Parameters:

Returns:


Method: scheduleApplyErrata

Description:
Schedules an action to apply errata updates to a system.

Parameters:

Returns:

Available since: 10.6


Method: scheduleApplyErrata

Description:
Schedules an action to apply errata updates to a system at a given date/time.

Parameters:

Returns:


Method: scheduleGuestAction

Description:
Schedules a guest action for the specified virtual guest for a given date/time.

Parameters:

Returns:


Method: scheduleGuestAction

Description:
Schedules a guest action for the specified virtual guest for the current time.

Parameters:

Returns:


Method: scheduleHardwareRefresh

Description:
Schedule a hardware refresh for a system.

Parameters:

Returns:


Method: schedulePackageInstall

Description:
Schedule package installation for a system.

Parameters:

Returns:


Method: schedulePackageRefresh

Description:
Schedule a package list refresh for a system.

Parameters:

Returns:


Method: schedulePackageRemove

Description:
Schedule package removal for a system.

Parameters:

Returns:


Method: scheduleReboot

Description:
Schedule a reboot for a system.

Parameters:

Returns:


Method: scheduleScriptRun

Description:
Schedule a script to run.

Parameters:

Returns:


Method: scheduleScriptRun

Description:
Schedule a script to run.

Parameters:

Returns:


Method: scheduleSyncPackagesWithSystem

Description:
Sync packages from a source system to a target.

Parameters:

Returns:


Method: searchByName

Description:
Returns a list of system IDs whose name matches the supplied regular expression.

Parameters:

Returns:


Method: setBaseChannel

Description:
Assigns the server to a new baseChannel.

Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string channelLabel)

Parameters:

Returns:


Method: setBaseChannel

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.

Parameters:

Returns:


Method: setChildChannels

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.

Parameters:

Returns:


Method: setCustomValues

Description:
Set custom values for the specified server.

Parameters:

Returns:


Method: setDetails

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

Parameters:

Returns:


Method: setGroupMembership

Description:
Set a servers membership in a given group.

Parameters:

Returns:


Method: setGuestCpus

Description:
Schedule an action of a guest's host, to set that guest's CPU allocation

Parameters:

Returns:


Method: setGuestMemory

Description:
Schedule an action of a guest's host, to set that guest's memory allocation

Parameters:

Returns:


Method: setLockStatus

Description:
Set server lock status.

Parameters:

Returns:


Method: setProfileName

Description:
Set the profile name for the server.

Parameters:

Returns:


Method: setVariables

Description:
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 to System -> <Specified System> -> Provisioning -> Select a Kickstart profile -> Create Cobbler System Record.

Parameters:

Returns:


Method: tagLatestSnapshot

Description:
Tags latest system snapshot

Parameters:

Returns:


Method: upgradeEntitlement

Description:
Adds an entitlement to a given server.

Parameters:

Returns:


Method: whoRegistered

Description:
Returns information about the user who registered the system

Parameters:

Returns:


system.config

(Return to Handler List)

Available methods

Description

Provides methods to access and modify many aspects of configuration channels and server association. basically system.config name space

Namespace: system.config


Method: addChannels

Description:
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:

Returns:


Method: createOrUpdatePath

Description:
Create a new file (text or binary) or directory with the given path, or update an existing path on a server.

Parameters:

Returns:

Available since: 10.2


Method: createOrUpdateSymlink

Description:
Create a new symbolic link with the given path, or update an existing path.

Parameters:

Returns:

Available since: 10.2


Method: deleteFiles

Description:
Removes file paths from a local or sandbox channel of a server.

Parameters:

Returns:


Method: deployAll

Description:
Schedules a deploy action for all the configuration files on the given list of systems.

Parameters:

Returns:


Method: listChannels

Description:
List all global configuration channels associated to a system in the order of their ranking.

Parameters:

Returns:


Method: listFiles

Description:
Return the list of files in a given channel.

Parameters:

Returns:


Method: lookupFileInfo

Description:
Given a list of paths and a server, returns details about the latest revisions of the paths.

Parameters:

Returns:

Available since: 10.2


Method: removeChannels

Description:
Remove config channels from the given servers.

Parameters:

Returns:


Method: setChannels

Description:
Replace the existing set of config channels on the given servers. Channels are ranked according to their order in the configChannelLabels array.

Parameters:

Returns:


system.custominfo

(Return to Handler List)

Available methods

Description

Provides methods to access and modify custom system information.

Namespace: system.custominfo


Method: createKey

Description:
Create a new custom key

Parameters:

Returns:


Method: deleteKey

Description:
Delete an existing custom key and all systems' values for the key.

Parameters:

Returns:


Method: listAllKeys

Description:
List the custom information keys defined for the user's organization.

Parameters:

Returns:


Method: updateKey

Description:
Update description of a custom key

Parameters:

Returns:


system.provisioning.snapshot

(Return to Handler List)

Available methods

Description

Provides methods to access and delete system snapshots.

Namespace: system.provisioning.snapshot


Method: addTagToSnapshot

Description:
Adds tag to snapshot

Parameters:

Returns:


Method: deleteSnapshot

Description:
Deletes a snapshot with the given snapshot id

Parameters:

Returns:

Available since: 10.1


Method: deleteSnapshots

Description:
Deletes all snapshots across multiple systems based on the given date criteria. For example,

Parameters:

Returns:

Available since: 10.1


Method: deleteSnapshots

Description:
Deletes all snapshots for a given system based on the date criteria. For example,

Parameters:

Returns:

Available since: 10.1


Method: listSnapshotConfigFiles

Description:
List the config files associated with a snapshot.

Parameters:

Returns:

Available since: 10.2


Method: listSnapshotPackages

Description:
List the packages associated with a snapshot.

Parameters:

Returns:

Available since: 10.1


Method: listSnapshots

Description:
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,

Parameters:

Returns:

Available since: 10.1


system.scap

(Return to Handler List)

Available methods

Description

Provides methods to schedule SCAP scans and access the results.

Namespace: system.scap


Method: getXccdfScanDetails

Description:
Get details of given OpenSCAP XCCDF scan.

Parameters:

Returns:


Method: getXccdfScanRuleResults

Description:
Return a full list of RuleResults for given OpenSCAP XCCDF scan.

Parameters:

Returns:


Method: listXccdfScans

Description:
Return a list of finished OpenSCAP scans for a given system.

Parameters:

Returns:


Method: scheduleXccdfScan

Description:
Schedule OpenSCAP scan.

Parameters:

Returns:


Method: scheduleXccdfScan

Description:
Schedule OpenSCAP scan.

Parameters:

Returns:


Method: scheduleXccdfScan

Description:
Schedule Scap XCCDF scan.

Parameters:

Returns:


Method: scheduleXccdfScan

Description:
Schedule Scap XCCDF scan.

Parameters:

Returns:


system.search

(Return to Handler List)

Available methods

Description

Provides methods to perform system search requests using the search server.

Namespace: system.search


Method: deviceDescription

Description:
List the systems which match the device description.

Parameters:

Returns:


Method: deviceDriver

Description:
List the systems which match this device driver.

Parameters:

Returns:


Method: deviceId

Description:
List the systems which match this device id

Parameters:

Returns:


Method: deviceVendorId

Description:
List the systems which match this device vendor_id

Parameters:

Returns:


Method: hostname

Description:
List the systems which match this hostname

Parameters:

Returns:


Method: ip

Description:
List the systems which match this ip.

Parameters:

Returns:


Method: nameAndDescription

Description:
List the systems which match this name or description

Parameters:

Returns:


Method: uuid

Description:
List the systems which match this UUID

Parameters:

Returns:


systemgroup

(Return to Handler List)

Available methods

Description

Provides methods to access and modify system groups.

Namespace: systemgroup


Method: addOrRemoveAdmins

Description:
Add or remove administrators to/from the given group. Satellite 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:

Returns:


Method: addOrRemoveSystems

Description:
Add/remove the given servers to a system group.

Parameters:

Returns:


Method: create

Description:
Create a new system group.

Parameters:

Returns:


Method: delete

Description:
Delete a system group.

Parameters:

Returns:


Method: getDetails

Description:
Retrieve details of a ServerGroup based on it's id

Parameters:

Returns:


Method: getDetails

Description:
Retrieve details of a ServerGroup based on it's name

Parameters:

Returns:


Method: listActiveSystemsInGroup

Description:
Lists active systems within a server group

Parameters:

Returns:


Method: listAdministrators

Description:
Returns the list of users who can administer the given group. Caller must be a system group admin or an organization administrator.

Parameters:

Returns:


Method: listAllGroups

Description:
Retrieve a list of system groups that are accessible by the logged in user.

Parameters:

Returns:


Method: listGroupsWithNoAssociatedAdmins

Description:
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:


Method: listInactiveSystemsInGroup

Description:
Lists inactive systems within a server group using a specified inactivity time.

Parameters:

Returns:


Method: listInactiveSystemsInGroup

Description:
Lists inactive systems within a server group using the default 1 day threshold.

Parameters:

Returns:


Method: listSystems

Description:
Return a list of systems associated with this system group. User must have access to this system group.

Parameters:

Returns:


Method: scheduleApplyErrataToActive

Description:
Schedules an action to apply errata updates to active systems from a group.

Parameters:

Returns:


Method: scheduleApplyErrataToActive

Description:
Schedules an action to apply errata updates to active systems from a group at a given date/time.

Parameters:

Returns:


Method: update

Description:
Update an existing system group.

Parameters:

Returns:


user

(Return to Handler List)

Available methods

Description

User namespace contains methods to access common user functions available from the web user interface.

Namespace: user


Method: addAssignedSystemGroup

Description:
Add system group to user's list of assigned system groups.

Parameters:

Returns:


Method: addAssignedSystemGroups

Description:
Add system groups to user's list of assigned system groups.

Parameters:

Returns:


Method: addDefaultSystemGroup

Description:
Add system group to user's list of default system groups.

Parameters:

Returns:


Method: addDefaultSystemGroups

Description:
Add system groups to user's list of default system groups.

Parameters:

Returns:


Method: addRole

Description:
Adds a role to a user.

Parameters:

Returns:


Method: create

Description:
Create a new user.

Parameters:

Returns:


Method: create

Description:
Create a new user.

Parameters:

Returns:


Method: delete

Description:
Delete a user.

Parameters:

Returns:


Method: disable

Description:
Disable a user.

Parameters:

Returns:


Method: enable

Description:
Enable a user.

Parameters:

Returns:


Method: getDetails

Description:
Returns the details about a given user.

Parameters:

Returns:


Method: getLoggedInTime

Description:
Returns the time user last logged in.

Parameters:

Returns:


Method: listAssignableRoles

Description:
Returns a list of user roles that this user can assign to others.

Parameters:

Returns:


Method: listAssignedSystemGroups

Description:
Returns the system groups that a user can administer.

Parameters:

Returns:


Method: listDefaultSystemGroups

Description:
Returns a user's list of default system groups.

Parameters:

Returns:


Method: listRoles

Description:
Returns a list of the user's roles.

Parameters:

Returns:


Method: listUsers

Description:
Returns a list of users in your organization.

Parameters:

Returns:


Method: removeAssignedSystemGroup

Description:
Remove system group from the user's list of assigned system groups.

Parameters:

Returns:


Method: removeAssignedSystemGroups

Description:
Remove system groups from a user's list of assigned system groups.

Parameters:

Returns:


Method: removeDefaultSystemGroup

Description:
Remove a system group from user's list of default system groups.

Parameters:

Returns:


Method: removeDefaultSystemGroups

Description:
Remove system groups from a user's list of default system groups.

Parameters:

Returns:


Method: removeRole

Description:
Remove a role from a user.

Parameters:

Returns:


Method: setDetails

Description:
Updates the details of a user.

Parameters:

Returns:


Method: usePamAuthentication

Description:
Toggles whether or not a user uses PAM authentication or basic RHN authentication.

Parameters:

Returns: