( Return to API Overview )

Description

ChannelSoftwareHandler

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 if successful, exception 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 arch the channel corresponds to
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 if the operation succeeded, an exception otherwise

Method: getDetails

Description:
Returns details of the given channel as a map

Parameters:

string sessionKey
string channelLabel - channel to query

Returns:

 array
  struct (channel)
  int "id"
 string "label"
 string "name"
 string "arch_name"
 string "summary"
 string "description"
 string "gpg_key_url"
 string "gpg_key_id"
 string "gpg_key_fp"
 string "end_of_life"
 string "parent_channel_label"
 int "channel_id" (deprecated)
 string "channel_label" (deprecated)
 string "channel_name" (deprecated)
 string "channel_arch_name" (deprecated)
 string "channel_summary" (deprecated)
 string "channel_description" (deprecated)
 string "channel_gpg_key_url" (deprecated)
 string "channel_gpg_key_id" (deprecated)
 string "channel_gpg_key_fp" (deprecated)
 string "channel_end_of_life" (deprecated)

Method: getDetails

Description:
Returns details of the given channel as a map

Parameters:

string sessionKey
int id - channel to query

Returns:

 array
  struct (channel)
  int "id"
 string "label"
 string "name"
 string "arch_name"
 string "summary"
 string "description"
 string "gpg_key_url"
 string "gpg_key_id"
 string "gpg_key_fp"
 string "end_of_life"
 string "parent_channel_label"
 int "channel_id" (deprecated)
 string "channel_label" (deprecated)
 string "channel_name" (deprecated)
 string "channel_arch_name" (deprecated)
 string "channel_summary" (deprecated)
 string "channel_description" (deprecated)
 string "channel_gpg_key_url" (deprecated)
 string "channel_gpg_key_id" (deprecated)
 string "channel_gpg_key_fp" (deprecated)
 string "channel_end_of_life" (deprecated)

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 - channel to query
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"
 string "package_name (deprecated)"
 string "package_version (deprecated)"
 string "package_release (deprecated)"
 string "package_epoch (deprecated)"
 int "package_id (deprecated)"
 string "package_arch_label (deprecated)"
 string "package_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"
 string "package_name (deprecated)"
 string "package_version (deprecated)"
 string "package_release (deprecated)"
 string "package_epoch (deprecated)"
 int "package_id (deprecated)"
 string "package_arch_label (deprecated)"
 string "package_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"
 string "package_name (deprecated)"
 string "package_version (deprecated)"
 string "package_release (deprecated)"
 string "package_epoch (deprecated)"
 int "package_id (deprecated)"
 string "package_arch_label (deprecated)"
 string "package_last_modified (deprecated)"

Method: listAllPackagesByDate

Description:
Lists all packages in the channel, regardless of the package 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"
 string "package_name (deprecated)"
 string "package_version (deprecated)"
 string "package_release (deprecated)"
 string "package_epoch (deprecated)"
 int "package_id (deprecated)"
 string "package_arch_label (deprecated)"
 string "package_last_modified (deprecated)"

Method: listAllPackagesByDate

Description:
Lists all packages in the channel, regardless of the 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"
 string "package_name (deprecated)"
 string "package_version (deprecated)"
 string "package_release (deprecated)"
 string "package_epoch (deprecated)"
 int "package_id (deprecated)"
 string "package_arch_label (deprecated)"
 string "package_last_modified (deprecated)"

Method: listAllPackagesByDate

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"
 string "package_name (deprecated)"
 string "package_version (deprecated)"
 string "package_release (deprecated)"
 string "package_epoch (deprecated)"
 int "package_id (deprecated)"
 string "package_arch_label (deprecated)"
 string "package_last_modified (deprecated)"

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"
 string "arch_name" (deprecated)
 string "arch_label" (deprecated)

Method: listErrata

Description:
List the errata applicable to a channel

Parameters:

string sessionKey
string channelLabel - channel to query

Returns:

 array
  struct (errata)
  string "advisory" - name of the advisory
 string "issue_date"
 string "update_date"
 string "synopsis"
 string "advisory_type"
 string "last_modified_date"
 string "ERRATA_ADVISORY" (deprecated)
 string "ERRATA_ISSUE_DATE" (deprecated)
 string "ERRATA_UPDATE_DATE" (deprecated)
 string "ERRATA_SYNOPSIS" (deprecated)
 string "ERRATA_ADVISORY_TYPE" (deprecated)
 string "errata_last_modified_date" (deprecated)

Method: listErrata

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

Parameters:

string sessionKey
string channelLabel - channel to query
string startDate

Returns:

 array
  struct (errata)
  string "advisory" - name of the advisory
 string "issue_date"
 string "update_date"
 string "synopsis"
 string "advisory_type"
 string "last_modified_date"
 string "ERRATA_ADVISORY" (deprecated)
 string "ERRATA_ISSUE_DATE" (deprecated)
 string "ERRATA_UPDATE_DATE" (deprecated)
 string "ERRATA_SYNOPSIS" (deprecated)
 string "ERRATA_ADVISORY_TYPE" (deprecated)
 string "errata_last_modified_date" (deprecated)

Method: listErrata

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

Parameters:

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

Returns:

 array
  struct (errata)
  string "advisory" - name of the advisory
 string "issue_date"
 string "update_date"
 string "synopsis"
 string "advisory_type"
 string "last_modified_date"
 string "ERRATA_ADVISORY" (deprecated)
 string "ERRATA_ISSUE_DATE" (deprecated)
 string "ERRATA_UPDATE_DATE" (deprecated)
 string "ERRATA_SYNOPSIS" (deprecated)
 string "ERRATA_ADVISORY_TYPE" (deprecated)
 string "errata_last_modified_date" (deprecated)

Method: listLatestPackages

Description:
Lists the packages with the largest 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"
 string "id"
 string "arch_label"
 string "package_name (deprecated)"
 string "package_version (deprecated)"
 string "package_release (deprecated)"
 string "package_epoch (deprecated)"
 int "package_id (deprecated)"
 string "package_arch_label (deprecated)"

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"
 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"
 string "system_name" (deprecated)
 int "sid" - system id (deprecated)

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"
 string "channel_label" (deprecated)
 string "channel_name" (deprecated)

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 - List of packages that were merged
  struct (package)
  string "name"
 string "version"
 string "release"
 string "epoch"
 string "id"
 string "arch_label"
 string "last_modified"

Method: removePackages

Description:
Removes a given list of packages from the given channel.

Parameters:

string sessionKey
string channelLabel - target channel
array
- int packageId

Returns: int - 1 if successful, exception otherwise.

Method: setGloballySubscribable

Description:
Set globally subscribable attribute for given channel.

Parameters:

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

Returns: int - 1 if successful, exception otherwise

Method: setSystemChannels

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

Parameters:

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

Returns: int - 1 on success, 0 otherwise

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
string value - value of the flag to set

Returns: int - 1 on success, an exception 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.

Available methods

Description

Method: addPackages

Method: availableEntitlements

Method: clone

Method: create

Method: delete

Method: getDetails

Method: getDetails

Method: isGloballySubscribable

Method: isUserSubscribable

Method: listAllPackages

Method: listAllPackages

Method: listAllPackages

Method: listAllPackagesByDate

Method: listAllPackagesByDate

Method: listAllPackagesByDate

Method: listArches

Method: listErrata

Method: listErrata

Method: listErrata

Method: listLatestPackages

Method: listPackagesWithoutChannel

Method: listSubscribedSystems

Method: listSystemChannels

Method: mergePackages

Method: removePackages

Method: setGloballySubscribable

Method: setSystemChannels

Method: setUserSubscribable

Method: subscribeSystem