описание-внешних-шлюзов-клиента
Описание
Описывает один или несколько ваших VPN-внешних шлюзов клиента.
Дополнительную информацию см. в разделе Amazon Web Services Site-to-Site VPN в руководстве пользователя Amazon Web Services Site-to-Site VPN.
См. также: Документацию API AWS
Синтаксис
describe-customer-gateways
[--customer-gateway-ids <value>]
[--filters <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]
Параметры
--customer-gateway-ids (список)
Один или несколько идентификаторов внешних шлюзов клиента.
По умолчанию: Описывает все ваши внешние шлюзы клиента.
(строка)
Синтаксис:
"string" "string" ...
--filters (список)
Один или несколько фильтров.
-
bgp-asn- Автономный номер системы (ASN) протокола Border Gateway Protocol (BGP) внешнего шлюза клиента. -
customer-gateway-id- Идентификатор внешнего шлюза клиента. -
ip-address- IP-адрес внешнего интерфейса устройства внешнего шлюза клиента. -
state- Состояние внешнего шлюза клиента (pending|available|deleting|deleted). -
type- Тип внешнего шлюза клиента. В настоящее время поддерживается только типipsec.1. -
tag:<ключ> - Сочетание ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, которые имеют тег с ключомOwnerи значениемTeamA, укажитеtag:Ownerдля имени фильтра иTeamAдля значения фильтра. -
tag-key- Ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которым назначен тег с указанным ключом, независимо от значения тега.
(структура)
Пара ключ-значение фильтра, используемая для получения более специфического списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.
Если вы укажете несколько фильтров, фильтры объединяются с помощью AND , и запрос возвращает только результаты, соответствующие всем указанным фильтрам.
Дополнительную информацию см. в разделе Список и фильтрация с помощью командной строки и API в руководстве пользователя Amazon EC2.
Имя -> (строка)
Значения -> (список)
Значения фильтра. Значения фильтров чувствительны к регистру. Если вы укажете несколько значений для фильтра, значения объединяются с помощью OR , и запрос возвращает все результаты, соответствующие любому из указанных значений.
(строка)
Упрощенный синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "string",
"Values": ["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 (строка)
Сборник сертификатов 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 (булево)
Автоматически запросить параметры ввода командной строки.
--no-cli-auto-prompt (булево)
Отключить автоматический запрос параметров ввода командной строки.
Примеры
Примечание
Чтобы использовать следующие примеры, вам необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве пользователя AWS CLI в разделе «Начало работы».
Если не указано иное, во всех примерах используются правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Чтобы описать ваши внешние шлюзы клиента
Этот пример описывает ваши внешние шлюзы клиента.
Команда:
aws ec2 describe-customer-gateways
Вывод:
{
"CustomerGateways": [
{
"CustomerGatewayId": "cgw-b4dc3961",
"IpAddress": "203.0.113.12",
"State": "available",
"Type": "ipsec.1",
"BgpAsn": "65000"
},
{
"CustomerGatewayId": "cgw-0e11f167",
"IpAddress": "12.1.2.3",
"State": "available",
"Type": "ipsec.1",
"BgpAsn": "65534"
}
]
}
Чтобы описать конкретный внешний шлюз клиента
Этот пример описывает указанный внешний шлюз клиента.
Команда:
aws ec2 describe-customer-gateways --customer-gateway-ids cgw-0e11f167
Вывод:
{
"CustomerGateways": [
{
"CustomerGatewayId": "cgw-0e11f167",
"IpAddress": "12.1.2.3",
"State": "available",
"Type": "ipsec.1",
"BgpAsn": "65534"
}
]
}
Вывод
CustomerGateways -> (список)
Информация об одном или нескольких внешних шлюзах клиента.
(структура)
Описание внешнего шлюза клиента.
CertificateArn -> (строка)
DeviceName -> (строка)
Tags -> (список)
Любые теги, назначенные внешнему шлюзу клиента.
(структура)
Описание тега.
Key -> (строка)
Ключ тега.
Ограничения: ключи тегов чувствительны к регистру и принимают максимум 127 символов Юникода. Не должно начинаться с aws: .
Value -> (строка)
Значение тега.
Ограничения: значения тегов чувствительны к регистру и принимают максимум 256 символов Юникода.
BgpAsnExtended -> (строка)
Автономный номер системы (ASN) протокола Border Gateway Protocol (BGP) устройства внешнего шлюза клиента.
Допустимые значения: от 2,147,483,648 до 4,294,967,295
CustomerGatewayId -> (строка)
State -> (строка)
pending | available | deleting | deleted ).Type -> (строка)
ipsec.1 ).IpAddress -> (строка)
OutsideIpAddressType в ваших параметрах VPN-соединения установлено в значение PrivateIpv4 , вы можете использовать частный IPv4-адрес RFC6598 или RFC1918. Если OutsideIpAddressType установлено в значение PublicIpv4 , вы можете использовать общедоступный IPv4-адрес.BgpAsn -> (строка)
Автономный номер системы (ASN) протокола Border Gateway Protocol (BGP) устройства внешнего шлюза клиента.
Допустимые значения: от 1 до 2,147,483,647
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|