Модуль cisco.aci.aci_encap_pool_range — управление диапазонами encap, назначенными пулам (fvns:EncapBlk и fvns:VsanEncapBlk)
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.aci.
Чтобы использовать коллекцию в плейбуке, укажите: cisco.aci.aci_encap_pool_range.
Краткое описание
- Управление диапазонами VLAN, VXLAN и VSAN, назначенными пулам в фабриках Cisco ACI.
Параметры
Параметр | Комментарии |
|---|---|
allocation_mode псевдонимы: mode string | Метод распределения encap между ресурсами. Режимы распределения поддерживаются только для VLAN и VSAN. Варианты:
|
annotation string | Определяемая пользователем строка для аннотирования объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Если значение не указано в задаче и переменная окружения По умолчанию: |
certificate_name псевдонимы: cert_name string | Имя сертификата X.509, привязанного к пользователю AAA APIC, который используется для аутентификации на основе подписи. Если указан файл Если для Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
description псевдонимы: descr string | Описание диапазона пула. |
host псевдонимы: hostname string | IP-адрес или имя узла APIC, доступное для разрешения с управляющего узла Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
name_alias string | Псевдоним текущего объекта. Соответствует полю nameAlias в ACI. |
output_level string | Управляет выводом этого модуля ACI.
Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Варианты:
|
output_path string | Путь к файлу, в который будут записываться созданные модулем объекты конфигурации ACI в формате JSON. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
password string | Пароль для аутентификации. Этот параметр взаимоисключающий с Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
pool псевдонимы: pool_name string | Имя пула, которому следует назначить диапазон. |
pool_allocation_mode псевдонимы: pool_mode string | Метод распределения encap между ресурсами. Режимы распределения поддерживаются только для VLAN и VSAN. Варианты:
|
pool_type псевдонимы: type string / обязательный | Тип encap для Варианты:
|
port integer | Номер порта для REST-подключения. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
private_key псевдонимы: cert_key string | Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение Этот параметр взаимоисключающий с Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
range_end псевдонимы: end integer | Конец диапазона encap. |
range_name псевдонимы: name, range string | Имя, присваиваемое диапазону encap. |
range_start псевдонимы: start integer | Начало диапазона encap. |
state string | Используйте Используйте Варианты:
|
suppress_previous псевдонимы: no_previous, ignore_previous boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — ВНИМАНИЕ — в результате возвращаемое значение previous будет пустым. Предыдущее состояние объекта проверяться не будет, а POST-обновление будет содержать все свойства. Варианты:
|
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — ВНИМАНИЕ — в результате возвращаемое значение current будет установлено в предложенное значение. Текущий объект, включая значения по умолчанию, невозможно проверить в рамках одной задачи. Варианты:
|
timeout integer | Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — 30. |
use_proxy boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — true. Варианты:
|
use_ssl boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной окружения При локальном подключении значение по умолчанию — true. Варианты:
|
username псевдонимы: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — admin. |
validate_certs boolean | Если Устанавливайте значение Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — true. Варианты:
|
Примечания
Примечание
- Для добавления или удаления диапазона необходимо, чтобы существовал
pool.
См. также
См. также
- cisco.aci.aci_encap_pool
-
Управление пулами encap (fvns:VlanInstP, fvns:VxlanInstP и fvns:VsanInstP).
- cisco.aci.aci_vlan_pool_encap_block
-
Управление блоками encap, назначенными пулам VLAN (fvns:EncapBlk).
- Справочник информационной модели управления APIC
-
Дополнительные сведения о внутренних классах APIC fvns:EncapBlk и fvns:VsanEncapBlk.
- Руководство по Cisco ACI
-
Подробная информация об управлении инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.
Примеры
- name: Add a new VLAN pool range
cisco.aci.aci_encap_pool_range:
host: apic
username: admin
password: SomeSecretPassword
pool: production
pool_type: vlan
pool_allocation_mode: static
range_name: anstest
range_start: 20
range_end: 40
allocation_mode: inherit
state: present
delegate_to: localhost
- name: Remove a VLAN pool range
cisco.aci.aci_encap_pool_range:
host: apic
username: admin
password: SomeSecretPassword
pool: production
pool_type: vlan
pool_allocation_mode: static
range_name: anstest
range_start: 20
range_end: 40
state: absent
delegate_to: localhost
- name: Query a VLAN range
cisco.aci.aci_encap_pool_range:
host: apic
username: admin
password: SomeSecretPassword
pool: production
pool_type: vlan
pool_allocation_mode: static
range_name: anstest
range_start: 20
range_end: 50
state: query
delegate_to: localhost
register: query_result
- name: Query a VLAN pool for ranges by range_name
cisco.aci.aci_encap_pool_range:
host: apic
username: admin
password: SomeSecretPassword
pool_type: vlan
range_name: anstest
state: query
delegate_to: localhost
register: query_result
- name: Query a VLAN pool for ranges by range_start
cisco.aci.aci_encap_pool_range:
host: apic
username: admin
password: SomeSecretPassword
pool_type: vlan
range_start: 20
state: query
delegate_to: localhost
register: query_result
- name: Query a VLAN pool for ranges by range_start and range_end
cisco.aci.aci_encap_pool_range:
host: apic
username: admin
password: SomeSecretPassword
pool_type: vlan
range_start: 20
range_end: 40
state: query
delegate_to: localhost
register: query_result
- name: Query all VLAN pool ranges
cisco.aci.aci_encap_pool_range:
host: apic
username: admin
password: SomeSecretPassword
pool_type: vlan
state: query
delegate_to: localhost
register: query_result
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
current list / elements=string | Существующая конфигурация APIC после выполнения модуля Возвращается: при успешном выполнении Пример: |
error dictionary | Сведения об ошибке, полученные от APIC Возвращается: при сбое Пример: |
filter_string string | Строка фильтра, использованная для запроса Возвращается: при сбое или в режиме отладки Пример: |
method string | Метод HTTP, использованный для запроса к APIC Возвращается: при сбое или в режиме отладки Пример: |
previous list / elements=string | Исходная конфигурация APIC до начала выполнения модуля Возвращается: в информационном режиме Пример: |
proposed dictionary | Собранная конфигурация на основе параметров, заданных пользователем Возвращается: в информационном режиме Пример: |
raw string | Необработанный ответ API REST APIC (XML или JSON) Возвращается: при ошибке разбора Пример: |
response string | Ответ HTTP от APIC Возвращается: при сбое или в режиме отладки Пример: |
sent list / elements=string | Фактическая/минимальная конфигурация, переданная в APIC Возвращается: в информационном режиме Пример: |
status integer | Статус HTTP от APIC Возвращается: при сбое или в режиме отладки Пример: |
url string | URL HTTP, использованный для запроса к APIC Возвращается: при сбое или в режиме отладки Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_encap_pool_range_module.html