Contains methods to access common activation key functions available from the web interface.
Description: Add child channels to an activation key.
Returns:
int - 1 on success, exception thrown otherwise.
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.
string sessionKey
order.
the activation key’s config channel list
activation key’s config channel list
Description: Add entitlements to an activation key. Currently only add-on entitlements are permitted. (monitoring_entitled, provisioning_entitled,
virtualization_host, virtualization_host_platform)
string sessionKey
string key
Returns:
- int - 1 on success, exception thrown otherwise.
Description: - Add packages to an activation key.
string sessionKey
string key
Returns:
- int - 1 on success, exception thrown otherwise.
string sessionKey string key array:
int - serverGroupId
Returns:
int - 1 on success, exception thrown otherwise.
Returns:
- 1 if enabled, 0 if disabled, exception thrown otherwise.
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”.
string sessionKey
string key - Leave empty to have new key autogenerated.
string description
string baseChannelLabel - Leave empty to accept default.
boolean universalDefault
Description: Delete an activation key.
Returns:
- int - 1 on success, exception thrown otherwise.
Description: Disable configuration file deployment for the specified activation key.
Description: Enable configuration file deployment for the specified activation key.
Description: Lookup an activation key’s details.
Parameters:
- string sessionKey
- string key
Returns:
- 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”
Description: List the systems activated with the key provided.
Parameters: string sessionKey string key
Description: List activation keys that are visible to the user.
string “key”
string “description”
int “usage_limit”
string “base_channel_label”
boolean “universal_default”
boolean “disabled”
Description: List configuration channels associated to an activation key.
array:
int “id”
int “orgId”
string “label”
string “name”
string “description”
struct “configChannelType”
Description: Remove child channels from an activation key.
string sessionKey
string key
= string - childChannelLabel
Description: Remove configuration channels from the given activation keys.
string sessionKey
Returns: - int - 1 on success, exception thrown otherwise.
Description: Remove entitlements (by label) from an activation key. Currently only add-on entitlements are permitted.
- monitoring_entitled,
- provisioning_entitled,
- virualization_host,
- virtualization_host_platform
string sessionKey
string key
-string - entitlement label - monitoring_entitled - provisioning_entitled - virtualization_host - virtualization_host_platform
Description: Remove package names from an activation key.
string key
Description: Remove server groups from an activation key.
string sessionKey
string key
Description: Replace the existing set of configuration channels on the given activation keys. Channels are ranked by their order in the array.
string sessionKey
Description: Update the details of an activation key. Parameters:
string sessionKey
string key
- struct - activation key
- string “description” - optional
- string “base_channel_label” - optional
- int “usage_limit” - optional
- boolean “unlimited_usage_limit” - Set true for unlimited usage and to override usage_limit
- boolean “universal_default” - optional
- boolean “disabled” - optional
Methods providing information about the API.
Available methods:
Description: Lists all available api calls grouped by namespace
Parameters:
- string sessionKey
Returns:
- struct - method_info
- string “name” - method name
- string “parameters” - method parameters
- string “exceptions” - method exceptions
- string “return” - method return type
Description: Lists all available api calls for the specified namespace
Parameters:
- string sessionKey
- string namespace
Returns:
- struct - method_info
- string “name” - method name
- string “parameters” - method parameters
- string “exceptions” - method exceptions
- string “return” - method return type
Description: Lists available API namespaces
Parameters:
- string sessionKey
Returns:
- struct - namespace
- string “namespace” - API namespace
- string “handler” - API Handler
Parameters:
Description: Returns the server version.
Parameters:
Returns:
- string
Provides method to get back a list of Software Channels.
Available methods:
Description: List all software channels that belong to the user’s organization.
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.
Description: List all software channels that may be shared by the user’s organization.
Returns:
- array:
- struct - channel info
- int “id”
- string “label”
- string “name”
- string “provider_name”
- int “packages”
- int “systems”
- string “arch_name”
Description: List all software channels that the user’s organization is entitled to.
Provides methods to retrieve and alter channel access restrictions.
‘private’, or ‘protected’.
sw session
string channelLabel - label of the channel
or ‘protected’
Description: Enable access to the channel for the given organization.
Description: List the organizations associated with the given channel that may be trusted.
Provides methods to access and modify many aspects of a channel.
sw session
string channelLabel - target channel.
string sessionKey
string original_label
boolean original_state
Returns:
- int the cloned channel ID
string sessionKey
string label - label of the new channel
string name - name of the new channel
string summary - summary of the channel
corresponds to
channel-ia32 - For 32 bit channel architecture
channel-ia64 - For 64 bit channel architecture
channel-sparc - For Sparc channel architecture
channel-alpha - For Alpha channel architecture
channel-s390 - For s390 channel architecture
channel-s390x - For s390x channel architecture
channel-iSeries - For i-Series channel architecture
channel-pSeries - For p-Series channel architecture
channel-x86_64 - For x86_64 channel architecture
channel-ppc - For PPC channel architecture
architecture
channel-i386-sun-solaris - For i386 Solaris channel architecture
string if it does not have one
repository metadata generation
sha1 - Offers widest compatibility with clients
newer clients: Fedora 11 and newer, or Enterprise Linux 6 and newer.
Returns:
Description: Disassociates a repository from a channel
struct - channel
int “id”
string “name”
string “label”
string “arch_name”
string “summary”
string “description”
string “checksum_label”
dateTime.iso8601 “last_modified”
string “maintainer_name”
string “maintainer_email”
string “maintainer_phone”
string “support_policy”
string “gpg_key_url”
string “gpg_key_id”
string “gpg_key_fp”
dateTime.iso8601 “yumrepo_last_sync” - (optional)
string “end_of_life”
string “parent_channel_label”
string “clone_original”
Description: Returns the last build date of the repomd.xml file for the given channel as a localised string.
Returns:
the last build date of the repomd.xml file as a localised string
Description: Returns details of the given channel as a map
int “id”
string “name”
string “label”
string “arch_name”
string “summary”
string “description”
string “checksum_label”
dateTime.iso8601 “last_modified”
string “maintainer_name”
string “maintainer_email”
string “maintainer_phone”
string “support_policy”
string “gpg_key_url”
string “gpg_key_id”
string “gpg_key_fp”
dateTime.iso8601 “yumrepo_last_sync” - (optional)
string “end_of_life”
string “parent_channel_label”
string “clone_original”
Description: Returns details of the given repository
Description: Returns repo synchronization cron expression
Parameters:
- string sessionKey
- string channelLabel - channel label
Parameters:
- string sessionKey
- string channelLabel - channel to query
Description: Returns whether the channel may be managed by the given user.
Description: Returns whether the channel may be subscribed to by the given user.
Description: If start and end are giving:
Lists all packages in the channel, regardless of package version, between the given dates.
Description: Lists the potential software channel architectures that can be created
Description: Lists associated repos with the given channel
Description: List the children of a channel
Parameters: string sessionKey string channelLabel - the label of the channel
int “id”
string “name”
string “label”
string “arch_name”
string “summary”
string “description”
string “checksum_label”
dateTime.iso8601 “last_modified”
string “maintainer_name”
string “maintainer_email”
string “maintainer_phone”
string “support_policy”
string “gpg_key_url”
string “gpg_key_id”
string “gpg_key_fp”
dateTime.iso8601 “yumrepo_last_sync” - (optional)
string “end_of_life”
string “parent_channel_label”
string “clone_original”
Description: List the errata applicable to a channel between startDate and endDate.
int “id” - Errata ID.
string “date” - Date erratum was created.
string “update_date” - Date erratum was updated.
string “advisory_synopsis” - Summary of the erratum.
Bug Fix
string “advisory_name” - Name such as RHSA, etc
Description: List the errata of a specific type that are applicable to a channel
string sessionKey
string channelLabel - channel to query
‘Security Advisory’, ‘Product Enhancement Advisory’, ‘Bug Fix Advisory’
string “advisory” - name of the advisory
YYYY-MM-DD HH24:MI:SS
YYYY-MM-DD HH24:MI:SS
string “synopsis”
string “advisory_type”
YYYY-MM-DD HH24:MI:SS
Description: Lists the packages with the latest version (including release and epoch) for the given channel
Description: Lists all packages that are not associated with a channel. Typically these are custom packages.
string “name”
string “version”
string “release”
string “epoch”
int “id”
string “arch_label”
package resides
determined by the gpg key it was signed with.
dateTime.iso8601 “last_modified”
Description: Lists the filters for a repo
Description: Returns list of subscribed systems for the given channel label
Description: Returns a list of channels that a system is subscribed to for the given system id
Description: Returns a list of ContentSource (repos) that the user can see
Parameters: string sessionKey
Description: Merges all errata from one channel into another
Description: Merges all packages from one channel into another
string sessionKey
packages from
string mergeToLabel - the label to push the packages into
string “name”
string “version”
string “release”
string “epoch”
int “id”
string “arch_label”
the package resides
by the gpg key it was signed with.
dateTime.iso8601 “last_modified”
Description: Completely clear and regenerate the needed Errata and Package cache or 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.
Returns:
- int - 1 on success, exception thrown otherwise.
Description: Regenerate yum cache for the specified channel.
Description: Removes a given list of packages from the given channel.
string sessionKey
string channelLabel - target channel.
Description: Removes a repository
Description: Set contact/support information for given channel.
Description: Allows to modify channel attributes
string sessionKey
int channelDd - channel id
(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)
string sessionKey
string channelLabel - label of the channel
globally subscribable. False otherwise.
Description: Returns a list of ContentSource (repos) that the user can see
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.
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.
Provides methods to access and modify many aspects of configuration channels.
Description: Check for the existence of the config channel provided.
Description: Create a new global config channel. Caller must be at least a config admin or an organization admin.
int “id”
int “orgId”
string “label”
string “name”
string “description”
struct “configChannelType”
Description: Create a new file or directory with the given path, or update an existing path.
string sessionKey
string configChannelLabel
string path
boolean isDir
string “contents” - Contents of the file
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)
delimiter. Use null or empty string to accept the default. (only for non-directories)
Use null or empty string to accept the default. (only for non-directories)
int “revision” - next revision number, auto increment for null
base64 encoded content is expected (only for non-directories)
struct - Configuration Revision information
string “path” - File Path
string “target_path” - Symbolic link Target File Path.
string “channel” - Channel Name
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.
string “group” - File Group.
files or directories only.
or directories only.
string “selinux_ctx” - SELinux Context (optional).
boolean “binary” - true/false , Present for files only.
string “md5” - File’s md5 signature. Present for files only.
config file.
Description: Create a new symbolic link with the given path, or update an existing path
string sessionKey
string configChannelLabel
string path
string “target_path” - The target path for the symbolic link
string “selinux_ctx” - SELinux Security context (optional)
for automatic revision number assignment
string “path” - File Path
string “target_path” - Symbolic link Target File Path.
string “channel” - Channel Name
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.
string “group” - File Group.
int “permissions” - File Permissions (Deprecated).
string “permissions_mode” - File Permissions.
string “selinux_ctx” - SELinux Context (optional).
boolean “binary” - true/false , Present for files only.
string “md5” - File’s md5 signature. Present for files only.
a config file.
file. Present for text files only.
Description: Delete a list of global config channels. Caller must be a config admin.
string sessionKey
Description: Delete specified revisions of a given configuration file
string sessionKey
string channelLabel - Label of config channel to lookup on.
string filePath - Configuration file path.
string sessionKey
string channelLabel - Channel to remove the files from.
Description: Schedule an immediate configuration deployment for all systems subscribed to a particular configuration channel.
Description: Lookup config channel details.
struct - Configuration Channel information
int “id”
int “orgId”
string “label”
string “name”
string “description”
struct “configChannelType”
Description: Get revision of the specified config file
string “path” - File Path
string “target_path” - Symbolic link Target File Path.
string “channel” - Channel Name
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.
string “group” - File Group.
or directories only.
or directories only.
string “selinux_ctx” - SELinux Context (optional).
boolean “binary” - true/false , Present for files only.
string “md5” - File’s md5 signature. Present for files only.
Present for text files only.
Present for text files only.
Description: Get revision of the specified config file
string “path” - File Path
string “target_path” - Symbolic link Target File Path.
string “channel” - Channel Name
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.
string “group” - File Group.
int “permissions” - File Permissions (Deprecated).
string “permissions_mode” - File Permissions.
string “selinux_ctx” - SELinux Context (optional).
boolean “binary” - true/false , Present for files only.
string “md5” - File’s md5 signature. Present for files only.
a config file.
a config file.
Description: Get list of revisions for specified config file
string “path” - File Path
string “target_path” - Symbolic link Target File Path.
string “channel” - Channel Name
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.
string “group” - File Group.
int “permissions” - File Permissions (Deprecated).
string “permissions_mode” - File Permissions.
string “selinux_ctx” - SELinux Context (optional).
boolean “binary” - true/false , Present for files only.
string “md5” - File’s md5 signature. Present for files only.
file.
string “macro-end-delimiter” - Macro end delimiter for a config file
Description: Return a list of files in a channel.
string “path” - File Path
dateTime.iso8601 “last_modified” - Last Modified Date
Description: List all the global config channels accessible to the logged-in user.
int “id”
int “orgId”
string “label”
string “name”
string “description”
string “type”
struct “configChannelType”
Description: Return a list of systems subscribed to a configuration channel
Description: Lists details on a list channels given their channel labels.
string sessionKey
int “id”
int “orgId”
string “label”
string “name”
string “description”
struct “configChannelType”
Description: Given a list of paths and a channel, returns details about the latest revisions of the paths.
string sessionKey
string channelLabel - label of config channel to lookup on
string “path” - File Path
string “target_path” - Symbolic link Target File Path.
string “channel” - Channel Name
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.
string “group” - File Group.
int “permissions” - File Permissions (Deprecated).
string “permissions_mode” - File Permissions.
string “selinux_ctx” - SELinux Context (optional).
boolean “binary” - true/false , Present for files only.
string “md5” - File’s md5 signature. Present for files only.
config file.
config file.
Description: Schedule a comparison of the latest revision of a file against the version deployed on a list of systems.
string sessionKey
string channelLabel - Label of config channel
string path - File path
performed on
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.
int “id”
int “orgId”
string “label”
string “name”
string “description”
struct “configChannelType”
Provides methods to access and modify distribution channel information.
Available methods:
Description: Lists the default distribution channel maps
Description: Lists distribution channel maps valid for an organization, satellite admin right needed Parameters: string sessionKey int orgId Returns:
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
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 Returns:
int - 1 on success, exception thrown otherwise.
Provides methods to access and modify distribution channel information.
Available methods:
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.
string sessionKey
string advisoryName
Returns:
int - representing the number of packages added, exception otherwise
Description: Returns a list of channels applicable to the erratum with the given advisory name.
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”
Description: Clone a list of errata into the specified channel.
string sessionKey
string channel_label
Description: Clones a list of errata into a specified cloned channel according the original erratas.
string sessionKey
string channel_label
Description: Asynchronously clones a list of errata into a specified cloned channel according the original erratas
string sessionKey
string channel_label
Description: Asynchronously clone a list of errata into the specified channel.
string sessionKey
string channel_label
Description: Create a custom errata. If “publish” is set to true, the errata will be published as well
string sessionKey
string “synopsis”
string “advisory_name”
int “advisory_release”
‘Security Advisory’, ‘Product Enhancement Advisory’, or ‘Bug Fix Advisory’
string “product”
string “errataFrom”
string “topic”
string “description”
string “references”
string “notes”
string “solution”
boolean publish - Should the errata be published.
published too, ignored if publish is set to false
Description: Delete an erratum. This method will only allow for deletion of custom errata created either through the UI or API.
Description: Lookup the details for errata associated with the given CVE (e.g. CVE-2008-3270)
Description: Retrieves the details for the erratum matching the given advisory name.
string “issue_date”
string “update_date”
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”
Description: Return the list of systems affected by the erratum with advisory name.
int “id”
string “name”
successfully checked in
Description: Returns a list of CVEs applicable to the erratum with the given advisory name.
Description: Get the keywords associated with an erratum matching the given advisory name.
Description: Returns a list of the packages affected by the erratum with the given advisory name.
int “id”
string “name”
string “epoch”
string “version”
string “release”
string “arch_label”
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”
Description: Returns a list of unpublished errata
Description: Publish an existing (unpublished) errata to a set of channels.
string sessionKey
string advisoryName
Description: Publishes an existing (unpublished) cloned errata to a set of cloned channels according to its original erratum
string sessionKey
string advisoryName
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.
string sessionKey
string advisoryName
otherwise
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.
string sessionKey
string advisoryName
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”
errata.
Provides methods to access and modify distribution channel information.
Available methods:
Description: Clone a Kickstart Profile
Returns: int - 1 on success, exception thrown otherwise.
Description: Import a kickstart profile into RHN.
string sessionKey
string profileLabel - Label for the new kickstart profile.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
associate the new profile with.
used to construct the default download URL for the new kickstart profile.
string rootPassword - Root password.
Returns: int - 1 on success, exception thrown otherwise.
Description: Import a kickstart profile into RHN.
string sessionKey
string profileLabel - Label for the new kickstart profile.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
associate the new profile with.
tree’s default URL.
string rootPassword - Root password.
Returns: int - 1 on success, exception thrown otherwise.
Description: Delete a kickstart profile
string sessionKey
remove
Description: Enable/Disable a Kickstart Profile
string sessionKey
en/disable
string disabled - true to disable the profile
Description: Find an associated kickstart for a given ip address.
Description: Import a kickstart profile into RHN.
string sessionKey
string profileLabel - Label for the new kickstart profile.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
associate the new profile with.
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.
import.
Description: Import a raw kickstart file into satellite.
string sessionKey
string profileLabel - Label for the new kickstart profile.
string virtualizationType - none, para_host, qemu, xenfv or xenpv.
associate the new profile with.
import.
Description: Returns whether a kickstart profile is disabled
Description: List all Ip Ranges and their associated kickstarts available in the user’s org.
range
string “max” - The max ip of the range
string “min” - The min ip of the range
Description: List kickstartable channels for the logged in user.
int “id”
string “name”
string “label”
string “arch_name”
string “summary”
string “description”
string “checksum_label”
dateTime.iso8601 “last_modified”
string “maintainer_name”
string “maintainer_email”
string “maintainer_phone”
string “support_policy”
string “gpg_key_url”
string “gpg_key_id”
string “gpg_key_fp”
dateTime.iso8601 “yumrepo_last_sync” - (optional)
string “end_of_life”
string “parent_channel_label”
string “clone_original”
Description: Provides a list of kickstart profiles visible to the user’s org
array:
Description: Rename a Kickstart Profile in Satellite
string sessionKey
rename
string newLabel - new label to change to
Provides methods to retrieve and manipulate kickstart file preservation lists.
Available methods:
Description: Create a new file preservation list.
string session_key
string name - name of the file list to create
Description: Delete a file preservation list.
Description: Returns all of the data associated with the given file preservation list.
string “name”
Description: List all file preservation lists for the organization associated with the user logged into the given session
Provides methods to manipulate kickstart keys.
Available methods:
Description: creates a new key with the given parameters
Description: deletes the key identified by the given parameters
Description: returns all of the data associated with the given key
Description: list all keys for the org associated with the user logged into the given session
Description: Updates type and content of the key identified by the description
Provides methods to access and modify many aspects of a kickstart profile.
Available methods:
Description: Add an ip range to a kickstart profile.
string sessionKey
string label - The label of the kickstart
(i.e. 192.168.0.1)
(i.e. 192.168.0.254)
Description: Add a pre/post script to a kickstart profile.
string sessionKey
string ksLabel - The kickstart label to add the script to.
string contents - The full script to add.
(i.e. /bin/bash). An empty string will use the kickstart default interpreter.
string type - The type of script (either ‘pre’ or ‘post’).
location (recommended) or not.
boolean template - Enable templating using cobbler.
Description: Returns a list for each kickstart profile; each list will contain activation keys not present on the other profile.
profile is the key into the struct
string “key”
string “description”
int “usage_limit”
string “base_channel_label”
boolean “universal_default”
boolean “disabled”
profile is the key into the struct
string “key”
string “description”
int “usage_limit”
string “base_channel_label”
boolean “universal_default”
boolean “disabled”
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 .
profile is the key into the struct
profile is the key into the struct
Description: Returns a list for each kickstart profile; each list will contain package names not present on the other profile.
profile is the key into the struct
profile is the key into the struct
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
Returns: string - The contents of the kickstart file.
Description: Downloads the Cobbler-rendered Kickstart file.
Description: Get advanced options for a kickstart profile.
Parameters: string sessionKey string kslabel - Label of kickstart profile to be changed.
Description: Get ks.cfg preservation option for a kickstart profile.
copied to /root, false means that it will not.
Description: Get the child channels for a kickstart profile.
Description: Get custom options for a kickstart profile.
Description: Get the kickstart tree for a kickstart profile.
Description: Returns a list of variables associated with the specified kickstart profile
Description: List all ip ranges for a kickstart profile.
range
string “max” - The max ip of the range
string “min” - The min ip of the range
Description: List the pre and post scripts for a kickstart profile. profile
int “id”
string “contents”
string “script_type” - Which type of script (‘pre’ or ‘post’).
for this script. An empty string indicates the default kickstart shell.
chroot environment.
boolean “template” - True if templating using cobbler is enabled
Description: Remove an ip range from a kickstart profile.
string sessionKey
remove
you are wanting to remove. The min or max of the range will work.
specified kickstart, exception otherwise.
Description: Remove a script from a kickstart profile.
Description: Set advanced options for a kickstart profile. Parameters:
string sessionKey
string kslabel
- options - 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
string “arguments” - Arguments of the option
Description: Set ks.cfg preservation option for a kickstart profile.
Description: Set the child channels for a kickstart profile.
Description: Set custom options for a kickstart profile.
Description: Set the kickstart tree for a kickstart profile.
Description: Set logging options for a kickstart profile.
string sessionKey
string kslabel - Label of kickstart profile to be changed.
to /root/ks-pre.log
kickstart to /root/ks-post.log
Description: Associates list of kickstart variables with the specified kickstart profile
string sessionKey
string kslabel
Returns: int - 1 on success, exception thrown otherwise.
Provides methods to access and modify the list of activation keys associated with a kickstart profile.
Available methods:
Description: Add an activation key association to the kickstart profile
Description: Lookup the activation keys associated with the kickstart profile.
string “key”
string “description”
int “usage_limit”
string “base_channel_label”
boolean “universal_default”
boolean “disabled”
Description: Remove an activation key association from the kickstart profile
Provides methods to access and modify the list of activation keys associated with a kickstart profile.
Available methods:
Description: Append the list of software packages to a kickstart profile. Duplicate packages will be ignored.
string sessionKey
string ksLabel - The label of a kickstart profile.
to the profile.
Description: Get a list of a kickstart profile’s software packages.
Returns:
- string[] - Get a list of a kickstart profile’s software packages.
Description: Set the list of software packages for a kickstart profile.
string sessionKey
string ksLabel - The label of a kickstart profile.
profile.
Provides methods to set various properties of a kickstart profile.
Available methods:
Description: Adds the given list of file preservations to the specified kickstart profile.
string sessionKey
string kickstartLabel
Returns: int - 1 on success, exception thrown otherwise.
Description: Adds the given list of keys to the specified kickstart profile.
string sessionKey
string kickstartLabel
Description: Check the configuration management status for a kickstart profile.
otherwise, false
Description: Check the remote commands status flag for a kickstart profile.
otherwise, false
Description: Disables the configuration management flag in a kickstart profile so that a system created using this profile will be NOT be configuration capable.
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
Description: Enables the configuration management flag in a kickstart profile so that a system created using this profile will be configuration capable.
Returns: int - 1 on success, exception thrown otherwise.
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
Description: Retrieves the locale for a kickstart profile.
string “locale”
Description: Get the partitioning scheme for a kickstart profile.
partitions, logical volumes and volume groups.
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.
none
Description: Retrieves the SELinux enforcing mode property of a kickstart profile.
Parameters: string sessionKey string kslabel - the kickstart profile label
Description: Returns the set of all file preservations associated with the given kickstart profile.
string “name”
Description: Returns the set of all keys associated with the given kickstart profile.
Description: Removes the given list of file preservations from the specified kickstart profile.
string sessionKey
string kslabel
Description: Removes the given list of keys from the specified kickstart profile.
string sessionKey
string kslabel
Description: Sets the locale for a kickstart profile.
string sessionKey
string kslabel - the kickstart profile label
string locale - the locale
true - the hardware clock uses UTC false - the hardware clock does not use UTC
Description: Set the partitioning scheme for a kickstart profile.
string sessionKey
string kslabel - The label of the kickstart profile to update.
command strings used to setup the partitions, volume groups and logical volumes.
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.
string sessionKey
string kslabel
that to register the system when reprovisioning a system.
reregister the system being reprovisioned as new
a duplicate on a reprovision.
Returns: int - 1 on success, exception thrown otherwise.
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.
string sessionKey
string kslabel - the kickstart profile label
Provides methods to create kickstart files
Available methods:
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.
string “name”
string “contents”
that will generate this snippet.
snippet.
Description: Delete the specified snippet. If the snippet is not found, 0 is returned.
Parameters: string sessionKey
string “name”
string “contents”
that will generate this snippet.
snippet.
Description: List only custom snippets for the logged in user. These snipppets are editable.
string “name”
string “contents”
that will generate this snippet.
snippet.
Description: List only pre-made default snippets for the logged in user. These snipppets are not editable.
Parameters: - string sessionKey
string “name”
string “contents”
file that will generate this snippet.
snippet.
Provides methods to access and modify the kickstart trees.
Available methods:
Description: Create a Kickstart Tree (Distribution) in Satellite.
string sessionKey
string treeLabel - The new kickstart tree label.
string basePath - Path to the base or root of the kickstart tree.
kickstart tree.
(rhel_2.1, rhel_3, rhel_4, rhel_5, fedora_9).
Description: Delete a Kickstart Tree (Distribution) in Satellite.
Description: Delete a kickstarttree and any profiles associated with this kickstart tree. WARNING: This will delete all profiles associated with this kickstart tree!
Description: The detailed information about a kickstartable tree given the tree name.
int “id”
string “label”
string “abs_path”
int “channel_id”
Description: List the available kickstartable trees for the given channel.
Description: List the available kickstartable install types (rhel2,3,4,5 and fedora9+).
Description: Rename a Kickstart Tree (Distribution) in Satellite.
Description: Edit a Kickstart Tree (Distribution) in Satellite.
string sessionKey
string treelabel - Label for the kickstart tree.
string basepath - Path to the base or root of the kickstart tree.
tree.
(rhel_2.1, rhel_3, rhel_4, rhel_5, fedora_9).
Returns: int - 1 on success, exception thrown otherwise.
Contains methods to access common organization management functions available from the web interface.
Description: Create a new organization and associated administrator account.
string sessionkey
web UI.
string adminLogin - New administrator login name.
string adminPassword - New administrator password.
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.
the new administrator account.
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.
organization. (optional)
organization. (optional)
organization. (optional)
in the organization. (optional)
Description: Delete an organization. The default organization (i.e. orgId=1) cannot be deleted.
Description: The detailed information about an organization given the organization ID.
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.
organization. (optional)
organization. (optional)
organization. (optional)
in the organization. (optional)
Description: Returns the list of organizations.
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.
organization. (optional)
organization. (optional)
organization. (optional)
in the organization. (optional)
Description: List software entitlement allocation information across all organizations. Caller must be a satellite administrator.
Description: List an organization’s allocation of each software entitlement. A value of -1 indicates unlimited entitlements.
Description: Lists system entitlement allocation information across all organizations. Caller must be a satellite administrator.
Description: List an organization’s allocation of each system entitlement.
Description: Returns the list of users in a given organization.
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.
string sessionKey
migrated to.
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.
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.
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.
string sessionKey
int orgid
int allocation
Returns: int - 1 on success, exception thrown otherwise.
Description: Updates the name of an organization
string sessionkey
int orgid
web UI.
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)
Contains methods to access common organization management functions available from the web interface.
Description: Add an organization to the list of trusted organizations.
Description: The trust details about an organization given the organization’s ID.
dateTime.iso8601 “created” - Date the organization was created
defined as trusted
organization.
organization.
organization.
organization.
Description: Lists all software channels that the organization given may consume from the user’s organization.
Description: Lists all software channels that the organization given is providing to the user’s organization.
Description: List all organanizations trusted by the user’s organization.
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.
Description: Returns the list of trusted organizations.
Description: Remove an organization to the list of trusted organizations.
Methods to retrieve information about the Packages contained within this server.
Description: Lookup the details for packages with the given name, version, release, architecture label, and (optionally) epoch.
string sw
string name
string version
string release
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 arch_label
string “name”
string “version”
string “release”
string “epoch”
int “id”
string “arch_label”
package resides
determined by the gpg key it was signed with.
dateTime.iso8601 “last_modified”
Description: Retrieve details for the package with the ID.
int “id”
string “name”
string “epoch”
string “version”
string “release”
string “arch_label”
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”
package resides.
string “payload_size”
Description: Retrieve the package file associated with a package.
Description: List the change log for a package.
Description: List the dependencies for a package.
Description: List the files associated with a package.
Description: List the channels that provide the a package.
Description: List the errata providing the a package.
Description: Remove a package from the satellite.
Methods to interface to package search capabilities in search server.
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.
Description: List all Package Providers. User executing the request must be a Satellite administrator.
string “name”
Description: List all security keys associated with a package provider. User executing the request must be a Satellite administrator.
Methods to interface to package search capabilities in search server.
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"
string sessionKey
QueryParser Syntax
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"
string sessionKey
QueryParser Syntax
string actkey - activation key to look for packages in
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"
string sessionKey
QueryParser Syntax
string channelLabel - Channel Label
Description: Search the lucene package indexes for all packages which match the given name.
Parameters: string sessionKey string name - package name to search for
Description: Search the lucene package indexes for all packages which match the given query in name or description
Description: Search the lucene package indexes for all packages which match the given query in name or summary.
Provides methods to access and modify user locale information
Description: Returns a list of all understood locales. Can be used as input to setLocale.
Parameters:
Returns: array: string - Locale code.
Description: Returns a list of all understood timezones. Results can be used as input to setTimeZone.
Parameters:
int “time_zone_id” - Unique identifier for timezone.
database.
Description: Set a user’s locale.
Description: Set a user’s timezone.
Provides methods to activate/deactivate a proxy server.
Description: Activates the proxy identified by the given client certificate i.e. systemid file.
Description: Create Monitoring Scout for proxy.
Available since: 10.7
Description: Deactivates the proxy identified by the given client certificate i.e. systemid file.
Parameters: string systemid - systemid file
Returns: int - 1 on success, exception thrown otherwise.
Description: Test, if the system identified by the given client certificate i.e. systemid file, is proxy.
Description: List available version of proxy channel for system identified by the given client certificate i.e. systemid file.
Available since: 10.5
Provides methods to obtain details on the Satellite.
Description: Retrieves the certificate expiration date of the activated certificate.
Description: Indicates if monitoring is enabled on the satellite
Description: Indicates if monitoring is enabled on the satellite
Description: Lists all channel and system entitlements for the organization associated with the user executing the request.
Description: List the proxies within the user’s organization.
int “id”
string “name”
successfully checked in
Methods to retrieve information about scheduled actions.
Description: Archive all actions in the given list.
session object
Description: Cancel all actions in given list. If an invalid action is provided, none of the actions given will canceled.
session object
Description: Delete all archived actions in the given list.
session object
Description: Returns a list of all actions. This includes completed, in progress, failed and archived actions.
Parameters: session object
int “id” - Action Id. string “name” - Action name. string “type” - Action type. string “scheduler” - The user that scheduled the action.
(optional)
int “failedSystems” - Number of systems that failed the action. int “inProgressSystems” - Number of systems that are in
progress.
Description: Returns a list of actions that have been archived.
int “id” - Action Id. string “name” - Action name. string “type” - Action type. string “scheduler” - The user that scheduled the action.
(optional)
action will be performed
action.
int “failedSystems” - Number of systems that failed the action. int “inProgressSystems” - Number of systems that are in
progress.
Description: Returns a list of actions that have completed successfully.
int “id” - Action Id.
string “name” - Action name.
string “type” - Action type.
(optional)
action will be performed
the action.
action.
progress.
Description: Returns a list of systems that have completed a specific action.
int “server_id”
string “server_name” - Server name.
string “base_channel” - Base channel used by the server.
completed
execution of the action. For example, if the action failed, this will contain the failure text.
Description: Returns a list of actions that have failed.
int “id” - Action Id.
string “name” - Action name.
string “type” - Action type.
(optional)
the action will be performed
the action.
action.
progress.
Description: Returns a list of systems that have failed a specific action.
int “server_id”
string “server_name” - Server name.
string “base_channel” - Base channel used by the server.
completed
execution of the action. For example, if the action failed, this will contain the failure text.
Description: Returns a list of actions that are in progress.
int “id” - Action Id.
string “name” - Action name.
string “type” - Action type.
(optional)
action will be performed
action.
action.
progress.
Description: Returns a list of systems that have a specific action in progress.
int “server_id”
string “server_name” - Server name.
string “base_channel” - Base channel used by the server.
completed
execution of the action. For example, if the action failed, this will contain the failure text.
Description: Reschedule all actions in the given list.
session object
reschedule all
Provides methods to access and modify registered system.
Description: Add addon entitlements to a server. Entitlements a server already has are quietly ignored.
session object
int serverId
Description: Add a new note to the given server.
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.
int “package_name_id”
string “package_name”
string “package_arch”
string “this_system” - Version of package on this system.
system.
Description: Compares the packages installed on two systems.
int “package_name_id”
string “package_name”
string “package_arch”
string “this_system” - Version of package on this system.
system.
Description: Converts the given list of systems for a given channel family to use the flex entitlement.
string channel_family_label
flex entitlement
Description: Create a new stored Package Profile from a systems installed package list.
Description: Creates a cobbler system record with the specified kickstart label
Description: Delete the custom values defined for the custom system information keys provided from the given system.
object session
int server_id
Returns: int - 1 on success, exception thrown otherwise.
Description: Delete the specified list of guest profiles for a given host
object session
int hostid
Returns: int - 1 on success, exception thrown otherwise.
Description: Deletes the given note from the server.
Returns: int - 1 on success, exception thrown otherwise.
Description: Deletes all notes from the server.
Description: Delete a package profile
Returns: int - 1 on success, exception thrown otherwise.
Description: Delete a system given its cilent certificate.
Available since: 10.10
Description: Delete systems given a list of system ids.
object session
Description: Deletes tag from system snapshot
Description: Get the system ID file for a given server.
Description: Get the list of proxies that the given system connects through in order to reach the server.
the system connects directly to is listed in position 1.
int “id” - Proxy system id
string “hostname” - Proxy host name
Description: Gets the CPU information of a system.
Description: Get the custom data values defined for the server.
Description: Get system details.
int “id” - System id
string “profile_name”
(enterprise_entitled or sw_mgr_entitled
enabled.
(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’.
False indicates that the system is unlocked
Description: Gets a list of devices for a system.
string “device” - optional
VIDEO, OTHER, etc.
string “driver”
string “description”
string “bus”
string “pcitype”
Description: Gets the DMI information of a system.
Description: Gets the entitlements for a given server.
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.
Description: Get system IDs and last check in information for the given system name.
Parameters:
- sw session
- string systemName
Returns:
- array:
- struct - system
int “id”
string “name”
- dateTime.iso8601 “last_checkin” - Last time server
successfully checked in
Description: Gets the memory information for a system.
Description: Get system name and last check in information for the given system ID.
int “id” - Server id
string “name” - Server name
checked in
Description: Get the addresses and hostname for a given server.
Description: Returns the network devices for the given server.
string “ip” - IP address assigned to this network 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
Description: Returns the date the system was registered.
Description: Returns a list of all errata that are relevant to the system.
Description: Returns a list of all errata of the specified type that are relevant to the system.
object session
int server_id
‘Security Advisory’, ‘Product Enhancement Advisory’, ‘Bug Fix Advisory’
; 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
Description: Returns the running kernel of the given system.
Returns: string
Description: Returns script details for script run actions
Parameters:
- session object
- int actionId - ID of the script run action.
Returns:
- struct - Script details
int “id” - action id
string “content” - script content
string “run_as_user” - Run as user
string “run_as_group” - Run as group
int “timeout” - Timeout in seconds
- array:
- struct - script result
int “serverId” - ID of the server the script runs on.
- dateTime.iso8601 “startDate” - Time script began
execution.
- dateTime.iso8601 “stopDate” - Time script stopped
execution.
int “returnCode” - Script execution return code.
string “output” - Output of the script
result
Description: Fetch results from a script execution. Returns an empty array if no results are yet available.
Parameters:
- session object
- int actionId - ID of the script run action.
Returns:
- array:
- struct - script result
- int “serverId” - ID of the server the script runs on.
- dateTime.iso8601 “startDate” - Time script began execution.
- dateTime.iso8601 “stopDate” - Time script stopped execution.
- int “returnCode” - Script execution return code.
- string “output” - Output of the script
Description: Provides the base channel of a given system
int “id”
string “name”
string “label”
string “arch_name”
string “summary”
string “description”
string “checksum_label”
dateTime.iso8601 “last_modified”
string “maintainer_name”
string “maintainer_email”
string “maintainer_phone”
string “support_policy”
string “gpg_key_url”
string “gpg_key_id”
string “gpg_key_fp”
dateTime.iso8601 “yumrepo_last_sync” - (optional)
string “end_of_life”
string “parent_channel_label”
string “clone_original”
Description: Get the System Currency score multipliers
Description: Get the System Currency scores for all servers the user has access to
Description: Provides an array of errata that are applicable to a given system.
Description: Get the UUID from the given system ID.
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.
boolean “netboot” - netboot enabled
Description: Check if the package with the given NVRE is installed on given system.
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.
Description: Returns a list of active servers visible to the user.
Parameters: object session
int “id”
string “name”
successfully checked in
Description: Given a list of server ids, returns a list of active servers’ details visible to the user.
object session
int “id” - The server’s id
string “name” - The server’s name
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
string “ip” - IP address assigned to this network 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
struct “dmi_info” - The server’s dmi info
struct “cpu_info” - The server’s cpu info
array “subscribed_channels” - List of subscribed channels
system ids for active guests
Description: Returns a list of users which can administer the system.
int “id”
string “login”
string “login_uc” - upper case version of the login
user is disabled
Description: List duplicate systems by Hostname.
string “hostname”
struct - system
int “systemId”
string “systemName”
successfully checked in
Description: List duplicate systems by IP Address.
Parameters: object session
string “ip”
int “systemId”
string “systemName”
successfully checked in
Description: List duplicate systems by Mac Address.
string “mac”
int “systemId”
string “systemName”
successfully checked in
Description: List eligible flex guests accessible to the user
int “id”
string “label”
string “name”
Description: List extra packages for a system
Description: List flex guests accessible to the user
int “id”
string “label”
string “name”
Description: List the available groups for a given system.
int “id” - server group id
this server group, 0 otherwise
string “system_group_name” - Name of the server group
string “sgid” - server group id (Deprecated)
Description: Lists systems that have been inactive for the default period of inactivity
int “id”
string “name”
successfully checked in
Description: Get the latest available version of a package for each system
object session
int “id” - server ID
string “name” - server name
struct “package” - package structure
Description: Get the list of latest installable packages for a given system.
Get the list of latest upgradable packages for a given system.
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:
- session object
- int serverId
- string name - Package name.
- string version - Package version.
- string release - Package release.
- string epoch - Package epoch.
- Returns:
- array:
- struct - package
- string “name”
- string “version”
- string “release”
- string “epoch”
Description: Provides a list of notes associated with a system.
int “id”
string “subject” - Subject of the note
string “note” - Contents of the note
note
string “creator” - Creator of the note
date “updated” - Date of the last note update
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.
Description: Returns list of systems needing package updates.
int “id”
string “name”
successfully checked in
Description: List the package profiles in this organization
Description: List the installed packages for a given system. The attribute installtime is returned since API version 10.10.
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.
string “name”
string “version”
string “release”
string “epoch”
int “id”
string “arch_label”
resides
by the gpg key it was signed with.
dateTime.iso8601 “last_modified”
Description: Returns a list of subscribable base channels.
int “id” - Base Channel ID.
string “name” - Name of channel.
string “label” - Label of Channel
channel
Description: Returns a list of subscribable child channels. This only shows channels the system is not currently subscribed to.
Description: Returns a list of subscribed child channels.
string “clone_original”
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.
int “failed_count” - Number of times action failed.
(Deprecated by modified_date)
dateTime.iso8601 “modified_date” - Date modified.
(Deprecated by created_date)
dateTime.iso8601 “created_date” - Date created.
string “action_type”
successful.
occur.
int “archived” - If this action is archived. (1 or 0)
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.
completed. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0.(optional) (Deprecated by completed_date)
was completed. (optional)
up. Format ->YYYY-MM-dd hh:mm:ss.ms Eg ->2007-06-04 13:58:13.0. (optional) (Deprecated by pickup_date)
picked up. (optional)
executes at the client machine. (optional)
information for the event, if available
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.
the specific event. For example, for a package or errata event, no result is included, for a config file event, the result might include an error (if one occurred, such as the file was missing) or in the case of a config file comparison it might include the differenes found.
Available since: 10.8
Returns a list of all servers visible to the user.
int “id”
string “name”
successfully checked in
Description: List systems with extra packages
Description: Lists the systems that have the given installed package
So either package_id here, or the NVR
int “id”
string “name”
successfully checked in
Description: List systems that are not associated with any system groups.
Description: List systems for a given user.
int “id”
string “name”
successfully checked in
Description: Lists the virtual guests for agiven virtual host
int “id”
string “name”
the virtual host
successfully checked in.
Description: Lists the virtual hosts visible to the user
int “id”
string “name”
successfully checked in
Description: Obtains a reactivation key for this server.
Description: Provision a system using the specified kickstart profile.
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.
object session
int serverId - ID of host to provision guest on.
string guest_name
string profile_name - Kickstart Profile to use.
int memorymb - Memory to allocate to the guest (optional)
int vcpus - Number of virtual CPUs to allocate to the guest(optional)
int storagegb - Size of the guests disk image. (optional)
hardware. (optional)
Description: Remove addon entitlements from a server. Entitlements a server does not have are quietly ignored.
object session
int server_id
Description: Schedules an action to apply errata updates to multiple systems.
object session
int - server_id
dateTime.iso8601 earliestOccurrence (optional)
Returns:
int - 1 on success, exception thrown otherwise.
Description: Schedules a guest action for the specified virtual guest for a given date/time.
object session
int server_id - the system Id of the guest
‘resume’, ‘restart’, ‘shutdown’.
action
Description: Schedule a hardware refresh for a system.
Description: Schedule package installation for a system.
Parameters:
session object
int serverId
- array:
- int - packageId
dateTime.iso8601 earliestOccurrence
Returns:
- int - 1 on success, exception thrown otherwise.
therwise exception thrown on error
Description: Schedule package removal for a system.
object session
int server_id
dateTime.iso8601 earliestOccurrence
Description: Schedule a reboot for a system.
Parameters:
- session object
- int serverId
- dateTime.iso860 earliestOccurrence
Returns:
- int - 1 on success, exception thrown otherwise.
Description: Schedule a script to run.
session object
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.
results with system.getScriptResults.
Description: Sync packages from a source system to a target.
object session
int target_server_id - Target system to apply package changes to.
int source_server_id - Source system to retrieve package state from.
dateTime.iso8601 date - Date to schedule action for
Description: Returns a list of system IDs whose name matches the supplied regular expression.
Parameters:
- session object
- string regexp - A regular expression.
Returns:
- array:
- struct - system
int “id”
string “name”
- dateTime.iso8601 “last_checkin” - Last time server
successfully checked in
http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html
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.
Returns: int - 1 on success, exception thrown otherwise.
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.
object session
int server_id
Returns: int - 1 on success, exception thrown otherwise.
Description: Set custom values for the specified server.
object session
int server_id
Description: Set server details. All arguments are optional and will only be modified if included in the struct.
object session
int server_id - ID of server to lookup details for.
string “profile_name” - System’s profile name
(enterprise_entitled or sw_mgr_entitled)
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”
Description: Set a servers membership in a given group.
object session
int server_id
int server_group_id
group, ‘0’ to remove the given server from the given server group.
Description: Schedule an action of a guest’s host, to set that guest’s CPU allocation
Returns: int actionID - the action Id for the schedule action on the host system
Description: Schedule an action of a guest’s host, to set that guest’s memory allocation
system.
Description: Set server lock status.
object session
int server_id
system.
Description: Set the profile name for the server.
Returns: int - 1 on success, exception thrown otherwise.
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.
object session
int server_id
boolean netboot
Description: Tags latest system snapshot
Description: Adds an entitlement to a given server.
object session
int server_id
Returns: int - 1 on success, exception thrown otherwise.
Description: Returns information about the user who registered the system
int “id”
string “login”
string “login_uc” - upper case version of the login
is disabled
Provides methods to access and modify many aspects of configuration channels and server association. basically system.config name space
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.
object session
configuration channels list of a server
configuration channels list of a server
Description: Create a new file (text or binary) or directory with the given path, or update an existing path on a server.
object session
int server_id
string path - the configuration file/directory path
if binary) ((only for non-directories)
(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)
Use null or empty string to accept the default. (only for non-directories)
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
encoded content is expected (only for non-directories)
override configuration channel
configuration channel
string “path” - File Path
for Symbolic links only.
string “channel” - Channel Name
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
only.
only.
files or directories only.
or directories only.
string “selinux_ctx” - SELinux Context (optional).
boolean “binary” - true/false , Present for files only.
string “md5” - File’s md5 signature. Present for files only.
config file. Present for text files only.
file. Present for text files only.
Available since: 10.2
Description: Create a new symbolic link with the given path, or update an existing path.
object session
int server_id
string path - the configuration file/directory path
configuration channel
configuration channel
string “path” - File Path
for Symbolic links only.
string “channel” - Channel Name
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
only.
only.
files or directories only.
or directories only.
string “selinux_ctx” - SELinux Context (optional).
boolean “binary” - true/false , Present for files only.
string “md5” - File’s md5 signature. Present for files only.
config file. Present for text files only.
config file. Present for text files only.
Available since: 10.2
Description: Removes file paths from a local or sandbox channel of a server.
object session
int server_id
local override configuration channel
sandbox configuration channel
Description: Schedules a deploy action for all the configuration files on the given list of systems.
object session
deployment
dateTime.iso8601 date - Earliest date for the deploy action.
Description: List all global configuration channels associated to a system in the order of their ranking.
array:
int “id”
int “orgId”
string “label”
string “name”
string “description”
struct “configChannelType”
Description: Return the list of files in a given channel.
object session
int server_id
configuration channel
configuration channel
string “path” - File Path
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”
dateTime.iso8601 “last_modified” - Last Modified Date
Description: Given a list of paths and a server, returns details about the latest revisions of the paths.
object session
int server_id
override configuration or systems subscribed central channels
configuration channel
string “path” - File Path
- string “target_path” - Symbolic link Target File Path.
Present for Symbolic links only.
string “channel” - Channel Name
- string “contents” - File contents (base64 encoded according
to the contents_enc64 attribute)
boolean “contents_enc64” - Identifies base64 encoded content
int “revision” - File Revision
dateTime.iso8601 “creation” - Creation Date
dateTime.iso8601 “modified” - Last Modified Date
- string “owner” - File Owner. Present for files or directories
only.
- string “group” - File Group. Present for files or directories
only.
- int “permissions” - File Permissions (Deprecated). Present
for files or directories only.
- string “permissions_mode” - File Permissions. Present for
files or directories only.
string “selinux_ctx” - SELinux Context (optional).
boolean “binary” - true/false , Present for files only.
string “md5” - File’s md5 signature. Present for files only.
- string “macro-start-delimiter” - Macro start delimiter for a
config file. Present for text files only.
- string “macro-end-delimiter” - Macro end delimiter for a
config file. Present for text files only.
Available since: 10.2
Description: Remove config channels from the given servers.
object session
configuration channels..
Description: Replace the existing set of config channels on the given servers. Channels are ranked according to their order in the configChannelLabels array.
object session
Provides methods to access and modify custom system information.
Description: Create a new custom key
Description: Delete an existing custom key and all systems’ values for the key.
Description: List the custom information keys defined for the user’s organization.
Description: Update description of a custom key
Provides methods to schedule SCAP scans and access the results.
Description: Get details of given 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
completion.
string “errors” - Stderr output of scan.
Description: Return a full list of RuleResults for given OpenSCAP XCCDF scan.
Description: Return a list of finished OpenSCAP scans for a given system.
Description: Schedule OpenSCAP scan.
Returns:
int - ID if SCAP action created.
Provides methods to perform system search requests using the search server.
Description: List the systems which match the device description.
int “id”
string “name”
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
Description: List the systems which match this device driver.
int “id”
string “name”
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
Description: List the systems which match this device id
int “id”
string “name”
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
Description: List the systems which match this device vendor_id
int “id”
string “name”
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
Description: List the systems which match this hostname
int “id”
string “name”
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
Description: List the systems which match this ip.
int “id”
string “name”
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
Description: List the systems which match this name or description
int “id”
string “name”
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
Description: List the systems which match this UUID
int “id”
string “name”
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
Provides methods to access and modify system groups.
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.
string sessionKey
string system_group
int add - 1 to add administrators, 0 to remove.
Description: Add/remove the given servers to a system group.
string sessionKey
string system_group
boolean add - True to add to the group, False to remove.
Description: Create a new system group.
Description: Delete a system group.
Description: Retrieve details of a ServerGroup based on it’s id
Description: Lists active systems within a server group
Description: Returns the list of users who can administer the given group. Caller must be a system group admin or an organization administrator.
int “id”
string “login”
string “login_uc” - upper case version of the login
user is disabled
Description: Retrieve a list of system groups that are accessible by the logged in user.
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.
Description: Lists inactive systems within a server group using a specified inactivity time.
string sessionKey
string system_group
to be considered inactive.
Description: Return a list of systems associated with this system group. User must have access to this system group.
int “id” - System id
string “profile_name”
(enterprise_entitled or sw_mgr_entitled)
including monitoring_entitled, provisioning_entitled, virtualization_host, virtualization_host_platform
updates enabled.
(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”
or ‘online’.
locked. False indicates that the system is unlocked.
Description: Schedules an action to apply errata updates to active systems from a group.
string sessionKey
string system_group
dateTime.iso8601 earliestOccurrence (Optional)
Description: Update an existing system group.
User namespace contains methods to access common user functions available from the web user interface..
Description: Add system group to user’s list of assigned system groups.
string sessionKey
string login - User’s login name.
string server_group_name
list of default system groups.
Description: Add system groups to user’s list of assigned system groups.
string sessionKey
string login - User’s login name.
list of default system groups.
Description: Add system group to user’s list of default system groups.
Description: Add system groups to user’s list of default system groups.
string sessionKey
string login - User’s login name.
Description: Adds a role to a user.
string sessionKey
string login - User login name to update.
org_admin, channel_admin, config_admin, system_group_admin, activation_key_admin, or monitoring_admin.
Returns: int - 1 on success, exception thrown otherwise.
Description: Create a new user.
string sessionKey
string login - Desired login name, will fail if already in use.
string password
string first_name
string last_name
string email - User’s e-mail address.
this user, 0 otherwise. (OPTIONAL)
Description: Delete a user.
Description: Disable a user.
Description: Enable a user.
Description: Returns the details about a given user.
string “first_names” - deprecated, use first_name
string “first_name”
string “last_name”
string “email”
int “org_id”
string “prefix”
string “last_login_date”
string “created_date”
is disabled
authentication
Description: Returns the time user last logged in.
Description: Returns a list of user roles that this user can assign to others.
Description: Returns the system groups that a user can administer.
Description: Returns a user’s list of default system groups.
Description: Returns a list of the user’s roles.
Description: Returns a list of users in your organization.
int “id”
string “login”
string “login_uc” - upper case version of the login
user is disabled
Description: Remove system group from the user’s list of assigned system groups.
string sessionKey
string login - User’s login name.
string serverGroupName
user’s list of default system groups.
Description: Remove system groups from a user’s list of assigned system groups.
string sessionKey
string login - User’s login name.
user’s list of default system groups.
Description: Remove a system group from user’s list of default system groups.
Returns: int - 1 on success, exception thrown otherwise.
Description: Remove system groups from a user’s list of default system groups.
string sessionKey
string login - User’s login name.
Description: Remove a role from a user.
string sessionKey
string login - User login name to update.
org_admin, channel_admin, config_admin, system_group_admin, activation_key_admin, or monitoring_admin.
Description: Updates the details of a user.
string sessionKey
string login - User’s login name.
Description: Toggles whether or not a user uses PAM authentication or basic RHN authentication.
string sessionKey
string login - User’s login name.
Space is a command line interface to Spacewalk's xmlrpc api.