Spec-Zone.ru › AWS CLI v2

[ aws . directconnect ]

describe-connections

Описание

Отображает указанное соединение или все соединения в данном регионе.

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

Синтаксис

  describe-connections
[--connection-id <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]

Параметры

--connection-id (строка)

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

--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.

Для отображения всех соединений в текущем регионе

Следующая describe-connections команда отображает все соединения в текущем регионе:

aws directconnect describe-connections

Вывод:

{
  "connections": [
      {
          "awsDevice": "EqDC2-123h49s71dabc",
          "ownerAccount": "123456789012",
          "connectionId": "dxcon-fguhmqlc",
          "lagId": "dxlag-ffrz71kw",
          "connectionState": "down",
          "bandwidth": "1Gbps",
          "location": "EqDC2",
          "connectionName": "My_Connection",
          "loaIssueTime": 1491568964.0,
          "region": "us-east-1"
      }
  ]
}

Вывод

connections -> (список)

Соединения.

(структура)

Информация о соединении Direct Connect.

ownerAccount -> (строка)

Идентификатор учетной записи Amazon Web Services, владеющей соединением.

connectionId -> (строка)

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

connectionName -> (строка)

Имя соединения.

connectionState -> (строка)

Состояние соединения. Доступные значения:

  • ordering : Начальное состояние размещенного соединения, предоставленного на межсоединении. Соединение остается в состоянии заказа до тех пор, пока владелец размещенного соединения не подтвердит или отклонит заказ на соединение.
  • requested : Начальное состояние стандартного соединения. Соединение остается в состоянии запроса до тех пор, пока письмо об авторизации (LOA) не будет отправлено клиенту.
  • pending : Соединение одобрено и инициализируется.
  • available : Сетевое соединение активно, и соединение готово к использованию.
  • down : Сетевое соединение неактивно.
  • deleting : Соединение удаляется.
  • deleted : Соединение удалено.
  • rejected : Размещенное соединение в состоянии ordering переходит в состояние rejected, если оно удаляется клиентом.
  • unknown : Состояние соединения недоступно.

region -> (строка)

Регион Amazon Web Services, в котором находится соединение.

location -> (строка)

Расположение соединения.

bandwidth -> (строка)

Пропускная способность соединения.

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

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

partnerName -> (строка)

Имя поставщика Direct Connect, связанного с соединением.

loaIssueTime -> (метка времени)

Время последнего вызова DescribeLoa для этого соединения.

lagId -> (строка)

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

awsDevice -> (строка)

Точка подключения Direct Connect, на которой завершается физическое соединение.

jumboFrameCapable -> (логическое значение)

Указывает, поддерживаются ли гигантские кадры.

awsDeviceV2 -> (строка)

Точка подключения Direct Connect, на которой завершается физическое соединение.

awsLogicalDeviceId -> (строка)

Точка подключения Direct Connect, на которой завершается логическое соединение. Это устройство может отличаться от устройства, на котором завершается физическое соединение.

hasLogicalRedundancy -> (строка)

Указывает, поддерживается ли второе BGP-соединение в том же семействе адресов (IPv4/IPv6).

tags -> (список)

Теги, связанные с соединением.

(структура)

Информация о теге.

key -> (строка)

Ключ.

value -> (строка)

Значение.

providerName -> (строка)

Имя поставщика услуг, связанного с соединением.

macSecCapable -> (логическое значение)

Указывает, поддерживается ли MAC Security (MACsec).

portEncryptionStatus -> (строка)

Статус подключения MAC Security (MACsec) к порту.

Допустимые значения — Encryption Up, что означает наличие активного имени ключа подключения, или Encryption Down.

encryptionMode -> (строка)

Режим шифрования MAC Security (MACsec).

Допустимые значения — no_encrypt, should_encrypt и must_encrypt.

macSecKeys -> (список)

Ключи безопасности MAC Security (MACsec), связанные с соединением.

(структура)

Информация о секретном ключе MAC Security (MACsec).

secretARN -> (строка)

Amazon Resource Name (ARN) секретного ключа MAC Security (MACsec).

ckn -> (строка)

Имя ключа подключения (CKN) для секретного ключа MAC Security.

state -> (строка)

Состояние секретного ключа MAC Security (MACsec).

Возможные значения:

  • associating : Ключ MAC Security (MACsec) проверяется и еще не связан с соединением или LAG.
  • associated : Ключ MAC Security (MACsec) проверен и связан с соединением или LAG.
  • disassociating : Ключ MAC Security (MACsec) отсоединяется от соединения или LAG.
  • disassociated : Ключ MAC Security (MACsec) больше не связан с соединением или LAG.

startOn -> (строка)

Дата вступления в силу секретного ключа MAC Security (MACsec). Значение отображается в формате UTC.

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

Spec-Zone.ru

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