Red Hat Network API: channel.software
- addPackages
- availableEntitlements
- availableEntitlements
- create
- create
- delete
- getDetails
- isGloballySubscribable
- isUserSubscribable
- listAllPackages
- listAllPackages
- listAllPackages
- listAllPackagesByDate
- listAllPackagesByDate
- listAllPackagesByDate
- listArches
- listErrata
- listErrata
- listErrata
- listLatestPackages
- listSubscribedSystems
- listSystemChannels
- removePackages
- setGloballySubscribable
- setSystemChannels
- setUserSubscribable
Description
Provides methods to view packages in a channel.
Namespace:
channel.software
Description:
Adds a given list of packages to the given channel.
Parameters:
- string sessionKey
- string channelLabel - target channel
- array packageIds - ids of the packages to add to the channel
Returns:
-
int - 1 if successful, exception otherwise
Description:
Returns the number of available physical subscriptions for the given channel
Parameters:
- string sessionKey
- string channelLabel - channel to query
Returns:
-
int number of available subscriptions for the given channel
Description:
Returns the number of available subscriptions for the given channel
Parameters:
- string sessionKey
- string channelLabel - channel to query
- string entitlementType - One of "regular" or "flex"
Returns:
-
int number of available subscriptions for the given channel of the given type.
Description:
Creates a software channel, parent_channel_label can be an empty string
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
- string channelChecksumLabel - the label of the preferred checksum method for channel metadata,
currently supported are sha1 and sha-256
- string rpmChecksumLabel - the label of the preferred checksum method for
identifying RPMs, currently
can be one of (md5, sha1, sha-256)
Returns:
-
int - 1 if the creation operation succeeded, 0 otherwise
Description:
Creates a software channel, parent_channel_label can be an empty string.
The newly created channel uses default checksums: SHA1 for metadata and MD5
to identify RPMs.
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
Description:
Lists the potential software channel architectures that can be created
Parameters:
- string sessionKey
- string channelLabel - channel to delete
Returns:
-
int - 1 if the operation succeeded, an exception otherwise
Description:
Returns details of the given channel as a map
Parameters:
- string sessionKey
- string channelLabel - channel to query
Returns:
-
struct (channel)
- string "channel_arch_name"
- string "channel_summary"
- string "channel_description"
- string "channel_gpg_key_url"
- string "channel_gpg_key_id"
- string "channel_gpg_key_fp"
- string "channel_end_of_life"
- string "channel_checksum_type"
- string "channel_rpm_checksum_type"
- string "parent_channel_label"
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
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
Description:
Lists all packages in the channel, regardless of package version,
between the given dates.
Parameters:
- string sessionKey
- string channelLabel - channel to query
- date startDate
- date endDate
Returns:
-
array
- struct (package)
- string "package_name"
- string "package_version"
- string "package_release"
- string "package_epoch"
- string "package_id"
- string "package_arch_label"
- string "package_last_modified"
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 "package_name"
- string "package_version"
- string "package_release"
- string "package_epoch"
- string "package_id"
- string "package_arch_label"
- string "package_last_modified"
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
- date startDate
Returns:
-
array
- struct (package)
- string "package_name"
- string "package_version"
- string "package_release"
- string "package_epoch"
- string "package_id"
- string "package_arch_label"
- string "package_last_modified"
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
- date startDate
Returns:
-
array
- struct (package)
- string "package_name"
- string "package_version"
- string "package_release"
- string "package_epoch"
- string "package_id"
- string "package_arch_label"
- string "package_last_modified"
Description:
Lists all packages in the channel, regardless of the package version,
between the given dates
Parameters:
- string sessionKey
- string channelLabel - channel to query
- date startDate
- date endDate
Returns:
-
array
- struct (package)
- string "package_name"
- string "package_version"
- string "package_release"
- string "package_epoch"
- string "package_id"
- string "package_arch_label"
- string "package_last_modified"
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 "package_name"
- string "package_version"
- string "package_release"
- string "package_epoch"
- string "package_id"
- string "package_arch_label"
- string "package_last_modified"
Description:
Lists the potential software channel architectures that can be created
Parameters:
Returns:
-
array
- struct (channel arch)
- string "arch_name"
- string "arch_label"
Description:
List the errata applicable to a channel
Parameters:
- string sessionKey
- string channelLabel - channel to query
Returns:
-
array
- struct (system)
- string "sid" - system id
- string "system_name"
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 "ERRATA_ADVISORY" - name of the advisory
- string "ERRATA_ISSUE_DATE"
- string "ERRATA_UPDATE_DATE"
- string "ERRATA_SYNOPSIS"
- string "ERRATA_ADVISORY_TYPE"
- string "errata_last_modified_date"
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 "ERRATA_ADVISORY" - name of the advisory
- string "ERRATA_ISSUE_DATE"
- string "ERRATA_UPDATE_DATE"
- string "ERRATA_SYNOPSIS"
- string "ERRATA_ADVISORY_TYPE"
- string "errata_last_modified_date"
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 "package_name"
- string "package_version"
- string "package_release"
- string "package_epoch"
- string "package_id"
- string "package_arch_label"
Description:
Returns list of subscribed systems for the given channel label
Parameters:
- string sessionKey
- string channelLabel - channel to query
Returns:
-
array
- struct (system)
- int "sid" - system id
- string "system_name"
Description:
Returns a list of channels that a system is subscribed to for the
given system id
Parameters:
- string sessionKey
- int sid - id of the system to be queried
Returns:
-
array
- struct (channel)
- string "channel_label"
- string "channel_name"
Description:
Removes a given list of packages from the given channel.
Parameters:
- string sessionKey
- string channelLabel - target channel
- array packageIds - ids of the packages to remove from the channel
Returns:
-
int - 1 if successful, exception otherwise
Description:
Set globally subscribable attribute for given channel.
Parameters:
- string sessionKey
- string channelLabel - channel to target
- string - value of the flag to set
Returns:
-
int - 1 if successful, exception otherwise
Description:
Change a systems subscribed channels to the list of channels passed in.
Parameters:
- string sessionKey
- int sid - id of the system
- array channelLabels - labels of the channel to subscribe the system to
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 priveledge 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