Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

modify-ipam-pool

Описание

Изменение конфигурации пула IPAM.

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

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

Синтаксис

  modify-ipam-pool
[--dry-run | --no-dry-run]
--ipam-pool-id <value>
[--description <value>]
[--auto-import| --no-auto-import]
[--allocation-min-netmask-length <value>]
[--allocation-max-netmask-length <value>]
[--allocation-default-netmask-length <value>]
[--clear-allocation-default-netmask-length | --no-clear-allocation-default-netmask-length]
[--add-allocation-resource-tags <value>]
[--remove-allocation-resource-tags <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]

Параметры

--dry-run | --no-dry-run (boolean)

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

--ipam-pool-id (string)

Идентификатор пула IPAM, который необходимо изменить.

--description (string)

Описание пула IPAM, который необходимо изменить.

--auto-import | --no-auto-import (boolean)

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

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

--allocation-min-netmask-length (integer)

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

--allocation-max-netmask-length (integer)

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

--allocation-default-netmask-length (integer)

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

--clear-allocation-default-netmask-length | --no-clear-allocation-default-netmask-length (boolean)

Очистка правила распределения стандартной длины маски сети для этого пула.

--add-allocation-resource-tags (list)

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

(структура)

Тег ресурса IPAM.

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

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

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

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

Краткая синтаксическая конструкция:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--remove-allocation-resource-tags (list)

Удаление правил распределения тегов из пула.

(структура)

Тег ресурса IPAM.

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

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

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

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

Краткая синтаксическая конструкция:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--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 (boolean)

Включить отладку логирования.

--endpoint-url (строка)

Переопределить стандартный URL команды указанным URL.

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификата CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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 (boolean)

Отключить вывод страницы CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Изменение пула IPAM

Следующий modify-ipam-pool пример изменяет пул IPAM.

(Linux):

aws ec2 modify-ipam-pool \
    --ipam-pool-id ipam-pool-0533048da7d823723 \
    --add-allocation-resource-tags "Key=Owner,Value=Build Team" \
    --clear-allocation-default-netmask-length \
    --allocation-min-netmask-length 14

(Windows):

aws ec2 modify-ipam-pool ^
    --ipam-pool-id ipam-pool-0533048da7d823723 ^
    --add-allocation-resource-tags "Key=Owner,Value=Build Team" ^
    --clear-allocation-default-netmask-length ^
    --allocation-min-netmask-length 14

Вывод:

{
    "IpamPool": {
        "OwnerId": "123456789012",
        "IpamPoolId": "ipam-pool-0533048da7d823723",
        "IpamPoolArn": "arn:aws:ec2::123456789012:ipam-pool/ipam-pool-0533048da7d823723",
        "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-02fc38cd4c48e7d38",
        "IpamScopeType": "private",
        "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908",
        "IpamRegion": "us-east-1",
        "Locale": "None",
        "PoolDepth": 1,
        "State": "modify-complete",
        "AutoImport": true,
        "AddressFamily": "ipv4",
        "AllocationMinNetmaskLength": 14,
        "AllocationMaxNetmaskLength": 26,
        "AllocationResourceTags": [
            {
                "Key": "Environment",
                "Value": "Preprod"
            },
            {
                "Key": "Owner",
                "Value": "Build Team"
            }
        ]
    }
}

Дополнительную информацию см. в руководстве пользователя 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-адреса в нескольких несвязанных сетях без перекрытия или конфликтов IP-адресов.

IpamArn -> (строка)

ARN IPAM.

IpamRegion -> (строка)

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

Locale -> (строка)

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

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

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

Если вы выберите регион 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 символов Юникода. Не должно начинаться с aws:.

Value -> (строка)

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

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

AwsService -> (строка)

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

PublicIpSource -> (строка)

Источник IP-адреса для пулов в общедоступной области. Используется только для выделения CIDR-диапазонов IP-адресов для пулов в общедоступной области. По умолчанию BYOIP. Дополнительную информацию см. в разделе Создание пулов IPv6 в руководстве пользователя Amazon VPC IPAM. По умолчанию вы можете добавить только один предоставленный 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