( Return to API Overview )

Description

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

Namespace: channel.software

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

Returns:

int - 1 on success, exception thrown otherwise.

Method: availableEntitlements

Description:
Returns the number of available subscriptions for the given channel

Parameters:

string sessionKey
string channelLabel - channel to query

Returns:

int number of available subscriptions for the given channel

Method: 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_url" - (optional)
- string "gpg_id" - (optional)
- string "gpg_fingerprint" - (optional)
- string "description" - (optional)
boolean original_state

Returns:

int the cloned channel ID

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

Returns:

int - 1 if the creation operation succeeded, 0 otherwise

Method: delete

Description:
Deletes a custom software channel

Parameters:

string sessionKey
string channelLabel - channel to delete

Returns:

int - 1 on success, exception thrown otherwise.

Method: getDetails

Description:
Returns details of the given channel as a map

Parameters:

string sessionKey
string channelLabel - channel to query

Returns:

struct - channel int "id" string "name" string "label" string "arch_name" string "summary" string "description" string "maintainer_name" string "maintainer_email" string "maintainer_phone" string "support_policy" string "gpg_key_url" string "gpg_key_id" string "gpg_key_fp" string "end_of_life" string "parent_channel_label"

Method: getDetails

Description:
Returns details of the given channel as a map

Parameters:

string sessionKey
int id - channel to query

Returns:

struct - channel int "id" string "name" string "label" string "arch_name" string "summary" string "description" string "maintainer_name" string "maintainer_email" string "maintainer_phone" string "support_policy" string "gpg_key_url" string "gpg_key_id" string "gpg_key_fp" string "end_of_life" string "parent_channel_label"

Method: isGloballySubscribable

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

Parameters:

string sessionKey
string channelLabel - channel to query

Returns:

int - 1 if true, 0 otherwise

Method: 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

Returns:

int - 1 if subscribable, 0 if not

Method: 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

Returns:

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

Method: 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

Returns:

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

Method: listAllPackages

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

Parameters:

string sessionKey
string channelLabel - channel to query

Returns:

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

Method: 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 as of version - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601 endDate)

Parameters:

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

Returns:

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

Method: 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 as of version - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate)

Parameters:

string sessionKey
string channelLabel - channel to query
string startDate

Returns:

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

Method: listAllPackagesByDate

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

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

Parameters:

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

Returns:

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

Method: 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 as of version - being replaced by listAllPackages(string sessionKey, string channelLabel, dateTime.iso8601 startDate)

Parameters:

string sessionKey
string channelLabel - channel to query
string startDate

Returns:

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

Method: listAllPackagesByDate

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

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

Parameters:

string sessionKey
string channelLabel - channel to query

Returns:

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

Method: listArches

Description:
Lists the potential software channel architectures that can be created

Parameters:

string sessionKey

Returns:

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

Method: listErrata

Description:
List the errata applicable to a channel after given startDate

Parameters:

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

Returns:

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

Method: 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

Returns:

array: struct - errata int "id" - Errata ID. string "date" - Date erratum was created. 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

Method: listErrata

Description:
List the errata applicable to a channel

Parameters:

string sessionKey
string channelLabel - channel to query

Returns:

array: struct - errata int "id" - Errata Id string "date" - Date erratum was created. 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)

Method: listErrata

Description:
List the errata applicable to a channel after given startDate

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

Parameters:

string sessionKey
string channelLabel - channel to query
string startDate

Returns:

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

Method: listErrata

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

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

Parameters:

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

Returns:

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

Method: 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'

Returns:

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

Method: 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

Returns:

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

Method: listPackagesWithoutChannel

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

Parameters:

string sessionKey

Returns:

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

Method: listSubscribedSystems

Description:
Returns list of subscribed systems for the given channel label

Parameters:

string sessionKey
string channelLabel - channel to query

Returns:

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

Method: listSystemChannels

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

Parameters:

string sessionKey
int serverId

Returns:

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

Method: 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

Returns:

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

Method: 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

Returns:

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

Method: 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

Returns:

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

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.

Parameters:

string sessionKey
string channelLabel - the label of the channel

Returns:

int - 1 on success, exception thrown otherwise.

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

Parameters:

string sessionKey

Returns:

int - 1 on success, exception thrown otherwise.

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

Returns:

int - 1 on success, exception thrown otherwise.

Method: 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

Returns:

int - 1 on success, exception thrown otherwise.

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

Returns:

int - 1 on success, exception thrown otherwise.

Method: setSystemChannels

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

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

Parameters:

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

Returns:

int - 1 on success, 0 otherwise

Method: 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

Returns:

int - 1 on success, exception thrown otherwise.

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

Parameters:

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

Returns:

int - 1 on success, exception thrown otherwise.

Generated on 7/31/2009