Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-vpn-gateways

Описание

Описывает один или несколько ваших виртуальных шлюзов VPN.

Дополнительную информацию см. на сайте Amazon Web Services в разделе «Виртуальные частные сети типа \"точка-точка\" Amazon Web Services» в руководстве пользователя.

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

Синтаксис

  describe-vpn-gateways
[--filters <value>]
[--vpn-gateway-ids <value>]
[--dry-run | --no-dry-run]
[--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]

Параметры

--filters (список)

Один или несколько фильтров.

  • amazon-side-asn - Номер автономной системы (ASN) со стороны Amazon для шлюза.
  • attachment.state - Текущее состояние подключения между шлюзом и VPC (attaching | attached | detaching | detached ).
  • attachment.vpc-id - Идентификатор подключенной VPC.
  • availability-zone - Зона доступности для виртуального шлюза VPN (применимо).
  • state - Состояние виртуального шлюза VPN (pending | available | deleting | deleted ).
  • tag :<ключ> - Комбинация ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением TeamA , укажите tag:Owner для имени фильтра и TeamA для значения фильтра.
  • tag-key - Ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которым назначен тег с определенным ключом, независимо от значения тега.
  • type - Тип виртуального шлюза VPN. В настоящее время поддерживается только тип ipsec.1.
  • vpn-gateway-id - Идентификатор виртуального шлюза VPN.

(структура)

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

Если вы укажете несколько фильтров, фильтры будут объединены с помощью AND , и запрос вернет только результаты, которые соответствуют всем указанным фильтрам.

Дополнительную информацию см. в разделе «Список и фильтрация с помощью CLI и API» в руководстве пользователя Amazon EC2.

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

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы укажете несколько значений для фильтра, значения будут объединены с помощью OR , и запрос вернет все результаты, которые соответствуют любому из указанных значений.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

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

--vpn-gateway-ids (список)

Один или несколько идентификаторов виртуальных шлюзов VPN.

По умолчанию: описывает все ваши виртуальные шлюзы VPN.

(строка)

Синтаксис:

"string" "string" ...

--dry-run | --no-dry-run (логическое значение)

Проверяет, есть ли у вас необходимые разрешения для действия, не выполняя фактический запрос, и возвращает ответ с ошибкой. Если у вас есть необходимые разрешения, ответ с ошибкой - DryRunOperation . В противном случае - UnauthorizedOperation .

--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 (строка)

Файл сертификата корневого центра для проверки 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.

Чтобы описать ваши виртуальные шлюзы VPN

В этом примере описываются ваши виртуальные шлюзы VPN.

Команда:

aws ec2 describe-vpn-gateways

Вывод:

{
    "VpnGateways": [
        {
            "State": "available",
            "Type": "ipsec.1",
            "VpnGatewayId": "vgw-f211f09b",
            "VpcAttachments": [
                {
                    "State": "attached",
                    "VpcId": "vpc-98eb5ef5"
                }
            ]
        },
        {
            "State": "available",
            "Type": "ipsec.1",
            "VpnGatewayId": "vgw-9a4cacf3",
            "VpcAttachments": [
                {
                    "State": "attaching",
                    "VpcId": "vpc-a01106c2"
                }
            ]
        }
    ]
}

Вывод

VpnGateways -> (список)

Информация об одном или нескольких виртуальных шлюзах VPN.

(структура)

Описание виртуального шлюза VPN.

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

Номер автономной системы (ASN) со стороны Amazon для сеанса BGP.

Теги -> (список)

Любые теги, назначенные виртуальному шлюзу VPN.

(структура)

Описание тега.

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

Ключ тега.

Ограничения: ключи тегов чувствительны к регистру и принимают не более 127 символов Unicode. Не может начинаться с aws:.

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

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

Ограничения: значения тегов чувствительны к регистру и принимают не более 256 символов Unicode.

VpnGatewayId -> (строка)

Идентификатор виртуального шлюза VPN.

Состояние -> (строка)

Текущее состояние виртуального шлюза VPN.

Тип -> (строка)

Тип подключения VPN, поддерживаемого виртуальным шлюзом VPN.

AvailabilityZone -> (строка)

Зона доступности, в которой был создан виртуальный шлюз VPN (если применимо). Это поле может быть пустым или не возвращаться.

VpcAttachments -> (список)

Любые VPC, подключенные к виртуальному шлюзу VPN.

(структура)

Описание подключения между виртуальным шлюзом VPN и VPC.

VpcId -> (строка)

Идентификатор VPC.

Состояние -> (строка)

Текущее состояние подключения.

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

Spec-Zone.ru

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