Red Hat Training

A Red Hat training course is available for Red Hat Satellite

API Overview

Red Hat Satellite 5.6

A reference guide to the Red Hat Satellite API

Edition 1

Daniel Macpherson

Red Hat Engineering Content Services

dmacpher@redhat.com

Legal Notice

Abstract

This book acts as a reference for the XML-RPC API for Red Hat Satellite. It contains a short introduction to XML-RPC, examples, and a full references all Red Hat Satellite API methods.

Preface

Red Hat Network (https://access.redhat.com/home) provides system-level support and management of Red Hat systems and networks. It brings together the tools, services, and information repositories needed to maximize the reliability, security, and performance of Red Hat systems. To use Red Hat Network, system administrators register software and hardware profiles, known as System Profiles, of their client systems with Red Hat Network. When a client system requests package updates, only the applicable packages for the client are returned.

Red Hat Satellite allows organizations to use the benefits of Red Hat Network without having to provide public Internet access to their servers or other client systems. System profiles are stored locally on the Satellite server. The Satellite website is served from a local web server and is only accessible to systems that can reach the Satellite server. All package management tasks, including errata updates, are performed through the Satellite server.

Red Hat Satellite provides a solution for organizations that require absolute control over and privacy of the maintenance and package deployment of their servers. It allows Red Hat Network customers the greatest flexibility and power in keeping systems secure and updated. Modules can be added to the Satellite server to provide extra functionality.

1. About This Guide

This guide explains how to use the Red Hat Satellite XML-RPC API.

2. Audience

The target audience for this guide includes developers and system administrators who aim to integrate and manage Red Hat Satellite with external clients and products.

Part I. Introduction

Chapter 1. Introduction to the Red Hat Satellite API

Red Hat Satellite provides organizations with the benefits of Red Hat Network without the need for public Internet access for servers or client systems. In addition, users of Red Hat Satellite can:

Maintain complete control and privacy over package management and server maintenance within their own networks;
Store System Profiles on a Satellite server, which connect to the Red Hat Network website via a local web server; and,
Perform package management tasks, including errata updates, through the local area network.

This gives Red Hat Network customers the greatest flexibility and power to keep servers secure and up-to-date.

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 documentation acts as a reference to the Red Hat Satellite XML-RPC API. It 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.

Chapter 2. Using XML-RPC with the Red Hat Satellite API

XML-RPC uses HTTP to send an XML-encoded request to a server. The request contains the following:

Namespace: A namespace is a grouping of methods based upon a particular function, object or resource. For example, the auth namespace groups authentication function, or the errata namespace groups function that control errata.
Method: A method represents a certain action. Each method controls a specific function of the Red Hat Satellite. For example, the login method in the auth namespace logs a user into Red Hat Satellite and returns a session key.
Parameter: A parameter is a piece of input to control specific aspects of a method. For example, the login method in the auth namespace requires username and password parameters to specify the login details of a certain user. The login method also accepts an optional duration parameter to specify the length of time until the user session expires..

The XML-encoded request usually appears in the following structure:

<methodCall>
  <methodName>namespace.method</methodName>
  <params>
    <param>
      <value><name>parameter</name></value>
    </param>
    <param>
      <value><name>parameter</name></value>
    </param>
    ...
  </params>
</methodCall>

For example, use the following XML-RPC request to retrieve a list of all Red Hat Satellite API namespaces:

<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 Part II, “Examples”.

For more information about XML-RPC, see http://www.xmlrpc.com/.

Part II. Examples

Chapter 3. Examples

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

3.1. Perl Example

This Perl example shows the system.listUserSystems call being used to get a list of systems a user has access. The example prints the name of each system. The Frontier::Client Perl module is found in the perl-Frontier-RPC RPM.

#!/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);

3.2. Python Example

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)

3.3. Ruby example

The following example demostrates 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 III. Reference

Chapter 4. Namespace: activationkey

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

Namespace: activationkey

4.1. Method: addChildChannels

Description

Add child channels to an activation key.

Parameters

The following parameters are available for this method:

string sessionKey
string key
array:
- string - childChannelLabel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.2. Method: addConfigChannels

Description

When 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 remains maintained while adding. If one of the configuration channels in the 'add' list already exists in an activation key, the configuration channel's ranking moves to the appropriate place.

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.3. Method: addEntitlements

Description

Add entitlements to an activation key. Currently only add-on entitlements are permitted e.g. monitoring_entitled, provisioning_entitled, virtualization_host, virtualization_host_platform.

Parameters

The following parameters are available for this method:

string sessionKey
string key
array:
- string - entitlement label
  - monitoring_entitled
  - provisioning_entitled
  - virtualization_host
  - virtualization_host_platform

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.4. Method: addPackageNames

Description

Add packages to an activation key using package name only.

Note

This method is deprecated. Use the addPackages (string sessionKey, string key, array[packages]) method.

Parameters

The following parameters are available for this method:

string sessionKey
string key
array:
- string - packageName

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

Available since: 10.2

4.5. Method: addPackages

Description

Add packages to an activation key.

Parameters

The following parameters are available for this method:

string sessionKey
string key
array:
- struct - packages
  - string name - Package name
  - string arch - Architecture label (Optional)

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.6. Method: addServerGroups

Description

Add server groups to an activation key.

Parameters

The following parameters are available for this method:

string sessionKey
string key
array:
- int - serverGroupId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.7. Method: checkConfigDeployment

Description

Check configuration file deployment status for the activation key specified.

Parameters

The following parameters are available for this method:

string sessionKey
string key

Returns

The following return values are available for this method:

1 if enabled, 0 if disabled, exception thrown otherwise.

4.8. Method: create

Description

Create a new activation key. The passed activation key parameter is prefixed with the organization ID. This value is returned from the create call. For example, if the caller passes in the key foo and adds to an organization with the ID 100, the actual activation key will be 100-foo. This allows setting a usage limit on this activation key. If unlimited usage is desired, use a create method that does not include this parameter.

Parameters

The following parameters are available for this method:

string sessionKey
string key - Leave empty to have new key generated.
string description
string baseChannelLabel - Leave empty to accept default.
int usageLimit - If unlimited usage is desired, use a create method that does not include this parameter.
array:
- string - Add-on entitlement label to associate with the key.
  - monitoring_entitled
  - provisioning_entitled
  - virtualization_host
  - virtualization_host_platform
boolean universalDefault

Returns

The following return values are available for this method:

string - The new activation key.

4.9. Method: delete

Description

Delete an activation key.

Parameters

The following parameters are available for this method:

string sessionKey
string key

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.10. Method: disableConfigDeployment

Description

Disable configuration file deployment for the specified activation key.

Parameters

The following parameters are available for this method:

string sessionKey
string key

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.11. Method: enableConfigDeployment

Description

Enable configuration file deployment for the specified activation key.

Parameters

The following parameters are available for this method:

string sessionKey
string key

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.12. Method: getDetails

Description

View an activation key's details.

Parameters

The following parameters are available for this method:

string sessionKey
string key

Returns

The following return values are available for this method:

struct - activation key
- string key
- string description
- int usage_limit
- string base_channel_label
- array child_channel_labels
  - string childChannelLabel
- array entitlements
  - string entitlementLabel
- array server_group_ids
  - string serverGroupId
- array package_names
  - string packageName - deprecated by packages
- array packages
  - struct - package
    string name - package name
    string arch - architecture label (optional0
- boolean universal_default
- boolean disabled

Available since:10.2

4.13. Method: listActivatedSystems

Description

List the systems activated with the key provided.

Parameters

The following parameters are available for this method:

string sessionKey
string key

Returns

The following return values are available for this method:

array:
- struct - system structure
  - int id - System id
  - string hostname
  - dateTime.iso8601 last_checkin - Last time server successfully checked in

4.14. Method: listActivationKeys

Description

List activation keys that are visible to the user.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - activation key
  - string key
  - string description
  - int usage_limit
  - string base_channel_label
  - array child_channel_labels
    string childChannelLabel
  - array entitlements
    string entitlementLabel
  - array server_group_ids
    string serverGroupId
  - array package_names
    string packageName - deprecated by packages
  - array packages
    struct - package
    string name - package name
    string arch - architecture label (optional)
  - boolean universal_default
  - boolean disabled

Available since:10.2

4.15. Method: listConfigChannels

Description

List configuration channels associated to an activation key.

Parameters

The following parameters are available for this method:

string sessionKey
string key

Returns

The following return values are available for this method:

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.16. Method: removeChildChannels

Description

Remove child channels from an activation key.

Parameters

The following parameters are available for this method:

string sessionKey
string key
array:
- string - childChannelLabel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.17. Method: removeConfigChannels

Description

Remove configuration channels from the given activation keys.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- string - activationKey
array:
- string - configChannelLabel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.18. Method: removeEntitlements

Description

Remove entitlements (by label) from an activation key. Currently only add-on entitlements are permitte e.g. monitoring_entitled, provisioning_entitled, virtualization_host, virtualization_host_platform.

Parameters

The following parameters are available for this method:

string sessionKey
string key
array:
- string - entitlementlabel
  - monitoring_entitled
  - provisioning_entitled
  - virtualization_host
  - virtualization_host_platform

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.19. Method: removePackageNames

Description

Remove package names from an activation key.

Note

This method is deprecated. Use the removePackages(string sessionKey, string key, array[packages])

Parameters

The following parameters are available for this method:

string sessionKey
string key
array:
- string - packageName

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

Available since: 10.2

4.20. Method: removePackages

Description

Remove package names from an activation key.

Parameters

The following parameters are available for this method:

string sessionKey
string key
array:
- struct - packages
  - string name - Package name
  - string arch - Architecture label (optional)

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.21. Method: removeServerGroups

Description

Remove server groups from an activation key.

Parameters

The following parameters are available for this method:

string sessionKey
string key
array:
- int - serverGroupId

Returns

The following return values are available for this method:

int - 1on success, exception thrown otherwise.

4.22. Method: setConfigChannels

Description

Replace the existing set of configuration channels on the given activation keys. Channels are ranked by their order in the array.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- string - activationKey
array:
- string - configChannelLabel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

4.23. Method: setDetails

Description

Update the details of an activation key.

Parameters

The following parameters are available for this method:

string sessionKey
string key
struct - activation key
- string description (optional)
- string base_channel_label (optional)
- 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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

Chapter 5. Namespace: api

Methods providing information about the API.

Namespace: api

5.1. Method: getApiCallList

Description

Lists all available API calls grouped by namespace.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

struct - method_info
- string name - method name
- string parameters - method parameters
- string exceptions - method exceptions
- string return - method return type

5.2. Method: getApiNamespaceCallList

Description

Lists all available API calls for the specified namespace.

Parameters

The following parameters are available for this method:

string sessionKey
string namespace

Returns

The following return values are available for this method:

struct - method_info
- string name - method name
- string parameters - method parameters
- string exceptions - method exceptions
- string return - method return type

5.3. Method: getApiNamespaces

Description

Lists available API namespaces.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

struct - namespace
- string namespace - API namespace
- string handler - API Handler

5.4. Method: getVersion

Description

Returns the version of the API. Since Satellite 5.3 it is no longer related to server version.

Returns

The following return values are available for this method:

string - the API version

5.5. Method: systemVersion

Description

Returns the server version.

Returns

The following return values are available for this method:

string - the server version

Chapter 6. Namespace: auth

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

Namespace: auth

6.1. Method: login

Description

Parameters

The following parameters are available for this method:

string username
string password
int duration - length of session (optional)

Returns

The following return values are available for this method:

string sessionKey

6.2. Method: logout

Description

Logout the user with the given session key.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

Chapter 7. Namespace: channel

Provides method to get back a list of Software Channels.

Namespace: channel

7.1. Method: listAllChannels

Description

List all software channels the user's organization is entitled.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - channel info
  - int id
  - string label
  - string name
  - string provider_name
  - int packages
  - int systems
  - string arch_name

7.2. Method: listMyChannels

Description

List all software channels that belong to the user's organization.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - channel info
  - int id
  - string label
  - string name
  - string provider_name
  - int packages
  - int systems
  - string arch_name

7.3. Method: listPopularChannels

Description

List the most popular software channels. This returns the channels with the number of systems subscribed as specified by the popularity count.

Parameters

The following parameters are available for this method:

string sessionKey
int popularityCount

Returns

The following return values are available for this method:

array:
- struct - channel info
  - int id
  - string label
  - string name
  - string provider_name
  - int packages
  - int systems
  - string arch_name

7.4. Method: listRedHatChannels

Description

List all Red Hat software channels the user's organization is entitled.

Note

This method is deprecated. Use the listVendorChannels(String sessionKey) method.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - channel info
  - int id
  - string label
  - string name
  - string provider_name
  - int packages
  - int systems
  - string arch_name

7.5. Method: listRetiredChannels

Description

List all retired software channels. These are channels the user's organization is entitled but are no longer supported because they have reached their end-of-life date.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - channel info
  - int id
  - string label
  - string name
  - string provider_name
  - int packages
  - int systems
  - string arch_name

7.6. Method: listSharedChannels

Description

List all software channels the user's organization may share.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - channel info
  - int id
  - string label
  - string name
  - string provider_name
  - int packages
  - int systems
  - string arch_name

7.7. Method: listSoftwareChannels

Description

List all visible software channels.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - channel
  - string label
  - string name
  - string parent_label
  - string end_of_life
  - string arch

7.8. Method: listVendorChannels

Description

Lists all the vendor software channels the user's organization is entitled.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - channel info
  - 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.

Namespace: channel.access

8.1. Method: disableUserRestrictions

Description

Disable user restrictions for the given channel. If disabled, all users within the organization may subscribe to the channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - label of the channel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

8.2. Method: enableUserRestrictions

Description

Enable user restrictions for the given channel. If enabled, only selected users within the organization may subscribe to the channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - label of the channel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

8.3. Method: getOrgSharing

Description

Get organization sharing access control.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - label of the channel

Returns

The following return values are available for this method:

string - The access value (one of the following: public, private, or protected.

8.4. Method: setOrgSharing

Description

Set organization sharing access control.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - label of the channel
string access - Access one of the following: public, private, or protected.

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

Chapter 9. Namespace: channel.org

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

Namespace: channel.org

9.1. Method: disableAccess

Description

Disable access to the channel for the given organization.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - label of the channel
int orgId - ID of organization with disabled access

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

9.2. Method: enableAccess

Description

Enable access to the channel for the given organization.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - label of the channel
int orgId - ID of organization granted access

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

9.3. Method: list

Description

List the organizations associated with the given channel that may be trusted.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - label of the channel

Returns

The following return values are available for this method:

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.

Namespace: channel.software

10.1. Method: addPackages

Description

Adds a given list of packages to the given channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - target channel
array:
- int - packageId - ID of a package to add to the channel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.2. Method: addRepoFilter

Description

Adds a filter for a given repo.

Parameters

The following parameters are available for this method:

string sessionKey
string label - repository label
struct - filter_map
- string filter - string to filter on
- string flag - plus (+) for include, minus (-) for exclude

Returns

The following return values are available for this method:

int sort - order for new filter

10.3. Method: associateRepo

Description

Associates a repository with a channel

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel label
string repoLabel - repository label

Returns

The following return values are available for this method:

struct - channel
int id
string name
string label
string arch_name
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

Description

Returns the number of available subscriptions for the given channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query

Returns

The following return values are available for this method:

int number of available subscriptions for the given channel

10.5. Method: clearRepoFilters

Description

Removes the filters for a repo.

Parameters

The following parameters are available for this method:

string sessionKey
string label - repository label

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.6. Method: clone

Description

Clone a channel. If arch_label is omitted, the architecture label of the original channel is used. If parent_label is omitted, the clone becomes a base channel.

Parameters

The following parameters are available for this method:

string sessionKey
string original_label
struct - channel details
- string name
- string label
- string summary
- string parent_label (optional)
- string arch_label (optional)
- string gpg_key_url (optional) - gpg_url can be used too
- string gpg_key_id - (optional), gpg_id can be used too
- string gpg_key_fp - (optional), gpg_fingerprint can be used too
- string description - (optional)
boolean original_state

Returns

The following return values are available for this method:

int - the cloned channel ID

10.7. Method: create

Description

Creates a software channel.

Parameters

The following parameters are available for this method:

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 for the channel.
- channel-ia32 - For 32 bit channel architecture
- channel-ia64 - For 64 bit channel architecture
- channel-sparc - For Sparc channel architecture
- channel-alpha - For Alpha channel architecture
- channel-s390 - For s390 channel architecture
- channel-s390x - For s390x channel architecture
- channel-iSeries - For i-Series channel architecture
- channel-pSeries - For p-Series channel architecture
- channel-x86_64 - For x86_64 channel architecture
- channel-ppc - For PPC channel architecture
- channel-sparc-sun-solaris - For Sparc Solaris channel architecture
- channel-i386-sun-solaris - For i386 Solaris channel architecture
string parentLabel - label of the parent of this channel or 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 e.g. Red Hat Enterprise Linux 6 and newer.
struct - gpgKey
- string url - GPG key URL
- string id - GPG key ID
- string fingerprint - GPG key Fingerprint

Returns

The following return values are available for this method:

int - 1 if the creation operation succeeded, 0 otherwise

Available since: 10.9

10.8. Method: create

Description

Creates a software channel.

Parameters

The following parameters are available for this method:

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 for the channel.
- channel-ia32 - For 32 bit channel architecture
- channel-ia64 - For 64 bit channel architecture
- channel-sparc - For Sparc channel architecture
- channel-alpha - For Alpha channel architecture
- channel-s390 - For s390 channel architecture
- channel-s390x - For s390x channel architecture
- channel-iSeries - For i-Series channel architecture
- channel-pSeries - For p-Series channel architecture
- channel-x86_64 - For x86_64 channel architecture
- channel-ppc - For PPC channel architecture
- channel-sparc-sun-solaris - For Sparc Solaris channel architecture
- channel-i386-sun-solaris - For i386 Solaris channel architecture
string parentLabel - label of the parent of this channel or 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 e.g. Red Hat Enterprise Linux 6 and newer.

Returns

The following return values are available for this method:

int - 1 if the creation operation succeeded, 0 otherwise

Available since: 10.9

10.9. Method: create

Description

Creates a software channel

Parameters

The following parameters are available for this method:

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 for the channel.
- channel-ia32 - For 32 bit channel architecture
- channel-ia64 - For 64 bit channel architecture
- channel-sparc - For Sparc channel architecture
- channel-alpha - For Alpha channel architecture
- channel-s390 - For s390 channel architecture
- channel-s390x - For s390x channel architecture
- channel-iSeries - For i-Series channel architecture
- channel-pSeries - For p-Series channel architecture
- channel-x86_64 - For x86_64 channel architecture
- channel-ppc - For PPC channel architecture
- channel-sparc-sun-solaris - For Sparc Solaris channel architecture
- channel-i386-sun-solaris - For i386 Solaris channel architecture
string parentLabel - label of the parent of this channel or an empty string if it does not have one

Returns

The following return values are available for this method:

int - 1 if the creation operation succeeded, 0 otherwise

10.10. Method: createRepo

Description

Creates a repository

Parameters

The following parameters are available for this method:

string sessionKey
string label - repository label
string type - repository type (only YUM is supported)
string url - repository url

Returns

The following return values are available for this method:

struct - channel
- int id
- string label
- string sourceUrl
- string type

10.11. Method: delete

Description

Deletes a custom software channel

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to delete

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.12. Method: disassociateRepo

Description

Disassociates a repository from a channel

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel label
string repoLabel - repository label

Returns

The following return values are available for this method:

struct - channel
int id
string name
string label
string arch_name
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

Description

Returns the last build date of the repomd.xml file for the given channel as a localised string.

Parameters

The following parameters are available for this method:

string sessionKey
int id - id of desired channel

Returns

The following return values are available for this method:

the last build date of the repomd.xml file as a localised string

10.14. Method: getDetails

Description

Returns details of the given channel as a map.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query

Returns

The following return values are available for this method:

struct - channel
int id
string name
string label
string arch_name
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

Description

Returns details of the given channel as a map.

Parameters

The following parameters are available for this method:

string sessionKey
int id - channel to query

Returns

The following return values are available for this method:

struct - channel
int id
string name
string label
string arch_name
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

Description

Returns details of the given repository.

Parameters

The following parameters are available for this method:

string sessionKey
string repoLabel - repository to query

Returns

The following return values are available for this method:

struct - channel
- int id
- string label
- string sourceUrl
- string type

10.17. Method: getRepoDetails

Description

Returns details of the given repo

Parameters

The following parameters are available for this method:

string sessionKey
string repoLabel - repo to query

Returns

The following return values are available for this method:

struct - channel
- int id
- string label
- string sourceUrl
- string type

10.18. Method: getRepoSyncCronExpression

Description

Returns repository synchronization cron expression.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel label

Returns

The following return values are available for this method:

string quartzexpression

10.19. Method: isGloballySubscribable

Description

Returns whether any user in the organization may subscribe to the channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query

Returns

The following return values are available for this method:

int - 1 if true, 0 otherwise

10.20. Method: isUserManageable

Description

Returns whether the given user may manage the channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - label of the channel
string login - login of the target user

Returns

The following return values are available for this method:

int - 1 if manageable, 0 if not

10.21. Method: isUserSubscribable

Description

Returns whether any user may subscribe to the channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - label of the channel
string login - login of the target user

Returns

The following return values are available for this method:

int - 1 if subscribable, 0 if not

10.22. Method: listAllPackages

Description

Lists all packages in the channel, regardless of package version, between given dates.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query
dateTime.iso8601 startDate
dateTime.iso8601 endDate

Returns

The following return values are available for this method:

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

Description

Lists all packages in the channel, regardless of version, where the last modified date is greater than the given date.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query
dateTime.iso8601 startDate

Returns

The following return values are available for this method:

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

Description

Lists all packages in the channel, regardless of the package version.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query

Returns

The following return values are available for this method:

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

Description

Lists all packages in the channel, regardless of package version, between given dates. Example Date: '2008-08-20 08:00:00'

Note

This method is dDeprecated. Use the listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601 endDate) method.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query
string startDate
string endDate

Returns

The following return values are available for this method:

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

Description

Lists all packages in the channel, regardless of version, where the last modified date is greater than the given date. Example Date: '2008-08-20 08:00:00'

Note

This method is deprecated. Use the listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate) method.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query
string startDate

Returns

The following return values are available for this method:

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

Description

Lists all packages in the channel, regardless of the package version, between the given dates. Example Date: '2008-08-20 08:00:00'

Note

This method is deprecated. Use the listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601 endDate) method.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query
string startDate
string endDate

Returns

The following return values are available for this method:

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - string id
  - string arch_label
  - string last_modified

10.28. Method: listAllPackagesByDate

Description

Lists all packages in the channel, regardless of the package version, where the last modified date is greater than the given date. Example Date: '2008-08-20 08:00:00'

Note

This method is deprecated. Use the listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate) method.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query
string startDate

Returns

The following return values are available for this method:

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - string id
  - string arch_label
  - string last_modified

10.29. Method: listAllPackagesByDate

Description

Lists all packages in the channel, regardless of the package version

Note

This method is deprecated. Use the listAllPackages(string sessionKey, string channelLabel) method.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query

Returns

The following return values are available for this method:

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - string id
  - string arch_label
  - string last_modified

10.30. Method: listArches

Description

Lists the potential software channel architectures for creation.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - channel arch
  - string name
  - string label

10.31. Method: listChannelRepos

Description

Lists associated repositories with the given channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel label

Returns

The following return values are available for this method:

array:
- struct - channel
  - int id
  - string label
  - string sourceUrl
  - string type

10.32. Method: listChildren

Description

List the children of a channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - the label of the channel

Returns

The following return values are available for this method:

array:
- struct - channel
- int id
- string name
- string label
- string arch_name
- 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

Description

List the errata applicable to a channel after given start date.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query
dateTime.iso8601 startDate

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata ID
  - string date - Erratum creation date
  - string update_date - Erratum update date
  - string advisory_synopsis - Summary of the erratum.
  - string advisory_type - Type label, such as "Security", "Bug Fix", or "Enhancement"
  - string advisory_name - Name, such as RHSA

10.34. Method: listErrata

Description

List the errata applicable to a channel between a start date and end date.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - channel to query
dateTime.iso8601 startDate
dateTime.iso8601 endDate

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata ID
  - string date - Erratum creation date
  - string update_date - Erratum update date
  - string advisory_synopsis - Summary of the erratum.
  - string advisory_type - Type label, such as "Security", "Bug Fix", or "Enhancement"
  - string advisory_name - Name, such as RHSA

10.35. Method: listErrata

Description

List the errata applicable to a channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Channel to query

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata Id
  - string advisory_synopsis - Summary of the erratum.
  - string advisory_type - Type label, such as "Security", "Bug Fix", or "Enhancement"
  - string advisory_name - Name, such as RHSA
  - string advisory - Name of the advisory (deprecated)
  - string issue_date - Date format, which follows YYYY-MM-DD HH24:MI:SS (deprecated)
  - string update_date - date format, which follows YYYY-MM-DD HH24:MI:SS (deprecated)
  - string synopsis (deprecated)
  - string last_modified_date - date format, which follows YYYY-MM-DD HH24:MI:SS (deprecated)

10.36. Method: listErrata

Description

List the errata applicable to a channel after given startDate

Note

The method is deprecated. Use the listErrata(string sessionKey, string channelLabel, dateTime.iso8601 startDate) method.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Channel to query
string startDate

Returns

The following return values are available for this method:

array:
- struct - errata
  - string advisory - Name of the advisory
  - string issue_date - Date format, which follows YYYY-MM-DD HH24:MI:SS
  - string update_date - date format, which follows YYYY-MM-DD HH24:MI:SS
  - string synopsis
  - string advisory_type
  - string last_modified_date - date format, which follows YYYY-MM-DD HH24:MI:SS

10.37. Method: listErrata

Description

List the errata applicable to a channel between a start date and end date.

Note

This method is deprecated. Use the listErrata(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601) method.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Channel to query
string startDate
string startDate

Returns

The following return values are available for this method:

array:
- struct - errata
  - string advisory - Name of the advisory
  - string issue_date - Date format, which follows YYYY-MM-DD HH24:MI:SS
  - string update_date - Date format, which follows YYYY-MM-DD HH24:MI:SS
  - string synopsis
  - string advisory_type
  - string last_modified_date - Date format, which follows YYYY-MM-DD HH24:MI:SS

10.38. Method: listErrataByType

Description

List the errata of a specific type applicable to a channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Channel to query
string advisoryType - Type of advisory; one of of the following: "Security Advisory", "Product Enhancement Advisory", or "Bug Fix Advisory".

Returns

The following return values are available for this method:

array:
- struct - errata
  - string advisory - Name of the advisory
  - string issue_date - Date format, which follows YYYY-MM-DD HH24:MI:SS
  - string update_date - Date format, which follows YYYY-MM-DD HH24:MI:SS
  - string synopsis
  - string advisory_type
  - string last_modified_date - Date format, which follows YYYY-MM-DD HH24:MI:SS

10.39. Method: listLatestPackages

Description

Lists the packages with the latest version, including release and epoch, for the given channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Channel to query

Returns

The following return values are available for this method:

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - int id
  - string arch_label

10.40. Method: listPackagesWithoutChannel

Description

Lists all packages not associated with a channel. Typically these are custom packages.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - int id
  - string arch_label
  - string path - The path on the file system the package resides
  - string provider - The provider of the package, determined by its GPG key
  - dateTime.iso8601 last_modified

10.41. Method: listRepoFilters

Description

Lists the filters for a repo.

Parameters

The following parameters are available for this method:

string sessionKey
string label - Repository label

Returns

The following return values are available for this method:

array:
- struct - filter
  - int sortOrder
  - string filter
  - string flag

10.42. Method: listSubscribedSystems

Description

Returns list of subscribed systems for the given channel label.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Channel to query

Returns

The following return values are available for this method:

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

10.43. Method: listSystemChannels

Description

Returns a list of channels that a system is subscribed to for the given system ID.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

array:
- struct - channel
  - string label
  - string name

10.44. Method: listUserRepos

Description

Returns a list of ContentSource (repositories) the user can see.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - map
  - long id - ID of the repo
  - string label - Label of the repo
  - string sourceUrl - URL of the repo

10.45. Method: mergeErrata

Description

Merges all errata from one channel into another.

Parameters

The following parameters are available for this method:

string sessionKey
string mergeFromLabel - The label of the channel to pull errata
string mergeToLabel - The label to push errata

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata ID
  - string date - Erratum creation date
  - string advisory_type - Type of advisory
  - string advisory_name - Name of the advisory
  - string advisory_synopsis - Summary of the erratum

10.46. Method: mergeErrata

Description

Merges all errata from one channel into another based upon a given start and end date.

Parameters

The following parameters are available for this method:

string sessionKey
string mergeFromLabel - The label of the channel to pull errata
string mergeToLabel - The label to push the errata
string startDate
string endDate

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata Id
  - string date - Erratum creation date
  - string advisory_type - Type of advisory
  - string advisory_name - Name of advisory
  - string advisory_synopsis - Summary of erratum

10.47. Method: mergeErrata

Description

Merges a list of errata from one channel into another.

Parameters

The following parameters are available for this method:

string sessionKey
string mergeFromLabel - The label of the channel to pull errata
string mergeToLabel - The label to push errata
array:
- string - advisory - The advisory name of the errata to merge

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata ID
  - string date - Erratum creation date
  - string advisory_type - Type of advisory
  - string advisory_name - Name of advisory
  - string advisory_synopsis - Summary of erratum

10.48. Method: mergePackages

Description

Merges all packages from one channel into another.

Parameters

The following parameters are available for this method:

string sessionKey
string mergeFromLabel - The label of the channel to pull packages
string mergeToLabel - The label to push the packages

Returns

The following return values are available for this method:

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - int id
  - string arch_label
  - string path - The path on the file system the package resides
  - string provider - The provider of the package, determined by its GPG key
  - dateTime.iso8601 last_modified

10.49. Method: regenerateNeededCache

Description

Completely clear and regenerate the needed errata and package cache for all systems subscribed to the specified channel. Only use this method if you believe your cache is incorrect for all systems in a given channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - The label of the channel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.50. Method: regenerateNeededCache

Description

Completely clear and regenerate the needed errata and package cache for all systems subscribed. Only a Satellite Administrator may perform this action.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.51. Method: regenerateYumCache

Description

Regenerate YUM cache for the specified channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - The label of the channel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.52. Method: removeErrata

Description

Removes a given list of errata from the given channel.

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.53. Method: removePackages

Description

Removes a given list of packages from the given channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Target channel.
array:
- int - packageId - ID of a package to remove from the channel.

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.54. Method: removeRepo

Description

Removes a repository.

Parameters

The following parameters are available for this method:

string sessionKey
long id - ID of repository to remove

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.55. Method: removeRepo

Description

Removes a repository

Parameters

The following parameters are available for this method:

string sessionKey
string label - Label of repo to be removed

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.56. Method: removeRepoFilter

Description

Removes a filter for a given repo.

Parameters

The following parameters are available for this method:

string sessionKey
string label - Repository label
struct - filter_map
- string filter - String to filter on
- string flag - plus (+) for include, minus (-) for exclude

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.57. Method: setContactDetails

Description

Set contact and support information for given channel.

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.58. Method: setDetails

Description

Allows to modify channel attributes

Parameters

The following parameters are available for this method:

string sessionKey
int channelDd - 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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.59. Method: setGloballySubscribable

Description

Set globally subscribable attribute for given channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Label of the channel
boolean subscribable - true if the channel is to be globally subscribable. false otherwise.

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.60. Method: setRepoFilters

Description

Replaces the existing set of filters for a given repository. Filters are ranked by their order in the array.

Parameters

The following parameters are available for this method:

string sessionKey
string label - Repository label
array:
- struct - filter_map
  - string filter - String to filter on
  - string flag - Plus (+) for include, minus (-) for exclude

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.61. Method: setSystemChannels

Description

Change a system's subscribed channels to the list of channels passed.

Note

This method is deprecated. The system.setBaseChannel(string sessionKey, int serverId, string channelLabel) and system.setChildChannels(string sessionKey, int serverId, array[string channelLabel]) methods now replace it.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
array:
- string - channelLabel - Labels of the channels to subscribe the system.

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.62. Method: setUserManageable

Description

Set the manageable flag for a given channel and user. If value is set to true, this method gives the user 'manage' permissions for the channel. Otherwise, the privilege is revoked.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Label of the channel
string login - Login of the target user
boolean value - Value of the flag to set

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.63. Method: setUserSubscribable

Description

Set the subscribable flag for a given channel and user. If value is set to true, this method gives the user 'subscribe' permissions to the channel. Otherwise, the privilege is revoked.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Label of the channel
string login - Login of the target user
boolean value - Value of the flag to set

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.64. Method: subscribeSystem

Description

Subscribes a system to a list of channels. If a base channel is included, it 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, provide an empty list of channel labels.

Note

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
array:
- string - label - Channel label to subscribe the system

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.65. Method: syncRepo

Description

Trigger immediate repository synchronization.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Channel label

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.66. Method: syncRepo

Description

Schedule periodic repository synchronization.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Channel label
string cron expression - If empty, all periodic schedules are disabled

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

10.67. Method: updateRepo

Description

Updates a ContentSource (repository).

Parameters

The following parameters are available for this method:

string sessionKey
int id - Repository ID
string label - New repository label
string url - New repository URL

Returns

The following return values are available for this method:

struct - channel
- int id
- string label
- string sourceUrl
- string type

10.68. Method: updateRepoLabel

Description

Updates the repository label.

Parameters

The following parameters are available for this method:

string sessionKey
int id - Repository ID
string label - New repository label

Returns

The following return values are available for this method:

struct - channel
- int id
- string label
- string sourceUrl
- string type

10.69. Method: updateRepoUrl

Description

Updates the repository source URL.

Parameters

The following parameters are available for this method:

string sessionKey
int id - Repository ID
string url - Repository URL

Returns

The following return values are available for this method:

struct - channel
- int id
- string label
- string sourceUrl
- string type

10.70. Method: updateRepoUrl

Description

Updates repository source URL

Parameters

The following parameters are available for this method:

string sessionKey
string label - Repository label
string url - Repository URL

Returns

The following return values are available for this method:

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.

Namespace: configchannel

11.1. Method: channelExists

Description

Check for the existence of the config channel provided.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Channel to check for

Returns

The following return values are available for this method:

1 if exists, 0 otherwise.

11.2. Method: create

Description

Create a new global config channel. Caller must be at least a config administrator or an organization administrator.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel
string channelName
string channelDescription

Returns

The following return values are available for this method:

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

Description

Create a new file or directory with the given path, or update an existing path.

Parameters

The following parameters are available for this method:

string sessionKey
string configChannelLabel
string path
boolean isDir - true if the path is a directory, false if it is a file.
struct - path info
- string contents - Contents of the file in text or base64 encoded if binary (only for non-directories)
- boolean contents_enc64 - Identifies base64 encoded content (disabled by default, only for non-directories)
- string owner - Owner of the file or directory.
- string group - Group name of the file or directory.
- string permissions - Octal file or directory permissions e.g. 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

The following return values are available for this method:

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; present for files or directories only (deprecated)
- string permissions_mode - File Permissions; Present for files or directories only
- string selinux_ctx - SELinux context (optional)
- boolean binary - true or 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

Description

Create a new symbolic link with the given path, or update an existing path.

Parameters

The following parameters are available for this method:

string sessionKey
string configChannelLabel
string path
struct - path info
- string target_path - The target path for the symbolic link
- string selinux_ctx - SELinux security context (optional)
- int revision - Next revision number; skip this field for automatic revision number assignment

Returns

The following return values are available for this method:

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; present for files or directories only (deprecated)
- string permissions_mode - File Permissions; present for files or directories only
- string selinux_ctx - SELinux context (optional)
- boolean binary - true or 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

Description

Delete a list of global config channels. Caller must be a config admin.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- string configuration - channel labels to delete

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

11.6. Method: deleteFileRevisions

Description

Delete specified revisions of a given configuration file.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Label of config channel to look up
string filePath - Configuration file path
array:
- int - List of revisions to delete

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

11.7. Method: deleteFiles

Description

Remove file paths from a global channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Channel to remove files
array:
- string file - Paths to remove

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

11.8. Method: deployAllSystems

Description

Schedule an immediate configuration deployment for all systems subscribed to a particular configuration channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - The configuration channel's label

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

11.9. Method: deployAllSystems

Description

Schedule a configuration deployment for all systems subscribed to a particular configuration channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - The configuration channel's label
dateTime.iso8601 date - The date to schedule the action

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

11.10. Method: getDetails

Description

Look up configuration channel details.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel

Returns

The following return values are available for this method:

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.11. Method: getDetails

Description

Look up configuration channel details.

Parameters

The following parameters are available for this method:

string sessionKey
int channelId

Returns

The following return values are available for this method:

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.12. Method: getEncodedFileRevision

Description

Get revision of the specified configuration file and transmit the contents as base64 encoded.

Parameters

The following parameters are available for this method:

string sessionKey
string configChannelLabel - Label of config channel to look up
string filePath - Config file path to examine
int revision - Config file revision to examine

Returns

The following return values are available for this method:

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 or 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.13. Method: getFileRevision

Description

Get revision of the specified configuration file and transmit the contents as plain text.

Parameters

The following parameters are available for this method:

string sessionKey
string configChannelLabel - Label of config channel to look up
string filePath - Config file path to examine
int revision - Config file revision to examine

Returns

The following return values are available for this method:

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; present for files or directories only. (deprecated)
- string permissions_mode - File permissions; present for files or directories only
- string selinux_ctx - SELinux context (optional)
- boolean binary - true or 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.14. Method: getFileRevisions

Description

Get list of revisions for specified config file.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Label of config channel to look up
string filePath - Config file path to examine

Returns

The following return values are available for this method:

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; present for files or directories only (deprecated)
  - string permissions_mode - File permissions; present for files or directories only
  - string selinux_ctx - SELinux context (optional)
  - boolean binary - true or 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: listFiles

Description

Return a list of files in a channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - label of config channel to list files on.

Returns

The following return values are available for this method:

array:
- struct - Configuration File information
  - string type
    file
    directory
    symlink
  - string path - File path
  - dateTime.iso8601 last_modified - Last modified date

11.16. Method: listGlobals

Description

List all the global config channels accessible to the logged-in user.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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.17. Method: listSubscribedSystems

Description

Return a list of systems subscribed to a configuration channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - label of config channel to list subscribed systems.

Returns

The following return values are available for this method:

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

11.18. Method: lookupChannelInfo

Description

Lists details for channels given their labels.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- string configuration - channel label

Returns

The following return values are available for this method:

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.19. Method: lookupFileInfo

Description

Returns details about the latest path revisions from a list of paths and a channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Label of config channel to look up
array:
- string - List of paths to examine.

Returns

The following return values are available for this method:

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; present for files or directories only (deprecated)
  - string permissions_mode - File permissions; present for files or directories only
  - string selinux_ctx - SELinux context (optional)
  - boolean binary - true or 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.20. Method: lookupFileInfo

Description

Returns details about the latest path revisions given a path, revision number, and a channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Label of config channel to look up
string path - Path of the file or directory
int revsion - The revision number

Returns

The following return values are available for this method:

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; present for files or directories only (deprecated)
- string permissions_mode - File permissions; present for files or directories only
- string selinux_ctx - SELinux context (optional)
- boolean binary - true or 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.21. Method: scheduleFileComparisons

Description

Schedule a comparison of the latest revision of a file against the version deployed on a list of systems.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Label of config channel
string path - File path
array:
- long - The list of server ID for the comparison performed on

Returns

The following return values are available for this method:

int actionId - The action ID of the scheduled action

11.22. Method: update

Description

Update a global config channel. Caller is at least a config administrator, an organization administrator, or have access to a system containing this config channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel
string channelName
string description

Returns

The following return values are available for this method:

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

Namespace: distchannel

12.1. Method: listDefaultMaps

Description

Lists the default distribution channel maps.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

struct - distChannelMap
- string os - Operating system
- string release - Operating system relase
- string arch_name - Channel architecture
- string channel_label - Channel label
- string org_specific - Y for organization-specific, N for default

12.2. Method: listMapsForOrg

Description

Lists distribution channel maps valid for the user's organization.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

struct - distChannelMap
- string os - Operating system
- string release - Operating system relase
- string arch_name - Channel architecture
- string channel_label - Channel label
- string org_specific - Y for organization-specific, N for default

12.3. Method: listMapsForOrg

Description

Lists distribution channel maps valid for an organization. Requires Satellite administration permissions.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

struct - distChannelMap
- string os - Operating system
- string release - Operating system relase
- string arch_name - Channel architecture
- string channel_label - Channel label
- string org_specific - Y for organization-specific, N for default

12.4. Method: setMapForOrg

Description

Sets and overrides (or removes if channelLabel is empty) a distribution channel map within an organization.

Parameters

The following parameters are available for this method:

string sessionKey
string os
string release
string archName
string channelLabel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

Chapter 13. Namespace: errata

Provides methods to access and modify errata.

Namespace: errata

13.1. Method: addPackages

Description

Add a set of packages to an erratum with the given advisory name. This method only allows for modification of custom errata created either through the UI or API.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName
array:
- int - packageId

Returns

The following return values are available for this method:

int - represents the number of packages added, exception otherwise

13.2. Method: applicableToChannels

Description

Returns a list of channels applicable to the erratum with the given advisory name.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName

Returns

The following return values are available for this method:

array:
- struct - channel
  - int channel_id
  - string label
  - string name
  - string parent_channel_label

13.3. Method: bugzillaFixes

Description

Get the Bugzilla fixes for an erratum matching the given advisoryName. The bugs are returned in a struct where the bug ID is the key.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName

Returns

The following return values are available for this method:

struct - Bugzilla info
- string bugzilla_id - Actual bug ID number and the key for the struct entry
- string bug_summary - Summary where the key is the bug ID number

13.4. Method: clone

Description

Clone a list of errata into the specified channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channel_label
array:
- string advisory - The advisory name of the errata to clone

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata ID
  - string date - Erratum creation date
  - string advisory_type - Type of advisory
  - string advisory_name - Name of advisory
  - string advisory_synopsis - Summary of erratum

13.5. Method: cloneAsOriginal

Description

Clones a list of errata into a specified cloned channel according to the original errata.

Parameters

The following parameters are available for this method:

string sessionKey
string channel_label
array:
- string - advisory - The advisory name of the errata to clone

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata ID
  - string date - Erratum creation date
  - string advisory_type - Type of advisory
  - string advisory_name - Name of advisory
  - string advisory_synopsis - Summary of erratum

13.6. Method: cloneAsOriginalAsync

Description

Asynchronously clones a list of errata into a specified cloned channel according the original errata.

Parameters

The following parameters are available for this method:

string sessionKey
string channel_label
array:
- string advisory - The advisory name of the errata to clone

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

13.7. Method: cloneAsync

Description

Asynchronously clone a list of errata into the specified channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channel_label
array:
- string advisory - The advisory name of the errata to clone

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

13.8. Method: create

Description

Create a custom errata. If publish is set to true, the errata is published too.

Parameters

The following parameters are available for this method:

string sessionKey
struct - errata info
- string synopsis
- string advisory_name
- int advisory_release
- string advisory_type - Type of advisory (one of the following: Security Advisory, Product Enhancement Advisory, or Bug Fix Advisory
- string product
- string errataFrom
- string topic
- string description
- string references
- string notes
- string solution
array:
- struct - bug
  - int id - Bug ID
  - string summary
  - string url
array:
- string keyword - List of keywords to associate with the errata
array:
- int - packageId
boolean publish - Should the errata be published
array:
- string - channelLabel - List of channels to publish the errata; ignored if publish is set to false

Returns

The following return values are available for this method:

struct - errata
- int id - Errata ID
- string date - Erratum creation date
- string advisory_type - Type of advisory
- string advisory_name - Name of advisory
- string advisory_synopsis - Summary of erratum

13.9. Method: delete

Description

Delete an erratum. This method only allows deletion of custom errata created either through the UI or API.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

13.10. Method: findByCve

Description

Looks up the details for errata associated with the given CVE value e.g. CVE-2008-3270

Parameters

The following parameters are available for this method:

string sessionKey
string cveName

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata ID
  - string date - Erratum creation date
  - string advisory_type - Type of advisory
  - string advisory_name - Name of advisory
  - string advisory_synopsis - Summary of erratum

13.11. Method: getDetails

Description

Retrieves the details for the erratum matching the given advisory name.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName

Returns

The following return values are available for this method:

struct - erratum
- string issue_date
- string update_date
- string last_modified_date - This date is only included for published erratum and represents the erratum's late date of modification
- string synopsis
- int release
- string type
- string product
- string errataFrom
- string topic
- string description
- string references
- string notes
- string solution

13.12. Method: listAffectedSystems

Description

Return the list of systems affected by the erratum with advisory name.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

13.13. Method: listByDate

Description

List errata that have been applied to a particular channel by date.

Note

This method is deprecated. The channel.software.listErrata(string sessionKey, string channelLabel) now replaces it.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata ID
  - string date - Erratum creation date
  - string advisory_type - Type of advisory
  - string advisory_name - Name of advisory
  - string advisory_synopsis - Summary of erratum

13.14. Method: listCves

Description

Returns a list of CVEs applicable to the erratum with the given advisory name. CVEs may be associated only with published errata.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName

Returns

The following return values are available for this method:

array:
- string cveName

13.15. Method: listKeywords

Description

Get the keywords associated with an erratum matching the given advisory name.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName

Returns

The following return values are available for this method:

array:
- string - Keyword associated with erratum

13.16. Method: listPackages

Description

Returns a list of the packages affected by the erratum with the given advisory name.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName

Returns

The following return values are available for this method:

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

Description

Returns a list of unpublished errata

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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

Description

Publish an existing unpublished errata to a set of channels.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName
array:
- string - channelLabel - List of channel labels to publish the errata

Returns

The following return values are available for this method:

struct - errata
- int id - Errata ID
- string date - Erratum creation date
- string advisory_type - Type of advisory
- string advisory_name - Name of advisory
- string advisory_synopsis - Summary of erratum

13.19. Method: publishAsOriginal

Description

Publishes an existing unpublished cloned errata to a set of cloned channels according to its original erratum.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName
array:
- string channelLabel - List of channel labels to publish errata

Returns

The following return values are available for this method:

struct - errata
- int id - Errata ID
- string date - Erratum creation date
- string advisory_type - Type of advisory
- string advisory_name - Name of advisory
- string advisory_synopsis - Summary of erratum

13.20. Method: removePackages

Description

Remove a set of packages from an erratum with the given advisory name. This method only allows for modification of custom errata created either through the UI or API.

Parameters

The following parameters are available for this method:

string sessionKey
string advisoryName
array:
- int - packageId

Returns

The following return values are available for this method:

int - Represents the number of packages removed, exception otherwise

13.21. Method: setDetails

Description

Set erratum details. All arguments are optional and are only modified if included in the struct. This method only allows for modification of custom errata created either through the UI or API.

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

int - 1on success, exception thrown otherwise.

Chapter 14. Namespace: kickstart

Provides methods to create kickstart files.

Namespace: kickstart

14.1. Method: cloneProfile

Description

Clone a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabelToClone - Label of the kickstart profile to clone
string newKsLabel - Label of the cloned profile

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

14.2. Method: createProfile

Description

Import a kickstart profile into Red Hat Network.

Parameters

The following parameters are available for this method:

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
string kickstartHost - Kickstart hostname (of a Red Hat Satellite or Red Hat Satellite Proxy) used to construct the default download URL for the new kickstart profile.
string rootPassword - root password
string updateType - Update the profile to use the newest tree available. Possible values are: none (default), red_hat (only use kickstart trees synchronized from Red Hat), or all (includes custom kickstart trees)

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

14.3. Method: createProfile

Description

Import a kickstart profile into Red Hat Network.

Parameters

The following parameters are available for this method:

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
string kickstartHost - Kickstart hostname (of a Red Hat Satellite or Red Hat Satellite Proxy) used to construct the default download URL for the new kickstart profile
string rootPassword - root password

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

14.4. Method: createProfileWithCustomUrl

Description

Import a kickstart profile into Red Hat Network.

Parameters

The following parameters are available for this method:

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
boolean downloadUrl - Download URL, or default to use the kickstart tree's default URL.
string rootPassword - root password

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

14.5. Method: createProfileWithCustomUrl

Description

Import a kickstart profile into Red Hat Network.

Parameters

The following parameters are available for this method:

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
boolean downloadUrl - Download URL, or default to use the kickstart tree's default URL.
string rootPassword - root password
string updateType - Update the profile to use the newest tree available. Possible values are: none (default), red_hat (only use kickstart trees synchronized from Red Hat), or all (includes custom kickstart trees)

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

14.6. Method: deleteProfile

Description

Delete a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The label of the kickstart profile to remove

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

14.7. Method: disableProfile

Description

Enable or disable a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string profileLabel - Label for the kickstart tree to enable or disable
string disabled - true to disable the profile

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

14.8. Method: findKickstartForIp

Description

Find an associated kickstart for a given IP address.

Parameters

The following parameters are available for this method:

string sessionKey
string ipAddress - The IP address to find

Returns

The following return values are available for this method:

string - label of the kickstart. Returns an empty string ("") if not found.

14.9. Method: importFile

Description

Import a kickstart profile into Red Hat Network.

Parameters

The following parameters are available for this method:

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
string kickstartFileContents - Contents of the kickstart file to import

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

14.10. Method: importFile

Description

Import a kickstart profile into Red Hat Network.

Parameters

The following parameters are available for this method:

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
string kickstartHost - Kickstart hostname (of a Red Hat Satellite or Red Hat Satellite 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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

14.11. Method: importFile

Description

Import a kickstart profile into Red Hat Network.

Parameters

The following parameters are available for this method:

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
string kickstartHost - Kickstart hostname (of a Red Hat Satellite or Red Hat Satellite 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 - Update the profile to use the newest tree available. Possible values are: none (default), red_hat (only use kickstart trees synchronized from Red Hat), or all (includes custom kickstart trees)

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

14.12. Method: importRawFile

Description

Import a raw kickstart file into Red Hat Satellite.

Parameters

The following parameters are available for this method:

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
string kickstartFileContents - Contents of the kickstart file to import

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

14.13. Method: importRawFile

Description

Import a raw kickstart file into Red Hat Satellite.

Parameters

The following parameters are available for this method:

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.
string kickstartFileContents - Contents of the kickstart file to import.
string updateType - Update the profile to use the newest tree available. Possible values are: none (default), red_hat (only use kickstart trees synchronized from Red Hat), or all (includes custom kickstart trees)

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

14.14. Method: isProfileDisabled

Description

Returns whether a kickstart profile is disabled

Parameters

The following parameters are available for this method:

string sessionKey
string profileLabel - Kickstart profile label

Returns

The following return values are available for this method:

true if profile is disabled

14.15. Method: listAllIpRanges

Description

List all IP ranges and their associated kickstarts available in the user's organization.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - Kickstart IP range
  - string ksLabel - The kickstart label associated with the IP range
  - string max - The maximum IP of the range
  - string min - The minimum IP of the range

14.16. Method: listKickstartableChannels

Description

List kickstartable channels for the logged in user.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - channel
  - int id
  - string name
  - string label
  - string arch_name
  - 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

Description

List the available kickstartable trees for the given channel.

Note

This method is deprecated. Use the kickstart.tree.list(string sessionKey, string channelLabel) method.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Label of channel to search

Returns

The following return values are available for this method:

array:
- struct - kickstartable tree
  - int id
  - string label
  - string base_path
  - int channel_id

14.18. Method: listKickstarts

Description

Provides a list of kickstart profiles visible to the user's organization.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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

Description

Rename a kickstart profile in Red Hat Satellite.

Parameters

The following parameters are available for this method:

string sessionKey
string originalLabel - Label for the kickstart profile to rename
string newLabel - New label for the kickstart profile

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

Chapter 15. Namespace: kickstart.filepreservation

Provides methods to retrieve and manipulate kickstart file preservation lists.

Namespace: kickstart.filepreservation

15.1. Method: create

Description

Create a new file preservation list.

Parameters

The following parameters are available for this method:

string session_key
string name - Name of the file list to create
array:
- string name - File names to include

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

15.2. Method: delete

Description

Delete a file preservation list.

Parameters

The following parameters are available for this method:

string session_key
string name - Name of the file list to delete

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

15.3. Method: getDetails

Description

Returns all of the data associated with the given file preservation list.

Parameters

The following parameters are available for this method:

string session_key
string name - Name of the file list to retrieve details

Returns

The following return values are available for this method:

struct - file list
- string name
- array file_names
  - string name

15.4. Method: listAllFilePreservations

Description

List all file preservation lists for the organization associated with the user logged into the given session.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - file preservation
  - int id
  - string name
  - dateTime.iso8601 created
  - dateTime.iso8601 last_modified

Chapter 16. Namespace: kickstart.keys

Provides methods to manipulate kickstart keys.

Namespace: kickstart.keys

16.1. Method: create

Description

Creates a new key with the given parameters.

Parameters

The following parameters are available for this method:

string session_key
string description
string type - Valid values are GPG or SSL
string content

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

16.2. Method: delete

Description

deletes the key identified by the given parameters

Parameters

The following parameters are available for this method:

string session_key
string description

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

16.3. Method: getDetails

Description

Returns all of the data associated with the given key.

Parameters

The following parameters are available for this method:

string session_key
string description

Returns

The following return values are available for this method:

struct - key
- string description
- string type
- string content

16.4. Method: listAllKeys

Description

List all keys for the org associated with the user logged into the given session.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - key
  - string description
  - string type

16.5. Method: update

Description

Updates type and content of the key identified by the description.

Parameters

The following parameters are available for this method:

string session_key
string description
string type - Valid values are GPG or SSL
string content

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Chapter 17. Namespace: kickstart.profile

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

Namespace: kickstart.profile

17.1. Method: addIpRange

Description

Add an IP range to a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string label - The label of the kickstart
string min - The IP address for minimum of the range
string max - The IP address for the maximum of the range

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

17.2. Method: addScript

Description

Add a pre or post script to a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart label to add the script
string name - The kickstart script name
string contents - The full script to add
string interpreter - The path to the interpreter to use e.g. /bin/bash; an empty string enables 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

The following return values are available for this method:

int id - The ID of the added script

17.3. Method: addScript

Description

Add a pre or post script to a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart label to add the script
string name - The kickstart script name
string contents - The full script to add
string interpreter - The path to the interpreter to use e.g. /bin/bash; an empty string enables 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

The following return values are available for this method:

int id - The ID of the added script

17.4. Method: addScript

Description

Add a pre or post script to a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart label to add the script
string name - The kickstart script name
string contents - The full script to add
string interpreter - The path to the interpreter to use e.g. /bin/bash; an empty string enables 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

The following return values are available for this method:

int id - The ID of the added script

17.5. Method: compareActivationKeys

Description

Returns a list for each kickstart profile. Each list contains activation keys not present on the other profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kickstartLabel1
string kickstartLabel2

Returns

The following return values are available for this method:

struct - Comparison Info
- array "kickstartLabel1" - Actual label of the first kickstart profile is the key into the struct
  - array:
    struct - activation key
    string key
    string description
    int usage_limit
    string base_channel_label
    array child_channel_labels
    string childChannelLabel
    array entitlements
    string entitlementLabel
    array server_group_ids
    string serverGroupId
    array package_names
    string packageName - (deprecated by packages)
    array packages
    struct - package
    string name - packageName
    string arch - archLabel - optional
    boolean universal_default
    boolean disabled
- array "kickstartLabel2" - Actual label of the second kickstart profile is the key into the struct
  - array:
    struct - activation key
    string key
    string description
    int usage_limit
    string base_channel_label
    array child_channel_labels
    string childChannelLabel
    array entitlements
    string entitlementLabel
    array server_group_ids
    string serverGroupId
    array package_names
    string packageName - (deprecated by packages)
    array packages
    struct - package
    string name - packageName
    string arch - archLabel - optional
    boolean universal_default
    boolean disabled

17.6. Method: compareAdvancedOptions

Description

Returns a list for each kickstart profile. Each list contains the properties that differ between the profiles and their values for that specific profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kickstartLabel1
string kickstartLabel2

Returns

The following return values are available for this method:

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

17.7. Method: comparePackages

Description

Returns a list for each kickstart profile. Each list contains package names not present on the other profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kickstartLabel1
string kickstartLabel2

Returns

The following return values are available for this method:

struct - Comparison Info
- array "kickstartLabel1" - Actual label of the first kickstart profile is the key into the struct
  - array:
    string - packagename
- array "kickstartLabel2" - Actual label of the second kickstart profile is the key into the struct
  - array:
    string - packagename

17.8. Method: downloadKickstart

Description

Download the full contents of a kickstart file.

Parameters

The following parameters are available for this method:

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 is the FQDN of the Satellite, but can be the IP address or shortname of it too

Returns

The following return values are available for this method:

string - The contents of the kickstart file

Note

If an activation key is not associated with the kickstart file, registration does not occur in the Satellite-generated %post section. If one is associated, it is used for registration.

17.9. Method: downloadRenderedKickstart

Description

Downloads the Cobbler-rendered Kickstart file.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The label of the kickstart to download

Returns

The following return values are available for this method:

string - The contents of the kickstart file

17.10. Method: getAdvancedOptions

Description

Get advanced options for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - Label of kickstart profile to be changed

Returns

The following return values are available for this method:

array:
- struct - option
  - string name
  - string arguments

17.11. Method: getCfgPreservation

Description

Get ks.cfg preservation option for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kslabel - Label of kickstart profile to be changed.

Returns

The following return values are available for this method:

boolean - The value of the option; true means that ks.cfg is copied to /root and false means it is not.

17.12. Method: getChildChannels

Description

Get the child channels for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kslabel - Label of kickstart profile

Returns

The following return values are available for this method:

array:
- string - channelLabel

17.13. Method: getCustomOptions

Description

Get custom options for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel

Returns

The following return values are available for this method:

array:
- struct - option
  - int id
  - string arguments

17.14. Method: getKickstartTree

Description

Get the kickstart tree for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kslabel - Label of kickstart profile to be changed

Returns

The following return values are available for this method:

string kstreeLabel - Label of the kickstart tree

17.15. Method: getUpdateType

Description

Get the update type for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kslabel - Label of kickstart profile

Returns

The following return values are available for this method:

string update_type - Update type for this kickstart profile

17.16. Method: getVariables

Description

Returns a list of variables associated with the specified kickstart profile

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel

Returns

The following return values are available for this method:

array:
- struct - kickstart variable
  - string key
  - string or int value

17.17. Method: listIpRanges

Description

List all IP ranges for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string label - The label of the kickstart

Returns

The following return values are available for this method:

array:
- struct - Kickstart IP Range
  - string ksLabel - The kickstart label associated with the IP range
  - string max - The maximum IP of the range
  - string min - The minimum IP of the range

17.18. Method: listScripts

Description

List the pre and post scripts for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The label of the kickstart

Returns

The following return values are available for this method:

array:
- struct - kickstart script
  - int id
  - string contents
  - string script_type - The type of script; either 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 executes within the chroot environment.
  - boolean erroronfail - true if the script throws an error if it fails.
  - boolean template - true if templating using cobbler is enabled

17.19. Method: removeIpRange

Description

Remove an IP range from a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart label of the IP range to remove
string ip_address - An IP Address that falls within the range to remove. The minimum or maximum of the range also works.

Returns

The following return values are available for this method:

int - 1 on successful removal, 0 if range was not found for the specified kickstart, exception otherwise.

17.20. Method: removeScript

Description

Remove a script from a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart from which to remove the script
int scriptId - The ID of the script to remove

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

17.21. Method: setAdvancedOptions

Description

Set advanced options for a kickstart profile. If md5_crypt_rootpw is set to True, root_pw is taken as plain text and MD5 encrypted on server side, otherwise a hash encoded password (according to the auth option) is expected

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel
array:
- struct - advanced options
  - string name - Name of the advanced option. Valid option names: autostep, interactive, install, upgrade, text, network, cdrom, harddrive, nfs, url, lang, langsupport keyboard, mouse, device, deviceprobe, zerombr, clearpart, bootloader, timezone, auth, rootpw, selinux, reboot, firewall, xconfig, skipx, key, ignoredisk, autopart, cmdline, firstboot, graphical, iscsi, iscsiname, logging, monitor, multipath, poweroff, halt, services, shutdown, user, vnc, zfcp, driverdisk, md5_crypt_rootpw
  - string arguments - Arguments of the option

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

17.22. Method: setCfgPreservation

Description

Set ks.cfg preservation option for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kslabel - Label of kickstart profile to be changed
boolean preserve - Defines whether or not ks.cfg and all %include fragments are copied to /root

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

17.23. Method: setChildChannels

Description

Set the child channels for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kslabel - Label of kickstart profile to be changed
string[] channelLabels - List of labels of child channels

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

17.24. Method: setCustomOptions

Description

Set custom options for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel
string options

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

17.25. Method: setKickstartTree

Description

Set the kickstart tree for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kslabel - Label of kickstart profile to be changed
string kstreeLabel - Label of new kickstart tree

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

17.26. Method: setLogging

Description

Set logging options for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kslabel - Label of kickstart profile to be changed
boolean pre - Defines whether or not to log the pre section of a kickstart to /root/ks-pre.log
boolean post - Defines whether or not to log the post section of a kickstart to /root/ks-post.log

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

17.27. Method: setUpdateType

Description

Set the update typefor a kickstart profile.

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

17.28. Method: setVariables

Description

Associates list of kickstart variables with the specified kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel
array:
- struct - kickstart variable
  - string key
  - string or int value

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Chapter 18. Namespace: kickstart.profile.keys

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

Namespace: kickstart.profile.keys

18.1. Method: addActivationKey

Description

Add an activation key association to the kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label
string key - The activation key

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

18.2. Method: getActivationKeys

Description

Looks up the activation keys associated with the kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label

Returns

The following return values are available for this method:

array:
- struct - activation key
  - string key
  - string description
  - int usage_limit
  - string base_channel_label
  - array child_channel_labels
    string childChannelLabel
  - array entitlements
    string entitlementLabel
  - array server_group_ids
    string serverGroupId
  - array package_names
    string packageName (deprecated by packages)
  - array packages
    struct - package
    string name - Package name
    string arch - Architecture label (optional)
  - boolean universal_default
  - boolean disabled

18.3. Method: removeActivationKey

Description

Remove an activation key association from the kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label
string key - The activation key

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

Chapter 19. Namespace: kickstart.profile.software

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

Namespace: kickstart.profile.software

19.1. Method: appendToSoftwareList

Description

Append the list of software packages to a kickstart profile. Duplicate packages are ignored.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The label of a kickstart profile
string[] packageList - A list of package names to be added to the profile

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

19.2. Method: getSoftwareList

Description

Get a list of a kickstart profile's software packages.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The label of a kickstart profile

Returns

The following return values are available for this method:

Array:
- string - A list of a kickstart profile's software packages

19.3. Method: setSoftwareList

Description

Set the list of software packages for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The label of a kickstart profile
Array:
- string packageList - A list of package names to be set on the profile

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Chapter 20. Namespace: kickstart.profile.system

Provides methods to set various properties of a kickstart profile.

Namespace: kickstart.profile.system

20.1. Method: addFilePreservations

Description

Adds the given list of file preservations to the specified kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kickstartLabel
array:
- string - filePreservations

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

20.2. Method: addKeys

Description

Adds the given list of keys to the specified kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kickstartLabel
array:
- string - keyDescription

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

20.3. Method: checkConfigManagement

Description

Check the configuration management status for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label

Returns

The following return values are available for this method:

boolean enabled - true if configuration management is enabled; otherwise, false

20.4. Method: checkRemoteCommands

Description

Check the remote commands status flag for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label

Returns

The following return values are available for this method:

boolean enabled - true if remote commands support is enabled; otherwise, false

20.5. Method: disableConfigManagement

Description

Disables the configuration management flag in a kickstart profile so that a system created using this profile is not configuration capable.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

20.6. Method: disableRemoteCommands

Description

Disables the remote command flag in a kickstart profile so that a system created using this profile is capable of running remote commands.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

20.7. Method: enableConfigManagement

Description

Enables the configuration management flag in a kickstart profile so that a system created using this profile is configuration capable.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

20.8. Method: enableRemoteCommands

Description

Enables the remote command flag in a kickstart profile so that a system created using this profile is capable of running remote commands.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

20.9. Method: getLocale

Description

Retrieves the locale for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label

Returns

The following return values are available for this method:

struct - locale info
- string locale
- boolean useUtc
  - true - The hardware clock uses UTC
  - false - The hardware clock does not use UTC

20.10. Method: getPartitioningScheme

Description

Get the partitioning scheme for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The label of a kickstart profile.

Returns

The following return values are available for this method:

Array:
- string - A list of partitioning commands used to setup the partitions, logical volumes and volume groups.

20.11. Method: getRegistrationType

Description

Returns the registration type of a given kickstart profile. Registration type is one of reactivation, deletion, or none. These types determine the behavior of the registration when using this profile for reprovisioning.

Parameters

The following parameters are available for this method:

string sessionKey
string kickstartLabel

Returns

The following return values are available for this method:

string registrationType
- reactivation
- deletion
- none

20.12. Method: getSELinux

Description

Retrieves the SELinux enforcing mode property of a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label

Returns

The following return values are available for this method:

string enforcingMode
- enforcing
- permissive
- disabled

20.13. Method: listFilePreservations

Description

Returns the set of all file preservations associated with the given kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kickstartLabel

Returns

The following return values are available for this method:

array:
- struct - file list
  - string name
  - array file_names
    string name

20.14. Method: listKeys

Description

Returns the set of all keys associated with the given kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kickstartLabel

Returns

The following return values are available for this method:

array:
- struct - key
  - string description
  - string type
  - string content

20.15. Method: removeFilePreservations

Description

Removes the given list of file preservations from the specified kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kickstartLabel
array:
- string - filePreservations

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

20.16. Method: removeKeys

Description

Removes the given list of keys from the specified kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kickstartLabel
array:
- string - keyDescription

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

20.17. Method: setLocale

Description

Sets the locale for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label
string locale - The locale code
boolean useUtc
- true - The hardware clock uses UTC
- false - The hardware clock does not use UTC

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

20.18. Method: setPartitioningScheme

Description

Set the partitioning scheme for a kickstart profile.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The label of the kickstart profile to update.
Array:
- string scheme - The partitioning scheme is a list of partitioning command strings used to setup the partitions, volume groups and logical volumes.

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

20.19. Method: setRegistrationType

Description

Sets the registration type of a given kickstart profile. Registration type is one of reactivation, deletion, or none. These types determine the behaviour of re-registration when using this profile.

Parameters

The following parameters are available for this method:

string sessionKey
string kickstartLabel
string registrationType
- reactivation - Try and generate a reactivation key and use that to register the system when reprovisioning a system
- deletion - Try and delete the existing system profile and reregister the system being reprovisioned as new
- none - Preserve the status quo and leave the current system as a duplicate on a reprovision.

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

20.20. Method: setSELinux

Description

Sets the SELinux enforcing mode property of a kickstart profile so that a system created using this profile has the appropriate SELinux enforcing mode.

Parameters

The following parameters are available for this method:

string sessionKey
string ksLabel - The kickstart profile label
string enforcingMode - The SELinux enforcing mode
- enforcing
- permissive
- disabled

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Chapter 21. Namespace: kickstart.snippet

Provides methods to create kickstart files.

Namespace: kickstart.snippet

21.1. Method: createOrUpdate

Description

Creates a snippet with the given name and contents if it does not exist. If it does exist, the existing snippet is updated.

Parameters

The following parameters are available for this method:

string sessionKey
string name
string contents

Returns

The following return values are available for this method:

struct - snippet
- string name
- string contents
- string fragment - The string to include in a kickstart file that generates this snippet
- string file - The local path to the file containing this snippet

21.2. Method: delete

Description

Delete the specified snippet. If the snippet is not found, 0 is returned.

Parameters

The following parameters are available for this method:

string sessionKey
string name

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

21.3. Method: listAll

Description

List all cobbler snippets for the logged in user

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - snippet
  - string name
  - string contents
  - string fragment - The string to include in a kickstart file that generates this snippet
  - string file - The local path to the file containing this snippet

21.4. Method: listCustom

Description

List only custom snippets for the logged in user. These snipppets are editable.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - snippet
  - string name
  - string contents
  - string fragment - The string to include in a kickstart file that generates this snippet
  - string file - The local path to the file containing this snippet

21.5. Method: listDefault

Description

List only pre-made default snippets for the logged in user. These snipppets are not editable.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - snippet
  - string name
  - string contents
  - string fragment - The string to include in a kickstart file that generates 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.

Namespace: kickstart.tree

22.1. Method: create

Description

Create a kickstart tree (Distribution) in Red Hat Satellite.

Parameters

The following parameters are available for this method:

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_3, rhel_4, rhel_5, rhel_6, fedora_18).

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

22.2. Method: delete

Description

Delete a kickstart tree (Distribution) in Red Hat Satellite.

Parameters

The following parameters are available for this method:

string sessionKey
string treeLabel - Label for the kickstart tree to delete

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

22.3. Method: deleteTreeAndProfiles

Description

Delete a kickstarttree and any profiles associated with this kickstart tree.

Warning

This method deletes all profiles associated with this kickstart tree.

Parameters

The following parameters are available for this method:

string sessionKey
string treeLabel - Label for the kickstart tree to delete

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

22.4. Method: getDetails

Description

The detailed information about a kickstartable tree given the tree name.

Parameters

The following parameters are available for this method:

string sessionKey
string treeLabel - Label of kickstartable tree to search

Returns

The following return values are available for this method:

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

Description

List the available kickstartable trees for the given channel.

Parameters

The following parameters are available for this method:

string sessionKey
string channelLabel - Label of channel to search

Returns

The following return values are available for this method:

array:
- struct - kickstartable tree
  - int id
  - string label
  - string base_path
  - int channel_id

22.6. Method: listInstallTypes

Description

List the available kickstartable install types.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - kickstart install type
  - int id
  - string label
  - string name

22.7. Method: rename

Description

Rename a kickstart tree (Distribution) in Red Hat Satellite.

Parameters

The following parameters are available for this method:

string sessionKey
string originalLabel - Label for the kickstart tree to rename
string newLabel - The kickstart tree's new label

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

22.8. Method: update

Description

Edit a kickstart tree (Distribution) in Red Hat Satellite.

Parameters

The following parameters are available for this method:

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_3, rhel_4, rhel_5, rhel_6, fedora_18).

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Chapter 23. Namespace: org

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

Namespace: org

23.1. Method: create

Description

Create a new organization and associated administrator account

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

struct - organization info
- int id
- string name
- int active_users - Number of active users in the organization
- int systems - Number of systems in the organization
- int trusts - Number of trusted organizations
- int system_groups - Number of system groups in the organization (optional)
- int activation_keys - Number of activation keys in the organization (optional)
- int kickstart_profiles - Number of kickstart profiles in the organization (optional)
- int configuration_channels - Number of configuration channels in the organization (optional)

23.2. Method: delete

Description

Delete an organization. The default organization (i.e. orgId=1) cannot be deleted.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

23.3. Method: getCrashFileSizeLimit

Description

Get the organization wide crash file size limit. The limit value must be a non-negative number. Zero means no limit.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

int - Crash file size limit

23.4. Method: getDetails

Description

The detailed information about an organization given the organization ID.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

struct - organization info
- int id
- string name
- int active_users - Number of active users in the organization
- int systems - Number of systems in the organization
- int trusts - Number of trusted organizations
- int system_groups - Number of system groups in the organization (optional)
- int activation_keys - Number of activation keys in the organization (optional)
- int kickstart_profiles - Number of kickstart profiles in the organization (optional)
- int configuration_channels - Number of configuration channels in the organization (optional)

23.5. Method: getDetails

Description

The detailed information about an organization given the organization name.

Parameters

The following parameters are available for this method:

string sessionKey
string name

Returns

The following return values are available for this method:

struct - organization info
- int id
- string name
- int active_users - Number of active users in the organization
- int systems - Number of systems in the organization
- int trusts - Number of trusted organizations
- int system_groups - Number of system groups in the organization (optional)
- int activation_keys - Number of activation keys in the organization (optional)
- int kickstart_profiles - Number of kickstart profiles in the organization (optional)
- int configuration_channels - Number of configuration channels in the organization (optional)

23.6. Method: getPolicyForScapFileUpload

Description

Get the status of SCAP detailed result file upload settings for the given organization.

Parameters

The following paramaters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

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

Description

Get the status of SCAP result deletion settings for the given organization.

Parameters

The following paramaters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

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

Description

Get the status of crash reporting settings for the given organization. Returns true if enabled, false otherwise.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

boolean - Get the status of crash reporting settings

23.9. Method: isCrashfileUploadEnabled

Description

Get the status of crash file upload settings for the given organization. Returns true if enabled, false otherwise.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

boolean - Get the status of crash file upload settings

23.10. Method: listOrgs

Description

Returns the list of organizations.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

struct - organization info
- int id
- string name
- int active_users - Number of active users in the organization
- int systems - Number of systems in the organization
- int trusts - Number of trusted organizations
- int system_groups - Number of system groups in the organization (optional)
- int activation_keys - Number of activation keys in the organization (optional)
- int kickstart_profiles - Number of kickstart profiles in the organization (optional)
- int configuration_channels - Number of configuration channels in the organization (optional)

23.11. Method: listSoftwareEntitlements

Description

List software entitlement allocation information across all organizations. Caller must be an administrator.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - entitlement usage
  - string label
  - string name
  - int free
  - int used
  - int allocated
  - int unallocated
  - int free_flex
  - int used_flex
  - int allocated_flex
  - int unallocated_flex

23.12. Method: listSoftwareEntitlements

Description

List each organization's allocation of a given software entitlement. Organizations with no allocation are not present in the list. A value of -1 indicates unlimited entitlements.

Note

This method is deprecated. Use the listSoftwareEntitlements(string sessionKey, string label, boolean includeUnentitled) method.

Parameters

The following parameters are available for this method:

string sessionKey
string label - Software entitlement label

Returns

The following return values are available for this method:

array:
- struct - entitlement usage
  - int org_id
  - string org_name
  - int allocated
  - int unallocated
  - int used
  - int free

23.13. Method: listSoftwareEntitlements

Description

List each organization's allocation of a given software entitlement. A value of -1 indicates unlimited entitlements.

Parameters

The following parameters are available for this method:

string sessionKey
string label - Software entitlement label
boolean includeUnentitled - If true, the result includes 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

The following return values are available for this method:

array:
- struct - entitlement usage
  - int org_id
  - string org_name
  - int allocated
  - int unallocated
  - int used
  - int free

Available since: 10.4

23.14. Method: listSoftwareEntitlementsForOrg

Description

List an organization's allocation of each software entitlement. A value of -1 indicates unlimited entitlements.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

array:
- struct - entitlement usage
  - string label
  - string name
  - int allocated
  - int unallocated
  - int free
  - int used
  - int allocated_flex
  - int unallocated_flex
  - int free_flex
  - int used_flex

23.15. Method: listSystemEntitlements

Description

Lists system entitlement allocation information across all organizations. Caller must be an administrator.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - entitlement usage
  - string label
  - string name
  - int free
  - int used
  - int allocated
  - int unallocated
  - int free_flex
  - int used_flex
  - int allocated_flex
  - int unallocated_flex

23.16. Method: listSystemEntitlements

Description

List each organization's allocation of a system entitlement. If the organization has no allocation for a particular entitlement, it does not appear in the list.

Note

This method is deprecated. Use the listSystemEntitlements(string sessionKey, string label, boolean includeUnentitled) method.

Parameters

The following parameters are available for this method:

string sessionKey
string label

Returns

The following return values are available for this method:

array:
- struct - entitlement usage
  - int org_id
  - string org_name
  - int allocated
  - int unallocated
  - int used
  - int free

23.17. Method: listSystemEntitlements

Description

List each organization's allocation of a system entitlement.

Parameters

The following parameters are available for this method:

string sessionKey
string label
boolean includeUnentitled - If true, the result includes both organizations that have the entitlement as well as those that do not; otherwise, the result only includes organizations that have the entitlement

Returns

The following return values are available for this method:

array:
- struct - entitlement usage
  - int org_id
  - string org_name
  - int allocated
  - int unallocated
  - int used
  - int free

Available since: 10.4

23.18. Method: listSystemEntitlementsForOrg

Description

List an organization's allocation of each system entitlement.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

array:
- struct - entitlement usage
  - string label
  - string name
  - int free
  - int used
  - int allocated
  - int unallocated

23.19. Method: listUsers

Description

Returns the list of users in a given organization.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

array:
- struct - user
  - string login
  - string login_uc
  - string name
  - string email
  - boolean is_org_admin

23.20. Method: migrateSystems

Description

Migrate systems from one organization to another. If a Satellite administrator executes this method, the systems migrate from their current organization to the organization specified by the toOrgId. If organization administrator executea this method, the systems existing in the same organization as that administrator migrate to the organization specified by the toOrgId. In any scenario, the origin and destination organizations are defined in a trust.

Parameters

The following parameters are available for this method:

string sessionKey
int toOrgId - ID of the destination organization for the system(s) migration
array:
- int systemId

Returns

The following return values are available for this method:

array:
- int serverIdMigrated

23.21. Method: setCrashFileSizeLimit

Description

Set the organization-wide crash file size limit. The limit value must be non-negative. Zero means no limit.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId
int limit - The limit to set (non-negative value)

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

23.22. Method: setCrashReporting

Description

Set the status of crash reporting settings for the given organization. Disabling crash reporting automatically disables crash file upload.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId
boolean enable - Use true or false to enable or disable respectively

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

23.23. Method: setCrashfileUpload

Description

Set the status of crash file upload settings for the given organization. Modifying the settings is possible as long as crash reporting is enabled.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId
boolean enable - Use true or false to enable or disable respectively

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

23.24. Method: setPolicyForScapFileUpload

Description

Set the status of SCAP detailed result file upload settings for the given organization.

Parameters

The following paramaters are available for this method:

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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

23.25. Method: setPolicyForScapResultDeletion

Description

Set the status of SCAP result deletion settings for the given organization.

Parameters

The following paramaters are available for this method:

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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

23.26. Method: setSoftwareEntitlements

Description

Set an organization's entitlement allocation for the given software entitlement. If increasing the entitlement allocation, the default organization (i.e. orgId=1) must have a sufficient number of free entitlements.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId
string label - Software entitlement label
int allocation

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

23.27. Method: setSoftwareFlexEntitlements

Description

Set an organization's flex entitlement allocation for the given software entitlement. If increasing the flex entitlement allocation, the default organization (i.e. orgId=1) must have a sufficient number of free flex entitlements.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId
string label - Software entitlement label
int allocation

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

23.28. Method: setSystemEntitlements

Description

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

23.29. Method: updateName

Description

Updates the name of an organization/

Parameters

The following parameters are available for this method:

string sessionKey
int orgId
string name - Organization name; must meet same criteria as in the web UI

Returns

The following return values are available for this method:

struct - organization info
- int id
- string name
- int active_users - Number of active users in the organization
- int systems - Number of systems in the organization
- int trusts - Number of trusted organizations
- int system_groups - Number of system groups in the organization (optional)
- int activation_keys - Number of activation keys in the organization (optional)
- int kickstart_profiles - Number of kickstart profiles in the organization (optional)
- int configuration_channels - Number of configuration channels in the organization (optional)

Chapter 24. Namespace: org.trusts

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

Namespace: org.trusts

24.1. Method: addTrust

Description

Add an organization to the list of trusted organizations.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId
int trustOrgId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

24.2. Method: getDetails

Description

The trust details about an organization given the organization's ID.

Parameters

The following parameters are available for this method:

string sessionKey
int trustOrgId - ID of the trusted organization

Returns

The following return values are available for this method:

struct - org trust details
- dateTime.iso8601 created - Date the organization was created
- dateTime.iso8601 trusted_since - Date the organization was defined as trusted
- int channels_provided - Number of channels provided by the organization
- int channels_consumed - Number of channels consumed by the organization
- int systems_migrated_to - Number of systems migrated to the organization
- int systems_migrated_from - Number of systems migrated from the organization

24.3. Method: listChannelsConsumed

Description

Lists all software channels that the organization given may consume from the user's organization.

Parameters

The following parameters are available for this method:

string sessionKey
int trustOrgId - ID of the trusted organization

Returns

The following return values are available for this method:

array:
- struct - channel info
  - int channel_id
  - string channel_name
  - int packages
  - int systems

24.4. Method: listChannelsProvided

Description

Lists all software channels that the defined organization is providing to the user's organization.

Parameters

The following parameters are available for this method:

string sessionKey
int trustOrgId - ID of the trusted organization

Returns

The following return values are available for this method:

array:
- struct - channel info
  - int channel_id
  - string channel_name
  - int packages
  - int systems

24.5. Method: listOrgs

Description

List all organanizations the user's organization trusts.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - trusted organizations
  - int org_id
  - string org_name
  - int shared_channels

24.6. Method: listSystemsAffected

Description

Get a list of systems within the trusted organization that would be affected if the trust relationship was removed. This basically lists systems that are sharing at least one package.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId
string trustOrgId

Returns

The following return values are available for this method:

array:
- struct - affected systems
  - int systemId
  - string systemName

24.7. Method: listTrusts

Description

Returns the list of trusted organizations.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId

Returns

The following return values are available for this method:

array:
- struct - trusted organizations
  - int orgId
  - string orgName
  - bool trustEnabled

24.8. Method: removeTrust

Description

Remove an organization to the list of trusted organizations.

Parameters

The following parameters are available for this method:

string sessionKey
int orgId
int trustOrgId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Chapter 25. Namespace: packages

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

Namespace: packages

25.1. Method: findByNvrea

Description

Looks up the details for packages with the given name, version, release, architecture label, and optionally epoch.

Parameters

The following parameters are available for this method:

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 and if the epoch is null or there is only one NVRA combination, the NVRA combination is returned (Empty string is recommended)
string archLabel

Returns

The following return values are available for this method:

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

Description

Retrieve details for the package with the ID.

Parameters

The following parameters are available for this method:

string sessionKey
int packageId

Returns

The following return values are available for this method:

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

Description

Retrieve the package file associated with a package.

Important

Some larger package files result in an exception when attempting to download over XML-RPC. For larger package file, use the getPackageUrl method.

Parameters

The following parameters are available for this method:

string sessionKey
int package_id

Returns

The following return values are available for this method:

binary object - package file

25.4. Method: getPackageUrl

Description

Retrieve the URL used to download a package. The URL expires after a certain time period.

Parameters

The following parameters are available for this method:

string sessionKey
int package_id

Returns

The following return values are available for this method:

string - The download url

25.5. Method: listChangelog

Description

List the change log for a package.

Parameters

The following parameters are available for this method:

string sessionKey
int packageId

Returns

The following return values are available for this method:

string

25.6. Method: listDependencies

Description

List the dependencies for a package.

Parameters

The following parameters are available for this method:

string sessionKey
int packageId

Returns

The following return values are available for this method:

array:
- struct - dependency
  - string "dependency"
  - string "dependency_type" - One of the following:
    requires
    conflicts
    obsoletes
    provides
  - string "dependency_modifier"

25.7. Method: listFiles

Description

List the files associated with a package.

Parameters

The following parameters are available for this method:

string sessionKey
int packageId

Returns

The following return values are available for this method:

array:
- struct - file info
  - string path
  - string type
  - string last_modified_date
  - string checksum
  - string checksum_type
  - int size
  - string linkto

25.8. Method: listProvidingChannels

Description

List the channels that provide the a package.

Parameters

The following parameters are available for this method:

string sessionKey
int packageId

Returns

The following return values are available for this method:

array:
- struct - channel
  - string label
  - string parent_label
  - string name

25.9. Method: listProvidingErrata

Description

List the errata providing a package.

Parameters

The following parameters are available for this method:

string sessionKey
int packageId

Returns

The following return values are available for this method:

array:
- struct - errata
  - string advisory
  - string issue_date
  - string last_modified_date
  - string update_date
  - string synopsis
  - string type

25.10. Method: removePackage

Description

Remove a package from the satellite.

Parameters

The following parameters are available for this method:

string sessionKey
int packageId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Chapter 26. Namespace: packages.provider

Methods to retrieve information about Package Providers associated with packages.

Namespace: packages.provider

26.1. Method: associateKey

Description

Associate a package security key and with the package provider. If the provider or key does not exist, it is created. User executing the request must be an administrator.

Parameters

The following parameters are available for this method:

string sessionKey
string providerName - The provider name
string key - The actual key
string type - The type of the key. Only gpg is supported

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

26.2. Method: list

Description

List all Package Providers. User executing the request must be an administrator.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - package provider
  - string name
  - array keys
    struct - package security key
    string key
    string type

26.3. Method: listKeys

Description

List all security keys associated with a package provider. User executing the request must be an administrator.

Parameters

The following parameters are available for this method:

string sessionKey
string providerName - The provider name

Returns

The following return values are available for this method:

array:
- struct - package security key
  - string key
  - string type

Chapter 27. Namespace: packages.search

Methods to interface to package search capabilities in search server.

Namespace: packages.search

27.1. Method: advanced

Description

Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax. Lucene Query Parser syntax is defined at lucene.apache.org. Fields searchable for packages include: name, epoch, version, release, arch, description, summary.

Example 27.1. Lucene query example

name:kernel AND version:2.6.18 AND -description:devel

Parameters

The following parameters are available for this method:

string sessionKey
string luceneQuery - A query written in the form of Lucene Query Parser Syntax

Returns

The following return values are available for this method:

array:
- struct - package overview
  - int id
  - string name
  - string summary
  - string description
  - string version
  - string release
  - string arch
  - string epoch
  - string provider

27.2. Method: advancedWithActKey

Description

Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax, additionally this method will limit results to those which are associated with a given activation key. Lucene Query Parser syntax is defined at lucene.apache.org. Fields searchable for packages include: name, epoch, version, release, arch, description, summary.

Example 27.2. Lucene query example

name:kernel AND version:2.6.18 AND -description:devel

Parameters

The following parameters are available for this method:

string sessionKey
string luceneQuery - A query written in the form of Lucene Query Parser Syntax
string actKey - Activation key containing packages

Returns

The following return values are available for this method:

array:
- struct - package overview
  - int id
  - string name
  - string summary
  - string description
  - string version
  - string release
  - string arch
  - string epoch
  - string provider

27.3. Method: advancedWithChannel

Description

Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax, additionally this method will limit results to those which are in the passed in channel label. Lucene Query Parser syntax is defined at lucene.apache.org. Fields searchable for packages include: name, epoch, version, release, arch, description, summary.

Example 27.3. Lucene query example

name:kernel AND version:2.6.18 AND -description:devel

Parameters

The following parameters are available for this method:

string sessionKey
string luceneQuery - A query written in the form of Lucene Query Parser Syntax
string channelLabel - Channel Label

Returns

The following return values are available for this method:

array:
- struct - package overview
  - int id
  - string name
  - string summary
  - string description
  - string version
  - string release
  - string arch
  - string epoch
  - string provider

27.4. Method: name

Description

Search the Lucene package indexes for all packages that match the given name.

Parameters

The following parameters are available for this method:

string sessionKey
string name - Package name to search

Returns

The following return values are available for this method:

array:
- struct - package overview
  - int id
  - string name
  - string summary
  - string description
  - string version
  - string release
  - string arch
  - string epoch
  - string provider

27.5. Method: nameAndDescription

Description

Search the Lucene package indexes for all packages that match the given query in name or description.

Parameters

The following parameters are available for this method:

string sessionKey
string query - Text to match in package name or description

Returns

The following return values are available for this method:

array:
- struct - package overview
  - int id
  - string name
  - string summary
  - string description
  - string version
  - string release
  - string arch
  - string epoch
  - string provider

27.6. Method: nameAndSummary

Description

Search the Lucene package indexes for all packages that match the given query in name or summary.

Parameters

The following parameters are available for this method:

string sessionKey
string query - Text to match in package name or summary

Returns

The following return values are available for this method:

array:
- struct - package overview
  - 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

Namespace: preferences.locale

28.1. Method: listLocales

Description

Returns a list of all understood locales. Use results as input for setLocale.

Returns

The following return values are available for this method:

array:
- string - Locale code

28.2. Method: listTimeZones

Description

Returns a list of all understood timezones. Use results as input for setTimeZone.

Returns

The following return values are available for this method:

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

Description

Set a user's locale.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
string locale - Locale to set (from listLocales)

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

28.4. Method: setTimeZone

Description

Set a user's timezone.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
int tzid - Timezone ID (from listTimeZones)

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Chapter 29. Namespace: proxy

Provides methods to activate/deactivate a proxy server.

Namespace: proxy

29.1. Method: activateProxy

Description

Activates the proxy identified from the given client certificate e.g. systemid file.

Parameters

The following parameters are available for this method:

string systemid - systemid file
string version - Version of proxy to be registered

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

29.2. Method: createMonitoringScout

Description

Create Monitoring Scout for proxy.

Parameters

The following parameters are available for this method:

string systemid - systemid file

Returns

The following return values are available for this method:

string

Available since: 10.7

29.3. Method: deactivateProxy

Description

Deactivates the proxy identified from the given client certificate e.g. systemid file.

Parameters

The following parameters are available for this method:

string systemid - systemid file

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

29.4. Method: isProxy

Description

Test for proxy on the system identified by the given client certificate e.g. systemid file.

Parameters

The following parameters are available for this method:

string systemid - systemid file

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

29.5. Method: listAvailableProxyChannels

Description

List available version of proxy channel for system identified from the given client certificate e.g. systemid file.

Parameters

The following parameters are available for this method:

string systemid - systemid file

Returns

The following return values are available for this method:

array:
- string - version

Available since: 10.5

Chapter 30. Namespace: satellite

Provides methods to obtain details on the Satellite.

Namespace: satellite

30.1. Method: getCertificateExpirationDate

Description

Retrieves the certificate expiration date of the activated certificate.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

dateTime.iso8601

30.2. Method: isMonitoringEnabled

Description

Indicates if monitoring is enabled on the Satellite.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

boolean true if monitoring is enabled

30.3. Method: isMonitoringEnabledBySystemId

Description

Indicates if monitoring is enabled on the Satellite.

Parameters

The following parameters are available for this method:

string systemid - systemid file

Returns

The following return values are available for this method:

boolean true if monitoring is enabled

30.4. Method: listEntitlements

Description

Lists all channel and system entitlements for the organization associated with the user executing the request.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

struct - channel or system entitlements
- array system
  - struct - system entitlement
    string label
    string name
    int used_slots
    int free_slots
    int total_slots
- array channel
  - struct - channel entitlement
    string label
    string name
    int used_slots
    int free_slots
    int total_slots
    int used_flex
    int free_flex
    int total_flex

30.5. Method: listProxies

Description

List the Proxies within the user's organization.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time the server completed a successful check-in

Chapter 31. Namespace: schedule

Methods to retrieve information about scheduled actions

Namespace: schedule

31.1. Method: archiveActions

Description

Archive all actions in the given list.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int action - The action ID

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

31.2. Method: cancelActions

Description

Cancel all actions in a given list. If provided an invalid action, the Satellite cancels none of the provided actions.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int action - The action ID

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

31.3. Method: deleteActions

Description

Delete all archived actions in a given list.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int action - The action ID

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

31.4. Method: listAllActions

Description

Returns a list of all actions. This includes completed, in progress, failed and archived actions.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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 action's earliest date and time for the action's next performance
  - int completedSystems - Number of systems that completed the action
  - int failedSystems - Number of systems that failed the action
  - int inProgressSystems - Number of systems in progress

31.5. Method: listArchivedActions

Description

Returns a list of archived actions.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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 action's earliest date and time for the action's next performance
  - int completedSystems - Number of systems that completed the action
  - int failedSystems - Number of systems that failed the action
  - int inProgressSystems - Number of systems in progress

31.6. Method: listCompletedActions

Description

Returns a list of successfully completed actions.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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 action's earliest date and time for the action's next performance
  - int completedSystems - Number of systems that completed the action
  - int failedSystems - Number of systems that failed the action
  - int inProgressSystems - Number of systems in progress

31.7. Method: listCompletedSystems

Description

Returns a list of systems that have completed a specific action.

Parameters

The following parameters are available for this method:

string sessionKey
string actionId

Returns

The following return values are available for this method:

array:
- struct - system
  - int server_id
  - string server_name - Server name
  - string base_channel - Base channel the server uses
  - dateTime.iso8601 timestamp - The completion time for the action
  - string message - Optional message containing details on the execution of the action; for example, if the action failed, this contains the failure text

31.8. Method: listFailedActions

Description

Returns a list of failed actions.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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 action's earliest date and time for the action's next performance
  - int completedSystems - Number of systems that completed the action
  - int failedSystems - Number of systems that failed the action
  - int inProgressSystems - Number of systems in progress

31.9. Method: listFailedSystems

Description

Returns a list of systems that have failed a specific action.

Parameters

The following parameters are available for this method:

string sessionKey
string actionId

Returns

The following return values are available for this method:

array:
- struct - system
  - int server_id
  - string server_name - Server name
  - string base_channel - Base channel the server uses
  - dateTime.iso8601 timestamp - The completion time for the action
  - string message - Optional message containing details on the execution of the action; for example, if the action failed, this contains the failure text

31.10. Method: listInProgressActions

Description

Returns a list of actions that are in progress.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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 action's earliest date and time for the action's next performance
  - int completedSystems - Number of systems that completed the action
  - int failedSystems - Number of systems that failed the action
  - int inProgressSystems - Number of systems in progress

31.11. Method: listInProgressSystems

Description

Returns a list of systems that have a specific action in progress.

Parameters

The following parameters are available for this method:

string sessionKey
string actionId

Returns

The following return values are available for this method:

array:
- struct - system
  - int server_id
  - string server_name - Server name
  - string base_channel - Base channel the server uses
  - dateTime.iso8601 timestamp - The completion time for the action
  - string message - Optional message containing details on the execution of the action; for example, if the action failed, this contains the failure text

31.12. Method: rescheduleActions

Description

Reschedule all actions in the given list.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int action - The action ID
boolean onlyFailed - true to only reschedule failed actions, false to reschedule all

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Chapter 32. Namespace: sync.master

Contains methods to set up information about known Master Satellites for use on the Slave Satellite side of Inter-Satellite Synchronization.

Namespace: sync.master

32.1. Method: addToMaster

Description

Add a single organization to the list of those the specified Master has exported to this Slave.

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the desired Master
struct - master-org details
- int masterOrgId
- string masterOrgName
- int localOrgId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

32.2. Method: create

Description

Create a new Master, known to this Slave.

Parameters

The following parameters are available for this method:

string sessionKey
string label - The Master's fully-qualified domain name

Returns

The following return values are available for this method:

struct - IssMaster info
- int id
- string label

32.3. Method: delete

Description

Remove the specified Master.

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the Master to remove

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

32.4. Method: getDefaultMaster

Description

Return the current default master for this slave

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

struct - IssMaster info
- int id
- string label
- string caCert
- boolean isCurrentMaster

32.5. Method: getMaster

Description

Get information about the specified Master.

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the desired Master

Returns

The following return values are available for this method:

struct - IssMaster info
- int id
- string label

32.6. Method: getMasterByLabel

Description

Get information about the specified Master using a label to identify.

Parameters

The following parameters are available for this method:

string sessionKey
string label - Label of the desired Master

Returns

The following return values are available for this method:

struct - IssMaster info
- int id
- string label

32.7. Method: getMasterOrgs

Description

List all organizations the specified Master has exported to this Slave.

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the desired Master

Returns

The following return values are available for this method:

array:
- struct - IssMasterOrg info
  - int masterOrgId
  - string masterOrgName
  - int localOrgId

32.8. Method: getMasters

Description

Get all Masters known by a Slave.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - IssMaster info
  - int id
  - string label

32.9. Method: makeDefault

Description

Make the specified Master the default for this Slave's satellite synchronization.

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the Master to make the default

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

32.10. Method: mapToLocal

Description

Add a single organizations to the list of those the specified Master has exported to this Slave.

Parameters

The following parameters are available for this method:

string sessionKey
int masterId - ID of the desired Master
int masterOrgId - ID of the desired Master
int localOrgId - ID of the desired Master

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

32.11. Method: setCaCert

Description

Set the Certifcate Authority for the specified Master.

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the Master to affect
string caCertFilename - path to specified Master's CA cert

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

32.12. Method: setMasterOrgs

Description

List all organizations the specified Master has exported to this Slave.

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the desired Master
array:
- struct - master-org details
  - int masterOrgId
  - string masterOrgName
  - int localOrgId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

32.13. Method: unsetDefaultMaster

Description

Make this slave have no default Master for Satellite synchronization.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

32.14. Method: update

Description

Updates the label of the specified Master.

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the Master to update
string label - Desired new label

Returns

The following return values are available for this method:

struct - IssMaster info
- int id
- string label

Chapter 33. Namespace: sync.slave

Contains methods to set up information about allowed Red Hat Satellite Slave Servers, for use on the Red Hat Satellite Master Server side of Inter-Satellie Synchronization.

Namespace: sync.slave

33.1. Method: create

Description

Create a new Slave, known to this Slave.

Parameters

The following parameters are available for this method:

string sessionKey
string slave - Slave's fully-qualified domain name
boolean enabled - Defines if the Slave is active and communicating
boolean allowAllOrgs - Defines whether to export all organizations to this slave

Returns

The following return values are available for this method:

struct - IssSlave info
- int id
- string slave
- boolean enabled
- boolean allowAllOrgs

33.2. Method: delete

Description

Remove the specified Slave

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the Slave to remove

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

33.3. Method: getAllowedOrgs

Description

Get all Slaves this Master knows.

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the desired Slave

Returns

The following return values are available for this method:

array:
- int - IDs of allowed organizations

33.4. Method: getSlave

Description

Find a Slave by specifying its ID.

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the desired Slave

Returns

The following return values are available for this method:

struct - IssSlave info
- int id
- string slave
- boolean enabled
- boolean allowAllOrgs

33.5. Method: getSlaveByName

Description

Find a Slave by specifying its fully-qualified domain name.

Parameters

The following parameters are available for this method:

string sessionKey
string fqdn - Domain name of the desired Slave

Returns

The following return values are available for this method:

struct - IssSlave info
- int id
- string slave
- boolean enabled
- boolean allowAllOrgs

33.6. Method: getSlaves

Description

Get all slaves this master knows.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - IssSlave info
  - int id
  - string slave
  - boolean enabled
  - boolean allowAllOrgs

33.7. Method: setAllowedOrgs

Description

Get all the Slaves this Master knows.

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the desired Slave
array:
- int - List of revisions to delete

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

33.8. Method: update

Description

Updates the label of the specified Slave

Parameters

The following parameters are available for this method:

string sessionKey
int id - ID of the Slave to update
boolean enabled - Defines if the Slave is active and communicating
boolean allowAllOrgs - Defines whether to export all organizations to this slave

Returns

The following return values are available for this method:

struct - IssSlave info
- int id
- string slave
- boolean enabled
- boolean allowAllOrgs

Chapter 34. Namespace: system

Provides methods to access and modify registered system.

Namespace: system

34.1. Method: addEntitlements

Description

Add add-on entitlements to a server. Entitlements a server already has are quietly ignored.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
array:
- string - entitlementLabel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.2. Method: addNote

Description

Add a new note to the given server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string subject - The note's subject
string body - Content of the note

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.3. Method: applyErrata

Description

Schedules an action to apply errata updates to a system.

Note

This method is deprecated. Use the system.scheduleApplyErrata(string sessionKey, int serverId, array[int errataId]) method.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
array:
- int - errataId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.4. Method: comparePackageProfile

Description

Compare a system's packages against a package profile. In the result returned, this_system represents the server provided as an input and other_system represents the profile provided as an input.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string profileLabel

Returns

The following return values are available for this method:

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

Description

Compares the packages installed on two systems.

Parameters

The following parameters are available for this method:

string sessionKey
int thisServerId
int otherServerId

Returns

The following return values are available for this method:

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

Description

Converts the given list of systems for a given channel family to use the flex entitlement.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int serverId
string channelFamilyLabel

Returns

The following return values are available for this method:

int - The total the number of systems converted to use flex entitlement

34.7. Method: createPackageProfile

Description

Create a new stored package profile from a systems installed package list.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string profileLabel
string description

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.8. Method: createSystemRecord

Description

Creates a cobbler system record with the specified kickstart label

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string ksLabel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.9. Method: deleteCustomValues

Description

Delete the custom values defined for the custom system information keys provided from the given system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
array:
- string - customInfoLabel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.10. Method: deleteGuestProfiles

Description

Delete the specified list of guest profiles for a given host.

Parameters

The following parameters are available for this method:

string sessionKey
int hostId
array:
- string - guestNames

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.11. Method: deleteNote

Description

Deletes the given note from the server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
int noteId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.12. Method: deleteNotes

Description

Deletes all notes from the server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.13. Method: deletePackageProfile

Description

Delete a package profile.

Parameters

The following parameters are available for this method:

string sessionKey
int profileId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.14. Method: deleteSystem

Description

Delete a system given its client certificate.

Parameters

The following parameters are available for this method:

string systemid - systemid file

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Available since: 10.10

34.15. Method: deleteSystem

Description

Delete a system given its server ID synchronously.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.16. Method: deleteSystems

Description

Delete systems given a list of system IDs asynchronously.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int - serverId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.17. Method: deleteTagFromSnapshot

Description

Deletes tag from system snapshot.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string tagName

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.18. Method: downloadSystemId

Description

Get the system ID file for a given server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

string

34.19. Method: getConnectionPath

Description

Get the list of proxies the given system connects through in order to reach the server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

34.20. Method: getCpu

Description

Gets the CPU information of a system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

Description

Get the custom data values defined for the server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

struct - custom value
- string - Custom info label

34.22. Method: getDetails

Description

Get system details.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

struct - server details
- int id - System ID
- string profile_name
- string base_entitlement - System's base entitlement label; either enterprise_entitled or sw_mgr_entitled
- array string
  - add-on_entitlements - System's add-on entitlements
  - Labels including monitoring_entitled, provisioning_entitled, virtualization_host, or virtualization_host_platform
- boolean auto_update - true if system has auto errata updates enabled
- string release - The Operating System release i.e. 4AS, 5Server, etc
- 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 the system is locked. false indicates that the system is unlocked
- string virtualization - Virtualization type for virtual guests only (optional)

34.23. Method: getDevices

Description

Gets a list of devices for a system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

Description

Gets the DMI information of a system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

Description

Gets the entitlements for a given server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

array:
- string - entitlement_label

34.26. Method: getEventHistory

Description

Returns a list of history items associated with the system, ordered from newest to oldest. Note that the details might be empty for events scheduled against the system (as compared to instant). For more information about such events, see the system.listSystemEvents operation.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

34.27. Method: getId

Description

Get system IDs and last check-in information for the given system name.

Parameters

The following parameters are available for this method:

string sessionKey
string systemName

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Time of server's last successful check-in

34.28. Method: getMemory

Description

Gets the memory information for a system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

struct - memory
- int ram - The amount of physical memory in MB
- int swap - The amount of swap space in MB

34.29. Method: getName

Description

Get system name and last check-in information for the given system ID.

Parameters

The following parameters are available for this method:

string sessionKey
string serverId

Returns

The following return values are available for this method:

struct - name info
- int id - Server ID
- string name - Server name
- dateTime.iso8601 last_checkin - Time of server's last successful check-in

34.30. Method: getNetwork

Description

Get the addresses and hostname for a given server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

34.31. Method: getNetworkDevices

Description

Returns the network devices for the given server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

array:
- struct - network device
  - string ip - IP address assigned to this network device
  - string interface - Network interface assigned to device e.g. eth0
  - string netmask - Network mask assigned to device
  - string hardware_address - Hardware Address of device.
  - string module - Network driver used for this device.
  - string broadcast - Broadcast address for device.
  - array ipv6 - List of IPv6 addresses
  - array:
    struct - ipv6 address
    string address - IPv6 address of this network device
    string netmask - IPv6 netmask of this network device
    string scope - IPv6 address scope

34.32. Method: getRegistrationDate

Description

Returns the date the system was registered.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

34.33. Method: getRelevantErrata

Description

Returns a list of all errata that are relevant to the system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata ID
  - string date - Erratum creation date
  - string update_date - Erratum update date
  - string advisory_synopsis - Summary of the erratum.
  - string advisory_type - Type label, such as "Security", "Bug Fix", or "Enhancement"
  - string advisory_name - Name, such as RHSA

34.34. Method: getRelevantErrataByType

Description

Returns a list of all errata of the specified type relevant to the system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string advisoryType - Type of advisory; one of of the following: "Security Advisory", "Product Enhancement Advisory", or "Bug Fix Advisory".

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata ID
  - string date - Erratum creation date
  - string update_date - Erratum update date
  - string advisory_synopsis - Summary of the erratum.
  - string advisory_type - Type label, such as "Security", "Bug Fix", or "Enhancement"
  - string advisory_name - Name, such as RHSA

34.35. Method: getRunningKernel

Description

Returns the running kernel of the given system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

string

34.36. Method: getScriptActionDetails

Description

Returns script details for script run actions

Parameters

The following parameters are available for this method:

string sessionKey
int actionId - ID of the script run action

Returns

The following return values are available for this method:

struct - Script details
- int id - Action ID
  string content - Script content
  string run_as_user - Run as user
  string run_as_group - Run as group
  int timeout - Timeout in seconds
  array:
  - struct - script result
    int serverId - ID of the server the script runs
    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

Description

Fetch results from a script execution. Returns an empty array if no results are yet available.

Parameters

The following parameters are available for this method:

string sessionKey
int actionId - ID of the script run action

Returns

The following return values are available for this method:

array:
- struct - script result
  - int serverId - ID of the server the script runs
  - 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

Description

Provides the base channel of a given system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

struct - channel
- int id
- string name
- string label
- string arch_name
- 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

Description

Get the system currency score multipliers.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

Map of score multipliers

34.40. Method: getSystemCurrencyScores

Description

Get the System Currency scores for all servers the user has access.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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

34.41. Method: getUnscheduledErrata

Description

Provides an array of errata applicable to a given system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

array:
- struct - errata
  - int id - Errata ID
  - string date - Erratum creation date
  - 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

Description

Get the UUID from the given system ID.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

string

34.43. Method: getVariables

Description

Lists kickstart variables set in the system record for the specified server.

Note

This call assumes that a system record exists in cobbler for the given system and raises an XML-RPC fault if not the case. To create a system record over XML-RPC use system.createSystemRecord. To create a system record in the Web UI navigate to System → Specified System → Provisioning → Select a Kickstart profile → Create Cobbler System Record.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

34.44. Method: isNvreInstalled

Description

Check if the package with the given NVRE is installed on given system.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

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

34.45. Method: isNvreInstalled

Description

Is the package with the given NVRE installed on given system.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

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

34.46. Method: listActivationKeys

Description

List the activation keys registered with the system. An empty list is returned if an activation key is not used during registration.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

array:
- string - key

34.47. Method: listActiveSystems

Description

Returns a list of active servers visible to the user.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

34.48. Method: listActiveSystemsDetails

Description

Given a list of server IDs, returns a list of active servers' details visible to the user.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int - serverIds

Returns

The following return values are available for this method:

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

34.49. Method: listAdministrators

Description

Returns a list of users that can administer the system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

Description

Get the list of all installable packages for a given system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

34.51. Method: listBaseChannels

Description

Returns a list of subscribable base channels.

Note

This method is deprecated. Use the listSubscribableBaseChannels(string sessionKey, int serverId) method.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

Description

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

Note

This method is deprecated. Use the listSubscribableChildChannels(string sessionKey, int serverId) method.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

34.53. Method: listDuplicatesByHostname

Description

List duplicate systems by hostname.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - Duplicate Group
  - string hostname
  - array systems
    struct - system
    int systemId
    string systemName
    dateTime.iso8601 last_checkin - Last successful server check-in

34.54. Method: listDuplicatesByIp

Description

List duplicate systems by IP Address.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - Duplicate Group
  - string ip
  - array systems
    struct - system
    int systemId
    string systemName
    dateTime.iso8601 last_checkin - Last successful server check-in

34.55. Method: listDuplicatesByMac

Description

List duplicate systems by MAC Address.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - Duplicate Group
  - string mac
  - array systems
    struct - system
    int systemId
    string systemName
    dateTime.iso8601 last_checkin - Last successful server check-in

34.56. Method: listEligibleFlexGuests

Description

List eligible flex guests accessible to the user.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - channel family system group
  - int id
  - string label
  - string name
  - array:
    int - systems

34.57. Method: listExtraPackages

Description

List extra packages for a system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

Description

List flex guests accessible to the user

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - channel family system group
  - int id
  - string label
  - string name
  - array:
    int - systems

34.59. Method: listGroups

Description

List the available groups for a given system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

34.60. Method: listInactiveSystems

Description

Lists systems that have been inactive for the default period of inactivity.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

34.61. Method: listInactiveSystems

Description

Lists systems that have been inactive for the specified number of days.

Parameters

The following parameters are available for this method:

string sessionKey
int days

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

34.62. Method: listLatestAvailablePackage

Description

Get the latest available version of a package for each system.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int - serverId
string packageName

Returns

The following return values are available for this method:

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

Description

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

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - int id
  - string arch_label

34.64. Method: listLatestUpgradablePackages

Description

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

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

Description

Given a package name, version, release, and epoch, returns the list of packages installed on the system with the same name that are newer.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch

34.66. Method: listNotes

Description

Provides a list of notes associated with a system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

array:
- struct - note details
  - int id
  - string subject - Subject of the note
  - string note - Contents of the note
  - int system_id - The ID of the system associated with the note
  - string creator - Creator of the note
  - date updated - Date of the last note update

34.67. Method: listOlderInstalledPackages

Description

Given a package name, version, release, and epoch, returns the list of packages installed on the system with the same name that are older.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch

34.68. Method: listOutOfDateSystems

Description

Returns list of systems needing package updates.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

34.69. Method: listPackageProfiles

Description

List the package profiles in this organization

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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

34.70. Method: listPackages

Description

List the installed packages for a given system. The attribute installtime is returned since API version 10.10.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

34.71. Method: listPackagesFromChannel

Description

Provides a list of packages installed on a system that are also contained in the given channel. The installed package list does not include architecture information before Red Hat Enterprise Linux 5, so it is architecture unaware. Red Hat Enterprise Linux 5 systems do upload the architecture information, and thus are architecture aware.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string channelLabel

Returns

The following return values are available for this method:

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 its GPG key
  - dateTime.iso8601 last_modified

34.72. Method: listPhysicalSystems

Description

Returns a list of all physical servers visible to the user.

Parameters

The following paramaters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server successfully checked in

34.73. Method: listSubscribableBaseChannels

Description

Returns a list of subscribable base channels.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

Description

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

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

34.75. Method: listSubscribedChildChannels

Description

Returns a list of subscribed child channels.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

array:
- struct - channel
  - int id
  - string name
  - string label
  - string arch_name
  - 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

Description

List all system events for given server. This includes all events for the server since registration. This might require the caller to filter the results to fetch the desired events.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId - ID of system

Returns

The following return values are available for this method:

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 and time the event was completed; format is YYYY-MM-dd hh:mm:ss.ms e.g. 2007-06-04 13:58:13.0 (optional) (deprecated by completed_date)
  - dateTime.iso8601 completed_date - The date and time the event was completed (optional)
  - string pickup_time - The date and time of the action pick-up. Format is YYYY-MM-dd hh:mm:ss.ms e.g. 2007-06-04 13:58:13.0 (optional) (deprecated by pickup_date)
  - dateTime.iso8601 pickup_date - The date and time of the action pick-up. (optional)
  - string result_msg - The result string after the action executes on 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 is the package name; for an errata event, this is the advisory name and synopsis; for a config file event, this is the path and optional revision information
    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); in the case of a config file comparison, it might include the differenes found

Available since: 10.8

34.77. Method: listSystems

Description

Returns a list of all servers visible to the user.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

34.78. Method: listSystemsWithExtraPackages

Description

List systems with extra packages.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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

34.79. Method: listSystemsWithPackage

Description

Lists the systems that have the given installed package.

Parameters

The following parameters are available for this method:

string sessionKey
int pid - The package ID

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

34.80. Method: listSystemsWithPackage

Description

Lists the systems that have the given installed package

Parameters

The following parameters are available for this method:

string sessionKey
string name - The package name
string version - The package version
string release - The package release

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

34.81. Method: listUngroupedSystems

Description

List systems that are not associated with any system groups.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - system
  - int id - Server ID
  - string name

34.82. Method: listUserSystems

Description

List systems for a given user.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

34.83. Method: listUserSystems

Description

List systems for the logged in user.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

34.84. Method: listVirtualGuests

Description

Lists the virtual guests for a given virtual host.

Parameters

The following parameters are available for this method:

string sessionKey
int sid - The virtual host's ID

Returns

The following return values are available for this method:

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

34.85. Method: listVirtualHosts

Description

Lists the virtual hosts visible to the user

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

34.86. Method: obtainReactivationKey

Description

Obtains a reactivation key for this server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

string

34.87. Method: obtainReactivationKey

Description

Obtains a reactivation key for this server.

Parameters

The following parameters are available for this method:

string systemid - systemid file

Returns

The following return values are available for this method:

string

Available since: 10.10

34.88. Method: provisionSystem

Description

Provision a system using the specified kickstart profile.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

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

34.89. Method: provisionSystem

Description

Provision a system using the specified kickstart profile.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

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

34.90. Method: provisionVirtualGuest

Description

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

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.91. Method: provisionVirtualGuest

Description

Provision a guest on the host specified. This schedules the guest for creation and begins the provisioning process when the host checks in. If OSAD is enabled, provisioning begins immediately. Defaults to mac_address=random.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId - ID of host to provision guest
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 guest's disk image

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.92. Method: provisionVirtualGuest

Description

Provision a guest on the host specified. This schedules the guest for creation and begins the provisioning process when the host checks in. If OSAD is enabled, provisioning begins immediately.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId - ID of host to provision guest
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 guest's disk image
string macAddress - macAddress to give the guest's virtual networking hardware

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.93. Method: removeEntitlements

Description

Remove add-on entitlements from a server. Entitlements a server does not have are quietly ignored.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
array:
- string - entitlement_label

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.94. Method: scheduleApplyErrata

Description

Schedules an action to apply errata updates to multiple systems.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

array:
- int actionId - The action ID of the scheduled action

Available since: 13.0

34.95. Method: scheduleApplyErrata

Description

Schedules an action to apply errata updates to multiple systems at a given date and time.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

array:
- int - actionId

Available since: 13.0

34.96. Method: scheduleApplyErrata

Description

Schedules an action to apply errata updates to a system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
array:
- int - errataId

Returns

The following return values are available for this method:

array:
- int - actionId

Available since: 13.0

34.97. Method: scheduleApplyErrata

Description

Schedules an action to apply errata updates to a system at a given date and time.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

array:
- int - actionId

Available since: 13.0

34.98. Method: scheduleGuestAction

Description

Schedules a guest action for the specified virtual guest for a given date and time.

Parameters

The following parameters are available for this method:

string sessionKey
int sid - The system IG of the guest
string state - One of the following actions: start, suspend, resume, restart, or shutdown
dateTime.iso8601 date - The date and time to schedule the action

Returns

The following return values are available for this method:

int actionId - The action ID of the scheduled action

34.99. Method: scheduleGuestAction

Description

Schedules a guest action for the specified virtual guest for the current time.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

int actionId - The action ID of the scheduled action

34.100. Method: scheduleHardwareRefresh

Description

Schedule a hardware refresh for a system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
dateTime.iso8601 earliestOccurrence

Returns

The following return values are available for this method:

int actionId - The action ID of the scheduled action

Available since: 13.0

34.101. Method: schedulePackageInstall

Description

Schedule package installation for a system.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

int actionId - The action ID of the scheduled action

Available since: 13.0

34.102. Method: schedulePackageRefresh

Description

Schedule a package list refresh for a system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
dateTime.iso8601 earliestOccurrence

Returns

The following return values are available for this method:

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

34.103. Method: schedulePackageRemove

Description

Schedule package removal for a system.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

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

34.104. Method: scheduleReboot

Description

Schedule a reboot for a system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
dateTime.iso860 earliestOccurrence

Returns

The following return values are available for this method:

int actionId - The action ID of the scheduled action

Available since: 13.0

34.105. Method: scheduleScriptRun

Description

Schedule a script to run.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int - System IDs of the servers to run the script
string username - User to run script
string groupname - Group to run script
int timeout - Seconds to allow the script to run before timeout
string script - Contents of the script to run
dateTime.iso8601 earliestOccurrence - Earliest the script can run

Returns

The following return values are available for this method:

int - ID of the script run action. Used to fetch results with system.getScriptResults

34.106. Method: scheduleScriptRun

Description

Schedule a script to run.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

int - ID of the script run action. Used to fetch results with system.getScriptResults

34.107. Method: scheduleSyncPackagesWithSystem

Description

Synchronize packages from a source system to a target.

Parameters

The following parameters are available for this method:

string sessionKey
int targetServerId - Target system to apply package changes
int sourceServerId - Source system to retrieve package state
array:
- int - packageId - Package IDs to be synchronized
dateTime.iso8601 date - Date to schedule action

Returns

The following return values are available for this method:

int actionId - The action ID of the scheduled action

34.108. Method: searchByName

Description

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

Parameters

The following parameters are available for this method:

string sessionKey
string regexp - A regular expression

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last successful server check-in

34.109. Method: setBaseChannel

Description

Assigns the server to a new baseChannel.

Note

This method is deprecated. Use the system.setBaseChannel(string sessionKey, int serverId, string channelLabel) method.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
int channelId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.110. Method: setBaseChannel

Description

Assigns the server to a new base channel. If the user provides an empty string for the channelLabel, the current base channel and all child channels are removed from the system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string channelLabel

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.111. Method: setChildChannels

Description

Subscribe the given server to the child channels provided. This method will unsubscribe the server from any child channels currently subscribed, but that are not included in the list. The user provides either a list of channel IDs (int) or a list of channel labels (string) as input.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.112. Method: setCustomValues

Description

Set custom values for the specified server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
struct - Map of custom labels to custom values
- string - Custom information label
- string value

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.113. Method: setDetails

Description

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

Parameters

The following parameters are available for this method:

string sessionKey
int serverId - ID of server to look up details
struct - server details
- string profile_name - System's profile name
- string base_entitlement - System's base entitlement labe; either 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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.114. Method: setGroupMembership

Description

Set a servers membership in a given group.

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.115. Method: setGuestCpus

Description

Schedule an action of a guest's host to set that guest's CPU allocation.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

int actionID - The action ID for the schedule action on the host system

34.116. Method: setGuestMemory

Description

Schedule an action of a guest's host to set that guest's memory allocation

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

int actionID - The action ID for the schedule action on the host system

34.117. Method: setLockStatus

Description

Set server lock status.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.118. Method: setPrimaryInterface

Description

Sets new primary network interface.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string interfaceName

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.119. Method: setProfileName

Description

Set the profile name for the server.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string name - Name of the profile

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.120. Method: setVariables

Description

Sets a list of kickstart variables in the cobbler system record for the specified server.

Note

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.121. Method: tagLatestSnapshot

Description

Tags latest system snapshot.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string tagName

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.122. Method: upgradeEntitlement

Description

Adds an entitlement to a given server.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

34.123. Method: whoRegistered

Description

Returns information about the user who registered the system

Parameters

The following parameters are available for this method:

string sessionKey
int sid - ID of the system in question

Returns

The following return values are available for this method:

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.

Namespace: system.config

35.1. Method: addChannels

Description

Given a list of servers and configuration channels, this method appends the configuration channels to either the top or the bottom, depending of the user's choice, of a system's subscribed configuration channels list. The list maintains the ordering of the configuration channels provided while adding. If the has previous subscribed to one of the configuration channels in the "add" list, the subscribed channel is ranked to the appropriate place.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int - IDs of the systems to add the channels
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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

35.2. Method: createOrUpdatePath

Description

Create a new text or binary file or directory with the given path, or update an existing path on a server.

Parameters

The following parameters are available for this method:

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 - path info
- string contents - Contents of the file (text or base64 encoded if binary) (only for non-directories)
- boolean contents_enc64 - Identifies base64 encoded content (default: disabled, only for non-directories)
- string owner - Owner of the file or directory
- string group - Group name of the file or directory
- string permissions - Octal file or directory permissions e.g. 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

The following return values are available for this method:

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; present for files or directories only (deprecated)
- string permissions_mode - File Permissions; present for files or directories only
- string selinux_ctx - SELinux context (optional)
- boolean binary - true or 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

Description

Create a new symbolic link with the given path, or update an existing path.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string path - The configuration file or directory path
struct - path info
- string target_path - The target path for the symbolic link
- string selinux_ctx - SELinux security context (optional)
- int revision - Next revision number, 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

The following return values are available for this method:

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

Description

Removes file paths from a local or sandbox channel of a server.

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

35.5. Method: deployAll

Description

Schedules a deploy action for all the configuration files on the given list of systems.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int - id of the systems to schedule configuration files deployment
dateTime.iso8601 date - Earliest date for the deploy action.

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

35.6. Method: listChannels

Description

List all global configuration channels associated to a system in the order of their ranking.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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

Description

Return the list of files in a given channel.

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

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; this entry only shows if a central channel has not overwritten the file
  - 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

Description

Given a list of paths and a server, this method returns details about the latest revisions of the paths.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
array:
- string - Paths to query
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

The following return values are available for this method:

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 ; present for files or directories only (deprecated)
  - string permissions_mode - File Permissions; present for files or directories only
  - string selinux_ctx - SELinux context (optional)
  - boolean binary - true or 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

Description

Remove config channels from the given servers.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int - The IDs of the systems to remove configuration channels
array:
- string - List of configuration channel labels to remove

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

35.10. Method: setChannels

Description

Replace the existing set of config channels on the given servers. Channels are ranked according to their order in the configChannelLabels array.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int - IDs of the systems to set the channels
array:
- string - List of configuration channel labels in the ranked order

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Chapter 36. Namespace: system.crash

Provides methods to access and modify software crash information.

Namespace: system.crash

36.1. Method: createCrashNote

Description

Create a crash note.

Parameters

The following parameters are available for this method:

string sessionKey
int crashId
string subject
string details

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

36.2. Method: deleteCrash

Description

Delete a crash with given crash ID.

Parameters

The following parameters are available for this method:

string sessionKey
int crashId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

36.3. Method: deleteCrashNote

Description

Delete a crash note.

Parameters

The following parameters are available for this method:

string sessionKey
int crashNoteId

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

36.4. Method: getCrashCountInfo

Description

Return date of last software crashes report for given system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

struct - Crash Count 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

Description

Download a crash file.

Parameters

The following parameters are available for this method:

string sessionKey
int crashFileId

Returns

The following return values are available for this method:

base64 - base64 encoded crash file

36.6. Method: getCrashFileUrl

Description

Get a crash file download URL.

Parameters

The following parameters are available for this method:

string sessionKey
int crashFileId

Returns

The following return values are available for this method:

string - The crash file download URL

36.7. Method: getCrashNotesForCrash

Description

List crash notes for crash.

Parameters

The following parameters are available for this method:

string sessionKey
int crashId

Returns

The following return values are available for this method:

array:
- struct - crashNote
  - int id
  - string subject
  - string details
  - string updated

36.8. Method: getCrashOverview

Description

Get software crash overview.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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

Description

List software crashes with given UUID.

Parameters

The following parameters are available for this method:

string sessionKey
string uuid

Returns

The following return values are available for this method:

array:
- struct - crash
  - int server_id - ID of the server the crash occurred
  - 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

Description

Return list of crash files for given crash ID.

Parameters

The following parameters are available for this method:

string sessionKey
int crashId

Returns

The following return values are available for this method:

array:
- struct - crashFile
  - int id
  - string filename
  - string path
  - int filesize
  - boolean is_uploaded
  - date created
  - date modified

36.11. Method: listSystemCrashes

Description

Return list of software crashes for a system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

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.

Namespace: system.custominfo

37.1. Method: createKey

Description

Create a new custom key.

Parameters

The following parameters are available for this method:

string sessionKey
string keyLabel - New key's label
string keyDescription - New key's description

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

37.2. Method: deleteKey

Description

Delete an existing custom key and all systems' values for the key.

Parameters

The following parameters are available for this method:

string sessionKey
string keyLabel - New key's label

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

37.3. Method: listAllKeys

Description

List the custom information keys defined for the user's organization.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - custom info
  - int id
  - string label
  - string description
  - int system_count
  - dateTime.iso8601 last_modified

37.4. Method: updateKey

Description

Update description of a custom key.

Parameters

The following parameters are available for this method:

string sessionKey
string keyLabel - Key to change
string keyDescription - New key's description

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise.

Chapter 38. Namespace: system.provisioning.snapshot

Provides methods to access and delete system snapshots.

Namespace: system.provisioning.snapshot

38.1. Method: addTagToSnapshot

Description

Adds tag to snapshot.

Parameters

The following parameters are available for this method:

string sessionKey
int snapshotId - ID of the snapshot
string tag - Name of the snapshot tag

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

38.2. Method: deleteSnapshot

Description

Deletes a snapshot with the given snapshot ID.

Parameters

The following parameters are available for this method:

string sessionKey
int snapshotId - ID of snapshot to delete

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Available since: 10.1

38.3. Method: deleteSnapshots

Description

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 are removed
If user provides startDate and endDate, all snapshots created on or between the dates provided are removed
If the user doesn't provide a startDate and endDate, all snapshots are removed

Parameters

The following parameters are available for this method:

string sessionKey
struct - date details
- dateTime.iso8601 startDate (Optional, unless endDate is provided)
- dateTime.iso8601 endDate (Optional)

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Available since: 10.1

38.4. Method: deleteSnapshots

Description

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 are removed
If user provides startDate and endDate, all snapshots created on or between the dates provided are removed
If the user doesn't provide a startDate and endDate, all snapshots associated with the server are removed

Parameters

The following parameters are available for this method:

string sessionKey
int sid - system ID of system to delete snapshots
struct - date details
- dateTime.iso8601 startDate (optional, unless endDate is provided)
- dateTime.iso8601 endDate (optional)

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Available since: 10.1

38.5. Method: listSnapshotConfigFiles

Description

List the configuration files associated with a snapshot.

Parameters

The following parameters are available for this method:

string sessionKey
int snapId

Returns

The following return values are available for this method:

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; present for files or directories only (Deprecated)
  - string permissions_mode - File Permissions; present for files or directories only
  - string selinux_ctx - SELinux Context (optional)
  - boolean binary - true or 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

Description

List the packages associated with a snapshot.

Parameters

The following parameters are available for this method:

string sessionKey
int snapId

Returns

The following return values are available for this method:

array:
- struct - package nvera
  - string name
  - string epoch
  - string version
  - string release
  - string arch

Available since: 10.1

38.7. Method: listSnapshots

Description

List snapshots for a given system. A user may optionally provide a start and end date to narrow the snapshots that are listed. For example:

If the user provides startDate only, all snapshots created either on or after the date provided are returned
If user provides startDate and endDate, all snapshots created on or between the dates provided are returned
If the user doesn't provide a startDate and endDate, all snapshots associated with the server are returned

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
struct - date details
- dateTime.iso8601 startDate (optional, unless endDate is provided)
- dateTime.iso8601 endDate (optional)

Returns

The following return values are available for this method:

array:
- struct - server snapshot
  - int id
  - string reason - The reason for the snapshot's existence
  - dateTime.iso8601 created
  - array channels
    string - Labels of channels associated with the snapshot
  - array groups
    string - Names of server groups associated with the snapshot
  - array entitlements
    string - Names of system entitlements associated with the snapshot
  - array config_channels
    string - Labels of config channels the snapshot is associated with
  - array tags
    string - Tag names associated with this snapshot
  - string Invalid_reason - If the snapshot is invalid, this is the reason (optional)

Available since: 10.1

Chapter 39. Namespace: system.scap

Provides methods to schedule SCAP scans and access the results.

Namespace: system.scap

39.1. Method: deleteXccdfScan

Description

Delete OpenSCAP XCCDF Scan from Satellite database. Note only SCAP scans that have passed their retention period can be deleted.

Parameters

The following paramaters are available for this method:

string sessionKey
int Id of XCCDF scan (xid).

Returns

The following return values are available for this method:

boolean - indicates success of the operation.

39.2. Method: getXccdfScanDetails

Description

Get details of given OpenSCAP XCCDF scan.

Parameters

The following parameters are available for this method:

string sessionKey
int - ID of XCCDF scan (xid).

Returns

The following return values are available for this method:

struct - OpenSCAP XCCDF Scan
- int xid - XCCDF TestResult ID
- int sid - The server ID
- 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

39.3. Method: getXccdfScanRuleResults

Description

Return a full list of RuleResults for given OpenSCAP XCCDF scan.

Parameters

The following parameters are available for this method:

string sessionKey
int - ID of XCCDF scan (xid)

Returns

The following return values are available for this method:

array:
- struct - OpenSCAP XCCDF RuleResult
  - string idref - idref from XCCDF document
  - string result - Result of evaluation
  - string idents - Comma separated list of XCCDF idents

39.4. Method: listXccdfScans

Description

Return a list of finished OpenSCAP scans for a given system.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId

Returns

The following return values are available for this method:

array:
- struct - OpenSCAP XCCDF 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

Description

Schedule OpenSCAP scan.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int - serverId
string - Path to xccdf content on targeted systems
string - Additional parameters for OSCAP tool

Returns

The following return values are available for this method:

int - ID of SCAP action created

39.6. Method: scheduleXccdfScan

Description

Schedule OpenSCAP scan.

Parameters

The following parameters are available for this method:

string sessionKey
array:
- int - serverId
string - Path to xccdf content on targeted systems
string - Additional parameters for OSCAP tool
dateTime.iso8601 date - The date to schedule the action

Returns

The following return values are available for this method:

int - ID of SCAP action created

39.7. Method: scheduleXccdfScan

Description

Schedule SCAP XCCDF scan.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string - Path to xccdf content on targeted system
string - Additional parameters for OSCAP tool

Returns

The following return values are available for this method:

int - ID of the SCAP action created

39.8. Method: scheduleXccdfScan

Description

Schedule SCAP XCCDF scan.

Parameters

The following parameters are available for this method:

string sessionKey
int serverId
string - Path to xccdf content on targeted system
string - Additional parameters for OSCAP tool
dateTime.iso8601 date - The date to schedule the action

Returns

The following return values are available for this method:

int - ID of the scap action created

Chapter 40. Namespace: system.search

Provides methods to perform system search requests using the search server.

Namespace: system.search

40.1. Method: deviceDescription

Description

List the systems which match the device description.

Parameters

The following parameters are available for this method:

string sessionKey
string searchTerm

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server attempted a successful check-in
  - string hostname
  - string ip
  - string hw_description - Hardware description if not null
  - string hw_device_id - Hardware device ID if not null
  - string hw_vendor_id - Hardware vendor ID if not null
  - string hw_driver - Hardware driver if not null

40.2. Method: deviceDriver

Description

List the systems that match this device driver.

Parameters

The following parameters are available for this method:

string sessionKey
string searchTerm

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server attempted a successful check-in
  - string hostname
  - string ip
  - string hw_description - Hardware description if not null
  - string hw_device_id - Hardware device id if not null
  - string hw_vendor_id - Hardware vendor id if not null
  - string hw_driver - Hardware driver if not null

40.3. Method: deviceId

Description

List the systems which match this device ID.

Parameters

The following parameters are available for this method:

string sessionKey
string searchTerm

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server attempted a successful check-in
  - string hostname
  - string ip
  - string hw_description - Hardware description if not null
  - string hw_device_id - Hardware device id if not null
  - string hw_vendor_id - Hardware vendor id if not null
  - string hw_driver - Hardware driver if not null

40.4. Method: deviceVendorId

Description

List the systems which match this device Vendor ID.

Parameters

The following parameters are available for this method:

string sessionKey
string searchTerm

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server attempted a successful check-in
  - string hostname
  - string ip
  - string hw_description - Hardware description if not null
  - string hw_device_id - Hardware device id if not null
  - string hw_vendor_id - Hardware vendor id if not null
  - string hw_driver - Hardware driver if not null

40.5. Method: hostname

Description

List the systems which match this hostname.

Parameters

The following parameters are available for this method:

string sessionKey
string searchTerm

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server attempted a successful check-in
  - string hostname
  - string ip
  - string hw_description - Hardware description if not null
  - string hw_device_id - Hardware device id if not null
  - string hw_vendor_id - Hardware vendor id if not null
  - string hw_driver - Hardware driver if not null

40.6. Method: ip

Description

List the systems which match this IP.

Parameters

The following parameters are available for this method:

string sessionKey
string searchTerm

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server attempted a successful check-in
  - string hostname
  - string ip
  - string hw_description - Hardware description if not null
  - string hw_device_id - Hardware device id if not null
  - string hw_vendor_id - Hardware vendor id if not null
  - string hw_driver - Hardware driver if not null

40.7. Method: nameAndDescription

Description

List the systems which match this name or description.

Parameters

The following parameters are available for this method:

string sessionKey
string searchTerm

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server attempted a successful check-in
  - string hostname
  - string ip
  - string hw_description - Hardware description if not null
  - string hw_device_id - Hardware device id if not null
  - string hw_vendor_id - Hardware vendor id if not null
  - string hw_driver - Hardware driver if not null

40.8. Method: uuid

Description

List the systems which match this UUID.

Parameters

The following parameters are available for this method:

string sessionKey
string searchTerm

Returns

The following return values are available for this method:

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server attempted a successful check-in
  - string hostname
  - string ip
  - string hw_description - Hardware description if not null
  - string hw_device_id - Hardware device id if not null
  - string hw_vendor_id - Hardware vendor id if not null
  - string hw_driver - Hardware driver if not null

Chapter 41. Namespace: systemgroup

Provides methods to access and modify system groups.

Namespace: systemgroup

41.1. Method: addOrRemoveAdmins

Description

Add or remove administrators to or from the given group. Satellite and organization administrators are granted access to groups within their organization by default. Therefore, users with those roles are not included in the array provided. Caller must be an organization administrator.

Parameters

The following parameters are available for this method:

string sessionKey
string systemGroupName
array:
- string - loginName - User's login name
int add - 1 to add administrators, 0 to remove

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

41.2. Method: addOrRemoveSystems

Description

Add or remove the given servers to a system group.

Parameters

The following parameters are available for this method:

string sessionKey
string systemGroupName
array:
- int - serverId
boolean add - true to add to the group, false to remove

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

41.3. Method: create

Description

Create a new system group.

Parameters

The following parameters are available for this method:

string sessionKey
string name - Name of the system group
string description - Description of the system group

Returns

The following return values are available for this method:

struct - system group
- int id
- string name
- string description
- int org_id
- int system_count

41.4. Method: delete

Description

Delete a system group.

Parameters

The following parameters are available for this method:

string sessionKey
string systemGroupName

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

41.5. Method: getDetails

Description

Retrieve details of a system group based on its ID.

Parameters

The following parameters are available for this method:

string sessionKey
int systemGroupId

Returns

The following return values are available for this method:

struct - system group
- int id
- string name
- string description
- int org_id
- int system_count

41.6. Method: getDetails

Description

Retrieve details of a system group based on its name.

Parameters

The following parameters are available for this method:

string sessionKey
string systemGroupName

Returns

The following return values are available for this method:

struct - System Group
- int id
- string name
- string description
- int org_id
- int system_count

41.7. Method: listActiveSystemsInGroup

Description

Lists active systems within a system group.

Parameters

The following parameters are available for this method:

string sessionKey
string systemGroupName

Returns

The following return values are available for this method:

array:
- int - server_id

41.8. Method: listAdministrators

Description

Returns the list of users who can administer the given group. Caller must be a system group administrator or an organization administrator.

Parameters

The following parameters are available for this method:

string sessionKey
string systemGroupName

Returns

The following return values are available for this method:

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

Description

Retrieve a list of system groups that are accessible by the logged in user.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - system group
  - int id
  - string name
  - string description
  - int org_id
  - int system_count

41.10. Method: listGroupsWithNoAssociatedAdmins

Description

Returns a list of system groups that do not have an administrator i.e. one who is not an organization administrator, as they have implicit access to system groups. Caller must be an organization administrator.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- struct - system group
  - int id
  - string name
  - string description
  - int org_id
  - int system_count

41.11. Method: listInactiveSystemsInGroup

Description

Lists inactive systems within a system group using a specified inactivity time.

Parameters

The following parameters are available for this method:

string sessionKey
string systemGroupName
int daysInactive - Number of days a system must not check in to be considered inactive

Returns

The following return values are available for this method:

array:
- int - server_id

41.12. Method: listInactiveSystemsInGroup

Description

Lists inactive systems within a system group using the default 1-day threshold.

Parameters

The following parameters are available for this method:

string sessionKey
string systemGroupName

Returns

The following return values are available for this method:

array:
- int - server_id

41.13. Method: listSystems

Description

Return a list of systems associated with this system group. User must have access to this system group.

Parameters

The following parameters are available for this method:

string sessionKey
string systemGroupName

Returns

The following return values are available for this method:

array:
- struct - server details
  - int id - System ID
  - string profile_name
  - string base_entitlement - System's base entitlement label; either enterprise_entitled or sw_mgr_entitled
  - array string
    addon_entitlements - System's addon entitlements
    Labels including: monitoring_entitled, provisioning_entitled, virtualization_host, and 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: scheduleApplyErrataToActive

Description

Schedules an action to apply errata updates to active systems from a group.

Parameters

The following parameters are available for this method:

string sessionKey
string systemGroupName
array:
- int - errataId

Returns

The following return values are available for this method:

array:
- int actionId - The action ID of the scheduled action

41.15. Method: scheduleApplyErrataToActive

Description

Schedules an action to apply errata updates to active systems from a group at a given date and time.

Parameters

The following parameters are available for this method:

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

Returns

The following return values are available for this method:

array:
- int actionId - The action ID of the scheduled action

41.16. Method: update

Description

Update an existing system group.

Parameters

The following parameters are available for this method:

string sessionKey
string systemGroupName
string description

Returns

The following return values are available for this method:

struct - system group
- int id
- string name
- string description
- int org_id
- int system_count

Chapter 42. Namespace: user

User namespace contains methods to access common user functions available from the web user interface.

Namespace: user

42.1. Method: addAssignedSystemGroup

Description

Add system group to user's list of assigned system groups.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
string serverGroupName
boolean setDefault - Defines if the system group is added to user's list of default system groups

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.2. Method: addAssignedSystemGroups

Description

Add system groups to user's list of assigned system groups.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
array:
- string - serverGroupName
boolean setDefault - Defines if system groups are also added to user's list of default system groups

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.3. Method: addDefaultSystemGroup

Description

Add system group to user's list of default system groups.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
string serverGroupName

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.4. Method: addDefaultSystemGroups

Description

Add system groups to user's list of default system groups.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
array:
- string - serverGroupName

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.5. Method: addRole

Description

Adds a role to a user.

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.6. Method: create

Description

Create a new user.

Parameters

The following parameters are available for this method:

string sessionKey
string desiredLogin - Desired login name; fails if already in use
string desiredPassword
string firstName
string lastName
string email - User's e-mail address

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.7. Method: create

Description

Create a new user.

Parameters

The following parameters are available for this method:

string sessionKey
string desiredLogin - Desired login name; fails if already in use
string desiredPassword
string firstName
string lastName
string email - User's e-mail address
int usePamAuth - 1 to use PAM authentication for this user, 0 otherwise

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.8. Method: delete

Description

Delete a user.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User login name to delete

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.9. Method: disable

Description

Disable a user.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User login name to disable

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.10. Method: enable

Description

Enable a user.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User login name to enable

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.11. Method: getDetails

Description

Returns the details about a given user.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name

Returns

The following return values are available for this method:

struct - user details
- string first_names (deprecated, use first_name)
- string first_name
- string last_name
- string email
- int org_id
- 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

42.12. Method: getLoggedInTime

Description

Returns the time user last logged in.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name

Returns

The following return values are available for this method:

dateTime.iso8601

42.13. Method: listAssignableRoles

Description

Returns a list of user roles that this user can assign to others.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

array:
- string - role label

42.14. Method: listAssignedSystemGroups

Description

Returns the system groups that a user can administer.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name

Returns

The following return values are available for this method:

array:
- struct - system group
  - int id
  - string name
  - string description
  - int system_count
  - int org_id - Organization ID for this system group

42.15. Method: listDefaultSystemGroups

Description

Returns a user's list of default system groups.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name

Returns

The following return values are available for this method:

array:
- struct - system group
  - int id
  - string name
  - string description
  - int system_count
  - int org_id - Organization ID for this system group

42.16. Method: listRoles

Description

Returns a list of the user's roles.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name

Returns

The following return values are available for this method:

array:
- string - role label

42.17. Method: listUsers

Description

Returns a list of users in your organization.

Parameters

The following parameters are available for this method:

string sessionKey

Returns

The following return values are available for this method:

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

42.18. Method: removeAssignedSystemGroup

Description

Remove system group from the user's list of assigned system groups.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
string serverGroupName
boolean setDefault - Defines if the system group is removed from the user's list of default system groups

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.19. Method: removeAssignedSystemGroups

Description

Remove system groups from a user's list of assigned system groups.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
array:
- string - serverGroupName
boolean setDefault - Deinfes if the system groups are also removed from the user's list of default system groups

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.20. Method: removeDefaultSystemGroup

Description

Remove a system group from user's list of default system groups.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
string serverGroupName

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.21. Method: removeDefaultSystemGroups

Description

Remove system groups from a user's list of default system groups.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
array:
- string - serverGroupName

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.22. Method: removeRole

Description

Remove a role from a user.

Parameters

The following parameters are available for this method:

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

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.23. Method: setDetails

Description

Updates the details of a user.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
struct - user details
- string first_names (deprecated, use first_name)
- string first_name
- string last_name
- string email
- string prefix
- string password

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

42.24. Method: usePamAuthentication

Description

Toggles whether or not a user uses PAM authentication or basic Red Hat Network authentication.

Parameters

The following parameters are available for this method:

string sessionKey
string login - User's login name
int pam_value
- 1 to enable PAM authentication
- 0 to disable

Returns

The following return values are available for this method:

int - 1 on success, exception thrown otherwise

Appendix A. Revision History

Revision History

Revision 1.0-15.401

Thu Aug 20 2015

Dan Macpherson

Mass publication of all Satellite 5.6 books

Revision 1.0-15.400

2013-10-31

Rüdiger Landmann

Rebuild with publican 4.0.0

Revision 1.0-15

Fri Sep 27 2013

Dan Macpherson

Final version of documentation suite

Revision 1.0-14

Mon Sep 23 2013

Dan Macpherson

Final changes for Satellite API

Revision 1.0-13

Tue Sep 10 2013

Dan Macpherson

Revised Subtitle, Abstract and Preface for all Guides

Revision 1.0-12

Wed Sep 4 2013

Dan Macpherson

Minor change on configchannel.getEncodedFileRevision() for BZ#998951

Revision 1.0-11

Wed Sep 4 2013

Dan Macpherson

Fixing packages.getPackage() method for BZ#1003565

Revision 1.0-10

Wed Sep 4 2013

Dan Macpherson

Elaboration on configchannel.getEncodedFileRevision() for BZ#998951

Revision 1.0-9

Thu Aug 29 2013

Dan Macpherson

First implementation of QE Review feedback

Revision 1.0-8

Sun Jul 28 2013

Dan Macpherson

Second implementation of tech review feedback

Revision 1.0-7

Wed Jul 24 2013

Dan Macpherson

Corrections for BZ#987245

Revision 1.0-6

Tue Jul 23 2013

Dan Macpherson

First implementation of tech review feedback

Revision 1.0-5

Wed Jul 3 2013

Dan Macpherson

Typo correction

Revision 1.0-4

Wed Jul 3 2013

Dan Macpherson

Final beta updates

Revision 1.0-3

Wed Jul 3 2013

Dan Macpherson

Beta documentation creation

Revision 1.0-2

Wed Jul 3 2013

Dan Macpherson

Minor documentation cleaning

Revision 1.0-1

Wed Jul 3 2013

Dan Macpherson

Minor fix to examples

Revision 1.0-0

Wed Jul 3 2013

Dan Macpherson

Initial creation and generation of the API Guide

Legal Notice

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.

Language:

Language and Page Formatting Options

Language:

Red Hat Training

API Overview

A reference guide to the Red Hat Satellite API

Daniel Macpherson

Preface

1. About This Guide

2. Audience

Part I. Introduction

Chapter 1. Introduction to the Red Hat Satellite API

Chapter 2. Using XML-RPC with the Red Hat Satellite API

Part II. Examples

Chapter 3. Examples

3.1. Perl Example

3.2. Python Example

3.3. Ruby example

Part III. Reference

Chapter 4. Namespace: activationkey

4.1. Method: addChildChannels

4.2. Method: addConfigChannels

4.3. Method: addEntitlements

4.4. Method: addPackageNames

4.5. Method: addPackages

4.6. Method: addServerGroups

4.7. Method: checkConfigDeployment

4.8. Method: create

4.9. Method: delete

4.10. Method: disableConfigDeployment

4.11. Method: enableConfigDeployment

4.12. Method: getDetails

4.13. Method: listActivatedSystems

4.14. Method: listActivationKeys

4.15. Method: listConfigChannels

4.16. Method: removeChildChannels

4.17. Method: removeConfigChannels

4.18. Method: removeEntitlements

4.19. Method: removePackageNames

4.20. Method: removePackages

4.21. Method: removeServerGroups

4.22. Method: setConfigChannels

4.23. Method: setDetails

Chapter 5. Namespace: api

5.1. Method: getApiCallList

5.2. Method: getApiNamespaceCallList

5.3. Method: getApiNamespaces

5.4. Method: getVersion

5.5. Method: systemVersion

Chapter 6. Namespace: auth

6.1. Method: login

6.2. Method: logout

Chapter 7. Namespace: channel

7.1. Method: listAllChannels

7.2. Method: listMyChannels

7.3. Method: listPopularChannels

7.4. Method: listRedHatChannels

7.5. Method: listRetiredChannels

7.6. Method: listSharedChannels

7.7. Method: listSoftwareChannels

7.8. Method: listVendorChannels

Chapter 8. Namespace: channel.access

8.1. Method: disableUserRestrictions

8.2. Method: enableUserRestrictions

8.3. Method: getOrgSharing

8.4. Method: setOrgSharing

Chapter 9. Namespace: channel.org

9.1. Method: disableAccess

9.2. Method: enableAccess

9.3. Method: list

Chapter 10. Namespace: channel.software

10.1. Method: addPackages

10.2. Method: addRepoFilter

10.3. Method: associateRepo

10.4. Method: availableEntitlements

10.5. Method: clearRepoFilters

10.6. Method: clone

10.7. Method: create

10.8. Method: create

10.9. Method: create