此内容没有您所选择的语言版本。

API Guide

Red Hat Satellite 5.8

A reference guide to the Red Hat Satellite API

Red Hat Satellite Documentation Team

satellite-doc-list@redhat.com

Legal Notice

Abstract

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

Chapter 1. Introduction to Red Hat Satellite
复制链接

Red Hat Satellite provides organizations with the benefits of Red Hat Network without the need for public Internet access for servers or client systems. Red Hat Satellite also provides the following benefits:

You have complete control and privacy over package management and server maintenance within your own networks.
You can store System Profiles on a Satellite server, which connects to the Red Hat Network website using a local web server.
You can perform package management tasks, including errata updates, through the local area network.

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

1.1. The Red Hat Satellite API
复制链接

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

This guide aims to provide developers and administrators with instructions and examples to help harness the functionality of their Red Hat Satellite through the XML-RPM protocol.

1.2. Using XML-RPC with the Red Hat Satellite API
复制链接

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

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

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

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

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

Copy to Clipboard

Toggle word wrap

For example, use the following XML-RPC request to login to the API and request a session key for authentication:

<methodCall>
  <methodName>auth.login</methodName>
  <params>
    <param>
      <value><username>admin</username></value>
    </param>
    <param>
      <value><password>p@55w0rd!</password></value>
    </param>
  </params>
</methodCall>

<methodCall>
  <methodName>auth.login</methodName>
  <params>
    <param>
      <value><username>admin</username></value>
    </param>
    <param>
      <value><password>p@55w0rd!</password></value>
    </param>
  </params>
</methodCall>

Copy to Clipboard

Toggle word wrap

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>

<methodResponse>
  <params>
    <param>
      <value><sessionKey>83d8b35f</sessionKey></value>
    </param>
  </params>
</methodResponse>

Copy to Clipboard

Toggle word wrap

The response contains a returned parameter for sessionKey, which is a key used to authenticate most of the API methods.

Most programming languages include XML-RPC modules and libraries that automatically parse the desired method and parameters into the XML-encoded request and parse the resulting response as returned variable. For examples, see Chapter 2, Examples.

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

1.3. Using the Read-only API
复制链接

Red Hat Satellite 5.8 features a read-only API that is designed to provide a safe way of auditing and generating reports of the contents of the Satellite server. Read-only users cannot log in to the Satellite web UI or perform other actions that can affect the functionality of the Satellite. For example, read-only users cannot make back-end calls or use API calls that modify content.

Read-only API users can only use non-destructive API calls, such as org.listUsers; in short, they are denied access to any API call that does not start with list, is, or get. In addition, read-only users require the same role specifications as normal users to gain access to the API calls associated with those roles. This leads to the concept where a read-only channel administrator can make API calls such as channel.listAllChannels but cannot call org.listUsers because the organization administrator rights are not available.

1.3.1. Creating a Read-only User
复制链接

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

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

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

Chapter 2. Examples
复制链接

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

2.1. Python Examples
复制链接

The following example demonstrates the user.listUsers call. The example prints the name of each group.

#!/usr/bin/python
import xmlrpclib

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

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

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

client.auth.logout(key)

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

Copy to Clipboard

Toggle word wrap

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)

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

Copy to Clipboard

Toggle word wrap

The following example show how to check channels for their last synchronization:

#!/usr/bin/python
import xmlrpclib

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

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

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

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

client.auth.logout(key)

#!/usr/bin/python
import xmlrpclib

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

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

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

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

client.auth.logout(key)

Copy to Clipboard

Toggle word wrap

2.2. Perl Example
复制链接

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

#!/usr/bin/perl
use Frontier::Client;

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

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

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

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

Copy to Clipboard

Toggle word wrap

2.3. Ruby Example
复制链接

The following example demonstrates the channel.listAllChannels API call. The example prints a list of channel labels.

#!/usr/bin/env ruby
require "xmlrpc/client"

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

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

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

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

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

Copy to Clipboard

Toggle word wrap

Part I. Methods
复制链接

Chapter 3. actionchain
复制链接

Abstract

Provides the namespace for the Action Chain methods.

3.1. addConfigurationDeployment
复制链接

Name

addConfigurationDeployment

Description

Adds an action to deploy a configuration file to an Action Chain.

Parameters

string sessionKey - Session token, issued at login
string chainLabel - Label of the chain
int System ID - System ID
array:
- int - Revision ID

Return Value

int - 1 on success, exception thrown otherwise.

3.2. addErrataUpdate
复制链接

Name

addErrataUpdate

Description

Adds Errata update to an Action Chain.

Parameters

string sessionKey - Session token, issued at login
int serverId - System ID
array:
- int - Errata ID
string chainLabel - Label of the chain

Return Value

int actionId - The action id of the scheduled action

3.3. addPackageInstall
复制链接

Name

addPackageInstall

Description

Adds package installation action to an Action Chain.

Parameters

string sessionKey - Session token, issued at login
int serverId - System ID
array:
- int - Package ID
string chainLabel

Return Value

int - 1 on success, exception thrown otherwise.

3.4. addPackageRemoval
复制链接

Name

addPackageRemoval

Description

Adds an action to remove installed packages on the system to an Action Chain.

Parameters

string sessionKey - Session token, issued at login
int serverId - System ID
array:
- int - Package ID
string chainLabel - Label of the chain

Return Value

int actionId - The action id of the scheduled action or exception

3.5. addPackageUpgrade
复制链接

Name

addPackageUpgrade

Description

Adds an action to upgrade installed packages on the system to an Action Chain.

Parameters

string sessionKey - Session token, issued at login
int serverId - System ID
array:
- int - packageId
string chainLabel - Label of the chain

Return Value

int actionId - The id of the action or throw an exception

3.6. addPackageVerify
复制链接

Name

addPackageVerify

Description

Adds an action to verify installed packages on the system to an Action Chain.

Parameters

string sessionKey - Session token, issued at login
int serverId - System ID
array:
- int - packageId
string chainLabel - Label of the chain

Return Value

int - 1 on success, exception thrown otherwise.

3.7. addScriptRun
复制链接

Name

addScriptRun

Description

Add an action to run a script to an Action Chain. NOTE: The script body must be Base64 encoded!

Parameters

string sessionKey - Session token, issued at login
int serverId - System ID
string chainLabel - Label of the chain
string uid - User ID on the particular system
string gid - Group ID on the particular system
int timeout - Timeout
string scriptBodyBase64 - Base64 encoded script body

Return Value

int actionId - The id of the action or throw an exception

3.8. addSystemReboot
复制链接

Name

addSystemReboot

Description

Add system reboot to an Action Chain.

Parameters

string sessionKey - Session token, issued at login
int serverId
string chainLabel - Label of the chain

Return Value

int actionId - The action id of the scheduled action

3.9. createChain
复制链接

Name

createChain

Description

Create an Action Chain.

Parameters

string sessionKey - Session token, issued at login
string chainLabel - Label of the chain

Return Value

int actionId - The ID of the created action chain

3.10. deleteChain
复制链接

Name

deleteChain

Description

Delete action chain by label.

Parameters

string sessionKey - Session token, issued at login
string chainLabel - Label of the chain

Return Value

int - 1 on success, exception thrown otherwise.

3.11. listChainActions
复制链接

Name

listChainActions

Description

List all actions in the particular Action Chain.

Parameters

string sessionKey - Session token, issued at login
string chainLabel - Label of the chain

Return Value

array:
- struct - entry
  - int id - Action ID
  - string label - Label of an Action
  - string created - Created date/time
  - string earliest - Earliest scheduled date/time
  - string type - Type of the action
  - string modified - Modified date/time
  - string cuid - Creator UID

3.12. listChains
复制链接

Name

listChains

Description

List currently available action chains.

Parameters

string sessionKey - Session token, issued at login

Return Value

array:
- struct - chain
  - string label - Label of an Action Chain
  - string entrycount - Number of entries in the Action Chain

3.13. removeAction
复制链接

Name

removeAction

Description

Remove an action from an Action Chain.

Parameters

string sessionKey - Session token, issued at login
string chainLabel - Label of the chain
int actionId - Action ID

Return Value

int - 1 on success, exception thrown otherwise.

3.14. renameChain
复制链接

Name

renameChain

Description

Rename an Action Chain.

Parameters

string sessionKey - Session token, issued at login
string previousLabel - Previous chain label
string newLabel - New chain label

Return Value

int - 1 on success, exception thrown otherwise.

3.15. scheduleChain
复制链接

Name

scheduleChain

Description

Schedule the Action Chain so that its actions will actually occur.

Parameters

string sessionKey - Session token, issued at login
string chainLabel - Label of the chain
dateTime.iso8601 Earliest date

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 4. activationkey
复制链接

Abstract

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

4.1. addChildChannels
复制链接

Name

addChildChannels

Description

Add child channels to an activation key.

Parameters

string sessionKey
string key
array:
- string - childChannelLabel

Return Value

int - 1 on success, exception thrown otherwise.

4.2. addConfigChannels
复制链接

Name

addConfigChannels

Description

Given a list of activation keys and configuration channels, this method adds given configuration channels to either the top or the bottom (whichever you specify) of an activation key's configuration channels list. The ordering of the configuration channels provided in the add list is maintained while adding. If one of the configuration channels in the 'add' list already exists in an activation key, the configuration channel will be re-ranked to the appropriate place.

Parameters

string sessionKey
array:
- string - activationKey
array:
- string - List of configuration channel labels in the ranked order.
boolean addToTop
- true - To prepend the given channels to the beginning of the activation key's config channel list
- false - To append the given channels to the end of the activation key's config channel list

Return Value

int - 1 on success, exception thrown otherwise.

4.3. addEntitlements
复制链接

Name

addEntitlements

Description

Add entitlements to an activation key. Currently only add-on entitlements are permitted. (provisioning_entitled, virtualization_host, virtualization_host_platform)

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

4.4. addPackageNames
复制链接

Name

addPackageNames

Description

Add packages to an activation key using package name only.

Deprecated - being replaced by addPackages(string sessionKey, string key, array[packages])

Available since: 10.2

Parameters

string sessionKey
string key
array:
- string - packageName

Return Value

int - 1 on success, exception thrown otherwise.

4.5. addPackages
复制链接

Name

addPackages

Description

Add packages to an activation key.

Parameters

string sessionKey
string key
array:
- struct - packages
  - string name - Package name
  - string arch - Arch label - Optional

Return Value

int - 1 on success, exception thrown otherwise.

4.6. addServerGroups
复制链接

Name

addServerGroups

Description

Add server groups to an activation key.

Parameters

string sessionKey
string key
array:
- int - serverGroupId

Return Value

int - 1 on success, exception thrown otherwise.

4.7. checkConfigDeployment
复制链接

Name

checkConfigDeployment

Description

Check configuration file deployment status for the activation key specified.

Parameters

string sessionKey
string key

Return Value

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

4.8. clone
复制链接

Name

clone

Description

Clone an existing activation key.

Parameters

string sessionKey
string key - Key to be cloned.
string cloneDescription - Description of the cloned key.

Return Value

string - The new activation key.

4.9. create
复制链接

Name

create

Description

Create a new activation key. The activation key parameter passed in will be prefixed with the organization ID, and this value will be returned from the create call. Eg. If the caller passes in the key "foo" and belong to an organization with the ID 100, the actual activation key will be "100-foo". This call allows for the setting of a usage limit on this activation key. If unlimited usage is desired see the similarly named API method with no usage limit argument.

Parameters

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

Return Value

string - The new activation key.

4.10. create
复制链接

Name

create

Description

Create a new activation key with unlimited usage. The activation key parameter passed in will be prefixed with the organization ID, and this value will be returned from the create call. Eg. If the caller passes in the key "foo" and belong to an organization with the ID 100, the actual activation key will be "100-foo".

Parameters

string sessionKey
string key - Leave empty to have new key autogenerated.
string description
string baseChannelLabel - Leave empty to accept default.
array string - Add-on entitlement label to associate with the key.
- - provisioning_entitled
  - virtualization_host
  - virtualization_host_platform
boolean universalDefault

Return Value

string - The new activation key.

4.11. delete
复制链接

Name

delete

Description

Delete an activation key.

Parameters

string sessionKey
string key

Return Value

int - 1 on success, exception thrown otherwise.

4.12. disableConfigDeployment
复制链接

Name

disableConfigDeployment

Description

Disable configuration file deployment for the specified activation key.

Parameters

string sessionKey
string key

Return Value

int - 1 on success, exception thrown otherwise.

4.13. enableConfigDeployment
复制链接

Name

enableConfigDeployment

Description

Enable configuration file deployment for the specified activation key.

Parameters

string sessionKey
string key

Return Value

int - 1 on success, exception thrown otherwise.

4.14. getDetails
复制链接

Name

getDetails

Description

Lookup an activation key's details.

Available since: 10.2

Parameters

string sessionKey
string key

Return Value

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

4.15. listActivatedSystems
复制链接

Name

listActivatedSystems

Description

List the systems activated with the key provided.

Parameters

string sessionKey
string key

Return Value

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

4.16. listActivationKeys
复制链接

Name

listActivationKeys

Description

List activation keys that are visible to the user.

Available since: 10.2

Parameters

string sessionKey

Return Value

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

4.17. listConfigChannels
复制链接

Name

listConfigChannels

Description

List configuration channels associated to an activation key.

Parameters

string sessionKey
string key

Return Value

array:
- struct - Configuration Channel information
  - int id
  - int orgId
  - string label
  - string name
  - string description
  - struct configChannelType
  - struct - Configuration Channel Type information
    int id
    string label
    string name
    int priority

4.18. removeChildChannels
复制链接

Name

removeChildChannels

Description

Remove child channels from an activation key.

Parameters

string sessionKey
string key
array:
- string - childChannelLabel

Return Value

int - 1 on success, exception thrown otherwise.

4.19. removeConfigChannels
复制链接

Name

removeConfigChannels

Description

Remove configuration channels from the given activation keys.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

4.20. removeEntitlements
复制链接

Name

removeEntitlements

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

4.21. removePackageNames
复制链接

Name

removePackageNames

Description

Remove package names from an activation key.

Deprecated - being replaced by removePackages(string sessionKey, string key, array[packages])

Available since: 10.2

Parameters

string sessionKey
string key
array:
- string - packageName

Return Value

int - 1 on success, exception thrown otherwise.

4.22. removePackages
复制链接

Name

removePackages

Description

Remove package names from an activation key.

Parameters

string sessionKey
string key
array:
- struct - packages
  - string name - Package name
  - string arch - Arch label - Optional

Return Value

int - 1 on success, exception thrown otherwise.

4.23. removeServerGroups
复制链接

Name

removeServerGroups

Description

Remove server groups from an activation key.

Parameters

string sessionKey
string key
array:
- int - serverGroupId

Return Value

int - 1 on success, exception thrown otherwise.

4.24. setConfigChannels
复制链接

Name

setConfigChannels

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

4.25. setDetails
复制链接

Name

setDetails

Description

Update the details of an activation key.

Parameters

string sessionKey
string key
struct - activation key
- string description - optional
- string base_channel_label - optional - to set default base channel set to empty string or 'none'
- int usage_limit - optional
- boolean unlimited_usage_limit - Set true for unlimited usage and to override usage_limit
- boolean universal_default - optional
- boolean disabled - optional

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 5. api
复制链接

Abstract

Methods providing information about the API.

5.1. getApiCallList
复制链接

Name

getApiCallList

Description

Lists all available api calls grouped by namespace

Parameters

string sessionKey

Return Value

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

5.2. getApiNamespaceCallList
复制链接

Name

getApiNamespaceCallList

Description

Lists all available api calls for the specified namespace

Parameters

string sessionKey
string namespace

Return Value

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

5.3. getApiNamespaces
复制链接

Name

getApiNamespaces

Description

Lists available API namespaces

Parameters

string sessionKey

Return Value

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

5.4. getVersion
复制链接

Name

getVersion

Description

Returns the version of the API. Since Spacewalk 0.4 (Satellite 5.3) it is no more related to server version.

Parameters

None

Return Value

string

5.5. systemVersion
复制链接

Name

systemVersion

Description

Returns the server version.

Parameters

None

Return Value

string

Chapter 6. auth
复制链接

Abstract

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

6.1. login
复制链接

Name

Description

Parameters

string username
string password

Return Value

string sessionKey

6.2. login
复制链接

Name

Description

Parameters

string username
string password
int duration - Length of session.

Return Value

string sessionKey

6.3. logout
复制链接

Name

logout

Description

Logout the user with the given session key.

Parameters

string sessionKey

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 7. channel
复制链接

Abstract

Provides method to get back a list of Software Channels.

7.1. listAllChannels
复制链接

Name

listAllChannels

Description

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

Parameters

string sessionKey

Return Value

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

7.2. listManageableChannels
复制链接

Name

listManageableChannels

Description

List all software channels that the user is entitled to manage.

Parameters

string sessionKey

Return Value

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

7.3. listMyChannels
复制链接

Name

listMyChannels

Description

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

Parameters

string sessionKey

Return Value

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

7.4. listPopularChannels
复制链接

Name

listPopularChannels

Description

List the most popular software channels. Channels that have at least the number of systems subscribed as specified by the popularity count will be returned.

Parameters

string sessionKey
int popularityCount

Return Value

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

7.5. listRedHatChannels
复制链接

Name

listRedHatChannels

Description

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

Deprecated - being replaced by listVendorChannels(String sessionKey)

Parameters

string sessionKey

Return Value

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

7.6. listRetiredChannels
复制链接

Name

listRetiredChannels

Description

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

Parameters

string sessionKey

Return Value

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

7.7. listSharedChannels
复制链接

Name

listSharedChannels

Description

List all software channels that may be shared by the user's organization.

Parameters

string sessionKey

Return Value

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

7.8. listSoftwareChannels
复制链接

Name

listSoftwareChannels

Description

List all visible software channels.

Parameters

string sessionKey

Return Value

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

7.9. listVendorChannels
复制链接

Name

listVendorChannels

Description

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

Parameters

string sessionKey

Return Value

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

Chapter 8. channel.access
复制链接

Abstract

Provides methods to retrieve and alter channel access restrictions.

8.1. disableUserRestrictions
复制链接

Name

disableUserRestrictions

Description

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

Parameters

string sessionKey
string channelLabel - label of the channel

Return Value

int - 1 on success, exception thrown otherwise.

8.2. enableUserRestrictions
复制链接

Name

enableUserRestrictions

Description

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

Parameters

string sessionKey
string channelLabel - label of the channel

Return Value

int - 1 on success, exception thrown otherwise.

8.3. getOrgSharing
复制链接

Name

getOrgSharing

Description

Get organization sharing access control.

Parameters

string sessionKey
string channelLabel - label of the channel

Return Value

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

8.4. setOrgSharing
复制链接

Name

setOrgSharing

Description

Set organization sharing access control.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 9. channel.org
复制链接

Abstract

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

9.1. disableAccess
复制链接

Name

disableAccess

Description

Disable access to the channel for the given organization.

Parameters

string sessionKey
string channelLabel - label of the channel
int orgId - id of org being removed access

Return Value

int - 1 on success, exception thrown otherwise.

9.2. enableAccess
复制链接

Name

enableAccess

Description

Enable access to the channel for the given organization.

Parameters

string sessionKey
string channelLabel - label of the channel
int orgId - id of org being granted access

Return Value

int - 1 on success, exception thrown otherwise.

9.3. list
复制链接

Name

list

Description

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

Parameters

string sessionKey
string channelLabel - label of the channel

Return Value

array:
- struct - org
  - int org_id
  - string org_name
  - boolean access_enabled

Chapter 10. channel.software
复制链接

Abstract

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

10.1. addPackages
复制链接

Name

addPackages

Description

Adds a given list of packages to the given channel.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

10.2. addRepoFilter
复制链接

Name

addRepoFilter

Description

Adds a filter for a given repo.

Parameters

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

Return Value

int sort order for new filter

10.3. associateRepo
复制链接

Name

associateRepo

Description

Associates a repository with a channel

Parameters

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

Return Value

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

10.4. availableEntitlements
复制链接

Name

availableEntitlements

Description

Returns the number of available subscriptions for the given channel

Parameters

string sessionKey
string channelLabel - channel to query

Return Value

int number of available subscriptions for the given channel

10.5. clearRepoFilters
复制链接

Name

clearRepoFilters

Description

Removes the filters for a repo

Parameters

string sessionKey
string label - repository label

Return Value

int - 1 on success, exception thrown otherwise.

10.6. clone
复制链接

Name

clone

Description

Clone a channel. If arch_label is omitted, the arch label of the original channel will be used. If parent_label is omitted, the clone will be a base channel.

Parameters

string sessionKey
string original_label
struct - channel details
- string name
- string label
- string summary
- string parent_label - (optional)
- string arch_label - (optional)
- string gpg_key_url - (optional), gpg_url might be used as well
- string gpg_key_id - (optional), gpg_id might be used as well
- string gpg_key_fp - (optional), gpg_fingerprint might be used as well
- string description - (optional)
- string checksum - either sha1 or sha256
boolean original_state

Return Value

int the cloned channel ID

10.7. create
复制链接

Name

create

Description

Creates a software channel

Available since: 10.9

Parameters

string sessionKey
string label - label of the new channel
string name - name of the new channel
string summary - summary of the channel
string archLabel - the label of the architecture the channel corresponds to, see channel.software.listArches API for complete listing
string parentLabel - label of the parent of this channel, an empty string if it does not have one
string checksumType - checksum type for this channel, used for yum repository metadata generation
- sha1 - Offers widest compatibility with clients
- sha256 - Offers highest security, but is compatible only with newer clients: Fedora 11 and newer, or Enterprise Linux 6 and newer.
struct - gpgKey
- string url - GPG key URL
- string id - GPG key ID
- string fingerprint - GPG key Fingerprint

Return Value

int - 1 if the creation operation succeeded, 0 otherwise

10.8. create
复制链接

Name

create

Description

Creates a software channel

Available since: 10.9

Parameters

string sessionKey
string label - label of the new channel
string name - name of the new channel
string summary - summary of the channel
string archLabel - the label of the architecture the channel corresponds to, see channel.software.listArches API for complete listing
string parentLabel - label of the parent of this channel, an empty string if it does not have one
string checksumType - checksum type for this channel, used for yum repository metadata generation
- sha1 - Offers widest compatibility with clients
- sha256 - Offers highest security, but is compatible only with newer clients: Fedora 11 and newer, or Enterprise Linux 6 and newer.

Return Value

int - 1 if the creation operation succeeded, 0 otherwise

10.9. create
复制链接

Name

create

Description

Creates a software channel

Parameters

string sessionKey
string label - label of the new channel
string name - name of the new channel
string summary - summary of the channel
string archLabel - the label of the architecture the channel corresponds to, see channel.software.listArches API for complete listing
string parentLabel - label of the parent of this channel, an empty string if it does not have one

Return Value

int - 1 if the creation operation succeeded, 0 otherwise

10.10. createRepo
复制链接

Name

createRepo

Description

Creates a repository

Parameters

string sessionKey
string label - repository label
string type - repository type (yum, uln...)
string url - repository url

Return Value

struct - channel
- int id
- string label
- string sourceUrl
- string type
- string sslCaDesc
- string sslCertDesc
- string sslKeyDesc

10.11. createRepo
复制链接

Name

createRepo

Description

Creates a repository

Parameters

string sessionKey
string label - repository label
string type - repository type (yum, uln...)
string url - repository url
string sslCaCert - SSL CA cert description
string sslCliCert - SSL Client cert description
string sslCliKey - SSL Client key description

Return Value

struct - channel
- int id
- string label
- string sourceUrl
- string type
- string sslCaDesc
- string sslCertDesc
- string sslKeyDesc

10.12. delete
复制链接

Name

delete

Description

Deletes a custom software channel

Parameters

string sessionKey
string channelLabel - channel to delete

Return Value

int - 1 on success, exception thrown otherwise.

10.13. disassociateRepo
复制链接

Name

disassociateRepo

Description

Disassociates a repository from a channel

Parameters

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

Return Value

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

10.14. getChannelLastBuildById
复制链接

Name

getChannelLastBuildById

Description

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

Parameters

string sessionKey
int id - id of channel wanted

Return Value

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

10.15. getDetails
复制链接

Name

getDetails

Description

Returns details of the given channel as a map

Parameters

string sessionKey
string channelLabel - channel to query

Return Value

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

10.16. getDetails
复制链接

Name

getDetails

Description

Returns details of the given channel as a map

Parameters

string sessionKey
int id - channel to query

Return Value

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

10.17. getRepoDetails
复制链接

Name

getRepoDetails

Description

Returns details of the given repository

Parameters

string sessionKey
string repoLabel - repo to query

Return Value

struct - channel
- int id
- string label
- string sourceUrl
- string type
- string sslCaDesc
- string sslCertDesc
- string sslKeyDesc

10.18. getRepoDetails
复制链接

Name

getRepoDetails

Description

Returns details of the given repo

Parameters

string sessionKey
string repoLabel - repo to query

Return Value

struct - channel
- int id
- string label
- string sourceUrl
- string type
- string sslCaDesc
- string sslCertDesc
- string sslKeyDesc

10.19. getRepoSyncCronExpression
复制链接

Name

getRepoSyncCronExpression

Description

Returns repo synchronization cron expression

Parameters

string sessionKey
string channelLabel - channel label

Return Value

string quartz expression

10.20. isGloballySubscribable
复制链接

Name

isGloballySubscribable

Description

Returns whether the channel is subscribable by any user in the organization

Parameters

string sessionKey
string channelLabel - channel to query

Return Value

int - 1 if true, 0 otherwise

10.21. isUserManageable
复制链接

Name

isUserManageable

Description

Returns whether the channel may be managed by the given user.

Parameters

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

Return Value

int - 1 if manageable, 0 if not

10.22. isUserSubscribable
复制链接

Name

isUserSubscribable

Description

Returns whether the channel may be subscribed to by the given user.

Parameters

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

Return Value

int - 1 if subscribable, 0 if not

10.23. listAllPackages
复制链接

Name

listAllPackages

Description

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

Parameters

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

Return Value

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - string checksum
  - string checksum_type
  - int id
  - string arch_label
  - string last_modified_date
  - string last_modified - (Deprecated)

10.24. listAllPackages
复制链接

Name

listAllPackages

Description

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

Parameters

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

Return Value

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - string checksum
  - string checksum_type
  - int id
  - string arch_label
  - string last_modified_date
  - string last_modified - (Deprecated)

10.25. listAllPackages
复制链接

Name

listAllPackages

Description

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

Parameters

string sessionKey
string channelLabel - channel to query

Return Value

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - string checksum
  - string checksum_type
  - int id
  - string arch_label
  - string last_modified_date
  - string last_modified - (Deprecated)

10.26. listAllPackages
复制链接

Name

listAllPackages

Description

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

Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601 endDate)

Parameters

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

Return Value

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - string checksum
  - string checksum_type
  - int id
  - string arch_label
  - string last_modified_date
  - string last_modified - (Deprecated)

10.27. listAllPackages
复制链接

Name

listAllPackages

Description

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

Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate)

Parameters

string sessionKey
string channelLabel - channel to query
string startDate

Return Value

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - string checksum
  - string checksum_type
  - int id
  - string arch_label
  - string last_modified_date
  - string last_modified - (Deprecated)

10.28. listAllPackagesByDate
复制链接

Name

listAllPackagesByDate

Description

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

Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601 endDate)

Parameters

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

Return Value

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

10.29. listAllPackagesByDate
复制链接

Name

listAllPackagesByDate

Description

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

Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate)

Parameters

string sessionKey
string channelLabel - channel to query
string startDate

Return Value

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

10.30. listAllPackagesByDate
复制链接

Name

listAllPackagesByDate

Description

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

Deprecated - being replaced by listAllPackages(string sessionKey, string channelLabel)

Parameters

string sessionKey
string channelLabel - channel to query

Return Value

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

10.31. listArches
复制链接

Name

listArches

Description

Lists the potential software channel architectures that can be created

Parameters

string sessionKey

Return Value

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

10.32. listChannelRepos
复制链接

Name

listChannelRepos

Description

Lists associated repos with the given channel

Parameters

string sessionKey
string channelLabel - channel label

Return Value

array:
- struct - channel
  - int id
  - string label
  - string sourceUrl
  - string type
  - string sslCaDesc
  - string sslCertDesc
  - string sslKeyDesc

10.33. listChildren
复制链接

Name

listChildren

Description

List the children of a channel

Parameters

string sessionKey
string channelLabel - the label of the channel

Return Value

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

10.34. listErrata
复制链接

Name

listErrata

Description

List the errata applicable to a channel after given startDate

Parameters

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

Return Value

array:
- struct - errata
  - int id - Errata ID.
  - string date - Date erratum was created.
  - string update_date - Date erratum was updated.
  - string advisory_synopsis - Summary of the erratum.
  - string advisory_type - Type label such as Security, Bug Fix
  - string advisory_name - Name such as RHSA, etc

10.35. listErrata
复制链接

Name

listErrata

Description

List the errata applicable to a channel between startDate and endDate.

Parameters

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

Return Value

array:
- struct - errata
  - int id - Errata ID.
  - string date - Date erratum was created.
  - string update_date - Date erratum was updated.
  - string advisory_synopsis - Summary of the erratum.
  - string advisory_type - Type label such as Security, Bug Fix
  - string advisory_name - Name such as RHSA, etc

10.36. listErrata
复制链接

Name

listErrata

Description

List the errata applicable to a channel between startDate and endDate.

Parameters

string sessionKey
string channelLabel - channel to query
dateTime.iso8601 startDate
dateTime.iso8601 endDate
boolean lastModified - select by last modified or not

Return Value

array:
- struct - errata
  - int id - Errata ID.
  - string date - Date erratum was created.
  - string update_date - Date erratum was updated.
  - string advisory_synopsis - Summary of the erratum.
  - string advisory_type - Type label such as Security, Bug Fix
  - string advisory_name - Name such as RHSA, etc

10.37. listErrata
复制链接

Name

listErrata

Description

List the errata applicable to a channel

Parameters

string sessionKey
string channelLabel - channel to query

Return Value

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

10.38. listErrata
复制链接

Name

listErrata

Description

List the errata applicable to a channel after given startDate

Deprecated - being replaced by listErrata(string sessionKey, string channelLabel, dateTime.iso8601 startDate)

Parameters

string sessionKey
string channelLabel - channel to query
string startDate

Return Value

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

10.39. listErrata
复制链接

Name

listErrata

Description

List the errata applicable to a channel between startDate and endDate.

Deprecated - being replaced by listErrata(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601)

Parameters

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

Return Value

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

10.40. listErrataByType
复制链接

Name

listErrataByType

Description

List the errata of a specific type that are applicable to a channel

Parameters

string sessionKey
string channelLabel - channel to query
string advisoryType - type of advisory (one of of the following: 'Security Advisory', 'Product Enhancement Advisory', 'Bug Fix Advisory'

Return Value

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

10.41. listErrataNeedingSync
复制链接

Name

listErrataNeedingSync

Description

If you have satellite-synced a new channel then Red Hat Errata will have been updated with the packages that are in the newly synced channel. A cloned erratum will not have been automatically updated however. If you cloned a channel that includes those cloned errata and should include the new packages, they will not be included when they should. This method lists the errata that will be updated if you run the syncErrata method.

Parameters

string sessionKey
string channelLabel - channel to update

Return Value

array:
- struct - errata
  - int id - Errata ID.
  - string date - Date erratum was created.
  - string update_date - Date erratum was updated.
  - string advisory_synopsis - Summary of the erratum.
  - string advisory_type - Type label such as Security, Bug Fix
  - string advisory_name - Name such as RHSA, etc

10.42. listLatestPackages
复制链接

Name

listLatestPackages

Description

Lists the packages with the latest version (including release and epoch) for the given channel

Parameters

string sessionKey
string channelLabel - channel to query

Return Value

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

10.43. listPackagesWithoutChannel
复制链接

Name

listPackagesWithoutChannel

Description

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

Parameters

string sessionKey

Return Value

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - int id
  - string arch_label
  - string path - The path on that file system that the package resides
  - string provider - The provider of the package, determined by the gpg key it was signed with.
  - dateTime.iso8601 last_modified

10.44. listRepoFilters
复制链接

Name

listRepoFilters

Description

Lists the filters for a repo

Parameters

string sessionKey
string label - repository label

Return Value

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

10.45. listSubscribedSystems
复制链接

Name

listSubscribedSystems

Description

Returns list of subscribed systems for the given channel label

Parameters

string sessionKey
string channelLabel - channel to query

Return Value

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

10.46. listSystemChannels
复制链接

Name

listSystemChannels

Description

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

Parameters

string sessionKey
int serverId

Return Value

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

10.47. listUserRepos
复制链接

Name

listUserRepos

Description

Returns a list of ContentSource (repos) that the user can see

Parameters

string sessionKey

Return Value

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

10.48. mergeErrata
复制链接

Name

mergeErrata

Description

Merges all errata from one channel into another

Parameters

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

Return Value

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

10.49. mergeErrata
复制链接

Name

mergeErrata

Description

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

Parameters

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

Return Value

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

10.50. mergeErrata
复制链接

Name

mergeErrata

Description

Merges a list of errata from one channel into another

Parameters

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

Return Value

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

10.51. mergePackages
复制链接

Name

mergePackages

Description

Merges all packages from one channel into another

Parameters

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

Return Value

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - int id
  - string arch_label
  - string path - The path on that file system that the package resides
  - string provider - The provider of the package, determined by the gpg key it was signed with.
  - dateTime.iso8601 last_modified

10.52. regenerateNeededCache
复制链接

Name

regenerateNeededCache

Description

Completely clear and regenerate the needed Errata and Package cache for all systems subscribed to the specified channel. This should be used only if you believe your cache is incorrect for all the systems in a given channel. This will schedule an asynchronous action to actually do the processing.

Parameters

string sessionKey
string channelLabel - the label of the channel

Return Value

int - 1 on success, exception thrown otherwise.

10.53. regenerateNeededCache
复制链接

Name

regenerateNeededCache

Description

Completely clear and regenerate the needed Errata and Package cache for all systems subscribed. You must be a Satellite Admin to perform this action. This will schedule an asynchronous action to actually do the processing.

Parameters

string sessionKey

Return Value

int - 1 on success, exception thrown otherwise.

10.54. regenerateYumCache
复制链接

Name

regenerateYumCache

Description

Regenerate yum cache for the specified channel.

Parameters

string sessionKey
string channelLabel - the label of the channel

Return Value

int - 1 on success, exception thrown otherwise.

10.55. removeErrata
复制链接

Name

removeErrata

Description

Removes a given list of errata from the given channel.

Parameters

string sessionKey
string channelLabel - target channel.
array:
- string - advisoryName - name of an erratum to remove
boolean removePackages - True to remove packages from the channel

Return Value

int - 1 on success, exception thrown otherwise.

10.56. removePackages
复制链接

Name

removePackages

Description

Removes a given list of packages from the given channel.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

10.57. removeRepo
复制链接

Name

removeRepo

Description

Removes a repository

Parameters

string sessionKey
long id - ID of repo to be removed

Return Value

int - 1 on success, exception thrown otherwise.

10.58. removeRepo
复制链接

Name

removeRepo

Description

Removes a repository

Parameters

string sessionKey
string label - label of repo to be removed

Return Value

int - 1 on success, exception thrown otherwise.

10.59. removeRepoFilter
复制链接

Name

removeRepoFilter

Description

Removes a filter for a given repo.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

10.60. setContactDetails
复制链接

Name

setContactDetails

Description

Set contact/support information for given channel.

Parameters

string sessionKey
string channelLabel - label of the channel
string maintainerName - name of the channel maintainer
string maintainerEmail - email of the channel maintainer
string maintainerPhone - phone number of the channel maintainer
string supportPolicy - channel support policy

Return Value

int - 1 on success, exception thrown otherwise.

10.61. setDetails
复制链接

Name

setDetails

Description

Allows to modify channel attributes

Parameters

string sessionKey
int channelId - channel id
struct - channel_map
- string checksum_label - new channel repository checksum label (optional)
- string name - new channel name (optional)
- string summary - new channel summary (optional)
- string description - new channel description (optional)
- string maintainer_name - new channel maintainer name (optional)
- string maintainer_email - new channel email address (optional)
- string maintainer_phone - new channel phone number (optional)
- string gpg_key_url - new channel gpg key url (optional)
- string gpg_key_id - new channel gpg key id (optional)
- string gpg_key_fp - new channel gpg key fingerprint (optional)

Return Value

int - 1 on success, exception thrown otherwise.

10.62. setGloballySubscribable
复制链接

Name

setGloballySubscribable

Description

Set globally subscribable attribute for given channel.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

10.63. setRepoFilters
复制链接

Name

setRepoFilters

Description

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

Parameters

string sessionKey
string label - repository label
array:
- struct - filter_map
  - string filter - string to filter on
  - string flag - + for include, - for exclude

Return Value

int - 1 on success, exception thrown otherwise.

10.64. setSystemChannels
复制链接

Name

setSystemChannels

Description

Change a systems subscribed channels to the list of channels passed in.

Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string channelLabel) and system.setChildChannels(string sessionKey, int serverId, array[string channelLabel])

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

10.65. setUserManageable
复制链接

Name

setUserManageable

Description

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

Parameters

string sessionKey
string channelLabel - label of the channel
string login - login of the target user
boolean value - value of the flag to set

Return Value

int - 1 on success, exception thrown otherwise.

10.66. setUserSubscribable
复制链接

Name

setUserSubscribable

Description

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

Parameters

string sessionKey
string channelLabel - label of the channel
string login - login of the target user
boolean value - value of the flag to set

Return Value

int - 1 on success, exception thrown otherwise.

10.67. subscribeSystem
复制链接

Name

subscribeSystem

Description

Subscribes a system to a list of channels. If a base channel is included, that is set before setting child channels. When setting child channels the current child channel subscriptions are cleared. To fully unsubscribe the system from all channels, simply provide an empty list of channel labels.

Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string channelLabel) and system.setChildChannels(string sessionKey, int serverId, array[string channelLabel])

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

10.68. syncErrata
复制链接

Name

syncErrata

Description

If you have satellite-synced a new channel then Red Hat Errata will have been updated with the packages that are in the newly synced channel. A cloned erratum will not have been automatically updated however. If you cloned a channel that includes those cloned errata and should include the new packages, they will not be included when they should. This method updates all the errata in the given cloned channel with packages that have recently been added, and ensures that all the packages you expect are in the channel.

Parameters

string sessionKey
string channelLabel - channel to update

Return Value

int - 1 on success, exception thrown otherwise.

10.69. syncRepo
复制链接

Name

syncRepo

Description

Trigger immediate repo synchronization

Parameters

string sessionKey
string channelLabel - channel label

Return Value

int - 1 on success, exception thrown otherwise.

10.70. syncRepo
复制链接

Name

syncRepo

Description

Trigger immediate repo synchronization

Parameters

string sessionKey
string channelLabel - channel label
struct - params_map
- Boolean sync-kickstart - Create kickstartable tree - Optional
- Boolean no-errata - Do not sync errata - Optional
- Boolean fail - Terminate upon any error - Optional

Return Value

int - 1 on success, exception thrown otherwise.

10.71. syncRepo
复制链接

Name

syncRepo

Description

Schedule periodic repo synchronization

Parameters

string sessionKey
string channelLabel - channel label
string cron expression - if empty all periodic schedules will be disabled

Return Value

int - 1 on success, exception thrown otherwise.

10.72. syncRepo
复制链接

Name

syncRepo

Description

Schedule periodic repo synchronization

Parameters

string sessionKey
string channelLabel - channel label
string cron expression - if empty all periodic schedules will be disabled
struct - params_map
- Boolean sync-kickstart - Create kickstartable tree - Optional
- Boolean no-errata - Do not sync errata - Optional
- Boolean fail - Terminate upon any error - Optional

Return Value

int - 1 on success, exception thrown otherwise.

10.73. updateRepo
复制链接

Name

updateRepo

Description

Updates a ContentSource (repo)

Parameters

string sessionKey
int id - repository id
string label - new repository label
string url - new repository URL

Return Value

struct - channel
- int id
- string label
- string sourceUrl
- string type
- string sslCaDesc
- string sslCertDesc
- string sslKeyDesc

10.74. updateRepoLabel
复制链接

Name

updateRepoLabel

Description

Updates repository label

Parameters

string sessionKey
int id - repository id
string label - new repository label

Return Value

struct - channel
- int id
- string label
- string sourceUrl
- string type
- string sslCaDesc
- string sslCertDesc
- string sslKeyDesc

10.75. updateRepoLabel
复制链接

Name

updateRepoLabel

Description

Updates repository label

Parameters

string sessionKey
string label - repository label
string newLabel - new repository label

Return Value

struct - channel
- int id
- string label
- string sourceUrl
- string type
- string sslCaDesc
- string sslCertDesc
- string sslKeyDesc

10.76. updateRepoSsl
复制链接

Name

updateRepoSsl

Description

Updates repository SSL certificates

Parameters

string sessionKey
int id - repository id
string sslCaCert - SSL CA cert description
string sslCliCert - SSL Client cert description
string sslCliKey - SSL Client key description

Return Value

struct - channel
- int id
- string label
- string sourceUrl
- string type
- string sslCaDesc
- string sslCertDesc
- string sslKeyDesc

10.77. updateRepoSsl
复制链接

Name

updateRepoSsl

Description

Updates repository SSL certificates

Parameters

string sessionKey
string label - repository label
string sslCaCert - SSL CA cert description
string sslCliCert - SSL Client cert description
string sslCliKey - SSL Client key description

Return Value

struct - channel
- int id
- string label
- string sourceUrl
- string type
- string sslCaDesc
- string sslCertDesc
- string sslKeyDesc

10.78. updateRepoUrl
复制链接

Name

updateRepoUrl

Description

Updates repository source URL

Parameters

string sessionKey
int id - repository id
string url - new repository url

Return Value

struct - channel
- int id
- string label
- string sourceUrl
- string type
- string sslCaDesc
- string sslCertDesc
- string sslKeyDesc

10.79. updateRepoUrl
复制链接

Name

updateRepoUrl

Description

Updates repository source URL

Parameters

string sessionKey
string label - repository label
string url - new repository url

Return Value

struct - channel
- int id
- string label
- string sourceUrl
- string type
- string sslCaDesc
- string sslCertDesc
- string sslKeyDesc

Chapter 11. configchannel
复制链接

Abstract

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

11.1. channelExists
复制链接

Name

channelExists

Description

Check for the existence of the config channel provided.

Parameters

string sessionKey
string channelLabel - Channel to check for.

Return Value

1 if exists, 0 otherwise.

11.2. create
复制链接

Name

create

Description

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

Parameters

string sessionKey
string channelLabel
string channelName
string channelDescription

Return Value

struct - Configuration Channel information
- int id
- int orgId
- string label
- string name
- string description
- struct configChannelType
- struct - Configuration Channel Type information
  - int id
  - string label
  - string name
  - int priority

11.3. createOrUpdatePath
复制链接

Name

createOrUpdatePath

Description

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

Available since: 10.2

Parameters

string sessionKey
string configChannelLabel
string path
boolean isDir - True if the path is a directory, False if it is a file.
struct - path info
- string contents - Contents of the file (text or base64 encoded if binary). (only for non-directories)
- boolean contents_enc64 - Identifies base64 encoded content (default: disabled, only for non-directories)
- string owner - Owner of the file/directory.
- string group - Group name of the file/directory.
- string permissions - Octal file/directory permissions (eg: 644)
- string selinux_ctx - SELinux Security context (optional)
- string macro-start-delimiter - Config file macro start delimiter. Use null or empty string to accept the default. (only for non-directories)
- string macro-end-delimiter - Config file macro end delimiter. Use null or empty string to accept the default. (only for non-directories)
- int revision - next revision number, auto increment for null
- boolean binary - mark the binary content, if True, base64 encoded content is expected (only for non-directories)

Return Value

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

11.4. createOrUpdateSymlink
复制链接

Name

createOrUpdateSymlink

Description

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

Available since: 10.2

Parameters

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

Return Value

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

11.5. deleteChannels
复制链接

Name

deleteChannels

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

11.6. deleteFileRevisions
复制链接

Name

deleteFileRevisions

Description

Delete specified revisions of a given configuration file

Parameters

string sessionKey
string channelLabel - Label of config channel to lookup on.
string filePath - Configuration file path.
array:
- int - List of revisions to delete

Return Value

int - 1 on success, exception thrown otherwise.

11.7. deleteFiles
复制链接

Name

deleteFiles

Description

Remove file paths from a global channel.

Parameters

string sessionKey
string channelLabel - Channel to remove the files from.
array:
- string - file paths to remove.

Return Value

int - 1 on success, exception thrown otherwise.

11.8. deployAllSystems
复制链接

Name

deployAllSystems

Description

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

Parameters

string sessionKey
string channelLabel - The configuration channel's label.

Return Value

int - 1 on success, exception thrown otherwise.

11.9. deployAllSystems
复制链接

Name

deployAllSystems

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

11.10. deployAllSystems
复制链接

Name

deployAllSystems

Description

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

Parameters

string sessionKey
string channelLabel - The configuration channel's label.
string filePath - The configuration file path.

Return Value

int - 1 on success, exception thrown otherwise.

11.11. deployAllSystems
复制链接

Name

deployAllSystems

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

11.12. getDetails
复制链接

Name

getDetails

Description

Lookup config channel details.

Parameters

string sessionKey
string channelLabel

Return Value

struct - Configuration Channel information
- int id
- int orgId
- string label
- string name
- string description
- struct configChannelType
- struct - Configuration Channel Type information
  - int id
  - string label
  - string name
  - int priority

11.13. getDetails
复制链接

Name

getDetails

Description

Lookup config channel details.

Parameters

string sessionKey
int channelId

Return Value

struct - Configuration Channel information
- int id
- int orgId
- string label
- string name
- string description
- struct configChannelType
- struct - Configuration Channel Type information
  - int id
  - string label
  - string name
  - int priority

11.14. getEncodedFileRevision
复制链接

Name

getEncodedFileRevision

Description

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

Parameters

string sessionKey
string configChannelLabel - label of config channel to lookup on
string filePath - config file path to examine
int revision - config file revision to examine

Return Value

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

11.15. getFileRevision
复制链接

Name

getFileRevision

Description

Get revision of the specified config file

Parameters

string sessionKey
string configChannelLabel - label of config channel to lookup on
string filePath - config file path to examine
int revision - config file revision to examine

Return Value

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

11.16. getFileRevisions
复制链接

Name

getFileRevisions

Description

Get list of revisions for specified config file

Parameters

string sessionKey
string channelLabel - label of config channel to lookup on
string filePath - config file path to examine

Return Value

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

11.17. listFiles
复制链接

Name

listFiles

Description

Return a list of files in a channel.

Parameters

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

Return Value

array:
- struct - Configuration File information
  - string type
  - file
    directory
    symlink
  - string path - File Path
  - dateTime.iso8601 last_modified - Last Modified Date

11.18. listGlobals
复制链接

Name

listGlobals

Description

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

Parameters

string sessionKey

Return Value

array:
- struct - Configuration Channel information
  - int id
  - int orgId
  - string label
  - string name
  - string description
  - string type
  - struct configChannelType
  - struct - Configuration Channel Type information
    int id
    string label
    string name
    int priority

11.19. listSubscribedSystems
复制链接

Name

listSubscribedSystems

Description

Return a list of systems subscribed to a configuration channel

Parameters

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

Return Value

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

11.20. lookupChannelInfo
复制链接

Name

lookupChannelInfo

Description

Lists details on a list channels given their channel labels.

Parameters

string sessionKey
array:
- string - configuration channel label

Return Value

array:
- struct - Configuration Channel information
  - int id
  - int orgId
  - string label
  - string name
  - string description
  - struct configChannelType
  - struct - Configuration Channel Type information
    int id
    string label
    string name
    int priority

11.21. lookupFileInfo
复制链接

Name

lookupFileInfo

Description

Given a list of paths and a channel, returns details about the latest revisions of the paths.

Available since: 10.2

Parameters

string sessionKey
string channelLabel - label of config channel to lookup on
array:
- string - List of paths to examine.

Return Value

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

11.22. lookupFileInfo
复制链接

Name

lookupFileInfo

Description

Given a path, revision number, and a channel, returns details about the latest revisions of the paths.

Available since: 10.12

Parameters

string sessionKey
string channelLabel - label of config channel to lookup on
string path - path of file/directory
int revsion - The revision number.

Return Value

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

11.23. scheduleFileComparisons
复制链接

Name

scheduleFileComparisons

Description

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

Parameters

string sessionKey
string channelLabel - Label of config channel
string path - File path
array:
- long - The list of server id that the comparison will be performed on

Return Value

int actionId - The action id of the scheduled action

11.24. update
复制链接

Name

update

Description

Update a global config channel. Caller must be at least a config admin or an organization admin, or have access to a system containing this config channel.

Parameters

string sessionKey
string channelLabel
string channelName
string description

Return Value

struct - Configuration Channel information
- int id
- int orgId
- string label
- string name
- string description
- struct configChannelType
- struct - Configuration Channel Type information
  - int id
  - string label
  - string name
  - int priority

Chapter 12. distchannel
复制链接

Abstract

Provides methods to access and modify distribution channel information

12.1. listDefaultMaps
复制链接

Name

listDefaultMaps

Description

Lists the default distribution channel maps

Parameters

string sessionKey

Return Value

array:
- struct - distChannelMap
  - string os - Operationg System
  - string release - OS Relase
  - string arch_name - Channel architecture
  - string channel_label - Channel label
  - string org_specific - 'Y' organization specific, 'N' default

12.2. listMapsForOrg
复制链接

Name

listMapsForOrg

Description

Lists distribution channel maps valid for the user's organization

Parameters

string sessionKey

Return Value

array:
- struct - distChannelMap
  - string os - Operationg System
  - string release - OS Relase
  - string arch_name - Channel architecture
  - string channel_label - Channel label
  - string org_specific - 'Y' organization specific, 'N' default

12.3. listMapsForOrg
复制链接

Name

listMapsForOrg

Description

Lists distribution channel maps valid for an organization, satellite admin right needed

Parameters

string sessionKey
int orgId

Return Value

array:
- struct - distChannelMap
  - string os - Operationg System
  - string release - OS Relase
  - string arch_name - Channel architecture
  - string channel_label - Channel label
  - string org_specific - 'Y' organization specific, 'N' default

12.4. setMapForOrg
复制链接

Name

setMapForOrg

Description

Sets, overrides (/removes if channelLabel empty) a distribution channel map within an organization

Parameters

string sessionKey
string os
string release
string archName
string channelLabel

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 13. errata
复制链接

Abstract

Provides methods to access and modify errata.

13.1. addPackages
复制链接

Name

addPackages

Description

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

Parameters

string sessionKey
string advisoryName
array:
- int - packageId

Return Value

int - representing the number of packages added, exception otherwise

13.2. applicableToChannels
复制链接

Name

applicableToChannels

Description

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

Parameters

string sessionKey
string advisoryName

Return Value

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

13.3. bugzillaFixes
复制链接

Name

bugzillaFixes

Description

Get the Bugzilla fixes for an erratum matching the given advisoryName. The bugs will be returned in a struct where the bug id is the key. i.e. 208144="errata.bugzillaFixes Method Returns different results than docs say"

Parameters

string sessionKey
string advisoryName

Return Value

struct - Bugzilla info
- string bugzilla_id - actual bug number is the key into the struct
- string bug_summary - summary who's key is the bug id

13.4. clone
复制链接

Name

clone

Description

Clone a list of errata into the specified channel.

Parameters

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

Return Value

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

13.5. cloneAsOriginal
复制链接

Name

cloneAsOriginal

Description

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

Parameters

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

Return Value

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

13.6. cloneAsOriginalAsync
复制链接

Name

cloneAsOriginalAsync

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

13.7. cloneAsync
复制链接

Name

cloneAsync

Description

Asynchronously clone a list of errata into the specified channel.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

13.8. create
复制链接

Name

create

Description

Create a custom errata. If "publish" is set to true, the errata will be published as well

Parameters

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

Return Value

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

13.9. delete
复制链接

Name

delete

Description

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

Parameters

string sessionKey
string advisoryName

Return Value

int - 1 on success, exception thrown otherwise.

13.10. findByCve
复制链接

Name

findByCve

Description

Lookup the details for errata associated with the given CVE (e.g. CVE-2008-3270)

Parameters

string sessionKey
string cveName

Return Value

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

13.11. getDetails
复制链接

Name

getDetails

Description

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

Parameters

string sessionKey
string advisoryName

Return Value

struct - erratum
- int id
- string issue_date
- string update_date
- string last_modified_date - This date is only included for published erratum and it represents the last time the erratum was modified.
- string synopsis
- int release
- string type
- string product
- string errataFrom
- string topic
- string description
- string references
- string notes
- string solution

13.12. listAffectedSystems
复制链接

Name

listAffectedSystems

Description

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

Parameters

string sessionKey
string advisoryName

Return Value

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

13.13. listByDate
复制链接

Name

listByDate

Description

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

Deprecated - being replaced by channel.software.listErrata(User LoggedInUser, string channelLabel)

Parameters

string sessionKey
string channelLabel

Return Value

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

13.14. listCves
复制链接

Name

listCves

Description

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

Parameters

string sessionKey
string advisoryName

Return Value

array:
- string - cveName

13.15. listKeywords
复制链接

Name

listKeywords

Description

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

Parameters

string sessionKey
string advisoryName

Return Value

array:
- string - Keyword associated with erratum.

13.16. listPackages
复制链接

Name

listPackages

Description

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

Parameters

string sessionKey
string advisoryName

Return Value

array:
- struct - package
  - int id
  - string name
  - string epoch
  - string version
  - string release
  - string arch_label
  - array providing_channels
    string - - Channel label providing this package.
  - string build_host
  - string description
  - string checksum
  - string checksum_type
  - string vendor
  - string summary
  - string cookie
  - string license
  - string path
  - string file
  - string build_date
  - string last_modified_date
  - string size
  - string payload_size

13.17. listUnpublishedErrata
复制链接

Name

listUnpublishedErrata

Description

Returns a list of unpublished errata

Parameters

string sessionKey

Return Value

array:
- struct - erratum
  - int id
  - int published
  - string advisory
  - string advisory_name
  - string advisory_type
  - string synopsis
  - dateTime.iso8601 created
  - dateTime.iso8601 update_date

13.18. publish
复制链接

Name

publish

Description

Publish an existing (unpublished) errata to a set of channels.

Parameters

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

Return Value

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

13.19. publishAsOriginal
复制链接

Name

publishAsOriginal

Description

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

Parameters

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

Return Value

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

13.20. removePackages
复制链接

Name

removePackages

Description

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

Parameters

string sessionKey
string advisoryName
array:
- int - packageId

Return Value

int - representing the number of packages removed, exception otherwise

13.21. setDetails
复制链接

Name

setDetails

Description

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

Parameters

string sessionKey
string advisoryName
struct - errata details
- string synopsis
- string advisory_name
- int advisory_release
- string advisory_type - Type of advisory (one of the following: 'Security Advisory', 'Product Enhancement Advisory', or 'Bug Fix Advisory'
- string product
- dateTime.iso8601 issue_date
- dateTime.iso8601 update_date
- string errataFrom
- string topic
- string description
- string references
- string notes
- string solution
- array bugs - 'bugs' is the key into the struct
- array:
  - struct - bug
    int id - Bug Id
    string summary
    string url
- array keywords - 'keywords' is the key into the struct
- array:
  - string - keyword - List of keywords to associate with the errata.
- array CVEs - 'cves' is the key into the struct
- array:
  - string - cves - List of CVEs to associate with the errata. (valid only for published errata)

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 14. kickstart
复制链接

Abstract

Provides methods to create kickstart files

14.1. cloneProfile
复制链接

Name

cloneProfile

Description

Clone a Kickstart Profile

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

14.2. createProfile
复制链接

Name

createProfile

Description

Import a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

14.3. createProfile
复制链接

Name

createProfile

Description

Import a kickstart profile.

Parameters

string sessionKey
string profileLabel - Label for the new kickstart profile.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
string kickstartHost - Kickstart hostname (of a satellite or proxy) used to construct the default download URL for the new kickstart profile.
string rootPassword - Root password.

Return Value

int - 1 on success, exception thrown otherwise.

14.4. createProfileWithCustomUrl
复制链接

Name

createProfileWithCustomUrl

Description

Import a kickstart profile.

Parameters

string sessionKey
string profileLabel - Label for the new kickstart profile.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
boolean downloadUrl - Download URL, or 'default' to use the kickstart tree's default URL.
string rootPassword - Root password.

Return Value

int - 1 on success, exception thrown otherwise.

14.5. createProfileWithCustomUrl
复制链接

Name

createProfileWithCustomUrl

Description

Import a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

14.6. deleteProfile
复制链接

Name

deleteProfile

Description

Delete a kickstart profile

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

14.7. disableProfile
复制链接

Name

disableProfile

Description

Enable/Disable a Kickstart Profile

Parameters

string sessionKey
string profileLabel - Label for the kickstart tree you want to en/disable
string disabled - true to disable the profile

Return Value

int - 1 on success, exception thrown otherwise.

14.8. findKickstartForIp
复制链接

Name

findKickstartForIp

Description

Find an associated kickstart for a given ip address.

Parameters

string sessionKey
string ipAddress - The ip address to search for (i.e. 192.168.0.1)

Return Value

string - label of the kickstart. Empty string ("") if not found.

14.9. importFile
复制链接

Name

importFile

Description

Import a kickstart profile.

Parameters

string sessionKey
string profileLabel - Label for the new kickstart profile.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
string kickstartFileContents - Contents of the kickstart file to import.

Return Value

int - 1 on success, exception thrown otherwise.

14.10. importFile
复制链接

Name

importFile

Description

Import a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

14.11. importFile
复制链接

Name

importFile

Description

Import a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

14.12. importRawFile
复制链接

Name

importRawFile

Description

Import a raw kickstart file into satellite.

Parameters

string sessionKey
string profileLabel - Label for the new kickstart profile.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
string kickstartFileContents - Contents of the kickstart file to import.

Return Value

int - 1 on success, exception thrown otherwise.

14.13. importRawFile
复制链接

Name

importRawFile

Description

Import a raw kickstart file into satellite.

Parameters

string sessionKey
string profileLabel - Label for the new kickstart profile.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
string kickstartableTreeLabel - Label of a kickstartable tree to associate the new profile with.
string kickstartFileContents - Contents of the kickstart file to import.
string updateType - Should the profile update itself to use the newest tree available? Possible values are: none (default), red_hat (only use Kickstart Trees synced from Red Hat), or all (includes custom Kickstart Trees).

Return Value

int - 1 on success, exception thrown otherwise.

14.14. isProfileDisabled
复制链接

Name

isProfileDisabled

Description

Returns whether a kickstart profile is disabled

Parameters

string sessionKey
string profileLabel - kickstart profile label

Return Value

true if profile is disabled

14.15. listAllIpRanges
复制链接

Name

listAllIpRanges

Description

List all Ip Ranges and their associated kickstarts available in the user's org.

Parameters

string sessionKey

Return Value

array:
- struct - Kickstart Ip Range
  - string ksLabel - The kickstart label associated with the ip range
  - string max - The max ip of the range
  - string min - The min ip of the range

14.16. listKickstartableChannels
复制链接

Name

listKickstartableChannels

Description

List kickstartable channels for the logged in user.

Parameters

string sessionKey

Return Value

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

14.17. listKickstartableTreeChannels
复制链接

Name

listKickstartableTreeChannels

Description

List kickstartable tree channels for the logged in user.

Parameters

string sessionKey

Return Value

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

14.18. listKickstartableTrees
复制链接

Name

listKickstartableTrees

Description

List the available kickstartable trees for the given channel.

Deprecated - being replaced by kickstart.tree.list(string sessionKey, string channelLabel)

Parameters

string sessionKey
string channelLabel - Label of channel to search.

Return Value

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

14.19. listKickstarts
复制链接

Name

listKickstarts

Description

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

Parameters

string sessionKey

Return Value

array:
- struct - kickstart
  - string label
  - string tree_label
  - string name
  - boolean advanced_mode
  - boolean org_default
  - boolean active
  - string update_type

14.20. renameProfile
复制链接

Name

renameProfile

Description

Rename a Kickstart Profile in Satellite

Parameters

string sessionKey
string originalLabel - Label for the kickstart profile you want to rename
string newLabel - new label to change to

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 15. kickstart.filepreservation
复制链接

Abstract

Provides methods to retrieve and manipulate kickstart file preservation lists.

15.1. create
复制链接

Name

create

Description

Create a new file preservation list.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

15.2. delete
复制链接

Name

delete

Description

Delete a file preservation list.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

15.3. getDetails
复制链接

Name

getDetails

Description

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

Parameters

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

Return Value

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

15.4. listAllFilePreservations
复制链接

Name

listAllFilePreservations

Description

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

Parameters

string sessionKey

Return Value

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

Chapter 16. kickstart.keys
复制链接

Abstract

Provides methods to manipulate kickstart keys.

16.1. create
复制链接

Name

create

Description

creates a new key with the given parameters

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

16.2. delete
复制链接

Name

delete

Description

deletes the key identified by the given parameters

Parameters

string session_key
string description

Return Value

int - 1 on success, exception thrown otherwise.

16.3. getDetails
复制链接

Name

getDetails

Description

returns all of the data associated with the given key

Parameters

string session_key
string description

Return Value

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

16.4. listAllKeys
复制链接

Name

listAllKeys

Description

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

Parameters

string sessionKey

Return Value

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

16.5. update
复制链接

Name

update

Description

Updates type and content of the key identified by the description

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 17. kickstart.profile.keys
复制链接

Abstract

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

17.1. addActivationKey
复制链接

Name

addActivationKey

Description

Add an activation key association to the kickstart profile

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

17.2. getActivationKeys
复制链接

Name

getActivationKeys

Description

Lookup the activation keys associated with the kickstart profile.

Parameters

string sessionKey
string ksLabel - the kickstart profile label

Return Value

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

17.3. removeActivationKey
复制链接

Name

removeActivationKey

Description

Remove an activation key association from the kickstart profile

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 18. kickstart.profile.software
复制链接

Abstract

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

18.1. appendToSoftwareList
复制链接

Name

appendToSoftwareList

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

18.2. getSoftwareDetails
复制链接

Name

getSoftwareDetails

Description

Gets kickstart profile software details.

Parameters

string sessionKey
string ksLabel - Label of the kickstart profile

Return Value

struct - Kickstart packages info
- string noBase - Install @Base package group
- string ignoreMissing - Ignore missing packages

18.3. getSoftwareList
复制链接

Name

getSoftwareList

Description

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

Parameters

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

Return Value

string[] - Get a list of a kickstart profile's software packages.

18.4. setSoftwareDetails
复制链接

Name

setSoftwareDetails

Description

Sets kickstart profile software details.

Parameters

string sessionKey
string ksLabel - Label of the kickstart profile
struct - Kickstart packages info
- string noBase - Install @Base package group
- string ignoreMissing - Ignore missing packages

Return Value

int - 1 on success, exception thrown otherwise.

18.5. setSoftwareList
复制链接

Name

setSoftwareList

Description

Set the list of software packages for a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

18.6. setSoftwareList
复制链接

Name

setSoftwareList

Description

Set the list of software packages for a kickstart profile.

Parameters

string sessionKey
string ksLabel - The label of a kickstart profile.
string[] packageList - A list of package names to be set on the profile.
boolean ignoremissing - Ignore missing packages if true
boolean nobase - Don't install @Base package group if true

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 19. kickstart.profile.system
复制链接

Abstract

Provides methods to set various properties of a kickstart profile.

19.1. addFilePreservations
复制链接

Name

addFilePreservations

Description

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

Parameters

string sessionKey
string kickstartLabel
array:
- string - filePreservations

Return Value

int - 1 on success, exception thrown otherwise.

19.2. addKeys
复制链接

Name

addKeys

Description

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

Parameters

string sessionKey
string kickstartLabel
array:
- string - keyDescription

Return Value

int - 1 on success, exception thrown otherwise.

19.3. checkConfigManagement
复制链接

Name

checkConfigManagement

Description

Check the configuration management status for a kickstart profile.

Parameters

string sessionKey
string ksLabel - the kickstart profile label

Return Value

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

19.4. checkRemoteCommands
复制链接

Name

checkRemoteCommands

Description

Check the remote commands status flag for a kickstart profile.

Parameters

string sessionKey
string ksLabel - the kickstart profile label

Return Value

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

19.5. disableConfigManagement
复制链接

Name

disableConfigManagement

Description

Disables the configuration management flag in a kickstart profile so that a system created using this profile will be NOT be configuration capable.

Parameters

string sessionKey
string ksLabel - the kickstart profile label

Return Value

int - 1 on success, exception thrown otherwise.

19.6. disableRemoteCommands
复制链接

Name

disableRemoteCommands

Description

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

Parameters

string sessionKey
string ksLabel - the kickstart profile label

Return Value

int - 1 on success, exception thrown otherwise.

19.7. enableConfigManagement
复制链接

Name

enableConfigManagement

Description

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

Parameters

string sessionKey
string ksLabel - the kickstart profile label

Return Value

int - 1 on success, exception thrown otherwise.

19.8. enableRemoteCommands
复制链接

Name

enableRemoteCommands

Description

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

Parameters

string sessionKey
string ksLabel - the kickstart profile label

Return Value

int - 1 on success, exception thrown otherwise.

19.9. getLocale
复制链接

Name

getLocale

Description

Retrieves the locale for a kickstart profile.

Parameters

string sessionKey
string ksLabel - the kickstart profile label

Return Value

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

19.10. getPartitioningScheme
复制链接

Name

getPartitioningScheme

Description

Get the partitioning scheme for a kickstart profile.

Parameters

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

Return Value

string[] - A list of partitioning commands used to setup the partitions, logical volumes and volume groups."

19.11. getRegistrationType
复制链接

Name

getRegistrationType

Description

returns the registration type of a given kickstart profile. Registration Type can be one of reactivation/deletion/none These types determine the behaviour of the registration when using this profile for reprovisioning.

Parameters

string sessionKey
string kickstartLabel

Return Value

string registrationType
- reactivation
- deletion
- none

19.12. getSELinux
复制链接

Name

getSELinux

Description

Retrieves the SELinux enforcing mode property of a kickstart profile.

Parameters

string sessionKey
string ksLabel - the kickstart profile label

Return Value

string enforcingMode
- enforcing
- permissive
- disabled

19.13. listFilePreservations
复制链接

Name

listFilePreservations

Description

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

Parameters

string sessionKey
string kickstartLabel

Return Value

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

19.14. listKeys
复制链接

Name

listKeys

Description

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

Parameters

string sessionKey
string kickstartLabel

Return Value

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

19.15. removeFilePreservations
复制链接

Name

removeFilePreservations

Description

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

Parameters

string sessionKey
string kickstartLabel
array:
- string - filePreservations

Return Value

int - 1 on success, exception thrown otherwise.

19.16. removeKeys
复制链接

Name

removeKeys

Description

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

Parameters

string sessionKey
string kickstartLabel
array:
- string - keyDescription

Return Value

int - 1 on success, exception thrown otherwise.

19.17. setLocale
复制链接

Name

setLocale

Description

Sets the locale for a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

19.18. setPartitioningScheme
复制链接

Name

setPartitioningScheme

Description

Set the partitioning scheme for a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

19.19. setRegistrationType
复制链接

Name

setRegistrationType

Description

Sets the registration type of a given kickstart profile. Registration Type can be one of reactivation/deletion/none These types determine the behaviour of the re registration when using this profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

19.20. setSELinux
复制链接

Name

setSELinux

Description

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

Parameters

string sessionKey
string ksLabel - the kickstart profile label
string enforcingMode - the selinux enforcing mode
- enforcing
- permissive
- disabled

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 20. kickstart.profile
复制链接

Abstract

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

20.1. addIpRange
复制链接

Name

addIpRange

Description

Add an ip range to a kickstart profile.

Parameters

string sessionKey
string label - The label of the kickstart
string min - The ip address making up the minimum of the range (i.e. 192.168.0.1)
string max - The ip address making up the maximum of the range (i.e. 192.168.0.254)

Return Value

int - 1 on success, exception thrown otherwise.

20.2. addScript
复制链接

Name

addScript

Description

Add a pre/post script to a kickstart profile.

Parameters

string sessionKey
string ksLabel - The kickstart label to add the script to.
string name - The kickstart script name.
string contents - The full script to add.
string interpreter - The path to the interpreter to use (i.e. /bin/bash). An empty string will use the kickstart default interpreter.
string type - The type of script (either 'pre' or 'post').
boolean chroot - Whether to run the script in the chrooted install location (recommended) or not.

Return Value

int id - the id of the added script

20.3. addScript
复制链接

Name

addScript

Description

Add a pre/post script to a kickstart profile.

Parameters

string sessionKey
string ksLabel - The kickstart label to add the script to.
string name - The kickstart script name.
string contents - The full script to add.
string interpreter - The path to the interpreter to use (i.e. /bin/bash). An empty string will use the kickstart default interpreter.
string type - The type of script (either 'pre' or 'post').
boolean chroot - Whether to run the script in the chrooted install location (recommended) or not.
boolean template - Enable templating using cobbler.

Return Value

int id - the id of the added script

20.4. addScript
复制链接

Name

addScript

Description

Add a pre/post script to a kickstart profile.

Parameters

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

Return Value

int id - the id of the added script

20.5. compareActivationKeys
复制链接

Name

compareActivationKeys

Description

Returns a list for each kickstart profile; each list will contain activation keys not present on the other profile.

Parameters

string sessionKey
string kickstartLabel1
string kickstartLabel2

Return Value

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

20.6. compareAdvancedOptions
复制链接

Name

compareAdvancedOptions

Description

Returns a list for each kickstart profile; each list will contain the properties that differ between the profiles and their values for that specific profile .

Parameters

string sessionKey
string kickstartLabel1
string kickstartLabel2

Return Value

struct - Comparison Info
- array kickstartLabel1 - Actual label of the first kickstart profile is the key into the struct
- array:
  - struct - value
    string name
    string value
    boolean enabled
- array kickstartLabel2 - Actual label of the second kickstart profile is the key into the struct
- array:
  - struct - value
    string name
    string value
    boolean enabled

20.7. comparePackages
复制链接

Name

comparePackages

Description

Returns a list for each kickstart profile; each list will contain package names not present on the other profile.

Parameters

string sessionKey
string kickstartLabel1
string kickstartLabel2

Return Value

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

20.8. downloadKickstart
复制链接

Name

downloadKickstart

Description

Download the full contents of a kickstart file.

Parameters

string sessionKey
string ksLabel - The label of the kickstart to download.
string host - The host to use when referring to the satellite itself (Usually this should be the FQDN of the satellite, but could be the ip address or shortname of it as well.

Return Value

string - The contents of the kickstart file. Note: if an activation key is not associated with the kickstart file, registration will not occur in the satellite generated %post section. If one is associated, it will be used for registration.

20.9. downloadRenderedKickstart
复制链接

Name

downloadRenderedKickstart

Description

Downloads the Cobbler-rendered Kickstart file.

Parameters

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

Return Value

string - The contents of the kickstart file.

20.10. getAdvancedOptions
复制链接

Name

getAdvancedOptions

Description

Get advanced options for a kickstart profile.

Parameters

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

Return Value

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

20.11. getAvailableRepositories
复制链接

Name

getAvailableRepositories

Description

Lists available OS repositories to associate with the provided kickstart profile.

Parameters

string sessionKey
string ksLabel

Return Value

array:
- string - repositoryLabel

20.12. getCfgPreservation
复制链接

Name

getCfgPreservation

Description

Get ks.cfg preservation option for a kickstart profile.

Parameters

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

Return Value

boolean - The value of the option. True means that ks.cfg will be copied to /root, false means that it will not.

20.13. getChildChannels
复制链接

Name

getChildChannels

Description

Get the child channels for a kickstart profile.

Parameters

string sessionKey
string kslabel - Label of kickstart profile.

Return Value

array:
- string - channelLabel

20.14. getCustomOptions
复制链接

Name

getCustomOptions

Description

Get custom options for a kickstart profile.

Parameters

string sessionKey
string ksLabel

Return Value

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

20.15. getKickstartTree
复制链接

Name

getKickstartTree

Description

Get the kickstart tree for a kickstart profile.

Parameters

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

Return Value

string kstreeLabel - Label of the kickstart tree.

20.16. getRepositories
复制链接

Name

getRepositories

Description

Lists all OS repositories associated with provided kickstart profile.

Parameters

string sessionKey
string ksLabel

Return Value

array:
- string - repositoryLabel

20.17. getUpdateType
复制链接

Name

getUpdateType

Description

Get the update type for a kickstart profile.

Parameters

string sessionKey
string kslabel - Label of kickstart profile.

Return Value

string update_type - Update type for this Kickstart Profile.

20.18. getVariables
复制链接

Name

getVariables

Description

Returns a list of variables associated with the specified kickstart profile

Parameters

string sessionKey
string ksLabel

Return Value

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

20.19. getVirtualizationType
复制链接

Name

getVirtualizationType

Description

For given kickstart profile label returns label of virtualization type it's using

Parameters

string sessionKey
string ksLabel

Return Value

string virtLabel - Label of virtualization type.

20.20. listIpRanges
复制链接

Name

listIpRanges

Description

List all ip ranges for a kickstart profile.

Parameters

string sessionKey
string label - The label of the kickstart

Return Value

array:
- struct - Kickstart Ip Range
  - string ksLabel - The kickstart label associated with the ip range
  - string max - The max ip of the range
  - string min - The min ip of the range

20.21. listScripts
复制链接

Name

listScripts

Description

List the pre and post scripts for a kickstart profile in the order they will run during the kickstart.

Parameters

string sessionKey
string ksLabel - The label of the kickstart

Return Value

array:
- struct - kickstart script
  - int id
  - string name
  - string contents
  - string script_type - Which type of script ('pre' or 'post').
  - string interpreter - The scripting language interpreter to use for this script. An empty string indicates the default kickstart shell.
  - boolean chroot - True if the script will be executed within the chroot environment.
  - boolean erroronfail - True if the script will throw an error if it fails.
  - boolean template - True if templating using cobbler is enabled
  - boolean beforeRegistration - True if script will run before the server registers and performs server actions.

20.22. orderScripts
复制链接

Name

orderScripts

Description

Change the order that kickstart scripts will run for this kickstart profile. Scripts will run in the order they appear in the array. There are three arrays, one for all pre scripts, one for the post scripts that run before registration and server actions happen, and one for post scripts that run after registration and server actions. All scripts must be included in one of these lists, as appropriate.

Parameters

string sessionKey
string ksLabel - The label of the kickstart
array:
- int - IDs of the ordered pre scripts
array:
- int - IDs of the ordered post scripts that will run before registration
array:
- int - IDs of the ordered post scripts that will run after registration

Return Value

int - 1 on success, exception thrown otherwise.

20.23. removeIpRange
复制链接

Name

removeIpRange

Description

Remove an ip range from a kickstart profile.

Parameters

string sessionKey
string ksLabel - The kickstart label of the ip range you want to remove
string ip_address - An Ip Address that falls within the range that you are wanting to remove. The min or max of the range will work.

Return Value

int - 1 on successful removal, 0 if range wasn't found for the specified kickstart, exception otherwise.

20.24. removeScript
复制链接

Name

removeScript

Description

Remove a script from a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

20.25. setAdvancedOptions
复制链接

Name

setAdvancedOptions

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

20.26. setCfgPreservation
复制链接

Name

setCfgPreservation

Description

Set ks.cfg preservation option for a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

20.27. setChildChannels
复制链接

Name

setChildChannels

Description

Set the child channels for a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

20.28. setCustomOptions
复制链接

Name

setCustomOptions

Description

Set custom options for a kickstart profile.

Parameters

string sessionKey
string ksLabel
string[] options

Return Value

int - 1 on success, exception thrown otherwise.

20.29. setKickstartTree
复制链接

Name

setKickstartTree

Description

Set the kickstart tree for a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

20.30. setLogging
复制链接

Name

setLogging

Description

Set logging options for a kickstart profile.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

20.31. setRepositories
复制链接

Name

setRepositories

Description

$call.doc

Parameters

string sessionKey
string ksLabel
array:
- string - repositoryLabel

Return Value

int - 1 on success, exception thrown otherwise.

20.32. setUpdateType
复制链接

Name

setUpdateType

Description

Set the update typefor a kickstart profile.

Parameters

string sessionKey
string kslabel - Label of kickstart profile to be changed.
string updateType - The new update type to set. Possible values are 'red_hat', 'all', and 'none'.

Return Value

int - 1 on success, exception thrown otherwise.

20.33. setVariables
复制链接

Name

setVariables

Description

Associates list of kickstart variables with the specified kickstart profile

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

20.34. setVirtualizationType
复制链接

Name

setVirtualizationType

Description

For given kickstart profile label sets its virtualization type.

Parameters

string sessionKey
string ksLabel
string typeLabel - One of the following: 'none', 'qemu', 'para_host', 'xenpv', 'xenfv'

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 21. kickstart.snippet
复制链接

Abstract

Provides methods to create kickstart files

21.1. createOrUpdate
复制链接

Name

createOrUpdate

Description

Will create a snippet with the given name and contents if it doesn't exist. If it does exist, the existing snippet will be updated.

Parameters

string sessionKey
string name
string contents

Return Value

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

21.2. delete
复制链接

Name

delete

Description

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

Parameters

string sessionKey
string name

Return Value

int - 1 on success, exception thrown otherwise.

21.3. listAll
复制链接

Name

listAll

Description

List all cobbler snippets for the logged in user

Parameters

string sessionKey

Return Value

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

21.4. listCustom
复制链接

Name

listCustom

Description

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

Parameters

string sessionKey

Return Value

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

21.5. listDefault
复制链接

Name

listDefault

Description

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

Parameters

string sessionKey

Return Value

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

Chapter 22. kickstart.tree
复制链接

Abstract

Provides methods to access and modify the kickstart trees.

22.1. create
复制链接

Name

create

Description

Create a Kickstart Tree (Distribution) in Satellite.

Parameters

string sessionKey
string treeLabel - The new kickstart tree label.
string basePath - Path to the base or root of the kickstart tree.
string channelLabel - Label of channel to associate with the kickstart tree.
string installType - Label for KickstartInstallType (rhel_2.1, rhel_3, rhel_4, rhel_5, fedora_9).

Return Value

int - 1 on success, exception thrown otherwise.

22.2. delete
复制链接

Name

delete

Description

Delete a Kickstart Tree (Distribution) in Satellite.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

22.3. deleteTreeAndProfiles
复制链接

Name

deleteTreeAndProfiles

Description

Delete a kickstarttree and any profiles associated with this kickstart tree. WARNING: This will delete all profiles associated with this kickstart tree!

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

22.4. getDetails
复制链接

Name

getDetails

Description

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

Parameters

string sessionKey
string treeLabel - Label of kickstartable tree to search.

Return Value

struct - kickstartable tree
- int id
- string label
- string abs_path
- int channel_id
- struct - kickstart install type
  - int id
  - string label
  - string name

22.5. list
复制链接

Name

list

Description

List the available kickstartable trees for the given channel.

Parameters

string sessionKey
string channelLabel - Label of channel to search.

Return Value

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

22.6. listInstallTypes
复制链接

Name

listInstallTypes

Description

List the available kickstartable install types (rhel2,3,4,5 and fedora9+).

Parameters

string sessionKey

Return Value

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

22.7. rename
复制链接

Name

rename

Description

Rename a Kickstart Tree (Distribution) in Satellite.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

22.8. update
复制链接

Name

update

Description

Edit a Kickstart Tree (Distribution) in Satellite.

Parameters

string sessionKey
string treeLabel - Label for the kickstart tree.
string basePath - Path to the base or root of the kickstart tree.
string channelLabel - Label of channel to associate with kickstart tree.
string installType - Label for KickstartInstallType (rhel_2.1, rhel_3, rhel_4, rhel_5, fedora_9).

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 23. org
复制链接

Abstract

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

23.1. create
复制链接

Name

create

Description

Create a new organization and associated administrator account.

Parameters

string sessionKey
string orgName - Organization name. Must meet same criteria as in the web UI.
string adminLogin - New administrator login name.
string adminPassword - New administrator password.
string prefix - New administrator's prefix. Must match one of the values available in the web UI. (i.e. Dr., Mr., Mrs., Sr., etc.)
string firstName - New administrator's first name.
string lastName - New administrator's first name.
string email - New administrator's e-mail.
boolean usePamAuth - True if PAM authentication should be used for the new administrator account.

Return Value

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

23.2. delete
复制链接

Name

delete

Description

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

Parameters

string sessionKey
int orgId

Return Value

int - 1 on success, exception thrown otherwise.

23.3. getCrashFileSizeLimit
复制链接

Name

getCrashFileSizeLimit

Description

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

Parameters

string sessionKey
int orgId

Return Value

int - Crash file size limit.

23.4. getDetails
复制链接

Name

getDetails

Description

The detailed information about an organization given the organization ID.

Parameters

string sessionKey
int orgId

Return Value

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

23.5. getDetails
复制链接

Name

getDetails

Description

The detailed information about an organization given the organization name.

Parameters

string sessionKey
string name

Return Value

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

23.6. getPolicyForScapFileUpload
复制链接

Name

getPolicyForScapFileUpload

Description

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

Parameters

string sessionKey
int orgId

Return Value

struct - scap_upload_info
- boolean enabled - Aggregation of detailed SCAP results is enabled.
- int size_limit - Limit (in Bytes) for a single SCAP file upload.

23.7. getPolicyForScapResultDeletion
复制链接

Name

getPolicyForScapResultDeletion

Description

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

Parameters

string sessionKey
int orgId

Return Value

struct - scap_deletion_info
- boolean enabled - Deletion of SCAP results is enabled
- int retention_period - Period (in days) after which a scan can be deleted (if enabled).

23.8. isCrashReportingEnabled
复制链接

Name

isCrashReportingEnabled

Description

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

Parameters

string sessionKey
int orgId

Return Value

boolean - Get the status of crash reporting settings.

23.9. isCrashfileUploadEnabled
复制链接

Name

isCrashfileUploadEnabled

Description

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

Parameters

string sessionKey
int orgId

Return Value

boolean - Get the status of crash file upload settings.

23.10. isErrataEmailNotifsForOrg
复制链接

Name

isErrataEmailNotifsForOrg

Description

Returns whether errata e-mail notifications are enabled for the organization

Parameters

string sessionKey
int orgId

Return Value

boolean - Returns the status of the errata e-mail notification setting for the organization

23.11. isOrgConfigManagedByOrgAdmin
复制链接

Name

isOrgConfigManagedByOrgAdmin

Description

Returns whether Organization Administrator is able to manage his organization configuration. This organization configuration may have a high impact on the whole Spacewalk/Satellite performance

Parameters

string sessionKey
int orgId

Return Value

boolean - Returns the status org admin management setting

23.12. listOrgs
复制链接

Name

listOrgs

Description

Returns the list of organizations.

Parameters

string sessionKey

Return Value

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

23.13. listSoftwareEntitlements
复制链接

Name

listSoftwareEntitlements

Description

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

Parameters

string sessionKey

Return Value

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

23.14. listSoftwareEntitlements
复制链接

Name

listSoftwareEntitlements

Description

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

Deprecated - being replaced by listSoftwareEntitlements(string sessionKey, string label, boolean includeUnentitled)

Parameters

string sessionKey
string label - Software entitlement label.

Return Value

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

23.15. listSoftwareEntitlements
复制链接

Name

listSoftwareEntitlements

Description

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

Available since: 10.4

Parameters

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

Return Value

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

23.16. listSoftwareEntitlementsForOrg
复制链接

Name

listSoftwareEntitlementsForOrg

Description

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

Parameters

string sessionKey
int orgId

Return Value

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

23.17. listSystemEntitlements
复制链接

Name

listSystemEntitlements

Description

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

Parameters

string sessionKey

Return Value

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

23.18. listSystemEntitlements
复制链接

Name

listSystemEntitlements

Description

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

Deprecated - being replaced by listSystemEntitlements(string sessionKey, string label, boolean includeUnentitled)

Parameters

string sessionKey
string label

Return Value

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

23.19. listSystemEntitlements
复制链接

Name

listSystemEntitlements

Description

List each organization's allocation of a system entitlement.

Available since: 10.4

Parameters

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

Return Value

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

23.20. listSystemEntitlementsForOrg
复制链接

Name

listSystemEntitlementsForOrg

Description

List an organization's allocation of each system entitlement.

Parameters

string sessionKey
int orgId

Return Value

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

23.21. listUsers
复制链接

Name

listUsers

Description

Returns the list of users in a given organization.

Parameters

string sessionKey
int orgId

Return Value

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

23.22. migrateSystems
复制链接

Name

migrateSystems

Description

Migrate systems from one organization to another. If executed by a Satellite administrator, the systems will be migrated from their current organization to the organization specified by the toOrgId. If executed by an organization administrator, the systems must exist in the same organization as that administrator and the systems will be migrated to the organization specified by the toOrgId. In any scenario, the origination and destination organizations must be defined in a trust.

Parameters

string sessionKey
int toOrgId - ID of the organization where the system(s) will be migrated to.
array:
- int - systemId

Return Value

array:
- int - serverIdMigrated

23.23. setCrashFileSizeLimit
复制链接

Name

setCrashFileSizeLimit

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

23.24. setCrashReporting
复制链接

Name

setCrashReporting

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

23.25. setCrashfileUpload
复制链接

Name

setCrashfileUpload

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

23.26. setErrataEmailNotifsForOrg
复制链接

Name

setErrataEmailNotifsForOrg

Description

Dis/enables errata e-mail notifications for the organization

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

23.27. setOrgConfigManagedByOrgAdmin
复制链接

Name

setOrgConfigManagedByOrgAdmin

Description

Sets whether Organization Administrator can manage his organization configuration. This organization configuration may have a high impact on the whole Spacewalk/Satellite performance

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

23.28. setPolicyForScapFileUpload
复制链接

Name

setPolicyForScapFileUpload

Description

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

Parameters

string sessionKey
int orgId
struct - scap_upload_info
- boolean enabled - Aggregation of detailed SCAP results is enabled.
- int size_limit - Limit (in Bytes) for a single SCAP file upload.

Return Value

int - 1 on success, exception thrown otherwise.

23.29. setPolicyForScapResultDeletion
复制链接

Name

setPolicyForScapResultDeletion

Description

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

Parameters

string sessionKey
int orgId
struct - scap_deletion_info
- boolean enabled - Deletion of SCAP results is enabled
- int retention_period - Period (in days) after which a scan can be deleted (if enabled).

Return Value

int - 1 on success, exception thrown otherwise.

23.30. setSoftwareEntitlements
复制链接

Name

setSoftwareEntitlements

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

23.31. setSoftwareFlexEntitlements
复制链接

Name

setSoftwareFlexEntitlements

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

23.32. setSystemEntitlements
复制链接

Name

setSystemEntitlements

Description

Parameters

string sessionKey
int orgId
string label - System entitlement label. Valid values include:
- enterprise_entitled
- provisioning_entitled
- virtualization_host
- virtualization_host_platform
int allocation

Return Value

int - 1 on success, exception thrown otherwise.

23.33. updateName
复制链接

Name

updateName

Description

Updates the name of an organization

Parameters

string sessionKey
int orgId
string name - Organization name. Must meet same criteria as in the web UI.

Return Value

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

Chapter 24. org.trusts
复制链接

Abstract

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

24.1. addTrust
复制链接

Name

addTrust

Description

Add an organization to the list of trusted organizations.

Parameters

string sessionKey
int orgId
int trustOrgId

Return Value

int - 1 on success, exception thrown otherwise.

24.2. getDetails
复制链接

Name

getDetails

Description

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

Parameters

string sessionKey
int trustOrgId - Id of the trusted organization

Return Value

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

24.3. listChannelsConsumed
复制链接

Name

listChannelsConsumed

Description

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

Parameters

string sessionKey
int trustOrgId - Id of the trusted organization

Return Value

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

24.4. listChannelsProvided
复制链接

Name

listChannelsProvided

Description

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

Parameters

string sessionKey
int trustOrgId - Id of the trusted organization

Return Value

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

24.5. listOrgs
复制链接

Name

listOrgs

Description

List all organanizations trusted by the user's organization.

Parameters

string sessionKey

Return Value

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

24.6. listSystemsAffected
复制链接

Name

listSystemsAffected

Description

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

Parameters

string sessionKey
int orgId
string trustOrgId

Return Value

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

24.7. listTrusts
复制链接

Name

listTrusts

Description

Returns the list of trusted organizations.

Parameters

string sessionKey
int orgId

Return Value

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

24.8. removeTrust
复制链接

Name

removeTrust

Description

Remove an organization to the list of trusted organizations.

Parameters

string sessionKey
int orgId
int trustOrgId

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 25. packages
复制链接

Abstract

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

25.1. findByNvrea
复制链接

Name

findByNvrea

Description

Lookup the details for packages with the given name, version, release, architecture label, and (optionally) epoch.

Parameters

string sessionKey
string name
string version
string release
string epoch - If set to something other than empty string, strict matching will be used and the epoch string must be correct. If set to an empty string, if the epoch is null or there is only one NVRA combination, it will be returned. (Empty string is recommended.)
string archLabel

Return Value

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - int id
  - string arch_label
  - string path - The path on that file system that the package resides
  - string provider - The provider of the package, determined by the gpg key it was signed with.
  - dateTime.iso8601 last_modified

25.2. getDetails
复制链接

Name

getDetails

Description

Retrieve details for the package with the ID.

Parameters

string sessionKey
int packageId

Return Value

struct - package
- int id
- string name
- string epoch
- string version
- string release
- string arch_label
- array providing_channels
  - string - Channel label providing this package.
- string build_host
- string description
- string checksum
- string checksum_type
- string vendor
- string summary
- string cookie
- string license
- string file
- string build_date
- string last_modified_date
- string size
- string path - The path on the Satellite's file system that the package resides.
- string payload_size

25.3. getPackage
复制链接

Name

getPackage

Description

Retrieve the package file associated with a package. (Consider using packages.getPackageUrl for larger files.)

Parameters

string sessionKey
int package_id

Return Value

binary object - package file

25.4. getPackageUrl
复制链接

Name

getPackageUrl

Description

Retrieve the url that can be used to download a package. This will expire after a certain time period.

Parameters

string sessionKey
int package_id

Return Value

string - the download url

25.5. listChangelog
复制链接

Name

listChangelog

Description

List the change log for a package.

Parameters

string sessionKey
int packageId

Return Value

string

25.6. listDependencies
复制链接

Name

listDependencies

Description

List the dependencies for a package.

Parameters

string sessionKey
int packageId

Return Value

array:
- struct - dependency
  - string dependency
  - string dependency_type - One of the following:
  - requires
    conflicts
    obsoletes
    provides
    recommends
    suggests
    supplements
    enhances
  - string dependency_modifier

25.7. listFiles
复制链接

Name

listFiles

Description

List the files associated with a package.

Parameters

string sessionKey
int packageId

Return Value

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

25.8. listProvidingChannels
复制链接

Name

listProvidingChannels

Description

List the channels that provide the a package.

Parameters

string sessionKey
int packageId

Return Value

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

25.9. listProvidingErrata
复制链接

Name

listProvidingErrata

Description

List the errata providing the a package.

Parameters

string sessionKey
int packageId

Return Value

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

25.10. listSourcePackages
复制链接

Name

listSourcePackages

Description

List all source packages in user's organization.

Parameters

string sessionKey

Return Value

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

25.11. removePackage
复制链接

Name

removePackage

Description

Remove a package from the satellite.

Parameters

string sessionKey
int packageId

Return Value

int - 1 on success, exception thrown otherwise.

25.12. removeSourcePackage
复制链接

Name

removeSourcePackage

Description

Remove a source package.

Parameters

string sessionKey
int packageSourceId

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 26. packages.provider
复制链接

Abstract

Methods to retrieve information about Package Providers associated with packages.

26.1. associateKey
复制链接

Name

associateKey

Description

Associate a package security key and with the package provider. If the provider or key doesn't exist, it is created. User executing the request must be a Satellite administrator.

Parameters

string sessionKey
string providerName - The provider name
string key - The actual key
string type - The type of the key. Currently, only 'gpg' is supported

Return Value

int - 1 on success, exception thrown otherwise.

26.2. list
复制链接

Name

list

Description

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

Parameters

string sessionKey

Return Value

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

26.3. listKeys
复制链接

Name

listKeys

Description

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

Parameters

string sessionKey
string providerName - The provider name

Return Value

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

Chapter 27. packages.search
复制链接

Abstract

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

27.1. advanced
复制链接

Name

advanced

Description

Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax. Lucene Query Parser syntax is defined at lucene.apache.org. Fields searchable for Packages: name, epoch, version, release, arch, description, summary Lucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"

Parameters

string sessionKey
string luceneQuery - a query written in the form of Lucene QueryParser Syntax

Return Value

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

27.2. advancedWithActKey
复制链接

Name

advancedWithActKey

Description

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

Parameters

string sessionKey
string luceneQuery - a query written in the form of Lucene QueryParser Syntax
string actKey - activation key to look for packages in

Return Value

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

27.3. advancedWithChannel
复制链接

Name

advancedWithChannel

Description

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

Parameters

string sessionKey
string luceneQuery - a query written in the form of Lucene QueryParser Syntax
string channelLabel - Channel Label

Return Value

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

27.4. name
复制链接

Name

name

Description

Search the lucene package indexes for all packages which match the given name.

Parameters

string sessionKey
string name - package name to search for

Return Value

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

27.5. nameAndDescription
复制链接

Name

nameAndDescription

Description

Search the lucene package indexes for all packages which match the given query in name or description

Parameters

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

Return Value

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

27.6. nameAndSummary
复制链接

Name

nameAndSummary

Description

Search the lucene package indexes for all packages which match the given query in name or summary.

Parameters

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

Return Value

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

Chapter 28. preferences.locale
复制链接

Abstract

Provides methods to access and modify user locale information

28.1. listLocales
复制链接

Name

listLocales

Description

Returns a list of all understood locales. Can be used as input to setLocale.

Parameters

None

Return Value

array:
- string - Locale code.

28.2. listTimeZones
复制链接

Name

listTimeZones

Description

Returns a list of all understood timezones. Results can be used as input to setTimeZone.

Parameters

None

Return Value

array:
- struct - timezone
  - int time_zone_id - Unique identifier for timezone.
  - string olson_name - Name as identified by the Olson database.

28.3. setLocale
复制链接

Name

setLocale

Description

Set a user's locale.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

28.4. setTimeZone
复制链接

Name

setTimeZone

Description

Set a user's timezone.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 29. proxy
复制链接

Abstract

Provides methods to activate/deactivate a proxy server.

29.1. activateProxy
复制链接

Name

activateProxy

Description

Activates the proxy identified by the given client certificate i.e. systemid file.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

29.2. createMonitoringScout
复制链接

Name

createMonitoringScout

Description

Create Monitoring Scout for proxy.

Available since: 10.7

Parameters

string systemid - systemid file

Return Value

string

29.3. deactivateProxy
复制链接

Name

deactivateProxy

Description

Deactivates the proxy identified by the given client certificate i.e. systemid file.

Parameters

string systemid - systemid file

Return Value

int - 1 on success, exception thrown otherwise.

29.4. isProxy
复制链接

Name

isProxy

Description

Test, if the system identified by the given client certificate i.e. systemid file, is proxy.

Parameters

string systemid - systemid file

Return Value

int - 1 on success, exception thrown otherwise.

29.5. listAvailableProxyChannels
复制链接

Name

listAvailableProxyChannels

Description

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

Available since: 10.5

Parameters

string systemid - systemid file

Return Value

array:
- string - version

Chapter 30. satellite
复制链接

Abstract

Provides methods to obtain details on the Satellite.

30.1. getCertificateExpirationDate
复制链接

Name

getCertificateExpirationDate

Description

Retrieves the certificate expiration date of the activated certificate.

Parameters

string sessionKey

Return Value

dateTime.iso8601

30.2. isMonitoringEnabled
复制链接

Name

isMonitoringEnabled

Description

Indicates if monitoring is enabled on the satellite

Parameters

string sessionKey

Return Value

boolean True if monitoring is enabled

30.3. isMonitoringEnabledBySystemId
复制链接

Name

isMonitoringEnabledBySystemId

Description

Indicates if monitoring is enabled on the satellite

Parameters

string systemid - systemid file

Return Value

boolean True if monitoring is enabled

30.4. listEntitlements
复制链接

Name

listEntitlements

Description

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

Parameters

string sessionKey

Return Value

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

30.5. listProxies
复制链接

Name

listProxies

Description

List the proxies within the user's organization.

Parameters

string sessionKey

Return Value

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

Chapter 31. schedule
复制链接

Abstract

Methods to retrieve information about scheduled actions.

31.1. archiveActions
复制链接

Name

archiveActions

Description

Archive all actions in the given list.

Parameters

string sessionKey
array:
- int - action id

Return Value

int - 1 on success, exception thrown otherwise.

31.2. cancelActions
复制链接

Name

cancelActions

Description

Cancel all actions in given list. If an invalid action is provided, none of the actions given will canceled.

Parameters

string sessionKey
array:
- int - action id

Return Value

int - 1 on success, exception thrown otherwise.

31.3. deleteActions
复制链接

Name

deleteActions

Description

Delete all archived actions in the given list.

Parameters

string sessionKey
array:
- int - action id

Return Value

int - 1 on success, exception thrown otherwise.

31.4. failSystemAction
复制链接

Name

failSystemAction

Description

Fail specific event on specified system

Parameters

string sessionKey
int serverId
int actionId

Return Value

int - 1 on success, exception thrown otherwise.

31.5. failSystemAction
复制链接

Name

failSystemAction

Description

Fail specific event on specified system

Parameters

string sessionKey
int serverId
int actionId
string message

Return Value

int - 1 on success, exception thrown otherwise.

31.6. listAllActions
复制链接

Name

listAllActions

Description

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

Parameters

string sessionKey

Return Value

array:
- struct - action
  - int id - Action Id.
  - string name - Action name.
  - string type - Action type.
  - string scheduler - The user that scheduled the action. (optional)
  - dateTime.iso8601 earliest - The earliest date and time the action will be performed
  - int completedSystems - Number of systems that completed the action.
  - int failedSystems - Number of systems that failed the action.
  - int inProgressSystems - Number of systems that are in progress.

31.7. listArchivedActions
复制链接

Name

listArchivedActions

Description

Returns a list of actions that have been archived.

Parameters

string sessionKey

Return Value

array:
- struct - action
  - int id - Action Id.
  - string name - Action name.
  - string type - Action type.
  - string scheduler - The user that scheduled the action. (optional)
  - dateTime.iso8601 earliest - The earliest date and time the action will be performed
  - int completedSystems - Number of systems that completed the action.
  - int failedSystems - Number of systems that failed the action.
  - int inProgressSystems - Number of systems that are in progress.

31.8. listCompletedActions
复制链接

Name

listCompletedActions

Description

Returns a list of actions that have completed successfully.

Parameters

string sessionKey

Return Value

array:
- struct - action
  - int id - Action Id.
  - string name - Action name.
  - string type - Action type.
  - string scheduler - The user that scheduled the action. (optional)
  - dateTime.iso8601 earliest - The earliest date and time the action will be performed
  - int completedSystems - Number of systems that completed the action.
  - int failedSystems - Number of systems that failed the action.
  - int inProgressSystems - Number of systems that are in progress.

31.9. listCompletedSystems
复制链接

Name

listCompletedSystems

Description

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

Parameters

string sessionKey
string actionId

Return Value

array:
- struct - system
  - int server_id
  - string server_name - Server name.
  - string base_channel - Base channel used by the server.
  - dateTime.iso8601 timestamp - The time the action was completed
  - string message - Optional message containing details on the execution of the action. For example, if the action failed, this will contain the failure text.

31.10. listFailedActions
复制链接

Name

listFailedActions

Description

Returns a list of actions that have failed.

Parameters

string sessionKey

Return Value

array:
- struct - action
  - int id - Action Id.
  - string name - Action name.
  - string type - Action type.
  - string scheduler - The user that scheduled the action. (optional)
  - dateTime.iso8601 earliest - The earliest date and time the action will be performed
  - int completedSystems - Number of systems that completed the action.
  - int failedSystems - Number of systems that failed the action.
  - int inProgressSystems - Number of systems that are in progress.

31.11. listFailedSystems
复制链接

Name

listFailedSystems

Description

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

Parameters

string sessionKey
string actionId

Return Value

array:
- struct - system
  - int server_id
  - string server_name - Server name.
  - string base_channel - Base channel used by the server.
  - dateTime.iso8601 timestamp - The time the action was completed
  - string message - Optional message containing details on the execution of the action. For example, if the action failed, this will contain the failure text.

31.12. listInProgressActions
复制链接

Name

listInProgressActions

Description

Returns a list of actions that are in progress.

Parameters

string sessionKey

Return Value

array:
- struct - action
  - int id - Action Id.
  - string name - Action name.
  - string type - Action type.
  - string scheduler - The user that scheduled the action. (optional)
  - dateTime.iso8601 earliest - The earliest date and time the action will be performed
  - int completedSystems - Number of systems that completed the action.
  - int failedSystems - Number of systems that failed the action.
  - int inProgressSystems - Number of systems that are in progress.

31.13. listInProgressSystems
复制链接

Name

listInProgressSystems

Description

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

Parameters

string sessionKey
string actionId

Return Value

array:
- struct - system
  - int server_id
  - string server_name - Server name.
  - string base_channel - Base channel used by the server.
  - dateTime.iso8601 timestamp - The time the action was completed
  - string message - Optional message containing details on the execution of the action. For example, if the action failed, this will contain the failure text.

31.14. rescheduleActions
复制链接

Name

rescheduleActions

Description

Reschedule all actions in the given list.

Parameters

string sessionKey
array:
- int - action id
boolean onlyFailed - True to only reschedule failed actions, False to reschedule all

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 32. sync.master
复制链接

Abstract

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

32.1. addToMaster
复制链接

Name

addToMaster

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

32.2. create
复制链接

Name

create

Description

Create a new Master, known to this Slave.

Parameters

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

Return Value

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

32.3. delete
复制链接

Name

delete

Description

Remove the specified Master

Parameters

string sessionKey
int id - Id of the Master to remove

Return Value

int - 1 on success, exception thrown otherwise.

32.4. getDefaultMaster
复制链接

Name

getDefaultMaster

Description

Return the current default-Master for this Slave

Parameters

string sessionKey

Return Value

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

32.5. getMaster
复制链接

Name

getMaster

Description

Find a Master by specifying its ID

Parameters

string sessionKey
int id - Id of the desired Master

Return Value

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

32.6. getMasterByLabel
复制链接

Name

getMasterByLabel

Description

Find a Master by specifying its label

Parameters

string sessionKey
string label - Label of the desired Master

Return Value

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

32.7. getMasterOrgs
复制链接

Name

getMasterOrgs

Description

List all organizations the specified Master has exported to this Slave

Parameters

string sessionKey
int id - Id of the desired Master

Return Value

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

32.8. getMasters
复制链接

Name

getMasters

Description

Get all the Masters this Slave knows about

Parameters

string sessionKey

Return Value

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

32.9. makeDefault
复制链接

Name

makeDefault

Description

Make the specified Master the default for this Slave's satellite-sync

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

32.10. mapToLocal
复制链接

Name

mapToLocal

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

32.11. setCaCert
复制链接

Name

setCaCert

Description

Set the CA-CERT filename for specified Master on this Slave

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

32.12. setMasterOrgs
复制链接

Name

setMasterOrgs

Description

Reset all organizations the specified Master has exported to this Slave

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

32.13. unsetDefaultMaster
复制链接

Name

unsetDefaultMaster

Description

Make this slave have no default Master for satellite-sync

Parameters

string sessionKey

Return Value

int - 1 on success, exception thrown otherwise.

32.14. update
复制链接

Name

update

Description

Updates the label of the specified Master

Parameters

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

Return Value

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

Chapter 33. sync.slave
复制链接

Abstract

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

33.1. create
复制链接

Name

create

Description

Create a new Slave, known to this Master.

Parameters

string sessionKey
string slave - Slave's fully-qualified domain name
boolean enabled - Let this slave talk to us?
boolean allowAllOrgs - Export all our orgs to this slave?

Return Value

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

33.2. delete
复制链接

Name

delete

Description

Remove the specified Slave

Parameters

string sessionKey
int id - Id of the Slave to remove

Return Value

int - 1 on success, exception thrown otherwise.

33.3. getAllowedOrgs
复制链接

Name

getAllowedOrgs

Description

Get all orgs this Master is willing to export to the specified Slave

Parameters

string sessionKey
int id - Id of the desired Slave

Return Value

array:
- int - ids of allowed organizations

33.4. getSlave
复制链接

Name

getSlave

Description

Find a Slave by specifying its ID

Parameters

string sessionKey
int id - Id of the desired Slave

Return Value

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

33.5. getSlaveByName
复制链接

Name

getSlaveByName

Description

Find a Slave by specifying its Fully-Qualified Domain Name

Parameters

string sessionKey
string fqdn - Domain-name of the desired Slave

Return Value

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

33.6. getSlaves
复制链接

Name

getSlaves

Description

Get all the Slaves this Master knows about

Parameters

string sessionKey

Return Value

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

33.7. setAllowedOrgs
复制链接

Name

setAllowedOrgs

Description

Set the orgs this Master is willing to export to the specified Slave

Parameters

string sessionKey
int id - Id of the desired Slave
array:
- int - List of org-ids we're willing to export

Return Value

int - 1 on success, exception thrown otherwise.

33.8. update
复制链接

Name

update

Description

Updates attributes of the specified Slave

Parameters

string sessionKey
int id - Id of the Slave to update
string slave - Slave's fully-qualified domain name
boolean enabled - Let this slave talk to us?
boolean allowAllOrgs - Export all our orgs to this Slave?

Return Value

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

Chapter 34. system
复制链接

Abstract

Provides methods to access and modify registered system.

34.1. addEntitlements
复制链接

Name

addEntitlements

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

34.2. addNote
复制链接

Name

addNote

Description

Add a new note to the given server.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

34.3. applyErrata
复制链接

Name

applyErrata

Description

Schedules an action to apply errata updates to a system.

Deprecated - being replaced by system.scheduleApplyErrata(string sessionKey, int serverId, array[int errataId])

Parameters

string sessionKey
int serverId
array:
- int - errataId

Return Value

int - 1 on success, exception thrown otherwise.

34.4. comparePackageProfile
复制链接

Name

comparePackageProfile

Description

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

Parameters

string sessionKey
int serverId
string profileLabel

Return Value

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

34.5. comparePackages
复制链接

Name

comparePackages

Description

Compares the packages installed on two systems.

Parameters

string sessionKey
int thisServerId
int otherServerId

Return Value

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

34.6. convertToFlexEntitlement
复制链接

Name

convertToFlexEntitlement

Description

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

Parameters

string sessionKey
array:
- int - serverId
string channelFamilyLabel

Return Value

int - the total the number of systems that were converted to use flex entitlement.

34.7. createPackageProfile
复制链接

Name

createPackageProfile

Description

Create a new stored Package Profile from a systems installed package list.

Parameters

string sessionKey
int serverId
string profileLabel
string description

Return Value

int - 1 on success, exception thrown otherwise.

34.8. createSystemRecord
复制链接

Name

createSystemRecord

Description

Creates a cobbler system record with the specified kickstart label

Parameters

string sessionKey
int serverId
string ksLabel

Return Value

int - 1 on success, exception thrown otherwise.

34.9. deleteCustomValues
复制链接

Name

deleteCustomValues

Description

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

Parameters

string sessionKey
int serverId
array:
- string - customInfoLabel

Return Value

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

34.10. deleteGuestProfiles
复制链接

Name

deleteGuestProfiles

Description

Delete the specified list of guest profiles for a given host

Parameters

string sessionKey
int hostId
array:
- string - guestNames

Return Value

int - 1 on success, exception thrown otherwise.

34.11. deleteNote
复制链接

Name

deleteNote

Description

Deletes the given note from the server.

Parameters

string sessionKey
int serverId
int noteId

Return Value

int - 1 on success, exception thrown otherwise.

34.12. deleteNotes
复制链接

Name

deleteNotes

Description

Deletes all notes from the server.

Parameters

string sessionKey
int serverId

Return Value

int - 1 on success, exception thrown otherwise.

34.13. deletePackageProfile
复制链接

Name

deletePackageProfile

Description

Delete a package profile

Parameters

string sessionKey
int profileId

Return Value

int - 1 on success, exception thrown otherwise.

34.14. deleteSystem
复制链接

Name

deleteSystem

Description

Delete a system given its client certificate.

Available since: 10.10

Parameters

string systemid - systemid file

Return Value

int - 1 on success, exception thrown otherwise.

34.15. deleteSystem
复制链接

Name

deleteSystem

Description

Delete a system given its server id synchronously

Parameters

string sessionKey
int serverId

Return Value

int - 1 on success, exception thrown otherwise.

34.16. deleteSystems
复制链接

Name

deleteSystems

Description

Delete systems given a list of system ids asynchronously.

Parameters

string sessionKey
array:
- int - serverId

Return Value

int - 1 on success, exception thrown otherwise.

34.17. deleteTagFromSnapshot
复制链接

Name

deleteTagFromSnapshot

Description

Deletes tag from system snapshot

Parameters

string sessionKey
int serverId
string tagName

Return Value

int - 1 on success, exception thrown otherwise.

34.18. downloadSystemId
复制链接

Name

downloadSystemId

Description

Get the system ID file for a given server.

Parameters

string sessionKey
int serverId

Return Value

string

34.19. getConnectionPath
复制链接

Name

getConnectionPath

Description

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

Parameters

string sessionKey
int serverId

Return Value

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

34.20. getCpu
复制链接

Name

getCpu

Description

Gets the CPU information of a system.

Parameters

string sessionKey
int serverId

Return Value

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

34.21. getCustomValues
复制链接

Name

getCustomValues

Description

Get the custom data values defined for the server.

Parameters

string sessionKey
int serverId

Return Value

struct - custom value
- string custom info label

34.22. getDetails
复制链接

Name

getDetails

Description

Get system details.

Parameters

string sessionKey
int serverId

Return Value

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

34.23. getDevices
复制链接

Name

getDevices

Description

Gets a list of devices for a system.

Parameters

string sessionKey
int serverId

Return Value

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

34.24. getDmi
复制链接

Name

getDmi

Description

Gets the DMI information of a system.

Parameters

string sessionKey
int serverId

Return Value

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

34.25. getEntitlements
复制链接

Name

getEntitlements

Description

Gets the entitlements for a given server.

Parameters

string sessionKey
int serverId

Return Value

array:
- string - entitlement_label

34.26. getEventHistory
复制链接

Name

getEventHistory

Description

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

Parameters

string sessionKey
int serverId

Return Value

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

34.27. getId
复制链接

Name

getId

Description

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

Parameters

string sessionKey
string systemName

Return Value

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

34.28. getMemory
复制链接

Name

getMemory

Description

Gets the memory information for a system.

Parameters

string sessionKey
int serverId

Return Value

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

34.29. getName
复制链接

Name

getName

Description

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

Parameters

string sessionKey
string serverId

Return Value

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

34.30. getNetwork
复制链接

Name

getNetwork

Description

Get the addresses and hostname for a given server.

Parameters

string sessionKey
int serverId

Return Value

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

34.31. getNetworkDevices
复制链接

Name

getNetworkDevices

Description

Returns the network devices for the given server.

Parameters

string sessionKey
int serverId

Return Value

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

34.32. getOsaPing
复制链接

Name

getOsaPing

Description

get details about a ping sent to a system using OSA

Parameters

User loggedInUser
int serverId

Return Value

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

34.33. getRegistrationDate
复制链接

Name

getRegistrationDate

Description

Returns the date the system was registered.

Parameters

string sessionKey
int serverId

Return Value

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

34.34. getRelevantErrata
复制链接

Name

getRelevantErrata

Description

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

Parameters

string sessionKey
int serverId

Return Value

array:
- struct - errata
  - int id - Errata ID.
  - string date - Date erratum was created.
  - string update_date - Date erratum was updated.
  - string advisory_synopsis - Summary of the erratum.
  - string advisory_type - Type label such as Security, Bug Fix
  - string advisory_name - Name such as RHSA, etc

34.35. getRelevantErrataByType
复制链接

Name

getRelevantErrataByType

Description

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

Parameters

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

Return Value

array:
- struct - errata
  - int id - Errata ID.
  - string date - Date erratum was created.
  - string update_date - Date erratum was updated.
  - string advisory_synopsis - Summary of the erratum.
  - string advisory_type - Type label such as Security, Bug Fix
  - string advisory_name - Name such as RHSA, etc

34.36. getRunningKernel
复制链接

Name

getRunningKernel

Description

Returns the running kernel of the given system.

Parameters

string sessionKey
int serverId

Return Value

string

34.37. getScriptActionDetails
复制链接

Name

getScriptActionDetails

Description

Returns script details for script run actions

Parameters

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

Return Value

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

34.38. getScriptResults
复制链接

Name

getScriptResults

Description

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

Parameters

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

Return Value

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

34.39. getSubscribedBaseChannel
复制链接

Name

getSubscribedBaseChannel

Description

Provides the base channel of a given system

Parameters

string sessionKey
int serverId

Return Value

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

34.40. getSystemCurrencyMultipliers
复制链接

Name

getSystemCurrencyMultipliers

Description

Get the System Currency score multipliers

Parameters

string sessionKey

Return Value

Map of score multipliers

34.41. getSystemCurrencyScores
复制链接

Name

getSystemCurrencyScores

Description

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

Parameters

string sessionKey

Return Value

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

34.42. getUnscheduledErrata
复制链接

Name

getUnscheduledErrata

Description

Provides an array of errata that are applicable to a given system.

Parameters

string sessionKey
int serverId

Return Value

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

34.43. getUuid
复制链接

Name

getUuid

Description

Get the UUID from the given system ID.

Parameters

string sessionKey
int serverId

Return Value

string

34.44. getVariables
复制链接

Name

getVariables

Description

Lists kickstart variables set in the system record for the specified server. Note: This call assumes that a system record exists in cobbler for the given system and will raise an XMLRPC fault if that is not the case. To create a system record over xmlrpc use system.createSystemRecord To create a system record in the Web UI please go to System -> <Specified System> -> Provisioning -> Select a Kickstart profile -> Create Cobbler System Record.

Parameters

string sessionKey
int serverId

Return Value

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

34.45. isNvreInstalled
复制链接

Name

isNvreInstalled

Description

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

Parameters

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

Return Value

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

34.46. isNvreInstalled
复制链接

Name

isNvreInstalled

Description

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

Parameters

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

Return Value

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

34.47. listActivationKeys
复制链接

Name

listActivationKeys

Description

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

Parameters

string sessionKey
int serverId

Return Value

array:
- string - key

34.48. listActiveSystems
复制链接

Name

listActiveSystems

Description

Returns a list of active servers visible to the user.

Parameters

string sessionKey

Return Value

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

34.49. listActiveSystemsDetails
复制链接

Name

listActiveSystemsDetails

Description

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

Parameters

string sessionKey
array:
- int - serverIds

Return Value

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

34.50. listAdministrators
复制链接

Name

listAdministrators

Description

Returns a list of users which can administer the system.

Parameters

string sessionKey
int serverId

Return Value

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

34.51. listAllInstallablePackages
复制链接

Name

listAllInstallablePackages

Description

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

Parameters

string sessionKey
int serverId

Return Value

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

34.52. listBaseChannels
复制链接

Name

listBaseChannels

Description

Returns a list of subscribable base channels.

Deprecated - being replaced by listSubscribableBaseChannels(string sessionKey, int serverId)

Parameters

string sessionKey
int serverId

Return Value

array:
- struct - channel
  - int id - Base Channel ID.
  - string name - Name of channel.
  - string label - Label of Channel
  - int current_base - 1 indicates it is the current base channel

34.53. listChildChannels
复制链接

Name

listChildChannels

Description

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

Deprecated - being replaced by listSubscribableChildChannels(string sessionKey, int serverId)

Parameters

string sessionKey
int serverId

Return Value

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

34.54. listDuplicatesByHostname
复制链接

Name

listDuplicatesByHostname

Description

List duplicate systems by Hostname.

Parameters

string sessionKey

Return Value

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

34.55. listDuplicatesByIp
复制链接

Name

listDuplicatesByIp

Description

List duplicate systems by IP Address.

Parameters

string sessionKey

Return Value

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

34.56. listDuplicatesByMac
复制链接

Name

listDuplicatesByMac

Description

List duplicate systems by Mac Address.

Parameters

string sessionKey

Return Value

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

34.57. listEligibleFlexGuests
复制链接

Name

listEligibleFlexGuests

Description

List eligible flex guests accessible to the user

Parameters

string sessionKey

Return Value

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

34.58. listExtraPackages
复制链接

Name

listExtraPackages

Description

List extra packages for a system

Parameters

string sessionKey
int serverId

Return Value

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

34.59. listFlexGuests
复制链接

Name

listFlexGuests

Description

List flex guests accessible to the user

Parameters

string sessionKey

Return Value

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

34.60. listGroups
复制链接

Name

listGroups

Description

List the available groups for a given system.

Parameters

string sessionKey
int serverId

Return Value

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

34.61. listInactiveSystems
复制链接

Name

listInactiveSystems

Description

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

Parameters

string sessionKey

Return Value

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

34.62. listInactiveSystems
复制链接

Name

listInactiveSystems

Description

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

Parameters

string sessionKey
int days

Return Value

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

34.63. listLatestAvailablePackage
复制链接

Name

listLatestAvailablePackage

Description

Get the latest available version of a package for each system

Parameters

string sessionKey
array:
- int - serverId
string packageName

Return Value

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

34.64. listLatestInstallablePackages
复制链接

Name

listLatestInstallablePackages

Description

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

Parameters

string sessionKey
int serverId

Return Value

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

34.65. listLatestUpgradablePackages
复制链接

Name

listLatestUpgradablePackages

Description

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

Parameters

string sessionKey
int serverId

Return Value

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

34.66. listNewerInstalledPackages
复制链接

Name

listNewerInstalledPackages

Description

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

Parameters

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

Return Value

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

34.67. listNotes
复制链接

Name

listNotes

Description

Provides a list of notes associated with a system.

Parameters

string sessionKey
int serverId

Return Value

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

34.68. listOlderInstalledPackages
复制链接

Name

listOlderInstalledPackages

Description

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

Parameters

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

Return Value

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

34.69. listOutOfDateSystems
复制链接

Name

listOutOfDateSystems

Description

Returns list of systems needing package updates.

Parameters

string sessionKey

Return Value

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

34.70. listPackageProfiles
复制链接

Name

listPackageProfiles

Description

List the package profiles in this organization

Parameters

string sessionKey

Return Value

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

34.71. listPackages
复制链接

Name

listPackages

Description

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

Parameters

string sessionKey
int serverId

Return Value

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

34.72. listPackagesFromChannel
复制链接

Name

listPackagesFromChannel

Description

Provides a list of packages installed on a system that are also contained in the given channel. The installed package list did not include arch information before RHEL 5, so it is arch unaware. RHEL 5 systems do upload the arch information, and thus are arch aware.

Parameters

string sessionKey
int serverId
string channelLabel

Return Value

array:
- struct - package
  - string name
  - string version
  - string release
  - string epoch
  - int id
  - string arch_label
  - string path - The path on that file system that the package resides
  - string provider - The provider of the package, determined by the gpg key it was signed with.
  - dateTime.iso8601 last_modified

34.73. listPhysicalSystems
复制链接

Name

listPhysicalSystems

Description

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

Parameters

string sessionKey

Return Value

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

34.74. listSubscribableBaseChannels
复制链接

Name

listSubscribableBaseChannels

Description

Returns a list of subscribable base channels.

Parameters

string sessionKey
int serverId

Return Value

array:
- struct - channel
  - int id - Base Channel ID.
  - string name - Name of channel.
  - string label - Label of Channel
  - int current_base - 1 indicates it is the current base channel

34.75. listSubscribableChildChannels
复制链接

Name

listSubscribableChildChannels

Description

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

Parameters

string sessionKey
int serverId

Return Value

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

34.76. listSubscribedChildChannels
复制链接

Name

listSubscribedChildChannels

Description

Returns a list of subscribed child channels.

Parameters

string sessionKey
int serverId

Return Value

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

34.77. listSuggestedReboot
复制链接

Name

listSuggestedReboot

Description

List systems that require reboot.

Parameters

string sessionKey

Return Value

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

34.78. listSystemEvents
复制链接

Name

listSystemEvents

Description

List system events of the specified type for given server. "actionType" should be exactly the string returned in the action_type field from the listSystemEvents(sessionKey, serverId) method. For example, 'Package Install' or 'Initiate a kickstart for a virtual guest.'

Available since: 10.8

Parameters

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

Return Value

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

34.79. listSystemEvents
复制链接

Name

listSystemEvents

Description

List all system events for given server. This includes *all* events for the server since it was registered. This may require the caller to filter the results to fetch the specific events they are looking for.

Available since: 10.8

Parameters

string sessionKey
int serverId - ID of system.

Return Value

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

34.80. listSystems
复制链接

Name

listSystems

Description

Returns a list of all servers visible to the user.

Parameters

string sessionKey

Return Value

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

34.81. listSystemsWithExtraPackages
复制链接

Name

listSystemsWithExtraPackages

Description

List systems with extra packages

Parameters

string sessionKey

Return Value

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

34.82. listSystemsWithPackage
复制链接

Name

listSystemsWithPackage

Description

Lists the systems that have the given installed package

Parameters

string sessionKey
int pid - the package id

Return Value

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

34.83. listSystemsWithPackage
复制链接

Name

listSystemsWithPackage

Description

Lists the systems that have the given installed package

Parameters

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

Return Value

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

34.84. listUngroupedSystems
复制链接

Name

listUngroupedSystems

Description

List systems that are not associated with any system groups.

Parameters

string sessionKey

Return Value

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

34.85. listUserSystems
复制链接

Name

listUserSystems

Description

List systems for a given user.

Parameters

string sessionKey
string login - User's login name.

Return Value

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

34.86. listUserSystems
复制链接

Name

listUserSystems

Description

List systems for the logged in user.

Parameters

string sessionKey

Return Value

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

34.87. listVirtualGuests
复制链接

Name

listVirtualGuests

Description

Lists the virtual guests for a given virtual host

Parameters

string sessionKey
int sid - the virtual host's id

Return Value

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

34.88. listVirtualHosts
复制链接

Name

listVirtualHosts

Description

Lists the virtual hosts visible to the user

Parameters

string sessionKey

Return Value

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

34.89. obtainReactivationKey
复制链接

Name

obtainReactivationKey

Description

Obtains a reactivation key for this server.

Parameters

string sessionKey
int serverId

Return Value

string

34.90. obtainReactivationKey
复制链接

Name

obtainReactivationKey

Description

Obtains a reactivation key for this server.

Available since: 10.10

Parameters

string systemid - systemid file

Return Value

string

34.91. provisionSystem
复制链接

Name

provisionSystem

Description

Provision a system using the specified kickstart profile.

Parameters

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

Return Value

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

34.92. provisionSystem
复制链接

Name

provisionSystem

Description

Provision a system using the specified kickstart profile.

Parameters

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

Return Value

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

34.93. provisionVirtualGuest
复制链接

Name

provisionVirtualGuest

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

34.94. provisionVirtualGuest
复制链接

Name

provisionVirtualGuest

Description

Provision a guest on the host specified. This schedules the guest for creation and will begin the provisioning process when the host checks in or if OSAD is enabled will begin immediately. Defaults to mac_address=random.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

34.95. provisionVirtualGuest
复制链接

Name

provisionVirtualGuest

Description

Provision a guest on the host specified. This schedules the guest for creation and will begin the provisioning process when the host checks in or if OSAD is enabled will begin immediately.

Parameters

string sessionKey
int serverId - ID of host to provision guest on.
string guestName
string profileName - Kickstart Profile to use.
int memoryMb - Memory to allocate to the guest
int vcpus - Number of virtual CPUs to allocate to the guest.
int storageGb - Size of the guests disk image.
string macAddress - macAddress to give the guest's virtual networking hardware.

Return Value

int - 1 on success, exception thrown otherwise.

34.96. removeEntitlements
复制链接

Name

removeEntitlements

Description

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

Parameters

string sessionKey
int serverId
array:
- string - entitlement_label

Return Value

int - 1 on success, exception thrown otherwise.

34.97. scheduleApplyErrata
复制链接

Name

scheduleApplyErrata

Description

Schedules an action to apply errata updates to multiple systems.

Available since: 13.0

Parameters

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

Return Value

array:
- int - actionId

34.98. scheduleApplyErrata
复制链接

Name

scheduleApplyErrata

Description

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

Available since: 13.0

Parameters

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

Return Value

array:
- int - actionId

34.99. scheduleApplyErrata
复制链接

Name

scheduleApplyErrata

Description

Schedules an action to apply errata updates to a system.

Available since: 13.0

Parameters

string sessionKey
int serverId
array:
- int - errataId

Return Value

array:
- int - actionId

34.100. scheduleApplyErrata
复制链接

Name

scheduleApplyErrata

Description

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

Available since: 13.0

Parameters

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

Return Value

array:
- int - actionId

34.101. scheduleCertificateUpdate
复制链接

Name

scheduleCertificateUpdate

Description

Schedule update of client certificate

Parameters

string sessionKey
int serverId

Return Value

int actionId - The action id of the scheduled action

34.102. scheduleCertificateUpdate
复制链接

Name

scheduleCertificateUpdate

Description

Schedule update of client certificate at given date and time

Parameters

string sessionKey
int serverId
dateTime.iso860 date

Return Value

int actionId - The action id of the scheduled action

34.103. scheduleGuestAction
复制链接

Name

scheduleGuestAction

Description

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

Parameters

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

Return Value

int actionId - The action id of the scheduled action

34.104. scheduleGuestAction
复制链接

Name

scheduleGuestAction

Description

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

Parameters

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

Return Value

int actionId - The action id of the scheduled action

34.105. scheduleHardwareRefresh
复制链接

Name

scheduleHardwareRefresh

Description

Schedule a hardware refresh for a system.

Available since: 13.0

Parameters

string sessionKey
int serverId
dateTime.iso8601 earliestOccurrence

Return Value

int actionId - The action id of the scheduled action

34.106. schedulePackageInstall
复制链接

Name

schedulePackageInstall

Description

Schedule package installation for several systems.

Parameters

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

Return Value

array:
- int - actionId

34.107. schedulePackageInstall
复制链接

Name

schedulePackageInstall

Description

Schedule package installation for a system.

Available since: 13.0

Parameters

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

Return Value

int actionId - The action id of the scheduled action

34.108. schedulePackageInstallByNevra
复制链接

Name

schedulePackageInstallByNevra

Description

Schedule package installation for several systems.

Parameters

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

Return Value

array:
- int - actionId

34.109. schedulePackageInstallByNevra
复制链接

Name

schedulePackageInstallByNevra

Description

Schedule package installation for a system.

Parameters

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

Return Value

int actionId - The action id of the scheduled action

34.110. schedulePackageRefresh
复制链接

Name

schedulePackageRefresh

Description

Schedule a package list refresh for a system.

Parameters

string sessionKey
int serverId
dateTime.iso8601 earliestOccurrence

Return Value

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

34.111. schedulePackageRemove
复制链接

Name

schedulePackageRemove

Description

Schedule package removal for several systems.

Parameters

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

Return Value

array:
- int - actionId

34.112. schedulePackageRemove
复制链接

Name

schedulePackageRemove

Description

Schedule package removal for a system.

Parameters

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

Return Value

int actionId - The action id of the scheduled action

34.113. schedulePackageRemoveByNevra
复制链接

Name

schedulePackageRemoveByNevra

Description

Schedule package removal for several systems.

Parameters

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

Return Value

array:
- int - actionId

34.114. schedulePackageRemoveByNevra
复制链接

Name

schedulePackageRemoveByNevra

Description

Schedule package removal for a system.

Parameters

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

Return Value

array:
- int - actionId

34.115. scheduleReboot
复制链接

Name

scheduleReboot

Description

Schedule a reboot for a system.

Available since: 13.0

Parameters

string sessionKey
int serverId
dateTime.iso860 earliestOccurrence

Return Value

int actionId - The action id of the scheduled action

34.116. scheduleScriptRun
复制链接

Name

scheduleScriptRun

Description

Schedule a script to run.

Parameters

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

Return Value

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

34.117. scheduleScriptRun
复制链接

Name

scheduleScriptRun

Description

Schedule a script to run.

Parameters

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

Return Value

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

34.118. scheduleScriptRun
复制链接

Name

scheduleScriptRun

Description

Schedule a script to run.

Parameters

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

Return Value

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

34.119. scheduleScriptRun
复制链接

Name

scheduleScriptRun

Description

Schedule a script to run.

Parameters

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

Return Value

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

34.120. scheduleSyncPackagesWithSystem
复制链接

Name

scheduleSyncPackagesWithSystem

Description

Sync packages from a source system to a target.

Available since: 13.0

Parameters

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

Return Value

int actionId - The action id of the scheduled action

34.121. searchByName
复制链接

Name

searchByName

Description

Returns a list of system IDs whose name matches the supplied regular expression(defined by Java representation of regular expressions)

Parameters

string sessionKey
string regexp - A regular expression

Return Value

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

34.122. sendOsaPing
复制链接

Name

sendOsaPing

Description

send a ping to a system using OSA

Parameters

string sessionKey
int serverId

Return Value

int - 1 on success, exception thrown otherwise.

34.123. setBaseChannel
复制链接

Name

setBaseChannel

Description

Assigns the server to a new baseChannel.

Deprecated - being replaced by system.setBaseChannel(string sessionKey, int serverId, string channelLabel)

Parameters

string sessionKey
int serverId
int channelId

Return Value

int - 1 on success, exception thrown otherwise.

34.124. setBaseChannel
复制链接

Name

setBaseChannel

Description

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

Parameters

string sessionKey
int serverId
string channelLabel

Return Value

int - 1 on success, exception thrown otherwise.

34.125. setChildChannels
复制链接

Name

setChildChannels

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

34.126. setCustomValues
复制链接

Name

setCustomValues

Description

Set custom values for the specified server.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

34.127. setDetails
复制链接

Name

setDetails

Description

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

Parameters

string sessionKey
int serverId - ID of server to lookup details for.
struct - server details
- string profile_name - System's profile name
- string base_entitlement - System's base entitlement label. (enterprise_entitled or 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

Return Value

int - 1 on success, exception thrown otherwise.

34.128. setGroupMembership
复制链接

Name

setGroupMembership

Description

Set a servers membership in a given group.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

34.129. setGuestCpus
复制链接

Name

setGuestCpus

Description

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

Parameters

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

Return Value

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

34.130. setGuestMemory
复制链接

Name

setGuestMemory

Description

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

Parameters

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

Return Value

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

34.131. setLockStatus
复制链接

Name

setLockStatus

Description

Set server lock status.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

34.132. setPrimaryInterface
复制链接

Name

setPrimaryInterface

Description

Sets new primary network interface

Parameters

string sessionKey
int serverId
string interfaceName

Return Value

int - 1 on success, exception thrown otherwise.

34.133. setProfileName
复制链接

Name

setProfileName

Description

Set the profile name for the server.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

34.134. setVariables
复制链接

Name

setVariables

Description

Sets a list of kickstart variables in the cobbler system record for the specified server. Note: This call assumes that a system record exists in cobbler for the given system and will raise an XMLRPC fault if that is not the case. To create a system record over xmlrpc use system.createSystemRecord To create a system record in the Web UI please go to System -> <Specified System> -> Provisioning -> Select a Kickstart profile -> Create Cobbler System Record.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

34.135. tagLatestSnapshot
复制链接

Name

tagLatestSnapshot

Description

Tags latest system snapshot

Parameters

string sessionKey
int serverId
string tagName

Return Value

int - 1 on success, exception thrown otherwise.

34.136. unentitle
复制链接

Name

unentitle

Description

Unentitle the system completely

Parameters

string systemid - systemid file

Return Value

int - 1 on success, exception thrown otherwise.

34.137. upgradeEntitlement
复制链接

Name

upgradeEntitlement

Description

Adds an entitlement to a given server.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

34.138. whoRegistered
复制链接

Name

whoRegistered

Description

Returns information about the user who registered the system

Parameters

string sessionKey
int sid - Id of the system in question

Return Value

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. system.config
复制链接

Abstract

Provides methods to access and modify many aspects of configuration channels and server association. basically system.config name space

35.1. addChannels
复制链接

Name

addChannels

Description

Given a list of servers and configuration channels, this method appends the configuration channels to either the top or the bottom (whichever you specify) of a system's subscribed configuration channels list. The ordering of the configuration channels provided in the add list is maintained while adding. If one of the configuration channels in the 'add' list has been previously subscribed by a server, the subscribed channel will be re-ranked to the appropriate place.

Parameters

string sessionKey
array:
- int - IDs of the systems to add the channels to.
array:
- string - List of configuration channel labels in the ranked order.
boolean addToTop
- true - to prepend the given channels list to the top of the configuration channels list of a server
- false - to append the given channels list to the bottom of the configuration channels list of a server

Return Value

int - 1 on success, exception thrown otherwise.

35.2. createOrUpdatePath
复制链接

Name

createOrUpdatePath

Description

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

Available since: 10.2

Parameters

string sessionKey
int serverId
string path - the configuration file/directory path
boolean isDir
- True - if the path is a directory
- False - if the path is a file
struct - path info
- string contents - Contents of the file (text or base64 encoded if binary) ((only for non-directories)
- boolean contents_enc64 - Identifies base64 encoded content (default: disabled, only for non-directories).
- string owner - Owner of the file/directory.
- string group - Group name of the file/directory.
- string permissions - Octal file/directory permissions (eg: 644)
- string 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

Return Value

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

35.3. createOrUpdateSymlink
复制链接

Name

createOrUpdateSymlink

Description

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

Available since: 10.2

Parameters

string sessionKey
int serverId
string path - the configuration file/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

Return Value

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

35.4. deleteFiles
复制链接

Name

deleteFiles

Description

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

Parameters

string sessionKey
int serverId
array:
- string - paths to remove.
boolean deleteFromLocal
- True - to delete configuration file paths from the system's local override configuration channel
- False - to delete configuration file paths from the system's sandbox configuration channel

Return Value

int - 1 on success, exception thrown otherwise.

35.5. deployAll
复制链接

Name

deployAll

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

35.6. listChannels
复制链接

Name

listChannels

Description

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

Parameters

string sessionKey
int serverId

Return Value

array:
- struct - Configuration Channel information
  - int id
  - int orgId
  - string label
  - string name
  - string description
  - struct configChannelType
  - struct - Configuration Channel Type information
    int id
    string label
    string name
    int priority

35.7. listFiles
复制链接

Name

listFiles

Description

Return the list of files in a given channel.

Parameters

string sessionKey
int serverId
int listLocal
- 1 - to return configuration files in the system's local override configuration channel
- 0 - to return configuration files in the system's sandbox configuration channel

Return Value

array:
- struct - Configuration File information
  - string type
  - file
    directory
    symlink
  - string path - File Path
  - string channel_label - the label of the central configuration channel that has this file. Note this entry only shows up if the file has not been overridden by a central channel.
  - struct channel_type
  - struct - Configuration Channel Type information
    int id
    string label
    string name
    int priority
  - dateTime.iso8601 last_modified - Last Modified Date

35.8. lookupFileInfo
复制链接

Name

lookupFileInfo

Description

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

Available since: 10.2

Parameters

string sessionKey
int serverId
array:
- string - paths to lookup on.
int searchLocal
- 1 - to search configuration file paths in the system's local override configuration or systems subscribed central channels
- 0 - to search configuration file paths in the system's sandbox configuration channel

Return Value

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

35.9. removeChannels
复制链接

Name

removeChannels

Description

Remove config channels from the given servers.

Parameters

string sessionKey
array:
- int - the IDs of the systems from which you would like to remove configuration channels..
array:
- string - List of configuration channel labels to remove.

Return Value

int - 1 on success, exception thrown otherwise.

35.10. setChannels
复制链接

Name

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

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

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 36. system.crash
复制链接

Abstract

Provides methods to access and modify software crash information.

36.1. createCrashNote
复制链接

Name

createCrashNote

Description

Create a crash note

Parameters

string sessionKey
int crashId
string subject
string details

Return Value

int - 1 on success, exception thrown otherwise.

36.2. deleteCrash
复制链接

Name

deleteCrash

Description

Delete a crash with given crash id.

Parameters

string sessionKey
int crashId

Return Value

int - 1 on success, exception thrown otherwise.

36.3. deleteCrashNote
复制链接

Name

deleteCrashNote

Description

Delete a crash note

Parameters

string sessionKey
int crashNoteId

Return Value

int - 1 on success, exception thrown otherwise.

36.4. getCrashCountInfo
复制链接

Name

getCrashCountInfo

Description

Return date of last software crashes report for given system

Parameters

string sessionKey
int serverId

Return Value

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. getCrashFile
复制链接

Name

getCrashFile

Description

Download a crash file.

Parameters

string sessionKey
int crashFileId

Return Value

base64 - base64 encoded crash file.

36.6. getCrashFileUrl
复制链接

Name

getCrashFileUrl

Description

Get a crash file download url.

Parameters

string sessionKey
int crashFileId

Return Value

string - The crash file download url

36.7. getCrashNotesForCrash
复制链接

Name

getCrashNotesForCrash

Description

List crash notes for crash

Parameters

string sessionKey
int crashId

Return Value

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

36.8. getCrashOverview
复制链接

Name

getCrashOverview

Description

Get Software Crash Overview

Parameters

string sessionKey

Return Value

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. getCrashesByUuid
复制链接

Name

getCrashesByUuid

Description

List software crashes with given UUID

Parameters

string sessionKey
string uuid

Return Value

array:
- struct - crash
  - int server_id - ID of the server the crash occurred on
  - string server_name - Name of the server the crash occurred on
  - int crash_id - ID of the crash with given UUID
  - int crash_count - Number of times the crash with given UUID occurred
  - string crash_component - Crash component
  - dateTime.iso8601 last_report - Last crash occurence

36.10. listSystemCrashFiles
复制链接

Name

listSystemCrashFiles

Description

Return list of crash files for given crash id.

Parameters

string sessionKey
int crashId

Return Value

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

36.11. listSystemCrashes
复制链接

Name

listSystemCrashes

Description

Return list of software crashes for a system.

Parameters

string sessionKey
int serverId

Return Value

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. system.custominfo
复制链接

Abstract

Provides methods to access and modify custom system information.

37.1. createKey
复制链接

Name

createKey

Description

Create a new custom key

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

37.2. deleteKey
复制链接

Name

deleteKey

Description

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

Parameters

string sessionKey
string keyLabel - new key's label

Return Value

int - 1 on success, exception thrown otherwise.

37.3. listAllKeys
复制链接

Name

listAllKeys

Description

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

Parameters

string sessionKey

Return Value

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

37.4. updateKey
复制链接

Name

updateKey

Description

Update description of a custom key

Parameters

string sessionKey
string keyLabel - key to change
string keyDescription - new key's description

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 38. system.provisioning.snapshot
复制链接

Abstract

Provides methods to access and delete system snapshots.

38.1. addTagToSnapshot
复制链接

Name

addTagToSnapshot

Description

Adds tag to snapshot

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

38.2. deleteSnapshot
复制链接

Name

deleteSnapshot

Description

Deletes a snapshot with the given snapshot id

Available since: 10.1

Parameters

string sessionKey
int snapshotId - Id of snapshot to delete

Return Value

int - 1 on success, exception thrown otherwise.

38.3. deleteSnapshots
复制链接

Name

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

Available since: 10.1

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

38.4. deleteSnapshots
复制链接

Name

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

Available since: 10.1

Parameters

string sessionKey
int sid - system id of system to delete snapshots for
struct - date details
- dateTime.iso8601 startDate - Optional, unless endDate is provided.
- dateTime.iso8601 endDate - Optional.

Return Value

int - 1 on success, exception thrown otherwise.

38.5. listSnapshotConfigFiles
复制链接

Name

listSnapshotConfigFiles

Description

List the config files associated with a snapshot.

Available since: 10.2

Parameters

string sessionKey
int snapId

Return Value

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

38.6. listSnapshotPackages
复制链接

Name

listSnapshotPackages

Description

List the packages associated with a snapshot.

Available since: 10.1

Parameters

string sessionKey
int snapId

Return Value

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

38.7. listSnapshots
复制链接

Name

listSnapshots

Description

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

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

Available since: 10.1

Parameters

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

Return Value

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).

38.8. rollbackToSnapshot
复制链接

Name

rollbackToSnapshot

Description

Rollbacks server to snapshot

Parameters

string sessionKey
int serverId
int snapshotId - Id of the snapshot

Return Value

int - 1 on success, exception thrown otherwise.

38.9. rollbackToTag
复制链接

Name

rollbackToTag

Description

Rollbacks server to snapshot

Parameters

string sessionKey
int serverId
string tagName - Name of the snapshot tag

Return Value

int - 1 on success, exception thrown otherwise.

38.10. rollbackToTag
复制链接

Name

rollbackToTag

Description

Rollbacks server to snapshot

Parameters

string sessionKey
string tagName - Name of the snapshot tag

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 39. system.scap
复制链接

Abstract

Provides methods to schedule SCAP scans and access the results.

39.1. deleteXccdfScan
复制链接

Name

deleteXccdfScan

Description

Delete OpenSCAP XCCDF Scan from Spacewalk database. Note that only those SCAP Scans can be deleted which have passed their retention period.

Parameters

string sessionKey
int Id of XCCDF scan (xid).

Return Value

boolean - indicates success of the operation.

39.2. getXccdfScanDetails
复制链接

Name

getXccdfScanDetails

Description

Get details of given OpenSCAP XCCDF scan.

Parameters

string sessionKey
int Id of XCCDF scan (xid).

Return Value

struct - OpenSCAP XCCDF Scan
- int xid - XCCDF TestResult id
- int sid - serverId
- int action_id - Id of the parent action.
- string path - Path to XCCDF document
- string oscap_parameters - oscap command-line arguments.
- string test_result - Identifier of XCCDF TestResult.
- string benchmark - Identifier of XCCDF Benchmark.
- string benchmark_version - Version of the Benchmark.
- string profile - Identifier of XCCDF Profile.
- string profile_title - Title of XCCDF Profile.
- dateTime.iso8601 start_time - Client machine time of scan start.
- dateTime.iso8601 end_time - Client machine time of scan completion.
- string errors - Stderr output of scan.
- bool deletable - Indicates whether the scan can be deleted.

39.3. getXccdfScanRuleResults
复制链接

Name

getXccdfScanRuleResults

Description

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

Parameters

string sessionKey
int Id of XCCDF scan (xid).

Return Value

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. listXccdfScans
复制链接

Name

listXccdfScans

Description

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

Parameters

string sessionKey
int serverId

Return Value

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. scheduleXccdfScan
复制链接

Name

scheduleXccdfScan

Description

Schedule OpenSCAP scan.

Parameters

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

Return Value

int - ID if SCAP action created.

39.6. scheduleXccdfScan
复制链接

Name

scheduleXccdfScan

Description

Schedule OpenSCAP scan.

Parameters

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

Return Value

int - ID if SCAP action created.

39.7. scheduleXccdfScan
复制链接

Name

scheduleXccdfScan

Description

Schedule Scap XCCDF scan.

Parameters

string sessionKey
int serverId
string Path to xccdf content on targeted system.
string Additional parameters for oscap tool.

Return Value

int - ID of the scap action created.

39.8. scheduleXccdfScan
复制链接

Name

scheduleXccdfScan

Description

Schedule Scap XCCDF scan.

Parameters

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

Return Value

int - ID of the scap action created.

Chapter 40. system.search
复制链接

Abstract

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

40.1. deviceDescription
复制链接

Name

deviceDescription

Description

List the systems which match the device description.

Parameters

string sessionKey
string searchTerm

Return Value

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server successfully checked in
  - string hostname
  - string ip
  - string hw_description - hw description if not null
  - string hw_device_id - hw device id if not null
  - string hw_vendor_id - hw vendor id if not null
  - string hw_driver - hw driver if not null

40.2. deviceDriver
复制链接

Name

deviceDriver

Description

List the systems which match this device driver.

Parameters

string sessionKey
string searchTerm

Return Value

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server successfully checked in
  - string hostname
  - string ip
  - string hw_description - hw description if not null
  - string hw_device_id - hw device id if not null
  - string hw_vendor_id - hw vendor id if not null
  - string hw_driver - hw driver if not null

40.3. deviceId
复制链接

Name

deviceId

Description

List the systems which match this device id

Parameters

string sessionKey
string searchTerm

Return Value

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server successfully checked in
  - string hostname
  - string ip
  - string hw_description - hw description if not null
  - string hw_device_id - hw device id if not null
  - string hw_vendor_id - hw vendor id if not null
  - string hw_driver - hw driver if not null

40.4. deviceVendorId
复制链接

Name

deviceVendorId

Description

List the systems which match this device vendor_id

Parameters

string sessionKey
string searchTerm

Return Value

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server successfully checked in
  - string hostname
  - string ip
  - string hw_description - hw description if not null
  - string hw_device_id - hw device id if not null
  - string hw_vendor_id - hw vendor id if not null
  - string hw_driver - hw driver if not null

40.5. hostname
复制链接

Name

hostname

Description

List the systems which match this hostname

Parameters

string sessionKey
string searchTerm

Return Value

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server successfully checked in
  - string hostname
  - string ip
  - string hw_description - hw description if not null
  - string hw_device_id - hw device id if not null
  - string hw_vendor_id - hw vendor id if not null
  - string hw_driver - hw driver if not null

40.6. ip
复制链接

Name

Description

List the systems which match this ip.

Parameters

string sessionKey
string searchTerm

Return Value

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server successfully checked in
  - string hostname
  - string ip
  - string hw_description - hw description if not null
  - string hw_device_id - hw device id if not null
  - string hw_vendor_id - hw vendor id if not null
  - string hw_driver - hw driver if not null

40.7. nameAndDescription
复制链接

Name

nameAndDescription

Description

List the systems which match this name or description

Parameters

string sessionKey
string searchTerm

Return Value

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server successfully checked in
  - string hostname
  - string ip
  - string hw_description - hw description if not null
  - string hw_device_id - hw device id if not null
  - string hw_vendor_id - hw vendor id if not null
  - string hw_driver - hw driver if not null

40.8. uuid
复制链接

Name

uuid

Description

List the systems which match this UUID

Parameters

string sessionKey
string searchTerm

Return Value

array:
- struct - system
  - int id
  - string name
  - dateTime.iso8601 last_checkin - Last time server successfully checked in
  - string hostname
  - string ip
  - string hw_description - hw description if not null
  - string hw_device_id - hw device id if not null
  - string hw_vendor_id - hw vendor id if not null
  - string hw_driver - hw driver if not null

Chapter 41. systemgroup
复制链接

Abstract

Provides methods to access and modify system groups.

41.1. addOrRemoveAdmins
复制链接

Name

addOrRemoveAdmins

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

41.2. addOrRemoveSystems
复制链接

Name

addOrRemoveSystems

Description

Add/remove the given servers to a system group.

Parameters

string sessionKey
string systemGroupName
array:
- int - serverId
boolean add - True to add to the group, False to remove.

Return Value

int - 1 on success, exception thrown otherwise.

41.3. create
复制链接

Name

create

Description

Create a new system group.

Parameters

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

Return Value

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

41.4. delete
复制链接

Name

delete

Description

Delete a system group.

Parameters

string sessionKey
string systemGroupName

Return Value

int - 1 on success, exception thrown otherwise.

41.5. getDetails
复制链接

Name

getDetails

Description

Retrieve details of a ServerGroup based on it's id

Parameters

string sessionKey
int systemGroupId

Return Value

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

41.6. getDetails
复制链接

Name

getDetails

Description

Retrieve details of a ServerGroup based on it's name

Parameters

string sessionKey
string systemGroupName

Return Value

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

41.7. listActiveSystemsInGroup
复制链接

Name

listActiveSystemsInGroup

Description

Lists active systems within a server group

Parameters

string sessionKey
string systemGroupName

Return Value

array:
- int - server_id

41.8. listAdministrators
复制链接

Name

listAdministrators

Description

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

Parameters

string sessionKey
string systemGroupName

Return Value

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

41.9. listAllGroups
复制链接

Name

listAllGroups

Description

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

Parameters

string sessionKey

Return Value

array:
- struct - Server Group
  - int id
  - string name
  - string description
  - int org_id
  - int system_count

41.10. listGroupsWithNoAssociatedAdmins
复制链接

Name

listGroupsWithNoAssociatedAdmins

Description

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

Parameters

string sessionKey

Return Value

array:
- struct - Server Group
  - int id
  - string name
  - string description
  - int org_id
  - int system_count

41.11. listInactiveSystemsInGroup
复制链接

Name

listInactiveSystemsInGroup

Description

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

Parameters

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

Return Value

array:
- int - server_id

41.12. listInactiveSystemsInGroup
复制链接

Name

listInactiveSystemsInGroup

Description

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

Parameters

string sessionKey
string systemGroupName

Return Value

array:
- int - server_id

41.13. listSystems
复制链接

Name

listSystems

Description

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

Parameters

string sessionKey
string systemGroupName

Return Value

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

41.14. listSystemsMinimal
复制链接

Name

listSystemsMinimal

Description

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

Parameters

string sessionKey
string systemGroupName

Return Value

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

41.15. scheduleApplyErrataToActive
复制链接

Name

scheduleApplyErrataToActive

Description

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

Available since: 13.0

Parameters

string sessionKey
string systemGroupName
array:
- int - errataId

Return Value

array:
- int - actionId

41.16. scheduleApplyErrataToActive
复制链接

Name

scheduleApplyErrataToActive

Description

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

Available since: 13.0

Parameters

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

Return Value

array:
- int - actionId

41.17. update
复制链接

Name

update

Description

Update an existing system group.

Parameters

string sessionKey
string systemGroupName
string description

Return Value

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

Chapter 42. user.external
复制链接

Abstract

If you are using IPA integration to allow authentication of users from an external IPA server (rare) the users will still need to be created in the Satellite database. Methods in this namespace allow you to configure some specifics of how this happens, like what organization they are created in or what roles they will have. These options can also be set in the web admin interface.

42.1. createExternalGroupToRoleMap
复制链接

Name

createExternalGroupToRoleMap

Description

Externally authenticated users may be members of external groups. You can use these groups to assign additional roles to the users when they log in. Can only be called by a satellite_admin.

Parameters

string sessionKey
string name - Name of the external group. Must be unique.
array:
- string - role - Can be any of: satellite_admin, org_admin (implies all other roles except for satellite_admin), channel_admin, config_admin, system_group_admin, or activation_key_admin.

Return Value

struct - externalGroup
- string name
- array roles
  - string - role

42.2. createExternalGroupToSystemGroupMap
复制链接

Name

createExternalGroupToSystemGroupMap

Description

Externally authenticated users may be members of external groups. You can use these groups to give access to server groups to the users when they log in. Can only be called by an org_admin.

Parameters

string sessionKey
string name - Name of the external group. Must be unique.
array:
- string - groupName - The names of the server groups to grant access to.

Return Value

struct - externalGroup
- string name
- array roles
  - string - role

42.3. deleteExternalGroupToRoleMap
复制链接

Name

deleteExternalGroupToRoleMap

Description

Delete the role map for an external group. Can only be called by a satellite_admin.

Parameters

string sessionKey
string name - Name of the external group.

Return Value

int - 1 on success, exception thrown otherwise.

42.4. deleteExternalGroupToSystemGroupMap
复制链接

Name

deleteExternalGroupToSystemGroupMap

Description

Delete the server group map for an external group. Can only be called by an org_admin.

Parameters

string sessionKey
string name - Name of the external group.

Return Value

int - 1 on success, exception thrown otherwise.

42.5. getDefaultOrg
复制链接

Name

getDefaultOrg

Description

Get the default org that users should be added in if orgunit from IPA server isn't found or is disabled. Can only be called by a satellite_admin.

Parameters

string sessionKey

Return Value

int - Id of the default organization. 0 if there is no default.

42.6. getExternalGroupToRoleMap
复制链接

Name

getExternalGroupToRoleMap

Description

Get a representation of the role mapping for an external group. Can only be called by a satellite_admin.

Parameters

string sessionKey
string name - Name of the external group.

Return Value

struct - externalGroup
- string name
- array roles
  - string - role

42.7. getExternalGroupToSystemGroupMap
复制链接

Name

getExternalGroupToSystemGroupMap

Description

Get a representation of the server group mapping for an external group. Can only be called by an org_admin.

Parameters

string sessionKey
string name - Name of the external group.

Return Value

struct - externalGroup
- string name
- array roles
  - string - role

42.8. getKeepTemporaryRoles
复制链接

Name

getKeepTemporaryRoles

Description

Get whether we should keeps roles assigned to users because of their IPA groups even after they log in through a non-IPA method. Can only be called by a satellite_admin.

Parameters

string sessionKey

Return Value

boolean - True if we should keep roles after users log in through non-IPA method, false otherwise.

42.9. getUseOrgUnit
复制链接

Name

getUseOrgUnit

Description

Get whether we place users into the organization that corresponds to the "orgunit" set on the IPA server. The orgunit name must match exactly the Satellite organization name. Can only be called by a satellite_admin.

Parameters

string sessionKey

Return Value

boolean - True if we should use the IPA orgunit to determine which organization to create the user in, false otherwise.

42.10. listExternalGroupToRoleMaps
复制链接

Name

listExternalGroupToRoleMaps

Description

List role mappings for all known external groups. Can only be called by a satellite_admin.

Parameters

string sessionKey

Return Value

array:
- struct - externalGroup
  - string name
  - array roles
    string - role

42.11. listExternalGroupToSystemGroupMaps
复制链接

Name

listExternalGroupToSystemGroupMaps

Description

List server group mappings for all known external groups. Can only be called by an org_admin.

Parameters

string sessionKey

Return Value

array:
- struct - externalGroup
  - string name
  - array roles
    string - role

42.12. setDefaultOrg
复制链接

Name

setDefaultOrg

Description

Set the default org that users should be added in if orgunit from IPA server isn't found or is disabled. Can only be called by a satellite_admin.

Parameters

string sessionKey
int defaultOrg - Id of the organization to set as the default org. 0 if there should not be a default organization.

Return Value

int - 1 on success, exception thrown otherwise.

42.13. setExternalGroupRoles
复制链接

Name

setExternalGroupRoles

Description

Update the roles for an external group. Replace previously set roles with the ones passed in here. Can only be called by a satellite_admin.

Parameters

string sessionKey
string name - Name of the external group.
array:
- string - role - Can be any of: satellite_admin, org_admin (implies all other roles except for satellite_admin), channel_admin, config_admin, system_group_admin, or activation_key_admin.

Return Value

int - 1 on success, exception thrown otherwise.

42.14. setExternalGroupSystemGroups
复制链接

Name

setExternalGroupSystemGroups

Description

Update the server groups for an external group. Replace previously set server groups with the ones passed in here. Can only be called by an org_admin.

Parameters

string sessionKey
string name - Name of the external group.
array:
- string - groupName - The names of the server groups to grant access to.

Return Value

int - 1 on success, exception thrown otherwise.

42.15. setKeepTemporaryRoles
复制链接

Name

setKeepTemporaryRoles

Description

Set whether we should keeps roles assigned to users because of their IPA groups even after they log in through a non-IPA method. Can only be called by a satellite_admin.

Parameters

string sessionKey
boolean keepRoles - True if we should keep roles after users log in through non-IPA method, false otherwise.

Return Value

int - 1 on success, exception thrown otherwise.

42.16. setUseOrgUnit
复制链接

Name

setUseOrgUnit

Description

Set whether we place users into the organization that corresponds to the "orgunit" set on the IPA server. The orgunit name must match exactly the Satellite organization name. Can only be called by a satellite_admin.

Parameters

string sessionKey
boolean useOrgUnit - True if we should use the IPA orgunit to determine which organization to create the user in, false otherwise.

Return Value

int - 1 on success, exception thrown otherwise.

Chapter 43. user
复制链接

Abstract

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

43.1. addAssignedSystemGroup
复制链接

Name

addAssignedSystemGroup

Description

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

Parameters

string sessionKey
string login - User's login name.
string serverGroupName
boolean setDefault - Should system group also be added to user's list of default system groups.

Return Value

int - 1 on success, exception thrown otherwise.

43.2. addAssignedSystemGroups
复制链接

Name

addAssignedSystemGroups

Description

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

Parameters

string sessionKey
string login - User's login name.
array:
- string - serverGroupName
boolean setDefault - Should system groups also be added to user's list of default system groups.

Return Value

int - 1 on success, exception thrown otherwise.

43.3. addDefaultSystemGroup
复制链接

Name

addDefaultSystemGroup

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

43.4. addDefaultSystemGroups
复制链接

Name

addDefaultSystemGroups

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

43.5. addRole
复制链接

Name

addRole

Description

Adds a role to a user.

Parameters

string sessionKey
string login - User login name to update.
string role - Role label to add. Can be any of: satellite_admin, org_admin, channel_admin, config_admin, system_group_admin, or activation_key_admin.

Return Value

int - 1 on success, exception thrown otherwise.

43.6. create
复制链接

Name

create

Description

Create a new user.

Parameters

string sessionKey
string desiredLogin - Desired login name, will fail if already in use.
string desiredPassword
string firstName
string lastName
string email - User's e-mail address.

Return Value

int - 1 on success, exception thrown otherwise.

43.7. create
复制链接

Name

create

Description

Create a new user.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

43.8. delete
复制链接

Name

delete

Description

Delete a user.

Parameters

string sessionKey
string login - User login name to delete.

Return Value

int - 1 on success, exception thrown otherwise.

43.9. disable
复制链接

Name

disable

Description

Disable a user.

Parameters

string sessionKey
string login - User login name to disable.

Return Value

int - 1 on success, exception thrown otherwise.

43.10. enable
复制链接

Name

enable

Description

Enable a user.

Parameters

string sessionKey
string login - User login name to enable.

Return Value

int - 1 on success, exception thrown otherwise.

43.11. getCreateDefaultSystemGroup
复制链接

Name

getCreateDefaultSystemGroup

Description

Returns the current value of the CreateDefaultSystemGroup setting. If True this will cause there to be a system group created (with the same name as the user) every time a new user is created, with the user automatically given permission to that system group and the system group being set as the default group for the user (so every time the user registers a system it will be placed in that system group by default). This can be useful if different users will administer different groups of servers in the same organization. Can only be called by an org_admin.

Parameters

string sessionKey

Return Value

int - 1 on success, exception thrown otherwise.

43.12. getDetails
复制链接

Name

getDetails

Description

Returns the details about a given user.

Parameters

string sessionKey
string login - User's login name.

Return Value

struct - user details
- string first_names - deprecated, use first_name
- string first_name
- string last_name
- string email
- int org_id
- string org_name
- string prefix
- string last_login_date
- string created_date
- boolean enabled - true if user is enabled, false if the user is disabled
- boolean use_pam - true if user is configured to use PAM authentication
- boolean read_only - true if user is readonly
- boolean errata_notification - true if errata e-mail notification is enabled for the user

43.13. getLoggedInTime
复制链接

Name

getLoggedInTime

Description

Returns the time user last logged in.

Deprecated - Never returned usable value.

Parameters

string sessionKey
string login - User's login name.

Return Value

dateTime.iso8601

43.14. listAssignableRoles
复制链接

Name

listAssignableRoles

Description

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

Parameters

string sessionKey

Return Value

array:
- string - (role label)

43.15. listAssignedSystemGroups
复制链接

Name

listAssignedSystemGroups

Description

Returns the system groups that a user can administer.

Parameters

string sessionKey
string login - User's login name.

Return Value

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

43.16. listDefaultSystemGroups
复制链接

Name

listDefaultSystemGroups

Description

Returns a user's list of default system groups.

Parameters

string sessionKey
string login - User's login name.

Return Value

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

43.17. listRoles
复制链接

Name

listRoles

Description

Returns a list of the user's roles.

Parameters

string sessionKey
string login - User's login name.

Return Value

array:
- string - (role label)

43.18. listUsers
复制链接

Name

listUsers

Description

Returns a list of users in your organization.

Parameters

string sessionKey

Return Value

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

43.19. removeAssignedSystemGroup
复制链接

Name

removeAssignedSystemGroup

Description

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

Parameters

string sessionKey
string login - User's login name.
string serverGroupName
boolean setDefault - Should system group also be removed from the user's list of default system groups.

Return Value

int - 1 on success, exception thrown otherwise.

43.20. removeAssignedSystemGroups
复制链接

Name

removeAssignedSystemGroups

Description

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

Parameters

string sessionKey
string login - User's login name.
array:
- string - serverGroupName
boolean setDefault - Should system groups also be removed from the user's list of default system groups.

Return Value

int - 1 on success, exception thrown otherwise.

43.21. removeDefaultSystemGroup
复制链接

Name

removeDefaultSystemGroup

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

43.22. removeDefaultSystemGroups
复制链接

Name

removeDefaultSystemGroups

Description

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

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

43.23. removeRole
复制链接

Name

removeRole

Description

Remove a role from a user.

Parameters

string sessionKey
string login - User login name to update.
string role - Role label to remove. Can be any of: satellite_admin, org_admin, channel_admin, config_admin, system_group_admin, or activation_key_admin.

Return Value

int - 1 on success, exception thrown otherwise.

43.24. setCreateDefaultSystemGroup
复制链接

Name

setCreateDefaultSystemGroup

Description

Sets the value of the CreateDefaultSystemGroup setting. If True this will cause there to be a system group created (with the same name as the user) every time a new user is created, with the user automatically given permission to that system group and the system group being set as the default group for the user (so every time the user registers a system it will be placed in that system group by default). This can be useful if different users will administer different groups of servers in the same organization. Can only be called by an org_admin.

Parameters

string sessionKey
boolean createDefaultSystemGruop - True if we should automatically create system groups, false otherwise.

Return Value

int - 1 on success, exception thrown otherwise.

43.25. setDetails
复制链接

Name

setDetails

Description

Updates the details of a user.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

43.26. setErrataNotifications
复制链接

Name

setErrataNotifications

Description

Enables/disables errata mail notifications for a specific user.

Parameters

string sessionKey
string login - User's login name.
boolean value - True for enabling errata notifications, False for disabling

Return Value

int - 1 on success, exception thrown otherwise.

43.27. setReadOnly
复制链接

Name

setReadOnly

Description

Sets whether the target user should have only read-only API access or standard full scale access.

Parameters

string sessionKey
string login - User's login name.
boolean readOnly - Sets whether the target user should have only read-only API access or standard full scale access.

Return Value

int - 1 on success, exception thrown otherwise.

43.28. usePamAuthentication
复制链接

Name

usePamAuthentication

Description

Toggles whether or not a user uses PAM authentication or basic Satellite authentication.

Parameters

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

Return Value

int - 1 on success, exception thrown otherwise.

Appendix A. Revision History
复制链接

Revision History

Revision 1.1-0

Wed Feb 1 2017

Satellite Documentation Team

Initial revision for the Red Hat Satellite 5.8 release.

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.

返回顶部

此内容没有您所选择的语言版本。

API Guide

A reference guide to the Red Hat Satellite API

Red Hat Satellite Documentation Team

Chapter 1. Introduction to Red Hat Satellite复制链接链接已复制到粘贴板!

1.1. The Red Hat Satellite API复制链接链接已复制到粘贴板!

1.2. Using XML-RPC with the Red Hat Satellite API复制链接链接已复制到粘贴板!

1.3. Using the Read-only API复制链接链接已复制到粘贴板!

1.3.1. Creating a Read-only User复制链接链接已复制到粘贴板!

Chapter 2. Examples复制链接链接已复制到粘贴板!

2.1. Python Examples复制链接链接已复制到粘贴板!

2.2. Perl Example复制链接链接已复制到粘贴板!

2.3. Ruby Example复制链接链接已复制到粘贴板!

Part I. Methods复制链接链接已复制到粘贴板!

Chapter 3. actionchain复制链接链接已复制到粘贴板!

3.1. addConfigurationDeployment复制链接链接已复制到粘贴板!

3.2. addErrataUpdate复制链接链接已复制到粘贴板!

3.3. addPackageInstall复制链接链接已复制到粘贴板!

3.4. addPackageRemoval复制链接链接已复制到粘贴板!

3.5. addPackageUpgrade复制链接链接已复制到粘贴板!

3.6. addPackageVerify复制链接链接已复制到粘贴板!

3.7. addScriptRun复制链接链接已复制到粘贴板!

3.8. addSystemReboot复制链接链接已复制到粘贴板!

3.9. createChain复制链接链接已复制到粘贴板!

3.10. deleteChain复制链接链接已复制到粘贴板!

3.11. listChainActions复制链接链接已复制到粘贴板!

3.12. listChains复制链接链接已复制到粘贴板!

3.13. removeAction复制链接链接已复制到粘贴板!

3.14. renameChain复制链接链接已复制到粘贴板!

3.15. scheduleChain复制链接链接已复制到粘贴板!

Chapter 4. activationkey复制链接链接已复制到粘贴板!

4.1. addChildChannels复制链接链接已复制到粘贴板!

4.2. addConfigChannels复制链接链接已复制到粘贴板!

4.3. addEntitlements复制链接链接已复制到粘贴板!

4.4. addPackageNames复制链接链接已复制到粘贴板!

4.5. addPackages复制链接链接已复制到粘贴板!

4.6. addServerGroups复制链接链接已复制到粘贴板!

4.7. checkConfigDeployment复制链接链接已复制到粘贴板!

4.8. clone复制链接链接已复制到粘贴板!

4.9. create复制链接链接已复制到粘贴板!

4.10. create复制链接链接已复制到粘贴板!

4.11. delete复制链接链接已复制到粘贴板!

4.12. disableConfigDeployment复制链接链接已复制到粘贴板!

4.13. enableConfigDeployment复制链接链接已复制到粘贴板!

4.14. getDetails复制链接链接已复制到粘贴板!

4.15. listActivatedSystems复制链接链接已复制到粘贴板!

4.16. listActivationKeys复制链接链接已复制到粘贴板!

4.17. listConfigChannels复制链接链接已复制到粘贴板!

4.18. removeChildChannels复制链接链接已复制到粘贴板!

4.19. removeConfigChannels复制链接链接已复制到粘贴板!

4.20. removeEntitlements复制链接链接已复制到粘贴板!

4.21. removePackageNames复制链接链接已复制到粘贴板!

4.22. removePackages复制链接链接已复制到粘贴板!

4.23. removeServerGroups复制链接链接已复制到粘贴板!

4.24. setConfigChannels复制链接链接已复制到粘贴板!

4.25. setDetails复制链接链接已复制到粘贴板!

Chapter 5. api复制链接链接已复制到粘贴板!

5.1. getApiCallList复制链接链接已复制到粘贴板!

5.2. getApiNamespaceCallList复制链接链接已复制到粘贴板!

5.3. getApiNamespaces复制链接链接已复制到粘贴板!

5.4. getVersion复制链接链接已复制到粘贴板!

5.5. systemVersion复制链接链接已复制到粘贴板!

Chapter 6. auth复制链接链接已复制到粘贴板!

6.1. login复制链接链接已复制到粘贴板!

6.2. login复制链接链接已复制到粘贴板!

6.3. logout复制链接链接已复制到粘贴板!

Chapter 7. channel复制链接链接已复制到粘贴板!

7.1. listAllChannels复制链接链接已复制到粘贴板!

7.2. listManageableChannels复制链接链接已复制到粘贴板!

7.3. listMyChannels复制链接链接已复制到粘贴板!

7.4. listPopularChannels复制链接链接已复制到粘贴板!

7.5. listRedHatChannels复制链接链接已复制到粘贴板!

7.6. listRetiredChannels复制链接链接已复制到粘贴板!

7.7. listSharedChannels复制链接链接已复制到粘贴板!

7.8. listSoftwareChannels复制链接链接已复制到粘贴板!

7.9. listVendorChannels复制链接链接已复制到粘贴板!

Chapter 8. channel.access复制链接链接已复制到粘贴板!

8.1. disableUserRestrictions复制链接链接已复制到粘贴板!

8.2. enableUserRestrictions复制链接链接已复制到粘贴板!

8.3. getOrgSharing复制链接链接已复制到粘贴板!

Chapter 1. Introduction to Red Hat Satellite
复制链接

1.1. The Red Hat Satellite API
复制链接

1.2. Using XML-RPC with the Red Hat Satellite API
复制链接

1.3. Using the Read-only API
复制链接

1.3.1. Creating a Read-only User
复制链接

Chapter 2. Examples
复制链接

2.1. Python Examples
复制链接

2.2. Perl Example
复制链接

2.3. Ruby Example
复制链接

Part I. Methods
复制链接

Chapter 3. actionchain
复制链接

3.1. addConfigurationDeployment
复制链接

3.2. addErrataUpdate
复制链接

3.3. addPackageInstall
复制链接

3.4. addPackageRemoval
复制链接

3.5. addPackageUpgrade
复制链接

3.6. addPackageVerify
复制链接

3.7. addScriptRun
复制链接

3.8. addSystemReboot
复制链接

3.9. createChain
复制链接

3.10. deleteChain
复制链接

3.11. listChainActions
复制链接

3.12. listChains
复制链接

3.13. removeAction
复制链接

3.14. renameChain
复制链接

3.15. scheduleChain
复制链接

Chapter 4. activationkey
复制链接

4.1. addChildChannels
复制链接

4.2. addConfigChannels
复制链接

4.3. addEntitlements
复制链接

4.4. addPackageNames
复制链接

4.5. addPackages
复制链接

4.6. addServerGroups
复制链接

4.7. checkConfigDeployment
复制链接

4.8. clone
复制链接

4.9. create
复制链接

4.10. create
复制链接

4.11. delete
复制链接

4.12. disableConfigDeployment
复制链接

4.13. enableConfigDeployment
复制链接

4.14. getDetails
复制链接

4.15. listActivatedSystems
复制链接

4.16. listActivationKeys
复制链接

4.17. listConfigChannels
复制链接

4.18. removeChildChannels
复制链接

4.19. removeConfigChannels
复制链接

4.20. removeEntitlements
复制链接

4.21. removePackageNames
复制链接

4.22. removePackages
复制链接

4.23. removeServerGroups
复制链接

4.24. setConfigChannels
复制链接

4.25. setDetails
复制链接

Chapter 5. api
复制链接

5.1. getApiCallList
复制链接

5.2. getApiNamespaceCallList
复制链接

5.3. getApiNamespaces
复制链接

5.4. getVersion
复制链接

5.5. systemVersion
复制链接

Chapter 6. auth
复制链接

6.1. login
复制链接

6.2. login
复制链接

6.3. logout
复制链接

Chapter 7. channel
复制链接

7.1. listAllChannels
复制链接

7.2. listManageableChannels
复制链接

7.3. listMyChannels
复制链接

7.4. listPopularChannels
复制链接

7.5. listRedHatChannels
复制链接

7.6. listRetiredChannels
复制链接

7.7. listSharedChannels
复制链接

7.8. listSoftwareChannels
复制链接

7.9. listVendorChannels
复制链接

Chapter 8. channel.access
复制链接

8.1. disableUserRestrictions
复制链接

8.2. enableUserRestrictions
复制链接

8.3. getOrgSharing
复制链接

8.4. setOrgSharing
复制链接

Chapter 9. channel.org
复制链接

9.1. disableAccess
复制链接

9.2. enableAccess
复制链接