Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

describe-instance-patch-states-for-patch-group

Описание

Получает состояние патчей высокого уровня для управляемых узлов в указанной группе патчей.

См. также: Документация API AWS

describe-instance-patch-states-for-patch-group это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: InstancePatchStates

Синтаксис

  describe-instance-patch-states-for-patch-group
--patch-group <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--patch-group (строка)

Имя группы патчей, для которой необходимо получить информацию о состоянии патчей.

--filters (список)

Каждый элемент массива — это структура, содержащая:

  • Ключ (строка длиной от 1 до 200 символов)
  • Значения (массив, содержащий одну строку)
  • Тип (строка “Equal”, “NotEqual”, “LessThan”, “GreaterThan”)

(структура)

Определяет фильтр, используемый в DescribeInstancePatchStatesForPatchGroup для сужения информации, возвращаемой API.

Пример: Чтобы отфильтровать все управляемые узлы в группе патчей, имеющие более трех патчей со статусом FailedCount, используйте следующие параметры фильтра:
  • Значение для Key : FailedCount
  • Значение для Type : GreaterThan
  • Значение для Values : 3

Ключ -> (строка)

Ключ фильтра. Допустимые значения включают:

  • InstalledCount
  • InstalledOtherCount
  • InstalledPendingRebootCount
  • InstalledRejectedCount
  • MissingCount
  • FailedCount
  • UnreportedNotApplicableCount
  • NotApplicableCount

Значения -> (список)

Значение для фильтра. Должно быть целым числом, больше или равным 0.

(строка)

Тип -> (строка)

Тип сравнения, который должен быть выполнен для значения.

Упрощённый синтаксис:

Key=string,Values=string,string,Type=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Values": ["string", ...],
    "Type": "Equal"|"NotEqual"|"LessThan"|"GreaterThan"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, указанному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, значения этих аргументов перепишут значения, указанные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания места начала постраничной обработки. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS CLI.

--page-size (целое число)

Размер каждой страницы для получения данных в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, возвращающих меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно валидирует входные данные команды и возвращает пример JSON-вывода для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию для команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную обработку. Если автоматическая постраничная обработка отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла параметров.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Показать версию этого инструмента.

--color (строка)

Включить/выключить вывод цвета.

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Сборник сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить постраничный вывод для CLI.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запрошенное ввод параметров CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, у вас должен быть установлен и настроен AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

За исключением случаев, когда указано иное, во всех примерах используются правила цитирования, похожие на UNIX. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Подробнее см. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Пример 1: Получение состояний экземпляров для группы патчей

Следующий describe-instance-patch-states-for-patch-group пример получает подробности о состояниях сводного обзора патчей на экземпляр для указанной группы патчей.

aws ssm describe-instance-patch-states-for-patch-group \
    --patch-group "Production"

Вывод:

{
    "InstancePatchStates": [
        {
            "InstanceId": "i-02573cafcfEXAMPLE",
            "PatchGroup": "Production",
            "BaselineId": "pb-0c10e65780EXAMPLE",
            "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE",
            "OwnerInformation": "",
            "InstalledCount": 32,
            "InstalledOtherCount": 1,
            "InstalledPendingRebootCount": 0,
            "InstalledRejectedCount": 0,
            "MissingCount": 2,
            "FailedCount": 0,
            "UnreportedNotApplicableCount": 2671,
            "NotApplicableCount": 400,
            "OperationStartTime": "2021-08-04T11:03:50.590000-07:00",
            "OperationEndTime": "2021-08-04T11:04:21.555000-07:00",
            "Operation": "Scan",
            "RebootOption": "NoReboot",
            "CriticalNonCompliantCount": 0,
            "SecurityNonCompliantCount": 1,
            "OtherNonCompliantCount": 0
        },
        {
            "InstanceId": "i-0471e04240EXAMPLE",
            "PatchGroup": "Production",
            "BaselineId": "pb-09ca3fb51fEXAMPLE",
            "SnapshotId": "05d8ffb0-1bbe-4812-ba2d-d9b7bEXAMPLE",
            "OwnerInformation": "",
            "InstalledCount": 32,
            "InstalledOtherCount": 1,
            "InstalledPendingRebootCount": 0,
            "InstalledRejectedCount": 0,
            "MissingCount": 2,
            "FailedCount": 0,
            "UnreportedNotApplicableCount": 2671,
            "NotApplicableCount": 400,
            "OperationStartTime": "2021-08-04T22:06:20.340000-07:00",
            "OperationEndTime": "2021-08-04T22:07:11.220000-07:00",
            "Operation": "Scan",
            "RebootOption": "NoReboot",
            "CriticalNonCompliantCount": 0,
            "SecurityNonCompliantCount": 1,
            "OtherNonCompliantCount": 0
        }
    ]
}

Пример 2: Получение состояний экземпляров для группы патчей с более чем пятью отсутствующими патчами

Следующий describe-instance-patch-states-for-patch-group пример получает подробности о состояниях сводного обзора патчей для указанной группы патчей для экземпляров с более чем пятью отсутствующими патчами.

aws ssm describe-instance-patch-states-for-patch-group \
    --filters Key=MissingCount,Type=GreaterThan,Values=5 \
    --patch-group "Production"

Вывод:

{
    "InstancePatchStates": [
        {
            "InstanceId": "i-02573cafcfEXAMPLE",
            "PatchGroup": "Production",
            "BaselineId": "pb-0c10e65780EXAMPLE",
            "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE",
            "OwnerInformation": "",
            "InstalledCount": 46,
            "InstalledOtherCount": 4,
            "InstalledPendingRebootCount": 1,
            "InstalledRejectedCount": 1,
            "MissingCount": 7,
            "FailedCount": 0,
            "UnreportedNotApplicableCount": 232,
            "NotApplicableCount": 654,
            "OperationStartTime": "2021-08-04T11:03:50.590000-07:00",
            "OperationEndTime": "2021-08-04T11:04:21.555000-07:00",
            "Operation": "Scan",
            "RebootOption": "NoReboot",
            "CriticalNonCompliantCount": 0,
            "SecurityNonCompliantCount": 1,
            "OtherNonCompliantCount": 1
        }
    ]
}

Пример 3: Получение состояний экземпляров для группы патчей с менее чем десятью экземплярами, требующими перезагрузки

Следующий describe-instance-patch-states-for-patch-group пример получает подробности о состояниях сводного обзора патчей для указанной группы патчей для экземпляров с менее чем десятью экземплярами, требующими перезагрузки.

aws ssm describe-instance-patch-states-for-patch-group \
    --filters Key=InstalledPendingRebootCount,Type=LessThan,Values=10 \
    --patch-group "Production"

Вывод:

{
    "InstancePatchStates": [
        {
            "InstanceId": "i-02573cafcfEXAMPLE",
            "BaselineId": "pb-0c10e65780EXAMPLE",
            "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE",
            "PatchGroup": "Production",
            "OwnerInformation": "",
            "InstalledCount": 32,
            "InstalledOtherCount": 1,
            "InstalledPendingRebootCount": 4,
            "InstalledRejectedCount": 0,
            "MissingCount": 2,
            "FailedCount": 0,
            "UnreportedNotApplicableCount": 846,
            "NotApplicableCount": 212,
            "OperationStartTime": "2021-08-046T11:03:50.590000-07:00",
            "OperationEndTime": "2021-08-06T11:04:21.555000-07:00",
            "Operation": "Scan",
            "RebootOption": "NoReboot",
            "CriticalNonCompliantCount": 0,
            "SecurityNonCompliantCount": 1,
            "OtherNonCompliantCount": 0
        }
    ]
}

Дополнительную информацию см. в разделе Понимание значений состояния соответствия патчам в Руководстве пользователя AWS Systems Manager.

Вывод

InstancePatchStates -> (список)

Состояние патчей на высоком уровне для запрошенных управляемых узлов.

(структура)

Определяет состояние соответствия патчам на высоком уровне для управляемого узла, предоставляя информацию о количестве установленных, отсутствующих, не применимых и неудачных патчей, а также метаданные об операции, когда эта информация была собрана для управляемого узла.

InstanceId -> (строка)

Идентификатор управляемого узла, для которого была собрана информация о соответствии патчам.

PatchGroup -> (строка)

Имя группы патчей, к которой принадлежит управляемый узел.

BaselineId -> (строка)

Идентификатор базовой линии патчей, используемой для патчинга управляемого узла.

SnapshotId -> (строка)

Идентификатор снимка базовой линии патчей, используемого во время операции патчинга, когда были собраны данные о соответствии.

InstallOverrideList -> (строка)

URL https или URL в стиле Amazon Simple Storage Service (Amazon S3) для списка патчей, которые необходимо установить. Этот список установки патчей, который вы храните в ведре S3 в формате YAML и указываете в документе SSM AWS-RunPatchBaseline, переопределяет патчи, указанные в стандартной базовой линии патчей.

Дополнительную информацию о параметре InstallOverrideList см. в Документе команды SSM для патчинга: ``AWS-RunPatchBaseline` https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html`__ в руководстве пользователя Amazon Web Services Systems Manager.

OwnerInformation -> (строка)

Информация для заполнения. Это поле всегда будет пустым в текущей версии сервиса.

InstalledCount -> (целое число)

Количество патчей из базовой линии, установленных на управляемом узле.

InstalledOtherCount -> (целое число)

Количество патчей, не указанных в базовой линии, установленных на управляемом узле.

InstalledPendingRebootCount -> (целое число)

Количество патчей, установленных Patch Manager с момента последнего перезапуска управляемого узла.

InstalledRejectedCount -> (целое число)

Количество патчей, установленных на управляемом узле, которые указаны в списке RejectedPatches. Патчи со статусом InstalledRejected, как правило, были установлены до добавления их в список RejectedPatches.

Примечание

Если ALLOW_AS_DEPENDENCY — это указанный параметр для RejectedPatchesAction, то значение InstalledRejectedCount всегда будет 0 (ноль).

MissingCount -> (целое число)

Количество патчей из базовой линии, применимых к управляемому узлу, но в настоящее время не установленных.

FailedCount -> (целое число)

Количество патчей из базовой линии, попытки установки которых были предприняты во время последней операции патчинга, но установка которых не удалась.

UnreportedNotApplicableCount -> (целое число)

Количество патчей, превышающих поддерживаемый лимит NotApplicableCount, которые не сообщаются по имени в Инвентаризацию. Инвентаризация — это инструмент в Amazon Web Services Systems Manager.

NotApplicableCount -> (целое число)

Количество патчей из базовой линии, которые не применимы к управляемому узлу и поэтому не установлены на узле. Это число может быть усечено, если список имён патчей очень большой. Количество патчей, превышающих этот предел, сообщается в UnreportedNotApplicableCount.

AvailableSecurityUpdateCount -> (целое число)

Количество патчей, относящихся к безопасности, которые доступны, но не одобрены, потому что они не соответствовали требованиям базовой линии патчей. Например, обновлённая версия патча могла быть выпущена до истечения указанного периода автоматического одобрения.

Применимо только к управляемым узлам Windows Server.

OperationStartTime -> (метка времени)

Время начала последней операции патчинга на управляемом узле.

OperationEndTime -> (метка времени)

Время завершения последней операции патчинга на управляемом узле.

Operation -> (строка)

Тип операции патчинга, который был выполнен:

  • SCAN оценивает состояние соответствия патчам.
  • INSTALL устанавливает отсутствующие патчи.

LastNoRebootInstallOperationTime -> (метка времени)

Время последней попытки патчинга управляемого узла с NoReboot в качестве указанного параметра перезагрузки.

RebootOption -> (строка)

Указывает параметр перезагрузки, указанный в базовой линии патчей.

Примечание

Параметры перезагрузки применяются только к операциям Install. Перезагрузки не выполняются для операций Patch Manager Scan.
  • RebootIfNeeded: Patch Manager пытается перезагрузить управляемый узел, если он установил какие-либо патчи или если обнаружены патчи со статусом InstalledPendingReboot.
  • NoReboot: Patch Manager пытается установить отсутствующие пакеты, не пытаясь перезагрузить систему. Патчи, установленные с этим параметром, получают статус InstalledPendingReboot. Эти патчи могут не вступить в силу до перезагрузки.

CriticalNonCompliantCount -> (целое число)

Количество патчей на узел, указанных как Critical для отчётности о соответствии в базовой линии патчей и которые не установлены. Эти патчи могут отсутствовать, установка их могла завершиться неудачно, они были отклонены или установлены, но ожидают необходимой перезагрузки управляемого узла. Состояние этих управляемых узлов — NON_COMPLIANT.

SecurityNonCompliantCount -> (целое число)

Количество патчей на узел, указанных как Security в консультации по патчам, которые не установлены. Эти патчи могут отсутствовать, установка их могла завершиться неудачно, они были отклонены или установлены, но ожидают необходимой перезагрузки управляемого узла. Состояние этих управляемых узлов — NON_COMPLIANT.

OtherNonCompliantCount -> (целое число)

Количество патчей на узел, указанных как отличные от Critical или Security, но не соответствующих базовой линии патчей. Состояние этих управляемых узлов — NON_COMPLIANT.

NextToken -> (строка)

Токен для использования при запросе следующего набора элементов. Если дополнительных элементов нет, строка пустая.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API