Spec-Zone.ru › AWS CLI v2

[ aws . directconnect ]

describe-lags

Описание

Описывает все ваши группы агрегирования каналов (LAG) или указанную группу LAG.

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

Синтаксис

  describe-lags
[--lag-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]

Параметры

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

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

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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 (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Для описания ваших LAG

Следующая команда описывает все ваши LAG для текущего региона.

Команда:

aws directconnect describe-lags

Вывод:

{
  "lags": [
      {
          "awsDevice": "EqDC2-19y7z3m17xpuz",
          "numberOfConnections": 2,
          "lagState": "down",
          "ownerAccount": "123456789012",
          "lagName": "DA-LAG",
          "connections": [
              {
                  "ownerAccount": "123456789012",
                  "connectionId": "dxcon-ffnikghc",
                  "lagId": "dxlag-fgsu9erb",
                  "connectionState": "requested",
                  "bandwidth": "10Gbps",
                  "location": "EqDC2",
                  "connectionName": "Requested Connection 1 for Lag dxlag-fgsu9erb",
                  "region": "us-east-1"
              },
              {
                  "ownerAccount": "123456789012",
                  "connectionId": "dxcon-fglgbdea",
                  "lagId": "dxlag-fgsu9erb",
                  "connectionState": "requested",
                  "bandwidth": "10Gbps",
                  "location": "EqDC2",
                  "connectionName": "Requested Connection 2 for Lag dxlag-fgsu9erb",
                  "region": "us-east-1"
              }
          ],
          "lagId": "dxlag-fgsu9erb",
          "minimumLinks": 0,
          "connectionsBandwidth": "10Gbps",
          "region": "us-east-1",
          "location": "EqDC2"
      }
  ]
}

Вывод

lags -> (список)

Данные о группе агрегирования каналов (LAG).

(структура)

Информация о группе агрегирования каналов (LAG).

connectionsBandwidth -> (строка)

Пропускная способность отдельных физических каналов, объединённых в LAG. Возможные значения: 1 Гбит/с, 10 Гбит/с, 100 Гбит/с или 400 Гбит/с.

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

Количество физических выделенных каналов, изначально предоставленных и объединённых в LAG. Максимальное количество каналов — 4 при скорости порта 1 Гбит/с или 10 Гбит/с, или 2 при скорости порта 100 Гбит/с или 400 Гбит/с.

lagId -> (строка)

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

ownerAccount -> (строка)

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

lagName -> (строка)

Имя LAG.

lagState -> (строка)

Состояние LAG. Возможные значения:

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

location -> (строка)

Расположение LAG.

region -> (строка)

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

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

Минимальное количество физических выделенных каналов, которые должны быть активны для работы самой LAG.

awsDevice -> (строка)

Точка подключения Direct Connect, в которой размещена LAG.

awsDeviceV2 -> (строка)

Точка подключения Direct Connect, в которой размещена LAG.

awsLogicalDeviceId -> (строка)

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

connections -> (список)

Каналы, объединённые в LAG.

(структура)

Информация о подключении 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.

allowsHostedConnections -> (булево)

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

jumboFrameCapable -> (булево)

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

hasLogicalRedundancy -> (строка)

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

tags -> (список)

Теги, связанные с LAG.

(структура)

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

key -> (строка)

Ключ.

value -> (строка)

Значение.

providerName -> (строка)

Название поставщика услуг, связанного с LAG.

macSecCapable -> (булево)

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

encryptionMode -> (строка)

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

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

macSecKeys -> (список)

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

(структура)

Информация о секретном ключе 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