Show Table of Contents
API Guide
Red Hat Satellite 5.7
A reference guide to the Red Hat Satellite API
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:
This gives Red Hat Network customers the greatest flexibility and power to keep servers secure and up-to-date.
- 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.
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
authnamespace groups authentication function, or theerratanamespace 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
loginmethod in theauthnamespace 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
loginmethod in theauthnamespace requiresusernameandpasswordparameters to specify the login details of a certain user. Theloginmethod also accepts an optionaldurationparameter 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.7 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:
- Click the tab on the main menu, and then click .
- Complete the required details, and select Read-only API User.
- Click .
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. Namespace: actionchain
Provides the namespace for the Action Chain methods.
3.1. Method: addConfigurationDeployment
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
systemId- System ID - array
- int - Revision ID
Returns
- int - 1 on success, exception thrown otherwise.
3.2. Method: addPackageInstall
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
Returns
- int - 1 on success, exception thrown otherwise.
3.3. Method: addPackageRemoval
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
Returns
- int
actionId- The action id of the scheduled action or exception
3.4. Method: addPackageUpgrade
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
Returns
- int
actionId- The action id of the scheduled action or exception
3.5. Method: addPackageVerify
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
Returns
- int - 1 on success, exception thrown otherwise.
3.6. Method: addScriptRun
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
Returns
- int
actionId- The id of the action or throw an exception
3.7. Method: addSystemReboot
Add system reboot to an Action Chain.
Parameters
- string
sessionKey- Session token, issued at login - int
serverId - string
chainLabel- Label of the chain
Returns
- int
actionId- The action id of the scheduled action
3.8. Method: createChain
Create an Action Chain.
Parameters
- string
sessionKey- Session token, issued at login - string
chainLabel- Label of the chain
Returns
- int
actionId- The ID of the created action chain
3.9. Method: deleteChain
Delete action chain by label.
Parameters
- string
sessionKey- Session token, issued at login - string
chainLabel- Label of the chain
Returns
- int - 1 on success, exception thrown otherwise.
3.10. Method: listChainActions
List all actions in the particular Action Chain.
Parameters
- string
sessionKey- Session token, issued at login - string
chainLabel- Label of the chain
Returns
- 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.11. Method: listChains
List currently available action chains.
Parameters
- string
sessionKey- Session token, issued at login
Returns
- array
- struct
chain- string
label- Label of an Action Chain - string
entrycount- Number of entries in the Action Chain
3.12. Method: removeAction
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
Returns
- int - 1 on success, exception thrown otherwise.
3.13. Method: renameChain
Rename an Action Chain.
Parameters
- string
sessionKey- Session token, issued at login - string
previousLabel- Previous chain label - string
newLabel- New chain label
Returns
- int - 1 on success, exception thrown otherwise.
3.14. Method: scheduleChain
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
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 4. Namespace: activationkey
Contains methods to access common activation key functions available from the web interface.
4.1. Method: addChildChannels
Add child channels to an activation key.
Parameters
- string
sessionKey - string
key - array
- string
childChannelLabel
Returns
- int - 1 on success, exception thrown otherwise.
4.2. Method: addConfigChannels
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
Returns
- int - 1 on success, exception thrown otherwise.
4.3. Method: addEntitlements
Add entitlements to an activation key. Currently only add-on entitlements are permitted. (monitoring_entitled, provisioning_entitled, virtualization_host, virtualization_host_platform)
Parameters
- string
sessionKey - string
key - array
- string - entitlement label
- monitoring_entitled
- provisioning_entitled
- virtualization_host
- virtualization_host_platform
Returns
- int - 1 on success, exception thrown otherwise.
4.4. Method: addPackageNames
Add packages to an activation key using package name only.
Deprecated - being replaced by addPackages(string sessionKey, string key, array[packages])
Parameters
- string
sessionKey - string
key - array
- string
packageName
Returns
- int - 1 on success, exception thrown otherwise.
Available since: 10.2
4.5. Method: addPackages
Add packages to an activation key.
Parameters
- string
sessionKey - string
key - array
- struct
packages- string
name- Package name - string
arch- Arch label - Optional
Returns
- int - 1 on success, exception thrown otherwise.
4.6. Method: addServerGroups
Add server groups to an activation key.
Parameters
- string
sessionKey - string
key - array
- int
serverGroupId
Returns
- int - 1 on success, exception thrown otherwise.
4.7. Method: checkConfigDeployment
Check configuration file deployment status for the activation key specified.
Parameters
- string
sessionKey - string
key
Returns
- 1 if enabled, 0 if disabled, exception thrown otherwise.
4.8. Method: clone
Clone an existing activation key.
Parameters
- string
sessionKey - string
key- Key to be cloned. - string
cloneDescription- Description of the cloned key.
Returns
- string - The new activation key.
4.9. Method: create
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.
- monitoring_entitled
- provisioning_entitled
- virtualization_host
- virtualization_host_platform
- boolean
universalDefault
Returns
- string - The new activation key.
4.10. Method: create
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.
- monitoring_entitled
- provisioning_entitled
- virtualization_host
- virtualization_host_platform
- boolean
universalDefault
Returns
- string - The new activation key.
4.11. Method: delete
Delete an activation key.
Parameters
- string
sessionKey - string
key
Returns
- int - 1 on success, exception thrown otherwise.
4.12. Method: disableConfigDeployment
Disable configuration file deployment for the specified activation key.
Parameters
- string
sessionKey - string
key
Returns
- int - 1 on success, exception thrown otherwise.
4.13. Method: enableConfigDeployment
Enable configuration file deployment for the specified activation key.
Parameters
- string
sessionKey - string
key
Returns
- int - 1 on success, exception thrown otherwise.
4.14. Method: getDetails
Lookup an activation key's details.
Parameters
- string
sessionKey - string
key
Returns
- struct
activationkey- 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
Available since: 10.2
4.15. Method: listActivatedSystems
List the systems activated with the key provided.
Parameters
- string
sessionKey - string
key
Returns
- array
- struct
systemstructure- int
id- System id - string
hostname - dateTime.iso8601
last_checkin- Last time server successfully checked in
4.16. Method: listActivationKeys
List activation keys that are visible to the user.
Parameters
- string
sessionKey
Returns
- array
- struct
activationkey- 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
Available since: 10.2
4.17. Method: listConfigChannels
List configuration channels associated to an activation key.
Parameters
- string
sessionKey - string
key
Returns
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. Method: removeChildChannels
Remove child channels from an activation key.
Parameters
- string
sessionKey - string
key - array
- string
childChannelLabel
Returns
- int - 1 on success, exception thrown otherwise.
4.19. Method: removeConfigChannels
Remove configuration channels from the given activation keys.
Parameters
- string
sessionKey - array
- string
activationKey
- array
- string
configChannelLabel
Returns
- int - 1 on success, exception thrown otherwise.
4.20. Method: removeEntitlements
Remove entitlements (by label) from an activation key. Currently only add-on entitlements are permitted. (monitoring_entitled, provisioning_entitled, virtualization_host, virtualization_host_platform)
Parameters
- string
sessionKey - string
key - array
- string - entitlement label
- monitoring_entitled
- provisioning_entitled
- virtualization_host
- virtualization_host_platform
Returns
- int - 1 on success, exception thrown otherwise.
4.21. Method: removePackageNames
Remove package names from an activation key.
Deprecated - being replaced by removePackages(string sessionKey, string key, array[packages])
Parameters
- string
sessionKey - string
key - array
- string
packageName
Returns
- int - 1 on success, exception thrown otherwise.
Available since: 10.2
4.22. Method: removePackages
Remove package names from an activation key.
Parameters
- string
sessionKey - string
key - array
- struct
packages- string
name- Package name - string
arch- Arch label - Optional
Returns
- int - 1 on success, exception thrown otherwise.
4.23. Method: removeServerGroups
Remove server groups from an activation key.
Parameters
- string
sessionKey - string
key - array
- int
serverGroupId
Returns
- int - 1 on success, exception thrown otherwise.
4.24. Method: setConfigChannels
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
Returns
- int - 1 on success, exception thrown otherwise.
4.25. Method: setDetails
Update the details of an activation key.
Parameters
- string
sessionKey - string
key - struct
activationkey- 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
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 5. Namespace: api
Methods providing information about the API.
5.1. Method: getApiCallList
Lists all available api calls grouped by namespace
Parameters
- string
sessionKey
Returns
- struct
method_info- string
name- method name - string
parameters- method parameters - string
exceptions- method exceptions - string
return- method return type
5.2. Method: getApiNamespaceCallList
Lists all available api calls for the specified namespace
Parameters
- string
sessionKey - string
namespace
Returns
- struct
method_info- string
name- method name - string
parameters- method parameters - string
exceptions- method exceptions - string
return- method return type
5.3. Method: getApiNamespaces
Lists available API namespaces
Parameters
- string
sessionKey
Returns
- struct
namespace- string
namespace- API namespace - string
handler- API Handler
5.4. Method: getVersion
Returns the version of the API. Since Spacewalk 0.4 (Satellite 5.3) it is no more related to server version.
Parameters
Returns
- string
5.5. Method: systemVersion
Returns the server version.
Parameters
Returns
- string
Chapter 6. Namespace: auth
This namespace provides methods to authenticate with the system's management server.
6.1. Method: login
Login using a username and password. Returns the session key used by most other API methods.
Parameters
- string
username - string
password
Returns
- string
sessionKey
6.2. Method: login
Login using a username and password. Returns the session key used by other methods.
Parameters
- string
username - string
password - int
duration- Length of session.
Returns
- string
sessionKey
6.3. Method: logout
Logout the user with the given session key.
Parameters
- string
sessionKey
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 7. Namespace: channel
Provides method to get back a list of Software Channels.
7.1. Method: listAllChannels
List all software channels that the user's organization is entitled to.
Parameters
- string
sessionKey
Returns
- array
- struct
channelInfo- int
id - string
label - string
name - string
provider_name - int
packages - int
systems - string
arch_name
7.2. Method: listMyChannels
List all software channels that belong to the user's organization.
Parameters
- string
sessionKey
Returns
- array
- struct
channelInfo- int
id - string
label - string
name - string
provider_name - int
packages - int
systems - string
arch_name
7.3. Method: listPopularChannels
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
Returns
- array
- struct
channelInfo- int
id - string
label - string
name - string
provider_name - int
packages - int
systems - string
arch_name
7.4. Method: listRedHatChannels
List all Red Hat software channels that the user's organization is entitled to.
Deprecated - being replaced by listVendorChannels(String sessionKey)
Parameters
- string
sessionKey
Returns
- array
- struct
channelInfo- int
id - string
label - string
name - string
provider_name - int
packages - int
systems - string
arch_name
7.5. Method: listRetiredChannels
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
Returns
- array
- struct
channelInfo- int
id - string
label - string
name - string
provider_name - int
packages - int
systems - string
arch_name
7.6. Method: listSharedChannels
List all software channels that may be shared by the user's organization.
Parameters
- string
sessionKey
Returns
- array
- struct
channelInfo- int
id - string
label - string
name - string
provider_name - int
packages - int
systems - string
arch_name
7.7. Method: listSoftwareChannels
List all visible software channels.
Parameters
- string
sessionKey
Returns
- array
- struct
channel- string
label - string
name - string
parent_label - string
end_of_life - string
arch
7.8. Method: listVendorChannels
Lists all the vendor software channels that the user's organization is entitled to.
Parameters
- string
sessionKey
Returns
- array
- struct
channelInfo- int
id - string
label - string
name - string
provider_name - int
packages - int
systems - string
arch_name
Chapter 8. Namespace: channel.access
Provides methods to retrieve and alter channel access restrictions.
8.1. Method: disableUserRestrictions
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
Returns
- int - 1 on success, exception thrown otherwise.
8.2. Method: enableUserRestrictions
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
Returns
- int - 1 on success, exception thrown otherwise.
8.3. Method: getOrgSharing
Get organization sharing access control.
Parameters
- string
sessionKey - string
channelLabel- label of the channel
Returns
- string - The access value (one of the following: 'public', 'private', or 'protected'.
8.4. Method: setOrgSharing
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'
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 9. Namespace: channel.org
Provides methods to retrieve and alter organization trust relationships for a channel.
9.1. Method: disableAccess
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
Returns
- int - 1 on success, exception thrown otherwise.
9.2. Method: enableAccess
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
Returns
- int - 1 on success, exception thrown otherwise.
9.3. Method: list
List the organizations associated with the given channel that may be trusted.
Parameters
- string
sessionKey - string
channelLabel- label of the channel
Returns
- array
- struct
org- int
org_id - string
org_name - boolean
access_enabled
Chapter 10. Namespace: channel.software
Provides methods to access and modify many aspects of a channel.
10.1. Method: addPackages
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.
Returns
- int - 1 on success, exception thrown otherwise.
10.2. Method: addRepoFilter
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
Returns
- int
sortorder for new filter
10.3. Method: associateRepo
Associates a repository with a channel
Parameters
- string
sessionKey - string
channelLabel- channel label - string
repoLabel- repository label
Returns
struct
channel
int
id
string
name
string
label
string
arch_name
string
arch_label
string
summary
string
description
string
checksum_label
dateTime.iso8601
last_modified
string
maintainer_name
string
maintainer_email
string
maintainer_phone
string
support_policy
string
gpg_key_url
string
gpg_key_id
string
gpg_key_fp
dateTime.iso8601
yumrepo_last_sync - (optional)
string
end_of_life
string
parent_channel_label
string
clone_original
array
- struct
contentSources- int
id - string
label - string
sourceUrl - string
type
10.4. Method: availableEntitlements
Returns the number of available subscriptions for the given channel
Parameters
- string
sessionKey - string
channelLabel- channel to query
Returns
- int
numberof available subscriptions for the given channel
10.5. Method: clearRepoFilters
Removes the filters for a repo
Parameters
- string
sessionKey - string
label- repository label
Returns
- int - 1 on success, exception thrown otherwise.
10.6. Method: clone
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
channeldetails- 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)
- boolean
original_state
Returns
- int
thecloned channel ID
10.7. Method: create
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 - 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
Returns
- int - 1 if the creation operation succeeded, 0 otherwise
Available since: 10.9
10.8. Method: create
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 - 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.
Returns
- int - 1 if the creation operation succeeded, 0 otherwise
Available since: 10.9
10.9. Method: create
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
Returns
- int - 1 if the creation operation succeeded, 0 otherwise
10.10. Method: createRepo
Creates a repository
Parameters
- string
sessionKey - string
label- repository label - string
type- repository type (only YUM is supported) - string
url- repository url
Returns
- struct
channel- int
id - string
label - string
sourceUrl - string
type
10.11. Method: delete
Deletes a custom software channel
Parameters
- string
sessionKey - string
channelLabel- channel to delete
Returns
- int - 1 on success, exception thrown otherwise.
10.12. Method: disassociateRepo
Disassociates a repository from a channel
Parameters
- string
sessionKey - string
channelLabel- channel label - string
repoLabel- repository label
Returns
struct
channel
int
id
string
name
string
label
string
arch_name
string
arch_label
string
summary
string
description
string
checksum_label
dateTime.iso8601
last_modified
string
maintainer_name
string
maintainer_email
string
maintainer_phone
string
support_policy
string
gpg_key_url
string
gpg_key_id
string
gpg_key_fp
dateTime.iso8601
yumrepo_last_sync - (optional)
string
end_of_life
string
parent_channel_label
string
clone_original
array
- struct
contentSources- int
id - string
label - string
sourceUrl - string
type
10.13. Method: getChannelLastBuildById
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
Returns
- the last build date of the repomd.xml file as a localised string
10.14. Method: getDetails
Returns details of the given channel as a map
Parameters
- string
sessionKey - string
channelLabel- channel to query
Returns
struct
channel
int
id
string
name
string
label
string
arch_name
string
arch_label
string
summary
string
description
string
checksum_label
dateTime.iso8601
last_modified
string
maintainer_name
string
maintainer_email
string
maintainer_phone
string
support_policy
string
gpg_key_url
string
gpg_key_id
string
gpg_key_fp
dateTime.iso8601
yumrepo_last_sync - (optional)
string
end_of_life
string
parent_channel_label
string
clone_original
array
- struct
contentSources- int
id - string
label - string
sourceUrl - string
type
10.15. Method: getDetails
Returns details of the given channel as a map
Parameters
- string
sessionKey - int
id- channel to query
Returns
struct
channel
int
id
string
name
string
label
string
arch_name
string
arch_label
string
summary
string
description
string
checksum_label
dateTime.iso8601
last_modified
string
maintainer_name
string
maintainer_email
string
maintainer_phone
string
support_policy
string
gpg_key_url
string
gpg_key_id
string
gpg_key_fp
dateTime.iso8601
yumrepo_last_sync - (optional)
string
end_of_life
string
parent_channel_label
string
clone_original
array
- struct
contentSources- int
id - string
label - string
sourceUrl - string
type
10.16. Method: getRepoDetails
Returns details of the given repository
Parameters
- string
sessionKey - string
repoLabel- repo to query
Returns
- struct
channel- int
id - string
label - string
sourceUrl - string
type
10.17. Method: getRepoDetails
Returns details of the given repo
Parameters
- string
sessionKey - string
repoLabel- repo to query
Returns
- struct
channel- int
id - string
label - string
sourceUrl - string
type
10.18. Method: getRepoSyncCronExpression
Returns repo synchronization cron expression
Parameters
- string
sessionKey - string
channelLabel- channel label
Returns
- string
quartzexpression
10.19. Method: isGloballySubscribable
Returns whether the channel is subscribable by any user in the organization
Parameters
- string
sessionKey - string
channelLabel- channel to query
Returns
- int - 1 if true, 0 otherwise
10.20. Method: isUserManageable
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
Returns
- int - 1 if manageable, 0 if not
10.21. Method: isUserSubscribable
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
Returns
- int - 1 if subscribable, 0 if not
10.22. Method: listAllPackages
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
Returns
- 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.23. Method: listAllPackages
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
Returns
- 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. Method: listAllPackages
Lists all packages in the channel, regardless of the package version
Parameters
- string
sessionKey - string
channelLabel- channel to query
Returns
- 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. Method: listAllPackages
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
Returns
- 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. Method: listAllPackages
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
Returns
- 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. Method: listAllPackagesByDate
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
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch - string
id - string
arch_label - string
last_modified
10.28. Method: listAllPackagesByDate
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
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch - string
id - string
arch_label - string
last_modified
10.29. Method: listAllPackagesByDate
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
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch - string
id - string
arch_label - string
last_modified
10.30. Method: listArches
Lists the potential software channel architectures that can be created
Parameters
- string
sessionKey
Returns
- array
- struct
channelarch- string
name - string
label
10.31. Method: listChannelRepos
Lists associated repos with the given channel
Parameters
- string
sessionKey - string
channelLabel- channel label
Returns
- array
- struct
channel- int
id - string
label - string
sourceUrl - string
type
10.32. Method: listChildren
List the children of a channel
Parameters
- string
sessionKey - string
channelLabel- the label of the channel
Returns
array
struct
channel
int
id
string
name
string
label
string
arch_name
string
arch_label
string
summary
string
description
string
checksum_label
dateTime.iso8601
last_modified
string
maintainer_name
string
maintainer_email
string
maintainer_phone
string
support_policy
string
gpg_key_url
string
gpg_key_id
string
gpg_key_fp
dateTime.iso8601
yumrepo_last_sync - (optional)
string
end_of_life
string
parent_channel_label
string
clone_original
array
- struct
contentSources- int
id - string
label - string
sourceUrl - string
type
10.33. Method: listErrata
List the errata applicable to a channel after given startDate
Parameters
- string
sessionKey - string
channelLabel- channel to query - dateTime.iso8601
startDate
Returns
- array
- struct
errata- int
id- Errata ID. - string
date- Date erratum was created. - string
update_date- Date erratum was updated. - string
advisory_synopsis- Summary of the erratum. - string
advisory_type- Type label such as Security, Bug Fix - string
advisory_name- Name such as RHSA, etc
10.34. Method: listErrata
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
Returns
- array
- struct
errata- int
id- Errata ID. - string
date- Date erratum was created. - string
update_date- Date erratum was updated. - string
advisory_synopsis- Summary of the erratum. - string
advisory_type- Type label such as Security, Bug Fix - string
advisory_name- Name such as RHSA, etc
10.35. Method: listErrata
List the errata applicable to a channel
Parameters
- string
sessionKey - string
channelLabel- channel to query
Returns
- 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.36. Method: listErrata
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
Returns
- 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.37. Method: listErrata
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
Returns
- 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.38. Method: listErrataByType
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'
Returns
- 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. Method: listErrataNeedingSync
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
Returns
- array
- struct
errata- int
id- Errata ID. - string
date- Date erratum was created. - string
update_date- Date erratum was updated. - string
advisory_synopsis- Summary of the erratum. - string
advisory_type- Type label such as Security, Bug Fix - string
advisory_name- Name such as RHSA, etc
10.40. Method: listLatestPackages
Lists the packages with the latest version (including release and epoch) for the given channel
Parameters
- string
sessionKey - string
channelLabel- channel to query
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch - int
id - string
arch_label
10.41. Method: listPackagesWithoutChannel
Lists all packages that are not associated with a channel. Typically these are custom packages.
Parameters
- string
sessionKey
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch - int
id - string
arch_label - string
path- The path on that file system that the package resides - string
provider- The provider of the package, determined by the gpg key it was signed with. - dateTime.iso8601
last_modified
10.42. Method: listRepoFilters
Lists the filters for a repo
Parameters
- string
sessionKey - string
label- repository label
Returns
- array
- struct
filter- int
sortOrder - string
filter - string
flag
10.43. Method: listSubscribedSystems
Returns list of subscribed systems for the given channel label
Parameters
- string
sessionKey - string
channelLabel- channel to query
Returns
- array
- struct
system- int
id - string
name
10.44. Method: listSystemChannels
Returns a list of channels that a system is subscribed to for the given system id
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
channel- string
id - string
label - string
name
10.45. Method: listUserRepos
Returns a list of ContentSource (repos) that the user can see
Parameters
- string
sessionKey
Returns
- array
- struct
map- long "id" - ID of the repo
- string
label- label of the repo - string
sourceUrl- URL of the repo
10.46. Method: mergeErrata
Prints a list of merged errata from one channel to another. Use
channel.errata.clone or channel.errata.cloneASync to perform the merge.
Parameters
- string
sessionKey - string
mergeFromLabel- the label of the channel to pull errata from - string
mergeToLabel- the label to push the errata into
Returns
- array
- struct
errata- int
id- Errata Id - string
date- Date erratum was created. - string
advisory_type- Type of the advisory. - string
advisory_name- Name of the advisory. - string
advisory_synopsis- Summary of the erratum.
10.47. Method: mergeErrata
Prints a list of merged errata from one channel to another based upon a given start/end date. Use
channel.errata.clone or channel.errata.cloneASync to perform the merge.
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
Returns
- array
- struct
errata- int
id- Errata Id - string
date- Date erratum was created. - string
advisory_type- Type of the advisory. - string
advisory_name- Name of the advisory. - string
advisory_synopsis- Summary of the erratum.
10.48. Method: mergeErrata
Prints a list of merged errata from one channel to another. Use
channel.errata.clone or channel.errata.cloneASync to perform the merge.
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
Returns
- array
- struct
errata- int
id- Errata Id - string
date- Date erratum was created. - string
advisory_type- Type of the advisory. - string
advisory_name- Name of the advisory. - string
advisory_synopsis- Summary of the erratum.
10.49. Method: mergePackages
Prints a list of merged packages from one channel to another. Use
channel.software.addPackages to perform the merge.
Parameters
- string
sessionKey - string
mergeFromLabel- the label of the channel to pull packages from - string
mergeToLabel- the label to push the packages into
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch - int
id - string
arch_label - string
path- The path on that file system that the package resides - string
provider- The provider of the package, determined by the gpg key it was signed with. - dateTime.iso8601
last_modified
10.50. Method: regenerateNeededCache
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.
Parameters
- string
sessionKey - string
channelLabel- the label of the channel
Returns
- int - 1 on success, exception thrown otherwise.
10.51. Method: regenerateNeededCache
Completely clear and regenerate the needed Errata and Package cache for all systems subscribed. You must be a Satellite Admin to perform this action.
Parameters
- string
sessionKey
Returns
- int - 1 on success, exception thrown otherwise.
10.52. Method: regenerateYumCache
Regenerate yum cache for the specified channel.
Parameters
- string
sessionKey - string
channelLabel- the label of the channel
Returns
- int - 1 on success, exception thrown otherwise.
10.53. Method: removeErrata
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
Returns
- int - 1 on success, exception thrown otherwise.
10.54. Method: removePackages
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.
Returns
- int - 1 on success, exception thrown otherwise.
10.55. Method: removeRepo
Removes a repository
Parameters
- string
sessionKey - long id - ID of repo to be removed
Returns
- int - 1 on success, exception thrown otherwise.
10.56. Method: removeRepo
Removes a repository
Parameters
- string
sessionKey - string
label- label of repo to be removed
Returns
- int - 1 on success, exception thrown otherwise.
10.57. Method: removeRepoFilter
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
Returns
- int - 1 on success, exception thrown otherwise.
10.58. Method: setContactDetails
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
Returns
- int - 1 on success, exception thrown otherwise.
10.59. Method: setDetails
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)
Returns
- int - 1 on success, exception thrown otherwise.
10.60. Method: setGloballySubscribable
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.
Returns
- int - 1 on success, exception thrown otherwise.
10.61. Method: setRepoFilters
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
Returns
- int - 1 on success, exception thrown otherwise.
10.62. Method: setSystemChannels
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.
Returns
- int - 1 on success, exception thrown otherwise.
10.63. Method: setUserManageable
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
Returns
- int - 1 on success, exception thrown otherwise.
10.64. Method: setUserSubscribable
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
Returns
- int - 1 on success, exception thrown otherwise.
10.65. Method: subscribeSystem
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.
Returns
- int - 1 on success, exception thrown otherwise.
10.66. Method: syncErrata
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
Returns
- int - 1 on success, exception thrown otherwise.
10.67. Method: syncRepo
Trigger immediate repo synchronization
Parameters
- string
sessionKey - string
channelLabel- channel label
Returns
- int - 1 on success, exception thrown otherwise.
10.68. Method: syncRepo
Trigger immediate repo synchronization
Parameters
- string
sessionKey - string
channelLabel- channel label - struct
params_map- Boolean "sync-kickstars" - Create kickstartable tree - Optional
- Boolean "no-errata" - Do not sync errata - Optional
- Boolean "fail" - Terminate upon any error - Optional
Returns
- int - 1 on success, exception thrown otherwise.
10.69. Method: syncRepo
Schedule periodic repo synchronization
Parameters
- string
sessionKey - string
channelLabel- channel label - string
cronexpression - if empty all periodic schedules will be disabled
Returns
- int - 1 on success, exception thrown otherwise.
10.70. Method: syncRepo
Schedule periodic repo synchronization
Parameters
- string
sessionKey - string
channelLabel- channel label - string
cronexpression - if empty all periodic schedules will be disabled - struct
params_map- Boolean "sync-kickstars" - Create kickstartable tree - Optional
- Boolean "no-errata" - Do not sync errata - Optional
- Boolean "fail" - Terminate upon any error - Optional
Returns
- int - 1 on success, exception thrown otherwise.
10.71. Method: updateRepo
Updates a ContentSource (repo)
Parameters
- string
sessionKey - int
id- repository id - string
label- new repository label - string
url- new repository URL
Returns
- struct
channel- int
id - string
label - string
sourceUrl - string
type
10.72. Method: updateRepoLabel
Updates repository label
Parameters
- string
sessionKey - int
id- repository id - string
label- new repository label
Returns
- struct
channel- int
id - string
label - string
sourceUrl - string
type
10.73. Method: updateRepoLabel
Updates repository label
Parameters
- string
sessionKey - string
label- repository label - string
newLabel- new repository label
Returns
- struct
channel- int
id - string
label - string
sourceUrl - string
type
10.74. Method: updateRepoUrl
Updates repository source URL
Parameters
- string
sessionKey - int
id- repository id - string
url- new repository url
Returns
- struct
channel- int
id - string
label - string
sourceUrl - string
type
10.75. Method: updateRepoUrl
Updates repository source URL
Parameters
- string
sessionKey - string
label- repository label - string
url- new repository url
Returns
- struct
channel- int
id - string
label - string
sourceUrl - string
type
Chapter 11. Namespace: configchannel
Provides methods to access and modify many aspects of configuration channels.
11.1. Method: channelExists
Check for the existence of the config channel provided.
Parameters
- string
sessionKey - string
channelLabel- Channel to check for.
Returns
- 1 if exists, 0 otherwise.
11.2. Method: create
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
Returns
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. Method: createOrUpdatePath
Create a new file or directory with the given path, or update an existing path.
Parameters
- string
sessionKey - string
configChannelLabel - string
path - boolean
isDir- True if the path is a directory, False if it is a file. - struct
pathinfo- 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)
Returns
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
md5 - File's md5 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.
Available since: 10.2
11.4. Method: createOrUpdateSymlink
Create a new symbolic link with the given path, or update an existing path.
Parameters
- string
sessionKey - string
configChannelLabel - string
path - struct
pathinfo- 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
Returns
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
md5 - File's md5 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.
Available since: 10.2
11.5. Method: deleteChannels
Delete a list of global config channels. Caller must be a config admin.
Parameters
- string
sessionKey - array
- string - configuration channel labels to delete.
Returns
- int - 1 on success, exception thrown otherwise.
11.6. Method: deleteFileRevisions
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
Returns
- int - 1 on success, exception thrown otherwise.
11.7. Method: deleteFiles
Remove file paths from a global channel.
Parameters
- string
sessionKey - string
channelLabel- Channel to remove the files from. - array
- string - file paths to remove.
Returns
- int - 1 on success, exception thrown otherwise.
11.8. Method: deployAllSystems
Schedule an immediate configuration deployment for all systems subscribed to a particular configuration channel.
Parameters
- string
sessionKey - string
channelLabel- The configuration channel's label.
Returns
- int - 1 on success, exception thrown otherwise.
11.9. Method: deployAllSystems
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
Returns
- int - 1 on success, exception thrown otherwise.
11.10. Method: deployAllSystems
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.
Returns
- int - 1 on success, exception thrown otherwise.
11.11. Method: deployAllSystems
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
Returns
- int - 1 on success, exception thrown otherwise.
11.12. Method: getDetails
Lookup config channel details.
Parameters
- string
sessionKey - string
channelLabel
Returns
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. Method: getDetails
Lookup config channel details.
Parameters
- string
sessionKey - int
channelId
Returns
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. Method: getEncodedFileRevision
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
Returns
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
md5 - File's md5 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. Method: getFileRevision
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
Returns
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
md5 - File's md5 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. Method: getFileRevisions
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
Returns
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
md5 - File's md5 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. Method: listFiles
Return a list of files in a channel.
Parameters
- string
sessionKey - string
channelLabel- label of config channel to list files on.
Returns
array
struct
Configuration File information
string
type
- file
- directory
- symlink
string
path - File Path
dateTime.iso8601
last_modified - Last Modified Date
11.18. Method: listGlobals
List all the global config channels accessible to the logged-in user.
Parameters
- string
sessionKey
Returns
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. Method: listSubscribedSystems
Return a list of systems subscribed to a configuration channel
Parameters
- string
sessionKey - string
channelLabel- label of config channel to list subscribed systems.
Returns
- array
- struct
system- int
id - string
name
11.20. Method: lookupChannelInfo
Lists details on a list channels given their channel labels.
Parameters
- string
sessionKey - array
- string - configuration channel label
Returns
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. Method: lookupFileInfo
Given a list of paths and a channel, returns details about the latest revisions of the paths.
Parameters
- string
sessionKey - string
channelLabel- label of config channel to lookup on - array
- string - List of paths to examine.
Returns
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
md5 - File's md5 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.
Available since: 10.2
11.22. Method: lookupFileInfo
Given a path, revision number, and a channel, returns details about the latest revisions of the paths.
Parameters
- string
sessionKey - string
channelLabel- label of config channel to lookup on - string
path- path of file/directory - int
revsion- The revision number.
Returns
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
md5 - File's md5 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.
Available since: 10.12
11.23. Method: scheduleFileComparisons
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
Returns
- int
actionId- The action id of the scheduled action
11.24. Method: update
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
Returns
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. Namespace: distchannel
Provides methods to access and modify distribution channel information
12.1. Method: listDefaultMaps
Lists the default distribution channel maps
Parameters
- string
sessionKey
Returns
- 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. Method: listMapsForOrg
Lists distribution channel maps valid for the user's organization
Parameters
- string
sessionKey
Returns
- 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. Method: listMapsForOrg
Lists distribution channel maps valid for an organization, satellite admin right needed
Parameters
- string
sessionKey - int
orgId
Returns
- 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. Method: setMapForOrg
Sets, overrides (/removes if channelLabel empty) a distribution channel map within an organization
Parameters
- string
sessionKey - string
os - string
release - string
archName - string
channelLabel
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 13. Namespace: errata
Provides methods to access and modify errata.
13.1. Method: addPackages
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
Returns
- int - representing the number of packages added, exception otherwise
13.2. Method: applicableToChannels
Returns a list of channels applicable to the erratum with the given advisory name.
Parameters
- string
sessionKey - string
advisoryName
Returns
- array
- struct
channel- int
channel_id - string
label - string
name - string
parent_channel_label
13.3. Method: bugzillaFixes
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
Returns
- struct
Bugzillainfo- 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. Method: clone
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.
Returns
- array
- struct
errata- int
id- Errata Id - string
date- Date erratum was created. - string
advisory_type- Type of the advisory. - string
advisory_name- Name of the advisory. - string
advisory_synopsis- Summary of the erratum.
13.5. Method: cloneAsOriginal
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.
Returns
- array
- struct
errata- int
id- Errata Id - string
date- Date erratum was created. - string
advisory_type- Type of the advisory. - string
advisory_name- Name of the advisory. - string
advisory_synopsis- Summary of the erratum.
13.6. Method: cloneAsOriginalAsync
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.
Returns
- int - 1 on success, exception thrown otherwise.
13.7. Method: cloneAsync
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.
Returns
- int - 1 on success, exception thrown otherwise.
13.8. Method: create
Create a custom errata. If "publish" is set to true, the errata will be published as well
Parameters
- string
sessionKey - struct
erratainfo- 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
Returns
- 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. Method: delete
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
Returns
- int - 1 on success, exception thrown otherwise.
13.10. Method: findByCve
Lookup the details for errata associated with the given CVE (e.g. CVE-2008-3270)
Parameters
- string
sessionKey - string
cveName
Returns
- array
- struct
errata- int
id- Errata Id - string
date- Date erratum was created. - string
advisory_type- Type of the advisory. - string
advisory_name- Name of the advisory. - string
advisory_synopsis- Summary of the erratum.
13.11. Method: getDetails
Retrieves the details for the erratum matching the given advisory name.
Parameters
- string
sessionKey - string
advisoryName
Returns
- 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. Method: listAffectedSystems
Return the list of systems affected by the erratum with advisory name.
Parameters
- string
sessionKey - string
advisoryName
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
13.13. Method: listByDate
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
Returns
- array
- struct
errata- int
id- Errata Id - string
date- Date erratum was created. - string
advisory_type- Type of the advisory. - string
advisory_name- Name of the advisory. - string
advisory_synopsis- Summary of the erratum.
13.14. Method: listCves
Returns a list of
Parameters
- string
sessionKey - string
advisoryName
Returns
- array
- string - cveName
13.15. Method: listKeywords
Get the keywords associated with an erratum matching the given advisory name.
Parameters
- string
sessionKey - string
advisoryName
Returns
- array
- string - Keyword associated with erratum.
13.16. Method: listPackages
Returns a list of the packages affected by the erratum with the given advisory name.
Parameters
- string
sessionKey - string
advisoryName
Returns
- 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. Method: listUnpublishedErrata
Returns a list of unpublished errata
Parameters
- string
sessionKey
Returns
- 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. Method: publish
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
Returns
- 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. Method: publishAsOriginal
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
Returns
- 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. Method: removePackages
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
Returns
- int - representing the number of packages removed, exception otherwise
13.21. Method: setDetails
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)
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 14. Namespace: kickstart
Provides methods to create kickstart files
14.1. Method: cloneProfile
Clone a Kickstart Profile
Parameters
- string
sessionKey - string
ksLabelToClone- Label of the kickstart profile to clone - string
newKsLabel- label of the cloned profile
Returns
- int - 1 on success, exception thrown otherwise.
14.2. Method: createProfile
Import a kickstart profile into RHN.
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).
Returns
- int - 1 on success, exception thrown otherwise.
14.3. Method: createProfile
Import a kickstart profile into RHN.
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.
Returns
- int - 1 on success, exception thrown otherwise.
14.4. Method: createProfileWithCustomUrl
Import a kickstart profile into RHN.
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.
Returns
- int - 1 on success, exception thrown otherwise.
14.5. Method: createProfileWithCustomUrl
Import a kickstart profile into RHN.
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).
Returns
- int - 1 on success, exception thrown otherwise.
14.6. Method: deleteProfile
Delete a kickstart profile
Parameters
- string
sessionKey - string
ksLabel- The label of the kickstart profile you want to remove
Returns
- int - 1 on success, exception thrown otherwise.
14.7. Method: disableProfile
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
Returns
- int - 1 on success, exception thrown otherwise.
14.8. Method: findKickstartForIp
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)
Returns
- string - label of the kickstart. Empty string ("") if not found.
14.9. Method: importFile
Import a kickstart profile into RHN.
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.
Returns
- int - 1 on success, exception thrown otherwise.
14.10. Method: importFile
Import a kickstart profile into RHN.
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.
Returns
- int - 1 on success, exception thrown otherwise.
14.11. Method: importFile
Import a kickstart profile into RHN.
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).
Returns
- int - 1 on success, exception thrown otherwise.
14.12. Method: importRawFile
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.
Returns
- int - 1 on success, exception thrown otherwise.
14.13. Method: importRawFile
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).
Returns
- int - 1 on success, exception thrown otherwise.
14.14. Method: isProfileDisabled
Returns whether a kickstart profile is disabled
Parameters
- string
sessionKey - string
profileLabel- kickstart profile label
Returns
- true if profile is disabled
14.15. Method: listAllIpRanges
List all Ip Ranges and their associated kickstarts available in the user's org.
Parameters
- string
sessionKey
Returns
- array
- struct
KickstartIp 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. Method: listKickstartableChannels
List kickstartable channels for the logged in user.
Parameters
- string
sessionKey
Returns
array
struct
channel
int
id
string
name
string
label
string
arch_name
string
arch_label
string
summary
string
description
string
checksum_label
dateTime.iso8601
last_modified
string
maintainer_name
string
maintainer_email
string
maintainer_phone
string
support_policy
string
gpg_key_url
string
gpg_key_id
string
gpg_key_fp
dateTime.iso8601
yumrepo_last_sync - (optional)
string
end_of_life
string
parent_channel_label
string
clone_original
array
- struct
contentSources- int
id - string
label - string
sourceUrl - string
type
14.17. Method: listKickstartableTrees
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.
Returns
- array
- struct
kickstartabletree- int
id - string
label - string
base_path - int
channel_id
14.18. Method: listKickstarts
Provides a list of kickstart profiles visible to the user's org
Parameters
- string
sessionKey
Returns
- array
- struct
kickstart- string
label - string
tree_label - string
name - boolean
advanced_mode - boolean
org_default - boolean
active - string
update_type
14.19. Method: renameProfile
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
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 15. Namespace: kickstart.filepreservation
Provides methods to retrieve and manipulate kickstart file preservation lists.
15.1. Method: create
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
Returns
- int - 1 on success, exception thrown otherwise.
15.2. Method: delete
Delete a file preservation list.
Parameters
- string
session_key - string
name- name of the file list to delete
Returns
- int - 1 on success, exception thrown otherwise.
15.3. Method: getDetails
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
Returns
- struct
filelist- string
name - array
file_names- string
name
15.4. Method: listAllFilePreservations
List all file preservation lists for the organization associated with the user logged into the given session
Parameters
- string
sessionKey
Returns
- array
- struct
filepreservation- int
id - string
name - dateTime.iso8601
created - dateTime.iso8601
last_modified
Chapter 16. Namespace: kickstart.keys
Provides methods to manipulate kickstart keys.
16.1. Method: create
creates a new key with the given parameters
Parameters
- string
session_key - string
description - string
type- valid values are GPG or SSL - string
content
Returns
- int - 1 on success, exception thrown otherwise.
16.2. Method: delete
deletes the key identified by the given parameters
Parameters
- string
session_key - string
description
Returns
- int - 1 on success, exception thrown otherwise.
16.3. Method: getDetails
returns all of the data associated with the given key
Parameters
- string
session_key - string
description
Returns
- struct
key- string
description - string
type - string
content
16.4. Method: listAllKeys
list all keys for the org associated with the user logged into the given session
Parameters
- string
sessionKey
Returns
- array
- struct
key- string
description - string
type
16.5. Method: update
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
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 17. Namespace: kickstart.profile.keys
Provides methods to access and modify the list of activation keys associated with a kickstart profile.
17.1. Method: addActivationKey
Add an activation key association to the kickstart profile
Parameters
- string
sessionKey - string
ksLabel- the kickstart profile label - string
key- the activation key
Returns
- int - 1 on success, exception thrown otherwise.
17.2. Method: getActivationKeys
Lookup the activation keys associated with the kickstart profile.
Parameters
- string
sessionKey - string
ksLabel- the kickstart profile label
Returns
- array
- struct
activationkey- 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. Method: removeActivationKey
Remove an activation key association from the kickstart profile
Parameters
- string
sessionKey - string
ksLabel- the kickstart profile label - string
key- the activation key
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 18. Namespace: kickstart.profile.software
Provides methods to access and modify the software list associated with a kickstart profile.
18.1. Method: appendToSoftwareList
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.
Returns
- int - 1 on success, exception thrown otherwise.
18.2. Method: getSoftwareDetails
Gets kickstart profile software details.
Parameters
- string
sessionKey - string
ksLabel- Label of the kickstart profile
Returns
- struct
Kickstartpackages info- string
noBase- Install @Base package group - string
ignoreMissing- Ignore missing packages
18.3. Method: getSoftwareList
Get a list of a kickstart profile's software packages.
Parameters
- string
sessionKey - string
ksLabel- The label of a kickstart profile.
Returns
- string[] - Get a list of a kickstart profile's software packages.
18.4. Method: setSoftwareDetails
Sets kickstart profile software details.
Parameters
- string
sessionKey - string
ksLabel- Label of the kickstart profile - struct
Kickstartpackages info- string
noBase- Install @Base package group - string
ignoreMissing- Ignore missing packages
Returns
- int - 1 on success, exception thrown otherwise.
18.5. Method: setSoftwareList
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.
Returns
- int - 1 on success, exception thrown otherwise.
18.6. Method: setSoftwareList
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
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 19. Namespace: kickstart.profile.system
Provides methods to set various properties of a kickstart profile.
19.1. Method: addFilePreservations
Adds the given list of file preservations to the specified kickstart profile.
Parameters
- string
sessionKey - string
kickstartLabel - array
- string - filePreservations
Returns
- int - 1 on success, exception thrown otherwise.
19.2. Method: addKeys
Adds the given list of keys to the specified kickstart profile.
Parameters
- string
sessionKey - string
kickstartLabel - array
- string - keyDescription
Returns
- int - 1 on success, exception thrown otherwise.
19.3. Method: checkConfigManagement
Check the configuration management status for a kickstart profile.
Parameters
- string
sessionKey - string
ksLabel- the kickstart profile label
Returns
- boolean
enabled- true if configuration management is enabled; otherwise, false
19.4. Method: checkRemoteCommands
Check the remote commands status flag for a kickstart profile.
Parameters
- string
sessionKey - string
ksLabel- the kickstart profile label
Returns
- boolean
enabled- true if remote commands support is enabled; otherwise, false
19.5. Method: disableConfigManagement
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
Returns
- int - 1 on success, exception thrown otherwise.
19.6. Method: disableRemoteCommands
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
Returns
- int - 1 on success, exception thrown otherwise.
19.7. Method: enableConfigManagement
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
Returns
- int - 1 on success, exception thrown otherwise.
19.8. Method: enableRemoteCommands
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
Returns
- int - 1 on success, exception thrown otherwise.
19.9. Method: getLocale
Retrieves the locale for a kickstart profile.
Parameters
- string
sessionKey - string
ksLabel- the kickstart profile label
Returns
struct
locale info
string
locale
boolean
useUtc
- true - the hardware clock uses UTC
- false - the hardware clock does not use UTC
19.10. Method: getPartitioningScheme
Get the partitioning scheme for a kickstart profile.
Parameters
- string
sessionKey - string
ksLabel- The label of a kickstart profile.
Returns
- string[] - A list of partitioning commands used to setup the partitions, logical volumes and volume groups."
19.11. Method: getRegistrationType
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
Returns
- string
registrationType- reactivation
- deletion
- none
19.12. Method: getSELinux
Retrieves the SELinux enforcing mode property of a kickstart profile.
Parameters
- string
sessionKey - string
ksLabel- the kickstart profile label
Returns
- string
enforcingMode- enforcing
- permissive
- disabled
19.13. Method: listFilePreservations
Returns the set of all file preservations associated with the given kickstart profile.
Parameters
- string
sessionKey - string
kickstartLabel
Returns
- array
- struct
filelist- string
name - array
file_names- string
name
19.14. Method: listKeys
Returns the set of all keys associated with the given kickstart profile.
Parameters
- string
sessionKey - string
kickstartLabel
Returns
- array
- struct
key- string
description - string
type - string
content
19.15. Method: removeFilePreservations
Removes the given list of file preservations from the specified kickstart profile.
Parameters
- string
sessionKey - string
kickstartLabel - array
- string - filePreservations
Returns
- int - 1 on success, exception thrown otherwise.
19.16. Method: removeKeys
Removes the given list of keys from the specified kickstart profile.
Parameters
- string
sessionKey - string
kickstartLabel - array
- string - keyDescription
Returns
- int - 1 on success, exception thrown otherwise.
19.17. Method: setLocale
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
Returns
- int - 1 on success, exception thrown otherwise.
19.18. Method: setPartitioningScheme
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.
Returns
- int - 1 on success, exception thrown otherwise.
19.19. Method: setRegistrationType
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.
Returns
- int - 1 on success, exception thrown otherwise.
19.20. Method: setSELinux
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
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 20. Namespace: kickstart.profile
Provides methods to access and modify many aspects of a kickstart profile.
20.1. Method: addIpRange
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)
Returns
- int - 1 on success, exception thrown otherwise.
20.2. Method: addScript
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.
Returns
- int
id- the id of the added script
20.3. Method: addScript
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.
Returns
- int
id- the id of the added script
20.4. Method: addScript
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
Returns
- int
id- the id of the added script
20.5. Method: compareActivationKeys
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
Returns
struct
Comparison Info
array
kickstartLabel1 - Actual label of the first kickstart profile is the key into the struct
array
- struct
activationkey- 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
activationkey- 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. Method: compareAdvancedOptions
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
Returns
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. Method: comparePackages
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
Returns
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. Method: downloadKickstart
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.
Returns
- 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. Method: downloadRenderedKickstart
Downloads the Cobbler-rendered Kickstart file.
Parameters
- string
sessionKey - string
ksLabel- The label of the kickstart to download.
Returns
- string - The contents of the kickstart file.
20.10. Method: getAdvancedOptions
Get advanced options for a kickstart profile.
Parameters
- string
sessionKey - string
ksLabel- Label of kickstart profile to be changed.
Returns
- array
- struct
option- string
name - string
arguments
20.11. Method: getAvailableRepositories
Lists available OS repositories to associate with the provided kickstart profile.
Parameters
- string
sessionKey - string
ksLabel
Returns
- array
- string - repositoryLabel
20.12. Method: getCfgPreservation
Get ks.cfg preservation option for a kickstart profile.
Parameters
- string
sessionKey - string
kslabel- Label of kickstart profile to be changed.
Returns
- boolean - The value of the option. True means that ks.cfg will be copied to /root, false means that it will not.
20.13. Method: getChildChannels
Get the child channels for a kickstart profile.
Parameters
- string
sessionKey - string
kslabel- Label of kickstart profile.
Returns
- array
- string - channelLabel
20.14. Method: getCustomOptions
Get custom options for a kickstart profile.
Parameters
- string
sessionKey - string
ksLabel
Returns
- array
- struct
option- int
id - string
arguments
20.15. Method: getKickstartTree
Get the kickstart tree for a kickstart profile.
Parameters
- string
sessionKey - string
kslabel- Label of kickstart profile to be changed.
Returns
- string
kstreeLabel- Label of the kickstart tree.
20.16. Method: getRepositories
Lists all OS repositories associated with provided kickstart profile.
Parameters
- string
sessionKey - string
ksLabel
Returns
- array
- string - repositoryLabel
20.17. Method: getUpdateType
Get the update type for a kickstart profile.
Parameters
- string
sessionKey - string
kslabel- Label of kickstart profile.
Returns
- string
update_type- Update type for this Kickstart Profile.
20.18. Method: getVariables
Returns a list of variables associated with the specified kickstart profile
Parameters
- string
sessionKey - string
ksLabel
Returns
- struct
kickstartvariable- string
key - string
orint "value"
20.19. Method: getVirtualizationType
For given kickstart profile label returns label of virtualization type it's using
Parameters
- string
sessionKey - string
ksLabel
Returns
- string
virtLabel- Label of virtualization type.
20.20. Method: listIpRanges
List all ip ranges for a kickstart profile.
Parameters
- string
sessionKey - string
label- The label of the kickstart
Returns
- array
- struct
KickstartIp 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. Method: listScripts
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
Returns
- array
- struct
kickstartscript- 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. Method: orderScripts
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
Returns
- int - 1 on success, exception thrown otherwise.
20.23. Method: removeIpRange
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.
Returns
- int - 1 on successful removal, 0 if range wasn't found for the specified kickstart, exception otherwise.
20.24. Method: removeScript
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.
Returns
- int - 1 on success, exception thrown otherwise.
20.25. Method: setAdvancedOptions
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
advancedoptions- 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
Returns
- int - 1 on success, exception thrown otherwise.
20.26. Method: setCfgPreservation
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.
Returns
- int - 1 on success, exception thrown otherwise.
20.27. Method: setChildChannels
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
Returns
- int - 1 on success, exception thrown otherwise.
20.28. Method: setCustomOptions
Set custom options for a kickstart profile.
Parameters
- string
sessionKey - string
ksLabel - string[] options
Returns
- int - 1 on success, exception thrown otherwise.
20.29. Method: setKickstartTree
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.
Returns
- int - 1 on success, exception thrown otherwise.
20.30. Method: setLogging
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
Returns
- int - 1 on success, exception thrown otherwise.
20.31. Method: setRepositories
$call.doc
Parameters
- string
sessionKey - string
ksLabel - array
- string - repositoryLabel
Returns
- int - 1 on success, exception thrown otherwise.
20.32. Method: setUpdateType
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'.
Returns
- int - 1 on success, exception thrown otherwise.
20.33. Method: setVariables
Associates list of kickstart variables with the specified kickstart profile
Parameters
- string
sessionKey - string
ksLabel - struct
kickstartvariable- string
key - string
orint "value"
Returns
- int - 1 on success, exception thrown otherwise.
20.34. Method: setVirtualizationType
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'
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 21. Namespace: kickstart.snippet
Provides methods to create kickstart files
21.1. Method: createOrUpdate
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
Returns
- 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. Method: delete
Delete the specified snippet. If the snippet is not found, 0 is returned.
Parameters
- string
sessionKey - string
name
Returns
- int - 1 on success, exception thrown otherwise.
21.3. Method: listAll
List all cobbler snippets for the logged in user
Parameters
- string
sessionKey
Returns
- 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. Method: listCustom
List only custom snippets for the logged in user. These snipppets are editable.
Parameters
- string
sessionKey
Returns
- 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. Method: listDefault
List only pre-made default snippets for the logged in user. These snipppets are not editable.
Parameters
- string
sessionKey
Returns
- 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. Namespace: kickstart.tree
Provides methods to access and modify the kickstart trees.
22.1. Method: create
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).
Returns
- int - 1 on success, exception thrown otherwise.
22.2. Method: delete
Delete a Kickstart Tree (Distribution) in Satellite.
Parameters
- string
sessionKey - string
treeLabel- Label for the kickstart tree to delete.
Returns
- int - 1 on success, exception thrown otherwise.
22.3. Method: deleteTreeAndProfiles
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.
Returns
- int - 1 on success, exception thrown otherwise.
22.4. Method: getDetails
The detailed information about a kickstartable tree given the tree name.
Parameters
- string
sessionKey - string
treeLabel- Label of kickstartable tree to search.
Returns
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. Method: list
List the available kickstartable trees for the given channel.
Parameters
- string
sessionKey - string
channelLabel- Label of channel to search.
Returns
- array
- struct
kickstartabletree- int
id - string
label - string
base_path - int
channel_id
22.6. Method: listInstallTypes
List the available kickstartable install types (rhel2,3,4,5 and fedora9+).
Parameters
- string
sessionKey
Returns
- array
- struct
kickstartinstall type- int
id - string
label - string
name
22.7. Method: rename
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.
Returns
- int - 1 on success, exception thrown otherwise.
22.8. Method: update
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).
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 23. Namespace: org
Contains methods to access common organization management functions available from the web interface.
23.1. Method: create
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.
Returns
- struct
organizationinfo- 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. Method: delete
Delete an organization. The default organization (i.e. orgId=1) cannot be deleted.
Parameters
- string
sessionKey - int
orgId
Returns
- int - 1 on success, exception thrown otherwise.
23.3. Method: getCrashFileSizeLimit
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
Returns
- int - Crash file size limit.
23.4. Method: getDetails
The detailed information about an organization given the organization ID.
Parameters
- string
sessionKey - int
orgId
Returns
- struct
organizationinfo- 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. Method: getDetails
The detailed information about an organization given the organization name.
Parameters
- string
sessionKey - string
name
Returns
- struct
organizationinfo- 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. Method: getPolicyForScapFileUpload
Get the status of SCAP detailed result file upload settings for the given organization.
Parameters
- string
sessionKey - int
orgId
Returns
- 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. Method: getPolicyForScapResultDeletion
Get the status of SCAP result deletion settings for the given organization.
Parameters
- string
sessionKey - int
orgId
Returns
- 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. Method: isCrashReportingEnabled
Get the status of crash reporting settings for the given organization. Returns true if enabled, false otherwise.
Parameters
- string
sessionKey - int
orgId
Returns
- boolean - Get the status of crash reporting settings.
23.9. Method: isCrashfileUploadEnabled
Get the status of crash file upload settings for the given organization. Returns true if enabled, false otherwise.
Parameters
- string
sessionKey - int
orgId
Returns
- boolean - Get the status of crash file upload settings.
23.10. Method: listOrgs
Returns the list of organizations.
Parameters
- string
sessionKey
Returns
- struct
organizationinfo- 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.11. Method: listSoftwareEntitlements
List software entitlement allocation information across all organizations. Caller must be a satellite administrator.
Parameters
- string
sessionKey
Returns
- array
- struct
entitlementusage- 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.12. Method: listSoftwareEntitlements
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.
Returns
- array
- struct
entitlementusage- int
org_id - string
org_name - int
allocated - int
unallocated - int
used - int
free
23.13. Method: listSoftwareEntitlements
List each organization's allocation of a given software entitlement. A value of -1 indicates unlimited entitlements.
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.
Returns
- array
- struct
entitlementusage- int
org_id - string
org_name - int
allocated - int
unallocated - int
used - int
free
Available since: 10.4
23.14. Method: listSoftwareEntitlementsForOrg
List an organization's allocation of each software entitlement. A value of -1 indicates unlimited entitlements.
Parameters
- string
sessionKey - int
orgId
Returns
- array
- struct
entitlementusage- 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.15. Method: listSystemEntitlements
Lists system entitlement allocation information across all organizations. Caller must be a satellite administrator.
Parameters
- string
sessionKey
Returns
- array
- struct
entitlementusage- string
label - string
name - int
allocated - int
unallocated - int
used - int
free
23.16. Method: listSystemEntitlements
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
Returns
- array
- struct
entitlementusage- int
org_id - string
org_name - int
allocated - int
unallocated - int
used - int
free
23.17. Method: listSystemEntitlements
List each organization's allocation of a system entitlement.
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.
Returns
- array
- struct
entitlementusage- int
org_id - string
org_name - int
allocated - int
unallocated - int
used - int
free
Available since: 10.4
23.18. Method: listSystemEntitlementsForOrg
List an organization's allocation of each system entitlement.
Parameters
- string
sessionKey - int
orgId
Returns
- array
- struct
entitlementusage- string
label - string
name - int
free - int
used - int
allocated - int
unallocated
23.19. Method: listUsers
Returns the list of users in a given organization.
Parameters
- string
sessionKey - int
orgId
Returns
- array
- struct
user- string
login - string
login_uc - string
name - string
email - boolean
is_org_admin
23.20. Method: migrateSystems
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
Returns
- array
- int - serverIdMigrated
23.21. Method: setCrashFileSizeLimit
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).
Returns
- int - 1 on success, exception thrown otherwise.
23.22. Method: setCrashReporting
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
Returns
- int - 1 on success, exception thrown otherwise.
23.23. Method: setCrashfileUpload
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
Returns
- int - 1 on success, exception thrown otherwise.
23.24. Method: setPolicyForScapFileUpload
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.
Returns
- int - 1 on success, exception thrown otherwise.
23.25. Method: setPolicyForScapResultDeletion
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).
Returns
- int - 1 on success, exception thrown otherwise.
23.26. Method: setSoftwareEntitlements
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
Returns
- int - 1 on success, exception thrown otherwise.
23.27. Method: setSoftwareFlexEntitlements
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
Returns
- int - 1 on success, exception thrown otherwise.
23.28. Method: setSystemEntitlements
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
- monitoring_entitled
- provisioning_entitled
- virtualization_host
- virtualization_host_platform
- int
allocation
Returns
- int - 1 on success, exception thrown otherwise.
23.29. Method: updateName
Updates the name of an organization
Parameters
- string
sessionKey - int
orgId - string
name- Organization name. Must meet same criteria as in the web UI.
Returns
- struct
organizationinfo- 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. Namespace: org.trusts
Contains methods to access common organization trust information available from the web interface.
24.1. Method: addTrust
Add an organization to the list of trusted organizations.
Parameters
- string
sessionKey - int
orgId - int
trustOrgId
Returns
- int - 1 on success, exception thrown otherwise.
24.2. Method: getDetails
The trust details about an organization given the organization's ID.
Parameters
- string
sessionKey - int
trustOrgId- Id of the trusted organization
Returns
- struct
orgtrust 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. Method: listChannelsConsumed
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
Returns
- array
- struct
channelInfo- int
channel_id - string
channel_name - int
packages - int
systems
24.4. Method: listChannelsProvided
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
Returns
- array
- struct
channelInfo- int
channel_id - string
channel_name - int
packages - int
systems
24.5. Method: listOrgs
List all organanizations trusted by the user's organization.
Parameters
- string
sessionKey
Returns
- array
- struct
trustedorganizations- int
org_id - string
org_name - int
shared_channels
24.6. Method: listSystemsAffected
Get a list of systems within the
Parameters
- string
sessionKey - int
orgId - string
trustOrgId
Returns
- array
- struct
affectedsystems- int
systemId - string
systemName
24.7. Method: listTrusts
Returns the list of trusted organizations.
Parameters
- string
sessionKey - int
orgId
Returns
- array
- struct
trustedorganizations- int
orgId - string
orgName - bool "trustEnabled"
24.8. Method: removeTrust
Remove an organization to the list of trusted organizations.
Parameters
- string
sessionKey - int
orgId - int
trustOrgId
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 25. Namespace: packages
Methods to retrieve information about the Packages contained within this server.
25.1. Method: findByNvrea
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
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch - int
id - string
arch_label - string
path- The path on that file system that the package resides - string
provider- The provider of the package, determined by the gpg key it was signed with. - dateTime.iso8601
last_modified
25.2. Method: getDetails
Retrieve details for the package with the ID.
Parameters
- string
sessionKey - int
packageId
Returns
- struct
package- int
id - string
name - string
epoch - string
version - string
release - string
arch_label - array
providing_channels- string
Channellabel 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. Method: getPackage
Retrieve the package file associated with a package. (Consider using packages.getPackageUrl for larger files.)
Parameters
- string
sessionKey - int
package_id
Returns
- binary object - package file
25.4. Method: getPackageUrl
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
Returns
- string - the download url
25.5. Method: listChangelog
List the change log for a package.
Parameters
- string
sessionKey - int
packageId
Returns
- string
25.6. Method: listDependencies
List the dependencies for a package.
Parameters
- string
sessionKey - int
packageId
Returns
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. Method: listFiles
List the files associated with a package.
Parameters
- string
sessionKey - int
packageId
Returns
- array
- struct
fileinfo- string
path - string
type - string
last_modified_date - string
checksum - string
checksum_type - int
size - string
linkto
25.8. Method: listProvidingChannels
List the channels that provide the a package.
Parameters
- string
sessionKey - int
packageId
Returns
- array
- struct
channel- string
label - string
parent_label - string
name
25.9. Method: listProvidingErrata
List the errata providing the a package.
Parameters
- string
sessionKey - int
packageId
Returns
- array
- struct
errata- string
advisory - string
issue_date - string
last_modified_date - string
update_date - string
synopsis - string
type
25.10. Method: removePackage
Remove a package from the satellite.
Parameters
- string
sessionKey - int
packageId
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 26. Namespace: packages.provider
Methods to retrieve information about Package Providers associated with packages.
26.1. Method: associateKey
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
Returns
- int - 1 on success, exception thrown otherwise.
26.2. Method: list
List all Package Providers. User executing the request must be a Satellite administrator.
Parameters
- string
sessionKey
Returns
- array
- struct
packageprovider- string
name - array
keys- struct
packagesecurity key- string
key - string
type
26.3. Method: listKeys
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
Returns
- array
- struct
packagesecurity key- string
key - string
type
Chapter 27. Namespace: packages.search
Methods to interface to package search capabilities in search server..
27.1. Method: advanced
Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax. Lucene Query Parser syntax is defined at
Parameters
- string
sessionKey - string
luceneQuery- a query written in the form of Lucene QueryParser Syntax
Returns
- array
- struct
packageoverview- int
id - string
name - string
summary - string
description - string
version - string
release - string
arch - string
epoch - string
provider
27.2. Method: advancedWithActKey
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
Parameters
- string
sessionKey - string
luceneQuery- a query written in the form of Lucene QueryParser Syntax - string
actKey- activation key to look for packages in
Returns
- array
- struct
packageoverview- int
id - string
name - string
summary - string
description - string
version - string
release - string
arch - string
epoch - string
provider
27.3. Method: advancedWithChannel
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
Parameters
- string
sessionKey - string
luceneQuery- a query written in the form of Lucene QueryParser Syntax - string
channelLabel- Channel Label
Returns
- array
- struct
packageoverview- int
id - string
name - string
summary - string
description - string
version - string
release - string
arch - string
epoch - string
provider
27.4. Method: name
Search the lucene package indexes for all packages which match the given name.
Parameters
- string
sessionKey - string
name- package name to search for
Returns
- array
- struct
packageoverview- int
id - string
name - string
summary - string
description - string
version - string
release - string
arch - string
epoch - string
provider
27.5. Method: nameAndDescription
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
Returns
- array
- struct
packageoverview- int
id - string
name - string
summary - string
description - string
version - string
release - string
arch - string
epoch - string
provider
27.6. Method: nameAndSummary
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
Returns
- array
- struct
packageoverview- int
id - string
name - string
summary - string
description - string
version - string
release - string
arch - string
epoch - string
provider
Chapter 28. Namespace: preferences.locale
Provides methods to access and modify user locale information
28.1. Method: listLocales
Returns a list of all understood locales. Can be used as input to setLocale.
Parameters
Returns
- array
- string - Locale code.
28.2. Method: listTimeZones
Returns a list of all understood timezones. Results can be used as input to setTimeZone.
Parameters
Returns
- array
- struct
timezone- int
time_zone_id- Unique identifier for timezone. - string
olson_name- Name as identified by the Olson database.
28.3. Method: setLocale
Set a user's locale.
Parameters
- string
sessionKey - string
login- User's login name. - string
locale- Locale to set. (from listLocales)
Returns
- int - 1 on success, exception thrown otherwise.
28.4. Method: setTimeZone
Set a user's timezone.
Parameters
- string
sessionKey - string
login- User's login name. - int
tzid- Timezone ID. (from listTimeZones)
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 29. Namespace: proxy
Provides methods to activate/deactivate a proxy server.
29.1. Method: activateProxy
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.
Returns
- int - 1 on success, exception thrown otherwise.
29.2. Method: createMonitoringScout
Create Monitoring Scout for proxy.
Parameters
- string
systemid- systemid file
Returns
- string
Available since: 10.7
29.3. Method: deactivateProxy
Deactivates the proxy identified by the given client certificate i.e. systemid file.
Parameters
- string
systemid- systemid file
Returns
- int - 1 on success, exception thrown otherwise.
29.4. Method: isProxy
Test, if the system identified by the given client certificate i.e. systemid file, is proxy.
Parameters
- string
systemid- systemid file
Returns
- int - 1 on success, exception thrown otherwise.
29.5. Method: listAvailableProxyChannels
List available version of proxy channel for system identified by the given client certificate i.e. systemid file.
Parameters
- string
systemid- systemid file
Returns
- array
- string - version
Available since: 10.5
Chapter 30. Namespace: satellite
Provides methods to obtain details on the Satellite.
30.1. Method: getCertificateExpirationDate
Retrieves the certificate expiration date of the activated certificate.
Parameters
- string
sessionKey
Returns
- dateTime.iso8601
30.2. Method: isMonitoringEnabled
Indicates if monitoring is enabled on the satellite
Parameters
- string
sessionKey
Returns
- boolean
Trueif monitoring is enabled
30.3. Method: isMonitoringEnabledBySystemId
Indicates if monitoring is enabled on the satellite
Parameters
- string
systemid- systemid file
Returns
- boolean
Trueif monitoring is enabled
30.4. Method: listEntitlements
Lists all channel and system entitlements for the organization associated with the user executing the request.
Parameters
- string
sessionKey
Returns
- struct
channel/systementitlements- array
system- struct
systementitlement- string
label - string
name - int
used_slots - int
free_slots - int
total_slots
- array
channel- struct
channelentitlement- string
label - string
name - int
used_slots - int
free_slots - int
total_slots - int
used_flex - int
free_flex - int
total_flex
30.5. Method: listProxies
List the proxies within the user's organization.
Parameters
- string
sessionKey
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
Chapter 31. Namespace: schedule
Methods to retrieve information about scheduled actions.
31.1. Method: archiveActions
Archive all actions in the given list.
Parameters
- string
sessionKey - array
- int - action id
Returns
- int - 1 on success, exception thrown otherwise.
31.2. Method: cancelActions
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
Returns
- int - 1 on success, exception thrown otherwise.
31.3. Method: deleteActions
Delete all archived actions in the given list.
Parameters
- string
sessionKey - array
- int - action id
Returns
- int - 1 on success, exception thrown otherwise.
31.4. Method: listAllActions
Returns a list of all actions. This includes completed, in progress, failed and archived actions.
Parameters
- string
sessionKey
Returns
- 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.5. Method: listArchivedActions
Returns a list of actions that have been archived.
Parameters
- string
sessionKey
Returns
- 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.6. Method: listCompletedActions
Returns a list of actions that have completed successfully.
Parameters
- string
sessionKey
Returns
- 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. Method: listCompletedSystems
Returns a list of systems that have completed a specific action.
Parameters
- string
sessionKey - string
actionId
Returns
- 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.8. Method: listFailedActions
Returns a list of actions that have failed.
Parameters
- string
sessionKey
Returns
- 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. Method: listFailedSystems
Returns a list of systems that have failed a specific action.
Parameters
- string
sessionKey - string
actionId
Returns
- 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. Method: listInProgressActions
Returns a list of actions that are in progress.
Parameters
- string
sessionKey
Returns
- 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. Method: listInProgressSystems
Returns a list of systems that have a specific action in progress.
Parameters
- string
sessionKey - string
actionId
Returns
- 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. Method: rescheduleActions
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
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 32. Namespace: sync.master
Contains methods to set up information about known-"masters", for use on the "slave" side of ISS
32.1. Method: addToMaster
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-orgdetails- int
masterOrgId - string
masterOrgName - int
localOrgId
Returns
- int - 1 on success, exception thrown otherwise.
32.2. Method: create
Create a new Master, known to this Slave.
Parameters
- string
sessionKey - string
label- Master's fully-qualified domain name
Returns
- struct
IssMasterinfo- int
id - string
label - string
caCert - boolean
isCurrentMaster
32.3. Method: delete
Remove the specified Master
Parameters
- string
sessionKey - int
id- Id of the Master to remove
Returns
- int - 1 on success, exception thrown otherwise.
32.4. Method: getDefaultMaster
Return the current default-Master for this Slave
Parameters
- string
sessionKey
Returns
- struct
IssMasterinfo- int
id - string
label - string
caCert - boolean
isCurrentMaster
32.5. Method: getMaster
Find a Master by specifying its ID
Parameters
- string
sessionKey - int
id- Id of the desired Master
Returns
- struct
IssMasterinfo- int
id - string
label - string
caCert - boolean
isCurrentMaster
32.6. Method: getMasterByLabel
Find a Master by specifying its label
Parameters
- string
sessionKey - string
label- Label of the desired Master
Returns
- struct
IssMasterinfo- int
id - string
label - string
caCert - boolean
isCurrentMaster
32.7. Method: getMasterOrgs
List all organizations the specified Master has exported to this Slave
Parameters
- string
sessionKey - int
id- Id of the desired Master
Returns
- array
- struct
IssMasterOrginfo- int
masterOrgId - string
masterOrgName - int
localOrgId
32.8. Method: getMasters
Get all the Masters this Slave knows about
Parameters
- string
sessionKey
Returns
- array
- struct
IssMasterinfo- int
id - string
label - string
caCert - boolean
isCurrentMaster
32.9. Method: makeDefault
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
Returns
- int - 1 on success, exception thrown otherwise.
32.10. Method: mapToLocal
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
Returns
- int - 1 on success, exception thrown otherwise.
32.11. Method: setCaCert
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
Returns
- int - 1 on success, exception thrown otherwise.
32.12. Method: setMasterOrgs
Reset all organizations the specified Master has exported to this Slave
Parameters
- string
sessionKey - int
id- Id of the desired Master - array
- struct
master-orgdetails- int
masterOrgId - string
masterOrgName - int
localOrgId
Returns
- int - 1 on success, exception thrown otherwise.
32.13. Method: unsetDefaultMaster
Make this slave have no default Master for satellite-sync
Parameters
- string
sessionKey
Returns
- int - 1 on success, exception thrown otherwise.
32.14. Method: update
Updates the label of the specified Master
Parameters
- string
sessionKey - int
id- Id of the Master to update - string
label- Desired new label
Returns
- struct
IssMasterinfo- int
id - string
label - string
caCert - boolean
isCurrentMaster
Chapter 33. Namespace: sync.slave
Contains methods to set up information about allowed-"slaves", for use on the "master" side of ISS
33.1. Method: create
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?
Returns
- struct
IssSlaveinfo- int
id - string
slave - boolean
enabled - boolean
allowAllOrgs
33.2. Method: delete
Remove the specified Slave
Parameters
- string
sessionKey - int
id- Id of the Slave to remove
Returns
- int - 1 on success, exception thrown otherwise.
33.3. Method: getAllowedOrgs
Get all orgs this Master is willing to export to the specified Slave
Parameters
- string
sessionKey - int
id- Id of the desired Slave
Returns
- array
- int - ids of allowed organizations
33.4. Method: getSlave
Find a Slave by specifying its ID
Parameters
- string
sessionKey - int
id- Id of the desired Slave
Returns
- struct
IssSlaveinfo- int
id - string
slave - boolean
enabled - boolean
allowAllOrgs
33.5. Method: getSlaveByName
Find a Slave by specifying its Fully-Qualified Domain Name
Parameters
- string
sessionKey - string
fqdn- Domain-name of the desired Slave
Returns
- struct
IssSlaveinfo- int
id - string
slave - boolean
enabled - boolean
allowAllOrgs
33.6. Method: getSlaves
Get all the Slaves this Master knows about
Parameters
- string
sessionKey
Returns
- array
- struct
IssSlaveinfo- int
id - string
slave - boolean
enabled - boolean
allowAllOrgs
33.7. Method: setAllowedOrgs
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
Returns
- int - 1 on success, exception thrown otherwise.
33.8. Method: update
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?
Returns
- struct
IssSlaveinfo- int
id - string
slave - boolean
enabled - boolean
allowAllOrgs
Chapter 34. Namespace: system
Provides methods to access and modify registered system.
34.1. Method: addEntitlements
Add entitlements to a server. Entitlements a server already has are quietly ignored.
Parameters
- string
sessionKey - int
serverId - array
- string - entitlementLabel - one of following: monitoring_entitled, provisioning_entitled, virtualization_host, virtualization_host_platform, enterprise_entitled
Returns
- int - 1 on success, exception thrown otherwise.
34.2. Method: addNote
Add a new note to the given server.
Parameters
- string
sessionKey - int
serverId - string
subject- What the note is about. - string
body- Content of the note.
Returns
- int - 1 on success, exception thrown otherwise.
34.3. Method: applyErrata
Schedules an action to apply errata updates to a system.
Deprecated - being replaced by system.scheduleApplyErrata(string sessionKey, int serverId, array[int errataId])
Parameters
- string
sessionKey - int
serverId - array
- int - errataId
Returns
- int - 1 on success, exception thrown otherwise.
34.4. Method: comparePackageProfile
Compare a system's packages against a package profile. In the result returned, 'this_system' represents the server provided as an input and 'other_system' represents the profile provided as an input.
Parameters
- string
sessionKey - int
serverId - string
profileLabel
Returns
array
struct
Package Metadata
int
package_name_id
string
package_name
string
package_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. Method: comparePackages
Compares the packages installed on two systems.
Parameters
- string
sessionKey - int
thisServerId - int
otherServerId
Returns
array
struct
Package Metadata
int
package_name_id
string
package_name
string
package_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. Method: convertToFlexEntitlement
Converts the given list of systems for a given channel family to use the flex entitlement.
Parameters
- string
sessionKey - array
- int - serverId
- string
channelFamilyLabel
Returns
- int - the total the number of systems that were converted to use flex entitlement.
34.7. Method: createPackageProfile
Create a new stored Package Profile from a systems installed package list.
Parameters
- string
sessionKey - int
serverId - string
profileLabel - string
description
Returns
- int - 1 on success, exception thrown otherwise.
34.8. Method: createSystemRecord
Creates a cobbler system record with the specified kickstart label
Parameters
- string
sessionKey - int
serverId - string
ksLabel
Returns
- int - 1 on success, exception thrown otherwise.
34.9. Method: deleteCustomValues
Delete the custom values defined for the custom system information keys provided from the given system.
Parameters
- string
sessionKey - int
serverId - array
- string - customInfoLabel
Returns
- int - 1 on success, exception thrown otherwise.
34.10. Method: deleteGuestProfiles
Delete the specified list of guest profiles for a given host
Parameters
- string
sessionKey - int
hostId - array
- string - guestNames
Returns
- int - 1 on success, exception thrown otherwise.
34.11. Method: deleteNote
Deletes the given note from the server.
Parameters
- string
sessionKey - int
serverId - int
noteId
Returns
- int - 1 on success, exception thrown otherwise.
34.12. Method: deleteNotes
Deletes all notes from the server.
Parameters
- string
sessionKey - int
serverId
Returns
- int - 1 on success, exception thrown otherwise.
34.13. Method: deletePackageProfile
Delete a package profile
Parameters
- string
sessionKey - int
profileId
Returns
- int - 1 on success, exception thrown otherwise.
34.14. Method: deleteSystem
Delete a system given its client certificate.
Parameters
- string
systemid- systemid file
Returns
- int - 1 on success, exception thrown otherwise.
Available since: 10.10
34.15. Method: deleteSystem
Delete a system given its server id synchronously
Parameters
- string
sessionKey - int
serverId
Returns
- int - 1 on success, exception thrown otherwise.
34.16. Method: deleteSystems
Delete systems given a list of system ids asynchronously.
Parameters
- string
sessionKey - array
- int - serverId
Returns
- int - 1 on success, exception thrown otherwise.
34.17. Method: deleteTagFromSnapshot
Deletes tag from system snapshot
Parameters
- string
sessionKey - int
serverId - string
tagName
Returns
- int - 1 on success, exception thrown otherwise.
34.18. Method: downloadSystemId
Get the system ID file for a given server.
Parameters
- string
sessionKey - int
serverId
Returns
- string
34.19. Method: getConnectionPath
Get the list of proxies that the given system connects through in order to reach the server.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
proxyconnection 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. Method: getCpu
Gets the CPU information of a system.
Parameters
- string
sessionKey - int
serverId
Returns
- struct
CPU- string
cache - string
family - string
mhz - string
flags - string
model - string
vendor - string
arch - string
stepping - string
count - int
socket_count(if available)"
34.21. Method: getCustomValues
Get the custom data values defined for the server.
Parameters
- string
sessionKey - int
serverId
Returns
- struct
customvalue- string
custominfo label"
34.22. Method: getDetails
Get system details.
Parameters
- string
sessionKey - int
serverId
Returns
- struct
serverdetails- 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 monitoring_entitled, 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. Method: getDevices
Gets a list of devices for a system.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
device- string
device- optional - string
device_class- Includes CDROM, FIREWIRE, HD, USB, VIDEO, OTHER, etc. - string
driver - string
description - string
bus - string
pcitype
34.24. Method: getDmi
Gets the DMI information of a system.
Parameters
- string
sessionKey - int
serverId
Returns
- struct
DMI- string
vendor - string
system - string
product - string
asset - string
board - string
bios_release- (optional) - string
bios_vendor- (optional) - string
bios_version- (optional)
34.25. Method: getEntitlements
Gets the entitlements for a given server.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- string - entitlement_label
34.26. Method: getEventHistory
Returns a list history items associated with the system, ordered from newest to oldest. Note that the details may be empty for events that were scheduled against the system (as compared to instant). For more information on such events, see the system.listSystemEvents operation.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
HistoryEvent- dateTime.iso8601
completed- Date that the event occurred (optional) - string
summary- Summary of the event - string
details- Details of the event
34.27. Method: getId
Get system IDs and last check in information for the given system name.
Parameters
- string
sessionKey - string
systemName
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.28. Method: getMemory
Gets the memory information for a system.
Parameters
- string
sessionKey - int
serverId
Returns
- struct
memory- int
ram- The amount of physical memory in MB. - int
swap- The amount of swap space in MB.
34.29. Method: getName
Get system name and last check in information for the given system ID.
Parameters
- string
sessionKey - string
serverId
Returns
- struct
nameinfo- int
id- Server id - string
name- Server name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.30. Method: getNetwork
Get the addresses and hostname for a given server.
Parameters
- string
sessionKey - int
serverId
Returns
- struct
networkinfo- string
ip- IPv4 address of server - string
ip6- IPv6 address of server - string
hostname- Hostname of server
34.31. Method: getNetworkDevices
Returns the network devices for the given server.
Parameters
- string
sessionKey - int
serverId
Returns
array
struct
network device
string
ip - IP address assigned to this network device
string
interface - Network interface assigned to device e.g. eth0
string
netmask - Network mask assigned to device
string
hardware_address - Hardware Address of device.
string
module - Network driver used for this device.
string
broadcast - Broadcast address for device.
array
ipv6 - List of IPv6 addresses
array
- struct
ipv6address- string
address- IPv6 address of this network device - string
netmask- IPv6 netmask of this network device - string
scope- IPv6 address scope
34.32. Method: getRegistrationDate
Returns the date the system was registered.
Parameters
- string
sessionKey - int
serverId
Returns
- dateTime.iso8601 - The date the system was registered, in local time.
34.33. Method: getRelevantErrata
Returns a list of all errata that are relevant to the system.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
errata- int
id- Errata ID. - string
date- Date erratum was created. - string
update_date- Date erratum was updated. - string
advisory_synopsis- Summary of the erratum. - string
advisory_type- Type label such as Security, Bug Fix - string
advisory_name- Name such as RHSA, etc
34.34. Method: getRelevantErrataByType
Returns a list of all errata of the specified type that are relevant to the system.
Parameters
- string
sessionKey - int
serverId - string
advisoryType- type of advisory (one of of the following: 'Security Advisory', 'Product Enhancement Advisory', 'Bug Fix Advisory'
Returns
- array
- struct
errata- int
id- Errata ID. - string
date- Date erratum was created. - string
update_date- Date erratum was updated. - string
advisory_synopsis- Summary of the erratum. - string
advisory_type- Type label such as Security, Bug Fix - string
advisory_name- Name such as RHSA, etc
34.35. Method: getRunningKernel
Returns the running kernel of the given system.
Parameters
- string
sessionKey - int
serverId
Returns
- string
34.36. Method: getScriptActionDetails
Returns script details for script run actions
Parameters
- string
sessionKey - int
actionId- ID of the script run action.
Returns
struct
Script details
int
id - action id
string
content - script content
string
run_as_user - Run as user
string
run_as_group - Run as group
int
timeout - Timeout in seconds
array
- struct
scriptresult- 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
- result
34.37. Method: getScriptResults
Fetch results from a script execution. Returns an empty array if no results are yet available.
Parameters
- string
sessionKey - int
actionId- ID of the script run action.
Returns
- array
- struct
scriptresult- 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. Method: getSubscribedBaseChannel
Provides the base channel of a given system
Parameters
- string
sessionKey - int
serverId
Returns
struct
channel
int
id
string
name
string
label
string
arch_name
string
arch_label
string
summary
string
description
string
checksum_label
dateTime.iso8601
last_modified
string
maintainer_name
string
maintainer_email
string
maintainer_phone
string
support_policy
string
gpg_key_url
string
gpg_key_id
string
gpg_key_fp
dateTime.iso8601
yumrepo_last_sync - (optional)
string
end_of_life
string
parent_channel_label
string
clone_original
array
- struct
contentSources- int
id - string
label - string
sourceUrl - string
type
34.39. Method: getSystemCurrencyMultipliers
Get the System Currency score multipliers
Parameters
- string
sessionKey
Returns
- Map of score multipliers
34.40. Method: getSystemCurrencyScores
Get the System Currency scores for all servers the user has access to
Parameters
- string
sessionKey
Returns
- array
- struct
systemcurrency- int
sid - int
criticalsecurity errata count" - int
importantsecurity errata count" - int
moderatesecurity errata count" - int
lowsecurity errata count" - int
bugfix errata count" - int
enhancementerrata count" - int
systemcurrency score"
34.41. Method: getUnscheduledErrata
Provides an array of errata that are applicable to a given system.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
errata- int
id- Errata Id - string
date- Date erratum was created. - string
advisory_type- Type of the advisory. - string
advisory_name- Name of the advisory. - string
advisory_synopsis- Summary of the erratum.
34.42. Method: getUuid
Get the UUID from the given system ID.
Parameters
- string
sessionKey - int
serverId
Returns
- string
34.43. Method: getVariables
Lists kickstart variables set in the system record for the specified server. Note: This call assumes that a system record exists in cobbler for the given system and will raise an XMLRPC fault if that is not the case. To create a system record over xmlrpc use system.createSystemRecord To create a system record in the Web UI please go to System - Specified System - Provisioning - Select a Kickstart profile - Create Cobbler System Record.
Parameters
- string
sessionKey - int
serverId
Returns
- struct
Systemkickstart variables- boolean
netboot- netboot enabled - array
kickstartvariables"- struct
kickstartvariable- string
key - string
orint "value"
34.44. Method: isNvreInstalled
Check if the package with the given NVRE is installed on given system.
Parameters
- string
sessionKey - int
serverId - string
name- Package name. - string
version- Package version. - string
release- Package release.
Returns
- 1 if package exists, 0 if not, exception is thrown if an error occurs
34.45. Method: isNvreInstalled
Is the package with the given NVRE installed on given system.
Parameters
- string
sessionKey - int
serverId - string
name- Package name. - string
version- Package version. - string
release- Package release. - string
epoch- Package epoch.
Returns
- 1 if package exists, 0 if not, exception is thrown if an error occurs
34.46. Method: listActivationKeys
List the activation keys the system was registered with. An empty list will be returned if an activation key was not used during registration.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- string - key
34.47. Method: listActiveSystems
Returns a list of active servers visible to the user.
Parameters
- string
sessionKey
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.48. Method: listActiveSystemsDetails
Given a list of server ids, returns a list of active servers' details visible to the user.
Parameters
- string
sessionKey - array
- int - serverIds
Returns
array
struct
server details
int
id - The server's id
string
name - The server's name
dateTime.iso8601
last_checkin - Last time server successfully checked in (in UTC)
int
ram - The amount of physical memory in MB.
int
swap - The amount of swap space in MB.
struct
network_devices The server's network devices
struct
network device
string
ip - IP address assigned to this network device
string
interface - Network interface assigned to device e.g. eth0
string
netmask - Network mask assigned to device
string
hardware_address - Hardware Address of device.
string
module - Network driver used for this device.
string
broadcast - Broadcast address for device.
array
ipv6 - List of IPv6 addresses
array
- struct
ipv6address- 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.49. Method: listAdministrators
Returns a list of users which can administer the system.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
user- int
id - string
login - string
login_uc- upper case version of the login - boolean
enabled- true if user is enabled, false if the user is disabled
34.50. Method: listAllInstallablePackages
Get the list of all installable packages for a given system.
Parameters
- string
sessionKey - int
serverId
Returns
- struct
package- string
name - string
version - string
release - string
epoch - int
id - string
arch_label
34.51. Method: listBaseChannels
Returns a list of subscribable base channels.
Deprecated - being replaced by listSubscribableBaseChannels(string sessionKey, int serverId)
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
channel- int
id- Base Channel ID. - string
name- Name of channel. - string
label- Label of Channel - int
current_base- 1 indicates it is the current base channel
34.52. Method: listChildChannels
Returns a list of subscribable child channels. This only shows channels the system is *not* currently subscribed to.
Deprecated - being replaced by listSubscribableChildChannels(string sessionKey, int serverId)
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
childchannel- int
id - string
name - string
label - string
summary - string
has_license - string
gpg_key_url
34.53. Method: listDuplicatesByHostname
List duplicate systems by Hostname.
Parameters
- string
sessionKey
Returns
- array
- struct
DuplicateGroup- string
hostname - array
systems- struct
system- int
systemId - string
systemName - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.54. Method: listDuplicatesByIp
List duplicate systems by IP Address.
Parameters
- string
sessionKey
Returns
- array
- struct
DuplicateGroup- string
ip - array
systems- struct
system- int
systemId - string
systemName - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.55. Method: listDuplicatesByMac
List duplicate systems by Mac Address.
Parameters
- string
sessionKey
Returns
- array
- struct
DuplicateGroup- string
mac - array
systems- struct
system- int
systemId - string
systemName - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.56. Method: listEligibleFlexGuests
List eligible flex guests accessible to the user
Parameters
- string
sessionKey
Returns
array
struct
channel family system group
int
id
string
label
string
name
array
- int - systems
34.57. Method: listExtraPackages
List extra packages for a system
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch- returned only if non-zero - string
arch - date "installtime" - returned only if known
34.58. Method: listFlexGuests
List flex guests accessible to the user
Parameters
- string
sessionKey
Returns
array
struct
channel family system group
int
id
string
label
string
name
array
- int - systems
34.59. Method: listGroups
List the available groups for a given system.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
systemgroup- 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.60. Method: listInactiveSystems
Lists systems that have been inactive for the default period of inactivity
Parameters
- string
sessionKey
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.61. Method: listInactiveSystems
Lists systems that have been inactive for the specified number of days..
Parameters
- string
sessionKey - int
days
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.62. Method: listLatestAvailablePackage
Get the latest available version of a package for each system
Parameters
- string
sessionKey - array
- int - serverId
- string
packageName
Returns
array
struct
system
int
id - server ID
string
name - server name
struct
package package structure
struct
package
- int
id - string
name - string
version - string
release - string
epoch - string
arch
34.63. Method: listLatestInstallablePackages
Get the list of latest installable packages for a given system.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch - int
id - string
arch_label
34.64. Method: listLatestUpgradablePackages
Get the list of latest upgradable packages for a given system.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
package- string
name - string
arch - string
from_version - string
from_release - string
from_epoch - string
to_version - string
to_release - string
to_epoch - string
to_package_id
34.65. Method: listNewerInstalledPackages
Given a package name, version, release, and epoch, returns the list of packages installed on the system w/ the same name that are newer.
Parameters
- string
sessionKey - int
serverId - string
name- Package name. - string
version- Package version. - string
release- Package release. - string
epoch- Package epoch.
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch
34.66. Method: listNotes
Provides a list of notes associated with a system.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
notedetails- 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.67. Method: listOlderInstalledPackages
Given a package name, version, release, and epoch, returns the list of packages installed on the system with the same name that are older.
Parameters
- string
sessionKey - int
serverId - string
name- Package name. - string
version- Package version. - string
release- Package release. - string
epoch- Package epoch.
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch
34.68. Method: listOutOfDateSystems
Returns list of systems needing package updates.
Parameters
- string
sessionKey
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.69. Method: listPackageProfiles
List the package profiles in this organization
Parameters
- string
sessionKey
Returns
- array
- struct
packageprofile- int
id - string
name - string
channel
34.70. Method: listPackages
List the installed packages for a given system. The attribute installtime is returned since API version 10.10.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch - string
arch - date "installtime" - returned only if known
34.71. Method: listPackagesFromChannel
Provides a list of packages installed on a system that are also contained in the given channel. The installed package list did not include arch information before RHEL 5, so it is arch unaware. RHEL 5 systems do upload the arch information, and thus are arch aware.
Parameters
- string
sessionKey - int
serverId - string
channelLabel
Returns
- array
- struct
package- string
name - string
version - string
release - string
epoch - int
id - string
arch_label - string
path- The path on that file system that the package resides - string
provider- The provider of the package, determined by the gpg key it was signed with. - dateTime.iso8601
last_modified
34.72. Method: listPhysicalSystems
Returns a list of all Physical servers visible to the user.
Parameters
- string
sessionKey
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.73. Method: listSubscribableBaseChannels
Returns a list of subscribable base channels.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
channel- int
id- Base Channel ID. - string
name- Name of channel. - string
label- Label of Channel - int
current_base- 1 indicates it is the current base channel
34.74. Method: listSubscribableChildChannels
Returns a list of subscribable child channels. This only shows channels the system is *not* currently subscribed to.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
childchannel- int
id - string
name - string
label - string
summary - string
has_license - string
gpg_key_url
34.75. Method: listSubscribedChildChannels
Returns a list of subscribed child channels.
Parameters
- string
sessionKey - int
serverId
Returns
array
struct
channel
int
id
string
name
string
label
string
arch_name
string
arch_label
string
summary
string
description
string
checksum_label
dateTime.iso8601
last_modified
string
maintainer_name
string
maintainer_email
string
maintainer_phone
string
support_policy
string
gpg_key_url
string
gpg_key_id
string
gpg_key_fp
dateTime.iso8601
yumrepo_last_sync - (optional)
string
end_of_life
string
parent_channel_label
string
clone_original
array
- struct
contentSources- int
id - string
label - string
sourceUrl - string
type
34.76. Method: listSystemEvents
List system events of the specified type for given server. "actionType" should be exactly the string returned in the action_type field from the listSystemEvents(sessionKey, serverId) method. For example, 'Package Install' or 'Initiate a kickstart for a virtual guest.'
Parameters
- string
sessionKey - int
serverId- ID of system. - string
actionType- Type of the action.
Returns
- array
- struct
action- int
failed_count- Number of times action failed. - string
modified- Date modified. (Deprecated by modified_date) - dateTime.iso8601
modified_date- Date modified. - string
created- Date created. (Deprecated by created_date) - dateTime.iso8601
created_date- Date created. - string
action_type - int
successful_count- Number of times action was successful. - string
earliest_action- Earliest date this action will occur. - int
archived- If this action is archived. (1 or 0) - string
scheduler_user- available only if concrete user has scheduled the action - string
prerequisite- Pre-requisite action. (optional) - string
name- Name of this action. - int
id- Id of this action. - string
version- Version of action. - string
completion_time- The date/time the event was completed. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by completed_date) - dateTime.iso8601
completed_date- The date/time the event was completed. (optional) - string
pickup_time- The date/time the action was picked up. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by pickup_date) - dateTime.iso8601
pickup_date- The date/time the action was picked up. (optional) - string
result_msg- The result string after the action executes at the client machine. (optional) - array
additional_info- This array contains additional information for the event, if available.- struct
info- string
detail- The detail provided depends on the specific event. For example, for a package event, this will be the package name, for an errata event, this will be the advisory name and synopsis, for a config file event, this will be path and optional revision information...etc. - string
result- The result (if included) depends on the specific event. For example, for a package or errata event, no result is included, for a config file event, the result might include an error (if one occurred, such as the file was missing) or in the case of a config file comparison it might include the differenes found.
Available since: 10.8
34.77. Method: listSystemEvents
List all system events for given server. This includes *all* events for the server since it was registered. This may require the caller to filter the results to fetch the specific events they are looking for.
Parameters
- string
sessionKey - int
serverId- ID of system.
Returns
- array
- struct
action- int
failed_count- Number of times action failed. - string
modified- Date modified. (Deprecated by modified_date) - dateTime.iso8601
modified_date- Date modified. - string
created- Date created. (Deprecated by created_date) - dateTime.iso8601
created_date- Date created. - string
action_type - int
successful_count- Number of times action was successful. - string
earliest_action- Earliest date this action will occur. - int
archived- If this action is archived. (1 or 0) - string
scheduler_user- available only if concrete user has scheduled the action - string
prerequisite- Pre-requisite action. (optional) - string
name- Name of this action. - int
id- Id of this action. - string
version- Version of action. - string
completion_time- The date/time the event was completed. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by completed_date) - dateTime.iso8601
completed_date- The date/time the event was completed. (optional) - string
pickup_time- The date/time the action was picked up. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by pickup_date) - dateTime.iso8601
pickup_date- The date/time the action was picked up. (optional) - string
result_msg- The result string after the action executes at the client machine. (optional) - array
additional_info- This array contains additional information for the event, if available.- struct
info- string
detail- The detail provided depends on the specific event. For example, for a package event, this will be the package name, for an errata event, this will be the advisory name and synopsis, for a config file event, this will be path and optional revision information...etc. - string
result- The result (if included) depends on the specific event. For example, for a package or errata event, no result is included, for a config file event, the result might include an error (if one occurred, such as the file was missing) or in the case of a config file comparison it might include the differenes found.
Available since: 10.8
34.78. Method: listSystems
Returns a list of all servers visible to the user.
Parameters
- string
sessionKey
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.79. Method: listSystemsWithExtraPackages
List systems with extra packages
Parameters
- string
sessionKey
Returns
- array
- int
id- System ID - string
name- System profile name - int
extra_pkg_count- Extra packages count
34.80. Method: listSystemsWithPackage
Lists the systems that have the given installed package
Parameters
- string
sessionKey - int
pid- the package id
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.81. Method: listSystemsWithPackage
Lists the systems that have the given installed package
Parameters
- string
sessionKey - string
name- the package name - string
version- the package version - string
release- the package release
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.82. Method: listUngroupedSystems
List systems that are not associated with any system groups.
Parameters
- string
sessionKey
Returns
- array
- struct
system- int
id- server id - string
name
34.83. Method: listUserSystems
List systems for a given user.
Parameters
- string
sessionKey - string
login- User's login name.
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.84. Method: listUserSystems
List systems for the logged in user.
Parameters
- string
sessionKey
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.85. Method: listVirtualGuests
Lists the virtual guests for agiven virtual host
Parameters
- string
sessionKey - int
sid- the virtual host's id
Returns
- array
- struct
virtualsystem- 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.86. Method: listVirtualHosts
Lists the virtual hosts visible to the user
Parameters
- string
sessionKey
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.87. Method: obtainReactivationKey
Obtains a reactivation key for this server.
Parameters
- string
sessionKey - int
serverId
Returns
- string
34.88. Method: obtainReactivationKey
Obtains a reactivation key for this server.
Parameters
- string
systemid- systemid file
Returns
- string
Available since: 10.10
34.89. Method: provisionSystem
Provision a system using the specified kickstart profile.
Parameters
- string
sessionKey - int
serverId- ID of the system to be provisioned. - string
profileName- Kickstart profile to use.
Returns
- int - ID of the action scheduled, otherwise exception thrown on error
34.90. Method: provisionSystem
Provision a system using the specified kickstart profile.
Parameters
- string
sessionKey - int
serverId- ID of the system to be provisioned. - string
profileName- Kickstart profile to use. - dateTime.iso8601
earliestDate
Returns
- int - ID of the action scheduled, otherwise exception thrown on error
34.91. Method: provisionVirtualGuest
Provision a guest on the host specified. Defaults to: memory=512MB, vcpu=1, storage=3GB, mac_address=random.
Parameters
- string
sessionKey - int
serverId- ID of host to provision guest on. - string
guestName - string
profileName- Kickstart profile to use.
Returns
- int - 1 on success, exception thrown otherwise.
34.92. Method: provisionVirtualGuest
Provision a guest on the host specified. This schedules the guest for creation and will begin the provisioning process when the host checks in or if OSAD is enabled will begin immediately. Defaults to mac_address=random.
Parameters
- string
sessionKey - int
serverId- ID of host to provision guest on. - string
guestName - string
profileName- Kickstart Profile to use. - int
memoryMb- Memory to allocate to the guest - int
vcpus- Number of virtual CPUs to allocate to the guest. - int
storageGb- Size of the guests disk image.
Returns
- int - 1 on success, exception thrown otherwise.
34.93. Method: provisionVirtualGuest
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.
Returns
- int - 1 on success, exception thrown otherwise.
34.94. Method: removeEntitlements
Remove addon entitlements from a server. Entitlements a server does not have are quietly ignored.
Parameters
- string
sessionKey - int
serverId - array
- string - entitlement_label
Returns
- int - 1 on success, exception thrown otherwise.
34.95. Method: scheduleApplyErrata
Schedules an action to apply errata updates to multiple systems.
Parameters
- string
sessionKey - array
- int - serverId
- array
- int - errataId
Returns
- array
- int - actionId
Available since: 13.0
34.96. Method: scheduleApplyErrata
Schedules an action to apply errata updates to multiple systems at a given date/time.
Parameters
- string
sessionKey - array
- int - serverId
- array
- int - errataId
- dateTime.iso8601
earliestOccurrence
Returns
- array
- int - actionId
Available since: 13.0
34.97. Method: scheduleApplyErrata
Schedules an action to apply errata updates to a system.
Parameters
- string
sessionKey - int
serverId - array
- int - errataId
Returns
- array
- int - actionId
Available since: 13.0
34.98. Method: scheduleApplyErrata
Schedules an action to apply errata updates to a system at a given date/time.
Parameters
- string
sessionKey - int
serverId - array
- int - errataId
- dateTime.iso8601
earliestOccurrence
Returns
- array
- int - actionId
Available since: 13.0
34.99. Method: scheduleCertificateUpdate
Schedule update of client certificate
Parameters
- string
sessionKey - int
serverId
Returns
- int
actionId- The action id of the scheduled action
34.100. Method: scheduleCertificateUpdate
Schedule update of client certificate at given date and time
Parameters
- string
sessionKey - int
serverId - dateTime.iso860 date
Returns
- int
actionId- The action id of the scheduled action
34.101. Method: scheduleGuestAction
Schedules a guest action for the specified virtual guest for a given date/time.
Parameters
- string
sessionKey - int
sid- the system Id of the guest - string
state- One of the following actions 'start', 'suspend', 'resume', 'restart', 'shutdown'. - dateTime.iso8601
date- the time/date to schedule the action
Returns
- int
actionId- The action id of the scheduled action
34.102. Method: scheduleGuestAction
Schedules a guest action for the specified virtual guest for the current time.
Parameters
- string
sessionKey - int
sid- the system Id of the guest - string
state- One of the following actions 'start', 'suspend', 'resume', 'restart', 'shutdown'.
Returns
- int
actionId- The action id of the scheduled action
34.103. Method: scheduleHardwareRefresh
Schedule a hardware refresh for a system.
Parameters
- string
sessionKey - int
serverId - dateTime.iso8601
earliestOccurrence
Returns
- int
actionId- The action id of the scheduled action
Available since: 13.0
34.104. Method: schedulePackageInstall
Schedule package installation for a system.
Parameters
- string
sessionKey - array
- int - serverId
- array
- int
packageId
- dateTime.iso8601
earliestOccurrence
Returns
- array
- int - actionId
34.105. Method: schedulePackageInstall
Schedule package installation for a system.
Parameters
- string
sessionKey - int
serverId - array
- int
packageId
- dateTime.iso8601
earliestOccurrence
Returns
- int
actionId- The action id of the scheduled action
Available since: 13.0
34.106. Method: schedulePackageRefresh
Schedule a package list refresh for a system.
Parameters
- string
sessionKey - int
serverId - dateTime.iso8601
earliestOccurrence
Returns
- int - ID of the action scheduled, otherwise exception thrown on error
34.107. Method: schedulePackageRemove
Schedule package removal for a system.
Parameters
- string
sessionKey - int
serverId - array
- int
packageId
- dateTime.iso8601
earliestOccurrence
Returns
- int - ID of the action scheduled, otherwise exception thrown on error
34.108. Method: scheduleReboot
Schedule a reboot for a system.
Parameters
- string
sessionKey - int
serverId - dateTime.iso860 earliestOccurrence
Returns
- int
actionId- The action id of the scheduled action
Available since: 13.0
34.109. Method: scheduleScriptRun
Schedule a script to run.
Parameters
- string
sessionKey - array
- int - System IDs of the servers to run the script on.
- string
username- User to run script as. - string
groupname- Group to run script as. - int
timeout- Seconds to allow the script to run before timing out. - string
script- Contents of the script to run. - dateTime.iso8601
earliestOccurrence- Earliest the script can run.
Returns
- int - ID of the script run action created. Can be used to fetch results with system.getScriptResults.
34.110. Method: scheduleScriptRun
Schedule a script to run.
Parameters
- string
sessionKey - int
serverId- ID of the server to run the script on. - string
username- User to run script as. - string
groupname- Group to run script as. - int
timeout- Seconds to allow the script to run before timing out. - string
script- Contents of the script to run. - dateTime.iso8601
earliestOccurrence- Earliest the script can run.
Returns
- int - ID of the script run action created. Can be used to fetch results with system.getScriptResults.
34.111. Method: scheduleSyncPackagesWithSystem
Sync packages from a source system to a target.
Parameters
- string
sessionKey - int
targetServerId- Target system to apply package changes to. - int
sourceServerId- Source system to retrieve package state from. - array
- int
packageId- Package IDs to be synced.
- dateTime.iso8601
date- Date to schedule action for
Returns
- int
actionId- The action id of the scheduled action
Available since: 13.0
34.112. Method: searchByName
Returns a list of system IDs whose name matches the supplied regular expression(defined by
Parameters
- string
sessionKey - string
regexp- A regular expression
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
34.113. Method: setBaseChannel
Assigns the server to a new baseChannel.
Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string channelLabel)
Parameters
- string
sessionKey - int
serverId - int
channelId
Returns
- int - 1 on success, exception thrown otherwise.
34.114. Method: setBaseChannel
Assigns the server to a new base channel. If the user provides an empty string for the channelLabel, the current base channel and all child channels will be removed from the system.
Parameters
- string
sessionKey - int
serverId - string
channelLabel
Returns
- int - 1 on success, exception thrown otherwise.
34.115. Method: setChildChannels
Subscribe the given server to the child channels provided. This method will unsubscribe the server from any child channels that the server is currently subscribed to, but that are not included in the list. The user may provide either a list of channel ids (int) or a list of channel labels (string) as input.
Parameters
- string
sessionKey - int
serverId - array
- int
(deprecated)or string - channelId (deprecated) or channelLabel
Returns
- int - 1 on success, exception thrown otherwise.
34.116. Method: setCustomValues
Set custom values for the specified server.
Parameters
- string
sessionKey - int
serverId - struct
Mapof custom labels to custom values- string
custominfo label" - string
value
Returns
- int - 1 on success, exception thrown otherwise.
34.117. Method: setDetails
Set server details. All arguments are optional and will only be modified if included in the struct.
Parameters
- string
sessionKey - int
serverId- ID of server to lookup details for. - struct
serverdetails- string
profile_name- System's profile name - string
base_entitlement- System's base entitlement label. (enterprise_entitled or sw_mgr_entitled) - boolean
auto_errata_update- True if system has auto errata updates enabled - string
description- System description - string
address1- System's address line 1. - string
address2- System's address line 2. - string
city - string
state - string
country - string
building - string
room - string
rack
Returns
- int - 1 on success, exception thrown otherwise.
34.118. Method: setGroupMembership
Set a servers membership in a given group.
Parameters
- string
sessionKey - int
serverId - int
serverGroupId - boolean
member- '1' to assign the given server to the given server group, '0' to remove the given server from the given server group.
Returns
- int - 1 on success, exception thrown otherwise.
34.119. Method: setGuestCpus
Schedule an action of a guest's host, to set that guest's CPU allocation
Parameters
- string
sessionKey - int
sid- The guest's system id - int
numOfCpus- The number of virtual cpus to allocate to the guest
Returns
- int
actionID- the action Id for the schedule action on the host system.
34.120. Method: setGuestMemory
Schedule an action of a guest's host, to set that guest's memory allocation
Parameters
- string
sessionKey - int
sid- The guest's system id - int
memory- The amount of memory to allocate to the guest
Returns
- int
actionID- the action Id for the schedule action on the host system.
34.121. Method: setLockStatus
Set server lock status.
Parameters
- string
sessionKey - int
serverId - boolean
lockStatus- true to lock the system, false to unlock the system.
Returns
- int - 1 on success, exception thrown otherwise.
34.122. Method: setPrimaryInterface
Sets new primary network interface
Parameters
- string
sessionKey - int
serverId - string
interfaceName
Returns
- int - 1 on success, exception thrown otherwise.
34.123. Method: setProfileName
Set the profile name for the server.
Parameters
- string
sessionKey - int
serverId - string
name- Name of the profile.
Returns
- int - 1 on success, exception thrown otherwise.
34.124. Method: setVariables
Sets a list of kickstart variables in the cobbler system record for the specified server. Note: This call assumes that a system record exists in cobbler for the given system and will raise an XMLRPC fault if that is not the case. To create a system record over xmlrpc use system.createSystemRecord To create a system record in the Web UI please go to System - Specified System - Provisioning - Select a Kickstart profile - Create Cobbler System Record.
Parameters
- string
sessionKey - int
serverId - boolean
netboot - array
- struct
kickstartvariable- string
key - string
orint "value"
Returns
- int - 1 on success, exception thrown otherwise.
34.125. Method: tagLatestSnapshot
Tags latest system snapshot
Parameters
- string
sessionKey - int
serverId - string
tagName
Returns
- int - 1 on success, exception thrown otherwise.
34.126. Method: unentitle
Unentitle the system completely
Parameters
- string
systemid- systemid file
Returns
- int - 1 on success, exception thrown otherwise.
34.127. Method: upgradeEntitlement
Adds an entitlement to a given server.
Parameters
- string
sessionKey - int
serverId - string
entitlementName- One of: 'enterprise_entitled', 'provisioning_entitled', 'monitoring_entitled', 'nonlinux_entitled', 'virtualization_host', or 'virtualization_host_platform'.
Returns
- int - 1 on success, exception thrown otherwise.
34.128. Method: whoRegistered
Returns information about the user who registered the system
Parameters
- string
sessionKey - int
sid- Id of the system in question
Returns
- struct
user- int
id - string
login - string
login_uc- upper case version of the login - boolean
enabled- true if user is enabled, false if the user is disabled
Chapter 35. Namespace: system.config
Provides methods to access and modify many aspects of configuration channels and server association. basically system.config name space
35.1. Method: addChannels
Given a list of servers and configuration channels, this method appends the configuration channels to either the top or the bottom (whichever you specify) of a system's subscribed 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 has been previously subscribed by a server, the subscribed channel will be re-ranked to the appropriate place.
Parameters
- string
sessionKey - array
- int - IDs of the systems to add the channels to.
- array
- string - List of configuration channel labels in the ranked order.
- boolean
addToTop- true - to prepend the given channels list to the top of the configuration channels list of a server
- false - to append the given channels list to the bottom of the configuration channels list of a server
Returns
- int - 1 on success, exception thrown otherwise.
35.2. Method: createOrUpdatePath
Create a new file (text or binary) or directory with the given path, or update an existing path on a server.
Parameters
- string
sessionKey - int
serverId - string
path- the configuration file/directory path - boolean
isDir- True - if the path is a directory
- False - if the path is a file
- struct
pathinfo- 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
macro-start-delimiter- Config file macro end 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) - string
selinux_ctx- SeLinux context (optional) - 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)
- int
commitToLocal- 1 - to commit configuration files to the system's local override configuration channel
- 0 - to commit configuration files to the system's sandbox configuration channel
Returns
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
md5 - File's md5 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.
Available since: 10.2
35.3. Method: createOrUpdateSymlink
Create a new symbolic link with the given path, or update an existing path.
Parameters
- string
sessionKey - int
serverId - string
path- the configuration file/directory path - struct
pathinfo- string
target_path- The target path for the symbolic link - string
selinux_ctx- SELinux Security context (optional) - int
revision- next revision number, auto increment for null
- int
commitToLocal- 1 - to commit configuration files to the system's local override configuration channel
- 0 - to commit configuration files to the system's sandbox configuration channel
Returns
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
md5 - File's md5 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.
Available since: 10.2
35.4. Method: deleteFiles
Removes file paths from a local or sandbox channel of a server.
Parameters
- string
sessionKey - int
serverId - array
- string - paths to remove.
- boolean
deleteFromLocal- True - to delete configuration file paths from the system's local override configuration channel
- False - to delete configuration file paths from the system's sandbox configuration channel
Returns
- int - 1 on success, exception thrown otherwise.
35.5. Method: deployAll
Schedules a deploy action for all the configuration files on the given list of systems.
Parameters
- string
sessionKey - array
- int - id of the systems to schedule configuration files deployment
- dateTime.iso8601
date- Earliest date for the deploy action.
Returns
- int - 1 on success, exception thrown otherwise.
35.6. Method: listChannels
List all global configuration channels associated to a system in the order of their ranking.
Parameters
- string
sessionKey - int
serverId
Returns
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
35.7. Method: listFiles
Return the list of files in a given channel.
Parameters
- string
sessionKey - int
serverId - int
listLocal- 1 - to return configuration files in the system's local override configuration channel
- 0 - to return configuration files in the system's sandbox configuration channel
Returns
array
struct
Configuration File information
string
type
- file
- directory
- symlink
string
path - File Path
string
channel_label - the label of the central configuration channel that has this file. Note this entry only shows up if the file has not been overridden by a central channel.
struct
channel_type
struct
Configuration Channel Type information
- int
id - string
label - string
name - int
priority
dateTime.iso8601
last_modified - Last Modified Date
35.8. Method: lookupFileInfo
Given a list of paths and a server, returns details about the latest revisions of the paths.
Parameters
- string
sessionKey - int
serverId - array
- string - paths to lookup on.
- int
searchLocal- 1 - to search configuration file paths in the system's local override configuration or systems subscribed central channels
- 0 - to search configuration file paths in the system's sandbox configuration channel
Returns
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
md5 - File's md5 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.
Available since: 10.2
35.9. Method: removeChannels
Remove config channels from the given servers.
Parameters
- string
sessionKey - array
- int - the IDs of the systems from which you would like to remove configuration channels..
- array
- string - List of configuration channel labels to remove.
Returns
- int - 1 on success, exception thrown otherwise.
35.10. Method: setChannels
Replace the existing set of config channels on the given servers. Channels are ranked according to their order in the configChannelLabels array.
Parameters
- string
sessionKey - array
- int - IDs of the systems to set the channels on.
- array
- string - List of configuration channel labels in the ranked order.
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 36. Namespace: system.crash
Provides methods to access and modify software crash information.
36.1. Method: createCrashNote
Create a crash note
Parameters
- string
sessionKey - int
crashId - string
subject - string
details
Returns
- int - 1 on success, exception thrown otherwise.
36.2. Method: deleteCrash
Delete a crash with given crash id.
Parameters
- string
sessionKey - int
crashId
Returns
- int - 1 on success, exception thrown otherwise.
36.3. Method: deleteCrashNote
Delete a crash note
Parameters
- string
sessionKey - int
crashNoteId
Returns
- int - 1 on success, exception thrown otherwise.
36.4. Method: getCrashCountInfo
Return date of last software crashes report for given system
Parameters
- string
sessionKey - int
serverId
Returns
- struct
CrashCount Information- int
total_count- Total number of software crashes for a system - int
unique_count- Number of unique software crashes for a system - dateTime.iso8601
last_report- Date of the last software crash report
36.5. Method: getCrashFile
Download a crash file.
Parameters
- string
sessionKey - int
crashFileId
Returns
- base64 - base64 encoded crash file.
36.6. Method: getCrashFileUrl
Get a crash file download url.
Parameters
- string
sessionKey - int
crashFileId
Returns
- string - The crash file download url
36.7. Method: getCrashNotesForCrash
List crash notes for crash
Parameters
- string
sessionKey - int
crashId
Returns
- array
- struct
crashNote- int
id - string
subject - string
details - string
updated
36.8. Method: getCrashOverview
Get Software Crash Overview
Parameters
- string
sessionKey
Returns
- array
- struct
crash- string
uuid- Crash UUID - string
component- Package component (set if unique and non empty) - int
crash_count- Number of crashes occurred - int
system_count- Number of systems affected - dateTime.iso8601
last_report- Last crash occurence
36.9. Method: getCrashesByUuid
List software crashes with given UUID
Parameters
- string
sessionKey - string
uuid
Returns
- array
- struct
crash- int
server_id- ID of the server the crash occurred on - string
server_name- Name of the server the crash occurred on - int
crash_id- ID of the crash with given UUID - int
crash_count- Number of times the crash with given UUID occurred - string
crash_component- Crash component - dateTime.iso8601
last_report- Last crash occurence
36.10. Method: listSystemCrashFiles
Return list of crash files for given crash id.
Parameters
- string
sessionKey - int
crashId
Returns
- array
- struct
crashFile- int
id - string
filename - string
path - int
filesize - boolean
is_uploaded - date "created"
- date "modified"
36.11. Method: listSystemCrashes
Return list of software crashes for a system.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
crash- int
id - string
crash - string
path - int
count - string
uuid - string
analyzer - string
architecture - string
cmdline - string
component - string
executable - string
kernel - string
reason - string
username - date "created"
- date "modified"
Chapter 37. Namespace: system.custominfo
Provides methods to access and modify custom system information.
37.1. Method: createKey
Create a new custom key
Parameters
- string
sessionKey - string
keyLabel- new key's label - string
keyDescription- new key's description
Returns
- int - 1 on success, exception thrown otherwise.
37.2. Method: deleteKey
Delete an existing custom key and all systems' values for the key.
Parameters
- string
sessionKey - string
keyLabel- new key's label
Returns
- int - 1 on success, exception thrown otherwise.
37.3. Method: listAllKeys
List the custom information keys defined for the user's organization.
Parameters
- string
sessionKey
Returns
- array
- struct
custominfo- int
id - string
label - string
description - int
system_count - dateTime.iso8601
last_modified
37.4. Method: updateKey
Update description of a custom key
Parameters
- string
sessionKey - string
keyLabel- key to change - string
keyDescription- new key's description
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 38. Namespace: system.provisioning.snapshot
Provides methods to access and delete system snapshots.
38.1. Method: addTagToSnapshot
Adds tag to snapshot
Parameters
- string
sessionKey - int
snapshotId- Id of the snapshot - string
tag- Name of the snapshot tag
Returns
- int - 1 on success, exception thrown otherwise.
38.2. Method: deleteSnapshot
Deletes a snapshot with the given snapshot id
Parameters
- string
sessionKey - int
snapshotId- Id of snapshot to delete
Returns
- int - 1 on success, exception thrown otherwise.
Available since: 10.1
38.3. Method: deleteSnapshots
Deletes all snapshots across multiple systems based on the given date criteria. For example,
- If the user provides startDate only, all snapshots created either on or after the date provided will be removed.
- If user provides startDate and endDate, all snapshots created on or between the dates provided will be removed.
- If the user doesn't provide a startDate and endDate, all snapshots will be removed.
Parameters
- string
sessionKey - struct
datedetails- dateTime.iso8601
startDate- Optional, unless endDate is provided. - dateTime.iso8601
endDate- Optional.
Returns
- int - 1 on success, exception thrown otherwise.
Available since: 10.1
38.4. Method: deleteSnapshots
Deletes all snapshots for a given system based on the date criteria. For example,
- If the user provides startDate only, all snapshots created either on or after the date provided will be removed.
- If user provides startDate and endDate, all snapshots created on or between the dates provided will be removed.
- If the user doesn't provide a startDate and endDate, all snapshots associated with the server will be removed.
Parameters
- string
sessionKey - int
sid- system id of system to delete snapshots for - struct
datedetails- dateTime.iso8601
startDate- Optional, unless endDate is provided. - dateTime.iso8601
endDate- Optional.
Returns
- int - 1 on success, exception thrown otherwise.
Available since: 10.1
38.5. Method: listSnapshotConfigFiles
List the config files associated with a snapshot.
Parameters
- string
sessionKey - int
snapId
Returns
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
md5 - File's md5 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.
Available since: 10.2
38.6. Method: listSnapshotPackages
List the packages associated with a snapshot.
Parameters
- string
sessionKey - int
snapId
Returns
- array
- struct
packagenvera- string
name - string
epoch - string
version - string
release - string
arch
Available since: 10.1
38.7. Method: listSnapshots
List snapshots for a given system. A user may optionally provide a start and end date to narrow the snapshots that will be listed. For example,
- If the user provides startDate only, all snapshots created either on or after the date provided will be returned.
- If user provides startDate and endDate, all snapshots created on or between the dates provided will be returned.
- If the user doesn't provide a startDate and endDate, all snapshots associated with the server will be returned.
Parameters
- string
sessionKey - int
serverId - struct
datedetails- dateTime.iso8601
startDate- Optional, unless endDate is provided. - dateTime.iso8601
endDate- Optional.
Returns
- array
- struct
serversnapshot- int
id - string
reason- the reason for the snapshot's existence - dateTime.iso8601
created - array
channels- string
labelsof channels associated with the snapshot
- array
groups- string
Namesof server groups associated with the snapshot
- array
entitlements- string
Namesof system entitlements associated with the snapshot
- array
config_channels- string
Labelsof config channels the snapshot is associated with.
- array
tags- string
Tagnames associated with this snapshot.
- string
Invalid_reason- If the snapshot is invalid, this is the reason (optional).
Available since: 10.1
38.8. Method: rollbackToSnapshot
Rollbacks server to snapshot
Parameters
- string
sessionKey - int
serverId - int
snapshotId- Id of the snapshot
Returns
- int - 1 on success, exception thrown otherwise.
38.9. Method: rollbackToTag
Rollbacks server to snapshot
Parameters
- string
sessionKey - int
serverId - string
tagName- Name of the snapshot tag
Returns
- int - 1 on success, exception thrown otherwise.
38.10. Method: rollbackToTag
Rollbacks server to snapshot
Parameters
- string
sessionKey - string
tagName- Name of the snapshot tag
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 39. Namespace: system.scap
Provides methods to schedule SCAP scans and access the results.
39.1. Method: deleteXccdfScan
Delete OpenSCAP XCCDF Scan from Spacewalk database. Note that only those SCAP Scans can be deleted which have passed their retention period.
Parameters
- string
sessionKey - int
Idof XCCDF scan (xid).
Returns
- boolean - indicates success of the operation.
39.2. Method: getXccdfScanDetails
Get details of given OpenSCAP XCCDF scan.
Parameters
- string
sessionKey - int
Idof XCCDF scan (xid).
Returns
- struct
OpenSCAPXCCDF Scan- int
xid- XCCDF TestResult id - int
sid- serverId - int
action_id- Id of the parent action. - string
path- Path to XCCDF document - string
oscap_parameters- oscap command-line arguments. - string
test_result- Identifier of XCCDF TestResult. - string
benchmark- Identifier of XCCDF Benchmark. - string
benchmark_version- Version of the Benchmark. - string
profile- Identifier of XCCDF Profile. - string
profile_title- Title of XCCDF Profile. - dateTime.iso8601
start_time- Client machine time of scan start. - dateTime.iso8601
end_time- Client machine time of scan completion. - string
errors- Stderr output of scan. - bool "deletable" - Indicates whether the scan can be deleted.
39.3. Method: getXccdfScanRuleResults
Return a full list of RuleResults for given OpenSCAP XCCDF scan.
Parameters
- string
sessionKey - int
Idof XCCDF scan (xid).
Returns
- array
- struct
OpenSCAPXCCDF RuleResult- string
idref- idref from XCCDF document. - string
result- Result of evaluation. - string
idents- Comma separated list of XCCDF idents.
39.4. Method: listXccdfScans
Return a list of finished OpenSCAP scans for a given system.
Parameters
- string
sessionKey - int
serverId
Returns
- array
- struct
OpenSCAPXCCDF Scan- int
xid- XCCDF TestResult ID - string
profile- XCCDF Profile - string
path- Path to XCCDF document - dateTime.iso8601
completed- Scan completion time
39.5. Method: scheduleXccdfScan
Schedule OpenSCAP scan.
Parameters
- string
sessionKey - array
- int - serverId
- string
Pathto xccdf content on targeted systems. - string
Additionalparameters for oscap tool.
Returns
- int - ID if SCAP action created.
39.6. Method: scheduleXccdfScan
Schedule OpenSCAP scan.
Parameters
- string
sessionKey - array
- int - serverId
- string
Pathto xccdf content on targeted systems. - string
Additionalparameters for oscap tool. - dateTime.iso8601
date- The date to schedule the action
Returns
- int - ID if SCAP action created.
39.7. Method: scheduleXccdfScan
Schedule Scap XCCDF scan.
Parameters
- string
sessionKey - int
serverId - string
Pathto xccdf content on targeted system. - string
Additionalparameters for oscap tool.
Returns
- int - ID of the scap action created.
39.8. Method: scheduleXccdfScan
Schedule Scap XCCDF scan.
Parameters
- string
sessionKey - int
serverId - string
Pathto xccdf content on targeted system. - string
Additionalparameters for oscap tool. - dateTime.iso8601
date- The date to schedule the action
Returns
- int - ID of the scap action created.
Chapter 40. Namespace: system.search
Provides methods to perform system search requests using the search server.
40.1. Method: deviceDescription
List the systems which match the device description.
Parameters
- string
sessionKey - string
searchTerm
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in - string
hostname - string
ip - string
hw_description- hw description if not null - string
hw_device_id- hw device id if not null - string
hw_vendor_id- hw vendor id if not null - string
hw_driver- hw driver if not null
40.2. Method: deviceDriver
List the systems which match this device driver.
Parameters
- string
sessionKey - string
searchTerm
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in - string
hostname - string
ip - string
hw_description- hw description if not null - string
hw_device_id- hw device id if not null - string
hw_vendor_id- hw vendor id if not null - string
hw_driver- hw driver if not null
40.3. Method: deviceId
List the systems which match this device id
Parameters
- string
sessionKey - string
searchTerm
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in - string
hostname - string
ip - string
hw_description- hw description if not null - string
hw_device_id- hw device id if not null - string
hw_vendor_id- hw vendor id if not null - string
hw_driver- hw driver if not null
40.4. Method: deviceVendorId
List the systems which match this device vendor_id
Parameters
- string
sessionKey - string
searchTerm
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in - string
hostname - string
ip - string
hw_description- hw description if not null - string
hw_device_id- hw device id if not null - string
hw_vendor_id- hw vendor id if not null - string
hw_driver- hw driver if not null
40.5. Method: hostname
List the systems which match this hostname
Parameters
- string
sessionKey - string
searchTerm
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in - string
hostname - string
ip - string
hw_description- hw description if not null - string
hw_device_id- hw device id if not null - string
hw_vendor_id- hw vendor id if not null - string
hw_driver- hw driver if not null
40.6. Method: ip
List the systems which match this ip.
Parameters
- string
sessionKey - string
searchTerm
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in - string
hostname - string
ip - string
hw_description- hw description if not null - string
hw_device_id- hw device id if not null - string
hw_vendor_id- hw vendor id if not null - string
hw_driver- hw driver if not null
40.7. Method: nameAndDescription
List the systems which match this name or description
Parameters
- string
sessionKey - string
searchTerm
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in - string
hostname - string
ip - string
hw_description- hw description if not null - string
hw_device_id- hw device id if not null - string
hw_vendor_id- hw vendor id if not null - string
hw_driver- hw driver if not null
40.8. Method: uuid
List the systems which match this UUID
Parameters
- string
sessionKey - string
searchTerm
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in - string
hostname - string
ip - string
hw_description- hw description if not null - string
hw_device_id- hw device id if not null - string
hw_vendor_id- hw vendor id if not null - string
hw_driver- hw driver if not null
Chapter 41. Namespace: systemgroup
Provides methods to access and modify system groups.
41.1. Method: addOrRemoveAdmins
Add or remove administrators to/from the given group. Satellite and Organization administrators are granted access to groups within their organization by default; therefore, users with those roles should not be included in the array provided. Caller must be an organization administrator.
Parameters
- string
sessionKey - string
systemGroupName - array
- string - loginName - User's loginName
- int
add- 1 to add administrators, 0 to remove.
Returns
- int - 1 on success, exception thrown otherwise.
41.2. Method: addOrRemoveSystems
Add/remove the given servers to a system group.
Parameters
- string
sessionKey - string
systemGroupName - array
- int - serverId
- boolean
add- True to add to the group, False to remove.
Returns
- int - 1 on success, exception thrown otherwise.
41.3. Method: create
Create a new system group.
Parameters
- string
sessionKey - string
name- Name of the system group. - string
description- Description of the system group.
Returns
- struct
ServerGroup- int
id - string
name - string
description - int
org_id - int
system_count
41.4. Method: delete
Delete a system group.
Parameters
- string
sessionKey - string
systemGroupName
Returns
- int - 1 on success, exception thrown otherwise.
41.5. Method: getDetails
Retrieve details of a ServerGroup based on it's id
Parameters
- string
sessionKey - int
systemGroupId
Returns
- struct
ServerGroup- int
id - string
name - string
description - int
org_id - int
system_count
41.6. Method: getDetails
Retrieve details of a ServerGroup based on it's name
Parameters
- string
sessionKey - string
systemGroupName
Returns
- struct
ServerGroup- int
id - string
name - string
description - int
org_id - int
system_count
41.7. Method: listActiveSystemsInGroup
Lists active systems within a server group
Parameters
- string
sessionKey - string
systemGroupName
Returns
- array
- int - server_id
41.8. Method: listAdministrators
Returns the list of users who can administer the given group. Caller must be a system group admin or an organization administrator.
Parameters
- string
sessionKey - string
systemGroupName
Returns
- array
- struct
user- int
id - string
login - string
login_uc- upper case version of the login - boolean
enabled- true if user is enabled, false if the user is disabled
41.9. Method: listAllGroups
Retrieve a list of system groups that are accessible by the logged in user.
Parameters
- string
sessionKey
Returns
- array
- struct
ServerGroup- int
id - string
name - string
description - int
org_id - int
system_count
41.10. Method: listGroupsWithNoAssociatedAdmins
Returns a list of system groups that do not have an administrator. (who is not an organization administrator, as they have implicit access to system groups) Caller must be an organization administrator.
Parameters
- string
sessionKey
Returns
- array
- struct
ServerGroup- int
id - string
name - string
description - int
org_id - int
system_count
41.11. Method: listInactiveSystemsInGroup
Lists inactive systems within a server group using a specified inactivity time.
Parameters
- string
sessionKey - string
systemGroupName - int
daysInactive- Number of days a system must not check in to be considered inactive.
Returns
- array
- int - server_id
41.12. Method: listInactiveSystemsInGroup
Lists inactive systems within a server group using the default 1 day threshold.
Parameters
- string
sessionKey - string
systemGroupName
Returns
- array
- int - server_id
41.13. Method: listSystems
Return a list of systems associated with this system group. User must have access to this system group.
Parameters
- string
sessionKey - string
systemGroupName
Returns
- array
- struct
serverdetails- 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 monitoring_entitled, 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)
41.14. Method: listSystemsMinimal
Return a list of systems associated with this system group. User must have access to this system group.
Parameters
- string
sessionKey - string
systemGroupName
Returns
- array
- struct
system- int
id - string
name - dateTime.iso8601
last_checkin- Last time server successfully checked in
41.15. Method: scheduleApplyErrataToActive
Schedules an action to apply errata updates to active systems from a group.
Parameters
- string
sessionKey - string
systemGroupName - array
- int - errataId
Returns
- array
- int - actionId
Available since: 13.0
41.16. Method: scheduleApplyErrataToActive
Schedules an action to apply errata updates to active systems from a group at a given date/time.
Parameters
- string
sessionKey - string
systemGroupName - array
- int - errataId
- dateTime.iso8601
earliestOccurrence
Returns
- array
- int - actionId
Available since: 13.0
41.17. Method: update
Update an existing system group.
Parameters
- string
sessionKey - string
systemGroupName - string
description
Returns
- struct
ServerGroup- int
id - string
name - string
description - int
org_id - int
system_count
Chapter 42. Namespace: user.external
If you are using IPA integration to allow authentication of users from an external IPA server (rare) the users will still need to be created in the Satellite database. Methods in this namespace allow you to configure some specifics of how this happens, like what organization they are created in or what roles they will have. These options can also be set in the web admin interface.
42.1. Method: createExternalGroupToRoleMap
Externally authenticated users may be members of external groups. You can use these groups to assign additional roles to the users when they log in. Can only be called by a satellite_admin.
Parameters
- string
sessionKey - string
name- Name of the external group. Must be unique. - array
- string - role - Can be any of: satellite_admin, org_admin (implies all other roles except for satellite_admin), channel_admin, config_admin, system_group_admin, activation_key_admin, or monitoring_admin.
Returns
- struct
externalGroup- string
name - array
roles- string
role
42.2. Method: createExternalGroupToSystemGroupMap
Externally authenticated users may be members of external groups. You can use these groups to give access to server groups to the users when they log in. Can only be called by an org_admin.
Parameters
- string
sessionKey - string
name- Name of the external group. Must be unique. - array
- string - groupName - The names of the server groups to grant access to.
Returns
- struct
externalGroup- string
name - array
roles- string
role
42.3. Method: deleteExternalGroupToRoleMap
Delete the role map for an external group. Can only be called by a satellite_admin.
Parameters
- string
sessionKey - string
name- Name of the external group.
Returns
- int - 1 on success, exception thrown otherwise.
42.4. Method: deleteExternalGroupToSystemGroupMap
Delete the server group map for an external group. Can only be called by an org_admin.
Parameters
- string
sessionKey - string
name- Name of the external group.
Returns
- int - 1 on success, exception thrown otherwise.
42.5. Method: getDefaultOrg
Get the default org that users should be added in if orgunit from IPA server isn't found or is disabled. Can only be called by a satellite_admin.
Parameters
- string
sessionKey
Returns
- int - Id of the default organization. 0 if there is no default.
42.6. Method: getExternalGroupToRoleMap
Get a representation of the role mapping for an external group. Can only be called by a satellite_admin.
Parameters
- string
sessionKey - string
name- Name of the external group.
Returns
- struct
externalGroup- string
name - array
roles- string
role
42.7. Method: getExternalGroupToSystemGroupMap
Get a representation of the server group mapping for an external group. Can only be called by an org_admin.
Parameters
- string
sessionKey - string
name- Name of the external group.
Returns
- struct
externalGroup- string
name - array
roles- string
role
42.8. Method: getKeepTemporaryRoles
Get whether we should keeps roles assigned to users because of their IPA groups even after they log in through a non-IPA method. Can only be called by a satellite_admin.
Parameters
- string
sessionKey
Returns
- boolean - True if we should keep roles after users log in through non-IPA method, false otherwise.
42.9. Method: getUseOrgUnit
Get whether we place users into the organization that corresponds to the "orgunit" set on the IPA server. The orgunit name must match exactly the Satellite organization name. Can only be called by a satellite_admin.
Parameters
- string
sessionKey
Returns
- boolean - True if we should use the IPA orgunit to determine which organization to create the user in, false otherwise.
42.10. Method: listExternalGroupToRoleMaps
List role mappings for all known external groups. Can only be called by a satellite_admin.
Parameters
- string
sessionKey
Returns
- array
- struct
externalGroup- string
name - array
roles- string
role
42.11. Method: listExternalGroupToSystemGroupMaps
List server group mappings for all known external groups. Can only be called by an org_admin.
Parameters
- string
sessionKey
Returns
- array
- struct
externalGroup- string
name - array
roles- string
role
42.12. Method: setDefaultOrg
Set the default org that users should be added in if orgunit from IPA server isn't found or is disabled. Can only be called by a satellite_admin.
Parameters
- string
sessionKey - int
defaultOrg- Id of the organization to set as the default org. 0 if there should not be a default organization.
Returns
- int - 1 on success, exception thrown otherwise.
42.13. Method: setExternalGroupRoles
Update the roles for an external group. Replace previously set roles with the ones passed in here. Can only be called by a satellite_admin.
Parameters
- string
sessionKey - string
name- Name of the external group. - array
- string - role - Can be any of: satellite_admin, org_admin (implies all other roles except for satellite_admin), channel_admin, config_admin, system_group_admin, activation_key_admin, or monitoring_admin.
Returns
- int - 1 on success, exception thrown otherwise.
42.14. Method: setExternalGroupSystemGroups
Update the server groups for an external group. Replace previously set server groups with the ones passed in here. Can only be called by an org_admin.
Parameters
- string
sessionKey - string
name- Name of the external group. - array
- string - groupName - The names of the server groups to grant access to.
Returns
- int - 1 on success, exception thrown otherwise.
42.15. Method: setKeepTemporaryRoles
Set whether we should keeps roles assigned to users because of their IPA groups even after they log in through a non-IPA method. Can only be called by a satellite_admin.
Parameters
- string
sessionKey - boolean
keepRoles- True if we should keep roles after users log in through non-IPA method, false otherwise.
Returns
- int - 1 on success, exception thrown otherwise.
42.16. Method: setUseOrgUnit
Set whether we place users into the organization that corresponds to the "orgunit" set on the IPA server. The orgunit name must match exactly the Satellite organization name. Can only be called by a satellite_admin.
Parameters
- string
sessionKey - boolean
useOrgUnit- True if we should use the IPA orgunit to determine which organization to create the user in, false otherwise.
Returns
- int - 1 on success, exception thrown otherwise.
Chapter 43. Namespace: user
User namespace contains methods to access common user functions available from the web user interface.
43.1. Method: addAssignedSystemGroup
Add system group to user's list of assigned system groups.
Parameters
- string
sessionKey - string
login- User's login name. - string
serverGroupName - boolean
setDefault- Should system group also be added to user's list of default system groups.
Returns
- int - 1 on success, exception thrown otherwise.
43.2. Method: addAssignedSystemGroups
Add system groups to user's list of assigned system groups.
Parameters
- string
sessionKey - string
login- User's login name. - array
- string - serverGroupName
- boolean
setDefault- Should system groups also be added to user's list of default system groups.
Returns
- int - 1 on success, exception thrown otherwise.
43.3. Method: addDefaultSystemGroup
Add system group to user's list of default system groups.
Parameters
- string
sessionKey - string
login- User's login name. - string
serverGroupName
Returns
- int - 1 on success, exception thrown otherwise.
43.4. Method: addDefaultSystemGroups
Add system groups to user's list of default system groups.
Parameters
- string
sessionKey - string
login- User's login name. - array
- string - serverGroupName
Returns
- int - 1 on success, exception thrown otherwise.
43.5. Method: addRole
Adds a role to a user.
Parameters
- string
sessionKey - string
login- User login name to update. - string
role- Role label to add. Can be any of: satellite_admin, org_admin, channel_admin, config_admin, system_group_admin, activation_key_admin, or monitoring_admin.
Returns
- int - 1 on success, exception thrown otherwise.
43.6. Method: create
Create a new user.
Parameters
- string
sessionKey - string
desiredLogin- Desired login name, will fail if already in use. - string
desiredPassword - string
firstName - string
lastName - string
email- User's e-mail address.
Returns
- int - 1 on success, exception thrown otherwise.
43.7. Method: create
Create a new user.
Parameters
- string
sessionKey - string
desiredLogin- Desired login name, will fail if already in use. - string
desiredPassword - string
firstName - string
lastName - string
email- User's e-mail address. - int
usePamAuth- 1 if you wish to use PAM authentication for this user, 0 otherwise.
Returns
- int - 1 on success, exception thrown otherwise.
43.8. Method: delete
Delete a user.
Parameters
- string
sessionKey - string
login- User login name to delete.
Returns
- int - 1 on success, exception thrown otherwise.
43.9. Method: disable
Disable a user.
Parameters
- string
sessionKey - string
login- User login name to disable.
Returns
- int - 1 on success, exception thrown otherwise.
43.10. Method: enable
Enable a user.
Parameters
- string
sessionKey - string
login- User login name to enable.
Returns
- int - 1 on success, exception thrown otherwise.
43.11. Method: getCreateDefaultSystemGroup
Returns the current value of the CreateDefaultSystemGroup setting. If True this will cause there to be a system group created (with the same name as the user) every time a new user is created, with the user automatically given permission to that system group and the system group being set as the default group for the user (so every time the user registers a system it will be placed in that system group by default). This can be useful if different users will administer different groups of servers in the same organization. Can only be called by an org_admin.
Parameters
- string
sessionKey
Returns
- int - 1 on success, exception thrown otherwise.
43.12. Method: getDetails
Returns the details about a given user.
Parameters
- string
sessionKey - string
login- User's login name.
Returns
- struct
userdetails- string
first_names- deprecated, use first_name - string
first_name - string
last_name - string
email - int
org_id - string
org_name - string
prefix - string
last_login_date - string
created_date - boolean
enabled- true if user is enabled, false if the user is disabled - boolean
use_pam- true if user is configured to use PAM authentication - boolean
read_only- true if user is readonly - boolean
errata_notification- true if errata e-mail notification is enabled for the user
43.13. Method: getLoggedInTime
Returns the time user last logged in.
Parameters
- string
sessionKey - string
login- User's login name.
Returns
- dateTime.iso8601
43.14. Method: listAssignableRoles
Returns a list of user roles that this user can assign to others.
Parameters
- string
sessionKey
Returns
- array
- string - (role label)
43.15. Method: listAssignedSystemGroups
Returns the system groups that a user can administer.
Parameters
- string
sessionKey - string
login- User's login name.
Returns
- array
- struct
systemgroup- int
id - string
name - string
description - int
system_count - int
org_id- Organization ID for this system group.
43.16. Method: listDefaultSystemGroups
Returns a user's list of default system groups.
Parameters
- string
sessionKey - string
login- User's login name.
Returns
- array
- struct
systemgroup- int
id - string
name - string
description - int
system_count - int
org_id- Organization ID for this system group.
43.17. Method: listRoles
Returns a list of the user's roles.
Parameters
- string
sessionKey - string
login- User's login name.
Returns
- array
- string - (role label)
43.18. Method: listUsers
Returns a list of users in your organization.
Parameters
- string
sessionKey
Returns
- array
- struct
user- int
id - string
login - string
login_uc- upper case version of the login - boolean
enabled- true if user is enabled, false if the user is disabled
43.19. Method: removeAssignedSystemGroup
Remove system group from the user's list of assigned system groups.
Parameters
- string
sessionKey - string
login- User's login name. - string
serverGroupName - boolean
setDefault- Should system group also be removed from the user's list of default system groups.
Returns
- int - 1 on success, exception thrown otherwise.
43.20. Method: removeAssignedSystemGroups
Remove system groups from a user's list of assigned system groups.
Parameters
- string
sessionKey - string
login- User's login name. - array
- string - serverGroupName
- boolean
setDefault- Should system groups also be removed from the user's list of default system groups.
Returns
- int - 1 on success, exception thrown otherwise.
43.21. Method: removeDefaultSystemGroup
Remove a system group from user's list of default system groups.
Parameters
- string
sessionKey - string
login- User's login name. - string
serverGroupName
Returns
- int - 1 on success, exception thrown otherwise.
43.22. Method: removeDefaultSystemGroups
Remove system groups from a user's list of default system groups.
Parameters
- string
sessionKey - string
login- User's login name. - array
- string - serverGroupName
Returns
- int - 1 on success, exception thrown otherwise.
43.23. Method: removeRole
Remove a role from a user.
Parameters
- string
sessionKey - string
login- User login name to update. - string
role- Role label to remove. Can be any of: satellite_admin, org_admin, channel_admin, config_admin, system_group_admin, activation_key_admin, or monitoring_admin.
Returns
- int - 1 on success, exception thrown otherwise.
43.24. Method: setCreateDefaultSystemGroup
Sets the value of the CreateDefaultSystemGroup setting. If True this will cause there to be a system group created (with the same name as the user) every time a new user is created, with the user automatically given permission to that system group and the system group being set as the default group for the user (so every time the user registers a system it will be placed in that system group by default). This can be useful if different users will administer different groups of servers in the same organization. Can only be called by an org_admin.
Parameters
- string
sessionKey - boolean
createDefaultSystemGruop- True if we should automatically create system groups, false otherwise.
Returns
- int - 1 on success, exception thrown otherwise.
43.25. Method: setDetails
Updates the details of a user.
Parameters
- string
sessionKey - string
login- User's login name. - struct
userdetails- string
first_names- deprecated, use first_name - string
first_name - string
last_name - string
email - string
prefix - string
password
Returns
- int - 1 on success, exception thrown otherwise.
43.26. Method: setErrataNotifications
Enables/disables errata mail notifications for a specific user.
Parameters
- string
sessionKey - string
login- User's login name. - boolean
value- True for enabling errata notifications, False for disabling
Returns
- int - 1 on success, exception thrown otherwise.
43.27. Method: setReadOnly
Sets whether the target user should have only read-only API access or standard full scale access.
Parameters
- string
sessionKey - string
login- User's login name. - boolean
readOnly- Sets whether the target user should have only read-only API access or standard full scale access.
Returns
- int - 1 on success, exception thrown otherwise.
43.28. Method: usePamAuthentication
Toggles whether or not a user uses PAM authentication or basic RHN authentication.
Parameters
- string
sessionKey - string
login- User's login name. - int
pam_value- 1 to enable PAM authentication
- 0 to disable.
Returns
- int - 1 on success, exception thrown otherwise.
Appendix A. Revision History
| Revision History | ||||
|---|---|---|---|---|
| Revision 2.0-11 | Thu Aug 20 2015 | |||
| ||||
| Revision 2.0-10 | Tue Aug 11 2015 | |||
| ||||
| Revision 2.0-9 | Wed May 27 2015 | |||
| ||||
| Revision 2.0-8 | Tue Apr 7 2015 | |||
| ||||
| Revision 2.0-7 | Mon Apr 6 2015 | |||
| ||||
| Revision 2.0-6 | Tue Feb 17 2015 | |||
| ||||
| Revision 2.0-5 | Tue Feb 3 2015 | |||
| ||||
| Revision 2.0-4 | Wed Jan 7 2015 | |||
| ||||
| Revision 2.0-3 | Thu Jan 1 2015 | |||
| ||||
| Revision 2.0-2 | Mon Dec 8 2014 | |||
| ||||
| Revision 2.0-1 | Fri Nov 7 2014 | |||
| ||||
| Revision 1.0-15 | Fri Sep 27 2013 | |||
| ||||
| Revision 1.0-14 | Mon Sep 23 2013 | |||
| ||||
| Revision 1.0-13 | Tue Sep 10 2013 | |||
| ||||
| Revision 1.0-12 | Wed Sep 4 2013 | |||
| ||||
| Revision 1.0-11 | Wed Sep 4 2013 | |||
| ||||
| Revision 1.0-10 | Wed Sep 4 2013 | |||
| ||||
| Revision 1.0-9 | Thu Aug 29 2013 | |||
| ||||
| Revision 1.0-8 | Sun Jul 28 2013 | |||
| ||||
| Revision 1.0-7 | Wed Jul 24 2013 | |||
| ||||
| Revision 1.0-6 | Tue Jul 23 2013 | |||
| ||||
| Revision 1.0-5 | Wed Jul 3 2013 | |||
| ||||
| Revision 1.0-4 | Wed Jul 3 2013 | |||
| ||||
| Revision 1.0-3 | Wed Jul 3 2013 | |||
| ||||
| Revision 1.0-2 | Wed Jul 3 2013 | |||
| ||||
| Revision 1.0-1 | Wed Jul 3 2013 | |||
| ||||
| Revision 1.0-0 | Wed Jul 3 2013 | |||
| ||||
Legal Notice
Copyright © 2014 Red Hat.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
