( Return to API Overview )

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: 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: 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 IP address 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: 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 -> -> 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: