Spec-Zone.ru › AWS CLI v2

[ aws . opsworkscm ]

обновление-атрибутов-сервера-движка

Описание

Обновляет атрибуты, специфичные для движка, на указанном сервере. Сервер переходит в состояние MODIFYING, когда эта операция выполняется. Одновременно может происходить только одно обновление. Вы можете использовать эту команду для сброса открытого ключа сервера Chef (CHEF_PIVOTAL_KEY) или пароля администратора сервера Puppet (PUPPET_ADMIN_PASSWORD).

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

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

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

Синтаксис

  update-server-engine-attributes
--server-name <value>
--attribute-name <value>
[--attribute-value <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 (строка)

Имя сервера для обновления.

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

Имя атрибута движка для обновления.

--attribute-value (строка)

Значение для установки атрибута.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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-engine-attributes обновляет значение атрибута движка CHEF_PIVOTAL_KEY для сервера Chef Automate с именем automate-06. В настоящее время нельзя изменить значения других атрибутов движка.

aws opsworks-cm update-server-engine-attributes \
    --attribute-name CHEF_PIVOTAL_KEY \
    --attribute-value "new key value" \
    --server-name "automate-06"

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

{
    "Server": {
        "BackupRetentionCount": 2,
        "CreatedAt": 2016-07-29T13:38:47.520Z,
        "DisableAutomatedBackup": FALSE,
        "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com",
        "Engine": "Chef",
        "EngineAttributes": [
            {
                "Name": "CHEF_PIVOTAL_KEY",
                "Value": "new key value"
            }
        ],
        "EngineModel": "Single",
        "EngineVersion": "12",
        "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2",
        "InstanceType": "m4.large",
        "KeyPair": "",
        "MaintenanceStatus": "SUCCESS",
        "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" ]
    }
}

Для получения более подробной информации, см. UpdateServerEngineAttributes в Справочнике по API AWS OpsWorks for Chef Automate.

Вывод

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

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

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