Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

create-activation

Описание

Генерирует код активации и идентификатор активации, которые можно использовать для регистрации локальных серверов, периферийных устройств или виртуальных машин (ВМ) с Amazon Web Services Systems Manager. Регистрация этих машин в Systems Manager позволяет управлять ими с помощью инструментов Systems Manager. Для установки агента SSM на машинах в вашей гибридной среде используется код и идентификатор активации. Дополнительную информацию о требованиях к управлению локальными машинами с помощью Systems Manager см. в руководстве пользователя Amazon Web Services Systems Manager в разделе «Использование Amazon Web Services Systems Manager в гибридных и многооблачных средах».

Примечание

Машины Amazon Elastic Compute Cloud (Amazon EC2), периферийные устройства и локальные серверы и ВМ, настроенные для Systems Manager, называются управляемыми узлами.

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

Синтаксис

  create-activation
[--description <value>]
[--default-instance-name <value>]
--iam-role <value>
[--registration-limit <value>]
[--expiration-date <value>]
[--tags <value>]
[--registration-metadata <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]

Параметры

--description (строка)

Пользовательское описание ресурса, который вы хотите зарегистрировать в Systems Manager.

Предупреждение

Не вводите в это поле персональную информацию.

--default-instance-name (строка)

Имя зарегистрированного управляемого узла, которое будет отображаться в консоли Amazon Web Services Systems Manager или при использовании командных инструментов Amazon Web Services для перечисления ресурсов Systems Manager.

Предупреждение

Не вводите в это поле персональную информацию.

--iam-role (строка)

Имя роли Identity and Access Management (IAM), которую вы хотите назначить управляемому узлу. Эта роль IAM должна предоставлять разрешения AssumeRole для принципала службы Amazon Web Services Systems Manager ssm.amazonaws.com . Дополнительную информацию см. в руководстве пользователя Amazon Web Services Systems Manager в разделе «Создание роли службы IAM, необходимой для Systems Manager в гибридных и многооблачных средах».

Примечание

Для этого параметра нельзя указать роль, связанную со службой IAM. Вы должны создать уникальную роль.

--registration-limit (целое число)

Укажите максимальное количество управляемых узлов, которые вы хотите зарегистрировать. Значение по умолчанию — 1.

--expiration-date (метка времени)

Дата истечения срока действия этого запроса активации в формате метки времени, например «2024-07-07T00:00:00». Вы можете указать дату до 30 дней вперед. Если вы не укажете дату истечения срока действия, код активации истечет через 24 часа.

--tags (список)

Дополнительные метаданные, которые вы назначаете ресурсу. Теги позволяют категоризировать ресурс по-разному, например, по назначению, владельцу или среде. Например, вы можете пометить активацию, чтобы определить, какие серверы или виртуальные машины (ВМ) в вашей локальной среде вы планируете активировать. В этом случае вы можете указать следующие пары ключ-значение:

  • Key=OS,Value=Windows
  • Key=Environment,Value=Production

Предупреждение

При установке агента SSM на локальные серверы и ВМ вы указываете идентификатор и код активации. При указании идентификатора и кода активации теги, назначенные активации, автоматически применяются к локальным серверам или ВМ.

Вы не можете добавлять или удалять теги из существующей активации. Вы можете пометить локальные серверы, периферийные устройства и ВМ после того, как они впервые подключились к Systems Manager и получили идентификатор управляемого узла. Это означает, что они перечислены в консоли Amazon Web Services Systems Manager с идентификатором, начинающимся с «mi-». Дополнительную информацию о добавлении тегов к управляемым узлам см. в разделе AddTagsToResource. Дополнительную информацию об удалении тегов с управляемых узлов см. в разделе RemoveTagsFromResource.

(структура)

Метаданные, которые вы назначаете своим ресурсам Amazon Web Services. Теги позволяют категоризировать ваши ресурсы по-разному, например, по назначению, владельцу или среде. В Amazon Web Services Systems Manager вы можете применять теги к документам Systems Manager (SSM документы), управляемым узлам, временным интервалам обслуживания, параметрам, эталонным наборам исправлений, OpsItems и OpsMetadata.

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

Имя тега.

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

Значение тега.

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

Key=string,Value=string ...

Синтаксис JSON:

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

--registration-metadata (список)

Зарезервировано для внутреннего использования.

(структура)

Зарезервировано для внутреннего использования.

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

Зарезервировано для внутреннего использования.

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

Зарезервировано для внутреннего использования.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "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
  • 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.

Чтобы создать активацию управляемого экземпляра

В следующем create-activation примере создается активация управляемого экземпляра.

aws ssm create-activation \
    --default-instance-name "HybridWebServers" \
    --iam-role "HybridWebServersRole" \
    --registration-limit 5

Вывод:

{
    "ActivationId": "5743558d-563b-4457-8682-d16c3EXAMPLE",
    "ActivationCode": "dRmgnYaFv567vEXAMPLE"
}

Дополнительную информацию см. в разделе Шаг 4: Создание активации управляемого экземпляра для гибридной среды в руководстве пользователя AWS Systems Manager.

Вывод

ActivationId -> (строка)

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

ActivationCode -> (строка)

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

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

Spec-Zone.ru

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