Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

describe-instance-patch-states

Описание

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

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

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

Синтаксис

  describe-instance-patch-states
--instance-ids <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]

Параметры

--instance-ids (список)

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

(строка)

Синтаксис:

"string" "string" ...

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

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

Маркер для указания, где следует начать постраничный вывод. Это NextToken из ранее обрезанного ответа.

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

--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
  • text
  • таблица
  • 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

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

В этом describe-instance-patch-states примере получаются состояния сводки патчей для экземпляра.

aws ssm describe-instance-patch-states \
    --instance-ids "i-1234567890abcdef0"

Вывод:

{
    "InstancePatchStates": [
        {
            "InstanceId": "i-1234567890abcdef0",
            "PatchGroup": "my-patch-group",
            "BaselineId": "pb-0713accee01234567",
            "SnapshotId": "521c3536-930c-4aa9-950e-01234567abcd",
            "CriticalNonCompliantCount": 2,
            "SecurityNonCompliantCount": 2,
            "OtherNonCompliantCount": 1,
            "InstalledCount": 123,
            "InstalledOtherCount": 334,
            "InstalledPendingRebootCount": 0,
            "InstalledRejectedCount": 0,
            "MissingCount": 1,
            "FailedCount": 2,
            "UnreportedNotApplicableCount": 11,
            "NotApplicableCount": 2063,
            "OperationStartTime": "2021-05-03T11:00:56-07:00",
            "OperationEndTime": "2021-05-03T11:01:09-07:00",
            "Operation": "Scan",
            "LastNoRebootInstallOperationTime": "2020-06-14T12:17:41-07:00",
            "RebootOption": "RebootIfNeeded"
        }
    ]
}

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

Вывод

InstancePatchStates -> (список)

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

(структура)

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

InstanceId -> (строка)

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

PatchGroup -> (строка)

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

BaselineId -> (строка)

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

SnapshotId -> (строка)

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

InstallOverrideList -> (строка)

URL https или URL Amazon Simple Storage Service (Amazon S3) в стиле path для списка патчей, которые должны быть установлены. Этот список установки патчей, который вы храните в ведре 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, которые не сообщаются по имени в Inventory. Inventory — это инструмент в 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