Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_vlan_pool_encap_block — Управление блоками encap, назначенными пулам VLAN (fvns:EncapBlk)

Примечание

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

Если вы используете пакет ansible, эта коллекция возможно уже установлена. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_vlan_pool_encap_block.

  • Обзор
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Обзор

  • Управление блоками VLAN encap, назначенными пулам VLAN на фабриках Cisco ACI.

Параметры

Параметр

Комментарии

allocation_mode

aliases: mode

string

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

Варианты:

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

annotation

string

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

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

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

По умолчанию: "orchestrator:ansible"

block_end

aliases: end

integer

Конец блока encap.

block_name

aliases: name

string

Имя, которое нужно присвоить блоку encap.

block_start

aliases: start

integer

Начало блока encap.

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

Описание для блока encap пула.

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

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

pool_allocation_mode

aliases: pool_mode

string

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

Варианты:

  • "dynamic"
  • "static"

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.

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, вместо соединения HTTPS будет использоваться соединение HTTP.

Если значение не указано в задаче, будет использовано значение переменной окружения 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 должен существовать, чтобы добавить или удалить блок encap.

См. также

См. также

cisco.aci.aci_encap_pool_range

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

cisco.aci.aci_vlan_pool

Управление пулами VLAN (fvns:VlanInstP).

Справочник по модели управления информацией APIC

Дополнительная информация об внутренней APIC-классе fvns:EncapBlk.

Руководство по Cisco ACI

Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.

Разработка модулей Cisco ACI

Подробное руководство по написанию собственных модулей Cisco ACI для участия.

Примеры

- name: Add a new VLAN encap block
  cisco.aci.aci_vlan_pool_encap_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool: production
    pool_allocation_mode: static
    block_start: 20
    block_end: 50
    state: present
  delegate_to: localhost

- name: Remove a VLAN encap block
  cisco.aci.aci_vlan_pool_encap_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool: production
    pool_allocation_mode: static
    block_start: 20
    block_end: 50
    state: absent
  delegate_to: localhost

- name: Query a VLAN encap block
  cisco.aci.aci_vlan_pool_encap_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool: production
    pool_allocation_mode: static
    block_start: 20
    block_end: 50
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a VLAN pool for encap blocks
  cisco.aci.aci_vlan_pool_encap_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    pool: production
    pool_allocation_mode: static
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all VLAN encap blocks
  cisco.aci.aci_vlan_pool_encap_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    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)
  • Dag Wieers (@dagwieers)

Ссылки на коллекцию

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

© 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_vlan_pool_encap_block_module.html

Spec-Zone.ru

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