Skip to content

/AWS1/CL_SSM=>UPDATEPATCHBASELINE()

About UpdatePatchBaseline

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter.

Method Signature

IMPORTING

Required arguments:

iv_baselineid TYPE /AWS1/SSMBASELINEID /AWS1/SSMBASELINEID

The ID of the patch baseline to update.

Optional arguments:

iv_name TYPE /AWS1/SSMBASELINENAME /AWS1/SSMBASELINENAME

The name of the patch baseline.

io_globalfilters TYPE REF TO /AWS1/CL_SSMPATCHFILTERGROUP /AWS1/CL_SSMPATCHFILTERGROUP

A set of global filters used to include patches in the baseline.

The GlobalFilters parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.

io_approvalrules TYPE REF TO /AWS1/CL_SSMPATCHRULEGROUP /AWS1/CL_SSMPATCHRULEGROUP

A set of rules used to include patches in the baseline.

it_approvedpatches TYPE /AWS1/CL_SSMPATCHIDLIST_W=>TT_PATCHIDLIST TT_PATCHIDLIST

A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

iv_approvedpatchescplnclevel TYPE /AWS1/SSMPATCHCOMPLIANCELEVEL /AWS1/SSMPATCHCOMPLIANCELEVEL

Assigns a new compliance severity level to an existing patch baseline.

iv_approvedpatchesenbnonsec TYPE /AWS1/SSMBOOLEAN /AWS1/SSMBOOLEAN

Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.

it_rejectedpatches TYPE /AWS1/CL_SSMPATCHIDLIST_W=>TT_PATCHIDLIST TT_PATCHIDLIST

A list of explicitly rejected patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

iv_rejectedpatchesaction TYPE /AWS1/SSMPATCHACTION /AWS1/SSMPATCHACTION

The action for Patch Manager to take on patches included in the RejectedPackages list.

ALLOW_AS_DEPENDENCY

Linux and macOS: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as INSTALLED_OTHER. This is the default action if no option is specified.

Windows Server: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as INSTALLED_OTHER. Any package not already installed on the node is skipped. This is the default action if no option is specified.

BLOCK

All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances. If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as INSTALLED_REJECTED.

iv_description TYPE /AWS1/SSMBASELINEDESCRIPTION /AWS1/SSMBASELINEDESCRIPTION

A description of the patch baseline.

it_sources TYPE /AWS1/CL_SSMPATCHSOURCE=>TT_PATCHSOURCELIST TT_PATCHSOURCELIST

Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

iv_availablesecupdscplncstat TYPE /AWS1/SSMPATCHCOMPLIANCESTATUS /AWS1/SSMPATCHCOMPLIANCESTATUS

Indicates the status to be assigned to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.

Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.

Supported for Windows Server managed nodes only.

iv_replace TYPE /AWS1/SSMBOOLEAN /AWS1/SSMBOOLEAN

If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request. Optional fields that aren't specified are set to null.

RETURNING

oo_output TYPE REF TO /aws1/cl_ssmuppatchbaseliners /AWS1/CL_SSMUPPATCHBASELINERS

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_ssm~updatepatchbaseline(
  io_approvalrules = new /aws1/cl_ssmpatchrulegroup(
    it_patchrules = VALUE /aws1/cl_ssmpatchrule=>tt_patchrulelist(
      (
        new /aws1/cl_ssmpatchrule(
          io_patchfiltergroup = new /aws1/cl_ssmpatchfiltergroup(
            it_patchfilters = VALUE /aws1/cl_ssmpatchfilter=>tt_patchfilterlist(
              (
                new /aws1/cl_ssmpatchfilter(
                  it_values = VALUE /aws1/cl_ssmpatchfiltvallist_w=>tt_patchfiltervaluelist(
                    ( new /aws1/cl_ssmpatchfiltvallist_w( |string| ) )
                  )
                  iv_key = |string|
                )
              )
            )
          )
          iv_approveafterdays = 123
          iv_approveuntildate = |string|
          iv_compliancelevel = |string|
          iv_enablenonsecurity = ABAP_TRUE
        )
      )
    )
  )
  io_globalfilters = new /aws1/cl_ssmpatchfiltergroup(
    it_patchfilters = VALUE /aws1/cl_ssmpatchfilter=>tt_patchfilterlist(
      (
        new /aws1/cl_ssmpatchfilter(
          it_values = VALUE /aws1/cl_ssmpatchfiltvallist_w=>tt_patchfiltervaluelist(
            ( new /aws1/cl_ssmpatchfiltvallist_w( |string| ) )
          )
          iv_key = |string|
        )
      )
    )
  )
  it_approvedpatches = VALUE /aws1/cl_ssmpatchidlist_w=>tt_patchidlist(
    ( new /aws1/cl_ssmpatchidlist_w( |string| ) )
  )
  it_rejectedpatches = VALUE /aws1/cl_ssmpatchidlist_w=>tt_patchidlist(
    ( new /aws1/cl_ssmpatchidlist_w( |string| ) )
  )
  it_sources = VALUE /aws1/cl_ssmpatchsource=>tt_patchsourcelist(
    (
      new /aws1/cl_ssmpatchsource(
        it_products = VALUE /aws1/cl_ssmpatchsrcproductl00=>tt_patchsourceproductlist(
          ( new /aws1/cl_ssmpatchsrcproductl00( |string| ) )
        )
        iv_configuration = |string|
        iv_name = |string|
      )
    )
  )
  iv_approvedpatchescplnclevel = |string|
  iv_approvedpatchesenbnonsec = ABAP_TRUE
  iv_availablesecupdscplncstat = |string|
  iv_baselineid = |string|
  iv_description = |string|
  iv_name = |string|
  iv_rejectedpatchesaction = |string|
  iv_replace = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_baselineid = lo_result->get_baselineid( ).
  lv_baselinename = lo_result->get_name( ).
  lv_operatingsystem = lo_result->get_operatingsystem( ).
  lo_patchfiltergroup = lo_result->get_globalfilters( ).
  IF lo_patchfiltergroup IS NOT INITIAL.
    LOOP AT lo_patchfiltergroup->get_patchfilters( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_patchfilterkey = lo_row_1->get_key( ).
        LOOP AT lo_row_1->get_values( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_patchfiltervalue = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
  ENDIF.
  lo_patchrulegroup = lo_result->get_approvalrules( ).
  IF lo_patchrulegroup IS NOT INITIAL.
    LOOP AT lo_patchrulegroup->get_patchrules( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lo_patchfiltergroup = lo_row_5->get_patchfiltergroup( ).
        IF lo_patchfiltergroup IS NOT INITIAL.
          LOOP AT lo_patchfiltergroup->get_patchfilters( ) into lo_row.
            lo_row_1 = lo_row.
            IF lo_row_1 IS NOT INITIAL.
              lv_patchfilterkey = lo_row_1->get_key( ).
              LOOP AT lo_row_1->get_values( ) into lo_row_2.
                lo_row_3 = lo_row_2.
                IF lo_row_3 IS NOT INITIAL.
                  lv_patchfiltervalue = lo_row_3->get_value( ).
                ENDIF.
              ENDLOOP.
            ENDIF.
          ENDLOOP.
        ENDIF.
        lv_patchcompliancelevel = lo_row_5->get_compliancelevel( ).
        lv_approveafterdays = lo_row_5->get_approveafterdays( ).
        lv_patchstringdatetime = lo_row_5->get_approveuntildate( ).
        lv_boolean = lo_row_5->get_enablenonsecurity( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  LOOP AT lo_result->get_approvedpatches( ) into lo_row_6.
    lo_row_7 = lo_row_6.
    IF lo_row_7 IS NOT INITIAL.
      lv_patchid = lo_row_7->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_patchcompliancelevel = lo_result->get_approvedpatchescplncle00( ).
  lv_boolean = lo_result->get_approvedpatchesenbnonsec( ).
  LOOP AT lo_result->get_rejectedpatches( ) into lo_row_6.
    lo_row_7 = lo_row_6.
    IF lo_row_7 IS NOT INITIAL.
      lv_patchid = lo_row_7->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_patchaction = lo_result->get_rejectedpatchesaction( ).
  lv_datetime = lo_result->get_createddate( ).
  lv_datetime = lo_result->get_modifieddate( ).
  lv_baselinedescription = lo_result->get_description( ).
  LOOP AT lo_result->get_sources( ) into lo_row_8.
    lo_row_9 = lo_row_8.
    IF lo_row_9 IS NOT INITIAL.
      lv_patchsourcename = lo_row_9->get_name( ).
      LOOP AT lo_row_9->get_products( ) into lo_row_10.
        lo_row_11 = lo_row_10.
        IF lo_row_11 IS NOT INITIAL.
          lv_patchsourceproduct = lo_row_11->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_patchsourceconfiguratio = lo_row_9->get_configuration( ).
    ENDIF.
  ENDLOOP.
  lv_patchcompliancestatus = lo_result->get_availablesecupdscplncs00( ).
ENDIF.