跳转到主要内容

createPatchManagementMaintenanceWindow

此方法创建可用于补丁管理的维护窗口。

参数

参数

描述

包含于请求中

类型

取值

名称

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

必填

字符串

可选值：

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

  • 必须唯一。

允许其他用户修改

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

必填

布尔值

无额外要求。

设置

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

必填

对象数组

参见 对象

对象

下载设置

参数

描述

类型

值

cachingServers

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

对象数组

包含以下信息：

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

fallbackOnDirectDownload

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

布尔值

无额外要求。

installPatchesSettings

参数

描述

类型

值

enabled

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

布尔值

无额外要求。

ifMissedRunAsSoonAsPossible

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

布尔值

无额外要求。

specificVendorAndProduct

指定要包含或排除在补丁应用范围内的供应商和产品。

对象

包含以下信息：

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

    类型：布尔值

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

    类型：整数

    可能的值：

    • 1 - 表示包含，

      2 - 表示排除。

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

    类型：对象数组

    更多信息，请参考 供应商产品对 .

推迟重启

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

对象

包含以下信息：

  • 选项 - 指示如何推迟重启。

    类型：整数

    可能的值：

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

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

      若分配此值，则请求中必须同时包含 afterMinutes , afterCustomMessage 及 between 属性。

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

      若分配此值，则请求中必须同时包含 afterMinutes 和 afterCustomMessage 属性。

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

    类型：整数

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

  • afterCustomMessage - 将在发生重启的端点上显示的文本。

    类型：字符串

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

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

    类型：对象

    更多信息，请参阅???。

updateType

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

对象

包含以下信息：

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

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

    • scheduler - 设置特定计划。

      类型：对象

      在以下情况下，此参数必须包含在对象中：

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

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

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

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

      更多信息请参阅???。

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

      类型：对象

      该参数必须包含在对象中，当：

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

      • 若 useSameScheduler 参数在 scanPatchesSettings 对象的 false 值。

      以下情况将忽略此参数：

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

      更多信息请参阅???。

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

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

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

      类型：对象

      以下情况必须包含此参数：

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

      • 若 useSameScheduler scanPatchesSettings对象下的 scanPatchesSettings 对象中的 false 值。

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

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

      更多信息请参阅???。

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

      类型：对象

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

      • 若 enabled 参数位于 nonSecurityPatchesSettings 对象中且值为 true 。

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

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

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

      更多信息请参阅???。

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

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

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

      类型：对象

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

      • 若 enabled 参数位于 securityPatchesSettings 对象中且值为 false 。

      • 若 useSameScheduler 参数位于 scanPatchesSettings 对象具有 false 值。

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

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

      更多信息请参阅 调度器 .

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

      类型：对象

      该参数必须包含在对象中，当满足以下条件时：

      • 若 enabled 参数位于 securityPatchesSettings 对象下且值为 false 。

      • 若 useSameScheduler 参数位于 scanPatchesSettings 对象下且值为 false 值。

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

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

      更多信息请参阅???。

    注意

    若 enabled 参数在 securityPatchesSettings 对象中设置为 true ，则 scheduler 与 oldScheduler 设置在 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 值：

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

    • 位于 nonSecurityPatchesSettings 选项下的 enabled 参数。这些参数可在 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-product组合兼容。使用无效组合将导致错误。

vendor

包含一个或多个供应商。

对象

该对象包含以下属性：

  • id - 供应商的ID。

    类型：字符串。

products

包含一个或多个产品

对象数组

该对象包含以下属性：

  • id - 产品的ID。

    类型：字符串。

介于

参数

描述

类型

取值

startHour

事件设定的开始小时。

整数

取值范围为 0 至 23 .

startMinute

事件设定的开始分钟。

整数

取值范围为 0 至 59 .

endHour

事件设定的结束小时。

整数

取值范围为 startHour 至 23 .

endminute

事件设定的结束分钟。

整数

其取值范围在 0 到 59 .

注意

startHour:startMinute 必须小于 endHour:endMinute

调度器

参数

描述

类型

取值

重复规则

设置特定任务的执行频率

整数

可选值：

  • 1 - 立即执行。

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

    若选择该值，则对象必须包含 weeklyRecurrence 参数。

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

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

    monthlyRecurrence 参数。

startDate

当选择当前日期时，表示当前纪元时间（10位字符，秒级精度）。

整数

必须为大于 0 .

between

设置任务运行的时间间隔

对象

更多信息请参阅 between .

weeklyRecurrence

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

该参数仅在 recurrence 设置为 3 .

对象

包含以下信息：

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

    类型：整数

    可选值： 1 - 4 .

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

    类型：整数数组

    可选值： 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 , 4 或 5 时，该对象必须包含 frequencyDayOfWeek 参数。

  • frequencyDayNumber - 表示任务将在当月第几天执行。

    类型：整数

    可选值： 1 - 31

  • frequencyDayOfWeek - 表示任务将在周几执行。

    类型：整数

    可选值： 0 （周日）- 6 （周六）。

旧调度器

参数

描述

类型

值

重复频率

设置任务运行的频率

整数

可选值：

  • 1 - 表示立即执行

  • 2 - 表示每天

  • 3 - 表示每周

开始小时

事件设定的开始小时。

整数

可选值： 0 - 23 .

开始分钟

事件设定的开始分钟数。

整数

可选值： 0 - 59 .

天数

设置任务在每周特定日期重复执行。

整数数组

可选值： 0 （周日）- 6 （周六）。

扫描补丁设置

参数

描述

类型

值

启用

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

布尔值

无额外要求。

系统变更时运行

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

布尔值

无额外要求

useFallbackSchedule

在当前调度系统( schedule )与备用系统( oldScheduler ).

字符串

可选值:

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

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

useSameSchedule

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

布尔值

无额外要求。

调度器

设置特定计划。

对象

包含以下信息

  • 重复周期 - 整数，设置特定任务的执行频率。可选值包括：

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

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

  • startDate - 整数，若选择当前日期则表示当前纪元时间（10位字符，秒级精度）。该值应大于 0 .

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

    • startHour - 整数，取值范围 0 至 23

    • startMinute - 整数，介于 0 与 59

    • endHour - 整数，介于 startHour 与 23

    • endMinute - 整数，介于 0 与 59

      注意

      startHour:startMinute 必须小于 endHour:endMinute

  • weeklyRecurrence - 对象，当 recurrence = 3 时为必填项。包含以下组件：

    • every - 整数，取值范围介于 1 与 4 之间。用于设置任务执行的时间间隔，以周为单位。

    • 天 - 整型数组，取值范围在 0 到 6 之间（0表示周日，6表示周六）。设置任务在一周中的特定日期重复执行。

  • monthlyRecurrence - 对象，当 recurrence = 4 时必填。包含以下组件：

    • every - 整型，取值范围在 1 到 12 之间。设置任务之间的时间间隔，以月为单位。

    • frequency - 整型，设置重复任务的频率。可选值如下：

      • 0 - 在特定日期运行

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

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

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

      • 4 - 在每月的第四个 frequencyDayOfWeek 运行。

      • 5 - 在每月的最后一个 frequencyDayOfWeek 运行。

        注意

        如果 frequency 的值为 0 ，则 monthlyRecurrence 对象还必须包含 frequencyDayNumber 。如果 frequency 的值为 1 , 2 , 3 , 4 或 5 时， monthlyRecurrence 对象还必须包含 frequencyDayOfWeek .

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

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

注意

当 enabled = true 且 useFallbackSchedule = false .

oldScheduler

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

Object

包含以下信息：

  • recurrence - 整数，设置任务运行的频率。可取值如下：

    • 2 - 表示每日

    • 3 - 表示每周

  • startHour - 整数。取值范围在 0 至 23 .

  • startMinute - 整数。取值范围在 0 至 59 .

  • days - 整数数组，取值范围在 0 至 6 (0表示周日，6表示周六)。设置任务在每周特定日期重复执行。

    注意

    当 启用 = true 时必须包含此参数。若 重复模式 = 2 .

返回值

本方法返回布尔值true或false，表示维护窗口是否创建成功。

示例

请求 : 

{
  "方法": "创建补丁管理维护窗口",
  "请求ID": "a7f1d11d-3c94-47f0-a599-b48d2fc44241",
  "jsonrpc版本": "2.0",
  "参数": {
    "名称": "QXPzQWvgtqtI4FlCRSU9z",
    "允许其他用户修改": true,
    "设置": {
      "下载设置": {
        "缓存服务器": [],
        "直连下载回退": 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": "6196964afb457113d33fb25e"
  }
}

响应 : 

{
   "请求ID" : "a7f1d11d-3c94-47f0-a599-b48d2fc44241",
   "jsonrpc版本" : "2.0",
   "结果" : {
      "数据" : [
         "61969696af703331ad53a948"
      ],
      "成功" : true
   }
}
本节内容 :