errata

Description

Provides methods to access and modify errata.

Namespace:

errata

Method: addPackages

Description:

Add a set of packages to an erratum with the given advisory name. This method will only allow for modification of custom errata created either through the UI or API.

Parameters:

  • string sessionKey

  • string advisoryName

  • array :

    • int - packageId

Returns:

  • int count - representing the number of packages added, exception otherwise

Method: applicableToChannels

Description:

Returns a list of channels applicable to the errata with the given advisory name. For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the list of channels applicable of both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • array :

    • struct - channel

      • int "channel_id"

      • string "label"

      • string "name"

      • string "parent_channel_label"

Method: bugzillaFixes

Description:

Get the Bugzilla fixes for an erratum matching the given advisoryName. The bugs will be returned in a struct where the bug id is the key. i.e. 208144="errata.bugzillaFixes Method Returns different results than docs say" For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the list of Bugzilla fixes of both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • struct - Bugzilla info

    • string "bugzilla_id" - actual bug number is the key into the struct

    • string "bug_summary" - summary who’s key is the bug id

Method: clone

Description:

Clone a list of errata into the specified channel.

Parameters:

  • string sessionKey

  • string channel_label

  • array :

    • string - advisory - The advisory name of the errata to clone.

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

Description:

Clones a list of errata into a specified cloned channel according the original erratas.

Parameters:

  • string sessionKey

  • string channel_label

  • array :

    • string - advisory - The advisory name of the errata to clone.

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

Description:

Asynchronously clones a list of errata into a specified cloned channel according the original erratas

Parameters:

  • string sessionKey

  • string channel_label

  • array :

    • string - advisory - The advisory name of the errata to clone.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: cloneAsync

Description:

Asynchronously clone a list of errata into the specified channel.

Parameters:

  • string sessionKey

  • string channel_label

  • array :

    • string - advisory - The advisory name of the errata to clone.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: create

Description:

Create a custom errata

Parameters:

  • string sessionKey

  • struct - errata info

    • string "synopsis"

    • string "advisory_name"

    • int "advisory_release"

    • string "advisory_type" - Type of advisory (one of the following: 'Security Advisory', 'Product Enhancement Advisory', or 'Bug Fix Advisory'

    • string "product"

    • string "errataFrom"

    • string "topic"

    • string "description"

    • string "references"

    • string "notes"

    • string "solution"

    • string "severity" - Severity of advisory (one of the following: 'Low', 'Moderate', 'Important', 'Critical' or 'Unspecified'

  • array :

    • struct - bug

      • int "id" - Bug Id

      • string "summary"

      • string "url"

  • array :

    • string - keyword - List of keywords to associate with the errata.

  • array :

    • int - packageId

  • array :

    • string - channelLabel - list of channels the errata should be published to

Returns:

  • * 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: delete

Description:

Delete an erratum. This method will only allow for deletion of custom errata created either through the UI or API.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: findByCve

Description:

Lookup the details for errata associated with the given CVE (e.g. CVE-2008-3270)

Parameters:

  • string sessionKey

  • string cveName

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

Description:

Retrieves the details for the erratum matching the given advisory name.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • struct - erratum

    • int "id"

    • string "issue_date"

    • string "update_date"

    • string "last_modified_date" - last time the erratum was modified.

    • string "synopsis"

    • int "release"

    • string "type"

    • string "product"

    • string "errataFrom"

    • string "topic"

    • string "description"

    • string "references"

    • string "notes"

    • string "solution"

Method: listAffectedSystems

Description:

Return the list of systems affected by the errata with the given advisory name. For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the affected systems by both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • array :

  • struct - system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - Last time server successfully checked in

    • dateTime.iso8601 "created" - Server registration time

    • dateTime.iso8601 "last_boot" - Last server boot time

    • int "extra_pkg_count" - Number of packages not belonging to any assigned channel

    • int "outdated_pkg_count" - Number of out-of-date packages

Method: listByDate (Deprecated)

Description:

List errata that have been applied to a particular channel by date.

Deprecated - being replaced by channel.software.listErrata(User LoggedInUser, string channelLabel)

Parameters:

  • string sessionKey

  • string channelLabel

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

Description:

Returns a list of CVEs applicable to the errata with the given advisory name. For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the list of CVEs of both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • array :

    • string - cveName

Method: listKeywords

Description:

Get the keywords associated with an erratum matching the given advisory name. For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the keywords of both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • array :

    • string - Keyword associated with erratum.

Method: listPackages

Description:

Returns a list of the packages affected by the errata with the given advisory name. For those errata that are present in both vendor and user organizations under the same advisory name, this method retrieves the packages of both of them.

Parameters:

  • string sessionKey

  • string advisoryName

Returns:

  • array :

    • struct - package

      • int "id"

      • string "name"

      • string "epoch"

      • string "version"

      • string "release"

      • string "arch_label"

      • array "providing_channels"

        • string - - Channel label providing this package.

      • string "build_host"

      • string "description"

      • string "checksum"

      • string "checksum_type"

      • string "vendor"

      • string "summary"

      • string "cookie"

      • string "license"

      • string "path"

      • string "file"

      • string "build_date"

      • string "last_modified_date"

      • string "size"

      • string "payload_size"

Method: publish

Description:

Adds an existing errata to a set of channels.

Parameters:

  • string sessionKey

  • string advisoryName

  • array :

    • string - channelLabel - list of channel labels to add to

Returns:

  • * 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: publishAsOriginal

Description:

Adds an existing cloned errata to a set of cloned channels according to its original erratum

Parameters:

  • string sessionKey

  • string advisoryName

  • array :

    • string - channelLabel - list of channel labels to add to

Returns:

  • * 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: removePackages

Description:

Remove a set of packages from an erratum with the given advisory name. This method will only allow for modification of custom errata created either through the UI or API.

Parameters:

  • string sessionKey

  • string advisoryName

  • array :

    • int - packageId

Returns:

  • int count - representing the number of packages removed, exception otherwise

Method: setDetails

Description:

Set erratum details. All arguments are optional and will only be modified if included in the struct. This method will only allow for modification of custom errata created either through the UI or API.

Parameters:

  • string sessionKey

  • string advisoryName

  • struct - errata details

    • string "synopsis"

    • string "advisory_name"

    • int "advisory_release"

    • string "advisory_type" - Type of advisory (one of the following: 'Security Advisory', 'Product Enhancement Advisory', or 'Bug Fix Advisory'

    • string "product"

    • dateTime.iso8601 "issue_date"

    • dateTime.iso8601 "update_date"

    • string "errataFrom"

    • string "topic"

    • string "description"

    • string "references"

    • string "notes"

    • string "solution"

    • string "severity" - Severity of advisory (one of the following: 'Low', 'Moderate', 'Important', 'Critical' or 'Unspecified'

    • array "bugs" - 'bugs' is the key into the struct

    • array :

      • struct - bug

        • int "id" - Bug Id

        • string "summary"

        • string "url"

    • array "keywords" - 'keywords' is the key into the struct

    • array :

      • string - keyword - List of keywords to associate with the errata.

    • array "CVEs" - 'cves' is the key into the struct

    • array :

      • string - cves - List of CVEs to associate with the errata

Returns:

  • int - 1 on success, exception thrown otherwise.