Description

Namespace: errata

Method: addPackages

Parameters:

• string sessionKey
• string advisoryName
• array:
  • int - packageId

Returns:

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

Method: applicableToChannels

Parameters:

• string sessionKey
• string advisoryName

Returns:

• array:
  • struct - channel
    • int "channel_id"
    • string "label"
    • string "name"
    • string "parent_channel_label"

Method: bugzillaFixes

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

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: 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:
  • string - keyword - List of keywords to associate with the errata.
• array:
  • int - packageId
• boolean publish - Should the errata be published.
• array:
  • string - channelLabel - list of channels the errata should be published too, ignored if publish is set to false

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

Parameters:

• string sessionKey
• string advisoryName

Returns:

• int - 1 on success, exception thrown otherwise.

Method: findByCve

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

Parameters:

• string sessionKey
• string advisoryName

Returns:

• struct - erratum
  • string "issue_date"
  • string "update_date"
  • string "last_modified_date" - This date is only included for published erratum and it represents the last time the erratum was modified.
  • string "synopsis"
  • int "release"
  • string "type"
  • string "product"
  • string "topic"
  • string "description"
  • string "references"
  • string "notes"
  • string "solution"

Method: listAffectedSystems

Parameters:

• string sessionKey
• string advisoryName

Returns:

• array:
  • struct - system
    • int "id"
    • string "name"
    • dateTime.iso8601 "last_checkin" - Last time server successfully checked in

Method: listByDate

Deprecated as of version - being replaced by channel.software.listErrata(string sessionKey, 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

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 - Channel label providing this package.
    • string "build_host"
    • string "description"
    • string "md5sum"
    • string "vendor"
    • string "summary"
    • string "cookie"
    • string "license"
    • string "file"
    • string "path"
    • string "build_date"
    • string "last_modified_date"
    • string "size"
    • string "payload_size"

Method: publish

Parameters:

• string sessionKey
• string advisoryName
• array:
  • string - channelLabel - list of channel labels to publish 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

Parameters:

• string sessionKey
• string advisoryName
• array:
  • int - packageId

Returns:

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

Method: setDetails

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"
  • string "topic"
  • string "description"
  • string "references"
  • string "notes"
  • string "solution"
  • array "bugs" - 'bugs' is the key into the struct
  array:
  • struct - bug
    • int "id" - Bug Id
    • string "summary"
  • array "keywords" - 'keywords' is the key into the struct
  array:
  • string - keyword - List of keywords to associate with the errata.

Returns:

• int - 1 on success, exception thrown otherwise.