API Overview: system

Description

Provides methods to access and modify many aspects of a system within the Red Hat Network.

Namespace: system

Method: addEntitlements

Parameters:

• string sessionKey
• int serverId
• array
  • string entitlementLabel

Returns: int - 1 on success, exception thrown otherwise.

Method: addNote

Parameters:

• string sessionKey
• int serverId
• string subject - What the note is about.
• string body - Content of the note.

Returns: int - 1 if note was added successfully.

Method: applyErrata

Parameters:

• string sessionKey
• int serverId
• array
  • int errataId

Returns: int - 1 on success.

Method: comparePackages

Parameters:

• string sessionKey
• int thisServerId
• int otherServerId

Returns: array

• struct (Package Metadata)
• int "package_name_id"
• string "package_name"
• string "this_system" - Version of package on this system.
• string "other_system" - Version of package on other system.
• int "comparison"
  • 0 - No difference.
  • 1 - Package on this system only.
  • 2 - Newer package version on this system.
  • 3 - Package on other system only.
  • 4 - Newer package version on other system.

Method: createPackageProfile

Parameters:

• string sessionKey
• int serverId
• string profile_label
• string description

Returns: int - 1 on success

Method: deleteSystems

Parameters:

• string sessionKey
• array
  • int serverId

Returns: int - Number of systems deleted.

Method: downloadSystemId

Parameters:

• string sessionKey
• int serverId

Returns: string

Method: getCpu

Parameters:

• string sessionKey
• int serverId

Returns: struct (CPU)

• string "cache"
• string "family"
• string "mhz"
• string "flags"
• string "model"
• string "vendor"
• string "arch"
• string "stepping"

Method: getCustomValues

Parameters:

• string sessionKey
• int serverId

Returns: struct (custom value)

• string (custom_info_label)

Method: getDetails

Parameters:

• string sessionKey
• int serverId

Returns: struct (server details)

• int "id" - System ID.
• string "profile_name" - System's profile name.
• string "base_entitlement" - System's base entitlement label. (enterprise_entitled or sw_mgr_entitled)
• array "addon_entitlements"
  • string entitlementLabel - Addon entitlement label:
    • monitoring_entitled
    • provisioning_entitled
    • virtualization_host
    • virtualization_host_platform
• boolean "auto_update" - True if system has auto errata updates enabled.
• string "address1" - System's address line 1.
• string "address2" - System's address line 2.
• string "city" - System's city.
• string "state" - System's state.
• string "country" - System's country code.
• string "building" - System's building.
• string "room" - System's room.
• string "rack" - System's rack.
• string "description"

Method: getDevices

Parameters:

• string sessionKey
• int serverId

Returns: array

• struct (device)
• string "device"
• string "device_class" - Includes CDROM, FIREWIRE, HD, USB, VIDEO, OTHER, etc.
• string "driver"
• string "description"
• string "bus"
• string "pcitype"

Method: getDmi

Parameters:

• string sessionKey
• int serverId

Returns: struct (DMI)

• string "vendor"
• string "system"
• string "product"
• string "asset"
• string "board"
• string "bios_release"
• string "bios_vendor"
• string "bios_version"

Method: getEntitlements

Parameters:

• string sessionKey
• int serverId

Returns: array

• string entitlement_label

Method: getEventHistory

Parameters:

• string sessionKey
• int serverId

Returns: array

• struct (History Event)
• dateTime.iso8601 "completed" - Date that the event occurred
• string "summary" - Summary of the event
• string "details" - Details of the event

Method: getId

Parameters:

• string sessionKey
• string systemName

Returns: array

• struct (system)
• int "id" - Server ID
• string "name" - Server name
• dateTime.iso8601 "last_checkin" - Last time server successfully checked in with Red Hat Network.

Method: getMemory

Parameters:

• string sessionKey
• int serverId

Returns: struct (memory)

• int "ram" - The amount of physical memory in MB.
• int "swap" - The amount of swap space in MB.

Method: getNetwork

Parameters:

• string sessionKey
• int serverId

Returns: struct (network info)

• string "ip" - IP address of server.
• string "hostname" - Hostname of server.

Method: getNetworkDevices

Parameters:

• string sessionKey
• int serverId

Returns: array

• struct (network device)
• string "ip" - IP address assigned to this network device.
• string "interface" - Network interface assigned to device e.g. eth0.
• string "netmask" - Network mask assigned to device
• string "hardware_address" - Hardware Address of device.
• string "module" - Network driver used for this device.
• string "broadcast" - Broadcast address for device.

Method: getRegistrationDate

Parameters:

• string sessionKey
• int serverId

Returns: dateTime.iso8601 - The date the system was registered, in local time.

Method: getRelevantErrata

Parameters:

• string sessionKey
• int serverId

Returns: array

• struct (errata)
• int "id" - Errata ID.
• string "date" - Date erratum was created.
• string "advisory_name" - Name of the advisory.
• string "advisory_synopsis" - Summary of the erratum.
• string "advisory_type" - Type of advisory.

Method: getRunningKernel

Parameters:

• string sessionKey
• int serverId

Returns: string

Method: getScriptResults

Parameters:

• string sessionKey
• int actionId - ID of the script run action.

Returns: array

• struct (script result)
• dateTime.iso8601 "startDate" - Time script began execution.
• dateTime.iso8601 "stopDate" - Time script stopped execution.
• int "returnCode" - Script execution return code.
• string "output" - Output of the script.

Method: getSubscribedBaseChannel

Parameters:

• string sessionKey
• int serverId

Returns: struct (channel)

• int "id"
• string "label"
• string "name"
• string "arch_name"
• string "summary"
• string "description"
• string "gpg_key_url"
• string "gpg_key_id"
• string "gpg_key_fp"
• string "end_of_life"
• string "parent_channel_label"
• channel_* (deprecated)

Method: getUnscheduledErrata

Parameters:

• string sessionKey
• int serverId

Returns: array

• struct (errata)
• int "id" - Errata ID.
• string "date" - Date erratum was created.
• string "advisory_synopsis" - Summary of the erratum.
• string "advisory_type" - type label such as Security, Bug Fix
• string "advisory_name" - name such as RHSA, etc.

Method: isNvreInstalled

Parameters:

• string sessionKey
• int serverId
• string name - Package name.
• string version - Package version.
• string release - Package release.

Returns: int - 1 on success.

Method: isNvreInstalled

Parameters:

• string sessionKey
• int serverId
• string name - Package name.
• string version - Package version.
• string release - Package release.
• string epoch - Package epoch.

Returns: int - 1 on success.

Method: listActiveSystems

Parameters:

• string sessionKey

Returns: array

• struct (server info)
• int "id"
• string "name"
• dateTime.iso8601 "last_checkin" - Last time server successfully checked in with Red Hat Network.

---

Method: listAdministrators

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

Parameters:


• string sessionKey
• int serverId

Returns: array

• struct (user)
• int "id" - User ID.
• string "login" - User login.
• string "login_uc" - User login in uppercase.

---

Method: listBaseChannels

Description:
Returns a list of subscribable base channels.

Parameters:


• string sessionKey
• int serverId

Returns: array

• struct (channel)
• int "id" - Base channel ID.
• string "name" - Name of channel.
• string "label" - Label of channel.
• int "current_base" - 1 indicates it is the current base channel.
• int "ID" - Base channel id. (deprecated)
• string "NAME" - Name of channel. (deprecated)
• string "LABEL" - Label of channel. (deprecated)
• int "CURRENT_BASE" - 1 indicates it is the current base channel. (deprecated)

---

Method: listChildChannels

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

Parameters:


• string sessionKey
• int serverId

Returns: array

• struct (child channel)
• int "id"
• string "name"
• string "label"
• string "summary"
• string "has_license"
• string "gpg_key_url"
• int "ID" (deprecated)
• string "NAME" (deprecated)
• string "LABEL" (deprecated)
• string "SUMMARY" (deprecated)
• string "HAS_LICENSE" (deprecated)
• string "GPG_KEY_URL" (deprecated)

---

Method: listGroups

Description:
List the available groups for a given system.

Parameters:


• string sessionKey
• int serverId

Returns: array

• struct (system group)
• int "sgid" - Server group ID.
• int "subscribed" - 1 if the given server is subscribed to this server group, 0 otherwise.
• string "system_group_name" - Name of the server group.

---

Method: listLatestInstallablePackages

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

Parameters:


• string sessionKey
• int serverId

Returns: array

• struct (package)
• string "name"
• string "version"
• string "release"
• string "epoch"
• string "id"
• string "arch_label"
• string "package_name" (deprecated)
• string "package_version" (deprecated)
• string "package_release" (deprecated)
• string "package_epoch" (deprecated)
• string "package_id" (deprecated)
• string "package_arch_label" (deprecated)

---

Method: listLatestUpgradablePackages

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

Parameters:


• string sessionKey
• int serverId

Returns: array

• struct (package)
• string "package_name"
• string "from_version"
• string "from_release"
• string "from_epoch"
• string "to_version"
• string "to_release"
• string "to_epoch"

---

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:


• string sessionKey
• int serverId
• string name - Package name.
• string version - Package version.
• string release - Package release.
• string epoch - Package epoch.

Returns: array

• struct (package)
• string "name"
• string "version"
• string "release"
• string "epoch"

---

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:


• string sessionKey
• int serverId
• string name - Package name.
• string version - Package version.
• string release - Package release.
• string epoch - Package epoch.

Returns: array

• struct (package)
• string "name"
• string "version"
• string "release"
• string "epoch"

---

Method: listOutOfDateSystems

Description:
Returns list of systems needing package updates.

Parameters:


• string sessionKey

Returns: array

• struct (system)
• int "id"
• string "name"

---

Method: listPackages

Description:
List the installed packages for a given system.

Parameters:


• string sessionKey
• int serverId

Returns: array

• struct (package)
• string "name"
• string "version"
• string "release"
• string "epoch"

---

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:


• string sessionKey
• int serverId
• string channelLabel

Returns: array

• struct (package)
• string "name"
• string "version"
• string "release"
• string "epoch"
• string "id"
• string "arch_label"
• dateTime.iso8601 "last_modified"

---

Method: listSubscribedChildChannels

Description:
Returns a list of subscribed child channels.

Parameters:


• string sessionKey
• int serverId

Returns: array

• struct (child channels)
• int "id"
• string "name"
• string "label"
• string "summary"
• string "gpg_key_url"

---

Method: listSystemEvents

Description:
List all system events for given server. This is *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:


• string sessionKey
• int serverId - ID of system.

Returns: array

• struct (action)
• int "failed_count" - Number of times action failed.
• string "modified" - Date modified.
• string "created" - Date created.
• string "action_type"
• int "successful_count" - Number of times action was successful.
• string "earliest_action" - Earliest date this action will occur.
• int "archived" - If this action is archived. (1 or 0)
• string "scheduler_user"
• string "prerequisite" - Pre-requisite action.
• string "name" - Name of this action.
• int "id" - ID of this action.
• string "version" - Version of action.
• string "completion_time" - The event completion time or "" if the action did not complete. Format ->(YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0
• string "pickup_time" - The time the action was picked up or "" if the action was not picked up. Format ->(YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0
• string "result_msg" - The result string after the action executes at the client machine.

---

Method: listUngroupedSystems

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

Parameters:


• string sessionKey

Returns: array

• struct (system)
• int "id" - Server ID.
• string "name" - Server name.
• dateTime.iso8601 "last_checkin" - Last time server successfully checked in with Red Hat Network.

---

Method: listUserSystems

Description:
List systems for a given user.

Parameters:


• string sessionKey
• string login - User's login name.

Returns: array

• struct (system)
• int "id"
• string "name"
• dateTime.iso8601 "last_checkin" - Last time server successfully checked in with Red Hat Network.

---

Method: listUserSystems

Description:
List systems for the logged in user.

Parameters:


• string sessionKey

Returns: array

• struct (system)
• int "id"
• string "name"
• dateTime.iso8601 "last_checkin" - Last time server successfully checked in with Red Hat Network.

---

Method: obtainReactivationKey

Description:
Obtains a reactivation key for this server.

Parameters:


• string sessionKey
• int serverId

Returns: string

---

Method: provisionVirtualGuest

Description:
Provision a guest on the host specified. Defaults to: memory=256MB, vcpu=1, storage=2048MB.

Parameters:


• string sessionKey
• int serverId - ID of host to provision guest on.
• string guestName
• string profileName - Kickstart profile to use.

Returns: int - 1 if guest was scheduled for creation successfully.

---

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 with the Satellite or if OSAD is enabled will begin immediately.

Parameters:


• string sessionKey
• int serverId - ID of host to provision guest on.
• string guestName
• string profileName - Kickstart Profile to use.
• int memoryMb - Memory to allocate to the guest.
• int vcpus - Number of virtual CPUs to allocate to the guest.
• int storageMb - Size of the guests disk image.

Returns: int - 1 if guest was scheduled for creation successfully.

---

Method: removeEntitlements

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

Parameters:


• string sessionKey
• int serverId
• array
  • string entitlement_label

Returns: int - 1 on success, exception thrown otherwise.

---

Method: scheduleApplyErrata

Description:
Apply errata updates to a system.

Parameters:


• string sessionKey
• int serverId
• array
  • int errataId
• dateTime.iso8601 earliestOccurrence

Returns: int - 1 on success.

---

Method: scheduleHardwareRefresh

Description:
Schedule a hardware refresh for a system.

Parameters:


• string sessionKey
• int serverId
• dateTime.iso8601 earliestOccurrence

Returns: int - 1 on success.

---

Method: schedulePackageInstall

Description:
Schedule package installation for a system.

Parameters:


• string sessionKey
• int serverId
• array
  • int packageId
• dateTime.iso8601 earliestOccurrence

Returns: int - 1 on success.

---

Method: scheduleReboot

Description:
Schedule a reboot for a system.

Parameters:


• string sessionKey
• int serverId
• dateTime.iso8601 earliestOccurrence

Returns: int - 1 on success.

---

Method: scheduleScriptRun

Description:
Schedule a script to run.

Parameters:


• string sessionKey
• int serverId - ID of the server to run the script on.
• string username - User to run script as.
• string groupname - Group to run script as.
• int timeout - Seconds to allow the script to run before timing out.
• string script - Contents of the script to run.
• dateTime.iso8601 earliestOccurrence - Earliest the script can run.

Returns: int - ID of the script run action created. Can be used to fetch results with system.getScriptResults.

---

Method: scheduleSyncPackagesWithSystem

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

Parameters:


• string sessionKey
• int targetServerId - Target system to apply package changes to.
• int sourceServerId - Source system to retrieve package state from.
• array
  • int packageId - Package IDs to be synced.
• dateTime.iso8601 - Earliest List of package IDs to be synced.

Returns: int - 1 on success, exception thrown otherwise.

---

Method: searchByName

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

Parameters:


• string sessionKey
• string regexp - A regular expression. (as defined by http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html )

Returns: array

• struct (system)
• int "id" - Server ID.
• string "name" - Server name.
• dateTime.iso8601 "last_checkin" - Last time server successfully checked in with Red Hat Network.

---

Method: setBaseChannel

Description:
Assigns the server to a new baseChannel.

Parameters:


• string sessionKey
• int serverId
• int channelId

Returns: int - 1 on success.

---

Method: setChildChannels

Description:
Subscribes the given server to the child channels (ids).

Parameters:


• string sessionKey
• int serverId
• array
  • int channelId

Returns: int - 1 on success

---

Method: setCustomValues

Description:
Set custom values for the specified server.

Parameters:


• string sessionKey
• int serverId
• struct (Map of custom labels to custom values)
  • string (custom info label)
  • string (value)

Returns: int - 1 on success

---

Method: setDetails

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

Parameters:


• string sessionKey
• int serverId - ID of server to lookup details for.
• struct (server details)
  • struct
  • int "id" - System id.
  • string "profile_name" - System's profile name.
  • string "base_entitlement" - System's base entitlement label. (enterprise_entitled or sw_mgr_entitled)
  • boolean "auto_errata_update" - True if system has auto errata updates enabled.
  • string "address1" - System's address line 1.
  • string "address1" - System's address line 2.
  • string "city" - System's city.
  • string "state" - System's state.
  • string "country" - System's country code.
  • string "building" - System's building.
  • string "room" - System's room.
  • string "rack" - System's rack.

  Returns: int - 1 on success, exception thrown otherwise.

  ---

  Method: setGroupMembership

  Description:
  Set a servers membership in a given group.

  Parameters:
  

  • string sessionKey
  • int serverId
  • int serverGroupId
  • int member - "1" to assign the given server to the given server group, "0" to remove the given server from the given server group.

  Returns: int - 1 on success.

  ---

  Method: setProfileName

  Description:
  Set the profile name for the server.

  Parameters:
  

  • string sessionKey
  • int serverId
  • string name - Name of the profile.

  Returns: int - 1 if note was added successfully.

  ---

  Method: upgradeEntitlement

  Description:
  Adds an entitlement to a given server.

  Parameters:
  

  • string sessionKey
  • int serverId
  • string entitlementName - One of: "enterprise_entitled", "provisioning_entitled", "monitoring_entitled", "nonlinux_entitled", "virtualization_host", or "virtualization_host_platform".

  Returns: int - 1 on success

  ---