Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_encap_pool_range – Управление диапазонами encap, назначенными пулам (fvns:EncapBlk и fvns:VsanEncapBlk)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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

aliases: mode

string

Метод, используемый для распределения encaps ресурсам.

Только vlan и vsan поддерживают режимы распределения.

Варианты:

  • "dynamic"
  • "inherit"
  • "static"

annotation

string

Определяемая пользователем строка для аннотирования объекта.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_ANNOTATION.

Если значение не указано в задаче и переменной среды ACI_ANNOTATION, то будет использовано значение по умолчанию.

Значение по умолчанию: "orchestrator:ansible"

certificate_name

aliases: cert_name

string

Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи.

Если указано имя файла private_key, это значение по умолчанию будет базовым именем private_key, без расширения.

Если для private_key было предоставлено содержимое в формате PEM, это значение по умолчанию будет username.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_CERTIFICATE_NAME.

description

aliases: descr

string

Описание для диапазона пула.

host

aliases: hostname

string

IP-адрес или имя хоста APIC, распознаваемые узлом управления Ansible.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_HOST.

name_alias

string

Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.

output_level

string

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая словарь current

info добавляет информационный вывод, включая словари previous, proposed и sent

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_OUTPUT_LEVEL.

Варианты:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

output_path

string

Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, созданных модулем.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_OUTPUT_PATH.

password

string

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

Этот параметр взаимоисключает private_key. Если также предоставлен private_key, он будет использоваться вместо него.

Если значение не указано в задаче, вместо него будет использовано значение переменных среды ACI_PASSWORD или ANSIBLE_NET_PASSWORD.

pool

aliases: pool_name

string

Имя пула, к которому должен быть назначен диапазон.

pool_allocation_mode

aliases: pool_mode

string

Метод, используемый для распределения encaps ресурсам.

Только vlan и vsan поддерживают режимы распределения.

Варианты:

  • "dynamic"
  • "static"

pool_type

aliases: type

string / required

Тип encaps pool.

Варианты:

  • "vlan"
  • "vxlan"
  • "vsan"

port

integer

Номер порта, который будет использоваться для соединения REST.

Значение по умолчанию зависит от параметра use_ssl.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_PORT.

private_key

aliases: cert_key

string

Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи.

Это значение также влияет на используемое значение certificate_name по умолчанию.

Этот параметр взаимоисключает password. Если также предоставлен password, он будет игнорироваться.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

range_end

aliases: end

integer

Конец диапазона encap.

range_name

aliases: name, range

string

Имя, которое нужно присвоить диапазону encap.

range_start

aliases: start

integer

Начальное значение диапазона encap.

state

string

Используйте present или absent для добавления или удаления.

Используйте query для перечисления объекта или нескольких объектов.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

aliases: no_previous, ignore_previous

boolean

Если true, GET для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC.

Если значение не указано в задаче, используется значение переменной среды ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым.

Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, GET для проверки не будет отправлен после обновления POST в APIC.

Если значение не указано в задаче, используется значение переменной среды ACI_SUPPRESS_VERIFICATION.

Значение по умолчанию false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение.

Текущий объект, включая значения по умолчанию, не будет проверяться в одной задаче.

Варианты:

  • false
  • true

timeout

integer

Таймаут уровня сокета в секундах.

Если значение не указано в задаче, используется значение переменной среды ACI_TIMEOUT.

Значение по умолчанию 30.

use_proxy

boolean

Если false, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.

Если значение не указано в задаче, используется значение переменной среды ACI_USE_PROXY.

Значение по умолчанию true.

Варианты:

  • false
  • true

use_ssl

boolean

Если false, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения.

Если значение не указано в задаче, используется значение переменной среды ACI_USE_SSL.

Значение по умолчанию true при локальном соединении.

Варианты:

  • false
  • true

username

aliases: user

string

Имя пользователя для аутентификации.

Если значение не указано в задаче, используется значение переменных среды ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию admin.

validate_certs

boolean

Если false, сертификаты SSL не будут проверены.

Это следует установить в false только при использовании на сайтах с самоподписанными сертификатами, контролируемыми лично.

Если значение не указано в задаче, используется значение переменной среды ACI_VALIDATE_CERTS.

Значение по умолчанию true.

Варианты:

  • false
  • 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 Management Information Model reference

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

список / элементы=строка

Существующая конфигурация с APIC после завершения модуля

Возвращено: успех

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

словарь

Информация об ошибке, возвращенная с APIC

Возвращено: неудача

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

строка

Используемая строка фильтра для запроса

Возвращено: неудача или отладка

Пример: "?rsp-prop-include=config-only"

method

строка

Используемый HTTP-метод для запроса к APIC

Возвращено: неудача или отладка

Пример: "POST"

previous

список / элементы=строка

Исходная конфигурация с APIC до запуска модуля

Возвращено: информация

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

словарь

Собраная конфигурация из параметров пользователя

Возвращено: информация

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

строка

Необработанный вывод, возвращенный API REST APIC (xml или json)

Возвращено: ошибка парсинга

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

строка

HTTP-ответ с APIC

Возвращено: неудача или отладка

Пример: "OK (30 bytes)"

sent

список / элементы=строка

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращено: информация

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

целое число

HTTP-статус с APIC

Возвращено: неудача или отладка

Пример: 200

url

строка

Используемый HTTP-URL для запроса к APIC

Возвращено: неудача или отладка

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Jacob McGill (@jmcgill298)

Ссылки на сборку

  • Отслеживание проблем
  • Репозиторий (исходные коды)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_encap_pool_range_module.html

Spec-Zone.ru

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