Red Hat Training

A Red Hat training course is available for Red Hat Satellite

API Guide

Red Hat Satellite 5.8

A reference guide to the Red Hat Satellite API

Red Hat Satellite Documentation Team

Abstract

This book provides an introduction to the XML-RPC API for Red Hat Satellite, and includes several examples of its use.

Chapter 1. Introduction to Red Hat Satellite

Red Hat Satellite provides organizations with the benefits of Red Hat Network without the need for public Internet access for servers or client systems. Red Hat Satellite also provides the following benefits:
  • You have complete control and privacy over package management and server maintenance within your own networks.
  • You can store System Profiles on a Satellite server, which connects to the Red Hat Network website using a local web server.
  • You can perform package management tasks, including errata updates, through the local area network.
This gives Red Hat Network customers the greatest flexibility and power to keep servers secure and up-to-date.

1.1. The Red Hat Satellite API

Red Hat Satellite includes an application programming interface (API), which offers software developers and system administrators control over their Satellite servers outside of the standard web and command line interfaces. The API is useful for developers and administrators who aim to integrate the functionality of a Red Hat Satellite with custom scripts or external applications that access the API via XML remote procedure call (RPC) protocol, or XML-RPC.
This guide aims to provide developers and administrators with instructions and examples to help harness the functionality of their Red Hat Satellite through the XML-RPM protocol.

1.2. Using XML-RPC with the Red Hat Satellite API

XML-RPC uses HTTP to send an XML-encoded request to a server. The request contains the following:
Namespace
A namespace is a grouping of methods based upon a particular function, object or resource. For example, the auth namespace groups authentication function, or the errata namespace groups function that control errata.
Method
A method represents a certain action. Each method controls a specific function of the Red Hat Satellite. For example, the login method in the auth namespace logs a user into Red Hat Satellite and returns a session key.
Parameter
A parameter is a piece of input to control specific aspects of a method. For example, the login method in the auth namespace requires username and password parameters to specify the login details of a certain user. The login method also accepts an optional duration parameter to specify the length of time until the user session expires..
The XML-encoded request usually appears in the following structure:
<methodCall>
  <methodName>namespace.method</methodName>
  <params>
    <param>
      <value><name>parameter</name></value>
    </param>
    <param>
      <value><name>parameter</name></value>
    </param>
    ...
  </params>
</methodCall>
For example, use the following XML-RPC request to login to the API and request a session key for authentication:
<methodCall>
  <methodName>auth.login</methodName>
  <params>
    <param>
      <value><username>admin</username></value>
    </param>
    <param>
      <value><password>p@55w0rd!</password></value>
    </param>
  </params>
</methodCall>
In this example, the request sends the username and password as a parameters to the login method, which is a part of the auth namespace. The Satellite server returns the following response:
<methodResponse>
  <params>
    <param>
      <value><sessionKey>83d8b35f</sessionKey></value>
    </param>
  </params>
</methodResponse>
The response contains a returned parameter for sessionKey, which is a key used to authenticate most of the API methods.
Most programming languages include XML-RPC modules and libraries that automatically parse the desired method and parameters into the XML-encoded request and parse the resulting response as returned variable. For examples, see Chapter 2, Examples.
For more information about XML-RPC, see http://www.xmlrpc.com/.

1.3. Using the Read-only API

Red Hat Satellite 5.8 features a read-only API that is designed to provide a safe way of auditing and generating reports of the contents of the Satellite server. Read-only users cannot log in to the Satellite web UI or perform other actions that can affect the functionality of the Satellite. For example, read-only users cannot make back-end calls or use API calls that modify content.
Read-only API users can only use non-destructive API calls, such as org.listUsers; in short, they are denied access to any API call that does not start with list, is, or get. In addition, read-only users require the same role specifications as normal users to gain access to the API calls associated with those roles. This leads to the concept where a read-only channel administrator can make API calls such as channel.listAllChannels but cannot call org.listUsers because the organization administrator rights are not available.

1.3.1. Creating a Read-only User

Use the same procedure to create a read-only user as for any other type of user, but ensure you select the Read only API user as part of the process.

Procedure 1.1. To Create a Read-only API User:

  1. Click the Users tab on the main menu, and then click Create User.
  2. Complete the required details, and select Read-only API User.
  3. Click Create Login.

Chapter 2. Examples

The following sections demonstrate Red Hat Satellite API usage using different programming languages and their respective XML-RPC requests.

2.1. Python Examples

The following example demonstrates the user.listUsers call. The example prints the name of each group.
#!/usr/bin/python
import xmlrpclib

SATELLITE_URL = "http://satellite.example.com/rpc/api"
SATELLITE_LOGIN = "username"
SATELLITE_PASSWORD = "password"

client = xmlrpclib.Server(SATELLITE_URL, verbose=0)

key = client.auth.login(SATELLITE_LOGIN, SATELLITE_PASSWORD)
list = client.user.list_users(key)
for user in list:
   print user.get('login')

client.auth.logout(key)
The following example shows how to use date-time parameters. This code schedules the installation of package rhnlib-2.5.22.9.el6.noarch to system with id 1000000001.
#!/usr/bin/python
from datetime import datetime
import time
import xmlrpclib

SATELLITE_URL = "http://satellite.example.com/rpc/api"
SATELLITE_LOGIN = "username"
SATELLITE_PASSWORD = "password"

client = xmlrpclib.Server(SATELLITE_URL, verbose=0)

key = client.auth.login(SATELLITE_LOGIN, SATELLITE_PASSWORD)
package_list = client.packages.findByNvrea(key, 'rhnlib', '2.5.22', '9.el6', '', 'noarch')
today = datetime.today()
earliest_occurrence = xmlrpclib.DateTime(today)
client.system.schedulePackageInstall(key, 1000000001, package_list[0]['id'], earliest_occurrence)

client.auth.logout(key)

The following example show how to check channels for their last synchronization:
#!/usr/bin/python
import xmlrpclib

SATELLITE_URL = "http://sat57.example.com/rpc/api"
SATELLITE_LOGIN = "admin"
SATELLITE_PASSWORD = "Redhat123"

client = xmlrpclib.Server(SATELLITE_URL, verbose=0)

key = client.auth.login(SATELLITE_LOGIN, SATELLITE_PASSWORD)
list = client.channel.listAllChannels(key)

for item in list:
  details = client.channel.software.getDetails(key, item['label'])
  print item
  print details
  print "Name: " + details['name']
  try:
    print "Last Sync: " + details['yumrepo_last_sync']
  except:
    print "Last Sync: Never"

client.auth.logout(key)

2.2. Perl Example

This example uses the system.listUserSystems call to retrieve a list of systems a user can access. The example prints the name of each system. The Frontier::Client Perl module is found in the perl-Frontier-RPC RPM file.
#!/usr/bin/perl
use Frontier::Client;

my $HOST = 'satellite.example.com';
my $user = 'username';
my $pass = 'password';

my $client = new Frontier::Client(url => "http://$HOST/rpc/api");
my $session = $client->call('auth.login',$user, $pass);

my $systems = $client->call('system.listUserSystems', $session);
foreach my $system (@$systems) {
   print $system->{'name'}."\n";
}
$client->call('auth.logout', $session);

2.3. Ruby Example

The following example demonstrates the channel.listAllChannels API call. The example prints a list of channel labels.
#!/usr/bin/env ruby
require "xmlrpc/client"

@SATELLITE_URL = "http://satellite.example.com/rpc/api"
@SATELLITE_LOGIN = "username"
@SATELLITE_PASSWORD = "password"

@client = XMLRPC::Client.new2(@SATELLITE_URL)

@key = @client.call('auth.login', @SATELLITE_LOGIN, @SATELLITE_PASSWORD)
channels = @client.call('channel.listAllChannels', @key)
for channel in channels do
   p channel["label"]
end

@client.call('auth.logout', @key)

Part I. Methods

Chapter 3. actionchain

Abstract

Provides the namespace for the Action Chain methods.

3.1. addConfigurationDeployment

Name
addConfigurationDeployment
Description
Adds an action to deploy a configuration file to an Action Chain.
Parameters
  • string sessionKey - Session token, issued at login
  • string chainLabel - Label of the chain
  • int System ID - System ID
  • array:
    • int - Revision ID
Return Value
  • int - 1 on success, exception thrown otherwise.

3.2. addErrataUpdate

Name
addErrataUpdate
Description
Adds Errata update to an Action Chain.
Parameters
  • string sessionKey - Session token, issued at login
  • int serverId - System ID
  • array:
    • int - Errata ID
  • string chainLabel - Label of the chain
Return Value
  • int actionId - The action id of the scheduled action

3.3. addPackageInstall

Name
addPackageInstall
Description
Adds package installation action to an Action Chain.
Parameters
  • string sessionKey - Session token, issued at login
  • int serverId - System ID
  • array:
    • int - Package ID
  • string chainLabel
Return Value
  • int - 1 on success, exception thrown otherwise.

3.4. addPackageRemoval

Name
addPackageRemoval
Description
Adds an action to remove installed packages on the system to an Action Chain.
Parameters
  • string sessionKey - Session token, issued at login
  • int serverId - System ID
  • array:
    • int - Package ID
  • string chainLabel - Label of the chain
Return Value
  • int actionId - The action id of the scheduled action or exception

3.5. addPackageUpgrade

Name
addPackageUpgrade
Description
Adds an action to upgrade installed packages on the system to an Action Chain.
Parameters
  • string sessionKey - Session token, issued at login
  • int serverId - System ID
  • array:
    • int - packageId
  • string chainLabel - Label of the chain
Return Value
  • int actionId - The id of the action or throw an exception

3.6. addPackageVerify

Name
addPackageVerify
Description
Adds an action to verify installed packages on the system to an Action Chain.
Parameters
  • string sessionKey - Session token, issued at login
  • int serverId - System ID
  • array:
    • int - packageId
  • string chainLabel - Label of the chain
Return Value
  • int - 1 on success, exception thrown otherwise.

3.7. addScriptRun

Name
addScriptRun
Description
Add an action to run a script to an Action Chain. NOTE: The script body must be Base64 encoded!
Parameters
  • string sessionKey - Session token, issued at login
  • int serverId - System ID
  • string chainLabel - Label of the chain
  • string uid - User ID on the particular system
  • string gid - Group ID on the particular system
  • int timeout - Timeout
  • string scriptBodyBase64 - Base64 encoded script body
Return Value
  • int actionId - The id of the action or throw an exception

3.8. addSystemReboot

Name
addSystemReboot
Description
Add system reboot to an Action Chain.
Parameters
  • string sessionKey - Session token, issued at login
  • int serverId
  • string chainLabel - Label of the chain
Return Value
  • int actionId - The action id of the scheduled action

3.9. createChain

Name
createChain
Description
Create an Action Chain.
Parameters
  • string sessionKey - Session token, issued at login
  • string chainLabel - Label of the chain
Return Value
  • int actionId - The ID of the created action chain

3.10. deleteChain

Name
deleteChain
Description
Delete action chain by label.
Parameters
  • string sessionKey - Session token, issued at login
  • string chainLabel - Label of the chain
Return Value
  • int - 1 on success, exception thrown otherwise.

3.11. listChainActions

Name
listChainActions
Description
List all actions in the particular Action Chain.
Parameters
  • string sessionKey - Session token, issued at login
  • string chainLabel - Label of the chain
Return Value
  • array:
    • struct - entry
      • int id - Action ID
      • string label - Label of an Action
      • string created - Created date/time
      • string earliest - Earliest scheduled date/time
      • string type - Type of the action
      • string modified - Modified date/time
      • string cuid - Creator UID

3.12. listChains

Name
listChains
Description
List currently available action chains.
Parameters
  • string sessionKey - Session token, issued at login
Return Value
  • array:
    • struct - chain
      • string label - Label of an Action Chain
      • string entrycount - Number of entries in the Action Chain

3.13. removeAction

Name
removeAction
Description
Remove an action from an Action Chain.
Parameters
  • string sessionKey - Session token, issued at login
  • string chainLabel - Label of the chain
  • int actionId - Action ID
Return Value
  • int - 1 on success, exception thrown otherwise.

3.14. renameChain

Name
renameChain
Description
Rename an Action Chain.
Parameters
  • string sessionKey - Session token, issued at login
  • string previousLabel - Previous chain label
  • string newLabel - New chain label
Return Value
  • int - 1 on success, exception thrown otherwise.

3.15. scheduleChain

Name
scheduleChain
Description
Schedule the Action Chain so that its actions will actually occur.
Parameters
  • string sessionKey - Session token, issued at login
  • string chainLabel - Label of the chain
  • dateTime.iso8601 Earliest date
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 4. activationkey

Abstract

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

4.1. addChildChannels

Name
addChildChannels
Description
Add child channels to an activation key.
Parameters
  • string sessionKey
  • string key
  • array:
    • string - childChannelLabel
Return Value
  • int - 1 on success, exception thrown otherwise.

4.2. addConfigChannels

Name
addConfigChannels
Description
Given a list of activation keys and configuration channels, this method adds given configuration channels to either the top or the bottom (whichever you specify) of an activation key's configuration channels list. The ordering of the configuration channels provided in the add list is maintained while adding. If one of the configuration channels in the 'add' list already exists in an activation key, the configuration channel will be re-ranked to the appropriate place.
Parameters
  • string sessionKey
  • array:
    • string - activationKey
  • array:
    • string - List of configuration channel labels in the ranked order.
  • boolean addToTop
    • true - To prepend the given channels to the beginning of the activation key's config channel list
    • false - To append the given channels to the end of the activation key's config channel list
Return Value
  • int - 1 on success, exception thrown otherwise.

4.3. addEntitlements

Name
addEntitlements
Description
Add entitlements to an activation key. Currently only add-on entitlements are permitted. (provisioning_entitled, virtualization_host, virtualization_host_platform)
Parameters
  • string sessionKey
  • string key
  • array string - entitlement label
      • provisioning_entitled
      • virtualization_host
      • virtualization_host_platform
Return Value
  • int - 1 on success, exception thrown otherwise.

4.4. addPackageNames

Name
addPackageNames
Description
Add packages to an activation key using package name only.
Deprecated - being replaced by addPackages(string sessionKey, string key, array[packages])
Available since: 10.2
Parameters
  • string sessionKey
  • string key
  • array:
    • string - packageName
Return Value
  • int - 1 on success, exception thrown otherwise.

4.5. addPackages

Name
addPackages
Description
Add packages to an activation key.
Parameters
  • string sessionKey
  • string key
  • array:
    • struct - packages
      • string name - Package name
      • string arch - Arch label - Optional
Return Value
  • int - 1 on success, exception thrown otherwise.

4.6. addServerGroups

Name
addServerGroups
Description
Add server groups to an activation key.
Parameters
  • string sessionKey
  • string key
  • array:
    • int - serverGroupId
Return Value
  • int - 1 on success, exception thrown otherwise.

4.7. checkConfigDeployment

Name
checkConfigDeployment
Description
Check configuration file deployment status for the activation key specified.
Parameters
  • string sessionKey
  • string key
Return Value
  • 1 if enabled, 0 if disabled, exception thrown otherwise.

4.8. clone

Name
clone
Description
Clone an existing activation key.
Parameters
  • string sessionKey
  • string key - Key to be cloned.
  • string cloneDescription - Description of the cloned key.
Return Value
  • string - The new activation key.

4.9. create

Name
create
Description
Create a new activation key. The activation key parameter passed in will be prefixed with the organization ID, and this value will be returned from the create call. Eg. If the caller passes in the key "foo" and belong to an organization with the ID 100, the actual activation key will be "100-foo". This call allows for the setting of a usage limit on this activation key. If unlimited usage is desired see the similarly named API method with no usage limit argument.
Parameters
  • string sessionKey
  • string key - Leave empty to have new key autogenerated.
  • string description
  • string baseChannelLabel - Leave empty to accept default.
  • int usageLimit - If unlimited usage is desired, use the create API that does not include the parameter.
  • array string - Add-on entitlement label to associate with the key.
      • provisioning_entitled
      • virtualization_host
      • virtualization_host_platform
  • boolean universalDefault
Return Value
  • string - The new activation key.

4.10. create

Name
create
Description
Create a new activation key with unlimited usage. The activation key parameter passed in will be prefixed with the organization ID, and this value will be returned from the create call. Eg. If the caller passes in the key "foo" and belong to an organization with the ID 100, the actual activation key will be "100-foo".
Parameters
  • string sessionKey
  • string key - Leave empty to have new key autogenerated.
  • string description
  • string baseChannelLabel - Leave empty to accept default.
  • array string - Add-on entitlement label to associate with the key.
      • provisioning_entitled
      • virtualization_host
      • virtualization_host_platform
  • boolean universalDefault
Return Value
  • string - The new activation key.

4.11. delete

Name
delete
Description
Delete an activation key.
Parameters
  • string sessionKey
  • string key
Return Value
  • int - 1 on success, exception thrown otherwise.

4.12. disableConfigDeployment

Name
disableConfigDeployment
Description
Disable configuration file deployment for the specified activation key.
Parameters
  • string sessionKey
  • string key
Return Value
  • int - 1 on success, exception thrown otherwise.

4.13. enableConfigDeployment

Name
enableConfigDeployment
Description
Enable configuration file deployment for the specified activation key.
Parameters
  • string sessionKey
  • string key
Return Value
  • int - 1 on success, exception thrown otherwise.

4.14. getDetails

Name
getDetails
Description
Lookup an activation key's details.
Available since: 10.2
Parameters
  • string sessionKey
  • string key
Return Value
  • struct - activation key
    • string key
    • string description
    • int usage_limit
    • string base_channel_label
    • array child_channel_labels
      • string - childChannelLabel
    • array entitlements
      • string - entitlementLabel
    • array server_group_ids
      • string - serverGroupId
    • array package_names
      • string - packageName - (deprecated by packages)
    • array packages
      • struct - package
        • string name - packageName
        • string arch - archLabel - optional
    • boolean universal_default
    • boolean disabled

4.15. listActivatedSystems

Name
listActivatedSystems
Description
List the systems activated with the key provided.
Parameters
  • string sessionKey
  • string key
Return Value
  • array:
    • struct - system structure
      • int id - System id
      • string hostname
      • dateTime.iso8601 last_checkin - Last time server successfully checked in

4.16. listActivationKeys

Name
listActivationKeys
Description
List activation keys that are visible to the user.
Available since: 10.2
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - activation key
      • string key
      • string description
      • int usage_limit
      • string base_channel_label
      • array child_channel_labels
        • string - childChannelLabel
      • array entitlements
        • string - entitlementLabel
      • array server_group_ids
        • string - serverGroupId
      • array package_names
        • string - packageName - (deprecated by packages)
      • array packages
        • struct - package
          • string name - packageName
          • string arch - archLabel - optional
      • boolean universal_default
      • boolean disabled

4.17. listConfigChannels

Name
listConfigChannels
Description
List configuration channels associated to an activation key.
Parameters
  • string sessionKey
  • string key
Return Value
  • array:
    • struct - Configuration Channel information
      • int id
      • int orgId
      • string label
      • string name
      • string description
      • struct configChannelType
      • struct - Configuration Channel Type information
        • int id
        • string label
        • string name
        • int priority

4.18. removeChildChannels

Name
removeChildChannels
Description
Remove child channels from an activation key.
Parameters
  • string sessionKey
  • string key
  • array:
    • string - childChannelLabel
Return Value
  • int - 1 on success, exception thrown otherwise.

4.19. removeConfigChannels

Name
removeConfigChannels
Description
Remove configuration channels from the given activation keys.
Parameters
  • string sessionKey
  • array:
    • string - activationKey
  • array:
    • string - configChannelLabel
Return Value
  • int - 1 on success, exception thrown otherwise.

4.20. removeEntitlements

Name
removeEntitlements
Description
Remove entitlements (by label) from an activation key. Currently only add-on entitlements are permitted. ( provisioning_entitled, virtualization_host, virtualization_host_platform)
Parameters
  • string sessionKey
  • string key
  • array string - entitlement label
      • provisioning_entitled
      • virtualization_host
      • virtualization_host_platform
Return Value
  • int - 1 on success, exception thrown otherwise.

4.21. removePackageNames

Name
removePackageNames
Description
Remove package names from an activation key.
Deprecated - being replaced by removePackages(string sessionKey, string key, array[packages])
Available since: 10.2
Parameters
  • string sessionKey
  • string key
  • array:
    • string - packageName
Return Value
  • int - 1 on success, exception thrown otherwise.

4.22. removePackages

Name
removePackages
Description
Remove package names from an activation key.
Parameters
  • string sessionKey
  • string key
  • array:
    • struct - packages
      • string name - Package name
      • string arch - Arch label - Optional
Return Value
  • int - 1 on success, exception thrown otherwise.

4.23. removeServerGroups

Name
removeServerGroups
Description
Remove server groups from an activation key.
Parameters
  • string sessionKey
  • string key
  • array:
    • int - serverGroupId
Return Value
  • int - 1 on success, exception thrown otherwise.

4.24. setConfigChannels

Name
setConfigChannels
Description
Replace the existing set of configuration channels on the given activation keys. Channels are ranked by their order in the array.
Parameters
  • string sessionKey
  • array:
    • string - activationKey
  • array:
    • string - configChannelLabel
Return Value
  • int - 1 on success, exception thrown otherwise.

4.25. setDetails

Name
setDetails
Description
Update the details of an activation key.
Parameters
  • string sessionKey
  • string key
  • struct - activation key
    • string description - optional
    • string base_channel_label - optional - to set default base channel set to empty string or 'none'
    • int usage_limit - optional
    • boolean unlimited_usage_limit - Set true for unlimited usage and to override usage_limit
    • boolean universal_default - optional
    • boolean disabled - optional
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 5. api

Abstract

Methods providing information about the API.

5.1. getApiCallList

Name
getApiCallList
Description
Lists all available api calls grouped by namespace
Parameters
  • string sessionKey
Return Value
  • struct - method_info
    • string name - method name
    • string parameters - method parameters
    • string exceptions - method exceptions
    • string return - method return type

5.2. getApiNamespaceCallList

Name
getApiNamespaceCallList
Description
Lists all available api calls for the specified namespace
Parameters
  • string sessionKey
  • string namespace
Return Value
  • struct - method_info
    • string name - method name
    • string parameters - method parameters
    • string exceptions - method exceptions
    • string return - method return type

5.3. getApiNamespaces

Name
getApiNamespaces
Description
Lists available API namespaces
Parameters
  • string sessionKey
Return Value
  • struct - namespace
    • string namespace - API namespace
    • string handler - API Handler

5.4. getVersion

Name
getVersion
Description
Returns the version of the API. Since Spacewalk 0.4 (Satellite 5.3) it is no more related to server version.
Parameters
  • None
Return Value
  • string

5.5. systemVersion

Name
systemVersion
Description
Returns the server version.
Parameters
  • None
Return Value
  • string

Chapter 6. auth

Abstract

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

6.1. login

Name
login
Description
Login using a username and password. Returns the session key used by most other API methods.
Parameters
  • string username
  • string password
Return Value
  • string sessionKey

6.2. login

Name
login
Description
Login using a username and password. Returns the session key used by other methods.
Parameters
  • string username
  • string password
  • int duration - Length of session.
Return Value
  • string sessionKey

6.3. logout

Name
logout
Description
Logout the user with the given session key.
Parameters
  • string sessionKey
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 7. channel

Abstract

Provides method to get back a list of Software Channels.

7.1. listAllChannels

Name
listAllChannels
Description
List all software channels that the user's organization is entitled to.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - channel info
      • int id
      • string label
      • string name
      • string provider_name
      • int packages
      • int systems
      • string arch_name

7.2. listManageableChannels

Name
listManageableChannels
Description
List all software channels that the user is entitled to manage.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - channel info
      • int id
      • string label
      • string name
      • string provider_name
      • int packages
      • int systems
      • string arch_name

7.3. listMyChannels

Name
listMyChannels
Description
List all software channels that belong to the user's organization.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - channel info
      • int id
      • string label
      • string name
      • string provider_name
      • int packages
      • int systems
      • string arch_name

7.4. listPopularChannels

Name
listPopularChannels
Description
List the most popular software channels. Channels that have at least the number of systems subscribed as specified by the popularity count will be returned.
Parameters
  • string sessionKey
  • int popularityCount
Return Value
  • array:
    • struct - channel info
      • int id
      • string label
      • string name
      • string provider_name
      • int packages
      • int systems
      • string arch_name

7.5. listRedHatChannels

Name
listRedHatChannels
Description
List all Red Hat software channels that the user's organization is entitled to.
Deprecated - being replaced by listVendorChannels(String sessionKey)
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - channel info
      • int id
      • string label
      • string name
      • string provider_name
      • int packages
      • int systems
      • string arch_name

7.6. listRetiredChannels

Name
listRetiredChannels
Description
List all retired software channels. These are channels that the user's organization is entitled to, but are no longer supported because they have reached their 'end-of-life' date.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - channel info
      • int id
      • string label
      • string name
      • string provider_name
      • int packages
      • int systems
      • string arch_name

7.7. listSharedChannels

Name
listSharedChannels
Description
List all software channels that may be shared by the user's organization.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - channel info
      • int id
      • string label
      • string name
      • string provider_name
      • int packages
      • int systems
      • string arch_name

7.8. listSoftwareChannels

Name
listSoftwareChannels
Description
List all visible software channels.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - channel
      • string label
      • string name
      • string parent_label
      • string end_of_life
      • string arch

7.9. listVendorChannels

Name
listVendorChannels
Description
Lists all the vendor software channels that the user's organization is entitled to.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - channel info
      • int id
      • string label
      • string name
      • string provider_name
      • int packages
      • int systems
      • string arch_name

Chapter 8. channel.access

Abstract

Provides methods to retrieve and alter channel access restrictions.

8.1. disableUserRestrictions

Name
disableUserRestrictions
Description
Disable user restrictions for the given channel. If disabled, all users within the organization may subscribe to the channel.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
Return Value
  • int - 1 on success, exception thrown otherwise.

8.2. enableUserRestrictions

Name
enableUserRestrictions
Description
Enable user restrictions for the given channel. If enabled, only selected users within the organization may subscribe to the channel.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
Return Value
  • int - 1 on success, exception thrown otherwise.

8.3. getOrgSharing

Name
getOrgSharing
Description
Get organization sharing access control.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
Return Value
  • string - The access value (one of the following: 'public', 'private', or 'protected'.

8.4. setOrgSharing

Name
setOrgSharing
Description
Set organization sharing access control.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
  • string access - Access (one of the following: 'public', 'private', or 'protected'
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 9. channel.org

Abstract

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

9.1. disableAccess

Name
disableAccess
Description
Disable access to the channel for the given organization.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
  • int orgId - id of org being removed access
Return Value
  • int - 1 on success, exception thrown otherwise.

9.2. enableAccess

Name
enableAccess
Description
Enable access to the channel for the given organization.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
  • int orgId - id of org being granted access
Return Value
  • int - 1 on success, exception thrown otherwise.

9.3. list

Name
list
Description
List the organizations associated with the given channel that may be trusted.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
Return Value
  • array:
    • struct - org
      • int org_id
      • string org_name
      • boolean access_enabled

Chapter 10. channel.software

Abstract

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

10.1. addPackages

Name
addPackages
Description
Adds a given list of packages to the given channel.
Parameters
  • string sessionKey
  • string channelLabel - target channel.
  • array:
    • int - packageId - id of a package to add to the channel.
Return Value
  • int - 1 on success, exception thrown otherwise.

10.2. addRepoFilter

Name
addRepoFilter
Description
Adds a filter for a given repo.
Parameters
  • string sessionKey
  • string label - repository label
  • struct - filter_map
    • string filter - string to filter on
    • string flag - + for include, - for exclude
Return Value
  • int sort order for new filter

10.3. associateRepo

Name
associateRepo
Description
Associates a repository with a channel
Parameters
  • string sessionKey
  • string channelLabel - channel label
  • string repoLabel - repository label
Return Value
  • 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

10.4. availableEntitlements

Name
availableEntitlements
Description
Returns the number of available subscriptions for the given channel
Parameters
  • string sessionKey
  • string channelLabel - channel to query
Return Value
  • int number of available subscriptions for the given channel

10.5. clearRepoFilters

Name
clearRepoFilters
Description
Removes the filters for a repo
Parameters
  • string sessionKey
  • string label - repository label
Return Value
  • int - 1 on success, exception thrown otherwise.

10.6. clone

Name
clone
Description
Clone a channel. If arch_label is omitted, the arch label of the original channel will be used. If parent_label is omitted, the clone will be a base channel.
Parameters
  • string sessionKey
  • string original_label
  • struct - channel details
    • string name
    • string label
    • string summary
    • string parent_label - (optional)
    • string arch_label - (optional)
    • string gpg_key_url - (optional), gpg_url might be used as well
    • string gpg_key_id - (optional), gpg_id might be used as well
    • string gpg_key_fp - (optional), gpg_fingerprint might be used as well
    • string description - (optional)
    • string checksum - either sha1 or sha256
  • boolean original_state
Return Value
  • int the cloned channel ID

10.7. create

Name
create
Description
Creates a software channel
Available since: 10.9
Parameters
  • string sessionKey
  • string label - label of the new channel
  • string name - name of the new channel
  • string summary - summary of the channel
  • string archLabel - the label of the architecture the channel corresponds to, see channel.software.listArches API for complete listing
  • string parentLabel - label of the parent of this channel, an empty string if it does not have one
  • string checksumType - checksum type for this channel, used for yum repository metadata generation
    • sha1 - Offers widest compatibility with clients
    • sha256 - Offers highest security, but is compatible only with newer clients: Fedora 11 and newer, or Enterprise Linux 6 and newer.
  • struct - gpgKey
    • string url - GPG key URL
    • string id - GPG key ID
    • string fingerprint - GPG key Fingerprint
Return Value
  • int - 1 if the creation operation succeeded, 0 otherwise

10.8. create

Name
create
Description
Creates a software channel
Available since: 10.9
Parameters
  • string sessionKey
  • string label - label of the new channel
  • string name - name of the new channel
  • string summary - summary of the channel
  • string archLabel - the label of the architecture the channel corresponds to, see channel.software.listArches API for complete listing
  • string parentLabel - label of the parent of this channel, an empty string if it does not have one
  • string checksumType - checksum type for this channel, used for yum repository metadata generation
    • sha1 - Offers widest compatibility with clients
    • sha256 - Offers highest security, but is compatible only with newer clients: Fedora 11 and newer, or Enterprise Linux 6 and newer.
Return Value
  • int - 1 if the creation operation succeeded, 0 otherwise

10.9. create

Name
create
Description
Creates a software channel
Parameters
  • string sessionKey
  • string label - label of the new channel
  • string name - name of the new channel
  • string summary - summary of the channel
  • string archLabel - the label of the architecture the channel corresponds to, see channel.software.listArches API for complete listing
  • string parentLabel - label of the parent of this channel, an empty string if it does not have one
Return Value
  • int - 1 if the creation operation succeeded, 0 otherwise

10.10. createRepo

Name
createRepo
Description
Creates a repository
Parameters
  • string sessionKey
  • string label - repository label
  • string type - repository type (yum, uln...)
  • string url - repository url
Return Value
  • struct - channel
    • int id
    • string label
    • string sourceUrl
    • string type
    • string sslCaDesc
    • string sslCertDesc
    • string sslKeyDesc

10.11. createRepo

Name
createRepo
Description
Creates a repository
Parameters
  • string sessionKey
  • string label - repository label
  • string type - repository type (yum, uln...)
  • string url - repository url
  • string sslCaCert - SSL CA cert description
  • string sslCliCert - SSL Client cert description
  • string sslCliKey - SSL Client key description
Return Value
  • struct - channel
    • int id
    • string label
    • string sourceUrl
    • string type
    • string sslCaDesc
    • string sslCertDesc
    • string sslKeyDesc

10.12. delete

Name
delete
Description
Deletes a custom software channel
Parameters
  • string sessionKey
  • string channelLabel - channel to delete
Return Value
  • int - 1 on success, exception thrown otherwise.

10.13. disassociateRepo

Name
disassociateRepo
Description
Disassociates a repository from a channel
Parameters
  • string sessionKey
  • string channelLabel - channel label
  • string repoLabel - repository label
Return Value
  • 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

10.14. getChannelLastBuildById

Name
getChannelLastBuildById
Description
Returns the last build date of the repomd.xml file for the given channel as a localised string.
Parameters
  • string sessionKey
  • int id - id of channel wanted
Return Value
  • the last build date of the repomd.xml file as a localised string

10.15. getDetails

Name
getDetails
Description
Returns details of the given channel as a map
Parameters
  • string sessionKey
  • string channelLabel - channel to query
Return Value
  • 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

10.16. getDetails

Name
getDetails
Description
Returns details of the given channel as a map
Parameters
  • string sessionKey
  • int id - channel to query
Return Value
  • 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

10.17. getRepoDetails

Name
getRepoDetails
Description
Returns details of the given repository
Parameters
  • string sessionKey
  • string repoLabel - repo to query
Return Value
  • struct - channel
    • int id
    • string label
    • string sourceUrl
    • string type
    • string sslCaDesc
    • string sslCertDesc
    • string sslKeyDesc

10.18. getRepoDetails

Name
getRepoDetails
Description
Returns details of the given repo
Parameters
  • string sessionKey
  • string repoLabel - repo to query
Return Value
  • struct - channel
    • int id
    • string label
    • string sourceUrl
    • string type
    • string sslCaDesc
    • string sslCertDesc
    • string sslKeyDesc

10.19. getRepoSyncCronExpression

Name
getRepoSyncCronExpression
Description
Returns repo synchronization cron expression
Parameters
  • string sessionKey
  • string channelLabel - channel label
Return Value
  • string quartz expression

10.20. isGloballySubscribable

Name
isGloballySubscribable
Description
Returns whether the channel is subscribable by any user in the organization
Parameters
  • string sessionKey
  • string channelLabel - channel to query
Return Value
  • int - 1 if true, 0 otherwise

10.21. isUserManageable

Name
isUserManageable
Description
Returns whether the channel may be managed by the given user.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
  • string login - login of the target user
Return Value
  • int - 1 if manageable, 0 if not

10.22. isUserSubscribable

Name
isUserSubscribable
Description
Returns whether the channel may be subscribed to by the given user.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
  • string login - login of the target user
Return Value
  • int - 1 if subscribable, 0 if not

10.23. listAllPackages

Name
listAllPackages
Description
Lists all packages in the channel, regardless of package version, between the given dates.
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • dateTime.iso8601 startDate
  • dateTime.iso8601 endDate
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch
      • string checksum
      • string checksum_type
      • int id
      • string arch_label
      • string last_modified_date
      • string last_modified - (Deprecated)

10.24. listAllPackages

Name
listAllPackages
Description
Lists all packages in the channel, regardless of version whose last modified date is greater than given date.
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • dateTime.iso8601 startDate
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch
      • string checksum
      • string checksum_type
      • int id
      • string arch_label
      • string last_modified_date
      • string last_modified - (Deprecated)

10.25. listAllPackages

Name
listAllPackages
Description
Lists all packages in the channel, regardless of the package version
Parameters
  • string sessionKey
  • string channelLabel - channel to query
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch
      • string checksum
      • string checksum_type
      • int id
      • string arch_label
      • string last_modified_date
      • string last_modified - (Deprecated)

10.26. listAllPackages

Name
listAllPackages
Description
Lists all packages in the channel, regardless of package version, between the given dates. Example Date: '2008-08-20 08:00:00'
Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601 endDate)
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • string startDate
  • string endDate
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch
      • string checksum
      • string checksum_type
      • int id
      • string arch_label
      • string last_modified_date
      • string last_modified - (Deprecated)

10.27. listAllPackages

Name
listAllPackages
Description
Lists all packages in the channel, regardless of version whose last modified date is greater than given date. Example Date: '2008-08-20 08:00:00'
Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate)
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • string startDate
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch
      • string checksum
      • string checksum_type
      • int id
      • string arch_label
      • string last_modified_date
      • string last_modified - (Deprecated)

10.28. listAllPackagesByDate

Name
listAllPackagesByDate
Description
Lists all packages in the channel, regardless of the package version, between the given dates. Example Date: '2008-08-20 08:00:00'
Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601 endDate)
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • string startDate
  • string endDate
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch
      • string id
      • string arch_label
      • string last_modified

10.29. listAllPackagesByDate

Name
listAllPackagesByDate
Description
Lists all packages in the channel, regardless of the package version, whose last modified date is greater than given date. Example Date: '2008-08-20 08:00:00'
Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate)
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • string startDate
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch
      • string id
      • string arch_label
      • string last_modified

10.30. listAllPackagesByDate

Name
listAllPackagesByDate
Description
Lists all packages in the channel, regardless of the package version
Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel)
Parameters
  • string sessionKey
  • string channelLabel - channel to query
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch
      • string id
      • string arch_label
      • string last_modified

10.31. listArches

Name
listArches
Description
Lists the potential software channel architectures that can be created
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - channel arch
      • string name
      • string label

10.32. listChannelRepos

Name
listChannelRepos
Description
Lists associated repos with the given channel
Parameters
  • string sessionKey
  • string channelLabel - channel label
Return Value
  • array:
    • struct - channel
      • int id
      • string label
      • string sourceUrl
      • string type
      • string sslCaDesc
      • string sslCertDesc
      • string sslKeyDesc

10.33. listChildren

Name
listChildren
Description
List the children of a channel
Parameters
  • string sessionKey
  • string channelLabel - the label of the channel
Return Value
  • 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

10.34. listErrata

Name
listErrata
Description
List the errata applicable to a channel after given startDate
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • dateTime.iso8601 startDate
Return Value
  • 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

10.35. listErrata

Name
listErrata
Description
List the errata applicable to a channel between startDate and endDate.
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • dateTime.iso8601 startDate
  • dateTime.iso8601 endDate
Return Value
  • 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

10.36. listErrata

Name
listErrata
Description
List the errata applicable to a channel between startDate and endDate.
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • dateTime.iso8601 startDate
  • dateTime.iso8601 endDate
  • boolean lastModified - select by last modified or not
Return Value
  • 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

10.37. listErrata

Name
listErrata
Description
List the errata applicable to a channel
Parameters
  • string sessionKey
  • string channelLabel - channel to query
Return Value
  • array:
    • struct - errata
      • int id - Errata Id
      • 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
      • string advisory - name of the advisory (Deprecated)
      • string issue_date - date format follows YYYY-MM-DD HH24:MI:SS (Deprecated)
      • string update_date - date format follows YYYY-MM-DD HH24:MI:SS (Deprecated)
      • string synopsis (Deprecated)
      • string last_modified_date - date format follows YYYY-MM-DD HH24:MI:SS (Deprecated)

10.38. listErrata

Name
listErrata
Description
List the errata applicable to a channel after given startDate
Deprecated - being replaced by listErrata(string sessionKey, string channelLabel, dateTime.iso8601 startDate)
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • string startDate
Return Value
  • array:
    • struct - errata
      • string advisory - name of the advisory
      • string issue_date - date format follows YYYY-MM-DD HH24:MI:SS
      • string update_date - date format follows YYYY-MM-DD HH24:MI:SS
      • string synopsis
      • string advisory_type
      • string last_modified_date - date format follows YYYY-MM-DD HH24:MI:SS

10.39. listErrata

Name
listErrata
Description
List the errata applicable to a channel between startDate and endDate.
Deprecated - being replaced by listErrata(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601)
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • string startDate
  • string endDate
Return Value
  • array:
    • struct - errata
      • string advisory - name of the advisory
      • string issue_date - date format follows YYYY-MM-DD HH24:MI:SS
      • string update_date - date format follows YYYY-MM-DD HH24:MI:SS
      • string synopsis
      • string advisory_type
      • string last_modified_date - date format follows YYYY-MM-DD HH24:MI:SS

10.40. listErrataByType

Name
listErrataByType
Description
List the errata of a specific type that are applicable to a channel
Parameters
  • string sessionKey
  • string channelLabel - channel to query
  • string advisoryType - type of advisory (one of of the following: 'Security Advisory', 'Product Enhancement Advisory', 'Bug Fix Advisory'
Return Value
  • array:
    • struct - errata
      • string advisory - name of the advisory
      • string issue_date - date format follows YYYY-MM-DD HH24:MI:SS
      • string update_date - date format follows YYYY-MM-DD HH24:MI:SS
      • string synopsis
      • string advisory_type
      • string last_modified_date - date format follows YYYY-MM-DD HH24:MI:SS

10.41. listErrataNeedingSync

Name
listErrataNeedingSync
Description
If you have satellite-synced a new channel then Red Hat Errata will have been updated with the packages that are in the newly synced channel. A cloned erratum will not have been automatically updated however. If you cloned a channel that includes those cloned errata and should include the new packages, they will not be included when they should. This method lists the errata that will be updated if you run the syncErrata method.
Parameters
  • string sessionKey
  • string channelLabel - channel to update
Return Value
  • 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

10.42. listLatestPackages

Name
listLatestPackages
Description
Lists the packages with the latest version (including release and epoch) for the given channel
Parameters
  • string sessionKey
  • string channelLabel - channel to query
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch
      • int id
      • string arch_label

10.43. listPackagesWithoutChannel

Name
listPackagesWithoutChannel
Description
Lists all packages that are not associated with a channel. Typically these are custom packages.
Parameters
  • string sessionKey
Return Value
  • 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

10.44. listRepoFilters

Name
listRepoFilters
Description
Lists the filters for a repo
Parameters
  • string sessionKey
  • string label - repository label
Return Value
  • array:
    • struct - filter
      • int sortOrder
      • string filter
      • string flag

10.45. listSubscribedSystems

Name
listSubscribedSystems
Description
Returns list of subscribed systems for the given channel label
Parameters
  • string sessionKey
  • string channelLabel - channel to query
Return Value
  • array:
    • struct - system
      • int id
      • string name

10.46. listSystemChannels

Name
listSystemChannels
Description
Returns a list of channels that a system is subscribed to for the given system id
Parameters
  • string sessionKey
  • int serverId
Return Value
  • array:
    • struct - channel
      • string id
      • string label
      • string name

10.47. listUserRepos

Name
listUserRepos
Description
Returns a list of ContentSource (repos) that the user can see
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - map
      • long "id" - ID of the repo
      • string label - label of the repo
      • string sourceUrl - URL of the repo

10.48. mergeErrata

Name
mergeErrata
Description
Merges all errata from one channel into another
Parameters
  • string sessionKey
  • string mergeFromLabel - the label of the channel to pull errata from
  • string mergeToLabel - the label to push the errata into
Return Value
  • 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.

10.49. mergeErrata

Name
mergeErrata
Description
Merges all errata from one channel into another based upon a given start/end date.
Parameters
  • string sessionKey
  • string mergeFromLabel - the label of the channel to pull errata from
  • string mergeToLabel - the label to push the errata into
  • string startDate
  • string endDate
Return Value
  • 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.

10.50. mergeErrata

Name
mergeErrata
Description
Merges a list of errata from one channel into another
Parameters
  • string sessionKey
  • string mergeFromLabel - the label of the channel to pull errata from
  • string mergeToLabel - the label to push the errata into
  • array:
    • string - advisory - The advisory name of the errata to merge
Return Value
  • 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.

10.51. mergePackages

Name
mergePackages
Description
Merges all packages from one channel into another
Parameters
  • string sessionKey
  • string mergeFromLabel - the label of the channel to pull packages from
  • string mergeToLabel - the label to push the packages into
Return Value
  • 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

10.52. regenerateNeededCache

Name
regenerateNeededCache
Description
Completely clear and regenerate the needed Errata and Package cache for all systems subscribed to the specified channel. This should be used only if you believe your cache is incorrect for all the systems in a given channel. This will schedule an asynchronous action to actually do the processing.
Parameters
  • string sessionKey
  • string channelLabel - the label of the channel
Return Value
  • int - 1 on success, exception thrown otherwise.

10.53. regenerateNeededCache

Name
regenerateNeededCache
Description
Completely clear and regenerate the needed Errata and Package cache for all systems subscribed. You must be a Satellite Admin to perform this action. This will schedule an asynchronous action to actually do the processing.
Parameters
  • string sessionKey
Return Value
  • int - 1 on success, exception thrown otherwise.

10.54. regenerateYumCache

Name
regenerateYumCache
Description
Regenerate yum cache for the specified channel.
Parameters
  • string sessionKey
  • string channelLabel - the label of the channel
Return Value
  • int - 1 on success, exception thrown otherwise.

10.55. removeErrata

Name
removeErrata
Description
Removes a given list of errata from the given channel.
Parameters
  • string sessionKey
  • string channelLabel - target channel.
  • array:
    • string - advisoryName - name of an erratum to remove
  • boolean removePackages - True to remove packages from the channel
Return Value
  • int - 1 on success, exception thrown otherwise.

10.56. removePackages

Name
removePackages
Description
Removes a given list of packages from the given channel.
Parameters
  • string sessionKey
  • string channelLabel - target channel.
  • array:
    • int - packageId - id of a package to remove from the channel.
Return Value
  • int - 1 on success, exception thrown otherwise.

10.57. removeRepo

Name
removeRepo
Description
Removes a repository
Parameters
  • string sessionKey
  • long id - ID of repo to be removed
Return Value
  • int - 1 on success, exception thrown otherwise.

10.58. removeRepo

Name
removeRepo
Description
Removes a repository
Parameters
  • string sessionKey
  • string label - label of repo to be removed
Return Value
  • int - 1 on success, exception thrown otherwise.

10.59. removeRepoFilter

Name
removeRepoFilter
Description
Removes a filter for a given repo.
Parameters
  • string sessionKey
  • string label - repository label
  • struct - filter_map
    • string filter - string to filter on
    • string flag - + for include, - for exclude
Return Value
  • int - 1 on success, exception thrown otherwise.

10.60. setContactDetails

Name
setContactDetails
Description
Set contact/support information for given channel.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
  • string maintainerName - name of the channel maintainer
  • string maintainerEmail - email of the channel maintainer
  • string maintainerPhone - phone number of the channel maintainer
  • string supportPolicy - channel support policy
Return Value
  • int - 1 on success, exception thrown otherwise.

10.61. setDetails

Name
setDetails
Description
Allows to modify channel attributes
Parameters
  • string sessionKey
  • int channelId - channel id
  • struct - channel_map
    • string checksum_label - new channel repository checksum label (optional)
    • string name - new channel name (optional)
    • string summary - new channel summary (optional)
    • string description - new channel description (optional)
    • string maintainer_name - new channel maintainer name (optional)
    • string maintainer_email - new channel email address (optional)
    • string maintainer_phone - new channel phone number (optional)
    • string gpg_key_url - new channel gpg key url (optional)
    • string gpg_key_id - new channel gpg key id (optional)
    • string gpg_key_fp - new channel gpg key fingerprint (optional)
Return Value
  • int - 1 on success, exception thrown otherwise.

10.62. setGloballySubscribable

Name
setGloballySubscribable
Description
Set globally subscribable attribute for given channel.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
  • boolean subscribable - true if the channel is to be globally subscribable. False otherwise.
Return Value
  • int - 1 on success, exception thrown otherwise.

10.63. setRepoFilters

Name
setRepoFilters
Description
Replaces the existing set of filters for a given repo. Filters are ranked by their order in the array.
Parameters
  • string sessionKey
  • string label - repository label
  • array:
    • struct - filter_map
      • string filter - string to filter on
      • string flag - + for include, - for exclude
Return Value
  • int - 1 on success, exception thrown otherwise.

10.64. setSystemChannels

Name
setSystemChannels
Description
Change a systems subscribed channels to the list of channels passed in.
Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string channelLabel) and system.setChildChannels(string sessionKey, int serverId, array[string channelLabel])
Parameters
  • string sessionKey
  • int serverId
  • array:
    • string - channelLabel - labels of the channels to subscribe the system to.
Return Value
  • int - 1 on success, exception thrown otherwise.

10.65. setUserManageable

Name
setUserManageable
Description
Set the manageable flag for a given channel and user. If value is set to 'true', this method will give the user manage permissions to the channel. Otherwise, that privilege is revoked.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
  • string login - login of the target user
  • boolean value - value of the flag to set
Return Value
  • int - 1 on success, exception thrown otherwise.

10.66. setUserSubscribable

Name
setUserSubscribable
Description
Set the subscribable flag for a given channel and user. If value is set to 'true', this method will give the user subscribe permissions to the channel. Otherwise, that privilege is revoked.
Parameters
  • string sessionKey
  • string channelLabel - label of the channel
  • string login - login of the target user
  • boolean value - value of the flag to set
Return Value
  • int - 1 on success, exception thrown otherwise.

10.67. subscribeSystem

Name
subscribeSystem
Description
Subscribes a system to a list of channels. If a base channel is included, that is set before setting child channels. When setting child channels the current child channel subscriptions are cleared. To fully unsubscribe the system from all channels, simply provide an empty list of channel labels.
Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string channelLabel) and system.setChildChannels(string sessionKey, int serverId, array[string channelLabel])
Parameters
  • string sessionKey
  • int serverId
  • array:
    • string - label - channel label to subscribe the system to.
Return Value
  • int - 1 on success, exception thrown otherwise.

10.68. syncErrata

Name
syncErrata
Description
If you have satellite-synced a new channel then Red Hat Errata will have been updated with the packages that are in the newly synced channel. A cloned erratum will not have been automatically updated however. If you cloned a channel that includes those cloned errata and should include the new packages, they will not be included when they should. This method updates all the errata in the given cloned channel with packages that have recently been added, and ensures that all the packages you expect are in the channel.
Parameters
  • string sessionKey
  • string channelLabel - channel to update
Return Value
  • int - 1 on success, exception thrown otherwise.

10.69. syncRepo

Name
syncRepo
Description
Trigger immediate repo synchronization
Parameters
  • string sessionKey
  • string channelLabel - channel label
Return Value
  • int - 1 on success, exception thrown otherwise.

10.70. syncRepo

Name
syncRepo
Description
Trigger immediate repo synchronization
Parameters
  • string sessionKey
  • string channelLabel - channel label
  • struct - params_map
    • Boolean sync-kickstart - Create kickstartable tree - Optional
    • Boolean no-errata - Do not sync errata - Optional
    • Boolean fail - Terminate upon any error - Optional
Return Value
  • int - 1 on success, exception thrown otherwise.

10.71. syncRepo

Name
syncRepo
Description
Schedule periodic repo synchronization
Parameters
  • string sessionKey
  • string channelLabel - channel label
  • string cron expression - if empty all periodic schedules will be disabled
Return Value
  • int - 1 on success, exception thrown otherwise.

10.72. syncRepo

Name
syncRepo
Description
Schedule periodic repo synchronization
Parameters
  • string sessionKey
  • string channelLabel - channel label
  • string cron expression - if empty all periodic schedules will be disabled
  • struct - params_map
    • Boolean sync-kickstart - Create kickstartable tree - Optional
    • Boolean no-errata - Do not sync errata - Optional
    • Boolean fail - Terminate upon any error - Optional
Return Value
  • int - 1 on success, exception thrown otherwise.

10.73. updateRepo

Name
updateRepo
Description
Updates a ContentSource (repo)
Parameters
  • string sessionKey
  • int id - repository id
  • string label - new repository label
  • string url - new repository URL
Return Value
  • struct - channel
    • int id
    • string label
    • string sourceUrl
    • string type
    • string sslCaDesc
    • string sslCertDesc
    • string sslKeyDesc

10.74. updateRepoLabel

Name
updateRepoLabel
Description
Updates repository label
Parameters
  • string sessionKey
  • int id - repository id
  • string label - new repository label
Return Value
  • struct - channel
    • int id
    • string label
    • string sourceUrl
    • string type
    • string sslCaDesc
    • string sslCertDesc
    • string sslKeyDesc

10.75. updateRepoLabel

Name
updateRepoLabel
Description
Updates repository label
Parameters
  • string sessionKey
  • string label - repository label
  • string newLabel - new repository label
Return Value
  • struct - channel
    • int id
    • string label
    • string sourceUrl
    • string type
    • string sslCaDesc
    • string sslCertDesc
    • string sslKeyDesc

10.76. updateRepoSsl

Name
updateRepoSsl
Description
Updates repository SSL certificates
Parameters
  • string sessionKey
  • int id - repository id
  • string sslCaCert - SSL CA cert description
  • string sslCliCert - SSL Client cert description
  • string sslCliKey - SSL Client key description
Return Value
  • struct - channel
    • int id
    • string label
    • string sourceUrl
    • string type
    • string sslCaDesc
    • string sslCertDesc
    • string sslKeyDesc

10.77. updateRepoSsl

Name
updateRepoSsl
Description
Updates repository SSL certificates
Parameters
  • string sessionKey
  • string label - repository label
  • string sslCaCert - SSL CA cert description
  • string sslCliCert - SSL Client cert description
  • string sslCliKey - SSL Client key description
Return Value
  • struct - channel
    • int id
    • string label
    • string sourceUrl
    • string type
    • string sslCaDesc
    • string sslCertDesc
    • string sslKeyDesc

10.78. updateRepoUrl

Name
updateRepoUrl
Description
Updates repository source URL
Parameters
  • string sessionKey
  • int id - repository id
  • string url - new repository url
Return Value
  • struct - channel
    • int id
    • string label
    • string sourceUrl
    • string type
    • string sslCaDesc
    • string sslCertDesc
    • string sslKeyDesc

10.79. updateRepoUrl

Name
updateRepoUrl
Description
Updates repository source URL
Parameters
  • string sessionKey
  • string label - repository label
  • string url - new repository url
Return Value
  • struct - channel
    • int id
    • string label
    • string sourceUrl
    • string type
    • string sslCaDesc
    • string sslCertDesc
    • string sslKeyDesc

Chapter 11. configchannel

Abstract

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

11.1. channelExists

Name
channelExists
Description
Check for the existence of the config channel provided.
Parameters
  • string sessionKey
  • string channelLabel - Channel to check for.
Return Value
  • 1 if exists, 0 otherwise.

11.2. create

Name
create
Description
Create a new global config channel. Caller must be at least a config admin or an organization admin.
Parameters
  • string sessionKey
  • string channelLabel
  • string channelName
  • string channelDescription
Return Value
  • struct - Configuration Channel information
    • int id
    • int orgId
    • string label
    • string name
    • string description
    • struct configChannelType
    • struct - Configuration Channel Type information
      • int id
      • string label
      • string name
      • int priority

11.3. createOrUpdatePath

Name
createOrUpdatePath
Description
Create a new file or directory with the given path, or update an existing path.
Available since: 10.2
Parameters
  • string sessionKey
  • string configChannelLabel
  • string path
  • boolean isDir - True if the path is a directory, False if it is a file.
  • struct - path info
    • string contents - Contents of the file (text or base64 encoded if binary). (only for non-directories)
    • boolean contents_enc64 - Identifies base64 encoded content (default: disabled, only for non-directories)
    • string owner - Owner of the file/directory.
    • string group - Group name of the file/directory.
    • string permissions - Octal file/directory permissions (eg: 644)
    • string selinux_ctx - SELinux Security context (optional)
    • string macro-start-delimiter - Config file macro start delimiter. Use null or empty string to accept the default. (only for non-directories)
    • string macro-end-delimiter - Config file macro end delimiter. Use null or empty string to accept the default. (only for non-directories)
    • int revision - next revision number, auto increment for null
    • boolean binary - mark the binary content, if True, base64 encoded content is expected (only for non-directories)
Return Value
  • struct - Configuration Revision information
    • string type
      • file
      • directory
      • symlink
    • string path - File Path
    • string target_path - Symbolic link Target File Path. Present for Symbolic links only.
    • string channel - Channel Name
    • string contents - File contents (base64 encoded according to the contents_enc64 attribute)
    • boolean contents_enc64 - Identifies base64 encoded content
    • int revision - File Revision
    • dateTime.iso8601 creation - Creation Date
    • dateTime.iso8601 modified - Last Modified Date
    • string owner - File Owner. Present for files or directories only.
    • string group - File Group. Present for files or directories only.
    • int permissions - File Permissions (Deprecated). Present for files or directories only.
    • string permissions_mode - File Permissions. Present for files or directories only.
    • string selinux_ctx - SELinux Context (optional).
    • boolean binary - true/false , Present for files only.
    • string sha256 - File's sha256 signature. Present for files only.
    • string macro-start-delimiter - Macro start delimiter for a config file. Present for text files only.
    • string macro-end-delimiter - Macro end delimiter for a config file. Present for text files only.

11.4. createOrUpdateSymlink

Name
createOrUpdateSymlink
Description
Create a new symbolic link with the given path, or update an existing path.
Available since: 10.2
Parameters
  • string sessionKey
  • string configChannelLabel
  • string path
  • struct - path info
    • string target_path - The target path for the symbolic link
    • string selinux_ctx - SELinux Security context (optional)
    • int revision - next revision number, skip this field for automatic revision number assignment
Return Value
  • struct - Configuration Revision information
    • string type
      • file
      • directory
      • symlink
    • string path - File Path
    • string target_path - Symbolic link Target File Path. Present for Symbolic links only.
    • string channel - Channel Name
    • string contents - File contents (base64 encoded according to the contents_enc64 attribute)
    • boolean contents_enc64 - Identifies base64 encoded content
    • int revision - File Revision
    • dateTime.iso8601 creation - Creation Date
    • dateTime.iso8601 modified - Last Modified Date
    • string owner - File Owner. Present for files or directories only.
    • string group - File Group. Present for files or directories only.
    • int permissions - File Permissions (Deprecated). Present for files or directories only.
    • string permissions_mode - File Permissions. Present for files or directories only.
    • string selinux_ctx - SELinux Context (optional).
    • boolean binary - true/false , Present for files only.
    • string sha256 - File's sha256 signature. Present for files only.
    • string macro-start-delimiter - Macro start delimiter for a config file. Present for text files only.
    • string macro-end-delimiter - Macro end delimiter for a config file. Present for text files only.

11.5. deleteChannels

Name
deleteChannels
Description
Delete a list of global config channels. Caller must be a config admin.
Parameters
  • string sessionKey
  • array:
    • string - configuration channel labels to delete.
Return Value
  • int - 1 on success, exception thrown otherwise.

11.6. deleteFileRevisions

Name
deleteFileRevisions
Description
Delete specified revisions of a given configuration file
Parameters
  • string sessionKey
  • string channelLabel - Label of config channel to lookup on.
  • string filePath - Configuration file path.
  • array:
    • int - List of revisions to delete
Return Value
  • int - 1 on success, exception thrown otherwise.

11.7. deleteFiles

Name
deleteFiles
Description
Remove file paths from a global channel.
Parameters
  • string sessionKey
  • string channelLabel - Channel to remove the files from.
  • array:
    • string - file paths to remove.
Return Value
  • int - 1 on success, exception thrown otherwise.

11.8. deployAllSystems

Name
deployAllSystems
Description
Schedule an immediate configuration deployment for all systems subscribed to a particular configuration channel.
Parameters
  • string sessionKey
  • string channelLabel - The configuration channel's label.
Return Value
  • int - 1 on success, exception thrown otherwise.

11.9. deployAllSystems

Name
deployAllSystems
Description
Schedule a configuration deployment for all systems subscribed to a particular configuration channel.
Parameters
  • string sessionKey
  • string channelLabel - The configuration channel's label.
  • dateTime.iso8601 date - The date to schedule the action
Return Value
  • int - 1 on success, exception thrown otherwise.

11.10. deployAllSystems

Name
deployAllSystems
Description
Schedule a configuration deployment of a certain file for all systems subscribed to a particular configuration channel.
Parameters
  • string sessionKey
  • string channelLabel - The configuration channel's label.
  • string filePath - The configuration file path.
Return Value
  • int - 1 on success, exception thrown otherwise.

11.11. deployAllSystems

Name
deployAllSystems
Description
Schedule a configuration deployment of a certain file for all systems subscribed to a particular configuration channel.
Parameters
  • string sessionKey
  • string channelLabel - The configuration channel's label.
  • string filePath - The configuration file path.
  • dateTime.iso8601 date - The date to schedule the action
Return Value
  • int - 1 on success, exception thrown otherwise.

11.12. getDetails

Name
getDetails
Description
Lookup config channel details.
Parameters
  • string sessionKey
  • string channelLabel
Return Value
  • struct - Configuration Channel information
    • int id
    • int orgId
    • string label
    • string name
    • string description
    • struct configChannelType
    • struct - Configuration Channel Type information
      • int id
      • string label
      • string name
      • int priority

11.13. getDetails

Name
getDetails
Description
Lookup config channel details.
Parameters
  • string sessionKey
  • int channelId
Return Value
  • struct - Configuration Channel information
    • int id
    • int orgId
    • string label
    • string name
    • string description
    • struct configChannelType
    • struct - Configuration Channel Type information
      • int id
      • string label
      • string name
      • int priority

11.14. getEncodedFileRevision

Name
getEncodedFileRevision
Description
Get revision of the specified configuration file and transmit the contents as base64 encoded.
Parameters
  • string sessionKey
  • string configChannelLabel - label of config channel to lookup on
  • string filePath - config file path to examine
  • int revision - config file revision to examine
Return Value
  • struct - Configuration Revision information
    • string type
      • file
      • directory
      • symlink
    • string path - File Path
    • string target_path - Symbolic link Target File Path. Present for Symbolic links only.
    • string channel - Channel Name
    • string contents - File contents (base64 encoded according to the contents_enc64 attribute)
    • boolean contents_enc64 - Identifies base64 encoded content
    • int revision - File Revision
    • dateTime.iso8601 creation - Creation Date
    • dateTime.iso8601 modified - Last Modified Date
    • string owner - File Owner. Present for files or directories only.
    • string group - File Group. Present for files or directories only.
    • int permissions - File Permissions (Deprecated). Present for files or directories only.
    • string permissions_mode - File Permissions. Present for files or directories only.
    • string selinux_ctx - SELinux Context (optional).
    • boolean binary - true/false , Present for files only.
    • string sha256 - File's sha256 signature. Present for files only.
    • string macro-start-delimiter - Macro start delimiter for a config file. Present for text files only.
    • string macro-end-delimiter - Macro end delimiter for a config file. Present for text files only.

11.15. getFileRevision

Name
getFileRevision
Description
Get revision of the specified config file
Parameters
  • string sessionKey
  • string configChannelLabel - label of config channel to lookup on
  • string filePath - config file path to examine
  • int revision - config file revision to examine
Return Value
  • struct - Configuration Revision information
    • string type
      • file
      • directory
      • symlink
    • string path - File Path
    • string target_path - Symbolic link Target File Path. Present for Symbolic links only.
    • string channel - Channel Name
    • string contents - File contents (base64 encoded according to the contents_enc64 attribute)
    • boolean contents_enc64 - Identifies base64 encoded content
    • int revision - File Revision
    • dateTime.iso8601 creation - Creation Date
    • dateTime.iso8601 modified - Last Modified Date
    • string owner - File Owner. Present for files or directories only.
    • string group - File Group. Present for files or directories only.
    • int permissions - File Permissions (Deprecated). Present for files or directories only.
    • string permissions_mode - File Permissions. Present for files or directories only.
    • string selinux_ctx - SELinux Context (optional).
    • boolean binary - true/false , Present for files only.
    • string sha256 - File's sha256 signature. Present for files only.
    • string macro-start-delimiter - Macro start delimiter for a config file. Present for text files only.
    • string macro-end-delimiter - Macro end delimiter for a config file. Present for text files only.

11.16. getFileRevisions

Name
getFileRevisions
Description
Get list of revisions for specified config file
Parameters
  • string sessionKey
  • string channelLabel - label of config channel to lookup on
  • string filePath - config file path to examine
Return Value
  • array:
    • struct - Configuration Revision information
      • string type
        • file
        • directory
        • symlink
      • string path - File Path
      • string target_path - Symbolic link Target File Path. Present for Symbolic links only.
      • string channel - Channel Name
      • string contents - File contents (base64 encoded according to the contents_enc64 attribute)
      • boolean contents_enc64 - Identifies base64 encoded content
      • int revision - File Revision
      • dateTime.iso8601 creation - Creation Date
      • dateTime.iso8601 modified - Last Modified Date
      • string owner - File Owner. Present for files or directories only.
      • string group - File Group. Present for files or directories only.
      • int permissions - File Permissions (Deprecated). Present for files or directories only.
      • string permissions_mode - File Permissions. Present for files or directories only.
      • string selinux_ctx - SELinux Context (optional).
      • boolean binary - true/false , Present for files only.
      • string sha256 - File's sha256 signature. Present for files only.
      • string macro-start-delimiter - Macro start delimiter for a config file. Present for text files only.
      • string macro-end-delimiter - Macro end delimiter for a config file. Present for text files only.

11.17. listFiles

Name
listFiles
Description
Return a list of files in a channel.
Parameters
  • string sessionKey
  • string channelLabel - label of config channel to list files on.
Return Value
  • array:
    • struct - Configuration File information
      • string type
        • file
        • directory
        • symlink
      • string path - File Path
      • dateTime.iso8601 last_modified - Last Modified Date

11.18. listGlobals

Name
listGlobals
Description
List all the global config channels accessible to the logged-in user.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - Configuration Channel information
      • int id
      • int orgId
      • string label
      • string name
      • string description
      • string type
      • struct configChannelType
      • struct - Configuration Channel Type information
        • int id
        • string label
        • string name
        • int priority

11.19. listSubscribedSystems

Name
listSubscribedSystems
Description
Return a list of systems subscribed to a configuration channel
Parameters
  • string sessionKey
  • string channelLabel - label of config channel to list subscribed systems.
Return Value
  • array:
    • struct - system
      • int id
      • string name

11.20. lookupChannelInfo

Name
lookupChannelInfo
Description
Lists details on a list channels given their channel labels.
Parameters
  • string sessionKey
  • array:
    • string - configuration channel label
Return Value
  • array:
    • struct - Configuration Channel information
      • int id
      • int orgId
      • string label
      • string name
      • string description
      • struct configChannelType
      • struct - Configuration Channel Type information
        • int id
        • string label
        • string name
        • int priority

11.21. lookupFileInfo

Name
lookupFileInfo
Description
Given a list of paths and a channel, returns details about the latest revisions of the paths.
Available since: 10.2
Parameters
  • string sessionKey
  • string channelLabel - label of config channel to lookup on
  • array:
    • string - List of paths to examine.
Return Value
  • array:
    • struct - Configuration Revision information
      • string type
        • file
        • directory
        • symlink
      • string path - File Path
      • string target_path - Symbolic link Target File Path. Present for Symbolic links only.
      • string channel - Channel Name
      • string contents - File contents (base64 encoded according to the contents_enc64 attribute)
      • boolean contents_enc64 - Identifies base64 encoded content
      • int revision - File Revision
      • dateTime.iso8601 creation - Creation Date
      • dateTime.iso8601 modified - Last Modified Date
      • string owner - File Owner. Present for files or directories only.
      • string group - File Group. Present for files or directories only.
      • int permissions - File Permissions (Deprecated). Present for files or directories only.
      • string permissions_mode - File Permissions. Present for files or directories only.
      • string selinux_ctx - SELinux Context (optional).
      • boolean binary - true/false , Present for files only.
      • string sha256 - File's sha256 signature. Present for files only.
      • string macro-start-delimiter - Macro start delimiter for a config file. Present for text files only.
      • string macro-end-delimiter - Macro end delimiter for a config file. Present for text files only.

11.22. lookupFileInfo

Name
lookupFileInfo
Description
Given a path, revision number, and a channel, returns details about the latest revisions of the paths.
Available since: 10.12
Parameters
  • string sessionKey
  • string channelLabel - label of config channel to lookup on
  • string path - path of file/directory
  • int revsion - The revision number.
Return Value
  • struct - Configuration Revision information
    • string type
      • file
      • directory
      • symlink
    • string path - File Path
    • string target_path - Symbolic link Target File Path. Present for Symbolic links only.
    • string channel - Channel Name
    • string contents - File contents (base64 encoded according to the contents_enc64 attribute)
    • boolean contents_enc64 - Identifies base64 encoded content
    • int revision - File Revision
    • dateTime.iso8601 creation - Creation Date
    • dateTime.iso8601 modified - Last Modified Date
    • string owner - File Owner. Present for files or directories only.
    • string group - File Group. Present for files or directories only.
    • int permissions - File Permissions (Deprecated). Present for files or directories only.
    • string permissions_mode - File Permissions. Present for files or directories only.
    • string selinux_ctx - SELinux Context (optional).
    • boolean binary - true/false , Present for files only.
    • string sha256 - File's sha256 signature. Present for files only.
    • string macro-start-delimiter - Macro start delimiter for a config file. Present for text files only.
    • string macro-end-delimiter - Macro end delimiter for a config file. Present for text files only.

11.23. scheduleFileComparisons

Name
scheduleFileComparisons
Description
Schedule a comparison of the latest revision of a file against the version deployed on a list of systems.
Parameters
  • string sessionKey
  • string channelLabel - Label of config channel
  • string path - File path
  • array:
    • long - The list of server id that the comparison will be performed on
Return Value
  • int actionId - The action id of the scheduled action

11.24. update

Name
update
Description
Update a global config channel. Caller must be at least a config admin or an organization admin, or have access to a system containing this config channel.
Parameters
  • string sessionKey
  • string channelLabel
  • string channelName
  • string description
Return Value
  • struct - Configuration Channel information
    • int id
    • int orgId
    • string label
    • string name
    • string description
    • struct configChannelType
    • struct - Configuration Channel Type information
      • int id
      • string label
      • string name
      • int priority

Chapter 12. distchannel

Abstract

Provides methods to access and modify distribution channel information

12.1. listDefaultMaps

Name
listDefaultMaps
Description
Lists the default distribution channel maps
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - distChannelMap
      • string os - Operationg System
      • string release - OS Relase
      • string arch_name - Channel architecture
      • string channel_label - Channel label
      • string org_specific - 'Y' organization specific, 'N' default

12.2. listMapsForOrg

Name
listMapsForOrg
Description
Lists distribution channel maps valid for the user's organization
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - distChannelMap
      • string os - Operationg System
      • string release - OS Relase
      • string arch_name - Channel architecture
      • string channel_label - Channel label
      • string org_specific - 'Y' organization specific, 'N' default

12.3. listMapsForOrg

Name
listMapsForOrg
Description
Lists distribution channel maps valid for an organization, satellite admin right needed
Parameters
  • string sessionKey
  • int orgId
Return Value
  • array:
    • struct - distChannelMap
      • string os - Operationg System
      • string release - OS Relase
      • string arch_name - Channel architecture
      • string channel_label - Channel label
      • string org_specific - 'Y' organization specific, 'N' default

12.4. setMapForOrg

Name
setMapForOrg
Description
Sets, overrides (/removes if channelLabel empty) a distribution channel map within an organization
Parameters
  • string sessionKey
  • string os
  • string release
  • string archName
  • string channelLabel
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 13. errata

Abstract

Provides methods to access and modify errata.

13.1. addPackages

Name
addPackages
Description
Add a set of packages to an erratum with the given advisory name. This method will only allow for modification of custom errata created either through the UI or API.
Parameters
  • string sessionKey
  • string advisoryName
  • array:
    • int - packageId
Return Value
  • int - representing the number of packages added, exception otherwise

13.2. applicableToChannels

Name
applicableToChannels
Description
Returns a list of channels applicable to the erratum with the given advisory name.
Parameters
  • string sessionKey
  • string advisoryName
Return Value
  • array:
    • struct - channel
      • int channel_id
      • string label
      • string name
      • string parent_channel_label

13.3. bugzillaFixes

Name
bugzillaFixes
Description
Get the Bugzilla fixes for an erratum matching the given advisoryName. The bugs will be returned in a struct where the bug id is the key. i.e. 208144="errata.bugzillaFixes Method Returns different results than docs say"
Parameters
  • string sessionKey
  • string advisoryName
Return Value
  • struct - Bugzilla info
    • string bugzilla_id - actual bug number is the key into the struct
    • string bug_summary - summary who's key is the bug id

13.4. clone

Name
clone
Description
Clone a list of errata into the specified channel.
Parameters
  • string sessionKey
  • string channel_label
  • array:
    • string - advisory - The advisory name of the errata to clone.
Return Value
  • 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.

13.5. cloneAsOriginal

Name
cloneAsOriginal
Description
Clones a list of errata into a specified cloned channel according the original erratas.
Parameters
  • string sessionKey
  • string channel_label
  • array:
    • string - advisory - The advisory name of the errata to clone.
Return Value
  • 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.

13.6. cloneAsOriginalAsync

Name
cloneAsOriginalAsync
Description
Asynchronously clones a list of errata into a specified cloned channel according the original erratas
Parameters
  • string sessionKey
  • string channel_label
  • array:
    • string - advisory - The advisory name of the errata to clone.
Return Value
  • int - 1 on success, exception thrown otherwise.

13.7. cloneAsync

Name
cloneAsync
Description
Asynchronously clone a list of errata into the specified channel.
Parameters
  • string sessionKey
  • string channel_label
  • array:
    • string - advisory - The advisory name of the errata to clone.
Return Value
  • int - 1 on success, exception thrown otherwise.

13.8. create

Name
create
Description
Create a custom errata. If "publish" is set to true, the errata will be published as well
Parameters
  • string sessionKey
  • struct - errata info
    • string synopsis
    • string advisory_name
    • int advisory_release
    • string advisory_type - Type of advisory (one of the following: 'Security Advisory', 'Product Enhancement Advisory', or 'Bug Fix Advisory'
    • string product
    • string errataFrom
    • string topic
    • string description
    • string references
    • string notes
    • string solution
  • array:
    • struct - bug
      • int id - Bug Id
      • string summary
      • string url
  • array:
    • string - keyword - List of keywords to associate with the errata.
  • array:
    • int - packageId
  • boolean publish - Should the errata be published.
  • array:
    • string - channelLabel - list of channels the errata should be published too, ignored if publish is set to false
Return Value
  • 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.

13.9. delete

Name
delete
Description
Delete an erratum. This method will only allow for deletion of custom errata created either through the UI or API.
Parameters
  • string sessionKey
  • string advisoryName
Return Value
  • int - 1 on success, exception thrown otherwise.

13.10. findByCve

Name
findByCve
Description
Lookup the details for errata associated with the given CVE (e.g. CVE-2008-3270)
Parameters
  • string sessionKey
  • string cveName
Return Value
  • 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.

13.11. getDetails

Name
getDetails
Description
Retrieves the details for the erratum matching the given advisory name.
Parameters
  • string sessionKey
  • string advisoryName
Return Value
  • struct - erratum
    • int id
    • string issue_date
    • string update_date
    • string last_modified_date - This date is only included for published erratum and it represents the last time the erratum was modified.
    • string synopsis
    • int release
    • string type
    • string product
    • string errataFrom
    • string topic
    • string description
    • string references
    • string notes
    • string solution

13.12. listAffectedSystems

Name
listAffectedSystems
Description
Return the list of systems affected by the erratum with advisory name.
Parameters
  • string sessionKey
  • string advisoryName
Return Value
  • 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

13.13. listByDate

Name
listByDate
Description
List errata that have been applied to a particular channel by date.
Deprecated - being replaced by channel.software.listErrata(User LoggedInUser, string channelLabel)
Parameters
  • string sessionKey
  • string channelLabel
Return Value
  • 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.

13.14. listCves

Name
listCves
Description
Returns a list of CVEs applicable to the erratum with the given advisory name. CVEs may be associated only with published errata.
Parameters
  • string sessionKey
  • string advisoryName
Return Value
  • array:
    • string - cveName

13.15. listKeywords

Name
listKeywords
Description
Get the keywords associated with an erratum matching the given advisory name.
Parameters
  • string sessionKey
  • string advisoryName
Return Value
  • array:
    • string - Keyword associated with erratum.

13.16. listPackages

Name
listPackages
Description
Returns a list of the packages affected by the erratum with the given advisory name.
Parameters
  • string sessionKey
  • string advisoryName
Return Value
  • array:
    • struct - package
      • int id
      • string name
      • string epoch
      • string version
      • string release
      • string arch_label
      • array providing_channels
        • string - - Channel label providing this package.
      • string build_host
      • string description
      • string checksum
      • string checksum_type
      • string vendor
      • string summary
      • string cookie
      • string license
      • string path
      • string file
      • string build_date
      • string last_modified_date
      • string size
      • string payload_size

13.17. listUnpublishedErrata

Name
listUnpublishedErrata
Description
Returns a list of unpublished errata
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - erratum
      • int id
      • int published
      • string advisory
      • string advisory_name
      • string advisory_type
      • string synopsis
      • dateTime.iso8601 created
      • dateTime.iso8601 update_date

13.18. publish

Name
publish
Description
Publish an existing (unpublished) errata to a set of channels.
Parameters
  • string sessionKey
  • string advisoryName
  • array:
    • string - channelLabel - list of channel labels to publish to
Return Value
  • 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.

13.19. publishAsOriginal

Name
publishAsOriginal
Description
Publishes an existing (unpublished) cloned errata to a set of cloned channels according to its original erratum
Parameters
  • string sessionKey
  • string advisoryName
  • array:
    • string - channelLabel - list of channel labels to publish to
Return Value
  • 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.

13.20. removePackages

Name
removePackages
Description
Remove a set of packages from an erratum with the given advisory name. This method will only allow for modification of custom errata created either through the UI or API.
Parameters
  • string sessionKey
  • string advisoryName
  • array:
    • int - packageId
Return Value
  • int - representing the number of packages removed, exception otherwise

13.21. setDetails

Name
setDetails
Description
Set erratum details. All arguments are optional and will only be modified if included in the struct. This method will only allow for modification of custom errata created either through the UI or API.
Parameters
  • string sessionKey
  • string advisoryName
  • struct - errata details
    • string synopsis
    • string advisory_name
    • int advisory_release
    • string advisory_type - Type of advisory (one of the following: 'Security Advisory', 'Product Enhancement Advisory', or 'Bug Fix Advisory'
    • string product
    • dateTime.iso8601 issue_date
    • dateTime.iso8601 update_date
    • string errataFrom
    • string topic
    • string description
    • string references
    • string notes
    • string solution
    • array bugs - 'bugs' is the key into the struct
    • array:
      • struct - bug
        • int id - Bug Id
        • string summary
        • string url
    • array keywords - 'keywords' is the key into the struct
    • array:
      • string - keyword - List of keywords to associate with the errata.
    • array CVEs - 'cves' is the key into the struct
    • array:
      • string - cves - List of CVEs to associate with the errata. (valid only for published errata)
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 14. kickstart

Abstract

Provides methods to create kickstart files

14.1. cloneProfile

Name
cloneProfile
Description
Clone a Kickstart Profile
Parameters
  • string sessionKey
  • string ksLabelToClone - Label of the kickstart profile to clone
  • string newKsLabel - label of the cloned profile
Return Value
  • int - 1 on success, exception thrown otherwise.

14.2. createProfile

Name
createProfile
Description
Import a kickstart profile.
Parameters
  • string sessionKey
  • string profileLabel - Label for the new kickstart profile.
  • string virtualizationType - none, para_host, qemu, xenfv or xenpv.
  • string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
  • string kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile.
  • string rootPassword - Root password.
  • string updateType - Should the profile update itself to use the newest tree available? Possible values are: none (default), red_hat (only use Kickstart Trees synced from Red Hat), or all (includes custom Kickstart Trees).
Return Value
  • int - 1 on success, exception thrown otherwise.

14.3. createProfile

Name
createProfile
Description
Import a kickstart profile.
Parameters
  • string sessionKey
  • string profileLabel - Label for the new kickstart profile.
  • string virtualizationType - none, para_host, qemu, xenfv or xenpv.
  • string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
  • string kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile.
  • string rootPassword - Root password.
Return Value
  • int - 1 on success, exception thrown otherwise.

14.4. createProfileWithCustomUrl

Name
createProfileWithCustomUrl
Description
Import a kickstart profile.
Parameters
  • string sessionKey
  • string profileLabel - Label for the new kickstart profile.
  • string virtualizationType - none, para_host, qemu, xenfv or xenpv.
  • string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
  • boolean downloadUrl - Download URL, or 'default' to use the kickstart tree's default URL.
  • string rootPassword - Root password.
Return Value
  • int - 1 on success, exception thrown otherwise.

14.5. createProfileWithCustomUrl

Name
createProfileWithCustomUrl
Description
Import a kickstart profile.
Parameters
  • string sessionKey
  • string profileLabel - Label for the new kickstart profile.
  • string virtualizationType - none, para_host, qemu, xenfv or xenpv.
  • string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
  • boolean downloadUrl - Download URL, or 'default' to use the kickstart tree's default URL.
  • string rootPassword - Root password.
  • string updateType - Should the profile update itself to use the newest tree available? Possible values are: none (default), red_hat (only use Kickstart Trees synced from Red Hat), or all (includes custom Kickstart Trees).
Return Value
  • int - 1 on success, exception thrown otherwise.

14.6. deleteProfile

Name
deleteProfile
Description
Delete a kickstart profile
Parameters
  • string sessionKey
  • string ksLabel - The label of the kickstart profile you want to remove
Return Value
  • int - 1 on success, exception thrown otherwise.

14.7. disableProfile

Name
disableProfile
Description
Enable/Disable a Kickstart Profile
Parameters
  • string sessionKey
  • string profileLabel - Label for the kickstart tree you want to en/disable
  • string disabled - true to disable the profile
Return Value
  • int - 1 on success, exception thrown otherwise.

14.8. findKickstartForIp

Name
findKickstartForIp
Description
Find an associated kickstart for a given ip address.
Parameters
  • string sessionKey
  • string ipAddress - The ip address to search for (i.e. 192.168.0.1)
Return Value
  • string - label of the kickstart. Empty string ("") if not found.

14.9. importFile

Name
importFile
Description
Import a kickstart profile.
Parameters
  • string sessionKey
  • string profileLabel - Label for the new kickstart profile.
  • string virtualizationType - none, para_host, qemu, xenfv or xenpv.
  • string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
  • string kickstartFileContents - Contents of the kickstart file to import.
Return Value
  • int - 1 on success, exception thrown otherwise.

14.10. importFile

Name
importFile
Description
Import a kickstart profile.
Parameters
  • string sessionKey
  • string profileLabel - Label for the new kickstart profile.
  • string virtualizationType - none, para_host, qemu, xenfv or xenpv.
  • string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
  • string kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile. Using this option signifies that this default URL will be used instead of any url/nfs/cdrom/harddrive commands in the kickstart file itself.
  • string kickstartFileContents - Contents of the kickstart file to import.
Return Value
  • int - 1 on success, exception thrown otherwise.

14.11. importFile

Name
importFile
Description
Import a kickstart profile.
Parameters
  • string sessionKey
  • string profileLabel - Label for the new kickstart profile.
  • string virtualizationType - none, para_host, qemu, xenfv or xenpv.
  • string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
  • string kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile. Using this option signifies that this default URL will be used instead of any url/nfs/cdrom/harddrive commands in the kickstart file itself.
  • string kickstartFileContents - Contents of the kickstart file to import.
  • string updateType - Should the profile update itself to use the newest tree available? Possible values are: none (default), red_hat (only use Kickstart Trees synced from Red Hat), or all (includes custom Kickstart Trees).
Return Value
  • int - 1 on success, exception thrown otherwise.

14.12. importRawFile

Name
importRawFile
Description
Import a raw kickstart file into satellite.
Parameters
  • string sessionKey
  • string profileLabel - Label for the new kickstart profile.
  • string virtualizationType - none, para_host, qemu, xenfv or xenpv.
  • string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
  • string kickstartFileContents - Contents of the kickstart file to import.
Return Value
  • int - 1 on success, exception thrown otherwise.

14.13. importRawFile

Name
importRawFile
Description
Import a raw kickstart file into satellite.
Parameters
  • string sessionKey
  • string profileLabel - Label for the new kickstart profile.
  • string virtualizationType - none, para_host, qemu, xenfv or xenpv.
  • string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
  • string kickstartFileContents - Contents of the kickstart file to import.
  • string updateType - Should the profile update itself to use the newest tree available? Possible values are: none (default), red_hat (only use Kickstart Trees synced from Red Hat), or all (includes custom Kickstart Trees).
Return Value
  • int - 1 on success, exception thrown otherwise.

14.14. isProfileDisabled

Name
isProfileDisabled
Description
Returns whether a kickstart profile is disabled
Parameters
  • string sessionKey
  • string profileLabel - kickstart profile label
Return Value
  • true if profile is disabled

14.15. listAllIpRanges

Name
listAllIpRanges
Description
List all Ip Ranges and their associated kickstarts available in the user's org.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - Kickstart Ip Range
      • string ksLabel - The kickstart label associated with the ip range
      • string max - The max ip of the range
      • string min - The min ip of the range

14.16. listKickstartableChannels

Name
listKickstartableChannels
Description
List kickstartable channels for the logged in user.
Parameters
  • string sessionKey
Return Value
  • 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

14.17. listKickstartableTreeChannels

Name
listKickstartableTreeChannels
Description
List kickstartable tree channels for the logged in user.
Parameters
  • string sessionKey
Return Value
  • 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

14.18. listKickstartableTrees

Name
listKickstartableTrees
Description
List the available kickstartable trees for the given channel.
Deprecated - being replaced by kickstart.tree.list(string sessionKey, string channelLabel)
Parameters
  • string sessionKey
  • string channelLabel - Label of channel to search.
Return Value
  • array:
    • struct - kickstartable tree
      • int id
      • string label
      • string base_path
      • int channel_id

14.19. listKickstarts

Name
listKickstarts
Description
Provides a list of kickstart profiles visible to the user's org
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - kickstart
      • string label
      • string tree_label
      • string name
      • boolean advanced_mode
      • boolean org_default
      • boolean active
      • string update_type

14.20. renameProfile

Name
renameProfile
Description
Rename a Kickstart Profile in Satellite
Parameters
  • string sessionKey
  • string originalLabel - Label for the kickstart profile you want to rename
  • string newLabel - new label to change to
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 15. kickstart.filepreservation

Abstract

Provides methods to retrieve and manipulate kickstart file preservation lists.

15.1. create

Name
create
Description
Create a new file preservation list.
Parameters
  • string session_key
  • string name - name of the file list to create
  • array:
    • string - name - file names to include
Return Value
  • int - 1 on success, exception thrown otherwise.

15.2. delete

Name
delete
Description
Delete a file preservation list.
Parameters
  • string session_key
  • string name - name of the file list to delete
Return Value
  • int - 1 on success, exception thrown otherwise.

15.3. getDetails

Name
getDetails
Description
Returns all of the data associated with the given file preservation list.
Parameters
  • string session_key
  • string name - name of the file list to retrieve details for
Return Value
  • struct - file list
    • string name
    • array file_names
      • string - name

15.4. listAllFilePreservations

Name
listAllFilePreservations
Description
List all file preservation lists for the organization associated with the user logged into the given session
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - file preservation
      • int id
      • string name
      • dateTime.iso8601 created
      • dateTime.iso8601 last_modified

Chapter 16. kickstart.keys

Abstract

Provides methods to manipulate kickstart keys.

16.1. create

Name
create
Description
creates a new key with the given parameters
Parameters
  • string session_key
  • string description
  • string type - valid values are GPG or SSL
  • string content
Return Value
  • int - 1 on success, exception thrown otherwise.

16.2. delete

Name
delete
Description
deletes the key identified by the given parameters
Parameters
  • string session_key
  • string description
Return Value
  • int - 1 on success, exception thrown otherwise.

16.3. getDetails

Name
getDetails
Description
returns all of the data associated with the given key
Parameters
  • string session_key
  • string description
Return Value
  • struct - key
    • string description
    • string type
    • string content

16.4. listAllKeys

Name
listAllKeys
Description
list all keys for the org associated with the user logged into the given session
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - key
      • string description
      • string type

16.5. update

Name
update
Description
Updates type and content of the key identified by the description
Parameters
  • string session_key
  • string description
  • string type - valid values are GPG or SSL
  • string content
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 17. kickstart.profile.keys

Abstract

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

17.1. addActivationKey

Name
addActivationKey
Description
Add an activation key association to the kickstart profile
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
  • string key - the activation key
Return Value
  • int - 1 on success, exception thrown otherwise.

17.2. getActivationKeys

Name
getActivationKeys
Description
Lookup the activation keys associated with the kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
Return Value
  • array:
    • struct - activation key
      • string key
      • string description
      • int usage_limit
      • string base_channel_label
      • array child_channel_labels
        • string - childChannelLabel
      • array entitlements
        • string - entitlementLabel
      • array server_group_ids
        • string - serverGroupId
      • array package_names
        • string - packageName - (deprecated by packages)
      • array packages
        • struct - package
          • string name - packageName
          • string arch - archLabel - optional
      • boolean universal_default
      • boolean disabled

17.3. removeActivationKey

Name
removeActivationKey
Description
Remove an activation key association from the kickstart profile
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
  • string key - the activation key
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 18. kickstart.profile.software

Abstract

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

18.1. appendToSoftwareList

Name
appendToSoftwareList
Description
Append the list of software packages to a kickstart profile. Duplicate packages will be ignored.
Parameters
  • string sessionKey
  • string ksLabel - The label of a kickstart profile.
  • string[] packageList - A list of package names to be added to the profile.
Return Value
  • int - 1 on success, exception thrown otherwise.

18.2. getSoftwareDetails

Name
getSoftwareDetails
Description
Gets kickstart profile software details.
Parameters
  • string sessionKey
  • string ksLabel - Label of the kickstart profile
Return Value
  • struct - Kickstart packages info
    • string noBase - Install @Base package group
    • string ignoreMissing - Ignore missing packages

18.3. getSoftwareList

Name
getSoftwareList
Description
Get a list of a kickstart profile's software packages.
Parameters
  • string sessionKey
  • string ksLabel - The label of a kickstart profile.
Return Value
  • string[] - Get a list of a kickstart profile's software packages.

18.4. setSoftwareDetails

Name
setSoftwareDetails
Description
Sets kickstart profile software details.
Parameters
  • string sessionKey
  • string ksLabel - Label of the kickstart profile
  • struct - Kickstart packages info
    • string noBase - Install @Base package group
    • string ignoreMissing - Ignore missing packages
Return Value
  • int - 1 on success, exception thrown otherwise.

18.5. setSoftwareList

Name
setSoftwareList
Description
Set the list of software packages for a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - The label of a kickstart profile.
  • string[] packageList - A list of package names to be set on the profile.
Return Value
  • int - 1 on success, exception thrown otherwise.

18.6. setSoftwareList

Name
setSoftwareList
Description
Set the list of software packages for a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - The label of a kickstart profile.
  • string[] packageList - A list of package names to be set on the profile.
  • boolean ignoremissing - Ignore missing packages if true
  • boolean nobase - Don't install @Base package group if true
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 19. kickstart.profile.system

Abstract

Provides methods to set various properties of a kickstart profile.

19.1. addFilePreservations

Name
addFilePreservations
Description
Adds the given list of file preservations to the specified kickstart profile.
Parameters
  • string sessionKey
  • string kickstartLabel
  • array:
    • string - filePreservations
Return Value
  • int - 1 on success, exception thrown otherwise.

19.2. addKeys

Name
addKeys
Description
Adds the given list of keys to the specified kickstart profile.
Parameters
  • string sessionKey
  • string kickstartLabel
  • array:
    • string - keyDescription
Return Value
  • int - 1 on success, exception thrown otherwise.

19.3. checkConfigManagement

Name
checkConfigManagement
Description
Check the configuration management status for a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
Return Value
  • boolean enabled - true if configuration management is enabled; otherwise, false

19.4. checkRemoteCommands

Name
checkRemoteCommands
Description
Check the remote commands status flag for a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
Return Value
  • boolean enabled - true if remote commands support is enabled; otherwise, false

19.5. disableConfigManagement

Name
disableConfigManagement
Description
Disables the configuration management flag in a kickstart profile so that a system created using this profile will be NOT be configuration capable.
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
Return Value
  • int - 1 on success, exception thrown otherwise.

19.6. disableRemoteCommands

Name
disableRemoteCommands
Description
Disables the remote command flag in a kickstart profile so that a system created using this profile will be capable of running remote commands
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
Return Value
  • int - 1 on success, exception thrown otherwise.

19.7. enableConfigManagement

Name
enableConfigManagement
Description
Enables the configuration management flag in a kickstart profile so that a system created using this profile will be configuration capable.
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
Return Value
  • int - 1 on success, exception thrown otherwise.

19.8. enableRemoteCommands

Name
enableRemoteCommands
Description
Enables the remote command flag in a kickstart profile so that a system created using this profile will be capable of running remote commands
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
Return Value
  • int - 1 on success, exception thrown otherwise.

19.9. getLocale

Name
getLocale
Description
Retrieves the locale for a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
Return Value
  • struct - locale info
    • string locale
    • boolean useUtc
      • true - the hardware clock uses UTC
      • false - the hardware clock does not use UTC

19.10. getPartitioningScheme

Name
getPartitioningScheme
Description
Get the partitioning scheme for a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - The label of a kickstart profile.
Return Value
  • string[] - A list of partitioning commands used to setup the partitions, logical volumes and volume groups."

19.11. getRegistrationType

Name
getRegistrationType
Description
returns the registration type of a given kickstart profile. Registration Type can be one of reactivation/deletion/none These types determine the behaviour of the registration when using this profile for reprovisioning.
Parameters
  • string sessionKey
  • string kickstartLabel
Return Value
  • string registrationType
    • reactivation
    • deletion
    • none

19.12. getSELinux

Name
getSELinux
Description
Retrieves the SELinux enforcing mode property of a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
Return Value
  • string enforcingMode
    • enforcing
    • permissive
    • disabled

19.13. listFilePreservations

Name
listFilePreservations
Description
Returns the set of all file preservations associated with the given kickstart profile.
Parameters
  • string sessionKey
  • string kickstartLabel
Return Value
  • array:
    • struct - file list
      • string name
      • array file_names
        • string - name

19.14. listKeys

Name
listKeys
Description
Returns the set of all keys associated with the given kickstart profile.
Parameters
  • string sessionKey
  • string kickstartLabel
Return Value
  • array:
    • struct - key
      • string description
      • string type
      • string content

19.15. removeFilePreservations

Name
removeFilePreservations
Description
Removes the given list of file preservations from the specified kickstart profile.
Parameters
  • string sessionKey
  • string kickstartLabel
  • array:
    • string - filePreservations
Return Value
  • int - 1 on success, exception thrown otherwise.

19.16. removeKeys

Name
removeKeys
Description
Removes the given list of keys from the specified kickstart profile.
Parameters
  • string sessionKey
  • string kickstartLabel
  • array:
    • string - keyDescription
Return Value
  • int - 1 on success, exception thrown otherwise.

19.17. setLocale

Name
setLocale
Description
Sets the locale for a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
  • string locale - the locale
  • boolean useUtc
    • true - the hardware clock uses UTC
    • false - the hardware clock does not use UTC
Return Value
  • int - 1 on success, exception thrown otherwise.

19.18. setPartitioningScheme

Name
setPartitioningScheme
Description
Set the partitioning scheme for a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - The label of the kickstart profile to update.
  • string[] scheme - The partitioning scheme is a list of partitioning command strings used to setup the partitions, volume groups and logical volumes.
Return Value
  • int - 1 on success, exception thrown otherwise.

19.19. setRegistrationType

Name
setRegistrationType
Description
Sets the registration type of a given kickstart profile. Registration Type can be one of reactivation/deletion/none These types determine the behaviour of the re registration when using this profile.
Parameters
  • string sessionKey
  • string kickstartLabel
  • string registrationType
    • reactivation - to try and generate a reactivation key and use that to register the system when reprovisioning a system.
    • deletion - to try and delete the existing system profile and reregister the system being reprovisioned as new
    • none - to preserve the status quo and leave the current system as a duplicate on a reprovision.
Return Value
  • int - 1 on success, exception thrown otherwise.

19.20. setSELinux

Name
setSELinux
Description
Sets the SELinux enforcing mode property of a kickstart profile so that a system created using this profile will be have the appropriate SELinux enforcing mode.
Parameters
  • string sessionKey
  • string ksLabel - the kickstart profile label
  • string enforcingMode - the selinux enforcing mode
    • enforcing
    • permissive
    • disabled
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 20. kickstart.profile

Abstract

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

20.1. addIpRange

Name
addIpRange
Description
Add an ip range to a kickstart profile.
Parameters
  • string sessionKey
  • string label - The label of the kickstart
  • string min - The ip address making up the minimum of the range (i.e. 192.168.0.1)
  • string max - The ip address making up the maximum of the range (i.e. 192.168.0.254)
Return Value
  • int - 1 on success, exception thrown otherwise.

20.2. addScript

Name
addScript
Description
Add a pre/post script to a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - The kickstart label to add the script to.
  • string name - The kickstart script name.
  • string contents - The full script to add.
  • string interpreter - The path to the interpreter to use (i.e. /bin/bash). An empty string will use the kickstart default interpreter.
  • string type - The type of script (either 'pre' or 'post').
  • boolean chroot - Whether to run the script in the chrooted install location (recommended) or not.
Return Value
  • int id - the id of the added script

20.3. addScript

Name
addScript
Description
Add a pre/post script to a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - The kickstart label to add the script to.
  • string name - The kickstart script name.
  • string contents - The full script to add.
  • string interpreter - The path to the interpreter to use (i.e. /bin/bash). An empty string will use the kickstart default interpreter.
  • string type - The type of script (either 'pre' or 'post').
  • boolean chroot - Whether to run the script in the chrooted install location (recommended) or not.
  • boolean template - Enable templating using cobbler.
Return Value
  • int id - the id of the added script

20.4. addScript

Name
addScript
Description
Add a pre/post script to a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - The kickstart label to add the script to.
  • string name - The kickstart script name.
  • string contents - The full script to add.
  • string interpreter - The path to the interpreter to use (i.e. /bin/bash). An empty string will use the kickstart default interpreter.
  • string type - The type of script (either 'pre' or 'post').
  • boolean chroot - Whether to run the script in the chrooted install location (recommended) or not.
  • boolean template - Enable templating using cobbler.
  • boolean erroronfail - Whether to throw an error if the script fails or not
Return Value
  • int id - the id of the added script

20.5. compareActivationKeys

Name
compareActivationKeys
Description
Returns a list for each kickstart profile; each list will contain activation keys not present on the other profile.
Parameters
  • string sessionKey
  • string kickstartLabel1
  • string kickstartLabel2
Return Value
  • struct - Comparison Info
    • array kickstartLabel1 - Actual label of the first kickstart profile is the key into the struct
    • array:
      • struct - activation key
        • string key
        • string description
        • int usage_limit
        • string base_channel_label
        • array child_channel_labels
          • string - childChannelLabel
        • array entitlements
          • string - entitlementLabel
        • array server_group_ids
          • string - serverGroupId
        • array package_names
          • string - packageName - (deprecated by packages)
        • array packages
          • struct - package
            • string name - packageName
            • string arch - archLabel - optional
        • boolean universal_default
        • boolean disabled
    • array kickstartLabel2 - Actual label of the second kickstart profile is the key into the struct
    • array:
      • struct - activation key
        • string key
        • string description
        • int usage_limit
        • string base_channel_label
        • array child_channel_labels
          • string - childChannelLabel
        • array entitlements
          • string - entitlementLabel
        • array server_group_ids
          • string - serverGroupId
        • array package_names
          • string - packageName - (deprecated by packages)
        • array packages
          • struct - package
            • string name - packageName
            • string arch - archLabel - optional
        • boolean universal_default
        • boolean disabled

20.6. compareAdvancedOptions

Name
compareAdvancedOptions
Description
Returns a list for each kickstart profile; each list will contain the properties that differ between the profiles and their values for that specific profile .
Parameters
  • string sessionKey
  • string kickstartLabel1
  • string kickstartLabel2
Return Value
  • struct - Comparison Info
    • array kickstartLabel1 - Actual label of the first kickstart profile is the key into the struct
    • array:
      • struct - value
        • string name
        • string value
        • boolean enabled
    • array kickstartLabel2 - Actual label of the second kickstart profile is the key into the struct
    • array:
      • struct - value
        • string name
        • string value
        • boolean enabled

20.7. comparePackages

Name
comparePackages
Description
Returns a list for each kickstart profile; each list will contain package names not present on the other profile.
Parameters
  • string sessionKey
  • string kickstartLabel1
  • string kickstartLabel2
Return Value
  • struct - Comparison Info
    • array kickstartLabel1 - Actual label of the first kickstart profile is the key into the struct
    • array:
      • string - package name
    • array kickstartLabel2 - Actual label of the second kickstart profile is the key into the struct
    • array:
      • string - package name

20.8. downloadKickstart

Name
downloadKickstart
Description
Download the full contents of a kickstart file.
Parameters
  • string sessionKey
  • string ksLabel - The label of the kickstart to download.
  • string host - The host to use when referring to the satellite itself (Usually this should be the FQDN of the satellite, but could be the ip address or shortname of it as well.
Return Value
  • string - The contents of the kickstart file. Note: if an activation key is not associated with the kickstart file, registration will not occur in the satellite generated %post section. If one is associated, it will be used for registration.

20.9. downloadRenderedKickstart

Name
downloadRenderedKickstart
Description
Downloads the Cobbler-rendered Kickstart file.
Parameters
  • string sessionKey
  • string ksLabel - The label of the kickstart to download.
Return Value
  • string - The contents of the kickstart file.

20.10. getAdvancedOptions

Name
getAdvancedOptions
Description
Get advanced options for a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - Label of kickstart profile to be changed.
Return Value
  • array:
    • struct - option
      • string name
      • string arguments

20.11. getAvailableRepositories

Name
getAvailableRepositories
Description
Lists available OS repositories to associate with the provided kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel
Return Value
  • array:
    • string - repositoryLabel

20.12. getCfgPreservation

Name
getCfgPreservation
Description
Get ks.cfg preservation option for a kickstart profile.
Parameters
  • string sessionKey
  • string kslabel - Label of kickstart profile to be changed.
Return Value
  • boolean - The value of the option. True means that ks.cfg will be copied to /root, false means that it will not.

20.13. getChildChannels

Name
getChildChannels
Description
Get the child channels for a kickstart profile.
Parameters
  • string sessionKey
  • string kslabel - Label of kickstart profile.
Return Value
  • array:
    • string - channelLabel

20.14. getCustomOptions

Name
getCustomOptions
Description
Get custom options for a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel
Return Value
  • array:
    • struct - option
      • int id
      • string arguments

20.15. getKickstartTree

Name
getKickstartTree
Description
Get the kickstart tree for a kickstart profile.
Parameters
  • string sessionKey
  • string kslabel - Label of kickstart profile to be changed.
Return Value
  • string kstreeLabel - Label of the kickstart tree.

20.16. getRepositories

Name
getRepositories
Description
Lists all OS repositories associated with provided kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel
Return Value
  • array:
    • string - repositoryLabel

20.17. getUpdateType

Name
getUpdateType
Description
Get the update type for a kickstart profile.
Parameters
  • string sessionKey
  • string kslabel - Label of kickstart profile.
Return Value
  • string update_type - Update type for this Kickstart Profile.

20.18. getVariables

Name
getVariables
Description
Returns a list of variables associated with the specified kickstart profile
Parameters
  • string sessionKey
  • string ksLabel
Return Value
  • struct - kickstart variable
    • string key
    • string or int value

20.19. getVirtualizationType

Name
getVirtualizationType
Description
For given kickstart profile label returns label of virtualization type it's using
Parameters
  • string sessionKey
  • string ksLabel
Return Value
  • string virtLabel - Label of virtualization type.

20.20. listIpRanges

Name
listIpRanges
Description
List all ip ranges for a kickstart profile.
Parameters
  • string sessionKey
  • string label - The label of the kickstart
Return Value
  • array:
    • struct - Kickstart Ip Range
      • string ksLabel - The kickstart label associated with the ip range
      • string max - The max ip of the range
      • string min - The min ip of the range

20.21. listScripts

Name
listScripts
Description
List the pre and post scripts for a kickstart profile in the order they will run during the kickstart.
Parameters
  • string sessionKey
  • string ksLabel - The label of the kickstart
Return Value
  • array:
    • struct - kickstart script
      • int id
      • string name
      • string contents
      • string script_type - Which type of script ('pre' or 'post').
      • string interpreter - The scripting language interpreter to use for this script. An empty string indicates the default kickstart shell.
      • boolean chroot - True if the script will be executed within the chroot environment.
      • boolean erroronfail - True if the script will throw an error if it fails.
      • boolean template - True if templating using cobbler is enabled
      • boolean beforeRegistration - True if script will run before the server registers and performs server actions.

20.22. orderScripts

Name
orderScripts
Description
Change the order that kickstart scripts will run for this kickstart profile. Scripts will run in the order they appear in the array. There are three arrays, one for all pre scripts, one for the post scripts that run before registration and server actions happen, and one for post scripts that run after registration and server actions. All scripts must be included in one of these lists, as appropriate.
Parameters
  • string sessionKey
  • string ksLabel - The label of the kickstart
  • array:
    • int - IDs of the ordered pre scripts
  • array:
    • int - IDs of the ordered post scripts that will run before registration
  • array:
    • int - IDs of the ordered post scripts that will run after registration
Return Value
  • int - 1 on success, exception thrown otherwise.

20.23. removeIpRange

Name
removeIpRange
Description
Remove an ip range from a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - The kickstart label of the ip range you want to remove
  • string ip_address - An Ip Address that falls within the range that you are wanting to remove. The min or max of the range will work.
Return Value
  • int - 1 on successful removal, 0 if range wasn't found for the specified kickstart, exception otherwise.

20.24. removeScript

Name
removeScript
Description
Remove a script from a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel - The kickstart from which to remove the script from.
  • int scriptId - The id of the script to remove.
Return Value
  • int - 1 on success, exception thrown otherwise.

20.25. setAdvancedOptions

Name
setAdvancedOptions
Description
Set advanced options for a kickstart profile. If 'md5_crypt_rootpw' is set to 'True', 'root_pw' is taken as plaintext and will md5 encrypted on server side, otherwise a hash encoded password (according to the auth option) is expected
Parameters
  • string sessionKey
  • string ksLabel
  • array:
    • struct - advanced options
      • string name - Name of the advanced option. Valid Option names: autostep, interactive, install, upgrade, text, network, cdrom, harddrive, nfs, url, lang, langsupport keyboard, mouse, device, deviceprobe, zerombr, clearpart, bootloader, timezone, auth, rootpw, selinux, reboot, firewall, xconfig, skipx, key, ignoredisk, autopart, cmdline, firstboot, graphical, iscsi, iscsiname, logging, monitor, multipath, poweroff, halt, services, shutdown, user, vnc, zfcp, driverdisk, md5_crypt_rootpw
      • string arguments - Arguments of the option
Return Value
  • int - 1 on success, exception thrown otherwise.

20.26. setCfgPreservation

Name
setCfgPreservation
Description
Set ks.cfg preservation option for a kickstart profile.
Parameters
  • string sessionKey
  • string kslabel - Label of kickstart profile to be changed.
  • boolean preserve - whether or not ks.cfg and all %include fragments will be copied to /root.
Return Value
  • int - 1 on success, exception thrown otherwise.

20.27. setChildChannels

Name
setChildChannels
Description
Set the child channels for a kickstart profile.
Parameters
  • string sessionKey
  • string kslabel - Label of kickstart profile to be changed.
  • string[] channelLabels - List of labels of child channels
Return Value
  • int - 1 on success, exception thrown otherwise.

20.28. setCustomOptions

Name
setCustomOptions
Description
Set custom options for a kickstart profile.
Parameters
  • string sessionKey
  • string ksLabel
  • string[] options
Return Value
  • int - 1 on success, exception thrown otherwise.

20.29. setKickstartTree

Name
setKickstartTree
Description
Set the kickstart tree for a kickstart profile.
Parameters
  • string sessionKey
  • string kslabel - Label of kickstart profile to be changed.
  • string kstreeLabel - Label of new kickstart tree.
Return Value
  • int - 1 on success, exception thrown otherwise.

20.30. setLogging

Name
setLogging
Description
Set logging options for a kickstart profile.
Parameters
  • string sessionKey
  • string kslabel - Label of kickstart profile to be changed.
  • boolean pre - whether or not to log the pre section of a kickstart to /root/ks-pre.log
  • boolean post - whether or not to log the post section of a kickstart to /root/ks-post.log
Return Value
  • int - 1 on success, exception thrown otherwise.

20.31. setRepositories

Name
setRepositories
Description
$call.doc
Parameters
  • string sessionKey
  • string ksLabel
  • array:
    • string - repositoryLabel
Return Value
  • int - 1 on success, exception thrown otherwise.

20.32. setUpdateType

Name
setUpdateType
Description
Set the update typefor a kickstart profile.
Parameters
  • string sessionKey
  • string kslabel - Label of kickstart profile to be changed.
  • string updateType - The new update type to set. Possible values are 'red_hat', 'all', and 'none'.
Return Value
  • int - 1 on success, exception thrown otherwise.

20.33. setVariables

Name
setVariables
Description
Associates list of kickstart variables with the specified kickstart profile
Parameters
  • string sessionKey
  • string ksLabel
  • struct - kickstart variable
    • string key
    • string or int value
Return Value
  • int - 1 on success, exception thrown otherwise.

20.34. setVirtualizationType

Name
setVirtualizationType
Description
For given kickstart profile label sets its virtualization type.
Parameters
  • string sessionKey
  • string ksLabel
  • string typeLabel - One of the following: 'none', 'qemu', 'para_host', 'xenpv', 'xenfv'
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 21. kickstart.snippet

Abstract

Provides methods to create kickstart files

21.1. createOrUpdate

Name
createOrUpdate
Description
Will create a snippet with the given name and contents if it doesn't exist. If it does exist, the existing snippet will be updated.
Parameters
  • string sessionKey
  • string name
  • string contents
Return Value
  • struct - snippet
    • string name
    • string contents
    • string fragment - The string to include in a kickstart file that will generate this snippet.
    • string file - The local path to the file containing this snippet.

21.2. delete

Name
delete
Description
Delete the specified snippet. If the snippet is not found, 0 is returned.
Parameters
  • string sessionKey
  • string name
Return Value
  • int - 1 on success, exception thrown otherwise.

21.3. listAll

Name
listAll
Description
List all cobbler snippets for the logged in user
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - snippet
      • string name
      • string contents
      • string fragment - The string to include in a kickstart file that will generate this snippet.
      • string file - The local path to the file containing this snippet.

21.4. listCustom

Name
listCustom
Description
List only custom snippets for the logged in user. These snipppets are editable.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - snippet
      • string name
      • string contents
      • string fragment - The string to include in a kickstart file that will generate this snippet.
      • string file - The local path to the file containing this snippet.

21.5. listDefault

Name
listDefault
Description
List only pre-made default snippets for the logged in user. These snipppets are not editable.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - snippet
      • string name
      • string contents
      • string fragment - The string to include in a kickstart file that will generate this snippet.
      • string file - The local path to the file containing this snippet.

Chapter 22. kickstart.tree

Abstract

Provides methods to access and modify the kickstart trees.

22.1. create

Name
create
Description
Create a Kickstart Tree (Distribution) in Satellite.
Parameters
  • string sessionKey
  • string treeLabel - The new kickstart tree label.
  • string basePath - Path to the base or root of the kickstart tree.
  • string channelLabel - Label of channel to associate with the kickstart tree.
  • string installType - Label for KickstartInstallType (rhel_2.1, rhel_3, rhel_4, rhel_5, fedora_9).
Return Value
  • int - 1 on success, exception thrown otherwise.

22.2. delete

Name
delete
Description
Delete a Kickstart Tree (Distribution) in Satellite.
Parameters
  • string sessionKey
  • string treeLabel - Label for the kickstart tree to delete.
Return Value
  • int - 1 on success, exception thrown otherwise.

22.3. deleteTreeAndProfiles

Name
deleteTreeAndProfiles
Description
Delete a kickstarttree and any profiles associated with this kickstart tree. WARNING: This will delete all profiles associated with this kickstart tree!
Parameters
  • string sessionKey
  • string treeLabel - Label for the kickstart tree to delete.
Return Value
  • int - 1 on success, exception thrown otherwise.

22.4. getDetails

Name
getDetails
Description
The detailed information about a kickstartable tree given the tree name.
Parameters
  • string sessionKey
  • string treeLabel - Label of kickstartable tree to search.
Return Value
  • struct - kickstartable tree
    • int id
    • string label
    • string abs_path
    • int channel_id
    • struct - kickstart install type
      • int id
      • string label
      • string name

22.5. list

Name
list
Description
List the available kickstartable trees for the given channel.
Parameters
  • string sessionKey
  • string channelLabel - Label of channel to search.
Return Value
  • array:
    • struct - kickstartable tree
      • int id
      • string label
      • string base_path
      • int channel_id

22.6. listInstallTypes

Name
listInstallTypes
Description
List the available kickstartable install types (rhel2,3,4,5 and fedora9+).
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - kickstart install type
      • int id
      • string label
      • string name

22.7. rename

Name
rename
Description
Rename a Kickstart Tree (Distribution) in Satellite.
Parameters
  • string sessionKey
  • string originalLabel - Label for the kickstart tree to rename.
  • string newLabel - The kickstart tree's new label.
Return Value
  • int - 1 on success, exception thrown otherwise.

22.8. update

Name
update
Description
Edit a Kickstart Tree (Distribution) in Satellite.
Parameters
  • string sessionKey
  • string treeLabel - Label for the kickstart tree.
  • string basePath - Path to the base or root of the kickstart tree.
  • string channelLabel - Label of channel to associate with kickstart tree.
  • string installType - Label for KickstartInstallType (rhel_2.1, rhel_3, rhel_4, rhel_5, fedora_9).
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 23. org

Abstract

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

23.1. create

Name
create
Description
Create a new organization and associated administrator account.
Parameters
  • string sessionKey
  • string orgName - Organization name. Must meet same criteria as in the web UI.
  • string adminLogin - New administrator login name.
  • string adminPassword - New administrator password.
  • string prefix - New administrator's prefix. Must match one of the values available in the web UI. (i.e. Dr., Mr., Mrs., Sr., etc.)
  • string firstName - New administrator's first name.
  • string lastName - New administrator's first name.
  • string email - New administrator's e-mail.
  • boolean usePamAuth - True if PAM authentication should be used for the new administrator account.
Return Value
  • struct - organization info
    • int id
    • string name
    • int active_users - Number of active users in the organization.
    • int systems - Number of systems in the organization.
    • int trusts - Number of trusted organizations.
    • int system_groups - Number of system groups in the organization. (optional)
    • int activation_keys - Number of activation keys in the organization. (optional)
    • int kickstart_profiles - Number of kickstart profiles in the organization. (optional)
    • int configuration_channels - Number of configuration channels in the organization. (optional)
    • boolean staging_content_enabled - Is staging content enabled in organization. (optional)

23.2. delete

Name
delete
Description
Delete an organization. The default organization (i.e. orgId=1) cannot be deleted.
Parameters
  • string sessionKey
  • int orgId
Return Value
  • int - 1 on success, exception thrown otherwise.

23.3. getCrashFileSizeLimit

Name
getCrashFileSizeLimit
Description
Get the organization wide crash file size limit. The limit value must be a non-negative number, zero means no limit.
Parameters
  • string sessionKey
  • int orgId
Return Value
  • int - Crash file size limit.

23.4. getDetails

Name
getDetails
Description
The detailed information about an organization given the organization ID.
Parameters
  • string sessionKey
  • int orgId
Return Value
  • struct - organization info
    • int id
    • string name
    • int active_users - Number of active users in the organization.
    • int systems - Number of systems in the organization.
    • int trusts - Number of trusted organizations.
    • int system_groups - Number of system groups in the organization. (optional)
    • int activation_keys - Number of activation keys in the organization. (optional)
    • int kickstart_profiles - Number of kickstart profiles in the organization. (optional)
    • int configuration_channels - Number of configuration channels in the organization. (optional)
    • boolean staging_content_enabled - Is staging content enabled in organization. (optional)

23.5. getDetails

Name
getDetails
Description
The detailed information about an organization given the organization name.
Parameters
  • string sessionKey
  • string name
Return Value
  • struct - organization info
    • int id
    • string name
    • int active_users - Number of active users in the organization.
    • int systems - Number of systems in the organization.
    • int trusts - Number of trusted organizations.
    • int system_groups - Number of system groups in the organization. (optional)
    • int activation_keys - Number of activation keys in the organization. (optional)
    • int kickstart_profiles - Number of kickstart profiles in the organization. (optional)
    • int configuration_channels - Number of configuration channels in the organization. (optional)
    • boolean staging_content_enabled - Is staging content enabled in organization. (optional)

23.6. getPolicyForScapFileUpload

Name
getPolicyForScapFileUpload
Description
Get the status of SCAP detailed result file upload settings for the given organization.
Parameters
  • string sessionKey
  • int orgId
Return Value
  • struct - scap_upload_info
    • boolean enabled - Aggregation of detailed SCAP results is enabled.
    • int size_limit - Limit (in Bytes) for a single SCAP file upload.

23.7. getPolicyForScapResultDeletion

Name
getPolicyForScapResultDeletion
Description
Get the status of SCAP result deletion settings for the given organization.
Parameters
  • string sessionKey
  • int orgId
Return Value
  • struct - scap_deletion_info
    • boolean enabled - Deletion of SCAP results is enabled
    • int retention_period - Period (in days) after which a scan can be deleted (if enabled).

23.8. isCrashReportingEnabled

Name
isCrashReportingEnabled
Description
Get the status of crash reporting settings for the given organization. Returns true if enabled, false otherwise.
Parameters
  • string sessionKey
  • int orgId
Return Value
  • boolean - Get the status of crash reporting settings.

23.9. isCrashfileUploadEnabled

Name
isCrashfileUploadEnabled
Description
Get the status of crash file upload settings for the given organization. Returns true if enabled, false otherwise.
Parameters
  • string sessionKey
  • int orgId
Return Value
  • boolean - Get the status of crash file upload settings.

23.10. isErrataEmailNotifsForOrg

Name
isErrataEmailNotifsForOrg
Description
Returns whether errata e-mail notifications are enabled for the organization
Parameters
  • string sessionKey
  • int orgId
Return Value
  • boolean - Returns the status of the errata e-mail notification setting for the organization

23.11. isOrgConfigManagedByOrgAdmin

Name
isOrgConfigManagedByOrgAdmin
Description
Returns whether Organization Administrator is able to manage his organization configuration. This organization configuration may have a high impact on the whole Spacewalk/Satellite performance
Parameters
  • string sessionKey
  • int orgId
Return Value
  • boolean - Returns the status org admin management setting

23.12. listOrgs

Name
listOrgs
Description
Returns the list of organizations.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - organization info
      • int id
      • string name
      • int active_users - Number of active users in the organization.
      • int systems - Number of systems in the organization.
      • int trusts - Number of trusted organizations.
      • int system_groups - Number of system groups in the organization. (optional)
      • int activation_keys - Number of activation keys in the organization. (optional)
      • int kickstart_profiles - Number of kickstart profiles in the organization. (optional)
      • int configuration_channels - Number of configuration channels in the organization. (optional)
      • boolean staging_content_enabled - Is staging content enabled in organization. (optional)

23.13. listSoftwareEntitlements

Name
listSoftwareEntitlements
Description
List software entitlement allocation information across all organizations. Caller must be a satellite administrator.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - entitlement usage
      • string label
      • string name
      • int free
      • int used
      • int allocated
      • int unallocated
      • int free_flex
      • int used_flex
      • int allocated_flex
      • int unallocated_flex

23.14. listSoftwareEntitlements

Name
listSoftwareEntitlements
Description
List each organization's allocation of a given software entitlement. Organizations with no allocation will not be present in the list. A value of -1 indicates unlimited entitlements.
Deprecated - being replaced by listSoftwareEntitlements(string sessionKey, string label, boolean includeUnentitled)
Parameters
  • string sessionKey
  • string label - Software entitlement label.
Return Value
  • array:
    • struct - entitlement usage
      • int org_id
      • string org_name
      • int allocated
      • int unallocated
      • int used
      • int free

23.15. listSoftwareEntitlements

Name
listSoftwareEntitlements
Description
List each organization's allocation of a given software entitlement. A value of -1 indicates unlimited entitlements.
Available since: 10.4
Parameters
  • string sessionKey
  • string label - Software entitlement label.
  • boolean includeUnentitled - If true, the result will include both organizations that have the entitlement as well as those that do not; otherwise, the result will only include organizations that have the entitlement.
Return Value
  • array:
    • struct - entitlement usage
      • int org_id
      • string org_name
      • int allocated
      • int unallocated
      • int used
      • int free

23.16. listSoftwareEntitlementsForOrg

Name
listSoftwareEntitlementsForOrg
Description
List an organization's allocation of each software entitlement. A value of -1 indicates unlimited entitlements.
Parameters
  • string sessionKey
  • int orgId
Return Value
  • array:
    • struct - entitlement usage
      • string label
      • string name
      • int allocated
      • int unallocated
      • int free
      • int used
      • int allocated_flex
      • int unallocated_flex
      • int free_flex
      • int used_flex

23.17. listSystemEntitlements

Name
listSystemEntitlements
Description
Lists system entitlement allocation information across all organizations. Caller must be a satellite administrator.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - entitlement usage
      • string label
      • string name
      • int allocated
      • int unallocated
      • int used
      • int free

23.18. listSystemEntitlements

Name
listSystemEntitlements
Description
List each organization's allocation of a system entitlement. If the organization has no allocation for a particular entitlement, it will not appear in the list.
Deprecated - being replaced by listSystemEntitlements(string sessionKey, string label, boolean includeUnentitled)
Parameters
  • string sessionKey
  • string label
Return Value
  • array:
    • struct - entitlement usage
      • int org_id
      • string org_name
      • int allocated
      • int unallocated
      • int used
      • int free

23.19. listSystemEntitlements

Name
listSystemEntitlements
Description
List each organization's allocation of a system entitlement.
Available since: 10.4
Parameters
  • string sessionKey
  • string label
  • boolean includeUnentitled - If true, the result will include both organizations that have the entitlement as well as those that do not; otherwise, the result will only include organizations that have the entitlement.
Return Value
  • array:
    • struct - entitlement usage
      • int org_id
      • string org_name
      • int allocated
      • int unallocated
      • int used
      • int free

23.20. listSystemEntitlementsForOrg

Name
listSystemEntitlementsForOrg
Description
List an organization's allocation of each system entitlement.
Parameters
  • string sessionKey
  • int orgId
Return Value
  • array:
    • struct - entitlement usage
      • string label
      • string name
      • int free
      • int used
      • int allocated
      • int unallocated

23.21. listUsers

Name
listUsers
Description
Returns the list of users in a given organization.
Parameters
  • string sessionKey
  • int orgId
Return Value
  • array:
    • struct - user
      • string login
      • string login_uc
      • string name
      • string email
      • boolean is_org_admin

23.22. migrateSystems

Name
migrateSystems
Description
Migrate systems from one organization to another. If executed by a Satellite administrator, the systems will be migrated from their current organization to the organization specified by the toOrgId. If executed by an organization administrator, the systems must exist in the same organization as that administrator and the systems will be migrated to the organization specified by the toOrgId. In any scenario, the origination and destination organizations must be defined in a trust.
Parameters
  • string sessionKey
  • int toOrgId - ID of the organization where the system(s) will be migrated to.
  • array:
    • int - systemId
Return Value
  • array:
    • int - serverIdMigrated

23.23. setCrashFileSizeLimit

Name
setCrashFileSizeLimit
Description
Set the organization wide crash file size limit. The limit value must be non-negative, zero means no limit.
Parameters
  • string sessionKey
  • int orgId
  • int limit - The limit to set (non-negative value).
Return Value
  • int - 1 on success, exception thrown otherwise.

23.24. setCrashReporting

Name
setCrashReporting
Description
Set the status of crash reporting settings for the given organization. Disabling crash reporting will automatically disable crash file upload.
Parameters
  • string sessionKey
  • int orgId
  • boolean enable - Use true/false to enable/disable
Return Value
  • int - 1 on success, exception thrown otherwise.

23.25. setCrashfileUpload

Name
setCrashfileUpload
Description
Set the status of crash file upload settings for the given organization. Modifying the settings is possible as long as crash reporting is enabled.
Parameters
  • string sessionKey
  • int orgId
  • boolean enable - Use true/false to enable/disable
Return Value
  • int - 1 on success, exception thrown otherwise.

23.26. setErrataEmailNotifsForOrg

Name
setErrataEmailNotifsForOrg
Description
Dis/enables errata e-mail notifications for the organization
Parameters
  • string sessionKey
  • int orgId
  • boolean enable - Use true/false to enable/disable
Return Value
  • int - 1 on success, exception thrown otherwise.

23.27. setOrgConfigManagedByOrgAdmin

Name
setOrgConfigManagedByOrgAdmin
Description
Sets whether Organization Administrator can manage his organization configuration. This organization configuration may have a high impact on the whole Spacewalk/Satellite performance
Parameters
  • string sessionKey
  • int orgId
  • boolean enable - Use true/false to enable/disable
Return Value
  • int - 1 on success, exception thrown otherwise.

23.28. setPolicyForScapFileUpload

Name
setPolicyForScapFileUpload
Description
Set the status of SCAP detailed result file upload settings for the given organization.
Parameters
  • string sessionKey
  • int orgId
  • struct - scap_upload_info
    • boolean enabled - Aggregation of detailed SCAP results is enabled.
    • int size_limit - Limit (in Bytes) for a single SCAP file upload.
Return Value
  • int - 1 on success, exception thrown otherwise.

23.29. setPolicyForScapResultDeletion

Name
setPolicyForScapResultDeletion
Description
Set the status of SCAP result deletion settins for the given organization.
Parameters
  • string sessionKey
  • int orgId
  • struct - scap_deletion_info
    • boolean enabled - Deletion of SCAP results is enabled
    • int retention_period - Period (in days) after which a scan can be deleted (if enabled).
Return Value
  • int - 1 on success, exception thrown otherwise.

23.30. setSoftwareEntitlements

Name
setSoftwareEntitlements
Description
Set an organization's entitlement allocation for the given software entitlement. If increasing the entitlement allocation, the default organization (i.e. orgId=1) must have a sufficient number of free entitlements.
Parameters
  • string sessionKey
  • int orgId
  • string label - Software entitlement label.
  • int allocation
Return Value
  • int - 1 on success, exception thrown otherwise.

23.31. setSoftwareFlexEntitlements

Name
setSoftwareFlexEntitlements
Description
Set an organization's flex entitlement allocation for the given software entitlement. If increasing the flex entitlement allocation, the default organization (i.e. orgId=1) must have a sufficient number of free flex entitlements.
Parameters
  • string sessionKey
  • int orgId
  • string label - Software entitlement label.
  • int allocation
Return Value
  • int - 1 on success, exception thrown otherwise.

23.32. setSystemEntitlements

Name
setSystemEntitlements
Description
Set an organization's entitlement allocation for the given software entitlement. If increasing the entitlement allocation, the default organization (i.e. orgId=1) must have a sufficient number of free entitlements.
Parameters
  • string sessionKey
  • int orgId
  • string label - System entitlement label. Valid values include:
    • enterprise_entitled
    • provisioning_entitled
    • virtualization_host
    • virtualization_host_platform
  • int allocation
Return Value
  • int - 1 on success, exception thrown otherwise.

23.33. updateName

Name
updateName
Description
Updates the name of an organization
Parameters
  • string sessionKey
  • int orgId
  • string name - Organization name. Must meet same criteria as in the web UI.
Return Value
  • struct - organization info
    • int id
    • string name
    • int active_users - Number of active users in the organization.
    • int systems - Number of systems in the organization.
    • int trusts - Number of trusted organizations.
    • int system_groups - Number of system groups in the organization. (optional)
    • int activation_keys - Number of activation keys in the organization. (optional)
    • int kickstart_profiles - Number of kickstart profiles in the organization. (optional)
    • int configuration_channels - Number of configuration channels in the organization. (optional)
    • boolean staging_content_enabled - Is staging content enabled in organization. (optional)

Chapter 24. org.trusts

Abstract

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

24.1. addTrust

Name
addTrust
Description
Add an organization to the list of trusted organizations.
Parameters
  • string sessionKey
  • int orgId
  • int trustOrgId
Return Value
  • int - 1 on success, exception thrown otherwise.

24.2. getDetails

Name
getDetails
Description
The trust details about an organization given the organization's ID.
Parameters
  • string sessionKey
  • int trustOrgId - Id of the trusted organization
Return Value
  • struct - org trust details
    • dateTime.iso8601 created - Date the organization was created
    • dateTime.iso8601 trusted_since - Date the organization was defined as trusted
    • int channels_provided - Number of channels provided by the organization.
    • int channels_consumed - Number of channels consumed by the organization.
    • int systems_migrated_to - Number of systems migrated to the organization.
    • int systems_migrated_from - Number of systems migrated from the organization.

24.3. listChannelsConsumed

Name
listChannelsConsumed
Description
Lists all software channels that the organization given may consume from the user's organization.
Parameters
  • string sessionKey
  • int trustOrgId - Id of the trusted organization
Return Value
  • array:
    • struct - channel info
      • int channel_id
      • string channel_name
      • int packages
      • int systems

24.4. listChannelsProvided

Name
listChannelsProvided
Description
Lists all software channels that the organization given is providing to the user's organization.
Parameters
  • string sessionKey
  • int trustOrgId - Id of the trusted organization
Return Value
  • array:
    • struct - channel info
      • int channel_id
      • string channel_name
      • int packages
      • int systems

24.5. listOrgs

Name
listOrgs
Description
List all organanizations trusted by the user's organization.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - trusted organizations
      • int org_id
      • string org_name
      • int shared_channels

24.6. listSystemsAffected

Name
listSystemsAffected
Description
Get a list of systems within the trusted organization that would be affected if the trust relationship was removed. This basically lists systems that are sharing at least (1) package.
Parameters
  • string sessionKey
  • int orgId
  • string trustOrgId
Return Value
  • array:
    • struct - affected systems
      • int systemId
      • string systemName

24.7. listTrusts

Name
listTrusts
Description
Returns the list of trusted organizations.
Parameters
  • string sessionKey
  • int orgId
Return Value
  • array:
    • struct - trusted organizations
      • int orgId
      • string orgName
      • bool trustEnabled

24.8. removeTrust

Name
removeTrust
Description
Remove an organization to the list of trusted organizations.
Parameters
  • string sessionKey
  • int orgId
  • int trustOrgId
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 25. packages

Abstract

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

25.1. findByNvrea

Name
findByNvrea
Description
Lookup the details for packages with the given name, version, release, architecture label, and (optionally) epoch.
Parameters
  • string sessionKey
  • string name
  • string version
  • string release
  • string epoch - If set to something other than empty string, strict matching will be used and the epoch string must be correct. If set to an empty string, if the epoch is null or there is only one NVRA combination, it will be returned. (Empty string is recommended.)
  • string archLabel
Return Value
  • 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

25.2. getDetails

Name
getDetails
Description
Retrieve details for the package with the ID.
Parameters
  • string sessionKey
  • int packageId
Return Value
  • struct - package
    • int id
    • string name
    • string epoch
    • string version
    • string release
    • string arch_label
    • array providing_channels
      • string - Channel label providing this package.
    • string build_host
    • string description
    • string checksum
    • string checksum_type
    • string vendor
    • string summary
    • string cookie
    • string license
    • string file
    • string build_date
    • string last_modified_date
    • string size
    • string path - The path on the Satellite's file system that the package resides.
    • string payload_size

25.3. getPackage

Name
getPackage
Description
Retrieve the package file associated with a package. (Consider using packages.getPackageUrl for larger files.)
Parameters
  • string sessionKey
  • int package_id
Return Value
  • binary object - package file

25.4. getPackageUrl

Name
getPackageUrl
Description
Retrieve the url that can be used to download a package. This will expire after a certain time period.
Parameters
  • string sessionKey
  • int package_id
Return Value
  • string - the download url

25.5. listChangelog

Name
listChangelog
Description
List the change log for a package.
Parameters
  • string sessionKey
  • int packageId
Return Value
  • string

25.6. listDependencies

Name
listDependencies
Description
List the dependencies for a package.
Parameters
  • string sessionKey
  • int packageId
Return Value
  • array:
    • struct - dependency
      • string dependency
      • string dependency_type - One of the following:
        • requires
        • conflicts
        • obsoletes
        • provides
        • recommends
        • suggests
        • supplements
        • enhances
      • string dependency_modifier

25.7. listFiles

Name
listFiles
Description
List the files associated with a package.
Parameters
  • string sessionKey
  • int packageId
Return Value
  • array:
    • struct - file info
      • string path
      • string type
      • string last_modified_date
      • string checksum
      • string checksum_type
      • int size
      • string linkto

25.8. listProvidingChannels

Name
listProvidingChannels
Description
List the channels that provide the a package.
Parameters
  • string sessionKey
  • int packageId
Return Value
  • array:
    • struct - channel
      • string label
      • string parent_label
      • string name

25.9. listProvidingErrata

Name
listProvidingErrata
Description
List the errata providing the a package.
Parameters
  • string sessionKey
  • int packageId
Return Value
  • array:
    • struct - errata
      • string advisory
      • string issue_date
      • string last_modified_date
      • string update_date
      • string synopsis
      • string type

25.10. listSourcePackages

Name
listSourcePackages
Description
List all source packages in user's organization.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - source_package
      • int id
      • string name

25.11. removePackage

Name
removePackage
Description
Remove a package from the satellite.
Parameters
  • string sessionKey
  • int packageId
Return Value
  • int - 1 on success, exception thrown otherwise.

25.12. removeSourcePackage

Name
removeSourcePackage
Description
Remove a source package.
Parameters
  • string sessionKey
  • int packageSourceId
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 26. packages.provider

Abstract

Methods to retrieve information about Package Providers associated with packages.

26.1. associateKey

Name
associateKey
Description
Associate a package security key and with the package provider. If the provider or key doesn't exist, it is created. User executing the request must be a Satellite administrator.
Parameters
  • string sessionKey
  • string providerName - The provider name
  • string key - The actual key
  • string type - The type of the key. Currently, only 'gpg' is supported
Return Value
  • int - 1 on success, exception thrown otherwise.

26.2. list

Name
list
Description
List all Package Providers. User executing the request must be a Satellite administrator.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - package provider
      • string name
      • array keys
        • struct - package security key
          • string key
          • string type

26.3. listKeys

Name
listKeys
Description
List all security keys associated with a package provider. User executing the request must be a Satellite administrator.
Parameters
  • string sessionKey
  • string providerName - The provider name
Return Value
  • array:
    • struct - package security key
      • string key
      • string type

Chapter 27. packages.search

Abstract

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

27.1. advanced

Name
advanced
Description
Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax. Lucene Query Parser syntax is defined at lucene.apache.org. Fields searchable for Packages: name, epoch, version, release, arch, description, summary Lucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"
Parameters
  • string sessionKey
  • string luceneQuery - a query written in the form of Lucene QueryParser Syntax
Return Value
  • array:
    • struct - package overview
      • int id
      • string name
      • string summary
      • string description
      • string version
      • string release
      • string arch
      • string epoch
      • string provider

27.2. advancedWithActKey

Name
advancedWithActKey
Description
Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax, additionally this method will limit results to those which are associated with a given activation key. Lucene Query Parser syntax is defined at lucene.apache.org. Fields searchable for Packages: name, epoch, version, release, arch, description, summary Lucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"
Parameters
  • string sessionKey
  • string luceneQuery - a query written in the form of Lucene QueryParser Syntax
  • string actKey - activation key to look for packages in
Return Value
  • array:
    • struct - package overview
      • int id
      • string name
      • string summary
      • string description
      • string version
      • string release
      • string arch
      • string epoch
      • string provider

27.3. advancedWithChannel

Name
advancedWithChannel
Description
Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax, additionally this method will limit results to those which are in the passed in channel label. Lucene Query Parser syntax is defined at lucene.apache.org. Fields searchable for Packages: name, epoch, version, release, arch, description, summary Lucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"
Parameters
  • string sessionKey
  • string luceneQuery - a query written in the form of Lucene QueryParser Syntax
  • string channelLabel - Channel Label
Return Value
  • array:
    • struct - package overview
      • int id
      • string name
      • string summary
      • string description
      • string version
      • string release
      • string arch
      • string epoch
      • string provider

27.4. name

Name
name
Description
Search the lucene package indexes for all packages which match the given name.
Parameters
  • string sessionKey
  • string name - package name to search for
Return Value
  • array:
    • struct - package overview
      • int id
      • string name
      • string summary
      • string description
      • string version
      • string release
      • string arch
      • string epoch
      • string provider

27.5. nameAndDescription

Name
nameAndDescription
Description
Search the lucene package indexes for all packages which match the given query in name or description
Parameters
  • string sessionKey
  • string query - text to match in package name or description
Return Value
  • array:
    • struct - package overview
      • int id
      • string name
      • string summary
      • string description
      • string version
      • string release
      • string arch
      • string epoch
      • string provider

27.6. nameAndSummary

Name
nameAndSummary
Description
Search the lucene package indexes for all packages which match the given query in name or summary.
Parameters
  • string sessionKey
  • string query - text to match in package name or summary
Return Value
  • array:
    • struct - package overview
      • int id
      • string name
      • string summary
      • string description
      • string version
      • string release
      • string arch
      • string epoch
      • string provider

Chapter 28. preferences.locale

Abstract

Provides methods to access and modify user locale information

28.1. listLocales

Name
listLocales
Description
Returns a list of all understood locales. Can be used as input to setLocale.
Parameters
  • None
Return Value
  • array:
    • string - Locale code.

28.2. listTimeZones

Name
listTimeZones
Description
Returns a list of all understood timezones. Results can be used as input to setTimeZone.
Parameters
  • None
Return Value
  • array:
    • struct - timezone
      • int time_zone_id - Unique identifier for timezone.
      • string olson_name - Name as identified by the Olson database.

28.3. setLocale

Name
setLocale
Description
Set a user's locale.
Parameters
  • string sessionKey
  • string login - User's login name.
  • string locale - Locale to set. (from listLocales)
Return Value
  • int - 1 on success, exception thrown otherwise.

28.4. setTimeZone

Name
setTimeZone
Description
Set a user's timezone.
Parameters
  • string sessionKey
  • string login - User's login name.
  • int tzid - Timezone ID. (from listTimeZones)
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 29. proxy

Abstract

Provides methods to activate/deactivate a proxy server.

29.1. activateProxy

Name
activateProxy
Description
Activates the proxy identified by the given client certificate i.e. systemid file.
Parameters
  • string systemid - systemid file
  • string version - Version of proxy to be registered.
Return Value
  • int - 1 on success, exception thrown otherwise.

29.2. createMonitoringScout

Name
createMonitoringScout
Description
Create Monitoring Scout for proxy.
Available since: 10.7
Parameters
  • string systemid - systemid file
Return Value
  • string

29.3. deactivateProxy

Name
deactivateProxy
Description
Deactivates the proxy identified by the given client certificate i.e. systemid file.
Parameters
  • string systemid - systemid file
Return Value
  • int - 1 on success, exception thrown otherwise.

29.4. isProxy

Name
isProxy
Description
Test, if the system identified by the given client certificate i.e. systemid file, is proxy.
Parameters
  • string systemid - systemid file
Return Value
  • int - 1 on success, exception thrown otherwise.

29.5. listAvailableProxyChannels

Name
listAvailableProxyChannels
Description
List available version of proxy channel for system identified by the given client certificate i.e. systemid file.
Available since: 10.5
Parameters
  • string systemid - systemid file
Return Value
  • array:
    • string - version

Chapter 30. satellite

Abstract

Provides methods to obtain details on the Satellite.

30.1. getCertificateExpirationDate

Name
getCertificateExpirationDate
Description
Retrieves the certificate expiration date of the activated certificate.
Parameters
  • string sessionKey
Return Value
  • dateTime.iso8601

30.2. isMonitoringEnabled

Name
isMonitoringEnabled
Description
Indicates if monitoring is enabled on the satellite
Parameters
  • string sessionKey
Return Value
  • boolean True if monitoring is enabled

30.3. isMonitoringEnabledBySystemId

Name
isMonitoringEnabledBySystemId
Description
Indicates if monitoring is enabled on the satellite
Parameters
  • string systemid - systemid file
Return Value
  • boolean True if monitoring is enabled

30.4. listEntitlements

Name
listEntitlements
Description
Lists all channel and system entitlements for the organization associated with the user executing the request.
Parameters
  • string sessionKey
Return Value
  • struct - channel/system entitlements
    • array system
      • struct - system entitlement
        • string label
        • string name
        • int used_slots
        • int free_slots
        • int total_slots
    • array channel
      • struct - channel entitlement
        • string label
        • string name
        • int used_slots
        • int free_slots
        • int total_slots
        • int used_flex
        • int free_flex
        • int total_flex

30.5. listProxies

Name
listProxies
Description
List the proxies within the user's organization.
Parameters
  • string sessionKey
Return Value
  • 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

Chapter 31. schedule

Abstract

Methods to retrieve information about scheduled actions.

31.1. archiveActions

Name
archiveActions
Description
Archive all actions in the given list.
Parameters
  • string sessionKey
  • array:
    • int - action id
Return Value
  • int - 1 on success, exception thrown otherwise.

31.2. cancelActions

Name
cancelActions
Description
Cancel all actions in given list. If an invalid action is provided, none of the actions given will canceled.
Parameters
  • string sessionKey
  • array:
    • int - action id
Return Value
  • int - 1 on success, exception thrown otherwise.

31.3. deleteActions

Name
deleteActions
Description
Delete all archived actions in the given list.
Parameters
  • string sessionKey
  • array:
    • int - action id
Return Value
  • int - 1 on success, exception thrown otherwise.

31.4. failSystemAction

Name
failSystemAction
Description
Fail specific event on specified system
Parameters
  • string sessionKey
  • int serverId
  • int actionId
Return Value
  • int - 1 on success, exception thrown otherwise.

31.5. failSystemAction

Name
failSystemAction
Description
Fail specific event on specified system
Parameters
  • string sessionKey
  • int serverId
  • int actionId
  • string message
Return Value
  • int - 1 on success, exception thrown otherwise.

31.6. listAllActions

Name
listAllActions
Description
Returns a list of all actions. This includes completed, in progress, failed and archived actions.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - action
      • int id - Action Id.
      • string name - Action name.
      • string type - Action type.
      • string scheduler - The user that scheduled the action. (optional)
      • dateTime.iso8601 earliest - The earliest date and time the action will be performed
      • int completedSystems - Number of systems that completed the action.
      • int failedSystems - Number of systems that failed the action.
      • int inProgressSystems - Number of systems that are in progress.

31.7. listArchivedActions

Name
listArchivedActions
Description
Returns a list of actions that have been archived.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - action
      • int id - Action Id.
      • string name - Action name.
      • string type - Action type.
      • string scheduler - The user that scheduled the action. (optional)
      • dateTime.iso8601 earliest - The earliest date and time the action will be performed
      • int completedSystems - Number of systems that completed the action.
      • int failedSystems - Number of systems that failed the action.
      • int inProgressSystems - Number of systems that are in progress.

31.8. listCompletedActions

Name
listCompletedActions
Description
Returns a list of actions that have completed successfully.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - action
      • int id - Action Id.
      • string name - Action name.
      • string type - Action type.
      • string scheduler - The user that scheduled the action. (optional)
      • dateTime.iso8601 earliest - The earliest date and time the action will be performed
      • int completedSystems - Number of systems that completed the action.
      • int failedSystems - Number of systems that failed the action.
      • int inProgressSystems - Number of systems that are in progress.

31.9. listCompletedSystems

Name
listCompletedSystems
Description
Returns a list of systems that have completed a specific action.
Parameters
  • string sessionKey
  • string actionId
Return Value
  • array:
    • struct - system
      • int server_id
      • string server_name - Server name.
      • string base_channel - Base channel used by the server.
      • dateTime.iso8601 timestamp - The time the action was completed
      • string message - Optional message containing details on the execution of the action. For example, if the action failed, this will contain the failure text.

31.10. listFailedActions

Name
listFailedActions
Description
Returns a list of actions that have failed.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - action
      • int id - Action Id.
      • string name - Action name.
      • string type - Action type.
      • string scheduler - The user that scheduled the action. (optional)
      • dateTime.iso8601 earliest - The earliest date and time the action will be performed
      • int completedSystems - Number of systems that completed the action.
      • int failedSystems - Number of systems that failed the action.
      • int inProgressSystems - Number of systems that are in progress.

31.11. listFailedSystems

Name
listFailedSystems
Description
Returns a list of systems that have failed a specific action.
Parameters
  • string sessionKey
  • string actionId
Return Value
  • array:
    • struct - system
      • int server_id
      • string server_name - Server name.
      • string base_channel - Base channel used by the server.
      • dateTime.iso8601 timestamp - The time the action was completed
      • string message - Optional message containing details on the execution of the action. For example, if the action failed, this will contain the failure text.

31.12. listInProgressActions

Name
listInProgressActions
Description
Returns a list of actions that are in progress.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - action
      • int id - Action Id.
      • string name - Action name.
      • string type - Action type.
      • string scheduler - The user that scheduled the action. (optional)
      • dateTime.iso8601 earliest - The earliest date and time the action will be performed
      • int completedSystems - Number of systems that completed the action.
      • int failedSystems - Number of systems that failed the action.
      • int inProgressSystems - Number of systems that are in progress.

31.13. listInProgressSystems

Name
listInProgressSystems
Description
Returns a list of systems that have a specific action in progress.
Parameters
  • string sessionKey
  • string actionId
Return Value
  • array:
    • struct - system
      • int server_id
      • string server_name - Server name.
      • string base_channel - Base channel used by the server.
      • dateTime.iso8601 timestamp - The time the action was completed
      • string message - Optional message containing details on the execution of the action. For example, if the action failed, this will contain the failure text.

31.14. rescheduleActions

Name
rescheduleActions
Description
Reschedule all actions in the given list.
Parameters
  • string sessionKey
  • array:
    • int - action id
  • boolean onlyFailed - True to only reschedule failed actions, False to reschedule all
Return Value
  • int - 1 on success, exception thrown otherwise.

Chapter 32. sync.master

Abstract

Contains methods to set up information about known-"masters", for use on the "slave" side of ISS

32.1. addToMaster

Name
addToMaster
Description
Add a single organizations to the list of those the specified Master has exported to this Slave
Parameters
  • string sessionKey
  • int id - Id of the desired Master
  • struct - master-org details
    • int masterOrgId
    • string masterOrgName
    • int localOrgId
Return Value
  • int - 1 on success, exception thrown otherwise.

32.2. create

Name
create
Description
Create a new Master, known to this Slave.
Parameters
  • string sessionKey
  • string label - Master's fully-qualified domain name
Return Value
  • struct - IssMaster info
    • int id
    • string label
    • string caCert
    • boolean isCurrentMaster

32.3. delete

Name
delete
Description
Remove the specified Master
Parameters
  • string sessionKey
  • int id - Id of the Master to remove
Return Value
  • int - 1 on success, exception thrown otherwise.

32.4. getDefaultMaster

Name
getDefaultMaster
Description
Return the current default-Master for this Slave
Parameters
  • string sessionKey
Return Value
  • struct - IssMaster info
    • int id
    • string label
    • string caCert
    • boolean isCurrentMaster

32.5. getMaster

Name
getMaster
Description
Find a Master by specifying its ID
Parameters
  • string sessionKey
  • int id - Id of the desired Master
Return Value
  • struct - IssMaster info
    • int id
    • string label
    • string caCert
    • boolean isCurrentMaster

32.6. getMasterByLabel

Name
getMasterByLabel
Description
Find a Master by specifying its label
Parameters
  • string sessionKey
  • string label - Label of the desired Master
Return Value
  • struct - IssMaster info
    • int id
    • string label
    • string caCert
    • boolean isCurrentMaster

32.7. getMasterOrgs

Name
getMasterOrgs
Description
List all organizations the specified Master has exported to this Slave
Parameters
  • string sessionKey
  • int id - Id of the desired Master
Return Value
  • array:
    • struct - IssMasterOrg info
      • int masterOrgId
      • string masterOrgName
      • int localOrgId

32.8. getMasters

Name
getMasters
Description
Get all the Masters this Slave knows about
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - IssMaster info
      • int id
      • string label
      • string caCert
      • boolean isCurrentMaster

32.9. makeDefault

Name
makeDefault
Description
Make the specified Master the default for this Slave's satellite-sync
Parameters
  • string sessionKey
  • int id - Id of the Master to make the default
Return Value
  • int - 1 on success, exception thrown otherwise.

32.10. mapToLocal

Name
mapToLocal
Description
Add a single organizations to the list of those the specified Master has exported to this Slave
Parameters
  • string sessionKey
  • int masterId - Id of the desired Master
  • int masterOrgId - Id of the desired Master
  • int localOrgId - Id of the desired Master
Return Value
  • int - 1 on success, exception thrown otherwise.

32.11. setCaCert

Name
setCaCert
Description
Set the CA-CERT filename for specified Master on this Slave
Parameters
  • string sessionKey
  • int id - Id of the Master to affect
  • string caCertFilename - path to specified Master's CA cert
Return Value
  • int - 1 on success, exception thrown otherwise.

32.12. setMasterOrgs

Name
setMasterOrgs
Description
Reset all organizations the specified Master has exported to this Slave
Parameters
  • string sessionKey
  • int id - Id of the desired Master
  • array:
    • struct - master-org details
      • int masterOrgId
      • string masterOrgName
      • int localOrgId
Return Value
  • int - 1 on success, exception thrown otherwise.

32.13. unsetDefaultMaster

Name
unsetDefaultMaster
Description
Make this slave have no default Master for satellite-sync
Parameters
  • string sessionKey
Return Value
  • int - 1 on success, exception thrown otherwise.

32.14. update

Name
update
Description
Updates the label of the specified Master
Parameters
  • string sessionKey
  • int id - Id of the Master to update
  • string label - Desired new label
Return Value
  • struct - IssMaster info
    • int id
    • string label
    • string caCert
    • boolean isCurrentMaster

Chapter 33. sync.slave

Abstract

Contains methods to set up information about allowed-"slaves", for use on the "master" side of ISS

33.1. create

Name
create
Description
Create a new Slave, known to this Master.
Parameters
  • string sessionKey
  • string slave - Slave's fully-qualified domain name
  • boolean enabled - Let this slave talk to us?
  • boolean allowAllOrgs - Export all our orgs to this slave?
Return Value
  • struct - IssSlave info
    • int id
    • string slave
    • boolean enabled
    • boolean allowAllOrgs

33.2. delete

Name
delete
Description
Remove the specified Slave
Parameters
  • string sessionKey
  • int id - Id of the Slave to remove
Return Value
  • int - 1 on success, exception thrown otherwise.

33.3. getAllowedOrgs

Name
getAllowedOrgs
Description
Get all orgs this Master is willing to export to the specified Slave
Parameters
  • string sessionKey
  • int id - Id of the desired Slave
Return Value
  • array:
    • int - ids of allowed organizations

33.4. getSlave

Name
getSlave
Description
Find a Slave by specifying its ID
Parameters
  • string sessionKey
  • int id - Id of the desired Slave
Return Value
  • struct - IssSlave info
    • int id
    • string slave
    • boolean enabled
    • boolean allowAllOrgs

33.5. getSlaveByName

Name
getSlaveByName
Description
Find a Slave by specifying its Fully-Qualified Domain Name
Parameters
  • string sessionKey
  • string fqdn - Domain-name of the desired Slave
Return Value
  • struct - IssSlave info
    • int id
    • string slave
    • boolean enabled
    • boolean allowAllOrgs

33.6. getSlaves

Name
getSlaves
Description
Get all the Slaves this Master knows about
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - IssSlave info
      • int id
      • string slave
      • boolean enabled
      • boolean allowAllOrgs

33.7. setAllowedOrgs

Name
setAllowedOrgs
Description
Set the orgs this Master is willing to export to the specified Slave
Parameters
  • string sessionKey
  • int id - Id of the desired Slave
  • array:
    • int - List of org-ids we're willing to export
Return Value
  • int - 1 on success, exception thrown otherwise.

33.8. update

Name
update
Description
Updates attributes of the specified Slave
Parameters
  • string sessionKey
  • int id - Id of the Slave to update
  • string slave - Slave's fully-qualified domain name
  • boolean enabled - Let this slave talk to us?
  • boolean allowAllOrgs - Export all our orgs to this Slave?
Return Value
  • struct - IssSlave info
    • int id
    • string slave
    • boolean enabled
    • boolean allowAllOrgs

Chapter 34. system

Abstract

Provides methods to access and modify registered system.

34.1. addEntitlements

Name
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: provisioning_entitled, virtualization_host, virtualization_host_platform, enterprise_entitled
Return Value
  • int - 1 on success, exception thrown otherwise.

34.2. addNote

Name
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.
Return Value
  • int - 1 on success, exception thrown otherwise.

34.3. applyErrata

Name
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
Return Value
  • int - 1 on success, exception thrown otherwise.

34.4. comparePackageProfile

Name
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
Return Value
  • 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.

34.5. comparePackages

Name
comparePackages
Description
Compares the packages installed on two systems.
Parameters
  • string sessionKey
  • int thisServerId
  • int otherServerId
Return Value
  • 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.

34.6. convertToFlexEntitlement

Name
convertToFlexEntitlement
Description
Converts the given list of systems for a given channel family to use the flex entitlement.
Parameters
  • string sessionKey
  • array:
    • int - serverId
  • string channelFamilyLabel
Return Value
  • int - the total the number of systems that were converted to use flex entitlement.

34.7. createPackageProfile

Name
createPackageProfile
Description
Create a new stored Package Profile from a systems installed package list.
Parameters
  • string sessionKey
  • int serverId
  • string profileLabel
  • string description
Return Value
  • int - 1 on success, exception thrown otherwise.

34.8. createSystemRecord

Name
createSystemRecord
Description
Creates a cobbler system record with the specified kickstart label
Parameters
  • string sessionKey
  • int serverId
  • string ksLabel
Return Value
  • int - 1 on success, exception thrown otherwise.

34.9. deleteCustomValues

Name
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
Return Value
  • 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.

34.10. deleteGuestProfiles

Name
deleteGuestProfiles
Description
Delete the specified list of guest profiles for a given host
Parameters
  • string sessionKey
  • int hostId
  • array:
    • string - guestNames
Return Value
  • int - 1 on success, exception thrown otherwise.

34.11. deleteNote

Name
deleteNote
Description
Deletes the given note from the server.
Parameters
  • string sessionKey
  • int serverId
  • int noteId
Return Value
  • int - 1 on success, exception thrown otherwise.

34.12. deleteNotes

Name
deleteNotes
Description
Deletes all notes from the server.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • int - 1 on success, exception thrown otherwise.

34.13. deletePackageProfile

Name
deletePackageProfile
Description
Delete a package profile
Parameters
  • string sessionKey
  • int profileId
Return Value
  • int - 1 on success, exception thrown otherwise.

34.14. deleteSystem

Name
deleteSystem
Description
Delete a system given its client certificate.
Available since: 10.10
Parameters
  • string systemid - systemid file
Return Value
  • int - 1 on success, exception thrown otherwise.

34.15. deleteSystem

Name
deleteSystem
Description
Delete a system given its server id synchronously
Parameters
  • string sessionKey
  • int serverId
Return Value
  • int - 1 on success, exception thrown otherwise.

34.16. deleteSystems

Name
deleteSystems
Description
Delete systems given a list of system ids asynchronously.
Parameters
  • string sessionKey
  • array:
    • int - serverId
Return Value
  • int - 1 on success, exception thrown otherwise.

34.17. deleteTagFromSnapshot

Name
deleteTagFromSnapshot
Description
Deletes tag from system snapshot
Parameters
  • string sessionKey
  • int serverId
  • string tagName
Return Value
  • int - 1 on success, exception thrown otherwise.

34.18. downloadSystemId

Name
downloadSystemId
Description
Get the system ID file for a given server.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • string

34.19. getConnectionPath

Name
getConnectionPath
Description
Get the list of proxies that the given system connects through in order to reach the server.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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

34.20. getCpu

Name
getCpu
Description
Gets the CPU information of a system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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)

34.21. getCustomValues

Name
getCustomValues
Description
Get the custom data values defined for the server.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • struct - custom value
    • string custom info label

34.22. getDetails

Name
getDetails
Description
Get system details.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • struct - server details
    • int id - System id
    • string profile_name
    • string base_entitlement - System's base entitlement label. (enterprise_entitled or sw_mgr_entitled)
    • array string
      • addon_entitlements - System's addon entitlements labels, including provisioning_entitled, virtualization_host, virtualization_host_platform
    • 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)

34.23. getDevices

Name
getDevices
Description
Gets a list of devices for a system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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

34.24. getDmi

Name
getDmi
Description
Gets the DMI information of a system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • struct - DMI
    • string vendor
    • string system
    • string product
    • string asset
    • string board
    • string bios_release - (optional)
    • string bios_vendor - (optional)
    • string bios_version - (optional)

34.25. getEntitlements

Name
getEntitlements
Description
Gets the entitlements for a given server.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • array:
    • string - entitlement_label

34.26. getEventHistory

Name
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
Return Value
  • 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

34.27. getId

Name
getId
Description
Get system IDs and last check in information for the given system name.
Parameters
  • string sessionKey
  • string systemName
Return Value
  • 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

34.28. getMemory

Name
getMemory
Description
Gets the memory information for a system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • struct - memory
    • int ram - The amount of physical memory in MB.
    • int swap - The amount of swap space in MB.

34.29. getName

Name
getName
Description
Get system name and last check in information for the given system ID.
Parameters
  • string sessionKey
  • string serverId
Return Value
  • struct - name info
    • int id - Server id
    • string name - Server name
    • dateTime.iso8601 last_checkin - Last time server successfully checked in

34.30. getNetwork

Name
getNetwork
Description
Get the addresses and hostname for a given server.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • struct - network info
    • string ip - IPv4 address of server
    • string ip6 - IPv6 address of server
    • string hostname - Hostname of server

34.31. getNetworkDevices

Name
getNetworkDevices
Description
Returns the network devices for the given server.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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

34.32. getOsaPing

Name
getOsaPing
Description
get details about a ping sent to a system using OSA
Parameters
  • User loggedInUser
  • int serverId
Return Value
  • 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

34.33. getRegistrationDate

Name
getRegistrationDate
Description
Returns the date the system was registered.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • dateTime.iso8601 - The date the system was registered, in local time.

34.34. getRelevantErrata

Name
getRelevantErrata
Description
Returns a list of all errata that are relevant to the system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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

34.35. getRelevantErrataByType

Name
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'
Return Value
  • 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

34.36. getRunningKernel

Name
getRunningKernel
Description
Returns the running kernel of the given system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • string

34.37. getScriptActionDetails

Name
getScriptActionDetails
Description
Returns script details for script run actions
Parameters
  • string sessionKey
  • int actionId - ID of the script run action.
Return Value
  • 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

34.38. getScriptResults

Name
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.
Return Value
  • 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

34.39. getSubscribedBaseChannel

Name
getSubscribedBaseChannel
Description
Provides the base channel of a given system
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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

34.40. getSystemCurrencyMultipliers

Name
getSystemCurrencyMultipliers
Description
Get the System Currency score multipliers
Parameters
  • string sessionKey
Return Value
  • Map of score multipliers

34.41. getSystemCurrencyScores

Name
getSystemCurrencyScores
Description
Get the System Currency scores for all servers the user has access to
Parameters
  • string sessionKey
Return Value
  • 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

34.42. getUnscheduledErrata

Name
getUnscheduledErrata
Description
Provides an array of errata that are applicable to a given system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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.

34.43. getUuid

Name
getUuid
Description
Get the UUID from the given system ID.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • string

34.44. getVariables

Name
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
Return Value
  • struct - System kickstart variables
    • boolean netboot - netboot enabled
    • array kickstart variables
      • struct - kickstart variable
        • string key
        • string or int value

34.45. isNvreInstalled

Name
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.
Return Value
  • 1 if package exists, 0 if not, exception is thrown if an error occurs

34.46. isNvreInstalled

Name
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.
Return Value
  • 1 if package exists, 0 if not, exception is thrown if an error occurs

34.47. listActivationKeys

Name
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
Return Value
  • array:
    • string - key

34.48. listActiveSystems

Name
listActiveSystems
Description
Returns a list of active servers visible to the user.
Parameters
  • string sessionKey
Return Value
  • 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

34.49. listActiveSystemsDetails

Name
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
Return Value
  • 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.

34.50. listAdministrators

Name
listAdministrators
Description
Returns a list of users which can administer the system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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

34.51. listAllInstallablePackages

Name
listAllInstallablePackages
Description
Get the list of all installable packages for a given system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • struct - package
    • string name
    • string version
    • string release
    • string epoch
    • int id
    • string arch_label

34.52. listBaseChannels

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

34.53. listChildChannels

Name
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
Return Value
  • array:
    • struct - child channel
      • int id
      • string name
      • string label
      • string summary
      • string has_license
      • string gpg_key_url

34.54. listDuplicatesByHostname

Name
listDuplicatesByHostname
Description
List duplicate systems by Hostname.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - Duplicate Group
      • string hostname
      • array systems
        • struct - system
          • int systemId
          • string systemName
          • dateTime.iso8601 last_checkin - Last time server successfully checked in

34.55. listDuplicatesByIp

Name
listDuplicatesByIp
Description
List duplicate systems by IP Address.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - Duplicate Group
      • string ip
      • array systems
        • struct - system
          • int systemId
          • string systemName
          • dateTime.iso8601 last_checkin - Last time server successfully checked in

34.56. listDuplicatesByMac

Name
listDuplicatesByMac
Description
List duplicate systems by Mac Address.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - Duplicate Group
      • string mac
      • array systems
        • struct - system
          • int systemId
          • string systemName
          • dateTime.iso8601 last_checkin - Last time server successfully checked in

34.57. listEligibleFlexGuests

Name
listEligibleFlexGuests
Description
List eligible flex guests accessible to the user
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - channel family system group
      • int id
      • string label
      • string name
      • array:
        • int - systems

34.58. listExtraPackages

Name
listExtraPackages
Description
List extra packages for a system
Parameters
  • string sessionKey
  • int serverId
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch - returned only if non-zero
      • string arch
      • date installtime - returned only if known

34.59. listFlexGuests

Name
listFlexGuests
Description
List flex guests accessible to the user
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - channel family system group
      • int id
      • string label
      • string name
      • array:
        • int - systems

34.60. listGroups

Name
listGroups
Description
List the available groups for a given system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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)

34.61. listInactiveSystems

Name
listInactiveSystems
Description
Lists systems that have been inactive for the default period of inactivity
Parameters
  • string sessionKey
Return Value
  • 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

34.62. listInactiveSystems

Name
listInactiveSystems
Description
Lists systems that have been inactive for the specified number of days..
Parameters
  • string sessionKey
  • int days
Return Value
  • 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

34.63. listLatestAvailablePackage

Name
listLatestAvailablePackage
Description
Get the latest available version of a package for each system
Parameters
  • string sessionKey
  • array:
    • int - serverId
  • string packageName
Return Value
  • 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

34.64. listLatestInstallablePackages

Name
listLatestInstallablePackages
Description
Get the list of latest installable packages for a given system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch
      • int id
      • string arch_label

34.65. listLatestUpgradablePackages

Name
listLatestUpgradablePackages
Description
Get the list of latest upgradable packages for a given system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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

34.66. listNewerInstalledPackages

Name
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.
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch

34.67. listNotes

Name
listNotes
Description
Provides a list of notes associated with a system.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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

34.68. listOlderInstalledPackages

Name
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.
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch

34.69. listOutOfDateSystems

Name
listOutOfDateSystems
Description
Returns list of systems needing package updates.
Parameters
  • string sessionKey
Return Value
  • 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

34.70. listPackageProfiles

Name
listPackageProfiles
Description
List the package profiles in this organization
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - package profile
      • int id
      • string name
      • string channel

34.71. listPackages

Name
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
Return Value
  • array:
    • struct - package
      • string name
      • string version
      • string release
      • string epoch
      • string arch
      • date installtime - returned only if known

34.72. listPackagesFromChannel

Name
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
Return Value
  • 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

34.73. listPhysicalSystems

Name
listPhysicalSystems
Description
Returns a list of all Physical servers visible to the user.
Parameters
  • string sessionKey
Return Value
  • 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

34.74. listSubscribableBaseChannels

Name
listSubscribableBaseChannels
Description
Returns a list of subscribable base channels.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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

34.75. listSubscribableChildChannels

Name
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
Return Value
  • array:
    • struct - child channel
      • int id
      • string name
      • string label
      • string summary
      • string has_license
      • string gpg_key_url

34.76. listSubscribedChildChannels

Name
listSubscribedChildChannels
Description
Returns a list of subscribed child channels.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • 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

34.77. listSuggestedReboot

Name
listSuggestedReboot
Description
List systems that require reboot.
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - system
      • int id
      • string name

34.78. listSystemEvents

Name
listSystemEvents
Description
List system events of the specified type for given server. "actionType" should be exactly the string returned in the action_type field from the listSystemEvents(sessionKey, serverId) method. For example, 'Package Install' or 'Initiate a kickstart for a virtual guest.'
Available since: 10.8
Parameters
  • string sessionKey
  • int serverId - ID of system.
  • string actionType - Type of the action.
Return Value
  • 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.

34.79. listSystemEvents

Name
listSystemEvents
Description
List all system events for given server. This includes *all* events for the server since it was registered. This may require the caller to filter the results to fetch the specific events they are looking for.
Available since: 10.8
Parameters
  • string sessionKey
  • int serverId - ID of system.
Return Value
  • 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.

34.80. listSystems

Name
listSystems
Description
Returns a list of all servers visible to the user.
Parameters
  • string sessionKey
Return Value
  • 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

34.81. listSystemsWithExtraPackages

Name
listSystemsWithExtraPackages
Description
List systems with extra packages
Parameters
  • string sessionKey
Return Value
  • array:
    • struct - system
      • int id - System ID
      • string name - System profile name
      • int extra_pkg_count - Extra packages count

34.82. listSystemsWithPackage

Name
listSystemsWithPackage
Description
Lists the systems that have the given installed package
Parameters
  • string sessionKey
  • int pid - the package id
Return Value
  • 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

34.83. listSystemsWithPackage

Name
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
Return Value
  • 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

34.84. listUngroupedSystems

Name
listUngroupedSystems
Description
List systems that are not associated with any system groups.
Parameters
  • string sessionKey
Return Value
  • 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

34.85. listUserSystems

Name
listUserSystems
Description
List systems for a given user.
Parameters
  • string sessionKey
  • string login - User's login name.
Return Value
  • 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

34.86. listUserSystems

Name
listUserSystems
Description
List systems for the logged in user.
Parameters
  • string sessionKey
Return Value
  • 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

34.87. listVirtualGuests

Name
listVirtualGuests
Description
Lists the virtual guests for a given virtual host
Parameters
  • string sessionKey
  • int sid - the virtual host's id
Return Value
  • 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

34.88. listVirtualHosts

Name
listVirtualHosts
Description
Lists the virtual hosts visible to the user
Parameters
  • string sessionKey
Return Value
  • 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

34.89. obtainReactivationKey

Name
obtainReactivationKey
Description
Obtains a reactivation key for this server.
Parameters
  • string sessionKey
  • int serverId
Return Value
  • string

34.90. obtainReactivationKey

Name
obtainReactivationKey
Description
Obtains a reactivation key for this server.
Available since: 10.10
Parameters
  • string systemid - systemid file
Return Value
  • string

34.91. provisionSystem

Name
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.
Return Value
  • int - ID of the action scheduled, otherwise exception thrown on error

34.92. provisionSystem

Name
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
Return Value
  • int - ID of the action scheduled, otherwise exception thrown on error

34.93. provisionVirtualGuest

Name
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.
Return Value
  • int - 1 on success, exception thrown otherwise.

34.94. provisionVirtualGuest

Name
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.
Return Value
  • int - 1 on success, exception thrown otherwise.

34.95. provisionVirtualGuest

Name
provisionVirtualGuest
Description
Provision a guest on the host specified. This schedules the guest for creation and will begin the provisioning process when the host checks in or if OSAD is enabled will begin immediately.
Parameters
  • 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.
Return Value
  • int - 1 on success, exception thrown otherwise.

34.96. removeEntitlements

Name
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
Return Value
  • int - 1 on success, exception thrown otherwise.

34.97. scheduleApplyErrata

Name
scheduleApplyErrata
Description
Schedules an action to apply errata updates to multiple systems.
Available since: 13.0
Parameters
  • string sessionKey
  • array:
    • int - serverId
  • array:
    • int - errataId
Return Value
  • array:
    • int - actionId

34.98. scheduleApplyErrata

Name
scheduleApplyErrata
Description
Schedules an action to apply errata updates to multiple systems at a given date/time.
Available since: 13.0
Parameters
  • string sessionKey
  • array:
    • int - serverId
  • array:
    • int - errataId
  • dateTime.iso8601 earliestOccurrence
Return Value
  • array:
    • int - actionId

34.99. scheduleApplyErrata

Name
scheduleApplyErrata
Description
Schedules an action to apply errata updates to a system.
Available since: 13.0
Parameters
  • string sessionKey
  • int serverId
  • array:
    • int - errataId
Return Value
  • array:
    • int - actionId

34.100. scheduleApplyErrata

Name
scheduleApplyErrata
Description
Schedules an action to apply errata updates to a system at a given date/time.
Available since: 13.0
Parameters
  • string sessionKey
  • int serverId
  • array:
    • int - errataId
  • dateTime.iso8601 earliestOccurrence
Return Value
  • array:
    • int - actionId

34.101. scheduleCertificateUpdate

Name
scheduleCertificateUpdate
Description
Schedule update of client certificate
Parameters
  • string sessionKey
  • int serverId
Return Value
  • int actionId - The action id of the scheduled action

34.102. scheduleCertificateUpdate

Name
scheduleCertificateUpdate
Description
Schedule update of client certificate at given date and time
Parameters
  • string sessionKey
  • int serverId
  • dateTime.iso860 date
Return Value
  • int actionId - The action id of the scheduled action

34.103. scheduleGuestAction

Name
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
Return Value
  • int actionId - The action id of the scheduled action

34.104. scheduleGuestAction

Name
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'.
Return Value
  • int actionId - The action id of the scheduled action

34.105. scheduleHardwareRefresh

Name
scheduleHardwareRefresh
Description
Schedule a hardware refresh for a system.
Available since: 13.0
Parameters
  • string sessionKey
  • int serverId
  • dateTime.iso8601 earliestOccurrence
Return Value
  • int actionId - The action id of the scheduled action

34.106. schedulePackageInstall

Name
schedulePackageInstall
Description
Schedule package installation for several systems.
Parameters
  • string sessionKey
  • array:
    • int - serverId
  • array:
    • int - packageId
  • dateTime.iso8601 earliestOccurrence
Return Value
  • array:
    • int - actionId

34.107. schedulePackageInstall

Name
schedulePackageInstall
Description
Schedule package installation for a system.
Available since: 13.0
Parameters
  • string sessionKey
  • int serverId
  • array:
    • int - packageId
  • dateTime.iso8601 earliestOccurrence
Return Value
  • int actionId - The action id of the scheduled action

34.108. schedulePackageInstallByNevra

Name
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
Return Value
  • array:
    • int - actionId

34.109. schedulePackageInstallByNevra

Name
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<