channel.software

Available methods

Description

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

Namespace:

channel.software

Method: addPackages

HTTP POST

Description:

Adds a given list of packages to the given channel.

Parameters:

  • string sessionKey

  • string channelLabel - target channel

  • int array packageIds - ID of a package to add to the channel

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: addRepoFilter

HTTP POST

Description:

Adds a filter for a given repo.

Parameters:

  • string sessionKey

  • string label - repository label

  • struct filterProps

    • string "filter" - string to filter on

    • string "flag" - + for include, - for exclude

Returns:

  • int order - sort order for new filter

Method: alignMetadata

HTTP POST

Description:

Align the metadata of a channel to another channel.

Parameters:

  • string sessionKey

  • string channelFromLabel - the label of the source channel

  • string channelToLabel - the label of the target channel

  • string metadataType - the metadata type. Only 'modules' supported currently.

Returns:

  • int result code - 1 when metadata has been aligned, 0 otherwise

Method: applyChannelState

HTTP POST

Description:

Refresh pillar data and then schedule channels state on the provided systems

Parameters:

  • string sessionKey

  • int array sids

Returns:

  • int array actionId

Method: associateRepo

HTTP POST

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 "contentSources"

      • struct content source

        • int "id"

        • string "label"

        • string "sourceUrl"

        • string "type"

Method: clearRepoFilters

HTTP POST

Description:

Removes the filters for a repo

Parameters:

  • string sessionKey

  • string label - repository label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: clone

HTTP POST

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 originalLabel

  • struct channelDetails

    • 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 "gpg_check" - (optional)

    • string "description" - (optional)

    • string "checksum" - either sha1 or sha256

  • boolean originalState

Returns:

  • int id - the cloned channel ID

Method: create

HTTP POST

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, run 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

  • boolean gpgCheck - true if the GPG check should be enabled by default, false otherwise

Returns:

  • int status - 1 if the creation operation succeeded, 0 otherwise

Available since API version: 10.9

Method: create

HTTP POST

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, run 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 status - 1 if the creation operation succeeded, 0 otherwise

Available since API version: 10.9

Method: create

HTTP POST

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, run 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 status - 1 if the creation operation succeeded, 0 otherwise

Available since API version: 10.9

Method: create

HTTP POST

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, run 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 status - 1 if the creation operation succeeded, 0 otherwise

Method: createRepo

HTTP POST

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"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: createRepo

HTTP POST

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"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: createRepo

HTTP POST

Description:

Creates a repository

Parameters:

  • string sessionKey

  • string label - repository label

  • string type - repository type (only YUM is supported)

  • string url - repository url

  • string sslCaCert - SSL CA cert description, or an empty string

  • string sslCliCert - SSL Client cert description, or an empty string

  • string sslCliKey - SSL Client key description, or an empty string

  • boolean hasSignedMetadata - true if the repository has signed metadata, false otherwise

Returns:

  • * struct channel

    • int "id"

    • string "label"

    • string "sourceUrl"

    • string "type"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: delete

HTTP POST

Description:

Deletes a custom software channel

Parameters:

  • string sessionKey

  • string channelLabel - channel to delete

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: disassociateRepo

HTTP POST

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 "contentSources"

      • struct content source

        • int "id"

        • string "label"

        • string "sourceUrl"

        • string "type"

Method: getChannelLastBuildById

HTTP GET

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:

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

Method: getDetails

HTTP GET

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 "contentSources"

      • struct content source

        • int "id"

        • string "label"

        • string "sourceUrl"

        • string "type"

Method: getDetails

HTTP GET

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 "contentSources"

      • struct content source

        • int "id"

        • string "label"

        • string "sourceUrl"

        • string "type"

Method: getRepoDetails

HTTP GET

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"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: getRepoDetails

HTTP GET

Description:

Returns details of the given repository

Parameters:

  • string sessionKey

  • int id - repository ID

Returns:

  • * struct channel

    • int "id"

    • string "label"

    • string "sourceUrl"

    • string "type"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: getRepoSyncCronExpression

HTTP GET

Description:

Returns repo synchronization cron expression

Parameters:

  • string sessionKey

  • string channelLabel - channel label

Returns:

  • string expression - quartz expression

Method: isExisting

HTTP GET

Description:

Returns whether is existing

Parameters:

  • string sessionKey

  • string channelLabel - label of the channel

Returns:

  • boolean result - true if the channel exists

Method: isGloballySubscribable

HTTP GET

Description:

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

Parameters:

  • string sessionKey

  • string channelLabel - channel to query

Returns:

  • int subscribable - 1 if true, 0 otherwise

Method: isUserManageable

HTTP GET

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 status - 1 if manageable, 0 if not

Method: isUserSubscribable

HTTP GET

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 status - 1 if subscribable, 0 if not

Method: listAllPackages

HTTP GET

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

HTTP GET

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

HTTP GET

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

HTTP GET

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

HTTP GET

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"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: listChildren

HTTP GET

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 "contentSources"

      • struct content source

        • int "id"

        • string "label"

        • string "sourceUrl"

        • string "type"

Method: listErrata

HTTP GET

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 "issue_date" - the date erratum was updated (deprecated)

    • string "date" - the date erratum was created (deprecated)

    • string "update_date" - the date erratum was updated (deprecated)

    • string "advisory_synopsis" - summary of the erratum

    • string "advisory_type" - type label such as 'Security', 'Bug Fix'

    • string "advisory_status" - status label such as 'final', 'testing', 'retracted'

    • string "advisory_name" - name such as 'RHSA', etc.

    • boolean "reboot_suggested" - A boolean flag signaling whether a system reboot is advisable following the application of the errata. Typical example is upon kernel update.

    • boolean "restart_suggested" - A boolean flag signaling a weather reboot of the package manager is advisable following the application of the errata. This is commonly used to address update stack issues before proceeding with other updates.

Method: listErrata

HTTP GET

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 "issue_date" - the date erratum was updated (deprecated)

    • string "date" - the date erratum was created (deprecated)

    • string "update_date" - the date erratum was updated (deprecated)

    • string "advisory_synopsis" - summary of the erratum

    • string "advisory_type" - type label such as 'Security', 'Bug Fix'

    • string "advisory_status" - status label such as 'final', 'testing', 'retracted'

    • string "advisory_name" - name such as 'RHSA', etc.

    • boolean "reboot_suggested" - A boolean flag signaling whether a system reboot is advisable following the application of the errata. Typical example is upon kernel update.

    • boolean "restart_suggested" - A boolean flag signaling a weather reboot of the package manager is advisable following the application of the errata. This is commonly used to address update stack issues before proceeding with other updates.

Method: listErrata

HTTP GET

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 "issue_date" - the date erratum was updated (deprecated)

    • string "date" - the date erratum was created (deprecated)

    • string "update_date" - the date erratum was updated (deprecated)

    • string "advisory_synopsis" - summary of the erratum

    • string "advisory_type" - type label such as 'Security', 'Bug Fix'

    • string "advisory_status" - status label such as 'final', 'testing', 'retracted'

    • string "advisory_name" - name such as 'RHSA', etc.

    • boolean "reboot_suggested" - A boolean flag signaling whether a system reboot is advisable following the application of the errata. Typical example is upon kernel update.

    • boolean "restart_suggested" - A boolean flag signaling a weather reboot of the package manager is advisable following the application of the errata. This is commonly used to address update stack issues before proceeding with other updates.

Method: listErrata

HTTP GET

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 "issue_date" - the date erratum was updated (deprecated)

    • string "date" - the date erratum was created (deprecated)

    • string "update_date" - the date erratum was updated (deprecated)

    • string "advisory_synopsis" - summary of the erratum

    • string "advisory_type" - type label such as 'Security', 'Bug Fix'

    • string "advisory_status" - status label such as 'final', 'testing', 'retracted'

    • string "advisory_name" - name such as 'RHSA', etc.

    • boolean "reboot_suggested" - A boolean flag signaling whether a system reboot is advisable following the application of the errata. Typical example is upon kernel update.

    • boolean "restart_suggested" - A boolean flag signaling a weather reboot of the package manager is advisable following the application of the errata. This is commonly used to address update stack issues before proceeding with other updates.

Method: listErrataByType

HTTP GET

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

HTTP GET

Description:

If you have synced a new channel then patches 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 "issue_date" - the date erratum was updated (deprecated)

    • string "date" - the date erratum was created (deprecated)

    • string "update_date" - the date erratum was updated (deprecated)

    • string "advisory_synopsis" - summary of the erratum

    • string "advisory_type" - type label such as 'Security', 'Bug Fix'

    • string "advisory_status" - status label such as 'final', 'testing', 'retracted'

    • string "advisory_name" - name such as 'RHSA', etc.

    • boolean "reboot_suggested" - A boolean flag signaling whether a system reboot is advisable following the application of the errata. Typical example is upon kernel update.

    • boolean "restart_suggested" - A boolean flag signaling a weather reboot of the package manager is advisable following the application of the errata. This is commonly used to address update stack issues before proceeding with other updates.

Method: listLatestPackages

HTTP GET

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

HTTP GET

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"

    • string "path" - the path on that file system that the package resides

    • boolean "part_of_retracted_patch" - true if the package is a part of a retracted patch

    • string "provider" - the provider of the package, determined by the gpg key it was signed with.

Method: listRepoFilters

HTTP GET

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

HTTP GET

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

HTTP GET

Description:

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

Parameters:

  • string sessionKey

  • int sid - system ID

Returns:

  • array :

    • struct channel

      • string "id"

      • string "label"

      • string "name"

Method: listUserRepos

HTTP GET

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

HTTP POST

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" - the date erratum was created

    • string "advisory_type" - type of the advisory

    • string "advisory_status" - status of the advisory

    • string "advisory_name" - name of the advisory

    • string "advisory_synopsis" - summary of the erratum

Method: mergeErrata

HTTP POST

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" - the date erratum was created

    • string "advisory_type" - type of the advisory

    • string "advisory_status" - status of the advisory

    • string "advisory_name" - name of the advisory

    • string "advisory_synopsis" - summary of the erratum

Method: mergeErrata

HTTP POST

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

  • string array errataNames - the advisory name of the errata to merge

Returns:

  • array :

  • struct errata

    • int "id" - errata ID

    • string "date" - the date erratum was created

    • string "advisory_type" - type of the advisory

    • string "advisory_status" - status of the advisory

    • string "advisory_name" - name of the advisory

    • string "advisory_synopsis" - summary of the erratum

Method: mergePackages

HTTP POST

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"

    • dateTime.iso8601 "last_modified"

    • string "path" - the path on that file system that the package resides

    • boolean "part_of_retracted_patch" - true if the package is a part of a retracted patch

    • string "provider" - the provider of the package, determined by the gpg key it was signed with.

Method: mergePackages

HTTP POST

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

  • boolean alignModules - align modular data of the target channel to the source channel (RHEL8 and higher)

Returns:

  • array :

  • struct package

    • string "name"

    • string "version"

    • string "release"

    • string "epoch"

    • int "id"

    • string "arch_label"

    • dateTime.iso8601 "last_modified"

    • string "path" - the path on that file system that the package resides

    • boolean "part_of_retracted_patch" - true if the package is a part of a retracted patch

    • string "provider" - the provider of the package, determined by the gpg key it was signed with.

Method: regenerateNeededCache

HTTP POST

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

HTTP POST

Description:

Completely clear and regenerate the needed Errata and Package cache for all systems subscribed. You must be a #product() 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

HTTP POST

Description:

Regenerate yum cache for the specified channel.

Parameters:

  • string sessionKey

  • string channelLabel - the label of the channel

  • boolean force - force cache regeneration

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: removeErrata

HTTP POST

Description:

Removes a given list of errata from the given channel.

Parameters:

  • string sessionKey

  • string channelLabel - target channel

  • string array errataNames - 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

HTTP POST

Description:

Removes a given list of packages from the given channel.

Parameters:

  • string sessionKey

  • string channelLabel - target channel

  • int array packageIds - ID of a package to remove from the channel

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: removeRepo

HTTP POST

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

HTTP POST

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

HTTP POST

Description:

Removes a filter for a given repo.

Parameters:

  • string sessionKey

  • string label - repository label

  • struct filterProps

    • string "filter" - string to filter on

    • string "flag" - + for include, - for exclude

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setContactDetails

HTTP POST

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

HTTP POST

Description:

Allows to modify channel attributes

Parameters:

  • string sessionKey

  • string channelLabel - channel label

  • struct details

    • 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)

    • string "gpg_check" - enable/disable gpg check (optional)

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setDetails

HTTP POST

Description:

Allows to modify channel attributes

Parameters:

  • string sessionKey

  • int channelId - channel id

  • struct details

    • 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)

    • string "gpg_check" - enable/disable gpg check (optional)

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setGloballySubscribable

HTTP POST

Description:

Set globally subscribable attribute for given channel.

Parameters:

  • string sessionKey

  • string channelLabel - label of the channel

  • boolean value - true if the channel is to be globally subscribable. False otherwise.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setRepoFilters

HTTP POST

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 filterProps

    • struct filter properties

      • string "filter" - string to filter on

      • string "flag" - + for include, - for exclude

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setUserManageable

HTTP POST

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

HTTP POST

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

HTTP POST

Description:

If you have synced a new channel then patches 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. It also updates cloned errata attributes like advisoryStatus.

Parameters:

  • string sessionKey

  • string channelLabel - channel to update

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: syncRepo

HTTP POST

Description:

Trigger immediate repo synchronization

Parameters:

  • string sessionKey

  • string array channelLabels

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: syncRepo

HTTP POST

Description:

Trigger immediate repo synchronization

Parameters:

  • string sessionKey

  • string channelLabel - channel label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: syncRepo

HTTP POST

Description:

Trigger immediate repo synchronization

Parameters:

  • string sessionKey

  • string channelLabel - channel label

  • struct params

    • 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

HTTP POST

Description:

Schedule periodic repo synchronization

Parameters:

  • string sessionKey

  • string channelLabel - channel label

  • string cronExpr - cron expression, if empty all periodic schedules will be disabled

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: syncRepo

HTTP POST

Description:

Schedule periodic repo synchronization

Parameters:

  • string sessionKey

  • string channelLabel - channel label

  • string cronExpr - cron expression, if empty all periodic schedules will be disabled

  • struct params

    • 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

HTTP POST

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"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: updateRepoLabel

HTTP POST

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"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: updateRepoLabel

HTTP POST

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"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: updateRepoSsl

HTTP POST

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"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: updateRepoSsl

HTTP POST

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"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: updateRepoUrl

HTTP POST

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"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"

Method: updateRepoUrl

HTTP POST

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"

    • boolean "hasSignedMetadata"

    • array "sslContentSources"

  • struct content source SSL

    • string "sslCaDesc"

    • string "sslCertDesc"

    • string "sslKeyDesc"