API Overview: errata

Description

ErrataHandler - provides methods to access errata within Red Hat Network.

Namespace: errata

Method: applicableToChannels

Parameters:

• string sessionKey
• string advisoryName

Returns: array

• struct (channel)
• int "channel_id"
• string "label"
• string "name"
• string "parent_channel_label"
• string "channel_label" (deprecated)
• string "channel_name" (deprecated)

Method: bugzillaFixes

Parameters:

• string sessionKey
• string advisoryName

Returns: struct (Bugzilla info)

• int 'bugzilla_id' - actual bug number is the key into the struct
• string 'bug_summary' - summary who's key is the bug id

Method: clone

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.
• dateTime.iso8601 "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: create

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 "topic"
  • string "description"
  • string "references"
  • string "notes"
  • string "solution"
• array
  • struct (bug)
  • int "id" - Bug ID.
  • string "summary"
• array - List of keywords to associate with the errata.
  • string keyword
• array - List of packages to associate with the errata.
  • int packageId
• boolean publish - Should the errata be published.
• array - List of channels the errata should be published too, if it is to be published. (ignored if publish is set to false)
  • string channelLabel

Returns: struct (errata)

• int "id" - Errata ID.
• dateTime.iso8601 "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

Parameters:

• string sessionKey
• string advisoryName

Returns: struct (erratum)

• string "issue_date"
• string "update_date"
• string "last_modified_date"
• string "description"
• string "synopsis"
• string "topic"
• string "references"
• string "notes"
• string "type"
• string "errata_issue_date" (deprecated)
• string "errata_update_date" (deprecated)
• string "errata_last_modified_date" (deprecated)
• string "errata_description" (deprecated)
• string "errata_synopsis" (deprecated)
• string "errata_topic" (deprecated)
• string "errata_references" (deprecated)
• string "errata_notes" (deprecated)
• string "errata_type" (deprecated)

Method: getOval

Parameters:

• string sessionKey
• string identifier - Can either be an erratum's ID, CVE/CAN, or advisory name. In the case of CVE/CAN, all dashes must be removed from the name. Numeric advisory IDs and advisory names (RHSA-2006:011) can be submitted as they are.

Returns: string - The OVAL metadata document in escaped XML form.

Method: listAffectedSystems

Parameters:

• string sessionKey
• string advisoryName

Returns: array

• struct (system)
• int "id"
• string "name"
• int "system_id" (deprecated)
• string "system_name" (deprecated)

Method: listByDate

Parameters:

• string sessionKey
• string channelLabel

Returns: array

• struct (errata)
• int "id" - Errata ID.
• dateTime.iso8601 "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

Parameters:

• string sessionKey
• string advisoryName

Returns: array

• string cveName

Method: listKeywords

Parameters:

• string sessionKey
• string advisoryName

Returns: array

• string - Keyword associated with erratum.

Method: listPackages

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 label - Channel label providing this package.
• string "build_host"
• string "description"
• string "md5sum"
• string "vendor"
• string "summary"
• string "cookie"
• string "license"
• string "file"
• string "build_date"
• string "last_modified_date"
• string "size"
• string "payload_size"
• int "package_id" (deprecated)
• string "package_name" (deprecated)
• string "package_epoch" (deprecated)
• string "package_version" (deprecated)
• string "package_release" (deprecated)
• string "package_arch_label" (deprecated)
• string "package_build_host" (deprecated)
• string "package_description" (deprecated)
• string "package_md5sum" (deprecated)
• string "package_vendor" (deprecated)
• string "package_summary" (deprecated)
• string "package_cookie" (deprecated)
• string "package_license" (deprecated)
• string "package_file" (deprecated)
• string "package_build_date" (deprecated)
• string "package_last_modified_date" (deprecated)
• string "package_size" (deprecated)
• string "package_payload_size" (deprecated)

Method: publish

Parameters:

• string sessionKey
• string advisoryName
• array - List of channels to publish the errata to.
  • string channelLabel

Returns: struct (errata)

• int "id" - Errata ID.
• dateTime.iso8601 "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.