Spec-Zone.ru › AWS CLI v2

[ aws . opsworkscm ]

update-server

Описание

Обновляет настройки сервера.

Данная операция является синхронной.

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

Синтаксис

  update-server
[--disable-automated-backup | --no-disable-automated-backup]
[--backup-retention-count <value>]
--server-name <value>
[--preferred-maintenance-window <value>]
[--preferred-backup-window <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]

Параметры

--disable-automated-backup | --no-disable-automated-backup (логическое значение)

Установление DisableAutomatedBackup в true отключает автоматические или запланированные резервные копии. Автоматические резервные копии включены по умолчанию.

--backup-retention-count (целое число)

Устанавливает количество автоматических резервных копий, которые вы хотите сохранить.

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

Имя сервера, который нужно обновить.

--preferred-maintenance-window (строка)

DDD:HH:MM (время начала еженедельного интервала) или HH:MM (время начала ежедневного интервала).

Интервалы времени всегда используют координированное универсальное время (UTC). Допустимые строки для дня недели (DDD ) являются: Mon , Tue , Wed , Thr , Fri , Sat , или Sun .

--preferred-backup-window (строка)

DDD:HH:MM (время начала еженедельного интервала) или HH:MM (время начала ежедневного интервала).

Интервалы времени всегда используют координированное универсальное время (UTC). Допустимые строки для дня недели (DDD ) являются: Mon , Tue , Wed , Thr , Fri , Sat , или Sun .

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

Для обновления сервера

Следующая update-server команда обновляет время начала технического обслуживания указанного сервера Chef Automate в вашем регионе по умолчанию. Добавление параметра --preferred-maintenance-window изменяет день и время технического обслуживания сервера на понедельник в 9:15 утра по UTC:

aws opsworks-cm update-server \
    --server-name "automate-06" \
    --preferred-maintenance-window "Mon:09:15"

Вывод отображает информацию, аналогичную следующей, об обновленном сервере.

{
    "Server": {
        "BackupRetentionCount": 8,
        "CreatedAt": 2016-07-29T13:38:47.520Z,
        "DisableAutomatedBackup": TRUE,
        "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com",
        "Engine": "Chef",
        "EngineAttributes": [
            {
                "Name": "CHEF_DELIVERY_ADMIN_PASSWORD",
                "Value": "1Password1"
            }
        ],
        "EngineModel": "Single",
        "EngineVersion": "12",
        "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2",
        "InstanceType": "m4.large",
        "KeyPair": "",
        "MaintenanceStatus": "OK",
        "PreferredBackupWindow": "Mon:09:15",
        "PreferredMaintenanceWindow": "03:00",
        "SecurityGroupIds": [ "sg-1a24c270" ],
        "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2",
        "ServerName": "automate-06",
        "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735",
        "Status": "HEALTHY",
        "StatusReason": "",
        "SubnetIds": [ "subnet-49436a18" ]
    }
}

Дополнительную информацию см. в разделе UpdateServer в Справочнике по API AWS OpsWorks for Chef Automate.

Вывод

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

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

AssociatePublicIpAddress -> (булево)

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

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

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

ServerName -> (строка)

Имя сервера.

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

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

CloudFormationStackArn -> (строка)

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

CustomDomain -> (строка)

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

DisableAutomatedBackup -> (булево)

Отключает автоматические резервные копии. Количество сохранённых резервных копий зависит от значения 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 -> (список)

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

(строка)

ServiceRoleArn -> (строка)

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

Status -> (строка)

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

StatusReason -> (строка)

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

SubnetIds -> (список)

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

(строка)

ServerArn -> (строка)

ARN сервера.

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

Spec-Zone.ru

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