( Return to API Overview )

Available methods

addPackages
addRepoFilter
associateRepo
clearRepoFilters
clone
create
create
create
createRepo
createRepo
delete
disassociateRepo
getChannelLastBuildById
getDetails
getDetails
getRepoDetails
getRepoDetails
getRepoSyncCronExpression
isGloballySubscribable
isUserManageable
isUserSubscribable
listAllPackages
listAllPackages
listAllPackages
listAllPackages
listAllPackages
listAllPackagesByDate
listAllPackagesByDate
listAllPackagesByDate
listArches
listChannelRepos
listChildren
listErrata
listErrata
listErrata
listErrata
listErrata
listErrata
listErrataByType
listErrataNeedingSync
listLatestPackages
listPackagesWithoutChannel
listRepoFilters
listSubscribedSystems
listSystemChannels
listUserRepos
mergeErrata
mergeErrata
mergeErrata
mergePackages
regenerateNeededCache
regenerateNeededCache
regenerateYumCache
removeErrata
removePackages
removeRepo
removeRepo
removeRepoFilter
setContactDetails
setDetails
setDetails
setGloballySubscribable
setRepoFilters
setSystemChannels
setUserManageable
setUserSubscribable
subscribeSystem
syncErrata
syncRepo
syncRepo
syncRepo
syncRepo
updateRepo
updateRepoLabel
updateRepoLabel
updateRepoSsl
updateRepoSsl
updateRepoUrl
updateRepoUrl

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

Description:
Adds a filter for a given repo.

Parameters:

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

Returns:

int sort order for new filter

Method: associateRepo

Description:
Associates a repository with a channel

Parameters:

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

Returns:

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

Method: clearRepoFilters

Description:
Removes the filters for a repo

Parameters:

string sessionKey
string label - repository label

Returns:

int - 1 on success, exception thrown otherwise.

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_key_url" - (optional), gpg_url might be used as well
- string "gpg_key_id" - (optional), gpg_id might be used as well
- string "gpg_key_fp" - (optional), gpg_fingerprint might be used as well
- string "description" - (optional)
- string "checksum" - either sha1 or sha256
boolean original_state

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

Returns:

int - 1 if the creation operation succeeded, 0 otherwise

Available since: 10.9

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, see channel.software.listArches API for complete listing
string parentLabel - label of the parent of this channel, an empty string if it does not have one
string checksumType - checksum type for this channel, used for yum repository metadata generation
- sha1 - Offers widest compatibility with clients
- sha256 - Offers highest security, but is compatible only with newer clients: Fedora 11 and newer, or Enterprise Linux 6 and newer.

Returns:

int - 1 if the creation operation succeeded, 0 otherwise

Available since: 10.9

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, see channel.software.listArches API for complete listing
string parentLabel - label of the parent of this channel, an empty string if it does not have one

Returns:

int - 1 if the creation operation succeeded, 0 otherwise

Method: createRepo

Description:
Creates a repository

Parameters:

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

Returns:

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

Method: createRepo

Description:
Creates a repository

Parameters:

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

Returns:

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

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

Description:
Disassociates a repository from a channel

Parameters:

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

Returns:

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

Method: getChannelLastBuildById

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

Parameters:

string sessionKey
int id - id of channel wanted

Returns:

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

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 "arch_label" string "summary" string "description" string "checksum_label" dateTime.iso8601 "last_modified" string "maintainer_name" string "maintainer_email" string "maintainer_phone" string "support_policy" string "gpg_key_url" string "gpg_key_id" string "gpg_key_fp" dateTime.iso8601 "yumrepo_last_sync" - (optional) string "end_of_life" string "parent_channel_label" string "clone_original" array: struct - contentSources int "id" string "label" string "sourceUrl" string "type"

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 "arch_label" string "summary" string "description" string "checksum_label" dateTime.iso8601 "last_modified" string "maintainer_name" string "maintainer_email" string "maintainer_phone" string "support_policy" string "gpg_key_url" string "gpg_key_id" string "gpg_key_fp" dateTime.iso8601 "yumrepo_last_sync" - (optional) string "end_of_life" string "parent_channel_label" string "clone_original" array: struct - contentSources int "id" string "label" string "sourceUrl" string "type"

Method: getRepoDetails

Description:
Returns details of the given repository

Parameters:

string sessionKey
string repoLabel - repo to query

Returns:

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

Method: getRepoDetails

Description:
Returns details of the given repo

Parameters:

string sessionKey
string repoLabel - repo to query

Returns:

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

Method: getRepoSyncCronExpression

Description:
Returns repo synchronization cron expression

Parameters:

string sessionKey
string channelLabel - channel label

Returns:

string quartz expression

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

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

Parameters:

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

Returns:

int - 1 if manageable, 0 if not

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" string "checksum" string "checksum_type" 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" string "checksum" string "checksum_type" 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" string "checksum" string "checksum_type" 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 - 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 "checksum" string "checksum_type" 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 - 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 "checksum" string "checksum_type" 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 - 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 - 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 - 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: listChannelRepos

Description:
Lists associated repos with the given channel

Parameters:

string sessionKey
string channelLabel - channel label

Returns:

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

Method: listChildren

Description:
List the children of a channel

Parameters:

string sessionKey
string channelLabel - the label of the channel

Returns:

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

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 "update_date" - Date erratum was updated. string "advisory_synopsis" - Summary of the erratum. string "advisory_type" - Type label such as Security, Bug Fix string "advisory_name" - Name such as RHSA, etc

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 "update_date" - Date erratum was updated. string "advisory_synopsis" - Summary of the erratum. string "advisory_type" - Type label such as Security, Bug Fix string "advisory_name" - Name such as RHSA, etc

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
boolean lastModified - select by last modified or not

Returns:

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

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 "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 - 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 - being replaced by listErrata(string sessionKey, string channelLabel, dateTime.iso8601 startDate, dateTime.iso8601)

Parameters:

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

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

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

Parameters:

string sessionKey
string channelLabel - channel to update

Returns:

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

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

Description:
Lists the filters for a repo

Parameters:

string sessionKey
string label - repository label

Returns:

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

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 "id" string "label" string "name"

Method: listUserRepos

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

Parameters:

string sessionKey

Returns:

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

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

Description:
Merges a list of errata from one channel into another

Parameters:

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

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"

Method: regenerateNeededCache

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

Parameters:

string sessionKey
string channelLabel - the label of the channel

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. This will schedule an asynchronous action to actually do the processing.

Parameters:

string sessionKey

Returns:

int - 1 on success, exception thrown otherwise.

Method: regenerateYumCache

Description:
Regenerate yum cache for the specified channel.

Parameters:

string sessionKey
string channelLabel - the label of the channel

Returns:

int - 1 on success, exception thrown otherwise.

Method: removeErrata

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

Parameters:

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

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

Description:
Removes a repository

Parameters:

string sessionKey
long id - ID of repo to be removed

Returns:

int - 1 on success, exception thrown otherwise.

Method: removeRepo

Description:
Removes a repository

Parameters:

string sessionKey
string label - label of repo to be removed

Returns:

int - 1 on success, exception thrown otherwise.

Method: removeRepoFilter

Description:
Removes a filter for a given repo.

Parameters:

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

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

Description:
Allows to modify channel attributes

Parameters:

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

Returns:

int - 1 on success, exception thrown otherwise.

Method: setDetails

Description:
Allows to modify channel attributes

Parameters:

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

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

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

Parameters:

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

Returns:

int - 1 on success, exception thrown otherwise.

Method: setSystemChannels

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

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

Parameters:

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

Returns:

int - 1 on success, exception thrown otherwise.

Method: setUserManageable

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

Parameters:

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

Returns:

int - 1 on success, exception thrown 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.

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

Parameters:

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

Returns:

int - 1 on success, exception thrown otherwise.

Method: syncErrata

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

Parameters:

string sessionKey
string channelLabel - channel to update

Returns:

int - 1 on success, exception thrown otherwise.

Method: syncRepo

Description:
Trigger immediate repo synchronization

Parameters:

string sessionKey
string channelLabel - channel label

Returns:

int - 1 on success, exception thrown otherwise.

Method: syncRepo

Description:
Trigger immediate repo synchronization

Parameters:

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

Returns:

int - 1 on success, exception thrown otherwise.

Method: syncRepo

Description:
Schedule periodic repo synchronization

Parameters:

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

Returns:

int - 1 on success, exception thrown otherwise.

Method: syncRepo

Description:
Schedule periodic repo synchronization

Parameters:

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

Returns:

int - 1 on success, exception thrown otherwise.

Method: updateRepo

Description:
Updates a ContentSource (repo)

Parameters:

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

Returns:

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

Method: updateRepoLabel

Description:
Updates repository label

Parameters:

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

Returns:

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

Method: updateRepoLabel

Description:
Updates repository label

Parameters:

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

Returns:

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

Method: updateRepoSsl

Description:
Updates repository SSL certificates

Parameters:

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

Returns:

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

Method: updateRepoSsl

Description:
Updates repository SSL certificates

Parameters:

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

Returns:

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

Method: updateRepoUrl

Description:
Updates repository source URL

Parameters:

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

Returns:

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

Method: updateRepoUrl

Description:
Updates repository source URL

Parameters:

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

Returns:

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

Generated on 3/4/2020