Spec-Zone.ru › AWS CLI v2

[ aws . opsworkscm ]

start-maintenance

Описание

Вручную запускает техническое обслуживание сервера. Эта команда может быть полезна, если предыдущая попытка технического обслуживания завершилась неудачей, и причина сбоя была устранена. Сервер находится в состоянии UNDER_MAINTENANCE во время выполнения технического обслуживания.

Техническое обслуживание может быть запущено только на серверах в состояниях HEALTHY и UNHEALTHY. В противном случае будет выброшено исключение InvalidStateException. Исключение ResourceNotFoundException выбрасывается, если сервер не существует. Исключение ValidationException генерируется, когда параметры запроса неверны.

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

Синтаксис

  start-maintenance
--server-name <value>
[--engine-attributes <value>]
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--server-name (строка)

Имя сервера, на котором необходимо выполнить техническое обслуживание.

--engine-attributes (список)

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

Принимаемые атрибуты в запросе StartMaintenance для Chef
  • CHEF_MAJOR_UPGRADE : Если сервер Chef Automate подходит для обновления до Chef Automate 2, добавьте этот атрибут двигателя в запрос StartMaintenance и установите значение на true для обновления сервера до Chef Automate 2. Дополнительную информацию можно найти в статье Обновление сервера AWS OpsWorks for Chef Automate до Chef Automate 2.

(структура)

Пара имя-значение, специфичная для двигателя сервера.

Имя -> (строка)

Имя атрибута двигателя.

Значение -> (строка)

Значение атрибута двигателя.

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

Name=string,Value=string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

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

--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.

Для запуска технического обслуживания

Следующий пример вручную запускает техническое обслуживание на указанном сервере Chef Automate или Puppet Enterprise в вашем регионе по умолчанию. Эта команда полезна, если предыдущая автоматизированная попытка технического обслуживания завершилась неудачей, и причина сбоя была устранена.

aws opsworks-cm start-maintenance \
    --server-name 'automate-06'

Вывод:

{
    "Server": {
        "AssociatePublicIpAddress": true,
        "BackupRetentionCount": 10,
        "ServerName": "automate-06",
        "CreatedAt": 1569229584.842,
        "CloudFormationStackArn": "arn:aws:cloudformation:us-west-2:123456789012:stack/aws-opsworks-cm-instance-automate-06-1606611794746/EXAMPLE0-31de-11eb-bdb0-0a5b0a1353b8",
        "DisableAutomatedBackup": false,
        "Endpoint": "automate-06-EXAMPLEvr8gjfk5f.us-west-2.opsworks-cm.io",
        "Engine": "ChefAutomate",
        "EngineModel": "Single",
        "EngineAttributes": [],
        "EngineVersion": "2020-07",
        "InstanceProfileArn": "arn:aws:iam::123456789012:instance-profile/aws-opsworks-cm-ec2-role",
        "InstanceType": "m5.large",
        "PreferredMaintenanceWindow": "Sun:01:00",
        "PreferredBackupWindow": "Sun:15:00",
        "SecurityGroupIds": [
            "sg-EXAMPLE"
        ],
        "ServiceRoleArn": "arn:aws:iam::123456789012:role/service-role/aws-opsworks-cm-service-role",
        "Status": "UNDER_MAINTENANCE",
        "SubnetIds": [
            "subnet-EXAMPLE"
        ],
        "ServerArn": "arn:aws:opsworks-cm:us-west-2:123456789012:server/automate-06/0148382d-66b0-4196-8274-d1a2b6dff8d1"
    }
}

Дополнительную информацию можно найти в разделе Техническое обслуживание системы (серверы Puppet Enterprise) или Техническое обслуживание системы (серверы Chef Automate) в Руководстве пользователя AWS OpsWorks.

Выходные данные

Сервер -> (структура)

Содержит ответ на запрос StartMaintenance.

AssociatePublicIpAddress -> (boolean)

Присоединить общедоступный IP-адрес к серверу, который вы запускаете.

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

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

ServerName -> (строка)

Имя сервера.

CreatedAt -> (временная метка)

Отметка времени создания сервера. Пример 2016-07-29T13:38:47.520Z

CloudFormationStackArn -> (строка)

ARN стека CloudFormation, который использовался для создания сервера.

CustomDomain -> (строка)

Необязательный общедоступный конечный пункт сервера, такой как https://aws.my-company.com. Вы не можете получить доступ к серверу, используя значение Endpoint, если для сервера указано значение CustomDomain.

DisableAutomatedBackup -> (boolean)

Отключает автоматическое создание резервных копий. Количество сохраненных резервных копий зависит от значения PreferredBackupCount.

Endpoint -> (строка)

Имя DNS, которое можно использовать для доступа к движку. Пример: myserver-asdfghjkl.us-east-1.opsworks.io. Вы не можете получить доступ к серверу, используя значение Endpoint, если для сервера указано значение CustomDomain.

Engine -> (строка)

Тип движка сервера. Допустимые значения в этом выпуске включают ChefAutomate и Puppet.

EngineModel -> (строка)

Модель движка сервера. Допустимые значения в этом выпуске включают Monolithic для Puppet и Single для Chef.

EngineAttributes -> (список)

Ответ на запрос createServer() возвращает служебные учетные данные для доступа к серверу в EngineAttributes. Эти учетные данные не хранятся AWS OpsWorks CM; они возвращаются только как часть результата createServer().

Атрибуты, возвращаемые в ответе createServer для Chef
  • CHEF_AUTOMATE_PIVOTAL_KEY: закодированный в base64 закрытый ключ RSA, сгенерированный AWS OpsWorks для Chef Automate. Этот закрытый ключ необходим для доступа к API Chef.
  • CHEF_STARTER_KIT: закодированный в base64 ZIP-архив. ZIP-архив содержит начальный набор инструментов Chef, включающий README, файл конфигурации и необходимый закрытый ключ RSA. Сохраните этот файл, распакуйте его и перейдите в каталог, где вы распаковали содержимое файла. Из этого каталога вы можете запускать команды Knife.
Атрибуты, возвращаемые в ответе createServer для Puppet
  • PUPPET_STARTER_KIT: закодированный в base64 ZIP-архив. ZIP-архив содержит начальный набор инструментов Puppet, включая README и необходимый закрытый ключ. Сохраните этот файл, распакуйте его и перейдите в каталог, где вы распаковали содержимое файла.
  • PUPPET_ADMIN_PASSWORD: пароль администратора, который можно использовать для входа в консоль Puppet Enterprise после того, как сервер станет доступен.

(структура)

Пара имя-значение, специфичная для движка сервера.

Name -> (строка)

Имя атрибута движка.

Value -> (строка)

Значение атрибута движка.

EngineVersion -> (строка)

Версия движка сервера. Для сервера Chef допустимое значение для EngineVersion в настоящее время 2. Для сервера Puppet укажите либо 2019, либо 2017.

InstanceProfileArn -> (строка)

ARN профиля экземпляра сервера.

InstanceType -> (строка)

Тип экземпляра для сервера, указанный в стеке CloudFormation. Он может отличаться от типа экземпляра, отображаемого в консоли EC2.

KeyPair -> (строка)

Пара ключей, связанная с сервером.

MaintenanceStatus -> (строка)

Статус последнего запуска обслуживания сервера. Показывается SUCCESS или FAILED.

PreferredMaintenanceWindow -> (строка)

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

PreferredBackupWindow -> (строка)

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

SecurityGroupIds -> (список)

Идентификаторы групп безопасности для сервера, указанные в стеке CloudFormation. Они могут отличаться от групп безопасности, отображаемых в консоли EC2.

(строка)

ServiceRoleArn -> (строка)

ARN служебной роли, используемой для создания сервера.

Status -> (строка)

Статус сервера. Это поле отображает состояние текущих действий, таких как создание, выполнение или резервное копирование сервера, а также состояние работоспособности сервера.

StatusReason -> (строка)

В зависимости от статуса сервера это поле содержит либо удобочитаемое сообщение (например, об ошибке создания или резервного копирования), либо экранированный блок JSON (используется для результатов проверки работоспособности).

SubnetIds -> (список)

Идентификаторы подсетей, указанные в запросе CreateServer.

(строка)

ServerArn -> (строка)

ARN сервера.

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

Spec-Zone.ru

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