Spec-Zone.ru › AWS CLI v2

[ aws . storagegateway ]

activate-gateway

Описание

Активирует шлюз, который вы ранее развернули на хосте. В процессе активации вы указываете информацию, такую как регион Amazon Web Services, который вы хотите использовать для хранения снимков или лент, часовой пояс для запланированных снимков, окно расписания снимков шлюза, ключ активации и имя вашего шлюза. Процесс активации также связывает ваш шлюз с вашей учетной записью. Для получения дополнительной информации см. UpdateGatewayInformation .

Примечание

Вы должны включить виртуальную машину шлюза, прежде чем сможете активировать свой шлюз.

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

Синтаксис

  activate-gateway
--activation-key <value>
--gateway-name <value>
--gateway-timezone <value>
--gateway-region <value>
[--gateway-type <value>]
[--tape-drive-type <value>]
[--medium-changer-type <value>]
[--tags <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]

Параметры

--activation-key (строка)

Ключ активации шлюза. Вы можете получить ключ активации, отправив HTTP-запрос GET с включенными редиректами на IP-адрес шлюза (порт 80). URL редиректа, возвращённый в ответе, предоставляет вам ключ активации для вашего шлюза в параметре запроса activationKey. Он также может содержать другие параметры, связанные с активацией, однако они являются лишь значениями по умолчанию — аргументы, которые вы передаёте в вызов API ActivateGateway, определяют фактическую конфигурацию вашего шлюза.

Для получения дополнительной информации, см. Получение ключа активации в Руководстве пользователя шлюза хранилища.

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

Имя, которое вы настроили для своего шлюза.

--gateway-timezone (строка)

Значение, указывающее часовой пояс, который вы хотите установить для шлюза. Часовой пояс имеет формат «GMT», «GMT-ч:мм» или «GMT+ч:мм». Например, GMT указывает среднее гринвичское время без какого-либо смещения. GMT-4:00 указывает, что время на 4 часа отстаёт от GMT. GMT+2:00 указывает, что время на 2 часа опережает GMT. Часовой пояс используется, например, для планирования снимков и графика обслуживания вашего шлюза.

--gateway-region (строка)

Значение, указывающее регион Amazon Web Services, в котором вы хотите хранить свои данные. Указанный регион Amazon Web Services для шлюза должен совпадать с регионом Amazon Web Services в вашем заголовке Host в запросе. Для получения дополнительной информации о доступных регионах и конечных точках Amazon Web Services для шлюза хранилища, см. Конечные точки и квоты шлюза хранилища в Общие справочные материалы Amazon Web Services.

Допустимые значения: см. Конечные точки и квоты шлюза хранилища в Общие справочные материалы Amazon Web Services.

--gateway-type (строка)

Значение, определяющее тип шлюза для активации. Указанный тип имеет критическое значение для всех последующих функций шлюза и не может быть изменён после активации. Значение по умолчанию — CACHED.

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

Amazon FSx File Gateway больше недоступен для новых клиентов. Существующие клиенты FSx File Gateway могут продолжать использовать услугу в обычном режиме. Для функций, аналогичных FSx File Gateway, посетите эту запись в блоге.

Допустимые значения: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB

--tape-drive-type (строка)

Значение, указывающее тип ленточного привода для ленточного шлюза. Этот параметр необязателен.

Допустимые значения: IBM-ULT3580-TD5

--medium-changer-type (строка)

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

Допустимые значения: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

--tags (список)

Список из до 50 тегов, которые можно назначить шлюзу. Каждый тег — это пара ключ-значение.

Примечание

Допустимые символы для ключа и значения — буквы, пробелы и цифры, которые можно представить в формате UTF-8, и следующие специальные символы: + - = . _ : / @.

(структура)

Пара ключ-значение, помогающая вам управлять, фильтровать и искать ваши ресурсы. Разрешённые символы: буквы, пробелы и цифры, представимые в UTF-8, и следующие символы: + - = . _ : /.

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

Ключ тега. Ключ не может начинаться с aws:.

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

Значение ключа тега.

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

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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот параметр указан.

--ca-bundle (string)

Файл с корневым сертификатом для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для бинарных блоков. По умолчанию используется формат base64. Формат base64 предполагает, что бинарные блоки предоставляются как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и бинарные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего бинарному блоку, fileb:// всегда будет рассматриваться как бинарный и использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить вывод страницы CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

GatewayARN -> (string)

Amazon Resource Name (ARN) шлюза. Используйте операцию ListGateways, чтобы получить список шлюзов для вашей учетной записи и региона Amazon Web Services.

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

Spec-Zone.ru

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