跳至主内容

updatePatchManagementMaintenanceWindow

此方法用于修改补丁管理维护时段。

参数

参数

描述

包含在请求中

类型

取值

name

要分配给补丁管理窗口的名称。

必填

字符串

可选值:

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

  • 必须唯一。

allowChangeByOtherUsers

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

必填

布尔值

无额外要求。

settings

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

必填

对象数组

参考???

对象

downloadSettings

参数

描述

类型

cachingServers

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

对象数组

包含以下信息:

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

fallbackOnDirectDownload

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

布尔值

无额外要求。

installPatchesSettings

参数

描述

类型

enabled

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

布尔值

无额外要求。

ifMissedRunAsSoonAsPossible

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

布尔值

无额外要求。

specificVendorAndProduct

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

对象

包含以下信息:

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

    类型:布尔值

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

    类型:整数

    可能取值:

    • 1 - 表示包含,

      2 - 表示排除。

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

    类型:对象数组

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

postponeReboot

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

对象

包含以下信息:

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

    类型:整数

    可能的值:

    • 0 - 用户可以推迟系统重启至更合适的时间。

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

      如果分配此值,则 afterMinutes , afterCustomMessagebetween 属性也必须包含在请求中。

    • 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 值。

      更多信息请参考 scheduler .

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

      类型:对象

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

      • enabled 参数在 securityPatchesSettings 对象中具有 true 值。

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

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

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

      更多信息请参阅 oldScheduler .

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

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

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

      类型:对象

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

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

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

      在以下情况下将忽略此参数:

      • useSameScheduler 参数位于 scanPatchesSettings 对象中的 true 值。

      更多信息请参阅 scheduler .

    • 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列表。

警告

  • 如果 启用 参数位于 installPatchesSettings 对象中且被赋值为 true 则需要将 true 值赋给以下任一参数:

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

    • 位于 启用 参数下的 nonSecurityPatchesSettings 选项。这些参数可在 updateType 对象下找到,该对象位于 installPatchesSettings 对象内。

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

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

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

  • 如果 enabled 参数在 installPatchesSettings 对象若已分配 true 值,则 enabled 参数在 scanPatchesSettings 对象下也必须被赋予 true 值。

vendorProductsPairs

参数

描述

类型

取值

os

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

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

整数

可选值:

  • 1 - Windows

  • 2 - Linux

  • 3 - macOS

默认值:

  • 1 (当 id 属于该 供应商 对象的属性仅包含数字。

  • 2 ,如果该 ID 属于 供应商 对象的属性包含字母。

重要提示

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

供应商

包含一个或多个供应商。

对象

该对象包含以下属性:

  • ID - 供应商的ID。

    类型:字符串。

产品

包含一个或多个产品

对象数组

该对象包含以下属性:

  • ID - 产品的ID。

    类型:字符串。

介于

参数

描述

类型

起始小时

事件设定的开始小时。

整数

取值范围为 023 .

起始分钟

事件设定的开始分钟。

整数

取值范围为 059 .

结束小时

事件设定的结束小时。

整数

取值范围为 起始小时23 .

结束分钟

事件设定的结束分钟。

整数

取值范围为 059 .

注意

startHour:startMinute 必须小于 endHour:endMinute

调度器

参数

描述

类型

取值

recurrence

设置特定任务的执行频率

整型

可选值:

  • 1 - 立即执行。

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

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

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

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

    monthlyRecurrence 参数。

startDate

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

整数

必须大于 0 .

介于

设置运行任务的时间间隔

对象

更多信息请参阅???。

weeklyRecurrence

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

该参数仅在 recurrence 设置为 3 .

对象

包含以下信息:

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

    类型:整数

    可选值: 1 - 4 .

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

    类型:整数数组

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

monthlyRecurrence

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

该参数仅在 recurrence 设置为 4 .

对象

包含以下信息:

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

    类型:整数

    可选值: 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 (周六)。

旧调度器

参数

描述

类型

取值

重复频率

设置任务运行的频率

整数

可选值:

  • 1 - 立即执行

  • 2 - 每日

  • 3 - 每周

起始小时

事件设定的开始小时数

整数

可选值: 0 - 23 .

起始分钟

事件设定的开始分钟数

整数

可选值: 0 - 59 .

设置任务在每周的特定星期几重复执行。

整数数组

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

scanPatchesSettings

参数

描述

类型

enabled

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

布尔值

无额外要求。

runOnSystemChanges

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

布尔值

无额外要求。

useFallbackSchedule

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

String

可选值:

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

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

useSameSchedule

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

Boolean

无额外要求。

scheduler

设置特定计划。

对象

包含以下信息

  • 重复周期 - 整数,设置特定任务的频率。可取值如下:

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

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

  • 开始日期 - 整数,若选择当日则表示为当前纪元时间(10位字符,秒级精度)。该值应大于 0 .

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

    • 起始小时 - 整数,介于 023

    • 起始分钟 - 整数,介于 059

    • 结束小时 - 整数,介于 起始小时23

    • 结束分钟 - 整数,介于 059

      注意

      起始小时:起始分钟 必须小于 结束小时:结束分钟

  • 每周重复 - 对象,当 重复模式 = 3 时必填。包含组件:

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

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

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

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

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

      • 0 - 在特定日期运行

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

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

      • 3 - 在每月的第三个 frequencyDayOfWeek 运行。

      • 4 - 在每月的第四个 星期几 运行。

      • 5 - 在每月的最后一个 星期几 运行。

        注意

        如果 频率 值为 0 ,则 每月重复 对象还必须包含 每月第几天 。如果 频率 值为 1 , 2 , 3 , 45 ,则 每月重复 对象还必须包含 frequencyDayOfWeek .

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

    • frequencyDayOfWeek 整数,表示任务将在每周的第几天运行。取值范围在 06 之间,其中0代表 周日 ,6代表 周六 .

注意

enabled = trueuseFallbackSchedule = false .

oldScheduler

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

对象

包含以下信息:

  • 重复周期 - 整数,设置任务运行的频率。可选用以下值之一:

    • 2 - 表示每日

    • 3 - 表示每周

  • 起始小时 - 整数。取值范围在 023 .

  • 起始分钟 - 整数。取值范围在 059 .

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

    注意

    启用则必须包含 = true 。若 recurrence = 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
   }
}