( Return to API Overview )

Available methods

Description

Provides methods to access and modify registered system.

Namespace: system


Method: addEntitlements

Description:
Add 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: 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 client certificate.

Parameters:

Returns:

Available since: 10.10


Method: deleteSystem

Description:
Delete a system given its server id synchronously

Parameters:

Returns:


Method: deleteSystems

Description:
Delete systems given a list of system ids asynchronously.

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

Description:
get details about a ping sent to a system using OSA

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 scores for all servers the user has access to

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

Description:
Given a list of server ids, returns a list of active servers' details visible to the user.

Parameters:

Returns:


Method: listAdministrators

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

Parameters:

Returns:


Method: listAllInstallablePackages

Description:
Get the list of all installable packages for a given 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: listExtraPackages

Description:
List extra packages for a system

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

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

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

Description:
List systems that require reboot.

Parameters:

Returns:


Method: listSystemEvents

Description:
List system events of the specified type for 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.'

Parameters:

Returns:

Available since: 10.8


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

Description:
List systems with extra packages

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 a given 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:

Available since: 13.0


Method: scheduleApplyErrata

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

Parameters:

Returns:

Available since: 13.0


Method: scheduleApplyErrata

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

Parameters:

Returns:

Available since: 13.0


Method: scheduleApplyErrata

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

Parameters:

Returns:

Available since: 13.0


Method: scheduleCertificateUpdate

Description:
Schedule update of client certificate

Parameters:

Returns:


Method: scheduleCertificateUpdate

Description:
Schedule update of client certificate at given date and 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:

Available since: 13.0


Method: schedulePackageInstall

Description:
Schedule package installation for several systems.

Parameters:

Returns:


Method: schedulePackageInstall

Description:
Schedule package installation for a system.

Parameters:

Returns:

Available since: 13.0


Method: schedulePackageInstallByNevra

Description:
Schedule package installation for several systems.

Parameters:

Returns:


Method: schedulePackageInstallByNevra

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

Parameters:

Returns:


Method: schedulePackageRemove

Description:
Schedule package removal for a system.

Parameters:

Returns:


Method: schedulePackageRemoveByNevra

Description:
Schedule package removal for several systems.

Parameters:

Returns:


Method: schedulePackageRemoveByNevra

Description:
Schedule package removal for a system.

Parameters:

Returns:


Method: scheduleReboot

Description:
Schedule a reboot for a system.

Parameters:

Returns:

Available since: 13.0


Method: scheduleScriptRun

Description:
Schedule a script to run.

Parameters:

Returns:


Method: scheduleScriptRun

Description:
Schedule a script to run.

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:

Available since: 13.0


Method: searchByName

Description:
Returns a list of system IDs whose name matches the supplied regular expression(defined by Java representation of regular expressions)

Parameters:

Returns:


Method: sendOsaPing

Description:
send a ping to a system using OSA

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

Description:
Sets new primary network interface

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

Description:
Unentitle the system completely

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:


Generated on 8/30/2017