Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

delete-ipam-pool

Описание

Удалить пул IPAM.

Примечание

Вы не можете удалить пул IPAM, если в нём есть выделения или CIDR, выделенные для него. Чтобы освободить выделения, см. ReleaseIpamPoolAllocation. Чтобы снять с выделения CIDR пула, см. DeprovisionIpamPoolCidr.

Дополнительную информацию см. в разделе Удаление пула в Руководстве пользователя Amazon VPC IPAM.

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

Синтаксис

  delete-ipam-pool
[--dry-run | --no-dry-run]
--ipam-pool-id <value>
[--cascade | --no-cascade]
[--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]

Параметры

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

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

--ipam-pool-id (строка)

Идентификатор пула для удаления.

--cascade | --no-cascade (логическое)

Позволяет быстро удалить пул IPAM и все ресурсы в рамках этого пула, включая выделенные CIDR, выделения и другие пулы.

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

Вы можете использовать этот параметр только для удаления пулов в частной области или пулов в общедоступной области с источником ресурса. Источник ресурса — ресурс, используемый для выделения CIDR для ресурсного планирования пула.

--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 для вывода.

--cli-auto-prompt (логическое)

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

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

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

Примеры

Примечание

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

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

Для удаления пула IPAM

В этом примере вы — делегированный администратор IPAM, который хочет удалить пул IPAM, который вам больше не нужен, но пул содержит выделенный CIDR. Вы не можете удалить пул, если к нему выделены CIDR, если не используете параметр --cascade, поэтому вы будете использовать --cascade.

Для выполнения этого запроса:

  • Вам понадобится идентификатор пула IPAM, который вы можете получить с помощью describe-ipam-pools.
  • --region должен быть домашним регионом IPAM.

Следующий пример delete-ipam-pool удаляет пул IPAM в вашей учетной записи AWS.

aws ec2 delete-ipam-pool \
    --ipam-pool-id ipam-pool-050c886a3ca41cd5b \
    --cascade \
    --region us-east-1

Вывод:

{
    "IpamPool": {
        "OwnerId": "320805250157",
        "IpamPoolId": "ipam-pool-050c886a3ca41cd5b",
        "IpamPoolArn": "arn:aws:ec2::320805250157:ipam-pool/ipam-pool-050c886a3ca41cd5b",
        "IpamScopeArn": "arn:aws:ec2::320805250157:ipam-scope/ipam-scope-0a158dde35c51107b",
        "IpamScopeType": "private",
        "IpamArn": "arn:aws:ec2::320805250157:ipam/ipam-005f921c17ebd5107",
        "IpamRegion": "us-east-1",
        "Locale": "None",
        "PoolDepth": 1,
        "State": "delete-in-progress",
        "Description": "example",
        "AutoImport": false,
        "AddressFamily": "ipv4",
        "AllocationMinNetmaskLength": 0,
        "AllocationMaxNetmaskLength": 32
    }
}

Дополнительную информацию см. в разделе Удаление пула в Руководстве пользователя Amazon VPC IPAM.

Вывод

IpamPool -> (структура)

Информация о результатах удаления.

OwnerId -> (строка)

Идентификатор учётной записи Amazon Web Services владельца пула IPAM.

IpamPoolId -> (строка)

Идентификатор пула IPAM.

SourceIpamPoolId -> (строка)

Идентификатор исходного пула IPAM. Вы можете использовать этот параметр для создания пула IPAM в рамках существующего исходного пула.

IpamPoolArn -> (строка)

Amazon Resource Name (ARN) пула IPAM.

IpamScopeArn -> (строка)

ARN области пула IPAM.

IpamScopeType -> (строка)

В IPAM область — это контейнер самого верхнего уровня в IPAM. IPAM содержит две области по умолчанию. Каждая область представляет адресное пространство IP для одной сети. Область «private» предназначена для всего адресного пространства частных IP-адресов. Область «public» предназначена для всего адресного пространства публичных IP-адресов. Области позволяют повторно использовать IP-адреса в нескольких несвязанных сетях без возникновения перекрытия или конфликта IP-адресов.

IpamArn -> (строка)

ARN IPAM.

IpamRegion -> (строка)

Регион Amazon Web Services пула IPAM.

Locale -> (строка)

Локаль пула IPAM.

Локаль пула должна быть одной из следующих:

  • Регион Amazon Web Services, в котором вы хотите, чтобы этот пул IPAM был доступен для выделения.
  • Группа границ сети для локальной зоны Amazon Web Services, в которой вы хотите, чтобы этот пул IPAM был доступен для выделения (поддерживаются локальные зоны). Этот параметр доступен только для пулов IPAM IPv4 в области «public».

Если вы выберете регион Amazon Web Services в качестве локали, который не настроен как рабочий регион для IPAM, вы получите ошибку.

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

Глубина пулов в вашем пуле IPAM. Квота глубины пула составляет 10. Дополнительная информация приведена в разделе «Квоты в IPAM» в руководстве пользователя Amazon VPC IPAM.

State -> (строка)

Состояние пула IPAM.

StateMessage -> (строка)

Сообщение о состоянии.

Description -> (строка)

Описание пула IPAM.

AutoImport -> (булево)

При выборе IPAM постоянно ищет ресурсы в диапазоне CIDR этого пула и автоматически импортирует их в качестве выделений в ваш IPAM. CIDR, которые будут выделены для этих ресурсов, не должны быть уже выделены другим ресурсам для успешного импорта. IPAM импортирует CIDR независимо от его соответствия правилам выделения пула, поэтому ресурс может быть импортирован и впоследствии помечен как несоответствующий. Если IPAM обнаруживает несколько перекрывающихся CIDR, IPAM импортирует только самый большой CIDR. Если IPAM обнаруживает несколько CIDR с совпадающими CIDR, IPAM импортирует только один из них случайным образом.

Для работы этой функции необходимо установить локаль пула.

PubliclyAdvertisable -> (булево)

Определяет, является ли пул публично доступным. Этот параметр недоступен для пулов с параметром AddressFamily, установленным на ipv4.

AddressFamily -> (строка)

Семейство адресов пула.

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

Минимальная длина маски сети, необходимая для соответствия выделений CIDR в этом пуле IPAM. Минимальная длина маски сети должна быть меньше максимальной длины маски сети. Возможные длины масок сети для IPv4-адресов составляют от 0 до 32. Возможные длины масок сети для IPv6-адресов составляют от 0 до 128.

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

Максимальная длина маски сети, возможная для соответствия выделений CIDR в этом пуле IPAM. Максимальная длина маски сети должна быть больше минимальной длины маски сети. Возможные длины масок сети для IPv4-адресов составляют от 0 до 32. Возможные длины масок сети для IPv6-адресов составляют от 0 до 128.

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

Значение по умолчанию для длины маски сети для выделений, добавленных в этот пул. Например, если CIDR, назначенный этому пулу, составляет 10.0.0.0/8, и вы вводите здесь 16, новые выделения будут по умолчанию 10.0.0.0/16.

AllocationResourceTags -> (список)

Теги, которые необходимы для ресурсов, использующих CIDR из этого пула IPAM. Ресурсы, не имеющие этих тегов, не смогут выделять пространство из пула. Если теги ресурсов изменены после выделения пространства или требования к тегам выделения изменены в пуле, ресурс может быть помечен как несоответствующий.

(структура)

Сочетание ключа/значения тега, назначенного ресурсу. Используйте ключ тега в имени фильтра, а значение тега — в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением TeamA, укажите tag:Owner для имени фильтра и TeamA для значения фильтра.

Key -> (строка)

Ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которым назначен тег с определенным ключом, независимо от значения тега.

Value -> (строка)

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

Tags -> (список)

Сочетание ключа/значения тега, назначенного ресурсу. Используйте ключ тега в имени фильтра, а значение тега — в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением TeamA, укажите tag:Owner для имени фильтра и TeamA для значения фильтра.

(структура)

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

Key -> (строка)

Ключ тега.

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

Value -> (строка)

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

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

AwsService -> (строка)

Ограничивает службы Amazon Web Services, которые могут использоваться в пуле. Например, «ec2» позволяет пользователям использовать пространство для Elastic IP-адресов и VPC.

PublicIpSource -> (строка)

Источник IP-адреса для пулов в области «public». Используется только для выделения CIDR-блоков IP-адресов для пулов в области «public». Значение по умолчанию — BYOIP. Дополнительная информация приведена в руководстве пользователя Amazon VPC IPAM в разделе «Создание пулов IPv6». По умолчанию вы можете добавить только один предоставленный Amazon IPv6-блок CIDR в пул IPv6 верхнего уровня. Сведения об увеличении значения по умолчанию см. в разделе «Квоты для IPAM» в руководстве пользователя Amazon VPC IPAM.

SourceResource -> (структура)

Ресурс, используемый для выделения CIDR-блоков в пул планирования ресурсов.

ResourceId -> (строка)

Идентификатор исходного ресурса.

ResourceType -> (строка)

Тип исходного ресурса.

ResourceRegion -> (строка)

Регион исходного ресурса.

ResourceOwner -> (строка)

Владелец исходного ресурса.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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