RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://spacewalkproject.github.io/documentation/api/2.10/handlers/SystemHandler.html below:

( Return to API Overview ) 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:

string sessionKey
int serverId
array:
- string - entitlementLabel - one of following: virtualization_host, enterprise_entitled

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: addNote Description:
Add a new note to the given server. Parameters:

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

Returns:


 
  int - 1 on success, exception thrown otherwise.

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:

string sessionKey
int serverId
array:
- int - errataId

Returns:


 
  int - 1 on success, exception thrown otherwise.

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:

string sessionKey
int serverId
string profileLabel

Returns:


 
  array: 
   
    struct - Package Metadata 
     
      int "package_name_id"
      string "package_name"
      string "package_epoch"
      string "package_version"
      string "package_release"
      string "package_arch"
      string "this_system" - Version of package on this system.
      string "other_system" - Version of package on the other system.
      int "comparison"
      
       0 - No difference.
       1 - Package on this system only.
       2 - Newer package version on this system.
       3 - Package on other system only.
       4 - Newer package version on other system.

Method: comparePackages Description:
Compares the packages installed on two systems. Parameters:

string sessionKey
int thisServerId
int otherServerId

Returns:


 
  array: 
   
    struct - Package Metadata 
     
      int "package_name_id"
      string "package_name"
      string "package_epoch"
      string "package_version"
      string "package_release"
      string "package_arch"
      string "this_system" - Version of package on this system.
      string "other_system" - Version of package on the other system.
      int "comparison"
      
       0 - No difference.
       1 - Package on this system only.
       2 - Newer package version on this system.
       3 - Package on other system only.
       4 - Newer package version on other system.

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

string sessionKey
int serverId
string profileLabel
string description

Returns:


 
  int - 1 on success, exception thrown otherwise.

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

string sessionKey
int serverId
string ksLabel

Returns:


 
  int - 1 on success, exception thrown otherwise.

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

string sessionKey
int serverId
array:
- string - customInfoLabel

Returns:


 
  int - 1 on success, exception thrown otherwise. (Note: Attempt to delete values of non-existing keys throws exception. Attempt to delete value of existing key which has assigned no values doesn't throw exception.)

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

string sessionKey
int hostId
array:
- string - guestNames

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: deleteNote Description:
Deletes the given note from the server. Parameters:

string sessionKey
int serverId
int noteId

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: deleteNotes Description:
Deletes all notes from the server. Parameters:

string sessionKey
int serverId

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: deletePackageProfile Description:
Delete a package profile Parameters:

string sessionKey
int profileId

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: deleteSystem Description:
Delete a system given its client certificate. Parameters:

string systemid - systemid file

Returns:


 
  int - 1 on success, exception thrown otherwise.

Available since: 10.10 Method: deleteSystem Description:
Delete a system given its server id synchronously Parameters:

string sessionKey
int serverId

Returns:


 
  int - 1 on success, exception thrown otherwise.

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

string sessionKey
array:
- int - serverId

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: deleteTagFromSnapshot Description:
Deletes tag from system snapshot Parameters:

string sessionKey
int serverId
string tagName

Returns:


 
  int - 1 on success, exception thrown otherwise.

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

string sessionKey
int serverId

Returns:


 
  string

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

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - proxy connection path details 
     
      int "position" - Position of proxy in chain. The proxy that the system connects directly to is listed in position 1.
      int "id" - Proxy system id
      string "hostname" - Proxy host name

Method: getCpu Description:
Gets the CPU information of a system. Parameters:

string sessionKey
int serverId

Returns:


 
  struct - CPU 
   
    string "cache"
    string "family"
    string "mhz"
    string "flags"
    string "model"
    string "vendor"
    string "arch"
    string "stepping"
    string "count"
    int "socket_count (if available)"

Method: getCustomValues Description:
Get the custom data values defined for the server. Parameters:

string sessionKey
int serverId

Returns:


 
  struct - custom value 
   
    string "custom info label"

Method: getDetails Description:
Get system details. Parameters:

string sessionKey
int serverId

Returns:


 
  struct - server details 
   
    int "id" - System id
    string "profile_name"
    string "base_entitlement" - System's base entitlement label
    array "string" 
     
      addon_entitlements System's addon entitlements labels, currently only 'virtualization_host'
     
    boolean "auto_update" - True if system has auto errata updates enabled.
    string "release" - The Operating System release (i.e. 4AS, 5Server
    string "address1"
    string "address2"
    string "city"
    string "state"
    string "country"
    string "building"
    string "room"
    string "rack"
    string "description"
    string "hostname"
    dateTime.iso8601 "last_boot"
    string "osa_status" - Either 'unknown', 'offline', or 'online'.
    boolean "lock_status" - True indicates that the system is locked. False indicates that the system is unlocked.
    string "virtualization" - Virtualization type - for virtual guests only (optional)

Method: getDevices Description:
Gets a list of devices for a system. Parameters:

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - device 
     
      string "device" - optional
      string "device_class" - Includes CDROM, FIREWIRE, HD, USB, VIDEO, OTHER, etc.
      string "driver"
      string "description"
      string "bus"
      string "pcitype"

Method: getDmi Description:
Gets the DMI information of a system. Parameters:

string sessionKey
int serverId

Returns:


 
  struct - DMI 
   
    string "vendor"
    string "system"
    string "product"
    string "asset"
    string "board"
    string "bios_release" - (optional)
    string "bios_vendor" - (optional)
    string "bios_version" - (optional)

Method: getEntitlements Description:
Gets the entitlements for a given server. Parameters:

string sessionKey
int serverId

Returns:


 
  array: 
   
    string - entitlement_label

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:

string sessionKey
int serverId

Returns:


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

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

string sessionKey
string systemName

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

Method: getMemory Description:
Gets the memory information for a system. 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: getName Description:
Get system name and last check in information for the given system ID. Parameters:

string sessionKey
string serverId

Returns:


 
  struct - name info 
   
    int "id" - Server id
    string "name" - Server name
    dateTime.iso8601 "last_checkin" - Last time server successfully checked in

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

string sessionKey
int serverId

Returns:


 
  struct - network info 
   
    string "ip" - IPv4 address of server
    string "ip6" - IPv6 address of server
    string "hostname" - Hostname of server

Method: getNetworkDevices Description:
Returns the network devices for the given server. 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.
      array "ipv6" - List of IPv6 addresses array: 
      
       struct - ipv6 address 
        
         string "address" - IPv6 address of this network device
         string "netmask" - IPv6 netmask of this network device
         string "scope" - IPv6 address scope

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

User loggedInUser
int serverId

Returns:


 
  struct - osaPing 
   
    String "state" - state of the system (unknown, online, offline)
    dateTime.iso8601 "lastMessageTime" - time of the last received response (1970/01/01 00:00:00 if never received a response)
    dateTime.iso8601 "lastPingTime" - time of the last sent ping (1970/01/01 00:00:00 if no ping is pending

Method: getRegistrationDate Description:
Returns the date the system was registered. Parameters:

string sessionKey
int serverId

Returns:


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

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

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - errata 
     
      int "id" - Errata ID.
      string "date" - Date erratum was created.
      string "update_date" - Date erratum was updated.
      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: getRelevantErrataByType Description:
Returns a list of all errata of the specified type that are relevant to the system. Parameters:

string sessionKey
int serverId
string advisoryType - type of advisory (one of of the following: 'Security Advisory', 'Product Enhancement Advisory', 'Bug Fix Advisory'

Returns:


 
  array: 
   
    struct - errata 
     
      int "id" - Errata ID.
      string "date" - Date erratum was created.
      string "update_date" - Date erratum was updated.
      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: getRunningKernel Description:
Returns the running kernel of the given system. Parameters:

string sessionKey
int serverId

Returns:


 
  string

Method: getScriptActionDetails Description:
Returns script details for script run actions Parameters:

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

Returns:


 
  struct - Script details 
   
    int "id" - action id
    string "content" - script content
    string "run_as_user" - Run as user
    string "run_as_group" - Run as group
    int "timeout" - Timeout in seconds array: 
    
     struct - script result 
      
       int "serverId" - ID of the server the script runs on.
       dateTime.iso8601 "startDate" - Time script began execution.
       dateTime.iso8601 "stopDate" - Time script stopped execution.
       int "returnCode" - Script execution return code.
       string "output" - Output of the script (base64 encoded according to the output_enc64 attribute)
       boolean "output_enc64" - Identifies base64 encoded output

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

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

Returns:


 
  array: 
   
    struct - script result 
     
      int "serverId" - ID of the server the script runs on.
      dateTime.iso8601 "startDate" - Time script began execution.
      dateTime.iso8601 "stopDate" - Time script stopped execution.
      int "returnCode" - Script execution return code.
      string "output" - Output of the script (base64 encoded according to the output_enc64 attribute)
      boolean "output_enc64" - Identifies base64 encoded output

Method: getSubscribedBaseChannel Description:
Provides the base channel of a given system Parameters:

string sessionKey
int serverId

Returns:


 
  struct - channel 
   
    int "id"
    string "name"
    string "label"
    string "arch_name"
    string "arch_label"
    string "summary"
    string "description"
    string "checksum_label"
    dateTime.iso8601 "last_modified"
    string "maintainer_name"
    string "maintainer_email"
    string "maintainer_phone"
    string "support_policy"
    string "gpg_key_url"
    string "gpg_key_id"
    string "gpg_key_fp"
    dateTime.iso8601 "yumrepo_last_sync" - (optional)
    string "end_of_life"
    string "parent_channel_label"
    string "clone_original" array: 
    
     struct - contentSources 
      
       int "id"
       string "label"
       string "sourceUrl"
       string "type"

Method: getSystemCurrencyMultipliers Description:
Get the System Currency score multipliers Parameters:

string sessionKey

Returns:


 
  Map of score multipliers

Method: getSystemCurrencyScores Description:
Get the System Currency scores for all servers the user has access to Parameters:

string sessionKey

Returns:


 
  array: 
   
    struct - system currency 
     
      int "sid"
      int "critical security errata count"
      int "important security errata count"
      int "moderate security errata count"
      int "low security errata count"
      int "bug fix errata count"
      int "enhancement errata count"
      int "system currency score"

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

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - errata 
     
      int "id" - Errata Id
      string "date" - Date erratum was created.
      string "advisory_type" - Type of the advisory.
      string "advisory_name" - Name of the advisory.
      string "advisory_synopsis" - Summary of the erratum.

Method: getUuid Description:
Get the UUID from the given system ID. Parameters:

string sessionKey
int serverId

Returns:


 
  string

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:

string sessionKey
int serverId

Returns:


 
  struct - System kickstart variables 
   
    boolean "netboot" - netboot enabled
    array "kickstart variables" 
     
      struct - kickstart variable 
       
        string "key"
        string or int "value"

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

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

Returns:


 
  1 if package exists, 0 if not, exception is thrown if an error occurs

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

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

Returns:


 
  1 if package exists, 0 if not, exception is thrown if an error occurs

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:

string sessionKey
int serverId

Returns:


 
  array: 
   
    string - key

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

string sessionKey

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

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

string sessionKey
array:
- int - serverIds

Returns:


 
  array: 
   
    struct - server details 
     
      int "id" - The server's id
      string "name" - The server's name
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in (in UTC)
      int "ram" - The amount of physical memory in MB.
      int "swap" - The amount of swap space in MB.
      struct "network_devices" - The server's network devices struct - network device 
      
       string "ip" - IP address assigned to this network device
       string "interface" - Network interface assigned to device e.g. eth0
       string "netmask" - Network mask assigned to device
       string "hardware_address" - Hardware Address of device.
       string "module" - Network driver used for this device.
       string "broadcast" - Broadcast address for device.
       array "ipv6" - List of IPv6 addresses array: 
       
        struct - ipv6 address 
         
          string "address" - IPv6 address of this network device
          string "netmask" - IPv6 netmask of this network device
          string "scope" - IPv6 address scope
         
       
      
      struct "dmi_info" - The server's dmi info struct - DMI 
      
       string "vendor"
       string "system"
       string "product"
       string "asset"
       string "board"
       string "bios_release" - (optional)
       string "bios_vendor" - (optional)
       string "bios_version" - (optional)
      
      struct "cpu_info" - The server's cpu info struct - CPU 
      
       string "cache"
       string "family"
       string "mhz"
       string "flags"
       string "model"
       string "vendor"
       string "arch"
       string "stepping"
       string "count"
       int "socket_count (if available)"
      
      array "subscribed_channels" - List of subscribed channels array: 
      
       struct - channel 
        
         int "channel_id" - The channel id.
         string "channel_label" - The channel label.
        
      
      array "active_guest_system_ids" - List of virtual guest system ids for active guests array: 
      
       
       int "guest_id" - The guest's system id.

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

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - user 
     
      int "id"
      string "login"
      string "login_uc" - upper case version of the login
      boolean "enabled" - true if user is enabled, false if the user is disabled

Method: listAllInstallablePackages Description:
Get the list of all installable packages for a given system. Parameters:

string sessionKey
int serverId

Returns:


 
  struct - package 
   
    string "name"
    string "version"
    string "release"
    string "epoch"
    int "id"
    string "arch_label"

Method: listBaseChannels Description:
Returns a list of subscribable base channels. Deprecated - being replaced by listSubscribableBaseChannels(string sessionKey, int serverId) 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

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:

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - child channel 
     
      int "id"
      string "name"
      string "label"
      string "summary"
      string "has_license"
      string "gpg_key_url"

Method: listDuplicatesByHostname Description:
List duplicate systems by Hostname. Parameters:

string sessionKey

Returns:


 
  array: 
   
    struct - Duplicate Group 
     
      string "hostname"
      array "systems" 
       
        struct - system 
         
          int "systemId"
          string "systemName"
          dateTime.iso8601 "last_checkin" - Last time server successfully checked in

Method: listDuplicatesByIp Description:
List duplicate systems by IP Address. Parameters:

string sessionKey

Returns:


 
  array: 
   
    struct - Duplicate Group 
     
      string "ip"
      array "systems" 
       
        struct - system 
         
          int "systemId"
          string "systemName"
          dateTime.iso8601 "last_checkin" - Last time server successfully checked in

Method: listDuplicatesByMac Description:
List duplicate systems by Mac Address. Parameters:

string sessionKey

Returns:


 
  array: 
   
    struct - Duplicate Group 
     
      string "mac"
      array "systems" 
       
        struct - system 
         
          int "systemId"
          string "systemName"
          dateTime.iso8601 "last_checkin" - Last time server successfully checked in

Method: listExtraPackages Description:
List extra packages for a system Parameters:

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - package 
     
      string "name"
      string "version"
      string "release"
      string "epoch" - returned only if non-zero
      string "arch"
      date "installtime" - returned only if known

Method: listGroups Description:
List the available groups for a given system. Parameters:

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - system group 
     
      int "id" - server group id
      int "subscribed" - 1 if the given server is subscribed to this server group, 0 otherwise
      string "system_group_name" - Name of the server group
      string "sgid" - server group id (Deprecated)

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

string sessionKey

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

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

string sessionKey
int days

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

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

string sessionKey
array:
- int - serverId
string packageName

Returns:


 
  array: 
   
    struct - system 
     
      int "id" - server ID
      string "name" - server name
      struct "package" - package structure struct - package 
      
       int "id"
       string "name"
       string "version"
       string "release"
       string "epoch"
       string "arch"

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"
      int "id"
      string "arch_label"

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

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - package 
     
      string "name"
      string "arch"
      string "from_version"
      string "from_release"
      string "from_epoch"
      string "to_version"
      string "to_release"
      string "to_epoch"
      string "to_package_id"

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: listNotes Description:
Provides a list of notes associated with a system. Parameters:

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - note details 
     
      int "id"
      string "subject" - Subject of the note
      string "note" - Contents of the note
      int "system_id" - The id of the system associated with the note
      string "creator" - Creator of the note if exists (optional)
      date "updated" - Date of the last note update

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"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

Method: listPackageProfiles Description:
List the package profiles in this organization Parameters:

string sessionKey

Returns:


 
  array: 
   
    struct - package profile 
     
      int "id"
      string "name"
      string "channel"

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

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - package 
     
      string "name"
      string "version"
      string "release"
      string "epoch"
      string "arch"
      date "installtime" - returned only if known

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"
      int "id"
      string "arch_label"
      string "path" - The path on that file system that the package resides
      string "provider" - The provider of the package, determined by the gpg key it was signed with.
      dateTime.iso8601 "last_modified"

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

string sessionKey

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

Method: listSubscribableBaseChannels 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

Method: listSubscribableChildChannels 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"

Method: listSubscribedChildChannels Description:
Returns a list of subscribed child channels. Parameters:

string sessionKey
int serverId

Returns:


 
  array: 
   
    struct - channel 
     
      int "id"
      string "name"
      string "label"
      string "arch_name"
      string "arch_label"
      string "summary"
      string "description"
      string "checksum_label"
      dateTime.iso8601 "last_modified"
      string "maintainer_name"
      string "maintainer_email"
      string "maintainer_phone"
      string "support_policy"
      string "gpg_key_url"
      string "gpg_key_id"
      string "gpg_key_fp"
      dateTime.iso8601 "yumrepo_last_sync" - (optional)
      string "end_of_life"
      string "parent_channel_label"
      string "clone_original" array: 
      
       struct - contentSources 
        
         int "id"
         string "label"
         string "sourceUrl"
         string "type"

Method: listSuggestedReboot Description:
List systems that require reboot. Parameters:

string sessionKey

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"

Method: listSystemEvents Description:
List system actions of the specified type that were *scheduled* against the given server. "actionType" should be exactly the string returned in the action_type field from the listSystemEvents(sessionKey, serverId) method. For example, 'Package Install' or 'Initiate a kickstart for a virtual guest.' Note: see also system.getEventHistory method which returns a history of all events. Parameters:

string sessionKey
int serverId - ID of system.
string actionType - Type of the action.

Returns:


 
  array: 
   
    struct - action 
     
      int "failed_count" - Number of times action failed.
      string "modified" - Date modified. (Deprecated by modified_date)
      dateTime.iso8601 "modified_date" - Date modified.
      string "created" - Date created. (Deprecated by created_date)
      dateTime.iso8601 "created_date" - Date created.
      string "action_type"
      int "successful_count" - Number of times action was successful.
      string "earliest_action" - Earliest date this action will occur.
      int "archived" - If this action is archived. (1 or 0)
      string "scheduler_user" - available only if concrete user has scheduled the action
      string "prerequisite" - Pre-requisite action. (optional)
      string "name" - Name of this action.
      int "id" - Id of this action.
      string "version" - Version of action.
      string "completion_time" - The date/time the event was completed. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by completed_date)
      dateTime.iso8601 "completed_date" - The date/time the event was completed. (optional)
      string "pickup_time" - The date/time the action was picked up. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by pickup_date)
      dateTime.iso8601 "pickup_date" - The date/time the action was picked up. (optional)
      string "result_msg" - The result string after the action executes at the client machine. (optional)
      array "additional_info" - This array contains additional information for the event, if available. 
       
        struct - info 
         
          string "detail" - The detail provided depends on the specific event. For example, for a package event, this will be the package name, for an errata event, this will be the advisory name and synopsis, for a config file event, this will be path and optional revision information...etc.
          string "result" - The result (if included) depends on the specific event. For example, for a package or errata event, no result is included, for a config file event, the result might include an error (if one occurred, such as the file was missing) or in the case of a config file comparison it might include the differenes found.

Available since: 10.8 Method: listSystemEvents Description:
List all system actions that were *scheduled* against the given server. This may require the caller to filter the result to fetch actions with a specific action type or to use the overloaded system.listSystemEvents method with actionType as a parameter. Note: see also system.getEventHistory method which returns a history of all events. Parameters:

string sessionKey
int serverId - ID of system.

Returns:


 
  array: 
   
    struct - action 
     
      int "failed_count" - Number of times action failed.
      string "modified" - Date modified. (Deprecated by modified_date)
      dateTime.iso8601 "modified_date" - Date modified.
      string "created" - Date created. (Deprecated by created_date)
      dateTime.iso8601 "created_date" - Date created.
      string "action_type"
      int "successful_count" - Number of times action was successful.
      string "earliest_action" - Earliest date this action will occur.
      int "archived" - If this action is archived. (1 or 0)
      string "scheduler_user" - available only if concrete user has scheduled the action
      string "prerequisite" - Pre-requisite action. (optional)
      string "name" - Name of this action.
      int "id" - Id of this action.
      string "version" - Version of action.
      string "completion_time" - The date/time the event was completed. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by completed_date)
      dateTime.iso8601 "completed_date" - The date/time the event was completed. (optional)
      string "pickup_time" - The date/time the action was picked up. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by pickup_date)
      dateTime.iso8601 "pickup_date" - The date/time the action was picked up. (optional)
      string "result_msg" - The result string after the action executes at the client machine. (optional)
      array "additional_info" - This array contains additional information for the event, if available. 
       
        struct - info 
         
          string "detail" - The detail provided depends on the specific event. For example, for a package event, this will be the package name, for an errata event, this will be the advisory name and synopsis, for a config file event, this will be path and optional revision information...etc.
          string "result" - The result (if included) depends on the specific event. For example, for a package or errata event, no result is included, for a config file event, the result might include an error (if one occurred, such as the file was missing) or in the case of a config file comparison it might include the differenes found.

Available since: 10.8 Method: listSystems Description:
Returns a list of all servers visible to the user. Parameters:

string sessionKey

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

Method: listSystemsWithExtraPackages Description:
List systems with extra packages Parameters:

string sessionKey

Returns:


 
  array: 
   
    struct - system 
     
      int "id" - System ID
      string "name" - System profile name
      int "extra_pkg_count" - Extra packages count

Method: listSystemsWithPackage Description:
Lists the systems that have the given installed package Parameters:

string sessionKey
int pid - the package id

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

Method: listSystemsWithPackage Description:
Lists the systems that have the given installed package Parameters:

string sessionKey
string name - the package name
string version - the package version
string release - the package release

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

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

string sessionKey

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

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
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

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
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

Method: listVirtualGuests Description:
Lists the virtual guests for a given virtual host Parameters:

string sessionKey
int sid - the virtual host's id

Returns:


 
  array: 
   
    struct - virtual system 
     
      int "id"
      string "name"
      string "guest_name" - The virtual guest name as provided by the virtual host
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in.
      string "uuid"

Method: listVirtualHosts Description:
Lists the virtual hosts visible to the user Parameters:

string sessionKey

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

Method: obtainReactivationKey Description:
Obtains a reactivation key for this server. Parameters:

string sessionKey
int serverId

Returns:


 
  string

Method: obtainReactivationKey Description:
Obtains a reactivation key for this server. Parameters:

string systemid - systemid file

Returns:


 
  string

Available since: 10.10 Method: provisionSystem Description:
Provision a system using the specified kickstart profile. Parameters:

string sessionKey
int serverId - ID of the system to be provisioned.
string profileName - Kickstart profile to use.

Returns:


 
  int - ID of the action scheduled, otherwise exception thrown on error

Method: provisionSystem Description:
Provision a system using the specified kickstart profile. Parameters:

string sessionKey
int serverId - ID of the system to be provisioned.
string profileName - Kickstart profile to use.
dateTime.iso8601 earliestDate

Returns:


 
  int - ID of the action scheduled, otherwise exception thrown on error

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

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

Returns:


 
  int - 1 on success, exception thrown otherwise.

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:

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 storageGb - Size of the guests disk image.

Returns:


 
  int - 1 on success, exception thrown otherwise.

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 storageGb - Size of the guests disk image.
string macAddress - macAddress to give the guest's virtual networking hardware.

Returns:


 
  int - 1 on success, exception thrown otherwise.

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:
Schedules an action to apply errata updates to multiple systems. Parameters:

string sessionKey
array:
- int - serverId
array:
- int - errataId

Returns:


 
  array: 
   
    int - actionId

Available since: 13.0 Method: scheduleApplyErrata Description:
Schedules an action to apply errata updates to multiple systems. Parameters:

string sessionKey
array:
- int - serverId
array:
- int - errataId
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  array: 
   
    int - actionId

Available since: 21 Method: scheduleApplyErrata Description:
Schedules an action to apply errata updates to multiple systems at a given date/time. Parameters:

string sessionKey
array:
- int - serverId
array:
- int - errataId
dateTime.iso8601 earliestOccurrence

Returns:


 
  array: 
   
    int - actionId

Available since: 13.0 Method: scheduleApplyErrata Description:
Schedules an action to apply errata updates to multiple systems at a given date/time. Parameters:

string sessionKey
array:
- int - serverId
array:
- int - errataId
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  array: 
   
    int - actionId

Available since: 21 Method: scheduleApplyErrata Description:
Schedules an action to apply errata updates to a system. Parameters:

string sessionKey
int serverId
array:
- int - errataId

Returns:


 
  array: 
   
    int - actionId

Available since: 13.0 Method: scheduleApplyErrata Description:
Schedules an action to apply errata updates to a system. Parameters:

string sessionKey
int serverId
array:
- int - errataId
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  array: 
   
    int - actionId

Available since: 21 Method: scheduleApplyErrata Description:
Schedules an action to apply errata updates to a system at a given date/time. Parameters:

string sessionKey
int serverId
array:
- int - errataId
dateTime.iso8601 earliestOccurrence

Returns:


 
  array: 
   
    int - actionId

Available since: 13.0 Method: scheduleApplyErrata Description:
Schedules an action to apply errata updates to a system at a given date/time. Parameters:

string sessionKey
int serverId
array:
- int - errataId
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  array: 
   
    int - actionId

Available since: 21 Method: scheduleCertificateUpdate Description:
Schedule update of client certificate Parameters:

string sessionKey
int serverId

Returns:


 
  int actionId - The action id of the scheduled action

Method: scheduleCertificateUpdate Description:
Schedule update of client certificate at given date and time Parameters:

string sessionKey
int serverId
dateTime.iso860 date

Returns:


 
  int actionId - The action id of the scheduled action

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

string sessionKey
int sid - the system Id of the guest
string state - One of the following actions 'start', 'suspend', 'resume', 'restart', 'shutdown'.
dateTime.iso8601 date - the time/date to schedule the action

Returns:


 
  int actionId - The action id of the scheduled action

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

string sessionKey
int sid - the system Id of the guest
string state - One of the following actions 'start', 'suspend', 'resume', 'restart', 'shutdown'.

Returns:


 
  int actionId - The action id of the scheduled action

Method: scheduleHardwareRefresh Description:
Schedule a hardware refresh for a system. Parameters:

string sessionKey
int serverId
dateTime.iso8601 earliestOccurrence

Returns:


 
  int actionId - The action id of the scheduled action

Available since: 13.0 Method: schedulePackageInstall Description:
Schedule package installation for several systems. Parameters:

string sessionKey
array:
- int - serverId
array:
- int - packageId
dateTime.iso8601 earliestOccurrence

Returns:


 
  array: 
   
    int - actionId

Method: schedulePackageInstall Description:
Schedule package installation for several systems. Parameters:

string sessionKey
array:
- int - serverId
array:
- int - packageId
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  array: 
   
    int - actionId

Available since: 21 Method: schedulePackageInstall Description:
Schedule package installation for a system. Parameters:

string sessionKey
int serverId
array:
- int - packageId
dateTime.iso8601 earliestOccurrence

Returns:


 
  int actionId - The action id of the scheduled action

Available since: 13.0 Method: schedulePackageInstall Description:
Schedule package installation for a system. Parameters:

string sessionKey
int serverId
array:
- int - packageId
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  int actionId - The action id of the scheduled action

Available since: 21 Method: schedulePackageInstallByNevra Description:
Schedule package installation for several systems. Parameters:

string sessionKey
array:
- int - serverId
array:
- struct - Package nevra
  - string "package_name"
  - string "package_epoch"
  - string "package_version"
  - string "package_release"
  - string "package_arch"
dateTime.iso8601 earliestOccurrence

Returns:


 
  array: 
   
    int - actionId

Method: schedulePackageInstallByNevra Description:
Schedule package installation for several systems. Parameters:

string sessionKey
array:
- int - serverId
array:
- struct - Package nevra
  - string "package_name"
  - string "package_epoch"
  - string "package_version"
  - string "package_release"
  - string "package_arch"
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  array: 
   
    int - actionId

Available since: 21 Method: schedulePackageInstallByNevra Description:
Schedule package installation for a system. Parameters:

string sessionKey
int serverId
array:
- struct - Package nevra
  - string "package_name"
  - string "package_epoch"
  - string "package_version"
  - string "package_release"
  - string "package_arch"
dateTime.iso8601 earliestOccurrence

Returns:


 
  int actionId - The action id of the scheduled action

Method: schedulePackageInstallByNevra Description:
Schedule package installation for a system. Parameters:

string sessionKey
int serverId
array:
- struct - Package nevra
  - string "package_name"
  - string "package_epoch"
  - string "package_version"
  - string "package_release"
  - string "package_arch"
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  int actionId - The action id of the scheduled action

Available since: 21 Method: schedulePackageRefresh Description:
Schedule a package list refresh for a system. Parameters:

string sessionKey
int serverId
dateTime.iso8601 earliestOccurrence

Returns:


 
  int - ID of the action scheduled, otherwise exception thrown on error

Method: schedulePackageRemove Description:
Schedule package removal for several systems. Parameters:

string sessionKey
array:
- int - serverId
array:
- int - packageId
dateTime.iso8601 earliestOccurrence

Returns:


 
  array: 
   
    int - actionId

Method: schedulePackageRemove Description:
Schedule package removal for several systems. Parameters:

string sessionKey
array:
- int - serverId
array:
- int - packageId
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  array: 
   
    int - actionId

Available since: 21 Method: schedulePackageRemove Description:
Schedule package removal for a system. Parameters:

string sessionKey
int serverId
array:
- int - packageId
dateTime.iso8601 earliestOccurrence

Returns:


 
  int actionId - The action id of the scheduled action

Method: schedulePackageRemove Description:
Schedule package removal for a system. Parameters:

string sessionKey
int serverId
array:
- int - packageId
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  int actionId - The action id of the scheduled action

Available since: 21 Method: schedulePackageRemoveByNevra Description:
Schedule package removal for several systems. Parameters:

string sessionKey
array:
- int - serverId
array:
- struct - Package nevra
  - string "package_name"
  - string "package_epoch"
  - string "package_version"
  - string "package_release"
  - string "package_arch"
dateTime.iso8601 earliestOccurrence

Returns:


 
  array: 
   
    int - actionId

Method: schedulePackageRemoveByNevra Description:
Schedule package removal for several systems. Parameters:

string sessionKey
array:
- int - serverId
array:
- struct - Package nevra
  - string "package_name"
  - string "package_epoch"
  - string "package_version"
  - string "package_release"
  - string "package_arch"
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  array: 
   
    int - actionId

Available since: 21 Method: schedulePackageRemoveByNevra Description:
Schedule package removal for a system. Parameters:

string sessionKey
int serverId
array:
- struct - Package nevra
  - string "package_name"
  - string "package_epoch"
  - string "package_version"
  - string "package_release"
  - string "package_arch"
dateTime.iso8601 earliestOccurrence

Returns:


 
  array: 
   
    int - actionId

Method: schedulePackageRemoveByNevra Description:
Schedule package removal for a system. Parameters:

string sessionKey
int serverId
array:
- struct - Package nevra
  - string "package_name"
  - string "package_epoch"
  - string "package_version"
  - string "package_release"
  - string "package_arch"
dateTime.iso8601 earliestOccurrence
boolean allowModules - Allow this API call, despite modular content being present

Returns:


 
  array: 
   
    int - actionId

Available since: 21 Method: scheduleReboot Description:
Schedule a reboot for a system. Parameters:

string sessionKey
int serverId
dateTime.iso860 earliestOccurrence

Returns:


 
  int actionId - The action id of the scheduled action

Available since: 13.0 Method: scheduleScriptRun Description:
Schedule a script to run. Parameters:

string sessionKey
string label
array:
- int - System IDs of the servers to run the script on.
string username - User to run script as.
string groupname - Group to run script as.
int timeout - Seconds to allow the script to run before timing out.
string script - Contents of the script to run.
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: scheduleScriptRun Description:
Schedule a script to run. Parameters:

string sessionKey
array:
- int - System IDs of the servers to run the script on.
string username - User to run script as.
string groupname - Group to run script as.
int timeout - Seconds to allow the script to run before timing out.
string script - Contents of the script to run.
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: 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: scheduleScriptRun Description:
Schedule a script to run. Parameters:

string sessionKey
string label
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 date - Date to schedule action for

Returns:


 
  int actionId - The action id of the scheduled action

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:

string sessionKey
string regexp - A regular expression

Returns:


 
  array: 
   
    struct - system 
     
      int "id"
      string "name"
      dateTime.iso8601 "last_checkin" - Last time server successfully checked in
      dateTime.iso8601 "last_boot" - Last server boot time
      dateTime.iso8601 "created" - Server registration time

Method: sendOsaPing Description:
send a ping to a system using OSA Parameters:

string sessionKey
int serverId

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: setBaseChannel Description:
Assigns the server to a new baseChannel. Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string channelLabel) Parameters:

string sessionKey
int serverId
int channelId

Returns:


 
  int - 1 on success, exception thrown otherwise.

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:

string sessionKey
int serverId
string channelLabel

Returns:


 
  int - 1 on success, exception thrown otherwise.

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:

string sessionKey
int serverId
array:
- int (deprecated) or string - channelId (deprecated) or channelLabel

Returns:


 
  int - 1 on success, exception thrown otherwise.

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, exception thrown otherwise.

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
- string "profile_name" - System's profile name
- string "base_entitlement" - System's base entitlement label. (enterprise_entitled or unentitle)
- boolean "auto_errata_update" - True if system has auto errata updates enabled
- string "description" - System description
- string "address1" - System's address line 1.
- string "address2" - System's address line 2.
- string "city"
- string "state"
- string "country"
- string "building"
- string "room"
- string "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
boolean member - '1' to assign the given server to the given server group, '0' to remove the given server from the given server group.

Returns:


 
  int - 1 on success, exception thrown otherwise.

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

string sessionKey
int sid - The guest's system id
int numOfCpus - The number of virtual cpus to allocate to the guest

Returns:


 
  int actionID - the action Id for the schedule action on the host system.

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

string sessionKey
int sid - The guest's system id
int memory - The amount of memory to allocate to the guest

Returns:


 
  int actionID - the action Id for the schedule action on the host system.

Method: setLockStatus Description:
Set server lock status. Parameters:

string sessionKey
int serverId
boolean lockStatus - true to lock the system, false to unlock the system.

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: setPrimaryInterface Description:
Sets new primary network interface Parameters:

string sessionKey
int serverId
string interfaceName

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: setProfileName Description:
Set the profile name for the server. Parameters:

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

Returns:


 
  int - 1 on success, exception thrown otherwise.

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:

string sessionKey
int serverId
boolean netboot
array:
- struct - kickstart variable
  - string "key"
  - string or int "value"

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: tagLatestSnapshot Description:
Tags latest system snapshot Parameters:

string sessionKey
int serverId
string tagName

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: unentitle Description:
Unentitle the system completely Parameters:

string systemid - systemid file

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: upgradeEntitlement Description:
Adds an entitlement to a given server. Parameters:

string sessionKey
int serverId
string entitlementName - One of: 'enterprise_entitled' or 'virtualization_host'.

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: whoRegistered Description:
Returns information about the user who registered the system Parameters:

string sessionKey
int sid - Id of the system in question

Returns:


 
  struct - user 
   
    int "id"
    string "login"
    string "login_uc" - upper case version of the login
    boolean "enabled" - true if user is enabled, false if the user is disabled

Generated on 3/4/2020

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4