跳至主要内容

更新补丁管理维护窗口

此方法用于修改补丁管理的维护窗口。

参数

参数

描述

包含于请求中

类型

取值

名称

您希望为补丁管理窗口指定的名称。

必填

字符串

可选值:

  • 长度必须介于1至80个字符之间。

  • 必须保持唯一性。

允许其他用户修改

指示目标是否为客户公司。

必填

布尔值

无附加要求。

设置

使用此数组为您正在创建的维护窗口配置补丁管理设置。

必填

对象数组

参见???

对象

下载设置

参数

描述

类型

取值

cachingServers

用于指定要使用的补丁缓存服务器。数组中的位置应被解释为优先级。

对象数组

包含以下信息:

  • id - 字符串,补丁缓存服务器的ID。

fallbackOnDirectDownload

确定是否启用直接下载设置。

布尔值

无额外要求。

installPatchesSettings

参数

描述

类型

enabled

指示启用时是否自动应用补丁。对应 应用补丁 开关在 GravityZone 控制台中。

布尔值

无额外要求。

ifMissedRunAsSoonAsPossible

指示如果任务未执行,将尽快重试。

布尔值

无额外要求。

specificVendorAndProduct

指定您希望包含或排除在补丁应用范围之外的供应商和产品。

对象

包含以下信息:

  • enabled - 表示是否允许包含或排除。

    类型:布尔值

  • type - 选择是包含还是排除供应商或产品不进行补丁。

    类型:整数

    可能的值:

    • 1 - 表示包含,

      2 - 表示排除。

  • vendorProductsPairs - 用于选择产品和供应商。

    类型:对象数组

    更多信息,请参考???。

postponeReboot

指示是否希望在应用补丁后推迟系统重启。

Object

包含以下信息:

  • option - 指示如何推迟重启。

    类型:整数

    可能的值:

    • 0 - 用户可以推迟系统重启直到更方便的时间。

    • 1 - 用户只能在特定时间间隔内推迟系统重启。

      如果分配了此值,则 afterMinutes , afterCustomMessage ,以及 介于 属性也必须包含在请求中。

    • 2 - 系统将在指定分钟数后自动重启。若选择此选项, postponeReboot 对象还必须包含: afterMinutes , afterCustomMessage .

      若分配此值,则 afterMinutesafterCustomMessage 属性也必须包含在请求中。

  • afterMinutes - 延迟重启的分钟数。

    类型:整数

    可选值: 10 , 30 , 45 , 60 .

  • afterCustomMessage - 在即将重启的终端上显示的文本。

    类型:字符串

    可能值:最多128个字符的任意字符串。

  • between - 重启发生的时间间隔。

    类型:对象

    更多信息,请参考 between .

updateType

用于启用并将特定设置应用于安全或非安全更新。

对象

包含以下信息:

  • securityPatchesSettings - 启用并配置安全补丁。

    • enabled - 布尔值,启用安全补丁的使用。

    • scheduler - 设置特定的计划。

      类型:对象

      在以下情况下必须包含此参数:

      • 如果 enabled 参数在 securityPatchesSettings 对象中的值为 true

      • 如果 useSameScheduler 参数在 scanPatchesSettings 对象下具有 false 值。

      该参数将在以下情况下被忽略:

      • useSameScheduler 参数在 scanPatchesSettings 对象下具有 true 值时。

      更多信息请参阅 调度器 .

    • oldScheduler - 使用备用系统设置特定调度方案。

      类型:对象

      该参数在以下情况下必须包含在对象中:

      • 如果 enabled 参数在 securityPatchesSettings 对象下具有 true 值。

      • 如果 useSameScheduler scanPatchesSettings对象下的 scanPatchesSettings 对象中的 false 值。

      在以下情况下该参数将被忽略:

      • useSameScheduler 参数在 scanPatchesSettings 对象中具有 true 值时。

      更多信息请参阅 oldScheduler .

  • nonSecurityPatchesSettings - 启用并配置非安全补丁。

    • enabled - 布尔值,启用非安全补丁功能。

    • scheduler - 设置特定调度计划。

      类型:对象

      在以下情况下必须包含此参数:

      • 如果 enabled 参数在 nonSecurityPatchesSettings 对象中为 true 值。

      • 如果 useSameScheduler 参数在 scanPatchesSettings 对象中具有 false 值。

      该参数将在以下情况下被忽略:

      • useSameScheduler 参数在 scanPatchesSettings 对象中具有 true 值时。

      更多信息请参阅 调度器 .

    • oldScheduler - 使用备用系统设置特定调度。

      类型:对象

      在以下情况下必须包含此参数:

      • 如果 enabled 参数在 nonSecurityPatchesSettings 对象中具有 true 值。

      • 如果 useSameScheduler 参数位于 scanPatchesSettings 对象下且值为 false

      在以下情况下该参数将被忽略:

      • useSameScheduler 参数位于 scanPatchesSettings 对象下且值为 true

      更多信息请参阅 oldScheduler .

  • manuallyApprovedPatchesSettings - 启用并配置手动批准的补丁。

    • enabled - 布尔值,启用手动批准补丁功能。

    • scheduler - 设置特定调度计划。

      类型:对象

      在以下情况下必须包含此参数:

      • 如果 enabled 参数位于 securityPatchesSettings 对象的 false 值。

      • 如果 useSameScheduler 参数在 scanPatchesSettings 对象中具有 false 值。

      该参数将在以下情况下被忽略:

      • useSameScheduler 参数在 scanPatchesSettings 对象中为 true 值时。

      更多信息请参阅???。

    • oldScheduler - 使用备用系统设置特定计划。

      类型:对象

      该参数必须包含在对象中,如果:

      • enabled 参数在 securityPatchesSettings 对象中为 false 值。

      • 如果 useSameScheduler 参数位于 scanPatchesSettings 对象中且值为 false

      在以下情况下该参数将被忽略:

      • useSameScheduler 参数位于 scanPatchesSettings 对象中且值为 true

      更多信息请参阅 oldScheduler .

    注意

    enabled 参数位于 securityPatchesSettings 对象中且值为 true ,则 scheduleroldScheduler 设置位于 manuallyApprovedPatchesSettings 将被忽略。

    如果 enabled 参数位于 securityPatchesSettings 对象内且 useFallbackSchedule 设置位于 scanPatchesSettings 参数中两者均为 false 值,则必须 在请求中包含 scheduler manuallyApprovedPatchesSettings 的设置。

    enabled 参数在 securityPatchesSettings 对象中为 false 值,且 useFallbackSchedule 设置位于 manuallyApprovedPatchesSettings 中为 true 值,则 oldScheduler 设置项位于 manuallyApprovedPatchesSettings 必须包含在请求中。

manuallyApprovedPatchIds

唯一补丁ID列表。

字符串数组

补丁ID必须有效且属于创建维护窗口的公司。

提示

您可以使用 getManuallyApprovedPatches 方法获取特定公司的手动补丁ID列表。

警告

  • enabled 参数位于 installPatchesSettings 对象中且赋值为 true 则需将以下任一参数赋值为 true

    • 位于 enabled 参数下的 securityPatchesSettings 选项。这些参数可在 updateType 对象下找到,该对象位于 installPatchesSettings 对象。

    • 位于 enabled 参数下的 nonSecurityPatchesSettings 选项。它们可以在 updateType 对象下找到,该对象位于 installPatchesSettings 对象下。

  • 如果 enabled 参数在 installPatchesSettings 对象中被赋值为 false ,则需要确保以下参数均未赋值为 true

    • 位于 enabled 参数下的 securityPatchesSettings 选项。它们可以在 updateType 对象下找到,该对象位于 installPatchesSettings 对象下。

    • 位于 enabled 参数位于 nonSecurityPatchesSettings 选项下。它们可以在 updateType 对象中找到,该对象位于 installPatchesSettings 对象下。

  • 如果 enabled 参数在 installPatchesSettings 对象中被赋值为 true ,则 enabled 参数在 scanPatchesSettings 对象中也必须被赋值为 true

vendorProductsPairs

参数

描述

类型

os

供应商-产品对兼容的操作系统。

当特定供应商-产品对兼容多个操作系统时,可使用此属性。

整数

可能取值:

  • 1 - Windows

  • 2 - Linux

  • 3 - macOS

默认值:

  • 1 (当 id 属性所属的 vendor 对象仅包含数字时)

  • 2 (当 id 属性所属的 vendor 对象包含字母时)

重要提示

提供给此属性的值必须与请求中指定的供应商-产品对兼容。使用无效组合将导致错误。

vendor

包含一个或多个供应商。

对象

该对象包含以下属性:

  • id - 供应商的ID。

    类型:字符串。

products

包含一个或多个产品

对象数组

该对象包含以下属性:

  • id - 产品的ID。

    类型:字符串。

介于

参数

描述

类型

取值范围

startHour

事件设定的开始小时。

整数

取值范围为 023 .

startMinute

事件设定的开始分钟。

整数

取值范围为 059 .

endHour

事件设定的结束小时。

整数

取值范围为 startHour23 .

endminute

事件设定的结束分钟数。

整数

取值范围在 059 .

注意

startHour:startMinute 必须小于 endHour:endMinute

scheduler

参数

描述

类型

取值

recurrence

设置特定任务的执行频率

整数

可选值:

  • 1 - 立即执行。

  • 3 - 每周执行。此时必须同时包含 weeklyRecurrence 对象。

    若赋值此参数,则该对象必须同时包含 weeklyRecurrence 参数。

  • 4 - 每月。此时必须同时包含 monthlyRecurrence 对象。

    若选择此值,则该对象必须同时包含

    monthlyRecurrence 参数。

startDate

当选择当日时,表示当前纪元时间(10位字符,秒级精度)。

整数

必须为大于 0 .

between

设置任务运行的时间间隔

对象

更多信息请参阅???。

weeklyRecurrence

决定每周任务的执行频率。

该参数仅在 recurrence 设为 3 .

对象

包含以下信息:

  • - 设置任务运行之间的时间间隔,以周为单位。

    类型:整数

    可选值: 1 - 4 .

  • 天数 - 设置任务在一周中的特定某天重复执行。

    类型:整数数组

    可选值: 0 (周日) - 6 (周六)。

monthlyRecurrence

决定月度任务的重复频率。

此参数仅在 recurrence 设置为 4 .

对象

包含以下信息:

  • - 设置任务之间的时间间隔,以月为单位。

    类型:整数

    可选值: 1 - 12 .

  • frequency - 设置重复任务的执行频率。

    类型:整数

    可选值:

    • 0 - 在每月的特定日期执行。

      若选择此值,对象必须包含 frequencyDayNumber 参数。

      注意

      frequency 值为 0 ,则 monthlyRecurrence 对象

    • 1 - 在每月的第一个 frequencyDayOfWeek 执行。

    • 2 - 在每月的第二个 frequencyDayOfWeek 执行。

    • 3 - 在每月的第三个 frequencyDayOfWeek 当月的星期几。

    • 4 - 在第四个 frequencyDayOfWeek 当月的星期几。

    • 5 - 在最后一个 frequencyDayOfWeek 当月的星期几。

      注意

      如果 frequency 的值为 1 , 2 , 3 , 45 ,则该对象必须包含 frequencyDayOfWeek 参数。

  • frequencyDayNumber - 表示任务将在当月的哪一天运行。

    类型:整数

    可能取值: 1 - 31

  • frequencyDayOfWeek - 表示任务在一周中的哪一天运行。

    类型:整数

    可能取值: 0 (周日) - 6 (周六)。

oldScheduler

参数

描述

类型

取值

recurrence

设置任务运行的频率

整数

可能取值:

  • 1 - 立即执行

  • 2 - 每日

  • 3 - 每周

startHour

事件设定的开始小时数。

整数

可能取值: 0 - 23 .

startMinute

事件设定的开始分钟数。

整数

可选值: 0 - 59 .

days

设置任务在一周中的特定日期重复执行。

整数数组

可选值: 0 (周日)- 6 (周六)。

scanPatchesSettings

参数

描述

类型

enabled

指示是否自动扫描以搜索新补丁。对应 扫描补丁 开关位于 GravityZone 控制台。

布尔值

无额外要求。

runOnSystemChanges

表示在安装新支持的应用程序时是否扫描可用补丁。对应 安装新应用程序时智能扫描补丁 开关位于 GravityZone 控制台。

布尔值

无额外要求。

useFallbackSchedule

在当前计划系统( schedule )与备用系统( oldScheduler ).

字符串

可选值:

  • enabled - 必须将 oldScheduler 参数包含在 installPatchesSettings .

  • disabled - 必须将 scheduler 参数包含在 installPatchesSettings .

useSameSchedule

将此计划设为所有任务的默认计划。对应 对所有目标操作使用相同计划 开关位于 GravityZone 控制台中。

布尔值

无额外要求。

scheduler

设置特定计划。

对象

包含以下信息

  • recurrence - 整数,设置特定任务的执行频率。可选值包括:

    • 3 - 每周。此时必须同时包含 weeklyRecurrence 对象。

    • 4 - 每月。此时必须同时包含 monthlyRecurrence 对象。

  • startDate - 整数,若选择当天则显示当前纪元时间(10位字符,秒级精度)。该值应大于 0 .

  • between - 对象,设置任务运行的时间间隔。包含组件:

    • startHour - 整数,介于 023

    • startMinute - 整数,介于 059

    • endHour - 整数,介于 startHour23

    • endMinute - 整数,介于 059

      注意

      startHour:startMinute 必须小于 endHour:endMinute

  • weeklyRecurrence - 对象,当 recurrence = 3 。包含组件:

    • every - 整数,取值范围介于 14 之间。设置任务运行的时间间隔,以周为单位计量。

    • days - 整数数组,取值范围介于 06 之间(0为周日,6为周六)。设置任务在一周中的特定日期重复执行。

  • monthlyRecurrence - 对象,当 recurrence = 4 时为必填项。组件包括:

    • every - 整数,取值范围介于 112 之间。设置任务之间的时间间隔,以月为单位计量。

    • frequency - 整数,设置重复任务的频率。可选值如下:

      • 0 - 在特定日期运行

      • 1 - 在每月第 frequencyDayOfWeek 当月第1个

      • 2 - 在第二个 frequencyDayOfWeek 当月第2个

      • 3 - 在第三个 frequencyDayOfWeek 当月第3个

      • 4 - 在第四个 frequencyDayOfWeek 当月第4个

      • 5 - 在最后一个 frequencyDayOfWeek 当月最后一个

        注意

        frequency 值为 0 时, monthlyRecurrence 对象必须同时包含 frequencyDayNumber 。若 frequency 值为 1 , 2 , 3 , 45 时, monthlyRecurrence 对象还必须包含 frequencyDayOfWeek .

    • frequencyDayNumber - 整数,表示任务将在当月的第几天运行。取值范围为 131 .

    • frequencyDayOfWeek 整数,表示任务将在星期几运行。取值范围为 06 ,其中0代表 周日 ,6代表 周六 .

注意

若启用则必须包含 enabled = trueuseFallbackSchedule = false .

oldScheduler

使用备用系统设置特定计划。

Object

包含以下信息:

  • recurrence - 整数,设定任务运行频率。可取值如下:

    • 2 - 表示每日

    • 3 - 表示每周

  • startHour - 整数。取值范围在 023 .

  • startMinute - 整数。取值范围在 059 .

  • - 整型数组,取值范围在 06 之间(0代表周日,6代表周六)。设置任务在每周特定日期重复执行。

    注意

    启用 = true 则必须包含此项。若 重复模式 = 2 .

返回值

此方法返回true或false,表示维护窗口是否成功更新。

示例

请求 :

{
  "方法": "updatePatchManagementMaintenanceWindow",
  "ID": "a7f1d11d-3c94-47f0-a599-b48d2fc44241",
  "jsonrpc": "2.0",
  "参数": {
    "ID": "61974ab63bdfe97a6c34fe4d",
    "设置": {
      "下载设置": {
        "缓存服务器": [
          
        ],
        "直连下载回退": true
      },
      "安装补丁设置": {
        "启用": true,
        "若错过则尽快运行": true,
        "特定厂商与产品": {
          "类型": 1,
          "启用": false,
          "厂商产品配对": [
                        {
                            "操作系统": 3, 
                            "厂商": {
                                "ID": "Oracle"
                            },
                            "产品": [
                                {
                                    "ID": "java-11-openjdk 11"
                                },
                                {
                                    "ID": "java-1.8.0-openjdk"
                                }
                            ]
                        },
                        {
                            "厂商": {
                                "ID": "Inkscape"
                            },
                            "产品": [
                                {
                                    "ID": "0"
                                }
                            ]
                        },
                        {
                            "厂商": {
                                "ID": "65"
                            },
                            "产品": [
                                {
                                    "ID": "15694"
                                }
                            ]
                        }         
          ]
        },
        "延迟重启": {
          "选项": 0
        },
        "更新类型": {
          "非安全补丁设置": {
            "启用": true,
            "调度器": {
              "重复模式": 3,
              "开始日期": 1637258826,
              "时段": {
                "起始小时": 21,
                "起始分钟": 0,
                "结束小时": 23,
                "结束分钟": 59
              },
              "每周重复": {
                "间隔": 1,
                "天数": [
                  1,
                  2,
                  3,
                  4,
                  5,
                  6,
                  0
                ]
              }
            },
          },
          "安全补丁设置": {
            "启用": true,
            "调度器": {
              "重复模式": 1
            },
          "手动批准补丁设置": {
            "启用": true,
            "调度器": {
            "重复模式": 1
            }
          }
        }
        "手动批准补丁ID": [
          "{00016C6E-0000-0000-0000-000000000000}",
          "{0001354A-0000-0000-0000-000000000000}"
        ]
      },
      "扫描补丁设置": {
        "启用": true,
        "使用相同计划": false,
        "使用备用计划": true,
        "系统变更时运行": true,
        "调度器": {
          "重复模式": 3,
          "开始日期": 1637258826,
          "时段": {
            "起始小时": 21,
            "起始分钟": 0,
            "结束小时": 23,
            "结束分钟": 59
          },
          "每周重复": {
            "间隔": 1,
            "天数": [
              1,
              2,
              3,
              4,
              5,
              6,
              0
            ]
          }
        },
      }
    }
  }
}

响应 :

{
   "ID" : "a7f1d11d-3c94-47f0-a599-b48d2fc44241",
   "jsonrpc" : "2.0",
   "结果" : {
      "成功" : true
   }
}